uniq_identifier 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b83fa51ff88933f8636a88302ae1f820d434589
-  data.tar.gz: d9502b8b8119eadcaed4226bb6f6c114255f4b0c
+  metadata.gz: b65e5a80f91751f11f0dbd70fd572ace568665cf
+  data.tar.gz: 17334d6d08293100d0215ffb8f3560783ed163cc
 SHA512:
-  metadata.gz: 4302b4de5568b7009943169f9c455af6e1495335ae66cc68e0182e431f0e5e4d9ddb220f2889d111ee863b1113b4afae1da513ba2f3d0c98c4221773cbe52cac
-  data.tar.gz: e1b71a71532dfdc247f9752e5c1411a32f1bde1ce435ed1e6964c83359b8b514790596a1359228b68cab37cab640a763b325543e907487c523625d1fca55812c
+  metadata.gz: 22c5f051f9c1232245c749f176371107695eb9b9271e32b49f968e045c786c466faa12d7f0588b8b99f27670ae744ff7ef029b4685235b4bcdd03419423c773c
+  data.tar.gz: 90a31bceb24b4f509c4c92756b41b4eeea21b79adaca776c389a5d684bef20f845fdc4fdbe33081e77595c3300924453bfb089be8bb665227606d522f5ce2473

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.rspec

@@ -0,0 +1 @@
+--format documentation --color --fail-fast

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+script: bundle exec rspec spec

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+### VERSION 0.0.2
+
+* Enhancements
+  * Liitle enhancement
+
+### VERSION 0.0.1
+
+* Skeleton and first parsing

data/Gemfile

@@ -6,11 +6,14 @@ gemspec
 group :test do
   case ENV['ADAPTER']
   when nil, 'active_record'
-    gem 'sqlite3'
+    gem 'sqlite3', platform: 'ruby'
     gem 'activerecord'
   when 'mongoid'
     gem 'mongoid'
   else
-    raise "Unknow adatper: #{ENV['ADAPTER']}"
+    raise "Unknown model adapter: #{ENV["ADAPTER"]}"
   end
+  gem 'coveralls', require: false
+  gem 'pry'
+  gem 'ammeter'
 end

data/README.md

@@ -1,6 +1,14 @@
 # UniqIdentifier
 
-This gem add uuid on your model.
+[![Code Climate](https://codeclimate.com/github/joel/uniq_identifier.png)](https://codeclimate.com/github/joel/uniq_identifier)
+
+[![Dependency Status](https://gemnasium.com/joel/uniq_identifier.png)](https://gemnasium.com/joel/uniq_identifier)
+
+[![Build Status](https://travis-ci.org/joel/uniq_identifier.png?branch=master)](https://travis-ci.org/joel/uniq_identifier) (Travis CI)
+
+[![Coverage Status](https://coveralls.io/repos/joel/uniq_identifier/badge.png)](https://coveralls.io/r/joel/uniq_identifier)
+
+Add an uniq identifier on your models. For make your model agnostic from backend unique identifier.
 
 ## Installation
 
@@ -20,31 +28,51 @@ Or install it yourself as:
 
 ## Usage
 
-add this on your model. For example.
-
-for ActiveRecord
+add uuid in your model like that:
 
-```
+```ruby
 class Foo < ActiveRecord::Base
   uniq_identifier
 end
 ```
 
-for Mongoid
+```ruby
+foo = Foo.new
+foo.id   # => nil
+foo.uuid # => "0c6bbc03-a269-44e2-8075-f442e1aac0c8"
+```
 
+```ruby
+foo.create!
+foo.id # => 1
 ```
-class Foo
-  include Mongoid::Document
-  uniq_identifier
-end
+
+```ruby
+my_foo = Foo.where(uuid: "0c6bbc03-a269-44e2-8075-f442e1aac0c8")
+my_foo.id # => 1
 ```
 
-you have this:
+## Configuration
 
+add app/config/initializers/uniq_identifier.rb
+
+```ruby
+UniqIdentifier.configuration do |conf|
+  conf.generator = SecureRandom
+end
 ```
-Foo.new.uuid # => "2d931510-d99f-494a-8c67-87feb05e1594"
+
+you can use the generator
+
+```ruby
+rails g uniq_identifier:install
+rails g uniq_identifier:add <model>
 ```
+for mongoid use
 
+```ruby
+rails g uniq_identifier:add <model> --orm=mongoid
+```
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/uniq_identifier/fork )

data/Rakefile

@@ -1,2 +1,31 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
+RSpec::Core::RakeTask.new(:generators) do |task|
+  task.pattern = 'spec/generators/**/*_spec.rb'
+end
+
+RSpec::Core::RakeTask.new(:uniq_identifier) do |task|
+  task.pattern = 'spec/uniq_identifier/**/*_spec.rb'
+end
+
+task :default => [ :spec ]
+
+desc 'Run all specs'
+task 'spec' do
+  Rake::Task['generators'].invoke
+  return_code1 = $?.exitstatus
+
+  Rake::Task['uniq_identifier'].invoke
+  return_code2 = $?.exitstatus
+
+  fail if return_code1 != 0 || return_code2 != 0
+end
+
+desc 'Run specs for all adapters'
+task :spec_all do
+  %w[active_record mongoid].each do |model_adapter|
+    puts "ADAPTER = #{model_adapter}"
+    system "ADAPTER=#{model_adapter} rake"
+  end
+end

data/lib/generators/uniq_identifier/add_generator.rb

@@ -0,0 +1,48 @@
+require 'rails/generators/active_record' if defined?(ActiveRecord)
+require 'rails/generators/migration'
+
+module UniqIdentifier
+  module Generators
+    class AddGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+      class_option :orm, type: :string, default: :active_record
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def self.next_migration_number(path)
+        ActiveRecord::Generators::Base.next_migration_number(path)
+      end
+
+      desc <<DESC
+description :
+  add migration file to choosen model
+  rails generate uniq_identifier:add model_name --orm=mongoid
+  rails generate uniq_identifier:add model_name
+DESC
+      def add_migration_file
+        migration_template 'migration.rb', "db/migrate/add_uuid_#{file_path}.rb" if options.orm == :active_record
+
+        hook   = 'uniq_identifier'
+        data   = "\n"
+        data += indent("#{hook}")
+
+        if options.orm == 'mongoid'
+          data += "\n"
+          data += indent("field :uuid, type: String")
+        end
+
+        if options.orm == :active_record
+          header = "class #{class_name} < ActiveRecord::Base"
+        else
+          header = 'include Mongoid::Document'
+        end
+
+        model_path = File.join('app', 'models', "#{file_path}.rb")
+        inject_into_file model_path, data, after: header, verbose: true
+
+        readme("./README-#{options.orm}")
+      end
+    end
+
+  end
+end

data/lib/generators/uniq_identifier/install_generator.rb

@@ -0,0 +1,18 @@
+module UniqIdentifier
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc <<DESC
+description :
+    copy uniq_identifier configuration to an initializer.
+    rails generate uniq_identifier:install
+DESC
+      def copy_initializer_file
+        template 'uniq_identifier.rb', "config/initializers/uniq_identifier.rb"
+      end
+    end
+
+  end
+end

data/lib/generators/uniq_identifier/templates/README-active_record

@@ -0,0 +1,8 @@
+Now, you just have to run the migration using rake command:
+
+   rake db:migrate
+
+and you will be able to add the uniq_identifier method inside all models you want
+add an uniq identifier.
+
+===============================================================================

data/lib/generators/uniq_identifier/templates/README-mongoid

@@ -0,0 +1,4 @@
+You will be able to add the uniq_identifier method inside all models you want
+add an uniq identifier.
+
+===============================================================================

data/lib/generators/uniq_identifier/templates/migration.rb

@@ -0,0 +1,8 @@
+class UniqIdentifierAddUuid<%= class_name %> < ActiveRecord::Migration
+  def change
+    change_table(:<%= plural_name %>) do |t|
+      t.string :uuid
+    end
+    add_index(:<%= plural_name %>, :uuid)
+  end
+end

data/lib/generators/uniq_identifier/templates/uniq_identifier.rb

@@ -0,0 +1,3 @@
+UniqIdentifier.configure do |conf|
+  # conf.generator = SecureRandom
+end

data/lib/uniq_identifier/configuration.rb

@@ -0,0 +1,11 @@
+require 'securerandom'
+
+module UniqIdentifier
+  class Configuration
+    attr_accessor :generator
+
+    def initialize
+      self.generator = SecureRandom
+    end
+  end
+end

data/lib/uniq_identifier/configure.rb

@@ -0,0 +1,17 @@
+require_relative 'configuration'
+
+module UniqIdentifier
+  module Configure
+
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+  end
+end

data/lib/uniq_identifier/fake_generator.rb

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

data/lib/uniq_identifier/hook.rb

@@ -3,8 +3,12 @@ require 'securerandom'
 module UniqIdentifier
   module Hook
 
+    def self.included(base)
+      base.extend(self)
+    end
+
     def set_uniq_identifier
-      self.uuid = SecureRandom.uuid
+      self.send(:uuid=, UniqIdentifier.configuration.generator.uuid)
     end
   end
 end

data/lib/uniq_identifier/railtie.rb

@@ -0,0 +1,20 @@
+require 'uniq_identifier'
+require 'rails'
+
+module UniqIdentifier
+  class Railtie < Rails::Railtie
+    initializer 'uniq_identifier.initialize' do
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.send :extend, UniqIdentifier
+      end
+
+      config.before_initialize do
+        ::Mongoid::Document.module_eval do
+          def self.included(base)
+            base.extend UniqIdentifier
+          end
+        end
+      end if defined?(Mongoid)
+    end
+  end
+end

data/lib/uniq_identifier/version.rb

@@ -1,3 +1,3 @@
 module UniqIdentifier
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 end

data/lib/uniq_identifier.rb

@@ -1,7 +1,10 @@
-require_relative "uniq_identifier/version"
-require_relative "uniq_identifier/hook"
+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
     include Hook

data/spec/generators/active_record/add_generator_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+require 'rails/generators'
+require 'ammeter/init'
+
+# Generators are not automatically loaded by Rails
+require_relative '../../../lib/generators/uniq_identifier/add_generator'
+
+module UniqIdentifier
+  module Generators
+    describe AddGenerator, skip: true do
+      let(:user_content) do
+        <<-CONTENT
+class User < ActiveRecord::Base
+end
+        CONTENT
+      end
+
+      # Tell the generator where to put its output (what it thinks of as Rails.root)
+      destination File.expand_path('../../../../tmp', __FILE__)
+
+      before do
+        prepare_destination
+        FileUtils.mkdir_p "#{destination_root}/app/models"
+        File.open("#{destination_root}/app/models/user.rb", 'w+') do |file|
+          file.write(user_content)
+        end
+      end
+
+      after do
+        FileUtils.rm_rf destination_root
+      end
+
+      describe 'the generated files' do
+        before do
+          expect(AddGenerator).to receive(:next_migration_number) { '20141008141816' }
+          run_generator ['User']
+        end
+
+        describe 'add hook' do
+          let(:file_path) { "#{destination_root}/app/models/user.rb" }
+          subject { file(file_path) }
+          specify do
+            expect(File.new(file_path)).to match(/uniq_identifier/)
+          end
+        end
+
+        describe 'generate migration' do
+          let(:file_path) { 'db/migrate/20141008141816_add_uuid_user.rb' }
+          subject { file(file_path) }
+          specify do
+            expect(File.exists?("#{destination_root}/#{file_path}")).to be_truthy
+          end
+        end
+      end
+    end
+  end
+end

data/spec/generators/mongoid/add_generator_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+require 'rails/generators'
+require 'ammeter/init'
+
+# Generators are not automatically loaded by Rails
+require_relative '../../../lib/generators/uniq_identifier/add_generator'
+
+module UniqIdentifier
+  module Generators
+    describe AddGenerator, skip: true do
+      # Tell the generator where to put its output (what it thinks of as Rails.root)
+      destination File.expand_path('../../../../tmp', __FILE__)
+      let(:user_content) do
+        <<-CONTENT
+class User
+  include Mongoid::Document
+end
+        CONTENT
+      end
+      before do
+        prepare_destination
+        FileUtils.mkdir_p "#{destination_root}/app/models"
+        File.open("#{destination_root}/app/models/user.rb", 'w+') do |file|
+          file.write(user_content)
+        end
+      end
+
+      after do
+        FileUtils.rm_rf destination_root
+      end
+
+      describe 'the generated files' do
+        before do
+          run_generator ['User', '--orm=mongoid']
+        end
+
+        describe 'add hook' do
+          let(:file_path) { 'app/models/user.rb' }
+          subject { file(file_path) }
+          specify do
+            expect(File.new(file_path)).to match(/uniq_identifier/)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/generators/uniq_identifier/install_generator_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+require 'rails/generators'
+require 'ammeter/init'
+
+# Generators are not automatically loaded by Rails
+require_relative '../../../lib/generators/uniq_identifier/install_generator'
+
+module UniqIdentifier
+  module Generators
+    describe InstallGenerator do
+      # Tell the generator where to put its output (what it thinks of as Rails.root)
+      destination File.expand_path('../../../../tmp', __FILE__)
+
+      before do
+        prepare_destination
+      end
+
+      after do
+        FileUtils.rm_rf destination_root
+      end
+
+      describe 'the generated files' do
+        before do
+          run_generator
+        end
+
+        describe 'the spec' do
+          let(:file_path) { 'config/initializers/uniq_identifier.rb' }
+
+          subject { file(file_path) }
+
+          specify do
+            expect(File.exists?("#{destination_root}/#{file_path}")).to be_truthy
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,21 @@
 require 'uniq_identifier'
 require 'bundler/setup'
+require 'coveralls'
+
+begin
+  require 'pry'
+rescue LoadError
+end
+
+Coveralls.wear!
 
 ENV['ADAPTER'] ||= 'active_record'
 load File.dirname(__FILE__) + "/support/adapters/#{ENV['ADAPTER']}.rb"
+
+UniqIdentifier.configure do |conf|
+  conf.generator = UniqIdentifier::FakeGenerator
+end
+
+RSpec.configure do |c|
+  c.run_all_when_everything_filtered = true
+end

data/spec/support/adapters/mongoid.yml

@@ -1,6 +1,6 @@
 test:
   sessions:
     default:
-      database: whatever
+      database: godfather
       hosts:
         - localhost:27017

data/spec/support/data.rb

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

data/spec/support/schema.rb

@@ -1,7 +1,9 @@
 ActiveRecord::Schema.define do
   self.verbose = false
+
   create_table(:users) do |t|
     t.string :name
     t.string :uuid
+    t.timestamps
   end
 end

data/spec/uniq_identifier/configuration_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+module UniqIdentifier
+  describe Configuration do
+
+    describe '#default' do
+      specify do
+        expect(subject.generator).to eql(SecureRandom)
+      end
+    end
+  end
+end

data/spec/uniq_identifier/uniq_identifier_spec.rb

@@ -6,4 +6,14 @@ describe UniqIdentifier do
   specify do
     expect(user.uuid).to match(/(.*)-(.*)-(.*)-(.*)-(.*)/)
   end
+
+  context 'persistence' do
+    let(:user_id) { user.id }
+
+    before { user.save! }
+
+    specify do
+      expect(User.find(user_id).uuid).to match(/(.*)-(.*)-(.*)-(.*)-(.*)/)
+    end
+  end
 end

data/uniq_identifier.gemspec

@@ -1,23 +1,23 @@
 require_relative 'lib/uniq_identifier/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "uniq_identifier"
+  spec.name          = 'uniq_identifier'
   spec.version       = UniqIdentifier::VERSION
-  spec.authors       = ["Joel AZEMAR"]
-  spec.email         = ["joel.azemar@gmail.com"]
-  spec.summary       = %q{This gem add uuid on your model.}
-  spec.description   = %q{This gem add uuid on your model. for agnostic backend}
-  spec.homepage      = "https://github.com/FinalCAD/uniq_identifier"
-  spec.license       = "MIT"
+  spec.authors       = ['Joel AZEMAR']
+  spec.email         = ['joel.azemar@gmail.com']
+  spec.summary       = %q{Add an uniq identifier}
+  spec.description   = %q{Add an uniq identifier on your models}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  # spec.add_development_dependency 'bundler', '~> 1.7'
+  # spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'rspec', '~> 3.1'
 
-  spec.required_ruby_version = '~> 2.1'
-end
+  # spec.required_ruby_version = '~> 2.2'
+end

metadata

@@ -1,80 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: uniq_identifier
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Joel AZEMAR
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-09 00:00:00.000000000 Z
+date: 2015-02-25 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-description: This gem add uuid on your model. for agnostic backend
+        version: '3.1'
+description: Add an uniq identifier on your models
 email:
 - joel.azemar@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/uniq_identifier/add_generator.rb
+- lib/generators/uniq_identifier/install_generator.rb
+- lib/generators/uniq_identifier/templates/README-active_record
+- lib/generators/uniq_identifier/templates/README-mongoid
+- lib/generators/uniq_identifier/templates/migration.rb
+- lib/generators/uniq_identifier/templates/uniq_identifier.rb
 - 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
+- spec/generators/active_record/add_generator_spec.rb
+- spec/generators/mongoid/add_generator_spec.rb
+- spec/generators/uniq_identifier/install_generator_spec.rb
 - spec/spec_helper.rb
 - spec/support/adapters/active_record.rb
 - spec/support/adapters/mongoid.rb
 - spec/support/adapters/mongoid.yml
+- spec/support/data.rb
 - spec/support/schema.rb
+- spec/uniq_identifier/configuration_spec.rb
 - spec/uniq_identifier/uniq_identifier_spec.rb
 - uniq_identifier.gemspec
-homepage: https://github.com/FinalCAD/uniq_identifier
+homepage: ''
 licenses:
 - MIT
 metadata: {}
@@ -84,9 +75,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -94,14 +85,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
-summary: This gem add uuid on your model.
+summary: Add an uniq identifier
 test_files:
+- spec/generators/active_record/add_generator_spec.rb
+- spec/generators/mongoid/add_generator_spec.rb
+- spec/generators/uniq_identifier/install_generator_spec.rb
 - spec/spec_helper.rb
 - spec/support/adapters/active_record.rb
 - spec/support/adapters/mongoid.rb
 - spec/support/adapters/mongoid.yml
+- spec/support/data.rb
 - spec/support/schema.rb
+- spec/uniq_identifier/configuration_spec.rb
 - spec/uniq_identifier/uniq_identifier_spec.rb