attribution 0.4.0 → 0.5.0

data/README.md

@@ -20,66 +20,70 @@ Or install it yourself as:
 
 You can define attributes like this:
 
-    class Book
-      include Attribution
-
-      integer :id
-      string :title
-      decimal :price
-      date :published_on
-      boolean :ebook_available
-      boolean :used
-      float :shipping_weight
-      time :created_at
-      time :updated_at
-      time_zone :time_zone
-
-      has_many :chapters
-    end
-
-    class Chapter
-      include Attribution
-
-      integer :number
-      string :title
-      integer :page_number
-
-      belongs_to :book
-    end
+``` ruby
+class Book
+  include Attribution
+
+  integer :id
+  string :title
+  decimal :price
+  date :published_on
+  boolean :ebook_available
+  boolean :used
+  float :shipping_weight
+  time :created_at
+  time :updated_at
+  time_zone :time_zone
+
+  has_many :chapters
+end
+
+class Chapter
+  include Attribution
+
+  integer :number
+  string :title
+  integer :page_number
+
+  belongs_to :book
+end
+```
 
 And then you can pass in a Hash or a String of JSON to initialize the object:
 
-    json = %{{
-      "id": 1,
-      "title": "Rework",
-      "price": "22.00",
-      "published_on": "March 9, 2010",
-      "ebook_available": "yes",
-      "used": "no",
-      "shipping_weight": "14.4",
-      "created_at": "2013-02-20 05:39:45 -0500",
-      "updated_at": "2013-02-20T05:40:37-05:00",
-      "time_zone": "Eastern Time (US & Canada)",
-      "chapters": [
-        {
-          "number": "1",
-          "title": "Introduction",
-          "page_number": "1"
-        },
-        {
-          "number": "2",
-          "title": "Takedowns",
-          "page_number": "7"
-        },
-        {
-          "number": "3",
-          "title": "Go",
-          "page_number": "29"
-        }
-      ]
-    }}
-
-    book = Book.new(json)
+``` ruby
+json = %{{
+  "id": 1,
+  "title": "Rework",
+  "price": "22.00",
+  "published_on": "March 9, 2010",
+  "ebook_available": "yes",
+  "used": "no",
+  "shipping_weight": "14.4",
+  "created_at": "2013-02-20 05:39:45 -0500",
+  "updated_at": "2013-02-20T05:40:37-05:00",
+  "time_zone": "Eastern Time (US & Canada)",
+  "chapters": [
+    {
+      "number": "1",
+      "title": "Introduction",
+      "page_number": "1"
+    },
+    {
+      "number": "2",
+      "title": "Takedowns",
+      "page_number": "7"
+    },
+    {
+      "number": "3",
+      "title": "Go",
+      "page_number": "29"
+    }
+  ]
+}}
+
+book = Book.new(json)
+```
 
 The object is populated based on the data, the values are converted into the type defined by the attribute:
 
@@ -132,17 +136,65 @@ You can access the values of all attributes as a hash:
 
 You can also add any arbitrary metadata to any attribute:
 
-    class Book
-      include Attribution
+``` ruby
+class Book
+  include Attribution
 
-      decimal :price, :required => true, :doc => "Price in USD", :whatever => "why not?"
-    end
+  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}]
 
+Attribution also has a module to make any object act more like a model:
+
+``` ruby
+class Book
+  include Attribution::Model
+end
+```
+
+By using `Attribution::Model`, your object will:
+
+* Have an id that is an integer
+* Implementation for equality and hash based on the id
+* Have a created_at that is a time
+* Have an updated_at that is a time
+* Include [ActiveModel::Validations][am]
+
+You can define validations in the standard way you do when using `ActiveModel::Validations`:
+
+``` ruby
+class Book
+  include Attribution::Model
+
+  belongs_to :author
+
+  string :title
+
+  validates :title, :presence => true
+  validates :title, :uniqueness => true
+  validates :title, :format => { :with => /^\w/, :message => "must start with a letter" }
+end
+```
+
+Or, more concisely, you can define the validation as part of the attribute definition:
+
+``` ruby
+class Book
+  include Attribution::Model
+
+  belongs_to :author
+
+  string :title, :required => true,
+                 :unique => true,
+                 :format => { :with => /^w/, :message => "must start with a letter" }
+end
+```
+
 ## Contributing
 
 1. Fork it
@@ -152,3 +204,4 @@ And retrieve that metadata any time:
 5. Create new Pull Request
 
 [ar]: http://api.rubyonrails.org/classes/ActiveRecord/Associations/ClassMethods.html
+[am]: http://rubydoc.info/gems/activemodel

data/attribution.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name          = "attribution"
-  gem.version       = "0.4.0"
+  gem.version       = "0.5.0"
   gem.authors       = ["Paul Barry"]
   gem.email         = ["mail@paulbarry.com"]
   gem.description   = %q{Add attributes to Ruby objects}
@@ -16,4 +16,5 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency "activesupport"
   gem.add_runtime_dependency "tzinfo"
+  gem.add_development_dependency "activemodel"
 end

data/lib/attribution/id.rb

@@ -0,0 +1,20 @@
+module Attribution
+  module ID
+    def self.included(cls)
+      cls.class_eval do
+        integer :id
+
+        alias_method :to_param, :id
+      end
+    end
+
+    def ==(o)
+      o.class == self.class && o.id == id
+    end
+    alias_method :eql?, :==
+
+    def hash
+      id.hash
+    end
+  end
+end

data/lib/attribution/model.rb

@@ -0,0 +1,16 @@
+require 'attribution/id'
+require 'attribution/timestamps'
+require 'attribution/validations'
+
+module Attribution
+  module Model
+    def self.included(cls)
+      cls.class_eval do
+        include Attribution
+        include ID
+        include Timestamps
+        include Validations
+      end
+    end
+  end
+end

data/lib/attribution/timestamps.rb

@@ -0,0 +1,10 @@
+module Attribution
+  module Timestamps
+    def self.included(cls)
+      cls.class_eval do
+        time :created_at
+        time :updated_at
+      end
+    end
+  end
+end

data/lib/attribution/validations.rb

@@ -0,0 +1,53 @@
+require 'active_model'
+
+module Attribution
+  module Validations
+
+    def self.included(cls)
+      cls.class_eval do
+        extend ClassMethods
+        include ActiveModel::Validations
+      end
+    end
+
+    module ClassMethods
+
+      VALIDATIONS = [
+        [:presence, :required],
+        [:presence],
+        [:uniqueness, :unique],
+        [:uniqueness],
+        [:format],
+        [:length],
+        [:inclusion],
+        [:numericality, :number],
+        [:numericality]
+      ]
+
+      def add_attribute(name, type, metadata={})
+        super
+        VALIDATIONS.each do |validation_name, validation_alias|
+          validation_alias ||= validation_name
+          if metadata[validation_alias] == true
+            validates name, validation_name => true
+          elsif metadata[validation_alias]
+            validates name, validation_name => metadata[validation_alias]
+          end
+        end
+      end
+
+    end
+
+    def errors
+      @errors ||= ActiveModel::Errors.new(self)
+    end
+
+    def errors=(errs)
+      if errs
+        errs.each do |attr, e|
+          errors.add attr, e
+        end
+      end
+    end
+  end
+end

data/lib/attribution/version.rb

@@ -1,3 +1,3 @@
 module Attribution
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/attribution.rb

@@ -1,6 +1,6 @@
-require "attribution/util"
-require "attribution/version"
-require "active_support/core_ext"
+require 'active_support/core_ext'
+require 'attribution/util'
+require 'attribution/version'
 
 module Attribution
   BOOLEAN_TRUE_STRINGS = ['y','yes','t','true']
@@ -13,13 +13,13 @@ module Attribution
     self.attributes = attributes
   end
 
-  # 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
   end
+  alias_method :to_h, :attributes
 
   def attributes=(attributes)
     if attributes

data/test/attribution_model_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+require 'attribution/model'
+
+class Article
+  include Attribution::Model
+
+  string :title, required: true, format: { with: /^\w/, message: "must start with a letter" }, length: 4..20
+end
+
+class AttributionModelTest < Test::Unit::TestCase
+  def test_model
+    article = Article.new(id: 1, created_at: Time.now, updated_at: Time.now)
+    assert !article.valid?
+    assert_equal ["can't be blank", "must start with a letter", "is too short (minimum is 4 characters)"], article.errors[:title]
+  end
+end

data/test/attribution_test.rb

@@ -1,5 +1,4 @@
-require 'test/unit'
-require 'attribution'
+require 'test_helper'
 
 #TODO: support using a different class name than the association name
 class Author
@@ -128,7 +127,7 @@ class AttributionTest < Test::Unit::TestCase
       { :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)
+    assert_equal({ :id => nil, :number => 1, :title => nil, :page_number => nil, :book_id => nil }, chapter.to_h)
   end
 
   def test_date_hash

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require 'attribution'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attribution
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-08 00:00:00.000000000 Z
+date: 2013-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  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'
 description: Add attributes to Ruby objects
 email:
 - mail@paulbarry.com
@@ -57,9 +73,15 @@ files:
 - Rakefile
 - attribution.gemspec
 - lib/attribution.rb
+- lib/attribution/id.rb
+- lib/attribution/model.rb
+- lib/attribution/timestamps.rb
 - lib/attribution/util.rb
+- lib/attribution/validations.rb
 - lib/attribution/version.rb
+- test/attribution_model_test.rb
 - test/attribution_test.rb
+- test/test_helper.rb
 homepage: http://github.com/pjb3/attribution
 licenses: []
 post_install_message: 
@@ -80,9 +102,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Add attributes to Ruby objects
 test_files:
+- test/attribution_model_test.rb
 - test/attribution_test.rb
+- test/test_helper.rb
+has_rdoc: