active_attr 0.2.1 → 0.2.2

data/.yardopts

@@ -1 +1 @@
-- CHANGELOG* *LICENSE*
+--no-private - CHANGELOG* *LICENSE*

data/CHANGELOG.md

@@ -1,4 +1,11 @@
-# ActiveAttr 0.2.1 (unreleased) #
+# ActiveAttr 0.2.2 (November 2, 2011) #
+
+* Fixed all instances of modules' #initialize not invoking its superclass
+* Fixed redefining an attribute appending a new AttributeDefinition
+* Subclassing a model using Attributes will now copy the parent's attribute
+  definitions to the subclass
+
+# ActiveAttr 0.2.1 (October 19, 2011) #
 
 * Added AttributeDefinition#<=>
 * Added AttributeDefinition#to_sym

data/Gemfile

@@ -9,7 +9,7 @@ group :development do
   gem "guard-rspec"
   gem "rb-fsevent"
   gem "rdiscount"
-  gem "rdoc"
+  gem "rdoc", "~> 3.9.4"
   gem "ruby-debug",    :platforms => :mri_18
   gem "ruby-debug19",  :platforms => :mri_19 if RUBY_VERSION < "1.9.3"
   gem "spec_coverage", :platforms => :mri_19

data/Guardfile

@@ -5,7 +5,7 @@ end
 
 guard "rspec", :version => 2, :cli=> "--format nested --debugger" do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$}) { |m| ["spec/unit/#{m[1]}_spec.rb", "spec/functional/#{m[1]}_spec.rb"] }
   watch("spec/spec_helper.rb") { "spec" }
   watch(%r{^spec/support/(.+)\.rb$}) { |m| "spec" }
 end

data/Rakefile

@@ -2,13 +2,23 @@ require "bundler/setup"
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-task :default => ["spec"]
+task :default => :spec
 
-RSpec::Core::RakeTask.new
+task :spec => %w(spec:units spec:functionals)
 
 namespace :spec do
   desc "Run RSpec specs with code coverate analysis"
   RSpec::Core::RakeTask.new(:cov) do |spec|
     spec.rspec_opts = "--format nested --format SpecCoverage"
   end
+
+  desc "Run RSpec unit specs"
+  RSpec::Core::RakeTask.new(:units) do |spec|
+    spec.pattern = "spec/unit/**/*_spec.rb"
+  end
+
+  desc "Run RSpec functional specs"
+  RSpec::Core::RakeTask.new(:functionals) do |spec|
+    spec.pattern = "spec/functional/**/*_spec.rb"
+  end
 end

data/lib/active_attr.rb

@@ -11,6 +11,7 @@ module ActiveAttr
   autoload :AttributeDefinition
   autoload :Attributes
   autoload :BasicModel
+  autoload :ChainableInitialization
   autoload :Error
   autoload :MassAssignment
   autoload :StrictMassAssignment

data/lib/active_attr/attribute_definition.rb

@@ -32,7 +32,7 @@ module ActiveAttr
     # @example Create an attribute defintion
     #   AttributeDefinition.new(:amount)
     #
-    # @param [Symbol, String, #to_sym] attribute name
+    # @param [Symbol, String, #to_sym] name attribute name
     #
     # @return [ActiveAttr::AttributeDefinition]
     #

data/lib/active_attr/attributes.rb

@@ -1,4 +1,5 @@
 require "active_attr/attribute_definition"
+require "active_attr/chainable_initialization"
 require "active_model"
 require "active_support/concern"
 
@@ -18,6 +19,7 @@ module ActiveAttr
   # @since 0.2.0
   module Attributes
     extend ActiveSupport::Concern
+    include ActiveAttr::ChainableInitialization
     include ActiveModel::AttributeMethods
 
     included do
@@ -54,8 +56,9 @@ module ActiveAttr
     end
 
     # @since 0.2.1
-    def initialize(*args)
+    def initialize(*)
       @attributes ||= {}
+      super
     end
 
     # Returns the class name plus its attributes
@@ -119,12 +122,12 @@ module ActiveAttr
       # @example Define an attribute.
       #   attribute :name
       #
-      # @param [Symbol] name The name of the attribute.
+      # @param (see AttributeDefinition#initialize)
       #
       # @since 0.2.0
       def attribute(name, options={})
         AttributeDefinition.new(name, options).tap do |attribute_definition|
-          attributes << attribute_definition
+          attributes << attribute_definition unless attributes.include? attribute_definition
           define_attribute_method attribute_definition.name
         end
       end
@@ -154,6 +157,29 @@ module ActiveAttr
         attributes_list = "(#{inspected_attributes.join(", ")})" unless inspected_attributes.empty?
         "#{self.name}#{attributes_list}"
       end
+
+      protected
+
+      # Assign a set of attribute definitions, used when subclassing models
+      #
+      # @param [Array<ActiveAttr::AttributeDefinition>] The Array of AttributeDefinition instances
+      #
+      # @since 0.2.2
+      def attributes=(attributes)
+        @attributes = attributes
+      end
+
+      private
+
+      # Ruby inherited hook to assign superclass attributes to subclasses
+      #
+      # @param [Class] subclass
+      #
+      # @since 0.2.2
+      def inherited(subclass)
+        super
+        subclass.attributes = attributes.dup
+      end
     end
   end
 end

data/lib/active_attr/chainable_initialization.rb

@@ -0,0 +1,49 @@
+module ActiveAttr
+  # Allows classes and modules to safely invoke super in its initialize method
+  #
+  # Many ActiveAttr modules enhance the behavior of the \#initialize method,
+  # and in doing so, these methods need to accept arguments. However, Ruby's
+  # Object and BasicObject classes, in most versions of Ruby, do not allow any
+  # arguments to be passed in. This module halts the propgation of
+  # initialization arguments before invoking the Object classes'
+  # initialization.
+  #
+  # In order to still allow a subclass mixing in this module (directly or
+  # through an ActiveSupport::Concern) to still pass its initialization
+  # arguments to its superclass, the module has to install itself into the
+  # ancestors of the base class, the class that inherits directly from Object
+  # or BasicObject.
+  #
+  # @since 0.2.2
+  module ChainableInitialization
+    class << self
+      # A collection of Ruby base objects
+      #   [Object] on Ruby 1.8
+      #   [Object, BasicObject] on Ruby 1.9
+      BASE_OBJECTS = begin
+        base_objects = []
+        superclass = Class.new
+        base_objects << superclass while superclass = superclass.superclass
+        base_objects
+      end
+
+      # Only append the features of this module to the class that inherits
+      # directly from one of the BASE_OBJECTS
+      def append_features(base)
+        if base.respond_to? :superclass
+          base = base.superclass while !BASE_OBJECTS.include?(base.superclass)
+        end
+
+        super
+      end
+    end
+
+    # Continue to propagate any superclass calls, but stop passing arguments
+    #
+    # This prevents problems in versions of Ruby where Object#initialize does
+    # not take arguments
+    def initialize(*)
+      super()
+    end
+  end
+end

data/lib/active_attr/mass_assignment.rb

@@ -1,3 +1,6 @@
+require "active_attr/chainable_initialization"
+require "active_support/concern"
+
 module ActiveAttr
   # MassAssignment allows you to bulk set and update attributes
   #
@@ -11,6 +14,9 @@ module ActiveAttr
   #
   # @since 0.1.0
   module MassAssignment
+    extend ActiveSupport::Concern
+    include ChainableInitialization
+
     # Mass update a model's attributes
     #
     # @example Assigning a hash
@@ -54,6 +60,7 @@ module ActiveAttr
     # @since 0.1.0
     def initialize(attributes=nil, options={})
       assign_attributes attributes, options
+      super
     end
   end
 end

data/lib/active_attr/matchers/have_attribute_matcher.rb

@@ -22,29 +22,29 @@ module ActiveAttr
     # @since 0.2.0
     class HaveAttributeMatcher
       # @return [Symbol]
-      # @api private
+      # @private
       attr_reader :attribute_name
 
       # @return [String] Description
-      # @api private
+      # @private
       def description
         "have attribute named #{attribute_name}"
       end
 
       # @return [String] Failure message
-      # @api private
+      # @private
       def failure_message
         "Expected #{@model_class} to #{description}"
       end
 
       # @param [Symbol, String, #to_sym] attribute_name
-      # @api private
+      # @private
       def initialize(attribute_name)
         raise TypeError, "can't convert #{attribute_name.class} into Symbol" unless attribute_name.respond_to? :to_sym
         @attribute_name = attribute_name.to_sym
       end
 
-      # @api private
+      # @private
       def matches?(model_or_model_class)
         @model_class = class_from(model_or_model_class)
 
@@ -54,7 +54,7 @@ module ActiveAttr
       end
 
       # @return [String] Negative failure message
-      # @api private
+      # @private
       def negative_failure_message
         "Expected #{@model_class} to not #{description}"
       end

data/lib/active_attr/version.rb

@@ -1,5 +1,5 @@
 module ActiveAttr
   # Complete version string
   # @since 0.1.0
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/spec/functional/active_attr/attributes_spec.rb

@@ -0,0 +1,111 @@
+require "spec_helper"
+require "active_attr/attributes"
+require "active_model"
+
+module ActiveAttr
+  describe Attributes do
+    context "subclassing a model" do
+      let :parent_class do
+        Class.new do
+          include Attributes
+
+          attribute :parent
+        end
+      end
+
+      let! :child_class do
+        Class.new(parent_class) do
+          attribute :child
+        end
+      end
+
+      context "attributes defined on the parent" do
+        subject { child_class.new }
+
+        it "create a reader on the child" do
+          should respond_to :parent
+        end
+
+        it "create a writer on the child" do
+          should respond_to :parent=
+        end
+
+        it "add attribute definitions to the child" do
+          child_class.attributes.map(&:name).should include :parent
+        end
+      end
+
+      context "attributes defined on the child" do
+        subject { parent_class.new }
+
+        it "don't create a reader on the parent" do
+          should_not respond_to :child
+        end
+
+        it "don't create a writer on the parent" do
+          should_not respond_to :child=
+        end
+
+        it "don't add attribute definitions to the parent" do
+          parent_class.attributes.map(&:name).should_not include :child
+        end
+      end
+    end
+
+    context "serializing a model" do
+      let(:first_name) { "Chris" }
+
+      let :instance do
+        model_class.new.tap do |model|
+          model.first_name = first_name
+        end
+      end
+
+      let :model_class do
+        Class.new do
+          include Attributes
+          include ActiveModel::Serializers::JSON
+          include ActiveModel::Serializers::Xml
+
+          attribute :first_name
+          attribute :last_name
+
+          def self.name
+            "Person"
+          end
+        end
+      end
+
+      shared_examples "serialization method" do
+        it "includes assigned attributes" do
+          should include("first_name" => first_name)
+        end
+
+        it "includes unassigned, defined attributes" do
+          subject.keys.should include("last_name")
+          subject["last_name"].should be_nil
+        end
+      end
+
+      describe "#as_json" do
+        subject { instance.as_json["person"] }
+        include_examples "serialization method"
+      end
+
+      describe "#serializable_hash" do
+        subject { instance.serializable_hash }
+        include_examples "serialization method"
+      end
+
+      describe "#to_json" do
+        subject { ActiveSupport::JSON.decode(instance.to_json)["person"] }
+        include_examples "serialization method"
+      end
+
+      describe "#to_xml" do
+        subject { Hash.from_xml(instance.to_xml)["person"] }
+        include_examples "serialization method"
+      end
+    end
+  end
+end

data/spec/functional/active_attr/chainable_initialization_spec.rb

@@ -0,0 +1,93 @@
+require "spec_helper"
+require "active_attr/chainable_initialization"
+require "active_support/concern"
+
+module ActiveAttr
+  describe ChainableInitialization do
+    subject { model_class.new("arg") }
+
+    shared_examples "chained initialization" do
+      describe "#initialize" do
+        it { expect { subject }.not_to raise_error }
+        it { subject.initialized?.should be_true }
+      end
+    end
+
+    context "mixed into a class with an argument to initialize" do
+      let :model_class do
+        Class.new do
+          include InitializationVerifier
+          include ChainableInitialization
+
+          def initialize(arg)
+            super
+          end
+        end
+      end
+
+      include_examples "chained initialization"
+    end
+
+    context "mixed into a subclass with an argument to initialize on the superclass" do
+      context "subclassing a model" do
+        let :parent_class do
+          Class.new do
+            include InitializationVerifier
+
+            def initialize(arg)
+              super
+            end
+          end
+        end
+
+        let :model_class do
+          Class.new(parent_class) do
+            include ChainableInitialization
+
+            def initialize(arg)
+              super
+            end
+          end
+        end
+
+        include_examples "chained initialization"
+      end
+    end
+
+    context "mixed into a concern which is mixed into a class with an argument to initialize" do
+      let :model_class do
+        Class.new do
+          include InitializationVerifier
+
+          include Module.new {
+            extend ActiveSupport::Concern
+            include ChainableInitialization
+          }
+
+          def initialize(arg)
+            super
+          end
+        end
+      end
+
+      include_examples "chained initialization"
+    end
+
+    if defined?(BasicObject)
+      context "mixed into a class that inherits from BasicObject with an argument to initialize" do
+        let :model_class do
+          Class.new(BasicObject) do
+            include InitializationVerifier
+            include ChainableInitialization
+
+            def initialize(arg)
+              super
+            end
+          end
+        end
+
+        include_examples "chained initialization"
+      end
+    end
+  end
+end

data/spec/support/initialization_verifier.rb

@@ -0,0 +1,9 @@
+module InitializationVerifier
+  def initialize
+    @initialized = true
+  end
+
+  def initialized?
+    @initialized ||= false
+  end
+end

data/spec/support/mass_assignment_shared_examples.rb

@@ -1,6 +1,8 @@
 shared_examples "mass assignment class", :mass_assignment => true do
   let :model_class do
     Class.new do
+      include InitializationVerifier
+
       attr_accessor :first_name, :last_name, :middle_name
       private :middle_name=
 
@@ -77,6 +79,10 @@ shared_examples "#initialize", :initialize => true do
     subject.new(attributes)
   end
 
+  it "invokes the superclass initializer" do
+    subject.new.should be_initialized
+  end
+
   it "raises ArgumentError when called with three arguments" do
     expect { subject.new({}, {}, nil) }.to raise_error ArgumentError
   end

data/spec/{active_attr → unit/active_attr}/attributes_spec.rb

@@ -7,6 +7,7 @@ module ActiveAttr
 
     let :model_class do
       Class.new do
+        include InitializationVerifier
         include Attributes
         attribute :name
         attribute :amount
@@ -19,7 +20,7 @@ module ActiveAttr
           super
         end
 
-        def amount=(*args)
+        def amount=(*)
           super
         end
 
@@ -68,6 +69,14 @@ module ActiveAttr
         subject.should_receive(:attribute=).with("amount", 1)
         subject.amount = 1
       end
+
+      it "defining an attribute twice does not make appear in the" do
+        Class.new do
+          include Attributes
+          attribute :name
+          attribute :name
+        end.should have(1).attributes
+      end
     end
 
     describe ".attributes" do
@@ -143,6 +152,12 @@ module ActiveAttr
       end
     end
 
+    describe "#initialize" do
+      it "invokes the superclass initializer" do
+        should be_initialized
+      end
+    end
+
     describe "#inspect" do
       before { subject.name = "Ben" }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_attr
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,12 +10,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-19 00:00:00.000000000 -05:00
+date: 2011-11-02 00:00:00.000000000 -05:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70255008815760 !ruby/object:Gem::Requirement
+  requirement: &70194693834500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,10 +23,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70255008815760
+  version_requirements: *70194693834500
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70255008814840 !ruby/object:Gem::Requirement
+  requirement: &70194693833280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +34,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70255008814840
+  version_requirements: *70194693833280
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70255008813600 !ruby/object:Gem::Requirement
+  requirement: &70194693832400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -45,10 +45,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70255008813600
+  version_requirements: *70194693832400
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70255008812200 !ruby/object:Gem::Requirement
+  requirement: &70194693831640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -56,10 +56,10 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *70255008812200
+  version_requirements: *70194693831640
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70255008809320 !ruby/object:Gem::Requirement
+  requirement: &70194693830660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -67,7 +67,7 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70255008809320
+  version_requirements: *70194693830660
 description: Create plain old ruby models without reinventing the wheel.
 email:
 - cgriego@gmail.com
@@ -92,6 +92,7 @@ files:
 - lib/active_attr/attribute_definition.rb
 - lib/active_attr/attributes.rb
 - lib/active_attr/basic_model.rb
+- lib/active_attr/chainable_initialization.rb
 - lib/active_attr/error.rb
 - lib/active_attr/mass_assignment.rb
 - lib/active_attr/matchers.rb
@@ -100,18 +101,21 @@ files:
 - lib/active_attr/strict_mass_assignment.rb
 - lib/active_attr/unknown_attributes_error.rb
 - lib/active_attr/version.rb
-- spec/active_attr/attribute_definition_spec.rb
-- spec/active_attr/attributes_spec.rb
-- spec/active_attr/basic_model_spec.rb
-- spec/active_attr/error_spec.rb
-- spec/active_attr/mass_assignment_spec.rb
-- spec/active_attr/matchers/have_attribute_matcher_spec.rb
-- spec/active_attr/strict_mass_assignment_spec.rb
-- spec/active_attr/unknown_attributes_error_spec.rb
-- spec/active_attr/version_spec.rb
+- spec/functional/active_attr/attributes_spec.rb
+- spec/functional/active_attr/chainable_initialization_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_model_lint.rb
+- spec/support/initialization_verifier.rb
 - spec/support/mass_assignment_shared_examples.rb
+- spec/unit/active_attr/attribute_definition_spec.rb
+- spec/unit/active_attr/attributes_spec.rb
+- spec/unit/active_attr/basic_model_spec.rb
+- spec/unit/active_attr/error_spec.rb
+- spec/unit/active_attr/mass_assignment_spec.rb
+- spec/unit/active_attr/matchers/have_attribute_matcher_spec.rb
+- spec/unit/active_attr/strict_mass_assignment_spec.rb
+- spec/unit/active_attr/unknown_attributes_error_spec.rb
+- spec/unit/active_attr/version_spec.rb
 has_rdoc: true
 homepage: https://github.com/cgriego/active_attr
 licenses: []
@@ -127,7 +131,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3746970680425630982
+      hash: 2011553241576823901
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -136,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3746970680425630982
+      hash: 2011553241576823901
 requirements: []
 rubyforge_project: active_attr
 rubygems_version: 1.5.2
@@ -144,15 +148,18 @@ signing_key:
 specification_version: 3
 summary: What ActiveModel left out
 test_files:
-- spec/active_attr/attribute_definition_spec.rb
-- spec/active_attr/attributes_spec.rb
-- spec/active_attr/basic_model_spec.rb
-- spec/active_attr/error_spec.rb
-- spec/active_attr/mass_assignment_spec.rb
-- spec/active_attr/matchers/have_attribute_matcher_spec.rb
-- spec/active_attr/strict_mass_assignment_spec.rb
-- spec/active_attr/unknown_attributes_error_spec.rb
-- spec/active_attr/version_spec.rb
+- spec/functional/active_attr/attributes_spec.rb
+- spec/functional/active_attr/chainable_initialization_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_model_lint.rb
+- spec/support/initialization_verifier.rb
 - spec/support/mass_assignment_shared_examples.rb
+- spec/unit/active_attr/attribute_definition_spec.rb
+- spec/unit/active_attr/attributes_spec.rb
+- spec/unit/active_attr/basic_model_spec.rb
+- spec/unit/active_attr/error_spec.rb
+- spec/unit/active_attr/mass_assignment_spec.rb
+- spec/unit/active_attr/matchers/have_attribute_matcher_spec.rb
+- spec/unit/active_attr/strict_mass_assignment_spec.rb
+- spec/unit/active_attr/unknown_attributes_error_spec.rb
+- spec/unit/active_attr/version_spec.rb