active_attr 0.2.0 → 0.2.1

data/.travis.yml

@@ -1,4 +1,5 @@
 rvm:
   - ree
   - 1.9.2
+  - 1.9.3
 bundler_args: --without development

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# ActiveAttr 0.2.1 (unreleased) #
+
+* Added AttributeDefinition#<=>
+* Added AttributeDefinition#to_sym
+* Added Attributes#[]
+* Added Attributes#[]=
+* Attributes#attributes now returns the results of overridden getters
+* Attributes.inspect and Attributes#inspect are now in alphabetical order
+* Overridden attribute getters and setters can now call super
+
 # ActiveAttr 0.2.0 (October 3, 2011) #
 
 * ActiveAttr now autoloads nested classes and modules

data/README.md

@@ -10,7 +10,9 @@ the wheel.
 [1]: http://travis-ci.org/cgriego/active_attr
 [2]: https://secure.travis-ci.org/cgriego/active_attr.png?branch=master
 
-## Attributes ##
+## Modules ##
+
+### Attributes ###
 
 Including the Attributes module into your class gives you a DSL for defining
 the attributes of your model.
@@ -27,7 +29,7 @@ the attributes of your model.
     p.last_name = "Griego"
     p.attributes #=> {"first_name"=>"Chris", "last_name"=>"Griego"}
 
-## BasicModel ##
+### BasicModel ###
 
 Including the BasicModel module into your class gives you the bare minimum
 required for your model to meet the ActiveModel API requirements.
@@ -41,7 +43,7 @@ required for your model to meet the ActiveModel API requirements.
     p.valid? #=> true
     p.errors.full_messages #=> []
 
-## MassAssignment ##
+### MassAssignment ###
 
 Including the MassAssignment module into your class gives you methods for bulk
 initializing and updating the attributes of your model. Any unknown attributes
@@ -51,9 +53,21 @@ attribute.
 
     class Person
       include ActiveAttr::MassAssignment
+      attr_accessor :first_name, :last_name
     end
 
     p = Person.new(:first_name => "Chris")
     p.attributes = { :last_name => "Griego" }
     p.first_name #=> "Chris"
     p.last_name #=> "Griego"
+
+## RSpec Integration ##
+
+ActiveAttr comes with matchers and RSpec integration to assist you in testing
+your models.
+
+    require "active_attr/rspec"
+
+    describe Person do
+      it { should have_attribute(:first_name) }
+    end

data/lib/active_attr/attribute_definition.rb

@@ -6,23 +6,25 @@ module ActiveAttr
   #
   # @since 0.2.0
   class AttributeDefinition
+    include Comparable
+
     # The attribute name
     # @since 0.2.0
     attr_reader :name
 
-    # Performs equality checking of the attribute definition
+    # Compare attribute definitions
     #
-    # @example Compare for equality.
-    #   attribute_definition == other
+    # @example
+    #   attribute_definition <=> other
     #
-    # @param [AttributeDefinition, Object] other The other attribute definition to compare with.
+    # @param [ActiveAttr::AttributeDefinition, Object] other The other attribute definition to compare with.
     #
-    # @return [true, false] True if attribute name is equal and other is instance of the same Class, false if not.
+    # @return [-1, 0, 1, nil]
     #
-    # @since 0.2.0
-    def ==(attribute)
-      return false unless attribute.instance_of? self.class
-      name == attribute.name
+    # @since 0.2.1
+    def <=>(other)
+      return nil unless other.instance_of? self.class
+      self.name.to_s <=> other.name.to_s
     end
 
     # Creates a new AttributeDefinition
@@ -32,7 +34,7 @@ module ActiveAttr
     #
     # @param [Symbol, String, #to_sym] attribute name
     #
-    # @return [AttributeDefinition]
+    # @return [ActiveAttr::AttributeDefinition]
     #
     # @since 0.2.0
     def initialize(name, options={})
@@ -40,7 +42,7 @@ module ActiveAttr
       @name = name.to_sym
     end
 
-    # Returns the attribute name
+    # The attribute name
     #
     # @return [String] the attribute name
     #
@@ -48,5 +50,15 @@ module ActiveAttr
     def to_s
       name.to_s
     end
+    alias_method :inspect, :to_s
+
+    # The attribute name
+    #
+    # @return [Symbol] the attribute name
+    #
+    # @since 0.2.1
+    def to_sym
+      name
+    end
   end
 end

data/lib/active_attr/attributes.rb

@@ -1,4 +1,5 @@
 require "active_attr/attribute_definition"
+require "active_model"
 require "active_support/concern"
 
 module ActiveAttr
@@ -17,13 +18,19 @@ module ActiveAttr
   # @since 0.2.0
   module Attributes
     extend ActiveSupport::Concern
+    include ActiveModel::AttributeMethods
+
+    included do
+      attribute_method_suffix ""
+      attribute_method_suffix "="
+    end
 
     # Performs equality checking on the result of attributes and its type.
     #
     # @example Compare for equality.
     #   model == other
     #
-    # @param [Attributes, Object] other The other model to compare with.
+    # @param [ActiveAttr::Attributes, Object] other The other model to compare with.
     #
     # @return [true, false] True if attributes are equal and other is instance of the same Class, false if not.
     #
@@ -38,10 +45,16 @@ module ActiveAttr
     # @example Get attributes
     #   person.attributes # => {"name"=>"Ben Poweski"}
     #
-    # @return [Hash] The Hash of attributes
+    # @return [Hash] The Hash of all attributes
     #
     # @since 0.2.0
     def attributes
+      attribute_names = self.class.attributes.map { |definition| definition.name.to_s }
+      Hash[attribute_names.map { |key| [key, send(key)] }]
+    end
+
+    # @since 0.2.1
+    def initialize(*args)
       @attributes ||= {}
     end
 
@@ -54,11 +67,13 @@ module ActiveAttr
     #
     # @since 0.2.0
     def inspect
-      attribute_descriptions = self.class.attributes.map do |attribute|
+      attribute_descriptions = self.class.attributes.sort.map do |attribute|
         "#{attribute.name.to_s}: #{read_attribute(attribute.name).inspect}"
-      end
+      end.join(", ")
+
+      attribute_descriptions = " " + attribute_descriptions unless attribute_descriptions.empty?
 
-      "#<#{self.class.name} #{attribute_descriptions.join(", ")}>"
+      "#<#{self.class.name}#{attribute_descriptions}>"
     end
 
     # Read a value from the model's attributes. If the value does not exist
@@ -73,8 +88,11 @@ module ActiveAttr
     #
     # @since 0.2.0
     def read_attribute(name)
-      attributes[name.to_s]
+      @attributes[name.to_s]
     end
+    alias_method :[], :read_attribute
+    alias_method :attribute, :read_attribute
+    private :attribute
 
     # Write a single attribute to the model's attribute hash.
     #
@@ -86,8 +104,11 @@ module ActiveAttr
     #
     # @since 0.2.0
     def write_attribute(name, value)
-      attributes[name.to_s] = value
+      @attributes[name.to_s] = value
     end
+    alias_method :[]=, :write_attribute
+    alias_method :attribute=, :write_attribute
+    private :attribute=
 
     module ClassMethods
       # Defines all the attributes that are to be returned from the attributes instance method.
@@ -102,12 +123,10 @@ module ActiveAttr
       #
       # @since 0.2.0
       def attribute(name, options={})
-        attribute_definition = AttributeDefinition.new(name, options)
-        attributes << attribute_definition
-        method_name = attribute_definition.name
-
-        define_method("#{method_name}=") { |value| write_attribute(name, value) }
-        define_method(method_name) { read_attribute(name) }
+        AttributeDefinition.new(name, options).tap do |attribute_definition|
+          attributes << attribute_definition
+          define_attribute_method attribute_definition.name
+        end
       end
 
       # Returns an Array of AttributeDefinition instances
@@ -115,7 +134,7 @@ module ActiveAttr
       # @example Get attribute definitions
       #   Person.attributes
       #
-      # @return [Array<AttributeDefinition>] The Array of AttributeDefinition instances
+      # @return [Array<ActiveAttr::AttributeDefinition>] The Array of AttributeDefinition instances
       #
       # @since 0.2.0
       def attributes
@@ -131,7 +150,9 @@ module ActiveAttr
       #
       # @since 0.2.0
       def inspect
-        "#{self.name}(#{attributes.map { |a| a.to_s }.join(", ")})"
+        inspected_attributes = attributes.sort.map { |attr| attr.inspect }
+        attributes_list = "(#{inspected_attributes.join(", ")})" unless inspected_attributes.empty?
+        "#{self.name}#{attributes_list}"
       end
     end
   end

data/lib/active_attr/matchers/have_attribute_matcher.rb

@@ -9,7 +9,7 @@ module ActiveAttr
     #
     # @param [Symbol, String, #to_sym] attribute_name
     #
-    # @return [HaveAttributeMatcher]
+    # @return [ActiveAttr::HaveAttributeMatcher]
     #
     # @since 0.2.0
     def have_attribute(attribute_name)

data/lib/active_attr/version.rb

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

data/spec/active_attr/attribute_definition_spec.rb

@@ -5,6 +5,24 @@ module ActiveAttr
   describe AttributeDefinition do
     subject { described_class.new(:amount) }
 
+    describe "#<=>" do
+      it "is nil if the right side is not an #{described_class}" do
+        (subject <=> nil).should be_nil
+      end
+
+      it "prefers neither when both sides use the same attribute name" do
+        (subject <=> subject).should == 0
+      end
+
+      it "prefers the left side when the left side name sorts alphabetically before the right side name" do
+        (described_class.new(:amount) <=> described_class.new(:quantity)).should == -1
+      end
+
+      it "prefers the right side when the right side name sorts alphabetically before the left side name" do
+        (described_class.new(:quantity) <=> described_class.new(:amount)).should == 1
+      end
+    end
+
     describe "#==" do
       it "returns true when the attribute name is equal" do
         described_class.new(:amount).should == described_class.new(:amount)
@@ -33,13 +51,25 @@ module ActiveAttr
       end
     end
 
+    describe "#inspect" do
+      it "renders the name" do
+        subject.inspect.should == "amount"
+      end
+    end
+
     describe "#name" do
       it { should respond_to(:name) }
     end
 
     describe "#to_s" do
-      it "renders the name" do
-        subject.to_s.should == subject.name.to_s
+      it "renders the name as a String" do
+        subject.to_s.should == "amount"
+      end
+    end
+
+    describe "#to_sym" do
+      it "renders the name as a Symbol" do
+        subject.to_sym.should == :amount
       end
     end
   end

data/spec/active_attr/attributes_spec.rb

@@ -3,18 +3,36 @@ require "active_attr/attributes"
 
 module ActiveAttr
   describe Attributes do
-    let(:model_class) do
+    subject { model_class.new }
+
+    let :model_class do
       Class.new do
         include Attributes
         attribute :name
+        attribute :amount
+
+        def self.name
+          "Foo"
+        end
+
+        def amount
+          super
+        end
+
+        def amount=(*args)
+          super
+        end
+
+        def initialize(name=nil)
+          super
+          write_attribute(:name, name)
+        end
       end
     end
 
-    subject do
+    let :attributeless do
       Class.new do
         include Attributes
-        attribute :name
-        attribute :amount
 
         def self.name
           "Foo"
@@ -23,59 +41,58 @@ module ActiveAttr
     end
 
     describe ".attribute" do
-      let(:instance) { subject.new }
-
       it "creates an attribute with no options" do
-        subject.attributes.should include(AttributeDefinition.new(:name))
+        model_class.attributes.should include(AttributeDefinition.new(:name))
       end
 
-      it "defined an attribute reader that calls #read_attribute" do
-        instance.should_receive(:read_attribute).with(:name)
-        instance.name
+      it "returns the attribute definition" do
+        Class.new(model_class).attribute(:address).should == AttributeDefinition.new(:address)
       end
 
-      it "defines an attribute writer method that calls #write_attribute" do
-        instance.should_receive(:write_attribute).with(:name, "Ben")
-        instance.name = "Ben"
+      it "defines an attribute reader that calls #attribute" do
+        subject.should_receive(:attribute).with("name")
+        subject.name
+      end
+
+      it "defines an attribute reader that can be called via super" do
+        subject.should_receive(:attribute).with("amount")
+        subject.amount
+      end
+
+      it "defines an attribute writer that calls #attribute=" do
+        subject.should_receive(:attribute=).with("name", "Ben")
+        subject.name = "Ben"
+      end
+
+      it "defines an attribute writer that can be called via super" do
+        subject.should_receive(:attribute=).with("amount", 1)
+        subject.amount = 1
       end
     end
 
     describe ".attributes" do
-      it { should respond_to(:attributes) }
+      it { model_class.should respond_to(:attributes) }
 
       context "when no attributes exist" do
-        subject do
-          Class.new { include Attributes }.attributes
-        end
-
-        it "returns an empty Array" do
-          should == []
-        end
+        it { attributeless.attributes.should be_empty }
       end
     end
 
     describe ".inspect" do
       it "renders the class name" do
-        subject.inspect.should match "Foo"
+        model_class.inspect.should match /^Foo\(.*\)$/
       end
 
-      it "renders the attribute name and type" do
-        subject.inspect.should match subject.attributes.map { |a| a.name }.join(", ")
+      it "renders the attribute names in alphabetical order" do
+        model_class.inspect.should match "(amount, name)"
       end
-    end
-
-    describe "#==" do
-      let(:model_class) do
-        Class.new do
-          include Attributes
-          attribute :name
 
-          def initialize(name)
-            write_attribute(:name, name)
-          end
-        end
+      it "doesn't format the inspection string for attributes if the model does not have any" do
+        attributeless.inspect.should == "Foo"
       end
+    end
 
+    describe "#==" do
       subject { model_class.new("Ben") }
 
       it "returns true when all attributes are equal" do
@@ -89,52 +106,96 @@ module ActiveAttr
 
     describe "#attributes" do
       context "when no attributes are defined" do
-        subject { Class.new { include Attributes } }
-
         it "returns an empty Hash" do
-          subject.new.attributes.should == {}
+          attributeless.new.attributes.should == {}
         end
       end
-    end
 
-    describe "#inspect" do
-      let(:instance) { subject.new.tap { |obj| obj.name = "Ben" }  }
+      context "when an attribute is defined" do
+        it "returns the key value pairs" do
+          subject.name = "Ben"
+          subject.attributes.should include("name" => "Ben")
+        end
+
+        it "returns a new Hash " do
+          subject.attributes.merge!("name" => "Bob")
+          subject.attributes.should_not include("name" => "Bob")
+        end
 
-      it "includes the class name and all attribute values" do
-        instance.inspect.should == %q{#<Foo name: "Ben", amount: nil>}
+        it "returns all attributes" do
+          subject.attributes.keys.should =~ %w(amount name)
+        end
+      end
+
+      context "when a getter is overridden" do
+        before do
+          subject.extend Module.new {
+            def name
+              "Benjamin"
+            end
+          }
+        end
+
+        it "uses the overridden implementation" do
+          subject.name = "Ben"
+          subject.attributes.should include("name" => "Benjamin")
+        end
       end
     end
 
-    describe "#read_attribute" do
-      let(:name) { "Bob" }
-      subject { model_class.new.tap { |s| s.write_attribute(:name, name) } }
+    describe "#inspect" do
+      before { subject.name = "Ben" }
 
-      it "returns the attribute using a Symbol" do
-        subject.read_attribute(:name).should == name
+      it "includes the class name and all attribute values in alphabetical order by attribute name" do
+        subject.inspect.should == %q{#<Foo amount: nil, name: "Ben">}
       end
 
-      it "returns the attribute using a String" do
-        subject.read_attribute('name').should == name
+      it "doesn't format the inspection string for attributes if the model does not have any" do
+        attributeless.new.inspect.should == %q{#<Foo>}
       end
     end
 
-    describe "#write_attribute" do
-      subject { model_class.new }
+    [:[], :read_attribute].each do |method|
+      describe "##{method}" do
+        context "when an attribute is not set" do
+          it "returns nil" do
+            subject.send(method, :name).should == nil
+          end
+        end
+
+        context "when an attribute is set" do
+          let(:name) { "Bob" }
 
-      it "raises ArgumentError with one argument" do
-        expect { subject.write_attribute(:name) }.to raise_error(ArgumentError)
-      end
+          before { subject.write_attribute(:name, name) }
 
-      it "raises ArgumentError with no arguments" do
-        expect { subject.write_attribute }.to raise_error(ArgumentError)
-      end
+          it "returns the attribute using a Symbol" do
+            subject.send(method, :name).should == name
+          end
 
-      it "assigns sets an attribute using a Symbol and value" do
-        expect { subject.write_attribute(:name, "Ben") }.to change(subject, :attributes).from({}).to("name" => "Ben")
+          it "returns the attribute using a String" do
+            subject.send(method, 'name').should == name
+          end
+        end
       end
+    end
 
-      it "assigns sets an attribute using a String and value" do
-        expect { subject.write_attribute('name', "Ben") }.to change(subject, :attributes).from({}).to("name" => "Ben")
+    [:[]=, :write_attribute].each do |method|
+      describe "##{method}" do
+        it "raises ArgumentError with one argument" do
+          expect { subject.send(method, :name) }.to raise_error(ArgumentError)
+        end
+
+        it "raises ArgumentError with no arguments" do
+          expect { subject.send(method) }.to raise_error(ArgumentError)
+        end
+
+        it "assigns sets an attribute using a Symbol and value" do
+          expect { subject.send(method, :name, "Ben") }.to change { subject.attributes["name"] }.from(nil).to("Ben")
+        end
+
+        it "assigns sets an attribute using a String and value" do
+          expect { subject.send(method, 'name', "Ben") }.to change { subject.attributes["name"] }.from(nil).to("Ben")
+        end
       end
     end
   end

data/spec/active_attr/basic_model_spec.rb

@@ -3,7 +3,7 @@ require "active_attr/basic_model"
 
 module ActiveAttr
   describe BasicModel do
-    let(:model_class) do
+    let :model_class do
       Class.new do
         include BasicModel
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_attr
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,12 +10,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-03 00:00:00.000000000 -05:00
+date: 2011-10-19 00:00:00.000000000 -05:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70212822508240 !ruby/object:Gem::Requirement
+  requirement: &70255008815760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,10 +23,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70212822508240
+  version_requirements: *70255008815760
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70212822507140 !ruby/object:Gem::Requirement
+  requirement: &70255008814840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -34,10 +34,10 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70212822507140
+  version_requirements: *70255008814840
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70212822506320 !ruby/object:Gem::Requirement
+  requirement: &70255008813600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -45,10 +45,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70212822506320
+  version_requirements: *70255008813600
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70212822505480 !ruby/object:Gem::Requirement
+  requirement: &70255008812200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -56,10 +56,10 @@ dependencies:
         version: 0.9.0
   type: :development
   prerelease: false
-  version_requirements: *70212822505480
+  version_requirements: *70255008812200
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70212822504100 !ruby/object:Gem::Requirement
+  requirement: &70255008809320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -67,7 +67,7 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70212822504100
+  version_requirements: *70255008809320
 description: Create plain old ruby models without reinventing the wheel.
 email:
 - cgriego@gmail.com
@@ -76,11 +76,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .document
 - .gitignore
 - .rspec
 - .rvmrc
 - .travis.yml
+- .yardopts
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -127,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4452087611638543141
+      hash: -3746970680425630982
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4452087611638543141
+      hash: -3746970680425630982
 requirements: []
 rubyforge_project: active_attr
 rubygems_version: 1.5.2