ancestree 0.1.0

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+gem 'rake'
+gem 'bundler', '1.0.0.rc.5'
+gem 'activesupport', '3.0.0.rc'
+gem 'activerecord', '3.0.0.rc'
+gem "rspec", '2.0.0.beta.19'
+
+gem 'jeweler'

data/Gemfile.lock

@@ -0,0 +1,48 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.0.rc)
+      activesupport (= 3.0.0.rc)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0.rc)
+      activemodel (= 3.0.0.rc)
+      activesupport (= 3.0.0.rc)
+      arel (~> 0.4.0)
+      tzinfo (~> 0.3.22)
+    activesupport (3.0.0.rc)
+    arel (0.4.0)
+      activesupport (>= 3.0.0.beta)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    i18n (0.4.1)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    rake (0.8.7)
+    rspec (2.0.0.beta.19)
+      rspec-core (= 2.0.0.beta.19)
+      rspec-expectations (= 2.0.0.beta.19)
+      rspec-mocks (= 2.0.0.beta.19)
+    rspec-core (2.0.0.beta.19)
+    rspec-expectations (2.0.0.beta.19)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.19)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 3.0.0.rc)
+  activesupport (= 3.0.0.rc)
+  bundler (= 1.0.0.rc.5)
+  jeweler
+  rake
+  rspec (= 2.0.0.beta.19)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,23 @@
+Ancestree
+=========
+
+Ancestree is a simple Rails 3 plugin that makes it easy to automatically inherit attributes from a parent object.
+
+Ancestree makes a few assumptions about the objects that will be inheriting attributes -- namely, objects should be in a tree-like structure, with each object responding to '#parent' up the tree, with the top-level objects returning nil for parent.
+
+
+Example
+=======
+
+Let's assume you have a Node model in your Rails app and that Node objects each have a parent. You want Nodes to be "disabled" if it or any of its parents are disabled:
+
+class Node < ActiveRecord::Base
+  include InheritAncestorAttributes
+  
+  belongs_to :parent, :class_name => 'Node'
+  
+  inherit_ancestor_attributes :disabled?
+end 
+
+
+Copyright (c) 2010 Brian Rose, released under the MIT license

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the ancestree plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the ancestree plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Ancestree'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "ancestree"
+    gemspec.summary = "Rails 3 plugin to inherit attributes"
+    gemspec.description = "Ancestree is a Rails 3 plugin that makes inheriting properties from parent objects in tree-like structure simple."
+    gemspec.email = "brian@heimidal.net"
+    gemspec.homepage = "http://github.com/heimidal/ancestree"
+    gemspec.authors = ["Brian Rose", "Gabe Varela"]
+    gemspec.add_development_dependency('rspec', '2.0.0.beta.19')
+    gemspec.add_dependency('activesupport', '>= 3.0.0.rc')
+    gemspec.add_dependency('activerecord', '>= 3.0.0.rc')
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+Jeweler::GemcutterTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/ancestree.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ancestree}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brian Rose", "Gabe Varela"]
+  s.date = %q{2010-08-20}
+  s.description = %q{Ancestree is a Rails 3 plugin that makes inheriting properties from parent objects in tree-like structure simple.}
+  s.email = %q{brian@heimidal.net}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "Gemfile",
+     "Gemfile.lock",
+     "MIT-LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "ancestree.gemspec",
+     "init.rb",
+     "install.rb",
+     "lib/ancestree.rb",
+     "spec/inherit_ancestor_attributes_spec.rb",
+     "spec/spec_helper.rb",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/heimidal/ancestree}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Rails 3 plugin to inherit attributes}
+  s.test_files = [
+    "spec/inherit_ancestor_attributes_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["= 2.0.0.beta.19"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.0.rc"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 3.0.0.rc"])
+    else
+      s.add_dependency(%q<rspec>, ["= 2.0.0.beta.19"])
+      s.add_dependency(%q<activesupport>, [">= 3.0.0.rc"])
+      s.add_dependency(%q<activerecord>, [">= 3.0.0.rc"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["= 2.0.0.beta.19"])
+    s.add_dependency(%q<activesupport>, [">= 3.0.0.rc"])
+    s.add_dependency(%q<activerecord>, [">= 3.0.0.rc"])
+  end
+end
+

data/init.rb

@@ -0,0 +1,5 @@
+require 'ancestree'
+
+class ActiveRecord::Base
+  include InheritAncestorAttributes
+end

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/ancestree.rb

@@ -0,0 +1,43 @@
+module InheritAncestorAttributes
+  extend ActiveSupport::Concern
+  
+  def inherits_from_ancestor?(method)
+    !gets_value_locally?(method)
+  end
+
+  private
+
+  def gets_value_locally?(method)
+    send("#{method}_without_parent") == send(method)
+  end
+
+  module ClassMethods
+    @@inherit_ancestor_attributes = []
+
+    def inherit_ancestor_attributes(*attrs)
+      self.define_attribute_methods
+      attrs.each do |attr|
+        create_inheritable_method(attr)
+        @@inherit_ancestor_attributes << attr.to_sym
+        method_added(attr) if method_defined?(attr)
+      end
+    end
+
+    def create_inheritable_method(attribute)
+      name = attribute.to_s.gsub(/(\?|!)/, '')
+      define_method "#{name}_with_parent#{$1}".to_sym do
+        val = send("#{name}_without_parent#{$1}") || parent.try(attribute.to_sym)
+        val ||= send("default_#{name}") if respond_to?("default_#{name}")
+        val
+      end
+    end
+
+    def method_added(name)
+      if defined?(:@@inherit_ancestor_attributes) && @@inherit_ancestor_attributes.include?(name)
+        @@inherit_ancestor_attributes.delete(name)
+        alias_method_chain name, :parent
+      end
+    end
+
+  end
+end

data/spec/inherit_ancestor_attributes_spec.rb

@@ -0,0 +1,163 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+module MockConcern
+  extend ActiveSupport::Concern
+
+  included do
+    inherit_ancestor_attributes :some_method
+  end
+
+  def mixin_name
+    "mixin_name #{self.name}" if self.name
+  end
+end
+
+class MockTreeNode
+  def self.define_attribute_methods
+    attr_accessor :age
+  end
+
+  include InheritAncestorAttributes
+  include MockConcern
+
+  inherit_ancestor_attributes :name, :age, :company, :active?, :bang!
+  attr_accessor :name, :company, :active, :bang
+
+  attr_accessor :parent
+
+  def default_company
+    "Apple"
+  end
+
+  def active?
+    active
+  end
+
+  def bang!
+    bang
+  end
+end
+
+class OtherMockClass
+  def self.define_attribute_methods
+    attr_accessor :name, :other_attr
+  end
+
+  include InheritAncestorAttributes
+  include MockConcern
+
+  inherit_ancestor_attributes :name, :other_attr
+
+  attr_accessor :parent
+end
+
+describe InheritAncestorAttributes do
+  context "with parent" do
+    subject { node = MockTreeNode.new; node.parent = MockTreeNode.new; node }
+
+    it "inherits a defined method declared in the base class" do
+      subject.parent.name = "Bob"
+      subject.name.should == "Bob"
+    end
+
+    it "returns set value of defined method declared in the base class" do
+      subject.parent.name = "Bob"
+      subject.name = "Rich"
+      subject.name.should == "Rich"
+    end
+
+    it "inherits a defined method declared in a mixin" do
+      subject.parent.name = "Paul"
+      subject.mixin_name.should == "mixin_name Paul"
+    end
+
+    it "returns set value for defined method declared in a mixin" do
+      subject.parent.name = "Paul"
+      subject.name = "Max"
+      subject.mixin_name.should == "mixin_name Max"
+    end
+
+    it "inherits an attribute that is lazy-loaded by Rails" do
+      subject.parent.instance_variable_set(:@age, 16)
+      subject.age.should == 16
+    end
+
+    it "has a default" do
+      subject.company.should == "Apple"
+    end
+
+    it "tells us it inherits the value from its parent" do
+      subject.parent.name = "Joe"
+      subject.inherits_from_ancestor?(:name).should be_true
+    end
+
+    it "tells us it doesn't inherit the value from its parent" do
+      subject.parent.name = "Joe"
+      subject.name = "Ken"
+      subject.inherits_from_ancestor?(:name).should be_false
+    end
+
+    it "tells us it doesn't inherit the value from its parent when the values are the same" do
+      subject.parent.name = "Bill"
+      subject.name = "Bill"
+      subject.inherits_from_ancestor?(:name).should be_false
+    end
+
+    it "inherits properly when a question mark exists in the method name" do
+      subject.parent.active = true
+      subject.should be_active
+      subject.should respond_to(:active_with_parent?)
+    end
+
+    it "inherits properly when a bang exists in the method name" do
+      subject.parent.bang = true
+      subject.bang!.should be_true
+      subject.should respond_to(:bang_with_parent!)
+    end
+  end
+
+  context "without parent" do
+    subject { MockTreeNode.new }
+
+    it "returns the value of a defined method declared in the base class" do
+      subject.name = "Bob"
+      subject.name.should == "Bob"
+    end
+
+    it "returns the value of a defined method declared in a mixin" do
+      subject.name = "Paul"
+      subject.name.should == "Paul"
+    end
+
+    it "returns the value of an attribute lazy-loaded by Rails" do
+      subject.age = 25
+      subject.age.should == 25
+    end
+
+    it "returns the set value even if default exists" do
+      subject.company = "Factory Labs"
+      subject.company.should == "Factory Labs"
+    end
+
+    it "has a default" do
+      subject.company.should == "Apple"
+    end
+  end
+
+  context 'with multiple inheriting classes' do
+    before do
+      @node_1 = MockTreeNode.new
+      @node_2 = OtherMockClass.new
+    end
+
+    it "should not inherit attrs that aren't part of the specified class" do
+      lambda { @node_1.other_attr }.should raise_error
+      lambda { @node_2.other_attr }.should_not raise_error
+    end
+
+    it "should not inherit attrs that aren't part of the specified class (2)" do
+      lambda { @node_1.age }.should_not raise_error
+      lambda { @node_2.age }.should raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+# This file is copied to ~/spec when you run 'ruby script/generate rspec'
+# from the project root directory.
+
+#ENV["RAILS_ENV"] = 'test'
+ENV["RACK_ENV"] = 'test'
+
+require 'active_support'
+require 'active_record'
+require File.expand_path("../../init", __FILE__)
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  # We are using factory_girl_rails instead of fixtures
+  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, comment the following line or assign false
+  # instead of true.
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification 
+name: ancestree
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Brian Rose
+- Gabe Varela
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-20 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 62196421
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 19
+        version: 2.0.0.beta.19
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7712042
+        segments: 
+        - 3
+        - 0
+        - 0
+        - rc
+        version: 3.0.0.rc
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7712042
+        segments: 
+        - 3
+        - 0
+        - 0
+        - rc
+        version: 3.0.0.rc
+  type: :runtime
+  version_requirements: *id003
+description: Ancestree is a Rails 3 plugin that makes inheriting properties from parent objects in tree-like structure simple.
+email: brian@heimidal.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- ancestree.gemspec
+- init.rb
+- install.rb
+- lib/ancestree.rb
+- spec/inherit_ancestor_attributes_spec.rb
+- spec/spec_helper.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/heimidal/ancestree
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rails 3 plugin to inherit attributes
+test_files: 
+- spec/inherit_ancestor_attributes_spec.rb
+- spec/spec_helper.rb