uniq_identifier 0.0.7 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ae67a2e8c41e72b1ce093225ba045e49dc2657f
-  data.tar.gz: 54eb0124b08b54a3d8dd5ccda5041980ecec8de1
+  metadata.gz: 92214b9affc9199eb4dc10482043977e685904a8
+  data.tar.gz: 5d07a33eaeb2ccc6f61497cb1a53ee1745464faa
 SHA512:
-  metadata.gz: 417c2e239763f9271c83c739bb02761cba7d0390056a16366efb4173475b24b8a24f0607a6d9bf9777be3047e32cbfc5b1b9d2b9a391cd454e50427991e32237
-  data.tar.gz: fa51e4f12e137a88f0138c536a67fb45aec525eab3a3532c6a6bb7b7a5c3280cf4ef3d4dbd62ecf2b6e356c1ed00de16c58256f4f150a73ee59ae73ac59891ac
+  metadata.gz: 25296558a96400d97799d936517a959cd6e9c94960d0ce4705db05bc5fb511f4ff2fa07456a7a3caf6798bd965c59f6f498984dc4859c416c092ab150d35e655
+  data.tar.gz: 924b77a7cb8a605cbac0bab7a140205f2fc3d96a11236f730c23f408967d932c284e69e7f093a1129238ab9d069d47cf15af6a784c30259bc555a8898b3d5282

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### VERSION 0.1.1
+
+* Enhancements
+  * You now can define your own specific Generator for every model, not just in a global config level.
+  * You can deactivate generation auto to ensure a UUID is provided
+  * You can deactivate the validation and authorize recording a empty UUID
+
 ### VERSION 0.0.7
 
 * Enhancements

data/README.md

@@ -1,12 +1,14 @@
 # UniqIdentifier
 
-[![Code Climate](https://codeclimate.com/github/joel/uniq_identifier.png)](https://codeclimate.com/github/joel/uniq_identifier)
+[![Code Climate](https://codeclimate.com/github/FinalCAD/uniq_identifier.png)](https://codeclimate.com/github/FinalCAD/uniq_identifier)
 
-[![Dependency Status](https://gemnasium.com/joel/uniq_identifier.png)](https://gemnasium.com/joel/uniq_identifier)
+[![Dependency Status](https://gemnasium.com/FinalCAD/uniq_identifier.png)](https://gemnasium.com/FinalCAD/uniq_identifier)
 
-[![Build Status](https://travis-ci.org/joel/uniq_identifier.png?branch=master)](https://travis-ci.org/joel/uniq_identifier) (Travis CI)
+[![Build Status](https://travis-ci.org/FinalCAD/uniq_identifier.svg?branch=master)](https://travis-ci.org/FinalCAD/uniq_identifier) (Travis CI)
 
-[![Coverage Status](https://coveralls.io/repos/joel/uniq_identifier/badge.svg?branch=master)](https://coveralls.io/r/joel/uniq_identifier?branch=master)
+[![Coverage Status](https://coveralls.io/repos/FinalCAD/uniq_identifier/badge.svg?branch=master)](https://coveralls.io/r/FinalCAD/uniq_identifier?branch=master)
+
+[![Gem Version](https://badge.fury.io/rb/uniq_identifier.svg)](https://badge.fury.io/rb/uniq_identifier)
 
 Add an uniq identifier on your models. For make your model agnostic from backend unique identifier.
 
@@ -65,15 +67,36 @@ end
 
 you can use the generator
 
-```ruby
+```bash
 rails g uniq_identifier:install
 rails g uniq_identifier:add <model>
 ```
 for mongoid use
 
-```ruby
+```bash
 rails g uniq_identifier:add <model> --orm=mongoid
 ```
+
+## Options
+
+```ruby
+class CustomGenerator
+  def uuid
+    # ...
+  end
+end
+
+class Bar
+  uniq_identifier generator: CustomGenerator,
+                  auto: bool,
+                  validate: bool
+end
+```
+
+* `generator` can be any object which respond to `uuid` signal or `:default` (default: `:default`)
+* `auto` if set to false then uuid will not be automatically generated after initialize (default: `true`)
+* `validate` if set to false validation will not be added (default: `true`)
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/uniq_identifier/fork )
@@ -81,3 +104,13 @@ rails g uniq_identifier:add <model> --orm=mongoid
 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
+
+## Test
+
+```bash
+  bundle && ADAPTER=mongoid bundle
+```
+
+```bash
+  rake
+```

data/lib/uniq_identifier.rb

@@ -1,14 +1,33 @@
 require_relative 'uniq_identifier/railtie' if defined?(Rails)
 require_relative 'uniq_identifier/hook'
 require_relative 'uniq_identifier/configure'
-require_relative 'uniq_identifier/fake_generator'
 
 module UniqIdentifier
   extend Configure
 
-  def uniq_identifier
-    prepend Hook
-    before_save :set_uniq_identifier
-    validates :uuid, presence: true, uniqueness: true
+  def uniq_identifier(auto: true, validate: true, generator: :default)
+    @uniq_identifier_generator = generator
+
+    class << self
+      def uniq_identifier_generator
+        generator = @uniq_identifier_generator
+        if generator.nil? && superclass.respond_to?(:uniq_identifier_generator)
+          superclass.uniq_identifier_generator
+        elsif generator == :default
+          UniqIdentifier.configuration.generator
+        else
+          generator
+        end
+      end
+    end
+
+    if auto
+      before_validation :set_uniq_identifier
+      include Hook
+    end
+
+    if validate
+      validates :uuid, presence: true, uniqueness: true
+    end
   end
 end

data/lib/uniq_identifier/hook.rb

@@ -2,17 +2,19 @@ require 'securerandom'
 
 module UniqIdentifier
   module Hook
-
     def uuid(*args, &block)
-      if super(*args).nil?
-        self.send(:uuid=, UniqIdentifier.configuration.generator.uuid)
-      end
-
-      super(*args)
+      generate_uniq_identifier! if super(*args, &block).nil?
+      super
     end
 
     def set_uniq_identifier
-      self.uuid # Just call lazy loading
+      generate_uniq_identifier! if self.uuid.nil?
+    end
+
+    def generate_uniq_identifier!
+      if self.class.uniq_identifier_generator.respond_to?(:uuid)
+        self.uuid = self.class.uniq_identifier_generator.uuid
+      end
     end
   end
 end

data/lib/uniq_identifier/version.rb

@@ -1,3 +1,6 @@
 module UniqIdentifier
-  VERSION = '0.0.7'
+  MAJOR = 0
+  MINOR = 1
+  PATCH = 1
+  VERSION = [MAJOR, MINOR, PATCH].join('.')
 end

data/spec/spec_helper.rb

@@ -4,12 +4,12 @@ require 'coveralls'
 
 require 'rails/all'
 
-begin
-  require 'pry'
-rescue LoadError
-end
+require 'pry' rescue nil
+
+require_relative './support/fake_generator'
+require_relative './support/class_generator'
 
-Coveralls.wear!
+Coveralls.wear! rescue nil
 
 ENV['ADAPTER'] ||= 'active_record'
 load File.dirname(__FILE__) + "/support/adapters/#{ENV['ADAPTER']}.rb"

data/spec/support/adapters/active_record.rb

@@ -6,5 +6,4 @@ ActiveRecord::Base.extend UniqIdentifier
 load File.dirname(__FILE__) + '/../schema.rb'
 
 class User < ActiveRecord::Base
-  uniq_identifier
 end

data/spec/support/adapters/mongoid.yml

@@ -4,3 +4,8 @@ test:
       database: godfather
       hosts:
         - localhost:27017
+  clients:
+    default:
+      database: godfather
+      hosts:
+        - localhost:27017

data/spec/support/class_generator.rb

@@ -0,0 +1,43 @@
+module ClassGenerator
+  extend self
+
+  def generate(**opts)
+    if defined? Mongoid
+      generate_mongoid_document!(opts)
+    else
+      generate_active_record!(opts)
+    end
+  end
+
+  private
+
+  def generate_active_record!(**opts)
+    klass = ::Class.new(parent_class)
+
+    def klass.name
+      'User'
+    end
+
+    klass.inheritance_column = '__'
+    klass.define_callbacks :initialize # reset initialize callbacks
+    klass.define_model_callbacks :initialize # reset initialize callbacks
+    klass.uniq_identifier opts
+    klass
+  end
+
+  def generate_mongoid_document!(**opts)
+    klass = ::Class.new(parent_class)
+
+    def klass.name
+      'User'
+    end
+
+    klass.define_model_callbacks :initialize # reset initialize callbacks
+    klass.uniq_identifier opts
+    klass
+  end
+
+  def parent_class
+    ::User
+  end
+end

data/{lib/uniq_identifier → spec/support}/fake_generator.rb

@@ -2,7 +2,7 @@ module UniqIdentifier
   class FakeGenerator
 
     def self.uuid
-      "0c6bbc03-a269-44e2-8075-f442e1aac0c8"
+      '0c6bbc03-a269-44e2-8075-f442e1aac0c8'
     end
 
   end

data/spec/uniq_identifier/uniq_identifier_spec.rb

@@ -4,67 +4,82 @@ describe UniqIdentifier do
   let(:user) { User.new }
   let(:fake_uuid) { SecureRandom.uuid }
 
-  before do
-    allow(UniqIdentifier).to receive_message_chain('configuration.generator.uuid') { fake_uuid }
-  end
+  context 'all settings default' do
+    let(:fake_uuid) { UniqIdentifier::FakeGenerator.uuid }
 
-  specify 'lazy load' do
-    expect {
-      expect(user.uuid).to eql(fake_uuid)
-    }.to change {
-      user.attributes['uuid']
-    }.from(nil).to(fake_uuid)
-  end
+    let(:default_settings_class) { ClassGenerator.generate }
 
-  specify do
-    expect {
-      user.save!
-    }.to change {
-      user.attributes['uuid']
-    }.from(nil).to(fake_uuid)
+    it 'must set uuid for new record' do
+      expect(default_settings_class.new.uuid).to be_eql fake_uuid
+    end
+
+    it 'must have callback method' do
+      expect(default_settings_class.new).to respond_to :set_uniq_identifier
+    end
   end
 
-  context 'persistence' do
-    let(:user_id) { user.id }
+  context 'generator option' do
+    let(:fake_uuid) { '0c6bbc03-a269-44e2-8075-f442e1aac0c1' }
+    let(:default_uuid) { UniqIdentifier::FakeGenerator.uuid }
+    let(:generator) { OpenStruct.new(uuid: fake_uuid) }
+
+    let!(:custom_settings_class) { ClassGenerator.generate generator: generator }
+    let!(:default_settings_class) { ClassGenerator.generate }
+    let!(:nil_settings_class) { ClassGenerator.generate generator: nil }
+    let!(:inherited_settings_class) { ::Class.new(custom_settings_class) }
+
+    it 'must have different generator when some was given' do
+      default_generator_current = default_settings_class.uniq_identifier_generator
+      custom_generator_current = custom_settings_class.uniq_identifier_generator
+      expect(default_generator_current).to_not be_eql custom_generator_current
+    end
 
-    context 'set uuid on save' do
-      before { user.save! }
+    it 'must use given generator' do
+      expect(custom_settings_class.uniq_identifier_generator).to be_eql generator
+    end
 
-      specify do
-        expect(User.find(user_id).uuid).to eql(fake_uuid)
-      end
+    it 'must accept nil as generator when option was given' do
+      expect(nil_settings_class.uniq_identifier_generator).to be_eql nil
     end
 
-    context 'keep given uuid on save' do
-      before do
-        user.uuid = fake_uuid
-        user.save!
-      end
+    it 'must nil as generator can\'t raise error'  do
+      expect { nil_settings_class.new.uuid }.to_not raise_exception
+    end
 
-      specify do
-        expect(User.find(user_id).uuid).to eql(fake_uuid)
-      end
+    it 'inherited class must have parent generator' do
+      custom_generator_current = custom_settings_class.uniq_identifier_generator
+      inherited_generator = inherited_settings_class.uniq_identifier_generator
+      expect(inherited_generator).to be_eql custom_generator_current
     end
+  end
 
-    context 'keep given uuid on save' do
-      before do
-        user.attributes = { uuid: fake_uuid }
-        user.save!
-      end
+  context 'auto option' do
+    let(:fake_uuid) { '0c6bbc03-a269-44e2-8075-f442e1aac0c1' }
+    let(:default_uuid) { UniqIdentifier::FakeGenerator.uuid }
+    let(:generator) { OpenStruct.new(uuid: fake_uuid) }
 
-      specify do
-        expect(User.find(user_id).uuid).to eql(fake_uuid)
-      end
+    let!(:custom_settings_class) { ClassGenerator.generate auto: false }
+    let!(:default_settings_class) { ClassGenerator.generate }
+
+    it 'disabled auto must not set uuid' do
+      expect(custom_settings_class.new.uuid).to be_nil
     end
 
-    context 'keep given uuid on save' do
-      let(:user) { User.new({ uuid: fake_uuid }) }
+    it 'enabled auto must set uuid' do
+      expect(default_settings_class.new.uuid).to_not be_nil
+    end
+  end
+
+  context 'persistence' do
+    let!(:default_settings_class) { ClassGenerator.generate generator: SecureRandom }
 
-      before { user.save! }
+    it 'must save uuid and return it' do
+      expect(default_settings_class.create!(name: 'example').uuid).to_not be_nil
+    end
 
-      specify do
-        expect(User.find(user_id).uuid).to eql(fake_uuid)
-      end
+    it 'must not change uuid during save' do
+      user = default_settings_class.new(name: 'example')
+      expect { user.save! }.to_not change { user.uuid }
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uniq_identifier
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.1
 platform: ruby
 authors:
 - Joel AZEMAR
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-28 00:00:00.000000000 Z
+date: 2017-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -67,7 +67,6 @@ files:
 - lib/uniq_identifier.rb
 - lib/uniq_identifier/configuration.rb
 - lib/uniq_identifier/configure.rb
-- lib/uniq_identifier/fake_generator.rb
 - lib/uniq_identifier/hook.rb
 - lib/uniq_identifier/railtie.rb
 - lib/uniq_identifier/version.rb
@@ -78,7 +77,8 @@ files:
 - spec/support/adapters/active_record.rb
 - spec/support/adapters/mongoid.rb
 - spec/support/adapters/mongoid.yml
-- spec/support/data.rb
+- spec/support/class_generator.rb
+- spec/support/fake_generator.rb
 - spec/support/schema.rb
 - spec/uniq_identifier/configuration_spec.rb
 - spec/uniq_identifier/uniq_identifier_spec.rb
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Add an uniq identifier
@@ -115,7 +115,8 @@ test_files:
 - spec/support/adapters/active_record.rb
 - spec/support/adapters/mongoid.rb
 - spec/support/adapters/mongoid.yml
-- spec/support/data.rb
+- spec/support/class_generator.rb
+- spec/support/fake_generator.rb
 - spec/support/schema.rb
 - spec/uniq_identifier/configuration_spec.rb
 - spec/uniq_identifier/uniq_identifier_spec.rb

data/spec/support/data.rb

@@ -1,2 +0,0 @@
-User.destroy_all
-user.create(name: 'John Doe')