UUID Shortener 项目教程

UUID Shortener 项目教程

uuid-shortenerA simple RFC 4122 UUID shortener library. Change your 36 chars long ID into it's shorter equivalent.项目地址:https://gitcode.com/gh_mirrors/uu/uuid-shortener

1. 项目的目录结构及介绍

UUID Shortener 项目的目录结构如下：

uuid-shortener/
├── lib/
│   └── uuid_shortener.rb
├── README.md
├── Gemfile
├── Gemfile.lock
└── uuid-shortener.gemspec

目录结构介绍

• lib/: 包含项目的主要代码文件。
  • uuid_shortener.rb: 实现 UUID 缩短和扩展的核心逻辑。
• README.md: 项目的说明文档。
• Gemfile: 定义项目所需的 Ruby 依赖。
• Gemfile.lock: 锁定依赖的具体版本。
• uuid-shortener.gemspec: 项目的 gem 规范文件。

2. 项目的启动文件介绍

UUID Shortener 项目的启动文件是 lib/uuid_shortener.rb。该文件定义了 UUID 缩短和扩展的主要逻辑。

启动文件内容

module UuidShortener
  ALPHABET = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
  ALPHABET_HASH = ALPHABET.each_char.with_index.each_with_object([]) { |(k, v), h| h[k] = v }
  BASE = ALPHABET.length

  class << self
    def shorten(uuid)
      num = uuid.tr('-', '').to_i(16)
      return '0' if num.zero?
      return nil if num.negative?
      str = ''
      while num.positive?
        str = ALPHABET[num % BASE] + str
        num /= BASE
      end
      str
    end

    def expand(suid)
      num = 0
      i = 0
      len = suid.length - 1
      while i < suid.length
        pow = BASE**(len - i)
        num += ALPHABET_HASH[suid[i]] * pow
        i += 1
      end
      num.to_s(16).rjust(32, '0').unpack('A8A4A4A4A12').join('-')
    end
  end
end

功能介绍

• shorten(uuid): 将标准的 36 字符 UUID 缩短为 22 字符的字符串。
• expand(suid): 将缩短的 UUID 字符串还原为标准的 36 字符 UUID。

3. 项目的配置文件介绍

UUID Shortener 项目的配置文件主要是 Gemfile 和 uuid-shortener.gemspec。

Gemfile

Gemfile 定义了项目所需的 Ruby 依赖：

source 'https://rubygems.org'

gem 'rake'
gem 'rspec'

uuid-shortener.gemspec

uuid-shortener.gemspec 定义了项目的 gem 规范：

Gem::Specification.new do |spec|
  spec.name          = "uuid-shortener"
  spec.version       = "0.1.0"
  spec.authors       = ["Your Name"]
  spec.email         = ["your.email@example.com"]
  spec.summary       = %q{Shorten UUIDs to a more manageable length.}
  spec.description   = %q{A simple library to shorten UUIDs to a more manageable length.}
  spec.homepage      = "https://github.com/mgrajcarek/uuid-shortener"
  spec.license       = "MIT"

  spec.files         = `git ls-files`.split($/)
  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
  spec.require_paths = ["lib"]

  spec.add_development_dependency "bundler", "~> 2.0"
  spec.add_development_dependency "rake", "~> 13.0"
  spec.add_development_dependency "rspec", "~

uuid-shortenerA simple RFC 4122 UUID shortener library. Change your 36 chars long ID into it's shorter equivalent.项目地址:https://gitcode.com/gh_mirrors/uu/uuid-shortener