tokogen 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d37166686245cf99243365f86bcef7c4a8ec2b1a
-  data.tar.gz: 978498c998a874852766f7c0e0f1ad6809cf633f
+  metadata.gz: 4935595f4088dbbf55cf945d762542593fd849e2
+  data.tar.gz: 6cf358d6f950178c266f9f1102822586c2e9e14d
 SHA512:
-  metadata.gz: 7ac95fe534f71d357d48b4c08fb1f461553314d6f5fa1c3912e4f20c0c08529a2e4b7bc00130b95954d9d8195656d84a708f36d8ef4c78a9dacf79a4636c2a3f
-  data.tar.gz: d73f36a631cf3385dde27a3607456987848366044f06f3e56c59c01bad28f8cfe1b49c3b466d3c3123e3516e493a13ad83e379c748055eec8256987c32b5abeb
+  metadata.gz: 693e975d0e678c26e8eb5ecb8721fbc795573d834c8f4528b5f1f1af31c462646f148a2c06c9873d3af130e07b6fb27d029001fe51fcaa6a7405b97907ee03df
+  data.tar.gz: e1961e28a51c691c6c0201bc25009d5c9c664ed4a54860269988a4b92c407af63736eef1a0c3de3ed61e3e3c027051ceb75cd48f57cd8c8eee8a413bac96c2c7

data/.rubocop.yml

@@ -5,6 +5,7 @@ AllCops:
     - '**/*.gemspec'
     - '**/Gemfile'
     - '**/Rakefile'
+    - '**/Guardfile'
     - '**/*.rake'
 Rails:
   Enabled: false
@@ -25,14 +26,17 @@ Style/IndentHash:
 Style/FirstParameterIndentation:
   EnforcedStyle: consistent
 Style/CaseIndentation:
-  IndentWhenRelativeTo: end
+  EnforcedStyle: end
 Style/Alias:
   EnforcedStyle: prefer_alias_method
 Lint/EndAlignment:
-  AlignWith: variable
+  EnforcedStyleAlignWith: variable
 Style/MultilineMethodCallIndentation:
   EnforcedStyle: indented
 Style/SpaceInLambdaLiteral:
   Enabled: false
 Bundler/OrderedGems:
   Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'

data/.travis.yml

@@ -2,6 +2,8 @@ sudo: false
 language: ruby
 rvm:
   - 2.3.1
+  - 2.3.3
+  - 2.4.0
 before_install: gem install bundler -v 1.13.6
 install:
   - bundle install --retry=3

data/Guardfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/README.md

@@ -1,4 +1,6 @@
 # Tokogen
+[![Build Status](https://travis-ci.org/MOZGIII/tokogen.svg?branch=master)](https://travis-ci.org/MOZGIII/tokogen)
+[![Gem Version](https://badge.fury.io/rb/tokogen.svg)](https://badge.fury.io/rb/tokogen)
 
 A ruby gem that allows you to generate customizable random tokens.
 

data/bin/bench_ruby_binary

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+require 'benchmark'
+
+TIMES = 500_000
+
+puts '# Sequential'
+puts
+
+Benchmark.bmbm(12) do |b|
+  b.report('(1 << x) - 1') { TIMES.times { |x| (1 << x) - 1 } }
+  b.report('~(-1 << x)')   { TIMES.times { |x| ~(-1 << x)   } }
+end
+
+puts
+
+puts '# Random'
+puts
+
+top = 1 << 32
+numbers = Array.new(TIMES) { Random::DEFAULT.rand(top) }
+
+Benchmark.bmbm(12) do |b|
+  b.report('(1 << x) - 1') { numbers.each { |x| (1 << x) - 1 } }
+  b.report('~(-1 << x)')   { numbers.each { |x| ~(-1 << x)   } }
+end

data/bin/bench_ruby_comparisons

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+require 'benchmark'
+
+TIMES = 100_000_000
+
+puts '# Sequential'
+puts
+
+Benchmark.bmbm(12) do |b|
+  b.report('x <= 255')          { TIMES.times { |x| x <= 255          } }
+  b.report('x < 256')           { TIMES.times { |x| x < 256           } }
+  b.report('x.bit_length <= 8') { TIMES.times { |x| x.bit_length <= 8 } }
+end
+
+puts
+
+puts '# Random'
+puts
+
+top = 1 << 32
+numbers = Array.new(TIMES) { Random::DEFAULT.rand(top) }
+
+Benchmark.bmbm(12) do |b|
+  b.report('x <= 255')          { numbers.each { |x| x <= 255          } }
+  b.report('x < 256')           { numbers.each { |x| x < 256           } }
+  b.report('x.bit_length <= 8') { numbers.each { |x| x.bit_length <= 8 } }
+end

data/exe/tokogen

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+require 'tokogen'
+args = []
+args << ARGV[0].to_i if ARGV[0]
+puts Tokogen.token(*args)

data/lib/tokogen.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 require 'securerandom'
 require 'tokogen/version'
+require 'tokogen/bit_splitter'
+require 'tokogen/bit_combiner'
 require 'tokogen/generator'
+require 'tokogen/alphabet'
 
 module Tokogen
   def self.token(length = 32)
@@ -12,7 +15,7 @@ module Tokogen
     generator # calling explicitly without arguments
   end
 
-  def self.generator(randomness_source: SecureRandom, **options)
-    Generator.new(randomness_source: randomness_source, **options)
+  def self.generator(randomness_source: SecureRandom, alphabet: Alphabet::BASE62)
+    Generator.new(randomness_source: randomness_source, alphabet: alphabet)
   end
 end

data/lib/tokogen/alphabet.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module Tokogen
+  module Alphabet
+    BASE62 = (('A'..'Z').to_a + ('a'..'z').to_a + ('0'..'9').to_a).join.freeze
+    BASE58 = (('A'..'Z').to_a + ('a'..'z').to_a + ('0'..'9').to_a - %w(0 O I l)).join.freeze
+    BASE64 = (('A'..'Z').to_a + ('a'..'z').to_a + ('0'..'9').to_a + ['+', '/']).join.freeze
+
+    # Note: This is NOT ASCII85 coding alphabet, it's from RFC1924.
+    # Do not use in unless you're sure you need it!
+    BASE85 = (('A'..'Z').to_a + ('a'..'z').to_a + ('0'..'9').to_a + ['!', '#', '$', '%', '&', '(', ')', '*', '+', '-', ';', '<', '=', '>', '?', '@', '^', '_', '`', '{', '|', '}', '~']).join.freeze
+
+    # Some simple alphabets.
+    # Mainly used for testing but you can use them too.
+    BASE2 = ('0'..'1').to_a.join.freeze
+    BASE3 = ('0'..'2').to_a.join.freeze
+  end
+end

data/lib/tokogen/bit_combiner.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module Tokogen
+  class BitCombiner
+    attr_reader :size
+
+    def initialize(bits_enum, width_in_bits)
+      @bits_enum = bits_enum
+      @width_in_bits = width_in_bits
+
+      bits_enum_size = @bits_enum.size
+      @size = bits_enum_size / @width_in_bits if bits_enum_size
+    end
+
+    def each(&block) # rubocop:disable Metrics/MethodLength
+      enum = Enumerator.new(@size) do |y|
+        @bits_enum.each_slice(@width_in_bits) do |slice|
+          num = 0
+          slice.size.times do |i|
+            num |= (slice[i] << i)
+          end
+          y.yield(num)
+        end
+      end
+      return enum if block.nil?
+      enum.each(&block)
+    end
+  end
+end

data/lib/tokogen/bit_splitter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module Tokogen
+  class BitSplitter
+    BYTE_SIZE = 8
+
+    attr_reader :size
+
+    def initialize(bytes_enum)
+      @bytes_enum = bytes_enum
+
+      bytes_enum_size = @bytes_enum.size
+      @size = bytes_enum_size * BYTE_SIZE if bytes_enum_size
+    end
+
+    def each(&block)
+      enum = Enumerator.new(@bytes_enum_bit_size) do |y|
+        @bytes_enum.each do |b|
+          BYTE_SIZE.times do |i|
+            y.yield(b[i])
+          end
+        end
+      end
+      return enum if block.nil?
+      enum.each(&block)
+    end
+  end
+end

data/lib/tokogen/generator.rb

@@ -1,67 +1,57 @@
 # frozen_string_literal: true
 module Tokogen
   class Generator
-    DEFAULT_ALPHABET = (('A'..'Z').to_a + ('a'..'z').to_a + ('0'..'9').to_a).join.freeze
+    class AssertionFail < StandardError; end
 
-    attr_reader :randomness_source
+    attr_reader :randomness_source, :alphabet
 
-    def initialize(randomness_source:, alphabet: DEFAULT_ALPHABET)
+    def initialize(randomness_source:, alphabet:)
       @randomness_source = randomness_source
       @alphabet = alphabet
+
+      @alphabet_size = @alphabet.size
+      @max_char_index = @alphabet_size - 1
+      @bits_per_char = @max_char_index.bit_length
     end
 
-    def generate(length)
-      token_bits_amount = length * bits_per_char
+    def generate(length) # rubocop:disable Metrics/AbcSize
+      token_bits_amount = length * @bits_per_char
       bytes_to_read = full_bytes_in_bits(token_bits_amount)
       bytes = random_bytes(bytes_to_read)
-      bits = bytes.unpack('b*')[0]
+      splitter = BitSplitter.new(bytes.each_byte)
+      combiner = BitCombiner.new(splitter.each, @bits_per_char)
       # It's possible we've read a couple exta bits of randomness,
       # since randomness is rounded to bytes.
       # Here we only take first `length` of bit that we need.
-      bit_string_split(bits, bits_per_char)
-        .take(length)
-        .map { |index| alphabet_char(index) }
-        .join
+      indexes = combiner.each.take(length)
+      raise AssertionFail, 'Invalid length' if indexes.size != length
+      indexes.map do |index|
+        # We split out random data into chunks of bits with fixed length.
+        # Therefore it's possible to have an index value that is larger than
+        # an alphabet size.
+        # In this case we'd resolve to nil, so we're just using modulo of the
+        # alphabet size. This will probably ruin the distribution that
+        # the randromness source provides, but it will at least work.
+        # If you don't want this behavior, just ensure you're using an alphabet
+        # with an even size - then there will always be a bijection between
+        # the generated indicies and the alphabet and the described issue
+        # will never occur.
+        alphabet_char(index % @alphabet_size)
+      end.join
     end
 
     def random_bytes(size)
       @randomness_source.random_bytes(size)
     end
 
-    def max_char_index
-      @alphabet.size - 1
+    def alphabet_char(index)
+      @alphabet[index]
     end
 
-    def bits_per_char
-      max_char_index.bit_length
-    end
+    private
 
     def full_bytes_in_bits(bits)
       (bits + 7) >> 3
     end
-
-    private
-
-    def bit_string_split(bits, bits_per_char, &block) # rubocop:disable Metrics/MethodLength
-      top = max_char_index
-      curry = 0
-      last_curry = 0
-      bits.each_char.each_slice(bits_per_char).map do |binary_ord|
-        val = binary_ord.join.to_i(2) + curry
-        last_curry = curry
-        if val <= top
-          current = val
-          curry = 0
-        else
-          current = top
-          curry = val % top
-        end
-        current
-      end.each(&block)
-    end
-
-    def alphabet_char(index)
-      @alphabet[index]
-    end
   end
 end

data/lib/tokogen/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Tokogen
-  VERSION = '0.1.2'
+  VERSION = '0.2.1'
 end

data/tokogen.gemspec

@@ -24,4 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'guard', '~> 2.14.0'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tokogen
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - MOZGIII
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-11 00:00:00.000000000 Z
+date: 2017-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,10 +52,39 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
 description: A ruby gem that allows you to generate customizable random tokens.
 email:
 - mike-n@narod.ru
-executables: []
+executables:
+- tokogen
 extensions: []
 extra_rdoc_files: []
 files:
@@ -66,11 +95,18 @@ files:
 - ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
+- Guardfile
 - README.md
 - Rakefile
+- bin/bench_ruby_binary
+- bin/bench_ruby_comparisons
 - bin/console
 - bin/setup
+- exe/tokogen
 - lib/tokogen.rb
+- lib/tokogen/alphabet.rb
+- lib/tokogen/bit_combiner.rb
+- lib/tokogen/bit_splitter.rb
 - lib/tokogen/generator.rb
 - lib/tokogen/version.rb
 - tokogen.gemspec