attribution 0.1.0 → 0.2.0

data/README.md

@@ -78,7 +78,7 @@ And then you can pass in a Hash or a String of JSON to initialize the object:
         }
       ]
     }}
-    
+
     book = Book.new(json)
 
 The object is populated based on the data, the values are converted into the type defined by the attribute:
@@ -116,6 +116,33 @@ The reciprocating association is populated as well:
     >> book.chapters[2].book.title
     => "Rework"
 
+You can access the values of all attributes as a hash:
+
+    >> pp book.attributes
+    {:id=>1,
+     :title=>"Rework",
+     :price=>#<BigDecimal:7f87db1f0b48,'0.22E2',9(18)>,
+     :published_on=>Tue, 09 Mar 2010,
+     :ebook_available=>true,
+     :used=>false,
+     :shipping_weight=>14.4,
+     :created_at=>2013-02-20 05:39:45 -0500,
+     :updated_at=>2013-02-20 05:40:37 -0500,
+     :time_zone=>(GMT-05:00) Eastern Time (US & Canada)}
+
+You can also add any arbitrary metadata to any attribute:
+
+    class Book
+      include Attribution
+
+      decimal :price, :required => true, :doc => "Price in USD", :whatever => "why not?"
+    end
+
+And retrieve that metadata any time:
+
+    >> Book.attributes
+    => [{:required=>true, :doc=>"Price in USD", :whatever=>"why not?", :name=>:price, :type=>:decimal}]
+
 ## Contributing
 
 1. Fork it
@@ -124,4 +151,4 @@ The reciprocating association is populated as well:
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-[ar]: http://api.rubyonrails.org/classes/ActiveRecord/Associations/ClassMethods.html
+[ar]: http://api.rubyonrails.org/classes/ActiveRecord/Associations/ClassMethods.html

data/attribution.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name          = "attribution"
-  gem.version       = "0.1.0"
+  gem.version       = "0.2.0"
   gem.authors       = ["Paul Barry"]
   gem.email         = ["mail@paulbarry.com"]
   gem.description   = %q{Add attributes to Ruby objects}

data/lib/attribution.rb

@@ -20,8 +20,9 @@ module Attribution
     end
   end
 
-  def attributes
-    self.class.attributes.inject({}) do |attrs, attr|
+  # TODO: Use associations argument as a way to specify which associations should be included
+  def attributes(*associations)
+    self.class.attribute_names.inject({}) do |attrs, attr|
       attrs[attr] = send(attr)
       attrs
     end
@@ -40,18 +41,25 @@ module Attribution
       @attributes ||= []
     end
 
+    def attribute_names
+      @attribute_names ||= attributes.map{|a| a[:name] }
+    end
+
+    def add_attribute(name, type, metadata={})
+      attr_reader name
+      attributes << (metadata || {}).merge(:name => name.to_sym, :type => type.to_sym)
+    end
+
     # Attribute macros
-    def string(attr)
-      attributes << attr.to_sym
-      attr_reader(attr)
+    def string(attr, metadata={})
+      add_attribute(attr, :string, metadata)
       define_method("#{attr}=") do |arg|
         instance_variable_set("@#{attr}", arg.to_s)
       end
     end
 
-    def boolean(attr)
-      attributes << attr.to_sym
-      attr_reader(attr)
+    def boolean(attr, metadata={})
+      add_attribute(attr, :boolean, metadata)
       define_method("#{attr}=") do |arg|
         v = case arg
         when String then BOOLEAN_TRUE_STRINGS.include?(arg.downcase)
@@ -63,33 +71,29 @@ module Attribution
       alias_method "#{attr}?", attr
     end
 
-    def integer(attr)
-      attributes << attr.to_sym
-      attr_reader(attr)
+    def integer(attr, metadata={})
+      add_attribute(attr, :integer, metadata)
       define_method("#{attr}=") do |arg|
         instance_variable_set("@#{attr}", arg.to_i)
       end
     end
 
-    def float(attr)
-      attributes << attr.to_sym
-      attr_reader(attr)
+    def float(attr, metadata={})
+      add_attribute(attr, :float, metadata)
       define_method("#{attr}=") do |arg|
         instance_variable_set("@#{attr}", arg.to_f)
       end
     end
 
-    def decimal(attr)
-      attributes << attr.to_sym
-      attr_reader(attr)
+    def decimal(attr, metadata={})
+      add_attribute(attr, :decimal, metadata)
       define_method("#{attr}=") do |arg|
         instance_variable_set("@#{attr}", BigDecimal.new(arg.to_s))
       end
     end
 
-    def date(attr)
-      attributes << attr.to_sym
-      attr_reader(attr)
+    def date(attr, metadata={})
+      add_attribute(attr, :date, metadata)
       define_method("#{attr}=") do |arg|
         v = case arg
         when Date then arg
@@ -101,10 +105,8 @@ module Attribution
       end
     end
 
-    def time(attr)
-      attributes << attr.to_sym
-      attributes << attr.to_sym
-      attr_reader(attr)
+    def time(attr, metadata={})
+      add_attribute(attr, :time, metadata)
       define_method("#{attr}=") do |arg|
         v = case arg
         when Date, DateTime then arg.to_time
@@ -116,20 +118,20 @@ module Attribution
       end
     end
 
-    def time_zone(attr)
-      attributes << attr.to_sym
-      attr_reader(attr)
+    def time_zone(attr, metadata={})
+      add_attribute(attr, :time_zone, metadata)
       define_method("#{attr}=") do |arg|
         instance_variable_set("@#{attr}", ActiveSupport::TimeZone[arg.to_s])
       end
     end
 
     # Association macros
-    def belongs_to(association_name)
+    def belongs_to(association_name, metadata={})
       # foo_id
-      attributes << "#{association_name}_id".to_sym
-      define_method("#{association_name}_id") do
-        ivar = "@#{association_name}_id"
+      id_getter = "#{association_name}_id".to_sym
+      add_attribute(id_getter, :integer, metadata)
+      define_method(id_getter) do
+        ivar = "@#{id_getter}"
         if instance_variable_defined?(ivar)
           instance_variable_get(ivar)
         else
@@ -142,8 +144,8 @@ module Attribution
       end
 
       # foo_id=
-      define_method("#{association_name}_id=") do |arg|
-        instance_variable_set("@#{association_name}_id", arg.to_i)
+      define_method("#{id_getter}=") do |arg|
+        instance_variable_set("@#{id_getter}", arg.to_i)
       end
 
       # foo

data/lib/attribution/version.rb

@@ -1,3 +1,3 @@
 module Attribution
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/attribution_test.rb

@@ -1,6 +1,17 @@
 require 'test/unit'
 require 'attribution'
 
+#TODO: support using a different class name than the association name
+class Author
+  include Attribution
+
+  integer :id
+  string :first_name
+  string :last_name
+
+  has_many :books
+end
+
 class Book
   include Attribution
 
@@ -15,16 +26,28 @@ class Book
   time :updated_at
   time_zone :time_zone
 
+  belongs_to :book
   has_many :chapters
 end
 
 class Chapter
   include Attribution
 
-  integer :number
+  integer :id
+  integer :number, :required => true, :doc => "Starts from 1"
   string :title
   integer :page_number
 
+  belongs_to :book
+  has_many :pages
+end
+
+class Page
+  include Attribution
+
+  integer :id
+  integer :page_number
+
   belongs_to :book
 end
 
@@ -82,7 +105,13 @@ class AttributionTest < Test::Unit::TestCase
 
   def test_attributes
     chapter = Chapter.new(:number => "1")
-    assert_equal [:number, :title, :page_number, :book_id], Chapter.attributes
-    assert_equal({ :number => 1, :title => nil, :page_number => nil, :book_id => nil }, chapter.attributes)
+    assert_equal [
+      { :name => :id, :type => :integer },
+      { :name => :number, :type => :integer, :required => true, :doc => "Starts from 1" },
+      { :name => :title, :type => :string },
+      { :name => :page_number, :type => :integer },
+      { :name => :book_id, :type => :integer }
+    ], Chapter.attributes
+    assert_equal({ :id => nil, :number => 1, :title => nil, :page_number => nil, :book_id => nil }, chapter.attributes)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attribution
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-27 00:00:00.000000000 Z
+date: 2013-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport