activerecord-duplicate 0.5.1 → 0.6.0

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# 0.6.0 (April 24, 2012)
+
+* Associations must be declared explicit as duplicatable as well, e.g. `belongs_to :posts; attr_duplicatable :text, :posts`.
+
+* Without specifying `attr_duplicatable`, all attributes (except the primary-key) and associations will be duplicated automatically.
+  This allows you to skip the `attr_duplicatable` declarations completely, if you don't have special requirements.

data/README.md

@@ -4,13 +4,12 @@ Duplicating ActiveRecords is easy again. All you have to do:
 
 ```ruby
 class Post < ActiveRecord::Base
-  attr_duplicatable :title, :content
 end
 
 post.duplicate
 ```
 
-You want more controll? Check out this example:
+You want more control? Check out this example:
 
 ```ruby
 class Post < ActiveRecord::Base
@@ -23,16 +22,17 @@ class Post < ActiveRecord::Base
   has_many :comments
   has_many :tags
   
-  # These attributes will be duplicated.
-  attr_duplicatable :title, :content
+  # Only these attributes and associations will be duplicated.
+  attr_duplicatable :title, :content, :tags
 end
 
 class Tag < ActiveRecord::Base
-  attr_duplicatable :tag
+  belongs_to :post
+  
+  attr_duplicatable :tag, :post
 end
 
 class Comment < ActiveRecord::Base
-  before_duplication { false }
 end
 
 # Duplicates non-copyrighted posts and tags as well, but ignores comments.

data/activerecord-duplicate.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name          = 'activerecord-duplicate'
-  gem.version       = '0.5.1'
+  gem.version       = '0.6.0'
   gem.authors       = 'Mario Uher'
   gem.email         = 'uher.mario@gmail.com'
   gem.description   = gem.summary = 'Duplicating ActiveRecords is easy again.'

data/lib/activerecord-duplicate/duplicate.rb

@@ -18,7 +18,7 @@ module ActiveRecord::Duplicate
             value = case true
             
             # Duplicate attribute if whitelisted
-            when self.class.attr_duplicatable.include?(key.to_sym)
+            when self.class.attr_duplicatable?(key)
               value
             
             # If not whitelisted, set to default value
@@ -34,6 +34,8 @@ module ActiveRecord::Duplicate
           
           self.class.reflect_on_all_associations.each do |association|
             name = association.name
+            
+            next unless self.class.attr_duplicatable?(name)
             macro = association.macro
             association = self.association(association.name)
             
@@ -66,7 +68,12 @@ module ActiveRecord::Duplicate
   module ClassMethods
     def attr_duplicatable(*attributes)
       self._duplicatable_attributes = attributes.map(&:to_sym) if attributes.present?
-      self._duplicatable_attributes || []
+      self._duplicatable_attributes
+    end
+
+    def attr_duplicatable?(attribute)
+      attribute = attribute.to_sym
+      attr_duplicatable.present? ? attr_duplicatable.include?(attribute) : primary_key.to_sym != attribute
     end
 
     # Duplicated from activemodel/lib/active_model/validations/callbacks.rb

data/spec/acts_as_duplicator_spec.rb

@@ -1,11 +1,19 @@
 require File.expand_path('../spec_helper', __FILE__)
 
 describe ActiveRecord::Duplicate do
+  before do
+    ActiveRecord::Schema.define do
+      change_table :records do |t|
+        t.timestamps
+      end
+    end
+  end
+
   let(:klass) { Class.new(ActiveRecord::Base) { self.table_name = 'records' } }
 
 
   describe :attr_duplicatable do
-    it 'allows you to whitelist attributes' do
+    it 'allows you to whitelist attributes and associations' do
       klass.attr_duplicatable(:created_at, :updated_at)
     end
 
@@ -18,6 +26,60 @@ describe ActiveRecord::Duplicate do
   end
 
 
+  describe :attr_duplicatable? do
+    describe 'attr_duplicatable is not set' do
+      it 'returns for all attributes and associations true' do
+        klass.instance_eval do
+          has_many :records
+        end
+        
+        klass.attr_duplicatable?(:created_at).must_equal(true)
+        klass.attr_duplicatable?(:updated_at).must_equal(true)
+        klass.attr_duplicatable?(:records).must_equal(true)
+      end
+
+
+      # but
+      it 'returns false for the primary-key' do
+        klass.attr_duplicatable?(:id).must_equal(false)
+      end
+    end
+
+
+    describe 'attr_duplicatable is set' do
+      it 'returns whether an attribute is allowed to duplicated or not' do
+        klass.instance_eval do
+          has_many :records
+          
+          attr_duplicatable :created_at, :records
+        end
+        
+        klass.attr_duplicatable?(:created_at).must_equal(true)
+        klass.attr_duplicatable?(:updated_at).must_equal(false)
+        klass.attr_duplicatable?(:records).must_equal(true)
+      end
+
+
+      it 'allows primary-keys only if explicit set' do
+        klass.instance_eval do
+          attr_duplicatable :id
+        end
+        
+        klass.attr_duplicatable?(:id).must_equal(true)
+      end
+
+
+      it 'allows (non-standard) primary-keys only if explicit set' do
+        klass.instance_eval do
+          attr_duplicatable primary_key
+        end
+        
+        klass.attr_duplicatable?(klass.primary_key).must_equal(true)
+      end
+    end
+  end
+
+
   describe 'before_duplication { false }' do
     it 'marks associations as non-duplicatable' do
       klass.instance_eval do
@@ -30,7 +92,7 @@ describe ActiveRecord::Duplicate do
 
 
   describe :duplicate do
-    it 'duplicates records' do
+    it 'duplicates records' do      
       record = klass.create
       duplicate = record.duplicate
       

data/spec/integration_spec.rb

@@ -24,11 +24,13 @@ describe 'Integration' do
         t.integer    :value
       end
     end
-    
+
     class Blog < ActiveRecord::Base
       has_many :posts, inverse_of: :blog
+      
+      attr_duplicatable :posts
     end
-    
+
     class Post < ActiveRecord::Base
       # Don't duplicate copyrighted posts
       before_duplication { !self.is_copyrighted? }
@@ -38,21 +40,22 @@ describe 'Integration' do
       has_many :comments
       has_many :ratings, as: :parent
       
-      attr_duplicatable :title, :content
-      class_attribute :counter
+      attr_duplicatable :title, :content, :blog, :ratings
       
       validates :title, presence: true, uniqueness: true
     end
-    
+
     class Comment < ActiveRecord::Base
-      before_duplication { false }
-      
       belongs_to :post
       has_many :ratings, as: :parent
+      
+      attr_duplicatable :ratings, :post
     end
-    
+
     class Rating < ActiveRecord::Base
       belongs_to :parent, polymorphic: true
+      
+      attr_duplicatable :parent
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-duplicate
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-20 00:00:00.000000000 Z
+date: 2012-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70282697881420 !ruby/object:Gem::Requirement
+  requirement: &70185001321060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70282697881420
+  version_requirements: *70185001321060
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70282697880800 !ruby/object:Gem::Requirement
+  requirement: &70185001320660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70282697880800
+  version_requirements: *70185001320660
 - !ruby/object:Gem::Dependency
   name: purdytest
-  requirement: &70282697880060 !ruby/object:Gem::Requirement
+  requirement: &70185001369300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70282697880060
+  version_requirements: *70185001369300
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70282697879480 !ruby/object:Gem::Requirement
+  requirement: &70185001368800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '3.1'
   type: :development
   prerelease: false
-  version_requirements: *70282697879480
+  version_requirements: *70185001368800
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70282697879060 !ruby/object:Gem::Requirement
+  requirement: &70185001368380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70282697879060
+  version_requirements: *70185001368380
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70282697878580 !ruby/object:Gem::Requirement
+  requirement: &70185001367920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70282697878580
+  version_requirements: *70185001367920
 description: Duplicating ActiveRecords is easy again.
 email: uher.mario@gmail.com
 executables: []
@@ -84,6 +84,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile