has_inherited 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+test.log

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mark Turner
+
+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.rdoc

@@ -0,0 +1,87 @@
+= has_inherited
+
+Easily share variables between Rails models with inheritance.
+
+== Installation
+
+  ➜  ~  gem install has_inherited
+
+== Using has_inheritable
+
+The intention of this library is to make it easy to inherit particular variables between models in rails apps. We start with a parent model that will function as a pseudo-polymorphic association for children objects.
+
+=== 1. Define a parent object
+
+  class Seo < ActiveRecord::Base
+    is_inheritable
+  end
+
+Use the following as a migration guideline. *Note:* The table structure is important.
+
+  create_table :seos do |t|
+    t.integer :inheritable_id
+    t.string  :inheritable_type
+    t.string  :name, :limit => 50, :null => false
+    t.string  :value
+    t.string  :value_type
+  end
+
+=== 2. Define child objects. 
+
+  class Industry < ActiveRecord::Base
+    has_inherited :seo, :from => Seo
+    has_many :clients
+  end
+
+This gives industry instances access to the seo namespace from the Seo object. In this case it will end up being `industry.seo.X`
+
+  class Client < ActiveRecord::Base
+    belongs_to :industry
+    has_many :stores
+    has_inherited :seo, :from => [:industry, :seo], :inherit_class => 'Seo'
+  end
+
+This gives client instances access to the seo namespace from its associated industry. You also have to specify the `:inherit_class` so we know what table to look up. 
+
+=== Examples
+
+  #Set the SEO global title
+  #Seo.global.title = "SEO Title"
+
+  #Grab that child industry title
+  industry.seo.title
+  # => 'SEO Title'
+
+  #Grab the client title
+  client.seo.title
+  # => 'SEO Title'
+
+  #Change the industry title
+  industry.seo.title = 'Industry Title'
+
+  #Check the client
+  client.seo.title
+  # => 'Industry Title'
+
+  #Grab all the Keys for the client
+  client.seo.all
+  # => {:title=>"Industry Title"}
+
+  #Grab all the non-inherited keys from the client
+  client.seo.all(false)
+  # => {}
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Mark Turner. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "has_inherited"
+    gem.summary = "Easily share variables between Rails models with inheritance."
+    gem.description = "The intention of this library is to make it easy to inherit particular variables between models in rails apps. We start with a parent model that will function as a pseudo-polymorphic association for children objects."
+    gem.email = "mark@amerine.net"
+    gem.homepage = "http://github.com/amerine/has_inherited"
+    gem.authors = ["Mark Turner"]
+    gem.add_development_dependency "bacon", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |spec|
+    spec.libs << 'spec'
+    spec.pattern = 'spec/**/*_spec.rb'
+    spec.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "has_inherited #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/has_inherited.gemspec

@@ -0,0 +1,54 @@
+# 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{has_inherited}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mark Turner"]
+  s.date = %q{2010-11-17}
+  s.description = %q{The intention of this library is to make it easy to inherit particular variables between models in rails apps. We start with a parent model that will function as a pseudo-polymorphic association for children objects.}
+  s.email = %q{mark@amerine.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "has_inherited.gemspec",
+     "lib/has_inherited.rb",
+     "spec/has_inherited_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/amerine/has_inherited}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Easily share variables between Rails models with inheritance.}
+  s.test_files = [
+    "spec/has_inherited_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<bacon>, [">= 0"])
+    else
+      s.add_dependency(%q<bacon>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<bacon>, [">= 0"])
+  end
+end
+

data/lib/has_inherited.rb

@@ -0,0 +1,177 @@
+module HasInherited
+  def self.included(base)
+    base.extend ClassMethods
+  end # self.included
+
+  module ClassMethods
+    def is_inheritable(*name)
+      attr = name.shift || :global
+      assoc = "_#{attr}"
+        
+      named_scope assoc.to_sym,
+          :conditions => 'inheritable_id IS NULL AND inheritable_type IS NULL'
+
+      (class << self; self; end).instance_eval do
+        define_method attr do
+          instance_variable_get(:"@#{attr.to_s}") || instance_variable_set(:"@#{attr.to_s}", InheritAccessor.new(self, assoc.to_sym, nil))
+        end
+      end
+
+      belongs_to :inheritable, :polymorphic => true
+      include HasInherited::InstanceMethods
+    end
+
+    def has_inherited(*opts)
+      options = opts.extract_options!
+      attr = opts.shift || 'inheritable'
+      assoc = "_#{attr}"
+      class_name = options[:inherit_class] || 'Seo'
+
+      has_many assoc.to_sym, :class_name => class_name, :as => :inheritable, :dependent => :destroy
+
+      define_method attr do
+      instance_variable_get(:"@#{attr.to_s}") || instance_variable_set(:"@#{attr.to_s}", InheritAccessor.new(self, assoc.to_sym, options[:from]))
+      end
+    end
+  end # ClassMethods
+
+  class InheritAccessor
+    # In 1.9 I would use a BasicObject here. A conditional check wouldn't hurt.
+    instance_methods.each {|m| undef_method m unless m.to_s =~ /(^__|send|inject)/}
+
+    def initialize(owner, assoc, heritage)
+      @owner = owner
+      @assoc = @owner.send(assoc)
+      if heritage.kind_of? Array
+        @parent = heritage.first
+        @parent_accessor = heritage.second
+      else
+        @parent = heritage
+      end
+
+      if @parent && @parent_accessor.nil?
+        if @parent.kind_of? Class
+          @parent_accessor = :global
+        else
+          @parent_accessor = :inheritable
+        end
+      end
+    end
+
+    def [](attribute)
+      attr_value = find_attr(attribute).try(:value)
+      if attr_value.nil? && has_parent?
+        return parent.__send__(:[], attribute)
+      else
+        return attr_value
+      end
+    end
+
+    def []=(attribute, value)
+      attr = find_attr(attribute)
+      if value.nil?
+        attr.delete if attribute
+      else
+        if attr.nil?
+          if @owner.respond_to?(:new_record?) && @owner.new_record?
+            attr = @assoc.build(:name => attribute.to_s, :value => value)
+          else
+            attr = @assoc.create(:name => attribute.to_s, :value => value)
+          end
+        else
+          attr.update_attributes(:value => value)
+        end
+      end
+    end
+
+    def all(inherited = true)
+      all_values = {}
+      @assoc.all.each {|inherited| all_values[inherited.name.to_sym] = inherited.value}
+      if inherited
+        parent_proxy = parent
+        while parent_proxy
+          parent_proxy_hash = parent_proxy.__send__(:all, false)
+          all_values.reverse_merge! parent_proxy_hash
+          parent_proxy = parent_proxy.__send__(:parent)
+        end
+      end
+      all_values
+    end
+
+    private 
+
+    def parent
+      if has_parent?
+        parent = @parent.is_a?(Class) ? @parent : @owner.__send__(@parent)
+        parent.__send__(@parent_accessor)
+      else
+        nil
+      end
+    end
+
+    def find_attr(attr)
+      @assoc.first(:conditions => ['name = ?', attr.to_s])
+    end
+
+    def has_parent?
+      !! @parent
+    end
+
+    def method_missing(symbol, *args)
+      name = symbol.to_s
+      if name =~ /=$/
+        self[name.gsub(/=$/, '')] = args.first
+      else
+        self[name]
+      end
+    end
+  end
+
+  module InstanceMethods
+    def value
+      case self[:value_type]
+      when 'String'
+        self[:value]
+      when  'Fixnum', 'Bignum'
+        Integer(self[:value])
+      when 'Float'
+        Float(self[:value])
+      when 'Symbol'
+        self[:value].to_sym
+      when 'TrueClass'
+        true
+      when 'FalseClass'
+        false
+      when 'Time'
+        Time.parse(self[:value])
+      when 'Date'
+        Date.parse(self[:value])
+      when 'DateTime'
+        DateTime.parse(self[:value])
+      else
+        self[:value]
+      end
+    end
+
+    def value=(new_value)
+      if new_value.nil?
+        self[:value] = self.value_type = nil
+      else
+        new_type = new_value.class.to_s
+        case new_type
+        when 'Symbol'
+          new_value = new_value.to_s
+        when 'Fixnum', 'Float', 'Bignum', 'TrueClass', 'FalseClass'
+          new_value = new_value.to_s
+        when 'Time', 'Date', 'DateTime'
+          new_value = new_value.to_s(:rfc822)
+        end
+        self[:value] = new_value
+        self.value_type = new_type
+      end
+    end
+
+  end
+end
+
+ActiveRecord::Base.send(:include, HasInherited)

data/spec/has_inherited_spec.rb

@@ -0,0 +1,203 @@
+require 'spec_helper'
+
+
+class Seo < ActiveRecord::Base
+  is_inheritable
+end
+
+class Industry < ActiveRecord::Base
+  has_inherited :seo, :from => Seo
+  has_many :clients
+end
+
+class Client < ActiveRecord::Base
+  belongs_to :industry
+  has_many :stores
+  has_inherited :seo, :from => [:industry, :seo], :inherit_class => 'Seo'
+end
+
+class Store < ActiveRecord::Base
+  belongs_to :client
+  has_inherited :seo, :from => [:client, :seo], :inherit_class => 'Seo'
+end
+
+describe "HasInherited" do
+
+  before do
+    ActiveRecord::Base.logger = Logger.new('test.log')
+    ActiveRecord::Base.logger.level = Logger::DEBUG
+    ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+    ActiveRecord::Schema.suppress_messages do
+      ActiveRecord::Schema.define(:version => 1) do
+        create_table :seos do |t|
+          t.integer :inheritable_id
+          t.string  :inheritable_type
+          t.string  :name, :limit => 50, :null => false
+          t.string  :value
+          t.string  :value_type
+        end
+
+        create_table :industries do |t|
+          t.name :string
+          t.timestamps
+        end
+
+        create_table :clients do |t|
+          t.name :string
+          t.references :industry
+          t.timestamps
+        end
+
+        create_table :stores do |t|
+          t.name :string
+          t.references :client
+          t.timestamps
+        end
+
+      end
+    end
+  end
+
+  after do
+    ActiveRecord::Base.connection.tables.each do |t|
+      ActiveRecord::Base.connection.drop_table(t)
+    end
+  end
+
+  it 'should have a value' do
+    s = Seo.new
+    s.value = "Some Title"
+    s.value.should.equal "Some Title"
+  end
+
+  it "has the ability to set global variables" do
+    Seo.global.title = "Title"
+    Seo.global.title.should.equal "Title"
+  end
+
+  it "should be able to set variables" do
+    Seo.global.title = "Title"
+    industry = Industry.create
+    industry.seo.title.should.equal "Title"
+  end
+
+  it "should work with two levels of nesting" do
+    Seo.global.title = "SEO Title"
+    industry = Industry.create
+    client = industry.clients.create
+    client.seo.title.should.equal 'SEO Title'
+  end
+
+  it "should work with three levels of nesting" do
+    Seo.global.title = "SEO Title"
+    industry = Industry.create
+    client = industry.clients.create
+    client.seo.title.should.equal "SEO Title"
+    client.seo.title = "Client Title"
+    client.seo.title.should.equal "Client Title"
+  end
+
+  it "Should allow you to see all the custom values" do
+    Seo.global.title = "SEO Title"
+    Seo.global.keywords = "Awesome, Words, Are, Awesome"
+    Seo.global.luke = "Luke"
+    industry = Industry.create
+    industry.seo.luke = "Luke 2"
+    industry.seo.luke = nil
+    client = industry.clients.create
+    client.seo.title = "Client Title"
+    client.seo.keywords = "Awesome"
+    client.seo.all.size.should.equal 3
+    puts client.seo.all.inspect
+    client.seo.luke.should.equal 'Luke'
+  end
+
+
+  it "should allow you to not include parent objects when grabbing all" do
+    Seo.global.title = "SEO Title"
+
+    industry = Industry.create
+    industry.seo.title = "Industry Title"
+
+    client = industry.clients.create
+    client.seo.title = "Client Title"
+
+    store = client.stores.create
+    store.seo.title = "Store Title"
+
+    store.seo.all(false).size.should.equal 1
+    client.seo.all(false).size.should.equal 1
+    industry.seo.all(false).size.should.equal 1
+  end
+
+  it "should work with four levels of nesting" do
+    Seo.global.title = "SEO Title"
+    industry = Industry.create
+    client = industry.clients.create
+    store = client.stores.create
+    store.seo.title.should.equal "SEO Title"
+  end
+
+  describe "Type Conversion" do
+    it "should store and retrieve Strings" do
+      Seo.global.title = "Title"
+      Seo.global.title.class.should.equal String
+    end
+
+    it "should store and retrieve Fixnums" do
+      Seo.global.number = 42
+      Seo.global.number.class.should.equal Fixnum
+    end
+
+    it "should store and retrieve Bignums" do
+      Seo.global.number = 123456789101112131415161718123
+      Seo.global.number.class.should.equal Bignum
+      Seo.global.number.should.equal 123456789101112131415161718123
+    end
+
+    it "should store and retrieve Floats" do
+      Seo.global.float = 1.2345678910
+      Seo.global.float.class.should.equal Float
+      Seo.global.float.should.equal 1.2345678910
+    end
+
+    it "should store and retrieve Symbols" do
+      Seo.global.symbol = :symbol
+      Seo.global.symbol.class.should.equal Symbol
+      Seo.global.symbol.should.equal :symbol
+    end
+
+    it "should store and retrieve True" do
+      Seo.global.true = true
+      Seo.global.true.class.should.equal TrueClass
+      Seo.global.true.should.equal true
+    end
+
+    it "should store and retrieve False" do
+      Seo.global.false = false
+      Seo.global.false.class.should.equal FalseClass
+      Seo.global.false.should.equal false
+    end
+
+    it "should store and retrieve Time" do
+      time = Time.now
+      Seo.global.time = time
+      Seo.global.time.class.should.equal Time
+      Seo.global.time.to_s.should.equal time.to_s
+    end
+
+    it "should store and retrieve Dates" do
+      date = Date.today
+      Seo.global.date = date
+      Seo.global.date.class.should.equal Date
+      Seo.global.date.should.equal date
+    end
+    
+    it "should store and retrieve DateTime" do
+      datetime = DateTime.now
+      Seo.global.datetime = datetime
+      Seo.global.datetime.class.should.equal DateTime
+      Seo.global.datetime.to_s.should.equal datetime.to_s
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bacon'
+require 'active_record'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'has_inherited'
+
+
+Bacon.summary_on_exit

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: has_inherited
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Mark Turner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-17 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bacon
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: The intention of this library is to make it easy to inherit particular variables between models in rails apps. We start with a parent model that will function as a pseudo-polymorphic association for children objects.
+email: mark@amerine.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- has_inherited.gemspec
+- lib/has_inherited.rb
+- spec/has_inherited_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/amerine/has_inherited
+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: Easily share variables between Rails models with inheritance.
+test_files: 
+- spec/has_inherited_spec.rb
+- spec/spec_helper.rb