inherited-attributes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: debc03f6def20cff892f28c8dee0e332b4a9021f
+  data.tar.gz: 764ce557abcb939139c0f822eaebb7c653323910
+SHA512:
+  metadata.gz: f7090f1d2f5dde67b3cea7bd60f9cec178476b89869550921d65d0ff6585cbb1b82c32e3cda2d474b2be927e56c9ddc60a99f57c76987590146a4f7b73ddeea0
+  data.tar.gz: ac622fe4603b0383e10b3e21f308a3d36b1f889f55b3c82271408a42458990807379751f12ea80c3e40c64840dd00bca1280b059f0d02d6b845ea11f1b19a55f

data/README.md

@@ -0,0 +1,104 @@
+# Inherited::Attributes
+
+Extends [ancestry](https://github.com/stefankroes/ancestry) to allow attributes to be inherited from ancestors.
+
+When you want nodes in your tree to be able to get default values for their
+attributes from their parent.
+
+## Usage
+
+### Tell your model that it has inherited attributes
+
+```ruby
+class Node < ActiveRecord::Base
+  has_ancestry
+
+  inherited_attribute :value
+
+  # If the root node has a nil location, use this as the default value instead.
+  # Note the special syntax - the default value is evaluated.
+  # strings: '"<the default>"'
+  # booleans: '<true|false>'
+  # integers: '<number>'
+  # enumerations: '"<name of the enum>"'
+  inherited_attribute :location, :default => '"Saint Louis"'
+end
+```
+
+### Accessing Inherited Attributes
+
+```
+root       = Node.create!
+child      = Node.create!(:parent => root, :value => 12, :location => "Boston")
+grandchild = Node.create!(:parent => child)
+
+# ------------------------------------------------------------------------------
+# The value of the node, without ancestry
+# ------------------------------------------------------------------------------
+root.value       # nil
+child.value      # 12
+grandchild.value # nil
+
+root.location       #
+child.location      # 'Boston'
+grandchild.location # nil
+
+# ------------------------------------------------------------------------------
+# The value of the node, or the inherited value if its not set
+# ------------------------------------------------------------------------------
+root.effective_value       # nil
+child.effective_value      # 12
+grandchild.effective_value # 12 -- inherited from child
+
+root.effective_location       # 'Saint Louis' -- using the default value
+child.effective_location      # 'Boston'      -- Using the node's value
+grandchild.effective_location # 'Boston'      -- Inherited from child
+
+# ------------------------------------------------------------------------------
+# The inherited value of the node or the default, ignoring the node's value
+# ------------------------------------------------------------------------------
+root.inherited_value        # nil
+child.inherited_value       # nil
+grandchild.inherited_value  # 12 -- inherited from child
+
+root.inherited_location       # 'Saint Louis' -- using the default value
+child.inherited_location      # 'Saint Louis' -- Inherited from root
+grandchild.inherited_location # 'Boston'      -- Inherited from child
+
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'inherited-attributes'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install inherited-attributes
+```
+
+## Contributing
+
+1. Fork the repo.
+
+2. Run the tests (appraisal rake spec). We only take pull requests with passing tests, and it's great
+to know that you have a clean slate: `bundle && rake`
+
+3. Add a test for your change. Only refactoring and documentation changes
+require no new tests. If you are adding functionality or fixing a bug, we need
+a test!
+
+4. Make the test pass.
+
+5. Push to your fork and submit a pull request.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rubygems'
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Inherited::Attributes'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/inherited/attributes.rb

@@ -0,0 +1,37 @@
+module Inherited
+  module Attributes
+    module ClassMethods
+      def inherited_attribute(*fields_or_method)
+        options = fields_or_method.extract_options!.reverse_merge({:default=>'nil'})
+        fields_or_method.each do |method|
+          eval <<-EOS
+            class_eval do
+              def effective_#{method}
+                if @effective_#{method}.nil?
+                  @effective_#{method} = (self.#{method}.blank? && !(self.#{method} == false)) ? inherited_#{method} : self.#{method}
+                end
+                @effective_#{method}
+              end
+
+              def inherited_#{method}
+                if @inherited_#{method}.nil?
+                  @inherited_#{method} = ancestors.map(&:#{method}).reject{ |val| val.blank? && !(val == false)}.compact.last
+                  if (@inherited_#{method}.blank? && !(@inherited_#{method} == false))
+                    @inherited_#{method} = self.class.new(:#{method} => #{options[:default]}).#{method}
+                  end
+                end
+                @inherited_#{method}
+              end
+            end
+          EOS
+        end
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, Inherited::Attributes

data/lib/inherited/attributes/version.rb

@@ -0,0 +1,5 @@
+module Inherited
+  module Attributes
+    VERSION = '0.1.0'
+  end
+end

data/lib/tasks/inherited/attributes_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :inherited_attributes do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: inherited-attributes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Naegle
+- Rob Mathews
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ancestry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.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: appraisal
+  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: shoulda
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: pry
+  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'
+description: Extends ancestry to allow attributes to be inherited from ancestors.
+email:
+- john.naegle@goodmeasures.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/inherited/attributes.rb
+- lib/inherited/attributes/version.rb
+- lib/tasks/inherited/attributes_tasks.rake
+homepage: https://github.com/GoodMeasuresLLC/inherited-attributes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Extends ancestry to allow attributes to be inherited from ancestors.
+test_files: []