acts_as_inheritable 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61f0d977c0caf99cd17883ba4e0f0e1a945be197
-  data.tar.gz: 28d9e8a7c3bb486dcfba2970eedbb25d4d4ec22e
+  metadata.gz: de7f7a195cd330508b532fbcbac354f6443e1aa9
+  data.tar.gz: 1407afe5e36bdabca17bc62bf11513b284a3bc0a
 SHA512:
-  metadata.gz: 72b8c954ef211b5f35164393614ab2c062d418df267bfb5a5eeb771d5f4550e1d03f00898ddaacce18e1039fa04ce95e9902200faf3c39b7338f8bfae44b4773
-  data.tar.gz: e62c7d4bf845b2b476120537a674b6b05c9a8fa179f1d6de929a1c20beaaf082b812d18f6280cb53777b9d5a818a39fa8a5af0149fd886cda674b00505930f24
+  metadata.gz: 078ad8bfebed70c26e90d6a166c7d03367f7450c9c2ff01f155e28e965ac05ff9de19ecae784bb362686e96b4461b18467b9497c3832242220c57cb80c440694
+  data.tar.gz: 7bf5b0ef3d38faafb2ae3a3a16fd4c56dcac0a1eb52d38b7fb769bfe592b61b74c1255fac9ea0eb5d20e4d9ea15e712849baa71f6ef59924cc3a2e7d63779b82

data/README.md

@@ -1,8 +1,8 @@
 # ActsAsInheritable
 
-[![Gem Version](https://badge.fury.io/rb/acts_as_inheritable.svg)](https://badge.fury.io/rb/acts_as_inheritable) [![Build Status](https://travis-ci.org/esbanarango/acts_as_inheritable.svg)](https://travis-ci.org/esbanarango/acts_as_inheritable) [![Test Coverage](https://codeclimate.com/github/esbanarango/acts_as_inheritable/badges/coverage.svg)](https://codeclimate.com/github/esbanarango/acts_as_inheritable/coverage) [![Code Climate](https://codeclimate.com/github/esbanarango/acts_as_inheritable/badges/gpa.svg)](https://codeclimate.com/github/esbanarango/acts_as_inheritable)
+[![Gem Version](https://badge.fury.io/rb/acts_as_inheritable.svg)](https://badge.fury.io/rb/acts_as_inheritable) [![Build Status](https://travis-ci.org/esbanarango/acts_as_inheritable.svg)](https://travis-ci.org/esbanarango/acts_as_inheritable) [![Test Coverage](https://codeclimate.com/github/esbanarango/acts_as_inheritable/badges/coverage.svg)](https://codeclimate.com/github/esbanarango/acts_as_inheritable/coverage) [![Code Climate](https://codeclimate.com/github/esbanarango/acts_as_inheritable/badges/gpa.svg)](https://codeclimate.com/github/esbanarango/acts_as_inheritable) [![security](https://hakiri.io/github/esbanarango/acts_as_inheritable/master.svg)](https://hakiri.io/github/esbanarango/acts_as_inheritable/master)
 
-_Acts As Inheritable_ is a Ruby Gem specifically written for Rails/ActiveRecord models. It is mean to be used with the [_Self-Referential Association_](#self-referential-association), or with a model having a `parent` that share the inheritable attributes. This will let you inherit any __attribute__ or __relation__ from the _parent_ model.
+_Acts As Inheritable_ is a Ruby Gem specifically written for Rails/ActiveRecord models. It is meant to be used with the [_Self-Referential Association_](#self-referential-association), or with a model having a `parent` that share the inheritable attributes. This will let you inherit any __attribute__ or __relation__ from the _parent_ model.
 
 ### Self-Referential Association
 
@@ -33,15 +33,14 @@ Or install it yourself as:
     $ gem install acts_as_inheritable
 
 ## Usage
+You can enable ActsAsInheritable by adding `acts_as_inheritable` into your model. You need to define at least one option, either `attributes` or `associations`. Those options are _arrays_ containing the atrributes names or the associations names.
 
 ```ruby
 
 class Person < ActiveRecord::Base
-  acts_as_inheritable
 
-  # Constants
-  INHERITABLE_ATTRIBUTES = %w(favorite_color last_name soccer_team)
-  INHERITABLE_ASSOCIATIONS = %w(shoes pictures clan)
+  acts_as_inheritable attributes: %w(favorite_color last_name soccer_team),
+                      associations: %w(shoes pictures clan)
 
   # Associations
   belongs_to  :parent, class_name: 'Person'
@@ -69,21 +68,22 @@ son.favorite_color # => Green
 By adding `acts_as_inheritable` to your models you will have access to these methods:
 
 #### inherit_attributes
+> Signature `inherit_attributes(force = false, not_force_for=[])`
+
 By default this method  will only set values that are [blank?](http://api.rubyonrails.org/classes/Object.html#method-i-blank-3F).
 
-##### params
+###### params
   - `force`: Default to true. Set the attribute even if it's _present_.
   - `not_force_for`: Default to empty array. When setting `force` to _true_, you can also specify the attributes you don't want to overwrite.
 
 #### inherit_relations
+> Signature `inherit_relations(model_parent = send(:parent), current = self)`
 
 ```ruby
 
 class Person < ActiveRecord::Base
-  acts_as_inheritable
 
-  # Constants
-  INHERITABLE_ASSOCIATIONS = %w(pet)
+  acts_as_inheritable associations: %w(pet)
 
   # Associations
   has_one     :pet
@@ -103,8 +103,13 @@ son.pet.inspect # => #<Pet id: 2, person_id: 2, name: "Mango", breed: "Golden Re
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/acts_as_inheritable/fork )
+1. Fork it ( https://github.com/esbanarango/acts_as_inheritable/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 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
+
+## Author
+
+This was written by [Esteban Arango Medina](http://esbanarango.com) while working at [Blue Sky Cards](https://www.blueskycards.com/).
+>Thanks to [@danielosorio83](https://github.com/danielosorio83) who also wrote part of the logic for this gem.

data/lib/acts_as_inheritable.rb

@@ -2,7 +2,15 @@ require 'active_record'
 require "acts_as_inheritable/version"
 
 module ActsAsInheritable
-  def acts_as_inheritable
+  def acts_as_inheritable(options)
+    raise ArgumentError, "Hash expected, got #{options.class.name}" if !options.is_a?(Hash)
+    raise ArgumentError, "Empty options" if options[:attributes].empty? && options[:associations].empty?
+
+    class_attribute :inheritable_configuration
+
+    self.inheritable_configuration = {}
+    self.inheritable_configuration.merge!(options)
+
     class_eval do
       def has_parent?
         parent.present?
@@ -12,8 +20,8 @@ module ActsAsInheritable
       # relations defined on `INHERITABLE_ASSOCIATIONS`. For each instance on
       # each relation it re-creates it.
       def inherit_relations(model_parent = send(:parent), current = self)
-        if model_parent && model_parent.class.const_defined?("INHERITABLE_ASSOCIATIONS")
-          model_parent.class::INHERITABLE_ASSOCIATIONS.each do |relation|
+        if model_parent && model_parent.class.method_defined?(:inheritable_configuration)
+          model_parent.class::inheritable_configuration[:associations].each do |relation|
             parent_relation = model_parent.send(relation)
             relation_instances = parent_relation.respond_to?(:each) ? parent_relation : [parent_relation].compact
             relation_instances.each do |relation_instance|
@@ -54,7 +62,7 @@ module ActsAsInheritable
         end
         # Relations has a diffeent name
         unless new_relation.respond_to?(parent_name)
-          new_relation.class.reflections.keys.each do |reflection|
+          new_relation.class.reflections.each_key  do |reflection|
             parent_name = reflection if new_relation.class.reflections[reflection].class_name == model_parent.class.name
           end
         end
@@ -64,7 +72,7 @@ module ActsAsInheritable
       def inherit_attributes(force = false, not_force_for=[])
         if has_parent?
           # Attributes
-          self.class::INHERITABLE_ATTRIBUTES.each do |attribute|
+          self.class.inheritable_configuration[:attributes].each do |attribute|
             current_val = send(attribute)
             if (force && !not_force_for.include?(attribute)) || current_val.blank?
               send("#{attribute}=", parent.send(attribute))

data/lib/acts_as_inheritable/version.rb

@@ -1,3 +1,3 @@
 module ActsAsInheritable
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/acts_as_inheritable_spec.rb

@@ -5,6 +5,27 @@ require 'support/models'
 
 RSpec.describe "ActiveRecord::Base model with #acts_as_inheritable" do
 
+  describe 'describe `acts_as_inheritable` setup' do
+    context 'when `acts_as_inheritable` is defined without options' do
+      it 'raises an `ArgumentError`' do
+        expect{
+          class Person < ActiveRecord::Base
+            acts_as_inheritable
+          end
+        }.to raise_error(ArgumentError)
+      end
+    end
+    context 'when `acts_as_inheritable` is defined with empty options' do
+      it 'raises an `ArgumentError`' do
+        expect{
+          class Person < ActiveRecord::Base
+            acts_as_inheritable{attributes:[],associations:[]}
+          end
+        }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
   describe '#inherit_attributes' do
     let(:person){ create(:person, :with_parent, favorite_color: nil, last_name: nil, soccer_team: nil) }
     let!(:person_parent) { person.parent }

data/spec/support/models.rb

@@ -1,11 +1,9 @@
 require 'acts_as_inheritable'
 
 class Person < ActiveRecord::Base
-  acts_as_inheritable
 
-  # Constants
-  INHERITABLE_ATTRIBUTES = %w(favorite_color last_name soccer_team)
-  INHERITABLE_ASSOCIATIONS = %w(shoes pictures clan toys pet)
+  acts_as_inheritable attributes: %w(favorite_color last_name soccer_team),
+                      associations: %w(shoes pictures clan toys pet)
 
   # Associations
   belongs_to  :parent, class_name: 'Person'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_inheritable
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Esteban Arango Medina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2015-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -246,7 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Inheritable behavior for models with parent.
@@ -257,3 +257,4 @@ test_files:
 - spec/support/factories.rb
 - spec/support/migrations.rb
 - spec/support/models.rb
+has_rdoc: