humanized_id 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 503446ac0138faee8cfe6329182e48b0a84e33b7
+  data.tar.gz: 0acf9a7b8cafec545fb4ae7f5e209705982eb5a9
+SHA512:
+  metadata.gz: f36d58aa96c011295a2cfe2a1492fdb32ee75005d32777959c562f69562e54a1a565999630f750c70ac67e01ba2c14c9e75987273921b8f1459def17ba8dd7ae
+  data.tar.gz: 00a91acd6c619c851ae898cd5315f1d849d8371c0acb0f05ae25c329ef73cecf9aef0a0c223a44606c1826773fbf42f042042fd9162e084bbd36a47dc5e81613

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+/.idea/
+.env
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/LineLength:
+  Max: 100
+
+Documentation:
+  Enabled: false
+
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+
+Style/TrivialAccessors:
+  AllowPredicates: true

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2
+notifications:
+  email:
+    - support@travellink.com.au
+  flowdock:
+    secure: CkLwygzeYX5y3r0eg1bn8wFLYd7qLeOrbrawQb/c/sTehXvU95sE/yZMNdPKD/Mv+IQ+blVVr4NAt8MvbN20Nw/W5EtcsMo2S2msuCsVbwCkvj21Dqm+pTRoD8O2yf3zxX5T7wmZ7PoD7UfE+wIPQ5C7QunODxCPnpPlj/RCaOKejarmdQWXQaT6/lJpzoRDav2oj+bbyPCwQbYGSYWFPFwQ3FylGNp/7eCD3wSPJtmYdunJtx1yVW4wnInTEzqsQ4eJubpwEfQ8vsWq7KbeUf2Z0IaPVtSzwN7gjIncGJ1gS5MGhZkFSsNhY9BvVkWw366qkTcESB3CbF5O9vUrUyWAaiLIHZrqTaqhocZ+4Y6jWJG/gSfLGYTSlVx+qxQ/Pd75bXu6ovlL2HF9lYEL1mbVp4GrOGcQTnw2SLOnLRmsGtf5CEVBE4llQXR0ySzqLCc0Q6XBLgbvG5yg+iKsnDQRZijStUQze/rQVGbtOLxXXyv+mQolaKd475igJYZB29KS0gW3gCJrTQPLRm1D/PPIOHLFysKgPc6kE5UcPWmTrnH8hWKj2K0tiN+u5S4jostoh1riDBr+baLQ5eI9k6KVevM7t1ICiSb9A9WpRfbUtGRHirnte/MgAc0EJ/J/iAT5breaV9urnjzyaYvpH8YzXHMbuw/tlS8jdxlI8qs=
+sudo: false
+cache: bundler

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Akil Madan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/Readme.md

@@ -0,0 +1,98 @@
+# HumanizedId
+
+HumanizedId is a gem designed to help you either:
+ - Convert an existing numerical id into a 'human friendly' alphanumerical id
+ - Generate a random 'human friendly' id that is of a specified or default length
+
+A 'humanized' (or 'human friendly') id is an id that is easy to read and is based
+off a character set that does not allow vague or vulgar references.
+
+## Installation
+
+Add this line to your application's Gemfile
+
+```ruby
+gem 'humanized_id'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install humanized_id
+
+## Usage
+
+### Humanize an existing id
+
+The simplest way to call humanize is to pass in an existing numerical id,
+and let HumanizedId return a human friendly version of that id. This id will be shorter
+in length (due to base conversion) and will be an alphanumerical string based on
+a 'human safe' character-set
+
+```ruby
+humanized_id = HumanizedId.humanize id: 1234567
+# Returns '6RDFD'
+```
+
+#### Ensuring minimum length of output id
+
+An optional min_length flag can be passed in order to guarantee the minimum length
+of the returned value. This will be done by 'padding' the return id with the
+safe-charset default value '2'
+
+```ruby
+humanized_id = HumanizedId.humanize id: 1234567, min_length: 20
+# Returns '222222222222226RDFD'
+```
+
+Note that the original length is not preserved during the base conversion, so you
+will need to explicitely pass in a min_length if you'd like a return id of the same length
+
+Also note that if you specify a min_length shorter than the actual output id length,
+the output id will not be modified (as expected)
+
+#### Adding a prefix
+
+Pass in a prefix if you'd like to add a prefix to your humanized id
+
+```ruby
+humanized_id = HumanizedId.humanize id: 1234567, min_length: 20, prefix: 'TEST'
+# Will return 'TEST222222222222226RDFD'
+```
+
+The prefix is added to the humanized id after all other processing (including min_length padding).
+Therefore the total length of the above example wil be 20 + 'TEST'.length = 24
+
+### Generating a random humanized id
+
+Call 'generate_random' with optional length and prefix
+
+```ruby
+random_humanized_id = HumanizedId.generate_random
+```
+
+Will generate a random human friendly id of default length (see HumanizedId::DEFAULT_GENERATION_LENGTH)
+
+```ruby
+random_humanized_id = HumanizedId.generate_random length: 20, prefix: 'TEST'
+```
+
+This will generate a random humanized id of length 20 and then add the prefix to the id
+thus resulting in a total length of 24
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/sealink/humanized_id/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'humanized_id'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/humanized_id.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'humanized_id/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'humanized_id'
+  spec.version       = HumanizedId::VERSION
+  spec.authors       = ['Akil Madan']
+  spec.email         = ['support@travellink.com.au']
+
+  spec.summary       = 'Gem to convert an existing id to a human friendly id or ' \
+                       'generate a new human friendly random id'
+  spec.description   = 'HumanizedId can be used to generate (or convert an existing id to) a ' \
+                       'human friendly id'
+  spec.homepage      = 'https://github.com/sealink/humanized_id'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`
+                       .split("\x0")
+                       .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-rcov'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'travis'
+end

data/lib/humanized_id/humanizer.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+module HumanizedId
+  class Humanizer
+    SOURCE_CHARSET = %w(0123456789abcdefghijklmnopqrstuvwxyz).freeze
+
+    def initialize(id:, min_length: nil, prefix: '')
+      @id               = id
+      @min_length       = min_length
+      @prefix           = prefix.nil? ? '' : prefix
+      @target_charset   = HumanizedId::CHARACTERSET.join('')
+      @source_charset   = SOURCE_CHARSET.join('')
+    end
+
+    def generate_humanized_id
+      new_id = convert_to_target_base id: @id
+      new_id = convert_to_target_charset id: new_id
+      new_id = resize id: new_id if @min_length
+      "#{@prefix}#{new_id}"
+    end
+
+    private
+
+    def convert_to_target_base(id: @id, target_base: @target_charset.length)
+      id.to_s(target_base)
+    rescue ArgumentError
+      raise Error, 'id is not an integer'
+    end
+
+    def convert_to_target_charset(
+      id: @id, target_charset: @target_charset, source_charset: @source_charset)
+      source_charset_subset = source_charset.slice(0, target_charset.length)
+      id.tr(source_charset_subset, target_charset)
+    end
+
+    def resize(id: @id, min_length: @min_length, target_charset: @target_charset)
+      if min_length > id.length
+        padding = target_charset[0] * (min_length - id.length)
+        id = "#{padding}#{id}"
+      end
+      id
+    end
+  end
+end

data/lib/humanized_id/rand_generator.rb

@@ -0,0 +1,24 @@
+module HumanizedId
+  class RandGenerator
+    def initialize(prefix: '', length:)
+      @prefix = prefix.nil? ? '' : prefix
+      @length = length
+      @target_charset = HumanizedId::CHARACTERSET
+    end
+
+    def generate_random_humanized_id
+      "#{@prefix}#{generate_random}"
+    end
+
+    private
+
+    def generate_random(length: @length, target_charset: @target_charset)
+      SecureRandom.random_bytes(length).unpack('C*').map{ |byte|
+        idx = byte % 64
+        idx = SecureRandom.random_number(target_charset.size) if
+          idx >= target_charset.size
+        target_charset[idx]
+      }.join
+    end
+  end
+end

data/lib/humanized_id/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module HumanizedId
+  VERSION = '0.1.0'.freeze
+end

data/lib/humanized_id.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+module HumanizedId
+  DEFAULT_GENERATION_LENGTH = 24
+  SIMILAR_NUMBERS_LETTERS = %w(0 O 1 I L 5 S 8 B).freeze
+  VOWELS = %w(A E I O U).freeze
+  CHARACTERSET =
+    (('0'..'9').to_a + ('A'..'Z').to_a - SIMILAR_NUMBERS_LETTERS - VOWELS).freeze
+
+  class << self
+    def humanize(id:, min_length: nil, prefix: '')
+      HumanizedId::Humanizer.new(id: id, min_length: min_length, prefix: prefix).generate_humanized_id
+    end
+
+    def generate_random(prefix: '', length: DEFAULT_GENERATION_LENGTH)
+      HumanizedId::RandGenerator.new(prefix: prefix, length: length).generate_random_humanized_id
+    end
+  end
+  Error = Class.new(StandardError)
+end
+
+require 'humanized_id/version'
+require 'humanized_id/humanizer'
+require 'humanized_id/rand_generator'

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: humanized_id
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Akil Madan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: travis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: HumanizedId can be used to generate (or convert an existing id to) a
+  human friendly id
+email:
+- support@travellink.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- Readme.md
+- bin/console
+- bin/setup
+- humanized_id.gemspec
+- lib/humanized_id.rb
+- lib/humanized_id/humanizer.rb
+- lib/humanized_id/rand_generator.rb
+- lib/humanized_id/version.rb
+homepage: https://github.com/sealink/humanized_id
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Gem to convert an existing id to a human friendly id or generate a new human
+  friendly random id
+test_files: []