attr_inherited 1.0.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+test/debug.log
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in attr_inherited.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) Christos Zisopoulos ( [@christos](http://twitter.com/christos) )
+========================================================================================
+
+The "attr_inherited_" plugin is released under the **MIT LICENSE**
+--------------------------------------------------------------------
+
+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 NON-INFRINGEMENT. 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.md

@@ -0,0 +1,145 @@
+## Description
+
+Attribute inheritance for `ActiveRecord` models
+
+Using `attr_inherited` allows your `ActiveRecord` models to inherit any of their attributes from an associated, or parent model.
+
+
+
+## Usage
+
+[![Build Status](https://secure.travis-ci.org/christos/attr_inherited.png)](http://travis-ci.org/christos/attr_inherited)
+
+### Inheriting attributes from an associated model
+
+Given a `Post` model and the following `Version` model
+
+    class Version < ActiveRecord::Base
+      belongs_to  :post
+
+      attr_inherited :title, :synopsis, from: :post
+    end
+
+..then `Version` will now inherit `title` and `synopsis` from the parent post, if either attributes are `nil`
+
+    1.9.3p194 :001 > post = Post.create!(title: "First post", synopsis: "First post synopsis")
+    1.9.3p194 :002 > version = Version.create!(post: post)
+
+    1.9.3p194 :003 > version.title
+     => "First post"
+
+    1.9.3p194 :004 > version.body
+     => "First post body"
+
+You can override any of the inherited attributes by setting its a value to anything other than `nil`
+
+    1.9.3p194 :005 > version.update_attributes(description: "Version synopsis")
+
+    1.9.3p194 :006 > version.synopsis
+     => "Version description"
+
+### Renaming inherited attributes
+
+If you want the inherited attribute to have a name other than that of the associated model's attribute, you can use the `as:` option to rename it. For example:
+
+    class Version < ActiveRecord::Base
+      belongs_to  :post
+
+      attr_inherited :synopsis, from: :post, as: :description
+    end
+
+    1.9.3p194 :001 > post = Post.create!(synopsis: "First post synopsis")
+    1.9.3p194 :002 > version = Version.create!(post: post)
+
+    1.9.3p194 :003 > version.description
+     => "First post synopsis"
+
+Note that `description` must be an attribute of `Version` for the above to work.
+
+### Inheriting attributes even when they are not `nil`
+
+You might want to inherit an attribute not only when it is `nil` but even when it is an empty string `""`. You can do this by passing a predicate with the `when:` option that would test if the attribute should be inherited.
+
+    class Version < ActiveRecord::Base
+      belongs_to  :post
+
+      attr_inherited :title, from: :post, when: :blank?
+    end
+
+    1.9.3p194 :001 > post = Post.create!(title: "First post")
+    1.9.3p194 :002 > version = Version.create!(post: post)
+
+    1.9.3p194 :003 > version.title
+     => "First post"
+
+    1.9.3p194 :004 > version.update_attributes(title: "     ")
+    1.9.3p194 :005 > version.title
+     => "First post"
+
+### Using the `when:` option to fake has_many association inheritance
+
+Until real association inheritance is implemented you can fake it like this:
+
+    class Version < ActiveRecord::Base
+      has_many :comments, as: :commentable
+    end
+
+    class Version < ActiveRecord::Base
+      belongs_to  :post
+      has_many :comments, as: :commentable
+
+      attr_inherited :comments, from: :post, when: :empty?
+    end
+
+...which makes `comments` behave almost as if it was inherited from `Post`:
+
+    1.9.3p194 :001 > post = Post.create!(title: "First post")
+    1.9.3p194 :002 > post.comments.create(text: "Post comment")
+    
+    1.9.3p194 :003 > version = Version.create!(post: post)
+    1.9.3p194 :004 > version.comments.first.text
+     => "Post comment"
+
+    1.9.3p194 :005 > version.comments = [Comment.create(text: "Version comment")]
+    1.9.3p194 :006 > version.comments.first.text
+     => "Version comment"
+
+**Caveat**: You can't call any other association methods on `version.comments` when it is inherited, such as `<<`, `.create`, `.build`
+
+## Installation
+
+*Requires Rails 3.1+*
+
+Add this line to your application's Gemfile:
+
+    gem 'attr_inherited'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install attr_inherited
+
+## Changelog
+
+**1.0.0** Initial relase (2012-10-02)
+
+## To Do
+
+  * Test assertion of valid parameters
+  * Write rdocs
+  * Document or remove default `parent` option for `from:` option
+  * Properly support inheriting associations
+  * Investigate support for virtual attributes (:attr_accessor)
+
+## Contributing
+
+1. Fork it
+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 new Pull Request
+
+Copyright (c) Christos Zisopoulos, released under the MIT license

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rake'
+require 'rake/testtask'
+require "bundler/gem_tasks"
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the attr_inherited gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+

data/attr_inherited.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'attr_inherited/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "attr_inherited"
+  gem.version       = AttrInherited::VERSION
+
+  gem.authors       = ["Christos Zisopoulos"]
+  gem.email         = ["christos@mac.com"]
+  gem.description   = "Attribute inheritance for ActiveRecord models"
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/christos/attr_inherited"
+
+  gem.rubyforge_project = "attr_inherited"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "sqlite3"
+
+  gem.add_dependency "activesupport"
+  gem.add_dependency "activerecord"
+
+end

data/lib/attr_inherited.rb

@@ -0,0 +1,51 @@
+require "attr_inherited/version"
+require 'active_record'
+
+module AttrInherited
+  def self.included(base) #:nodoc:
+    base.extend(AttrInheritedMacro)
+  end
+
+  module AttrInheritedMacro
+
+    def attr_inherited(*attrs)
+      if attrs.last.is_a? Hash
+        options = attrs.pop
+      end
+
+      _parent = options[:from] || 'parent'
+      _predicate = options[:when] && options[:when].to_s || 'nil?'
+
+      raise ArgumentError.new("Can't specify :as for multiple attributes in a single line") if attrs.size > 1 && options[:as].present?
+
+      attrs.each do |attr|
+        _alias = options[:as] || attr
+
+        class_eval <<-END, __FILE__, __LINE__
+
+        def #{_alias}_before_type_cast
+          _super = super
+          !_super.#{_predicate} && super || #{_parent} && #{_parent}.#{attr}_before_type_cast
+        end
+
+        def #{_alias}
+          _super = super
+          !_super.#{_predicate} && _super || #{_parent} && #{_parent}.#{attr} && !#{_parent}.#{attr}.#{_predicate} && #{_parent}.#{attr} || _super
+        end
+
+        def #{_alias}=(value)
+          super(value) if #{_parent}.nil? || #{_parent}.#{attr}.#{_predicate} || (#{_parent} && #{_parent}.#{attr} && #{_parent}.#{attr} != value)
+        end
+
+        def #{_alias}_inherited?
+          #{_parent}.#{attr} == self.#{attr}
+        end
+
+        END
+      end
+    end
+  end
+
+end
+
+ActiveRecord::Base.send(:include, AttrInherited) 

data/lib/attr_inherited/version.rb

@@ -0,0 +1,3 @@
+module AttrInherited
+  VERSION = "1.0.0"
+end

data/test/attr_inherited_test.rb

@@ -0,0 +1,84 @@
+require 'test_helper'
+
+class AttributeChoicesTest < ActiveSupport::TestCase
+
+  class Post < ActiveRecord::Base
+    has_many :comments, as: :commentable
+  end
+
+  class Version < ActiveRecord::Base
+    belongs_to  :post
+    has_many :comments, as: :commentable
+
+    attr_inherited :title, :body, from: :post
+    attr_inherited :synopsis, from: :post, as: :description
+
+    attr_inherited :comments, from: :post, when: :empty?
+  end
+
+  class Comment < ActiveRecord::Base
+    belongs_to :commentable, polymorphic: true
+  end
+
+  test "It should add a class method to all ActiveRecord objects" do
+    assert_respond_to ActiveRecord::Base, :attr_inherited
+    assert_respond_to Post, :attr_inherited
+    assert_respond_to Version, :attr_inherited
+    assert_respond_to Comment, :attr_inherited
+  end
+
+  test "It does not inherit attributes if its parent object is nil" do
+    version = Version.create! author: "Christos Zisopoulos", title: "First post"
+
+    assert_equal version.title, "First post"
+    assert_equal version.body, nil
+    assert_equal version.author, "Christos Zisopoulos"
+  end
+
+  test "It inherits attributes from the specified parent association when attribute is nil" do
+    post = Post.create! title: "First post", body: "First post body"
+    version = Version.create! author: "Christos Zisopoulos", post: post
+
+    assert_equal version.title, "First post"
+    assert_equal version.body, "First post body"
+    assert_equal version.author, "Christos Zisopoulos"
+  end
+
+  test "Inherited attribute's name can be aliased" do
+    post = Post.create! synopsis: "First post synopsis"
+    version = Version.create! post_id: post.id
+
+    assert_equal version.description, "First post synopsis"
+  end
+
+  test "Overrding the values of inherited attributes" do
+    post = Post.create! title: "First post", body: "First post body"
+    version = Version.create! do |v|
+      v.post_id = post.id
+      v.title = "Version title"
+      v.body =  "Version body"
+      v.description =  "Version description"
+      v.author = "Christos Zisopoulos"
+    end
+
+    assert_equal version.title, "Version title"
+    assert_equal version.body, "Version body"
+    assert_equal version.description, "Version description"
+    assert_equal version.author, "Christos Zisopoulos"
+  end
+
+  test "Using a user defined predicate to decide when to inherit" do
+    post = Post.create! title: "First post", body: "First post body"
+    post.comments.create! body: "Comment 1"
+    version = Version.create! post_id: post.id
+
+    assert_equal version.comments, post.comments
+
+    version_comment = Comment.create! body: "Comment 3"
+    version.comments = [version_comment]
+
+    assert_equal version.comments, [version_comment]
+  end
+
+end
+

data/test/database.yml

@@ -0,0 +1,3 @@
+sqlite3mem:
+  :adapter: sqlite3
+  :database: ":memory:"

data/test/schema.rb

@@ -0,0 +1,45 @@
+# This file is auto-generated from the current state of the database. Instead of editing this file,
+# please use the migrations feature of Active Record to incrementally modify your database, and
+# then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your database schema. If you need
+# to create the application database on another system, you should be using db:schema:load, not running
+# all the migrations from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20090418155608) do
+
+  create_table "posts", :force => true do |t|
+    t.string   "title"
+    t.text   "synopsis"
+    t.text   "body"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "versions", :force => true do |t|
+    t.integer  "post_id"
+
+    t.string   "title"
+    t.text     "description"
+    t.text      "body"
+    t.string    "author"
+
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "comments", :force => true do |t|
+    t.integer "commentable_id"
+    t.string "commentable_type"
+
+    t.text   "body"
+    t.string    "author"
+
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+ENV["RAILS_ENV"] = "test"
+
+require 'rubygems'
+
+require 'attr_inherited'
+
+require 'test/unit'
+
+require 'active_support/test_case'
+require 'active_record/fixtures'
+
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'sqlite3mem'])
+
+ActiveRecord::Migration.verbose = false
+load(File.dirname(__FILE__) + "/schema.rb")
+

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: attr_inherited
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Christos Zisopoulos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Attribute inheritance for ActiveRecord models
+email:
+- christos@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- attr_inherited.gemspec
+- lib/attr_inherited.rb
+- lib/attr_inherited/version.rb
+- test/attr_inherited_test.rb
+- test/database.yml
+- test/schema.rb
+- test/test_helper.rb
+homepage: https://github.com/christos/attr_inherited
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: attr_inherited
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Attribute inheritance for ActiveRecord models
+test_files:
+- test/attr_inherited_test.rb
+- test/database.yml
+- test/schema.rb
+- test/test_helper.rb