hashie-pre 2.0.0.beta

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,8 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+*.gem
+.bundle
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format=nested

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - rbx
+  - ree
+  - ruby-head
+  - jruby

data/.yardopts

@@ -0,0 +1 @@
+-m markdown

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    hashie-pre (2.0.0.beta)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    growl (1.0.3)
+    guard (0.5.1)
+      thor (~> 0.14.6)
+    guard-rspec (0.4.0)
+      guard (>= 0.4.0)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    thor (0.14.6)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  growl
+  guard
+  guard-rspec
+  hashie-pre!
+  rake (~> 0.9.2)
+  rspec (~> 2.5)

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Intridea, Inc.
+
+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.markdown

@@ -0,0 +1,232 @@
+**Note:** This documentation is for the unreleased version 2.0 of
+Hashie. See the [1-1-stable branch](https://github.com/intridea/hashie/tree/1-1-stable) for documentation of the released version.
+
+# Hashie [![Build Status](https://secure.travis-ci.org/intridea/hashie.png)](http://travis-ci.org/intridea/hashie) [![Dependency Status](https://gemnasium.com/intridea/hashie.png)](https://gemnasium.com/intridea/hashie)
+
+Hashie is a growing collection of tools that extend Hashes and make
+them more useful.
+
+## Installation
+
+Hashie is available as a RubyGem:
+
+    gem install hashie
+
+## Hash Extensions
+
+New to version 2.0 of Hashie, the library has been broken up into a
+number of atomically includeable Hash extension modules as described
+below. This provides maximum flexibility for users to mix and match
+functionality while maintaining feature parity with earlier versions of
+Hashie.
+
+Any of the extensions listed below can be mixed into a class by
+`include`-ing `Hashie::Extensions::ExtensionName`.
+
+### Coercion
+
+Coercions allow you to set up "coercion rules" based either on the key
+or the value type to massage data as it's being inserted into the Hash.
+Key coercions might be used, for example, in lightweight data modeling
+applications such as an API client:
+
+    class Tweet < Hash
+      include Hashie::Extensions::Coercion
+      coerce_key :user, User
+    end
+    
+    user_hash = {:name => "Bob"}
+    Tweet.new(:user => user_hash)
+    # => automatically calls User.coerce(user_hash) or
+    #    User.new(user_hash) if that isn't present.
+
+Value coercions, on the other hand, will coerce values based on the type
+of the value being inserted. This is useful if you are trying to build a
+Hash-like class that is self-propagating.
+
+    class SpecialHash < Hash
+      include Hashie::Extensions::Coercion
+      coerce_value Hash, SpecialHash
+      
+      def initialize(hash = {})
+        super
+        hash.each_pair do |k,v|
+          self[k] = v
+        end
+      end
+    end
+
+### KeyConversion
+
+The KeyConversion extension gives you the convenience methods of
+`symbolize_keys` and `stringify_keys` along with their bang
+counterparts. You can also include just stringify or just symbolize with
+`Hashie::Extensions::StringifyKeys` or `Hashie::Extensions::SymbolizeKeys`.
+
+### MergeInitializer
+
+The MergeInitializer extension simply makes it possible to initialize a
+Hash subclass with another Hash, giving you a quick short-hand.
+
+### MethodAccess
+
+The MethodAccess extension allows you to quickly build method-based
+reading, writing, and querying into your Hash descendant. It can also be
+included as individual modules, i.e. `Hashie::Extensions::MethodReader`,
+`Hashie::Extensions::MethodWriter` and `Hashie::Extensions::MethodQuery`
+
+    class MyHash < Hash
+      include Hashie::Extensions::MethodAccess
+    end
+    
+    h = MyHash.new
+    h.abc = 'def'
+    h.abc  # => 'def'
+    h.abc? # => true
+
+### IndifferentAccess
+
+This extension can be mixed in to instantly give you indifferent access
+to your Hash subclass. This works just like the params hash in Rails and
+other frameworks where whether you provide symbols or strings to access
+keys, you will get the same results.
+
+A unique feature of Hashie's IndifferentAccess mixin is that it will
+inject itself recursively into subhashes *without* reinitializing the
+hash in question. This means you can safely merge together indifferent
+and non-indifferent hashes arbitrarily deeply without worrying about
+whether you'll be able to `hash[:other][:another]` properly.
+
+### DeepMerge (Unimplemented)
+
+This extension *will* allow you to easily include a recursive merging
+system to any Hash descendant.
+
+## Mash
+
+Mash is an extended Hash that gives simple pseudo-object functionality
+that can be built from hashes and easily extended. It is designed to
+be used in RESTful API libraries to provide easy object-like access
+to JSON and XML parsed hashes.
+
+### Example:
+
+    mash = Hashie::Mash.new
+    mash.name? # => false
+    mash.name # => nil
+    mash.name = "My Mash"
+    mash.name # => "My Mash"
+    mash.name? # => true
+    mash.inspect # => <Hashie::Mash name="My Mash">
+
+    mash = Mash.new
+    # use bang methods for multi-level assignment
+    mash.author!.name = "Michael Bleigh"
+    mash.author # => <Hashie::Mash name="Michael Bleigh">
+
+    mash = Mash.new
+    # use under-bang methods for multi-level testing
+    mash.author_.name? # => false
+    mash.inspect # => <Hashie::Mash>
+
+**Note:** The `?` method will return false if a key has been set
+to false or nil. In order to check if a key has been set at all, use the
+`mash.key?('some_key')` method instead.
+
+## Dash
+
+Dash is an extended Hash that has a discrete set of defined properties
+and only those properties may be set on the hash. Additionally, you
+can set defaults for each property. You can also flag a property as
+required. Required properties will raise an execption if unset.
+
+### Example:
+
+    class Person < Hashie::Dash
+      property :name, :required => true
+      property :email
+      property :occupation, :default => 'Rubyist'
+    end
+
+    p = Person.new # => ArgumentError: The property 'name' is required for this Dash.
+
+    p = Person.new(:name => "Bob")
+    p.name # => 'Bob'
+    p.name = nil # => ArgumentError: The property 'name' is required for this Dash.
+    p.email = 'abc@def.com'
+    p.occupation   # => 'Rubyist'
+    p.email        # => 'abc@def.com'
+    p[:awesome]    # => NoMethodError
+    p[:occupation] # => 'Rubyist'
+
+## Trash
+
+A Trash is a Dash that allows you to translate keys on initialization.
+It is used like so:
+
+    class Person < Hashie::Trash
+      property :first_name, :from => :firstName
+    end
+
+This will automatically translate the <tt>firstName</tt> key to <tt>first_name</tt>
+when it is initialized using a hash such as through:
+
+    Person.new(:firstName => 'Bob')
+
+Trash also supports translations using lambda, this could be useful when dealing with
+external API's. You can use it in this way:
+
+    class Result < Hashie::Trash
+      property :id, :transform_with => lambda { |v| v.to_i }
+      property :created_at, :from => :creation_date, :with => lambda { |v| Time.parse(v) }
+    end
+
+this will produce the following
+
+    result = Result.new(:id => '123', :creation_date => '2012-03-30 17:23:28')
+    result.id.class         # => Fixnum
+    result.created_at.class # => Time
+
+## Clash
+
+Clash is a Chainable Lazy Hash that allows you to easily construct
+complex hashes using method notation chaining. This will allow you
+to use a more action-oriented approach to building options hashes.
+
+Essentially, a Clash is a generalized way to provide much of the same
+kind of "chainability" that libraries like Arel or Rails 2.x's named_scopes
+provide.
+
+### Example
+
+    c = Hashie::Clash.new
+    c.where(:abc => 'def').order(:created_at)
+    c # => {:where => {:abc => 'def}, :order => :created_at}
+
+    # You can also use bang notation to chain into sub-hashes,
+    # jumping back up the chain with _end!
+    c = Hashie::Clash.new
+    c.where!.abc('def').ghi(123)._end!.order(:created_at)
+    c # => {:where => {:abc => 'def', :ghi => 123}, :order => :created_at}
+
+    # Multiple hashes are merged automatically
+    c = Hashie::Clash.new
+    c.where(:abc => 'def').where(:hgi => 123)
+    c # => {:where => {:abc => 'def', :hgi => 123}}
+
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Authors
+
+* Michael Bleigh
+
+## Copyright
+
+Copyright (c) 2009-2011 Intridea, Inc. (http://intridea.com/). See LICENSE for details.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |spec|
+  # spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/hashie.gemspec

@@ -0,0 +1,22 @@
+require File.expand_path('../lib/hashie/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Michael Bleigh"]
+  gem.email         = ["michael@intridea.com"]
+  gem.description   = %q{Hashie is a small collection of tools that make hashes more powerful. Currently includes Mash (Mocking Hash) and Dash (Discrete Hash).}
+  gem.summary       = %q{Your friendly neighborhood hash toolkit.}
+  gem.homepage      = 'https://github.com/intridea/hashie'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "hashie-pre"
+  gem.require_paths = ['lib']
+  gem.version       = Hashie::VERSION
+
+  gem.add_development_dependency 'rake', '~> 0.9.2'
+  gem.add_development_dependency 'rspec', '~> 2.5'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'growl'
+end

data/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/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