public_uid 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76143c57285dda08be346c203901c384bc273bf0
-  data.tar.gz: 1bf42db639233d908a3bd447c57d9be3582fa572
+  metadata.gz: 84a09238730e59d9814e21cb6981e8679583f939
+  data.tar.gz: dfec8f57246595a82792f17c1280fc50302a7412
 SHA512:
-  metadata.gz: fd980096e936fa5816f1838aeb614d2d51dda724f66f046e45bceab9d072a0103e09a07325e92e800d45217352dc10cfe464c0897888b9711090c98d3a820428
-  data.tar.gz: 31f622b8165abae325f8c81921820fc18b91bf8dd0fe6c51a152c989834ef6a31b3841ef9d0a1e9ce40fec2ca57941e99e8f3c73b0591e0c8cad7d7a0cb7b8c3
+  metadata.gz: 20cb1ef26cd4f60ee236fa83c086be46c91a59011a942560bd740da7d640455e49cec638317dfcc4402cadc5bb18c027622edb653a7ff20b34e4f756986cdab1
+  data.tar.gz: 1f354dc5c5523d2c1ec2dd3f7f401da9d7d8f2e3c4ff471a91de8ebe0712ea7d8c291252ae9cb6b2505e7eb831145d2c1fa48651844024178f6d0dad16b2d1f0

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
   - 2.1.0
   - 2.1.1
+  - 2.2.2
   - ruby-head

data/README.md

@@ -156,6 +156,14 @@ u.save!       #=> true
 u.public_uid  #=> 2398
 ```
 
+### Rails rake task
+
+By using this gem you will automatically gain rake task `rake public_uid:generate`
+in your Rails application which will generate `public_uid` on the tables
+using `public_uid` on records where `public_uid == nil`.
+
+This is helpfull to generate `public_uid` on pre-existing recrods.
+
 ## Contributing
 
 1. Fork it

data/lib/public_uid.rb

@@ -5,4 +5,6 @@ require "public_uid/model"
 require "public_uid/generators/number_random"
 require "public_uid/generators/range_string"
 
+require 'public_uid/tasks' if defined?(Rails)
+
 require 'orm/active_record' if defined?(ActiveRecord::Base)

data/lib/public_uid/model.rb

@@ -4,20 +4,46 @@ module PublicUid
       base.extend(ClassMethods)
     end
 
-    def generate_uid
-      pub_uid = SetPublicUid.new(record: self, column: self.class.public_uid_column)
-      pub_uid.generate self.class.public_uid_generator
-      pub_uid.set
+    module InstanceMethods
+      def generate_uid
+        generate_uid! unless send(self.class.public_uid_column)
+      end
+
+      def generate_uid!
+        pub_uid = SetPublicUid.new(record: self, column: self.class.public_uid_column)
+        pub_uid.generate self.class.public_uid_generator
+        pub_uid.set
+      end
     end
 
     module ClassMethods
-      attr_reader :public_uid_column
-      attr_reader :public_uid_generator
+      attr_writer :public_uid_column
+      attr_writer :public_uid_generator
 
       def generate_public_uid(options={})
-        @public_uid_column    = options[:column]    || :public_uid
-        @public_uid_generator = options[:generator] || Generators::RangeString.new
-        before_create :generate_uid, unless: @public_uid_column
+        @public_uid_column    = options[:column]
+        @public_uid_generator = options[:generator]
+
+        _include_public_uid_instance_methods
+        _set_callback_to_generate_public_uid
+      end
+
+
+      def public_uid_column
+        @public_uid_column || :public_uid
+      end
+
+      def public_uid_generator
+        @public_uid_generator || Generators::RangeString.new
+      end
+
+      private
+      def _include_public_uid_instance_methods
+        self.include PublicUid::Model::InstanceMethods
+      end
+
+      def _set_callback_to_generate_public_uid 
+        self.before_create :generate_uid
       end
     end
   end

data/lib/public_uid/tasks.rb

@@ -0,0 +1,7 @@
+module PublicUid
+  class Tasks < Rails::Railtie
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }
+    end
+  end
+end

data/lib/public_uid/tasks/generate.rake

@@ -0,0 +1,22 @@
+namespace :public_uid do
+  desc "Generate public_uid on Models that have public_uid column on records that have nil public_uid"
+  task :generate => :environment do
+    Rails.application.eager_load!
+    ActiveRecord::Base.descendants.each do |model|
+      model.connection # establis conection
+
+      if model.instance_methods.collect(&:to_s).include?('generate_uid')
+        puts "Model #{model.name}: generating public_uids for missing records"
+
+        model
+          .where(public_uid: nil)
+          .tap { |scope| puts "  * generating #{scope.count} public_uid(s)" }
+          .each do |record_without_public_uid|
+            record_without_public_uid.generate_uid
+            record_without_public_uid.save!
+          end
+        puts ''
+      end
+    end
+  end
+end

data/lib/public_uid/version.rb

@@ -1,3 +1,3 @@
 module PublicUid
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/test/models/instance_methods_initialization_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+TestConf.orm_modules.each do |orm_module|
+  describe orm_module.description do
+    context "model doesn't want to generate public_uid" do
+
+      let(:model) do
+        "#{orm_module}::ModelWithoutGenaratePublicUid".constantize
+      end
+
+      it 'model should not expose :generate_uid public instance method' do
+        model.instance_methods.wont_include :generate_uid
+      end
+    end
+
+    context "model wants to generate public_uid" do
+      let(:model) do
+        "#{orm_module}::ModelWithGeneratorDefaults".constantize
+      end
+
+      it 'model should expose :generate_uid public instance method' do
+        model.instance_methods.must_include :generate_uid
+      end
+    end
+  end
+end

data/test/support/orm/active_record.rb

@@ -25,6 +25,10 @@ module ActRec
     generate_public_uid
   end
 
+  class ModelWithoutGenaratePublicUid < ActiveRecord::Base
+    self.table_name =  "users"
+  end
+
   class User < ActiveRecord::Base
     self.table_name = 'users'
   end

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: public_uid
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Tomas Valent
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-05 00:00:00.000000000 Z
+date: 2015-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: orm_adapter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
 - !ruby/object:Gem::Dependency
   name: rr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.2
 - !ruby/object:Gem::Dependency
   name: sqlite3
   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: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
 description: Automatic generates public unique identifier for model
@@ -115,8 +115,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -127,12 +127,15 @@ files:
 - lib/public_uid/generators/range_string.rb
 - lib/public_uid/model.rb
 - lib/public_uid/set_public_uid.rb
+- lib/public_uid/tasks.rb
+- lib/public_uid/tasks/generate.rake
 - lib/public_uid/version.rb
 - public_uid.gemspec
 - test/lib/generators/number_random_test.rb
 - test/lib/generators/range_string_test.rb
 - test/lib/set_public_uid_test.rb
 - test/models/custom_public_uid_column_test.rb
+- test/models/instance_methods_initialization_test.rb
 - test/models/model_with_custom_generator_test.rb
 - test/models/model_with_generator_defaults_test.rb
 - test/support/orm/active_record.rb
@@ -148,17 +151,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Automatic generates public UID column
@@ -167,6 +170,7 @@ test_files:
 - test/lib/generators/range_string_test.rb
 - test/lib/set_public_uid_test.rb
 - test/models/custom_public_uid_column_test.rb
+- test/models/instance_methods_initialization_test.rb
 - test/models/model_with_custom_generator_test.rb
 - test/models/model_with_generator_defaults_test.rb
 - test/support/orm/active_record.rb