attribution 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47f71dbe5313d245cc8548a49367c9ce1f33a4c0
-  data.tar.gz: 88bffa818cdb84d3a2c3575972af941a5e47e339
+  metadata.gz: d198859156d76d0e0c11d018834a556df0dbdfcb
+  data.tar.gz: 0a103445301e0ea36e62bf12b6d2089b015b9496
 SHA512:
-  metadata.gz: 7d6660fca38237e02cd6b042b8c67ad8c4de68e29a70997eb96f0522068562d47455dec03d4855b50f7a4d7b8a9245279cb9276489f7a9827d96799f75a6a034
-  data.tar.gz: 7c1da374f1d0728561d20d6e02179f44c3e7554029e2562616cafc5690f89cc4bd88b3898bfd0f94da36a505399605d011d1bf5fa9608ffc70a7bdd4940ec420
+  metadata.gz: 053aeb28529a3da23866dfdf01f4ccc53d1c9d07517c9e2e22647acef67d73614800b69517f7984b39af2112235f5cda34caab72a3390b8958e7b65bad754629
+  data.tar.gz: 380264f5c4aaf9df41bc2030de3c281d914983d7482939bcd54b54a2195bf8158b79a3d76a693c97f6ce58ee0aa7c9a5ec7ff44bcecf88b38affac8a9dd6f0fe

data/.ruby-version

@@ -1 +1 @@
-2.0.0-p0
+2.0.0-p247

data/Rakefile

@@ -2,7 +2,7 @@ require "bundler/gem_tasks"
 require "rake/testtask"
 
 Rake::TestTask.new do |t|
-  t.libs = ["lib"]
+  t.libs = ["lib", "test"]
   t.test_files = FileList["test/*_test.rb"]
 end
 

data/attribution.gemspec

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

data/lib/attribution/version.rb

@@ -1,3 +1,3 @@
 module Attribution
-  VERSION = "0.6.3"
+  VERSION = "0.6.4"
 end

data/lib/attribution.rb

@@ -16,6 +16,7 @@ module Attribution
     self.attributes = attributes
   end
 
+  # @return [Hash] the attributes of this instance and their values
   def attributes(*associations)
     self.class.attribute_names.inject({}) do |attrs, attr|
       attrs[attr] = send(attr)
@@ -24,6 +25,7 @@ module Attribution
   end
   alias_method :to_h, :attributes
 
+  # @param [String, Hash] attributes The attributes and their values
   def attributes=(attributes)
     attributes = case attributes
     when String then JSON.parse(attributes)
@@ -40,6 +42,10 @@ module Attribution
   end
 
   module ClassMethods
+
+    # @param [Hash, Attribution] obj The Hash or Object to convert to
+    #   an instance of this class
+    # @return [Attribution] An instance of this class
     def cast(obj)
       case obj
       when Hash then new(obj)
@@ -48,6 +54,8 @@ module Attribution
       end
     end
 
+    # @return [Hash{Symbol => Object}] Each attribute name, type and
+    #   any related metadata in the order in which they were defined
     def attributes
       @attributes ||= if superclass && superclass.respond_to?(:attributes)
         superclass.attributes.dup
@@ -56,16 +64,28 @@ module Attribution
       end
     end
 
+    # @return [Array<Symbol>] The names of the attributes
+    #   in the order in which they were defined
     def attribute_names
       @attribute_names ||= attributes.map{|a| a[:name] }
     end
 
+    # Attribute macros
+
+    # Defines an attribute
+    #
+    # @param [String] name The name of the attribute
+    # @param [Symbol] type The type of the attribute
+    # @param [Hash{Symbol => Object}] metadata The metadata for the attribute
     def add_attribute(name, type, metadata={})
       attr_reader name
       attributes << (metadata || {}).merge(:name => name.to_sym, :type => type.to_sym)
     end
 
-    # Attribute macros
+    # Defines a string attribute
+    #
+    # @param [Symbol] attr The name of the attribute
+    # @param [Hash{Symbol => Object}] metadata The metadata for the attribute
     def string(attr, metadata={})
       add_attribute(attr, :string, metadata)
       define_method("#{attr}=") do |arg|
@@ -73,6 +93,10 @@ module Attribution
       end
     end
 
+    # Defines a boolean attribute
+    #
+    # @param [Symbol] attr The name of the attribute
+    # @param [Hash{Symbol => Object}] metadata The metadata for the attribute
     def boolean(attr, metadata={})
       add_attribute(attr, :boolean, metadata)
       define_method("#{attr}=") do |arg|
@@ -87,6 +111,10 @@ module Attribution
       alias_method "#{attr}?", attr
     end
 
+    # Defines a integer attribute
+    #
+    # @param [Symbol] attr The name of the attribute
+    # @param [Hash{Symbol => Object}] metadata The metadata for the attribute
     def integer(attr, metadata={})
       add_attribute(attr, :integer, metadata)
       define_method("#{attr}=") do |arg|
@@ -94,6 +122,10 @@ module Attribution
       end
     end
 
+    # Defines a float attribute
+    #
+    # @param [Symbol] attr The name of the attribute
+    # @param [Hash{Symbol => Object}] metadata The metadata for the attribute
     def float(attr, metadata={})
       add_attribute(attr, :float, metadata)
       define_method("#{attr}=") do |arg|
@@ -101,6 +133,10 @@ module Attribution
       end
     end
 
+    # Defines a decimal attribute
+    #
+    # @param [Symbol] attr The name of the attribute
+    # @param [Hash{Symbol => Object}] metadata The metadata for the attribute
     def decimal(attr, metadata={})
       add_attribute(attr, :decimal, metadata)
       define_method("#{attr}=") do |arg|
@@ -108,6 +144,10 @@ module Attribution
       end
     end
 
+    # Defines a date attribute
+    #
+    # @param [Symbol] attr The name of the attribute
+    # @param [Hash{Symbol => Object}] metadata The metadata for the attribute
     def date(attr, metadata={})
       add_attribute(attr, :date, metadata)
       define_method("#{attr}=") do |arg|
@@ -125,6 +165,10 @@ module Attribution
       end
     end
 
+    # Defines a time attribute
+    #
+    # @param [Symbol] attr The name of the attribute
+    # @param [Hash{Symbol => Object}] metadata The metadata for the attribute
     def time(attr, metadata={})
       add_attribute(attr, :time, metadata)
       define_method("#{attr}=") do |arg|
@@ -142,6 +186,10 @@ module Attribution
       end
     end
 
+    # Defines a time zone attribute, based on ActiveSupport::TimeZone
+    #
+    # @param [Symbol] attr The name of the attribute
+    # @param [Hash{Symbol => Object}] metadata The metadata for the attribute
     def time_zone(attr, metadata={})
       add_attribute(attr, :time_zone, metadata)
       define_method("#{attr}=") do |arg|
@@ -150,10 +198,20 @@ module Attribution
     end
 
     # Association macros
+
+    # Defines an attribute that is a reference to another Attribution class.
+    #
+    # @param [Symbol] association_name The name of the association
+    # @param [Hash] metadata Extra information about the association.
+    # @option metadata [String] :class_name Class of the association,
+    #   defaults to a class name based on the association name
     def belongs_to(association_name, metadata={})
       # foo_id
       id_getter = "#{association_name}_id".to_sym
       add_attribute(id_getter, :integer, metadata)
+
+      association_class_name = metadata.try(:fetch, :class_name, [name.deconstantize, association_name.to_s.classify].reject(&:blank?).join('::'))
+
       define_method(id_getter) do
         ivar = "@#{id_getter}"
         if instance_variable_defined?(ivar)
@@ -177,11 +235,12 @@ module Attribution
         if instance_variable_defined?("@#{association_name}")
           instance_variable_get("@#{association_name}")
         elsif id = instance_variable_get("@#{association_name}_id")
+
           # TODO: Support a more generic version of lazy-loading
           begin
-            association_class = association_name.to_s.classify.constantize
+            association_class = Object.const_get(association_class_name)
           rescue NameError => ex
-            raise ArgumentError.new("Association #{association_name} in #{self.class} is invalid because #{association_name.to_s.classify} does not exist")
+            raise ArgumentError.new("Association #{association_name} in #{self.class} is invalid because #{association_class_name} does not exist")
           end
 
           if association_class.respond_to?(:find)
@@ -195,9 +254,9 @@ module Attribution
       # foo=
       define_method("#{association_name}=") do |arg|
         begin
-          association_class = association_name.to_s.classify.constantize
+          association_class = Object.const_get(association_class_name)
         rescue NameError => ex
-          raise ArgumentError.new("Association #{association_name} in #{self.class} is invalid because #{association_name.to_s.classify} does not exist")
+          raise ArgumentError.new("Association #{association_name} in #{self.class} is invalid because #{association_class_name} does not exist")
         end
 
         if instance_variable_defined?("@#{association_name}_id")
@@ -207,15 +266,24 @@ module Attribution
       end
     end
 
-    def has_many(association_name)
+    # Defines an attribute that is a reference to an Array of another Attribution class.
+    #
+    # @param [Symbol] association_name The name of the association
+    # @param [Hash] metadata Extra information about the association.
+    # @option metadata [String] :class_name Class of the association,
+    #   defaults to a class name based on the association name
+    def has_many(association_name, metadata={})
+
+      association_class_name = metadata.try(:fetch, :class_name, [name.deconstantize, association_name.to_s.singularize.classify].reject(&:blank?).join('::'))
+
       # foos
       define_method(association_name) do |*query|
 
         # TODO: Support a more generic version of lazy-loading
         begin
-          association_class = association_name.to_s.classify.constantize
+          association_class = Object.const_get(association_class_name)
         rescue NameError => ex
-          raise ArgumentError.new("Association #{association_name} in #{self.class} is invalid because #{association_name.to_s.classify} does not exist")
+          raise ArgumentError.new("Association #{association_name} in #{self.class} is invalid because #{association_class_name} does not exist")
         end
 
         if query.empty? # Ex: Books.all, so we want to cache it.
@@ -227,7 +295,7 @@ module Attribution
           end
         else # Ex: Book.all(:name => "The..."), so we do not want to cache it
           if association_class.respond_to?(:all)
-            Array(association_class.all({"#{self.class.name.underscore}_id" => id}.merge(query.first)))
+            Array(association_class.all({"#{self.class.name.demodulize.underscore}_id" => id}.merge(query.first)))
           end
         end
       end
@@ -236,15 +304,23 @@ module Attribution
       define_method("#{association_name}=") do |arg|
         # TODO: put this in method
         begin
-          association_class = association_name.to_s.classify.constantize
+          association_class = Object.const_get(association_class_name)
         rescue NameError => ex
-          raise ArgumentError.new("Association #{association_name} in #{self.class} is invalid because #{association_name.to_s.classify} does not exist")
+          raise ArgumentError.new("Association #{association_name} in #{self.class} is invalid because #{association_class_name} does not exist")
         end
 
+        attr_name = self.class.name.demodulize.underscore
         objs = (arg.is_a?(Hash) ? arg.values : Array(arg)).map do |obj|
           o = association_class.cast(obj)
-          o.send("#{self.class.name.underscore}=", self)
-          o.send("#{self.class.name.underscore}_id=", id)
+
+          if o.respond_to?("#{attr_name}=")
+            o.send("#{attr_name}=", self)
+          end
+
+          if o.respond_to?("#{attr_name}_id=") && respond_to?(:id)
+            o.send("#{attr_name}_id=", id)
+          end
+
           o
         end
         instance_variable_set("@#{association_name}", objs)

data/test/attribution_model_test.rb

@@ -4,7 +4,7 @@ require 'attribution/model'
 class Article
   include Attribution::Model
 
-  string :title, required: true, format: { with: /^\w/, message: "must start with a letter" }, length: 4..20
+  string :title, required: true, format: { with: /\A\w/, message: "must start with a letter" }, length: 4..20
 end
 
 class AttributionModelTest < Test::Unit::TestCase

data/test/attribution_test.rb

@@ -11,10 +11,10 @@ class Address
   string :state
   string :zip
 
-  belongs_to :author
+  belongs_to :author, :class_name => 'Person'
 end
 
-class Author
+class Person
   include Attribution
 
   integer :id
@@ -94,6 +94,32 @@ class Grandchild < Child
   string :baz
 end
 
+module Music
+
+end
+
+module Music
+  class Album
+    include Attribution
+
+    has_many :tracks
+
+    string :artist
+    string :title
+  end
+end
+
+module Music
+  class Track
+    include Attribution
+
+    belongs_to :album
+
+    integer :number
+    string :title
+  end
+end
+
 class AttributionTest < Test::Unit::TestCase
 
   def test_create
@@ -254,11 +280,21 @@ class AttributionTest < Test::Unit::TestCase
   end
 
   def test_has_many_association_name
-    author = Author.new(addresses: [{id: 1}])
-    assert_equal [1], author.addresses.map(&:id)
+    person = Person.new(addresses: [{id: 1}])
+    assert_equal [1], person.addresses.map(&:id)
   end
 
   def test_attribute_inheritence
     assert_equal [:foo, :bar, :baz], Grandchild.attribute_names
   end
+
+  def test_namespaced_belongs_to
+    track = Music::Track.new(number: 1, title: "Elevator Music", album: { artist: "Beck", title: "The Information" })
+    assert_equal "Beck", track.album.artist
+  end
+
+  def test_namespaced_has_many
+    album = Music::Album.new(artist: "Beck", title: "The Information", tracks: [ { number: 1, title: "Elevator Music" } ])
+    assert_equal "Elevator Music", album.tracks.first.title
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attribution
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - Paul Barry
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-09 00:00:00.000000000 Z
+date: 2013-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Add attributes to Ruby objects
@@ -103,3 +103,4 @@ test_files:
 - test/attribution_model_test.rb
 - test/attribution_test.rb
 - test/test_helper.rb
+has_rdoc: