attribution 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in attribution.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Paul Barry
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,127 @@
+# Attribution
+
+Attribution is a gem to allow you to define attributes for a Ruby object so that getters and setters will be defined that handle typecasting.  It also allows you to define associations between objects in an [ActiveRecord-style way][ar].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'attribution'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install attribution
+
+## Usage
+
+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
+
+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)
+
+The object is populated based on the data, the values are converted into the type defined by the attribute:
+
+    >> book.id
+    => 1
+    >> book.title
+    => "Rework"
+    >> book.price
+    => #<BigDecimal:7f82dfe9d018,'0.22E2',9(18)>
+    >> book.published_on
+    => Tue, 09 Mar 2010
+    >> book.ebook_available?
+    => true
+    >> book.used?
+    => false
+    >> book.shipping_weight
+    => 14.4
+    >> book.created_at
+    => 2013-02-20 05:39:45 -0500
+    >> book.updated_at
+    => 2013-02-20 05:40:37 -0500
+    >> book.time_zone
+    => GMT-05:00 Eastern Time US  Canada
+
+Also, the association is populated with an array of objects:
+
+    >> book.chapters.size
+    => 3
+    >> book.chapters[2].page_number
+    => 29
+
+The reciprocating association is populated as well:
+
+    >> book.chapters[2].book.title
+    => "Rework"
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/attribution.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name          = "attribution"
+  gem.version       = "0.0.1"
+  gem.authors       = ["Paul Barry"]
+  gem.email         = ["mail@paulbarry.com"]
+  gem.description   = %q{Add attributes to Ruby objects}
+  gem.summary       = %q{Add attributes to Ruby objects}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "activesupport"
+  gem.add_runtime_dependency "tzinfo"
+end

data/lib/attribution/version.rb

@@ -0,0 +1,3 @@
+module Attribution
+  VERSION = "0.0.1"
+end

data/lib/attribution.rb

@@ -0,0 +1,197 @@
+require "attribution/version"
+require "active_support/core_ext"
+
+module Attribution
+  BOOLEAN_TRUE_STRINGS = ['y','yes','t','true']
+
+  def self.included(cls)
+    cls.extend(ClassMethods)
+  end
+
+  def initialize(attrs={})
+    attrs = JSON.parse(attrs) if attrs.is_a?(String)
+    attrs.each do |k,v|
+      send("#{k}=", v)
+    end
+  end
+
+  module ClassMethods
+    def cast(obj)
+      case obj
+      when Hash then new(obj)
+      when self then obj
+      else raise ArgumentError.new("can't convert #{obj.class} to #{name}")
+      end
+    end
+
+    # Attribute macros
+    def string(attr)
+      attr_reader(attr)
+      define_method("#{attr}=") do |arg|
+        instance_variable_set("@#{attr}", arg.to_s)
+      end
+    end
+
+    def boolean(attr)
+      attr_reader(attr)
+      define_method("#{attr}=") do |arg|
+        v = case arg
+        when String then BOOLEAN_TRUE_STRINGS.include?(arg.downcase)
+        when Numeric then arg == 1
+        else !!arg
+        end
+        instance_variable_set("@#{attr}", v)
+      end
+      alias_method "#{attr}?", attr
+    end
+
+    def integer(attr)
+      attr_reader(attr)
+      define_method("#{attr}=") do |arg|
+        instance_variable_set("@#{attr}", arg.to_i)
+      end
+    end
+
+    def float(attr)
+      attr_reader(attr)
+      define_method("#{attr}=") do |arg|
+        instance_variable_set("@#{attr}", arg.to_f)
+      end
+    end
+
+    def decimal(attr)
+      attr_reader(attr)
+      define_method("#{attr}=") do |arg|
+        instance_variable_set("@#{attr}", BigDecimal.new(arg.to_s))
+      end
+    end
+
+    def date(attr)
+      attr_reader(attr)
+      define_method("#{attr}=") do |arg|
+        v = case arg
+        when Date then arg
+        when Time, DateTime then arg.to_date
+        when String then Date.parse(arg)
+        else raise ArgumentError.new("can't convert #{arg.class} to Date")
+        end
+        instance_variable_set("@#{attr}", v)
+      end
+    end
+
+    def time(attr)
+      attr_reader(attr)
+      define_method("#{attr}=") do |arg|
+        v = case arg
+        when Date, DateTime then arg.to_time
+        when Time then arg
+        when String then Time.parse(arg)
+        else raise ArgumentError.new("can't convert #{arg.class} to Time")
+        end
+        instance_variable_set("@#{attr}", v)
+      end
+    end
+
+    def time_zone(attr)
+      attr_reader(attr)
+      define_method("#{attr}=") do |arg|
+        instance_variable_set("@#{attr}", ActiveSupport::TimeZone[arg.to_s])
+      end
+    end
+
+    # Association macros
+    def belongs_to(association_name)
+      # foo_id
+      define_method("#{association_name}_id") do
+        ivar = "@#{association_name}_id"
+        if instance_variable_defined?(ivar)
+          instance_variable_get(ivar)
+        else
+          if obj = send(association_name)
+            instance_variable_set(ivar, obj.id)
+          else
+            instance_variable_set(ivar, nil)
+          end
+        end
+      end
+
+      # foo_id=
+      define_method("#{association_name}_id=") do |arg|
+        instance_variable_set("@#{association_name}_id", arg.to_i)
+      end
+
+      # foo
+      define_method(association_name) do
+        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
+          rescue NameError => ex
+            raise ArgumentError.new("Association #{association_name} in #{self.class} is invalid because #{association_name.to_s.classify} does not exist")
+          end
+
+          if association_class.respond_to?(:find)
+            instance_variable_set("@#{association_name}", association_class.find(id))
+          end
+        else
+          instance_variable_set("@#{association_name}", nil)
+        end
+      end
+
+      # foo=
+      define_method("#{association_name}=") do |arg|
+        begin
+          association_class = association_name.to_s.classify.constantize
+        rescue NameError => ex
+          raise ArgumentError.new("Association #{association_name} in #{self.class} is invalid because #{association_name.to_s.classify} does not exist")
+        end
+
+        if instance_variable_defined?("@#{association_name}_id")
+          remove_instance_variable("@#{association_name}_id")
+        end
+        instance_variable_set("@#{association_name}", association_class.cast(arg))
+      end
+    end
+
+    def has_many(association_name)
+      # foos
+      define_method(association_name) do
+        ivar = "@#{association_name}"
+        if instance_variable_defined?(ivar)
+          instance_variable_get(ivar)
+        else
+          # TODO: Support a more generic version of lazy-loading
+          begin
+            association_class = association_name.to_s.singularize.classify.constantize
+          rescue NameError => ex
+            raise ArgumentError.new("Association #{association_name} in #{self.class} is invalid because #{association_name.to_s.classify} does not exist")
+          end
+
+          if association_class.respond_to?(:all)
+            instance_variable_set(ivar, Array(association_class.all("#{self.class.name.underscore}_id" => id)))
+          end
+        end
+      end
+
+      # foos=
+      define_method("#{association_name}=") do |arg|
+        # TODO: put this in method
+        begin
+          association_class = association_name.to_s.singularize.classify.constantize
+        rescue NameError => ex
+          raise ArgumentError.new("Association #{association_name} in #{self.class} is invalid because #{association_name.to_s.classify} does not exist")
+        end
+
+        objs = 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)
+          o
+        end
+        instance_variable_set("@#{association_name}", objs)
+      end
+    end
+  end
+end

data/test/attribution_test.rb

@@ -0,0 +1,86 @@
+require 'test/unit'
+require 'attribution'
+
+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
+
+class AttributionTest < Test::Unit::TestCase
+
+  def test_create
+    data = {
+      :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"
+        }
+      ]
+    }
+
+    puts JSON.pretty_generate(data)
+
+    puts data.to_json.inspect
+
+    book = Book.new(data.to_json)
+
+    assert_equal 1, book.id
+    assert_equal "Rework", book.title
+    assert_equal BigDecimal.new("22.00"), book.price
+    assert_equal BigDecimal, book.price.class
+    assert_equal Date.new(2010, 3, 9), book.published_on
+    assert_equal true, book.ebook_available
+    assert_equal true, book.ebook_available?
+    assert_equal false, book.used
+    assert_equal false, book.used?
+    assert_equal 14.4, book.shipping_weight
+    assert_equal Float, book.shipping_weight.class
+    assert_equal Time.parse("2013-02-20T05:39:45-05:00"), book.created_at
+    assert_equal Time.parse("2013-02-20T05:40:37-05:00"), book.updated_at
+    assert_equal ActiveSupport::TimeZone["Eastern Time (US & Canada)"], book.time_zone
+    assert_equal 1, book.chapters.first.number
+    assert_equal 3, book.chapters.size
+    assert_equal book, book.chapters.first.book
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: attribution
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Paul Barry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- attribution.gemspec
+- lib/attribution.rb
+- lib/attribution/version.rb
+- test/attribution_test.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Add attributes to Ruby objects
+test_files:
+- test/attribution_test.rb
+has_rdoc: