humanized_id 0.1.0 → 0.2.0

checksums.yaml

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

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.1
 
 Metrics/LineLength:
   Max: 100
@@ -12,3 +12,9 @@ Style/BlockDelimiters:
 
 Style/TrivialAccessors:
   AllowPredicates: true
+
+Style/SignalException:
+  EnforcedStyle: semantic
+
+Style/SingleLineBlockParams:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+## 0.2.0 (2016-02-11)
+
+Fixed:
+
+  - Requires Ruby >= 2.1 (Ruby < 2.1 never worked)
+
+Changed:
+
+  - Refactors internal logic
+  - Updates tests
+
+## 0.1.0 (2016-02-11)
+
+Initial release

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 gemspec

data/Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/Readme.md

@@ -1,5 +1,11 @@
 # HumanizedId
 
+[![Gem Version](https://badge.fury.io/rb/humanized_id.svg)](https://badge.fury.io/rb/humanized_id)
+[![Build Status](https://travis-ci.org/sealink/humanized_id.svg?branch=master)](https://travis-ci.org/sealink/humanized_id)
+[![Coverage Status](https://coveralls.io/repos/github/sealink/humanized_id/badge.svg?branch=master)](https://coveralls.io/github/sealink/humanized_id?branch=master)
+[![Dependency Status](https://gemnasium.com/sealink/humanized_id.svg)](https://gemnasium.com/sealink/humanized_id)
+[![Code Climate](https://codeclimate.com/github/sealink/humanized_id/badges/gpa.svg)](https://codeclimate.com/github/sealink/humanized_id)
+
 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
@@ -27,10 +33,7 @@ Or install it yourself as:
 
 ### 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
+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
@@ -39,20 +42,16 @@ humanized_id = HumanizedId.humanize id: 1234567
 
 #### 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'
+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
+Note that the original length is not preserved during the base conversion, so you will need to explicitly pass in a min_length if you'd like a output 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)
+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
 
@@ -63,12 +62,11 @@ 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
+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 + 4 (length of 'TEST').
 
 ### Generating a random humanized id
 
-Call 'generate_random' with optional length and prefix
+Call 'generate_random' with optional length and prefix.
 
 ```ruby
 random_humanized_id = HumanizedId.generate_random
@@ -80,8 +78,7 @@ Will generate a random human friendly id of default length (see HumanizedId::DEF
 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
+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
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'humanized_id'

data/humanized_id.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -24,11 +25,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.0'
+  spec.required_ruby_version = '>= 2.1'
 
   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'

data/lib/humanized_id.rb

@@ -3,16 +3,15 @@ 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
+  CHARSET = (('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
+      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
+      RandGenerator.new(prefix: prefix, length: length).generate_random_humanized_id
     end
   end
   Error = Class.new(StandardError)

data/lib/humanized_id/humanizer.rb

@@ -1,43 +1,37 @@
 # frozen_string_literal: true
 module HumanizedId
   class Humanizer
-    SOURCE_CHARSET = %w(0123456789abcdefghijklmnopqrstuvwxyz).freeze
+    SOURCE_CHARSET = (('0'..'9').to_a + ('a'..'z').to_a).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('')
+      @prefix           = prefix.to_s
+      @target_charset   = CHARSET.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
+      new_id = resize convert_to_target_charset convert_to_target_base(@id)
       "#{@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'
+    def convert_to_target_base(id)
+      fail Error, 'id is not an integer' unless id.is_a? Integer
+      id.to_s(@target_charset.length)
     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)
+    def convert_to_target_charset(id)
+      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
+    def resize(id)
+      return id if @min_length.nil? || @min_length <= id.length
+      padding = @target_charset[0] * (@min_length - id.length)
+      "#{padding}#{id}"
     end
   end
 end

data/lib/humanized_id/rand_generator.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 module HumanizedId
   class RandGenerator
     def initialize(prefix: '', length:)
       @prefix = prefix.nil? ? '' : prefix
       @length = length
-      @target_charset = HumanizedId::CHARACTERSET
+      @target_charset = CHARSET
     end
 
     def generate_random_humanized_id
@@ -12,13 +13,13 @@ module HumanizedId
 
     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
+    def generate_random
+      SecureRandom.random_bytes(@length).unpack('C*').map { |byte| map_to_char(byte) }.join
+    end
+
+    def map_to_char(byte)
+      index = byte % @target_charset.size
+      @target_charset[index]
     end
   end
 end

data/lib/humanized_id/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: humanized_id
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Akil Madan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-11 00:00:00.000000000 Z
+date: 2016-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !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
@@ -149,6 +135,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -173,7 +160,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="