id_generator 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c2e271fb50e9a96d53b92c70fa45d55f8a8dc85aee47410868cb6ef33f239d4
-  data.tar.gz: 26ea59ebc7009adb5e2ca9fc5ac02af9d243e3a4b0a82efee6ad1b4f65296dc3
+  metadata.gz: b2a7e546cf4457139efc2403b915d913cea5b234df65a62318289912df7ae52b
+  data.tar.gz: 8628a0dcf288d1bd17f330f65e8f5662fc15d7ec009a3c0f648fa892ab2a31dd
 SHA512:
-  metadata.gz: edc950a375068320a1a6e4d478fde583f4677263103d3f391f5e7a4bbee1db2eda2a78fd63d1b1f98401088d4faec278a8b9e9b833c444cf79d427536d1a143f
-  data.tar.gz: bf47f173ee92b65f56a799654e39fc096c15a0cad660620bbb8e72ccce8884b253cdd72eae4693c55f6a3ec46974b69a9133b52fb848d1e44618143567cba1d3
+  metadata.gz: c8a59657ddf1506e5e2d0e6802dae6ff404f4508d893d9c62260b6b0966128d72bbf321f4570584d0b357062d6b2a6cd53187025f18c3e2ef32ffe37d3b1cc16
+  data.tar.gz: 9c14f200d0346daf7dc8b4523961e2d2d80d99301c30bc8b97f408ec75069a6836b86546832be917f1344cd996af024253f995f02ca13cf7d3cf66d6b94cb59f

data/.travis.yml

@@ -11,5 +11,4 @@ deploy:
   provider: rubygems
   api_key: "$RUBY_GEMS_API_KEY"
   on:
-    branch: master
     tags: true

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    id_generator (0.1.1)
+    id_generator (0.1.2)
 
 GEM
   remote: https://rubygems.org/
@@ -61,14 +61,14 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.16)
-  codacy-coverage
+  codacy-coverage (~> 2.1)
   id_generator!
-  pry
+  pry (~> 0.11)
   rake (~> 10.0)
   rspec (~> 3.0)
-  rubocop (~> 0.59.2)
-  rubocop-junit-formatter
-  rubocop-rspec
+  rubocop (~> 0.59)
+  rubocop-junit-formatter (~> 0.1)
+  rubocop-rspec (~> 1.30)
 
 BUNDLED WITH
    1.16.6

data/README.md

@@ -54,10 +54,12 @@ gem 'id_generator'
 ```ruby
 # Somewhere during project start
 context_id = 165 # value from 0 to 255
-ID_GENERATOR = IdGenerator.new(context_id)
+IdGenerator.configuration.context_id = context_id
+# Or using block
+IdGenerator.configure { |config| config.context_id = context_id } 
 
 #Inside of the actual code
-ID_GENERATOR.generate
+IdGenerator.generate
 ```
 
 ## Contributing

data/id_generator.gemspec

@@ -37,11 +37,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'codacy-coverage'
-  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'codacy-coverage', '~> 2.1'
+  spec.add_development_dependency 'pry', '~> 0.11'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.59.2'
-  spec.add_development_dependency 'rubocop-junit-formatter'
-  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'rubocop', '~> 0.59'
+  spec.add_development_dependency 'rubocop-junit-formatter', '~> 0.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.30'
 end

data/lib/id_generator.rb

@@ -1,46 +1,22 @@
-require 'securerandom'
-
-class IdGenerator
-  VERSION = '0.1.2'.freeze
-
-  COUNTER_PART_SIZE = 8
-  CONTEXT_PART_SIZE = 2
-
-  RANDOM_PART_BYTES = 11
-  COUNTER_START = Time.new(2000).to_i
-
-  class Error < StandardError
-  end
-
-  def initialize(context_id)
-    raise(IdGenerator::Error, 'Invalid project id') unless context_id_valid?(context_id)
-
-    @context_id = value_to_hex(context_id, CONTEXT_PART_SIZE)
-  end
-
-  def generate
-    "#{time}-#{@context_id}-#{random_number}"
-  end
-
-  private
-
-  def context_id_valid?(context_id)
-    return false unless context_id.is_a?(Integer)
-    return false unless context_id.between?(0, 255)
-
-    true
+require 'id_generator/version'
+require 'id_generator/configuration'
+require 'id_generator/errors'
+require 'id_generator/generators/timestamped_random'
+
+module IdGenerator
+  def self.configure
+    yield(configuration)
   end
 
-  def time
-    timestamp = Time.now.to_i - COUNTER_START
-    value_to_hex(timestamp, COUNTER_PART_SIZE)
+  def self.generate
+    id_generator.generate
   end
 
-  def random_number
-    SecureRandom.hex(RANDOM_PART_BYTES)
+  def self.configuration
+    @configuration ||= Configuration.new
   end
 
-  def value_to_hex(value, size)
-    format("%0#{size}x", value)
+  def self.id_generator
+    @id_generator ||= IdGenerator::Generators::TimestampedRandom.new(configuration)
   end
 end

data/lib/id_generator/configuration.rb

@@ -0,0 +1,24 @@
+module IdGenerator
+  class Configuration
+    attr_reader :context_id
+
+    def initialize(context_id: 0)
+      self.context_id = context_id
+    end
+
+    def context_id=(context_id)
+      raise(IdGenerator::Errors::InvalidContextId, 'Invalid context id') unless context_id_valid?(context_id)
+
+      @context_id = context_id
+    end
+
+    protected
+
+    def context_id_valid?(context_id)
+      return false unless context_id.is_a?(Integer)
+      return false unless context_id.between?(0, 255)
+
+      true
+    end
+  end
+end

data/lib/id_generator/errors.rb

@@ -0,0 +1,7 @@
+module IdGenerator
+  module Errors
+    class InvalidContextId < StandardError
+      # Just empty line to trick codacy
+    end
+  end
+end

data/lib/id_generator/generators/timestamped_random.rb

@@ -0,0 +1,42 @@
+require 'securerandom'
+
+module IdGenerator
+  module Generators
+    class TimestampedRandom
+      COUNTER_PART_SIZE = 8
+      CONTEXT_PART_SIZE = 2
+
+      RANDOM_PART_BYTES = 11
+      COUNTER_START = Time.new(2000).to_i
+
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
+      end
+
+      def generate
+        "#{time}-#{context_id}-#{random_number}"
+      end
+
+      private
+
+      def time
+        timestamp = Time.now.to_i - COUNTER_START
+        value_to_hex(timestamp, COUNTER_PART_SIZE)
+      end
+
+      def context_id
+        value_to_hex(config.context_id, CONTEXT_PART_SIZE)
+      end
+
+      def random_number
+        SecureRandom.hex(RANDOM_PART_BYTES)
+      end
+
+      def value_to_hex(value, size)
+        format("%0#{size}x", value)
+      end
+    end
+  end
+end

data/lib/id_generator/version.rb

@@ -0,0 +1,3 @@
+module IdGenerator
+  VERSION = '1.0.0'.freeze
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: id_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Viktor Novitskyi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-23 00:00:00.000000000 Z
+date: 2018-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,30 +28,30 @@ dependencies:
   name: codacy-coverage
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -86,42 +86,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.2
+        version: '0.59'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.59.2
+        version: '0.59'
 - !ruby/object:Gem::Dependency
   name: rubocop-junit-formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.30'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.30'
 description: |-
   Ruby Gem that allow to generate random ids in distributed systems (micro-services)
                           and include debug information like timestamp and system id
@@ -144,6 +144,10 @@ files:
 - bin/setup
 - id_generator.gemspec
 - lib/id_generator.rb
+- lib/id_generator/configuration.rb
+- lib/id_generator/errors.rb
+- lib/id_generator/generators/timestamped_random.rb
+- lib/id_generator/version.rb
 homepage: https://github.com/matic-insurance/id_generator
 licenses:
 - MIT