hashie-model 1.0.0.alpha

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Istvan Hoka
+
+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,3 @@
+# Hashie Model
+
+© 2011 Doublewide Partners I, LLC

data/hashie-model.gemspec

@@ -0,0 +1,106 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{hashie-model}
+  s.version = "1.0.0.alpha"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{ZenCash.com}]
+  s.date = %q{2011-11-01}
+  s.description = %q{Hashie + ActiveModel 3, offering declared properties, validations, JSON serialization/deserialization}
+  s.email = %q{istvan@zencash.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    "LICENSE.txt",
+    "README.md",
+    "hashie-model.gemspec",
+    "lib/hashie-model.rb",
+    "lib/hashie_model/array_of.rb",
+    "lib/hashie_model/associated_validator.rb",
+    "lib/hashie_model/base.rb",
+    "lib/hashie_model/money.rb",
+    "lib/hashie_model/spec/matchers.rb",
+    "lib/hashie_model/version.rb",
+    "vendor/hashie/lib/hashie.rb",
+    "vendor/hashie/lib/hashie/clash.rb",
+    "vendor/hashie/lib/hashie/dash.rb",
+    "vendor/hashie/lib/hashie/extensions/coercion.rb",
+    "vendor/hashie/lib/hashie/extensions/deep_merge.rb",
+    "vendor/hashie/lib/hashie/extensions/indifferent_access.rb",
+    "vendor/hashie/lib/hashie/extensions/key_conversion.rb",
+    "vendor/hashie/lib/hashie/extensions/merge_initializer.rb",
+    "vendor/hashie/lib/hashie/extensions/method_access.rb",
+    "vendor/hashie/lib/hashie/extensions/structure.rb",
+    "vendor/hashie/lib/hashie/hash.rb",
+    "vendor/hashie/lib/hashie/hash_extensions.rb",
+    "vendor/hashie/lib/hashie/mash.rb",
+    "vendor/hashie/lib/hashie/trash.rb",
+    "vendor/hashie/lib/hashie/version.rb"
+  ]
+  s.homepage = %q{http://github.com/doublewide/hashie-model}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{Hashie + ActiveModel 3.x}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.1.1"])
+      s.add_runtime_dependency(%q<activemodel>, [">= 3.1.1"])
+      s.add_runtime_dependency(%q<money>, [">= 3.7.1"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<shoulda-matchers>, ["~> 1.0.0.beta3"])
+      s.add_development_dependency(%q<yard>, [">= 0.7.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rb-fsevent>, [">= 0"])
+      s.add_development_dependency(%q<growl>, [">= 0"])
+      s.add_development_dependency(%q<guard>, [">= 0"])
+      s.add_development_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_development_dependency(%q<guard-yard>, [">= 0"])
+      s.add_development_dependency(%q<guard-bundler>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 3.1.1"])
+      s.add_dependency(%q<activemodel>, [">= 3.1.1"])
+      s.add_dependency(%q<money>, [">= 3.7.1"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<shoulda-matchers>, ["~> 1.0.0.beta3"])
+      s.add_dependency(%q<yard>, [">= 0.7.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rb-fsevent>, [">= 0"])
+      s.add_dependency(%q<growl>, [">= 0"])
+      s.add_dependency(%q<guard>, [">= 0"])
+      s.add_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_dependency(%q<guard-yard>, [">= 0"])
+      s.add_dependency(%q<guard-bundler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 3.1.1"])
+    s.add_dependency(%q<activemodel>, [">= 3.1.1"])
+    s.add_dependency(%q<money>, [">= 3.7.1"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<shoulda-matchers>, ["~> 1.0.0.beta3"])
+    s.add_dependency(%q<yard>, [">= 0.7.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rb-fsevent>, [">= 0"])
+    s.add_dependency(%q<growl>, [">= 0"])
+    s.add_dependency(%q<guard>, [">= 0"])
+    s.add_dependency(%q<guard-rspec>, [">= 0"])
+    s.add_dependency(%q<guard-yard>, [">= 0"])
+    s.add_dependency(%q<guard-bundler>, [">= 0"])
+  end
+end
+

data/lib/hashie-model.rb

@@ -0,0 +1,28 @@
+require 'active_model'
+
+# Load vendored Hashie unless it is already loaded.
+# We must have version >= 2.0 in order to get the Conversions API.
+if defined?(Hashie)
+  raise "Hashie >= 2.0.0 required by HashieModel." unless Hashie::VERSION.split('.').first.to_i >= 2
+else
+  $:.unshift File.expand_path(File.join('..', 'vendor', 'hashie', 'lib'), File.dirname(__FILE__))
+end
+require 'hashie'
+
+require 'active_support'
+require 'active_support/core_ext'
+require 'active_support/json'
+require 'money'
+
+module HashieModel
+  extend ActiveSupport::Autoload
+  
+  autoload :ArrayOf
+  autoload :AssociatedValidator
+  autoload :Base
+  autoload :Money
+  
+  autoload :Version
+  
+  include ArrayOf
+end

data/lib/hashie_model/array_of.rb

@@ -0,0 +1,15 @@
+module HashieModel
+  module ArrayOf
+    extend ActiveSupport::Concern
+    
+    module ClassMethods
+      def array_of(klass)
+        Class.new(Array) do
+          define_method(:initialize) do |values|
+            replace values.map { |value| klass.new(value) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hashie_model/associated_validator.rb

@@ -0,0 +1,8 @@
+module HashieModel
+  class AssociatedValidator < ActiveModel::EachValidator
+    def validate_each(record, attribute, value)
+      return if (value.is_a?(Array) ? value : [value]).collect{ |r| r.nil? || r.valid? }.all?
+      record.errors.add(attribute, :invalid, options.merge(:value => value))
+    end
+  end
+end

data/lib/hashie_model/base.rb

@@ -0,0 +1,74 @@
+module HashieModel
+  class Base < Hashie::Dash
+    extend ActiveModel::Naming
+    
+    include Hashie::Extensions::Coercion
+    
+    include ActiveModel::AttributeMethods
+    include ActiveModel::Conversion
+    include ActiveModel::Validations
+    
+    attribute_method_suffix '?', '_before_type_cast'
+    
+    class << self
+      def prop(name, type = nil, options = {})
+        if type.is_a?(Hash)
+          options = type
+          type    = nil
+        end
+        
+        property(name, options)
+        
+        if type
+          coerce_key(name.to_sym, type)
+          coerce_key(name.to_s, type)
+        end
+        
+        define_attribute_methods [name]
+        alias_method :"#{name}_without_type_cast=", :"#{name}="
+        
+        define_method(:"#{name}=") do |value|
+          attributes_before_type_cast[name.to_s] = value
+          send(:"#{name}_without_type_cast=", value)
+        end
+      end
+      
+      def from_json(json)
+        new(ActiveSupport::JSON.decode(json))
+      end
+      
+      def validates_associated(*attr_names)
+        validates_with HashieModel::AssociatedValidator, _merge_attributes(attr_names)
+      end
+    end
+    
+    def attributes_before_type_cast
+      @attributes_before_type_cast ||= {}
+    end
+    
+    def attributes
+      {}.tap do |attrs|
+        self.class.properties.each do |key|
+          attrs[key] = self[key]
+        end
+      end
+    end
+    
+    def persisted?
+      false
+    end
+    
+    protected
+      def attribute?(key)
+        self[key].present?
+      end
+      
+      def reset_attribute(key)
+        self[key] = self.class.defaults[key.to_sym]
+      end
+      
+      def attribute_before_type_cast(key)
+        attributes_before_type_cast[key.to_s]
+      end
+  end
+end

data/lib/hashie_model/money.rb

@@ -0,0 +1,12 @@
+module HashieModel
+  class Money < ::Money
+    def self.coerce(value)
+      cents = value.is_a?(Money) ? value.cents : value.to_money(:USD).cents
+      new(cents, :USD)
+    end
+    
+    def as_json(options=nil)
+      to_s
+    end
+  end
+end

data/lib/hashie_model/spec/matchers.rb

@@ -0,0 +1,86 @@
+RSpec::Matchers.define :have_property do |*expected|
+  options       = expected.extract_options!
+  property_name = expected.first
+  coercion      = expected.second
+  
+  description {
+    desc = "have"
+    desc << " required" if options[:required]
+    desc << " property :#{property_name}"
+    desc << ", coerced to #{coercion}" if coercion
+    desc << ", with default '#{options[:default]}'" if options.has_key?(:default)
+    desc
+  }
+  
+  match do |actual|
+    property_exists = actual.class.properties.include?(property_name)
+    
+    default_matches = if options.has_key?(:default)
+      actual.class.defaults[property_name] == options[:default]
+    else
+      true
+    end
+    
+    required_matches = if options[:required]
+      actual.class.required_properties.include?(property_name)
+    else
+      !actual.class.required_properties.include?(property_name)
+    end
+    
+    coercion_matches = if coercion
+      actual.class.key_coercion(property_name.to_sym) == coercion &&
+      actual.class.key_coercion(property_name.to_s) == coercion
+    else
+      actual.class.key_coercion(property_name.to_sym).nil? &&
+      actual.class.key_coercion(property_name.to_s).nil?
+    end
+    
+    property_exists && default_matches && required_matches && coercion_matches
+  end
+end
+
+RSpec::Matchers.define :serialize_to do |json|
+  description { "serialize to JSON" }
+  expected = ActiveSupport::JSON.decode(json)
+  
+  match do |object|
+    actual = ActiveSupport::JSON.decode(object.to_json)
+    actual == expected
+  end
+  
+  failure_message_for_should do |object|
+    actual = ActiveSupport::JSON.decode(object.to_json)
+    "expected that #{object} would serialize to #{expected.pretty_inspect}Diff:#{RSpec::Expectations.differ.diff_as_object(actual, expected)}"
+  end
+end
+
+RSpec::Matchers.define :deserialize_from do |json|
+  description { "deserialize from JSON" }
+  
+  match do |object|
+    new_object = object.class.from_json(json)
+    new_object.is_a?(object.class) && new_object == object
+  end
+end
+
+RSpec::Matchers.define :act_as_array do
+  match do |object|
+    klass       = object.class
+    array_klass = ZCQ::Component.const_get(:"ArrayOf#{klass.name.demodulize}s")
+    
+    actual   = [object]
+    expected = array_klass.new([object.as_json])
+    
+    actual == expected
+  end
+end
+
+RSpec::Matchers.define :validate_associated do |attribute|
+  match do |component|
+    component.stub(attribute => mock("#{component.class}.#{attribute}", :valid? => false))
+    is_invalid = !component.valid?
+    right_error_count = component.errors[attribute].size == 1
+    
+    is_invalid && right_error_count
+  end
+end

data/lib/hashie_model/version.rb

@@ -0,0 +1,10 @@
+module HashieModel
+  module Version
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
+    BUILD = 'alpha'
+    
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+end

data/vendor/hashie/lib/hashie.rb

@@ -0,0 +1,23 @@
+module Hashie
+  autoload :Clash,          'hashie/clash'
+  autoload :Dash,           'hashie/dash'
+  autoload :Hash,           'hashie/hash'
+  autoload :HashExtensions, 'hashie/hash_extensions'
+  autoload :Mash,           'hashie/mash'
+  autoload :PrettyInspect,  'hashie/hash_extensions'
+  autoload :Trash,          'hashie/trash'
+
+  module Extensions
+    autoload :Coercion,          'hashie/extensions/coercion'
+    autoload :DeepMerge,         'hashie/extensions/deep_merge'
+    autoload :KeyConversion,     'hashie/extensions/key_conversion'
+    autoload :IndifferentAccess, 'hashie/extensions/indifferent_access'
+    autoload :MergeInitializer,  'hashie/extensions/merge_initializer'
+    autoload :MethodAccess,      'hashie/extensions/method_access'
+    autoload :MethodQuery,       'hashie/extensions/method_access'
+    autoload :MethodReader,      'hashie/extensions/method_access'
+    autoload :MethodWriter,      'hashie/extensions/method_access'
+    autoload :StringifyKeys,     'hashie/extensions/key_conversion'
+    autoload :SymbolizeKeys,     'hashie/extensions/key_conversion'
+  end
+end

data/vendor/hashie/lib/hashie/clash.rb

@@ -0,0 +1,86 @@
+require 'hashie/hash'
+
+module Hashie
+  #
+  # A Clash is a "Chainable Lazy Hash". Inspired by libraries such as Arel,
+  # a Clash allows you to chain together method arguments to build a 
+  # hash, something that's especially useful if you're doing something
+  # like constructing a complex options hash. Here's a basic example:
+  # 
+  #     c = Hashie::Clash.new.conditions(:foo => 'bar').order(:created_at)
+  #     c # => {:conditions => {:foo => 'bar'}, :order => :created_at}
+  #
+  # Clash provides another way to create sub-hashes by using bang notation.
+  # You can dive into a sub-hash by providing a key with a bang and dive
+  # back out again with the _end! method. Example:
+  #
+  #     c = Hashie::Clash.new.conditions!.foo('bar').baz(123)._end!.order(:created_at)
+  #     c # => {:conditions => {:foo => 'bar', :baz => 123}, :order => :created_at}
+  #
+  # Because the primary functionality of Clash is to build options objects,
+  # all keys are converted to symbols since many libraries expect symbols explicitly
+  # for keys.
+  #
+  class Clash < ::Hash
+    class ChainError < ::StandardError; end
+    # The parent Clash if this Clash was created via chaining.
+    attr_reader :_parent
+    
+    # Initialize a new clash by passing in a Hash to
+    # convert and, optionally, the parent to which this
+    # Clash is chained.
+    def initialize(other_hash = {}, parent = nil)
+      @_parent = parent
+      other_hash.each_pair do |k, v|
+        self[k.to_sym] = v
+      end
+    end
+    
+    # Jump back up a level if you are using bang method
+    # chaining. For example:
+    #
+    # c = Hashie::Clash.new.foo('bar')
+    # c.baz!.foo(123) # => c[:baz]
+    # c.baz!._end! # => c
+    def _end!
+      self._parent
+    end
+    
+    def id(*args) #:nodoc:
+      method_missing(:id, *args)
+    end
+    
+    def merge_store(key, *args) #:nodoc:
+      case args.length
+        when 1
+          val = args.first
+          val = self[key].merge(val) if self[key].is_a?(::Hash) && val.is_a?(::Hash)
+        else
+          val = args
+      end
+
+      self[key.to_sym] = val
+      self
+    end
+    
+    def method_missing(name, *args) #:nodoc:
+      name = name.to_s
+      if name.match(/!$/) && args.empty?
+        key = name[0...-1].to_sym
+        
+        if self[key].nil?
+          self[key] = Clash.new({}, self)
+        elsif self[key].is_a?(::Hash) && !self[key].is_a?(Clash)
+          self[key] = Clash.new(self[key], self)
+        else
+          raise ChainError, "Tried to chain into a non-hash key."
+        end
+        
+        self[key]
+      elsif args.any?
+        key = name.to_sym
+        self.merge_store(key, *args)
+      end
+    end
+  end
+end