wahashie 1.2.0

data/lib/wahashie/hash.rb

@@ -0,0 +1,25 @@
+require 'wahashie/hash_extensions'
+
+module Wahashie
+  # A Wahashie Hash is simply a Hash that has convenience
+  # functions baked in such as stringify_keys that may
+  # not be available in all libraries.
+  class Hash < Hash
+    include Wahashie::HashExtensions
+
+    # Converts a mash back to a hash.
+    def to_hash(options = {})
+      out = {}
+      keys.each do |k|
+        key = options[:symbolize_keys] ? k.to_sym : k.to_s
+        out[key] = Wahashie::Hash === self[k] ? self[k].to_hash : self[k]
+      end
+      out
+    end
+
+    # The C geneartor for the json gem doesn't like mashies
+    def to_json(*args)
+      to_hash.to_json(*args)
+    end
+  end
+end

data/lib/wahashie/hash_extensions.rb

@@ -0,0 +1,49 @@
+module Wahashie
+  module HashExtensions
+    def self.included(base)
+      # Don't tread on existing extensions of Hash by
+      # adding methods that are likely to exist.
+      %w(stringify_keys stringify_keys!).each do |wahashie_method|
+        base.send :alias_method, wahashie_method, "wahashie_#{wahashie_method}" unless base.instance_methods.include?(wahashie_method)
+      end
+    end
+
+    # Destructively convert all of the keys of a Hash
+    # to their string representations.
+    def wahashie_stringify_keys!
+      self.keys.each do |k|
+        unless String === k
+          self[k.to_s] = self.delete(k)
+        end
+      end
+      self
+    end
+
+    # Convert all of the keys of a Hash
+    # to their string representations.
+    def wahashie_stringify_keys
+      self.dup.stringify_keys!
+    end
+
+    # Convert this hash into a Mash
+    def to_mash
+      ::Wahashie::Mash.new(self)
+    end
+  end
+
+  module PrettyInspect
+    def self.included(base)
+      base.send :alias_method, :hash_inspect, :inspect
+      base.send :alias_method, :inspect, :wahashie_inspect
+    end
+
+    def wahashie_inspect
+      ret = "#<#{self.class.to_s}"
+      stringify_keys.keys.sort.each do |key|
+        ret << " #{key}=#{self[key].inspect}"
+      end
+      ret << ">"
+      ret
+    end
+  end
+end

data/lib/wahashie/mash.rb

@@ -0,0 +1,197 @@
+require 'wahashie/hash'
+
+module Wahashie
+  # Mash allows you to create pseudo-objects that have method-like
+  # accessors for hash keys. This is useful for such implementations
+  # as an API-accessing library that wants to fake robust objects
+  # without the overhead of actually doing so. Think of it as OpenStruct
+  # with some additional goodies.
+  #
+  # A Mash will look at the methods you pass it and perform operations
+  # based on the following rules:
+  #
+  # * No punctuation: Returns the value of the hash for that key, or nil if none exists.
+  # * Assignment (<tt>=</tt>): Sets the attribute of the given method name.
+  # * Existence (<tt>?</tt>): Returns true or false depending on whether that key has been set.
+  # * Bang (<tt>!</tt>): Forces the existence of this key, used for deep Mashes. Think of it as "touch" for mashes.
+  #
+  # == Basic Example
+  #
+  #   mash = Mash.new
+  #   mash.name? # => false
+  #   mash.name = "Bob"
+  #   mash.name # => "Bob"
+  #   mash.name? # => true
+  #
+  # == Hash Conversion  Example
+  #
+  #   hash = {:a => {:b => 23, :d => {:e => "abc"}}, :f => [{:g => 44, :h => 29}, 12]}
+  #   mash = Mash.new(hash)
+  #   mash.a.b # => 23
+  #   mash.a.d.e # => "abc"
+  #   mash.f.first.g # => 44
+  #   mash.f.last # => 12
+  #
+  # == Bang Example
+  #
+  #   mash = Mash.new
+  #   mash.author # => nil
+  #   mash.author! # => <Mash>
+  #
+  #   mash = Mash.new
+  #   mash.author!.name = "Michael Bleigh"
+  #   mash.author # => <Mash name="Michael Bleigh">
+  #
+  class Mash < Wahashie::Hash
+    include Wahashie::PrettyInspect
+    alias_method :to_s, :inspect
+
+    # If you pass in an existing hash, it will
+    # convert it to a Mash including recursively
+    # descending into arrays and hashes, converting
+    # them as well.
+    def initialize(source_hash = nil, default = nil, &blk)
+      deep_update(source_hash) if source_hash
+      default ? super(default) : super(&blk)
+    end
+
+    class << self
+      alias [] new
+
+      def subkey_class
+        self
+      end
+    end
+
+    def id #:nodoc:
+      key?("id") ? self["id"] : super
+    end
+
+    def type #:nodoc:
+      key?("type") ? self["type"] : super
+    end
+
+    alias_method :regular_reader, :[]
+    alias_method :regular_writer, :[]=
+
+    # Retrieves an attribute set in the Mash. Will convert
+    # any key passed in to a string before retrieving.
+    def [](key)
+      value = regular_reader(convert_key(key))
+      yield value if block_given?
+      value
+    end
+
+    # Sets an attribute in the Mash. Key will be converted to
+    # a string before it is set, and Hashes will be converted
+    # into Mashes for nesting purposes.
+    def []=(key,value) #:nodoc:
+      regular_writer(convert_key(key), convert_value(value))
+    end
+
+    # This is the bang method reader, it will return a new Mash
+    # if there isn't a value already assigned to the key requested.
+    def initializing_reader(key)
+      ck = convert_key(key)
+      regular_writer(ck, self.class.new) unless key?(ck)
+      regular_reader(ck)
+    end
+
+    def delete(key)
+      super(convert_key(key))
+    end
+
+    alias_method :regular_dup, :dup
+    # Duplicates the current mash as a new mash.
+    def dup
+      self.class.new(self, self.default)
+    end
+
+    def key?(key)
+      super(convert_key(key))
+    end
+    alias_method :has_key?, :key?
+    alias_method :include?, :key?
+    alias_method :member?, :key?
+
+    # Performs a deep_update on a duplicate of the
+    # current mash.
+    def deep_merge(other_hash)
+      dup.deep_update(other_hash)
+    end
+    alias_method :merge, :deep_merge
+
+    # Recursively merges this mash with the passed
+    # in hash, merging each hash in the hierarchy.
+    def deep_update(other_hash)
+      other_hash.each_pair do |k,v|
+        key = convert_key(k)
+        if regular_reader(key).is_a?(Mash) and v.is_a?(::Hash)
+          regular_reader(key).deep_update(v)
+        else
+          regular_writer(key, convert_value(v, true))
+        end
+      end
+      self
+    end
+    alias_method :deep_merge!, :deep_update
+    alias_method :update, :deep_update
+    alias_method :merge!, :update
+
+    # Performs a shallow_update on a duplicate of the current mash
+    def shallow_merge(other_hash)
+      dup.shallow_update(other_hash)
+    end
+
+    # Merges (non-recursively) the hash from the argument,
+    # changing the receiving hash
+    def shallow_update(other_hash)
+      other_hash.each_pair do |k,v|
+        regular_writer(convert_key(k), convert_value(v, true))
+      end
+      self
+    end
+
+   # Will return true if the Mash has had a key
+   # set in addition to normal respond_to? functionality.
+   def respond_to?(method_name, include_private=false)
+     return true if key?(method_name)
+     super
+   end
+
+   def method_missing(method_name, *args, &blk)
+     return self.[](method_name, &blk) if key?(method_name)
+     match = method_name.to_s.match(/(.*?)([?=!]?)$/)
+     case match[2]
+     when "="
+       self[match[1]] = args.first
+     when "?"
+       !!self[match[1]]
+     when "!"
+       initializing_reader(match[1])
+     else
+       default(method_name, *args, &blk)
+     end
+   end
+
+    protected
+
+    def convert_key(key) #:nodoc:
+      key.to_s
+    end
+
+    def convert_value(val, duping=false) #:nodoc:
+      case val
+        when self.class
+          val.dup
+        when ::Hash
+          val = val.dup if duping
+          self.class.subkey_class.new.merge(val)
+        when Array
+          val.collect{ |e| convert_value(e) }
+        else
+          val
+      end
+    end
+  end
+end

data/lib/wahashie/trash.rb

@@ -0,0 +1,55 @@
+require 'wahashie/dash'
+
+module Wahashie
+  # A Trash is a 'translated' Dash where the keys can be remapped from a source
+  # hash.
+  #
+  # Trashes are useful when you need to read data from another application,
+  # such as a Java api, where the keys are named differently from how we would
+  # in Ruby.
+  class Trash < Wahashie::Dash
+
+    # Defines a property on the Trash. Options are as follows:
+    #
+    # * <tt>:default</tt> - Specify a default value for this property, to be
+    # returned before a value is set on the property in a new Dash.
+    # * <tt>:from</tt> - Specify the original key name that will be write only.
+    def self.property(property_name, options = {})
+      super
+
+      if options[:from]
+        translations << options[:from].to_sym
+        class_eval <<-RUBY
+          def #{options[:from]}=(val)
+            self[:#{property_name}] = val
+          end
+        RUBY
+      end
+    end
+
+    # Set a value on the Dash in a Hash-like way. Only works
+    # on pre-existing properties.
+    def []=(property, value)
+      if self.class.translations.include? property.to_sym
+        send("#{property}=", value)
+      elsif property_exists? property
+        super
+      end
+    end
+
+    private
+
+    def self.translations
+      @translations ||= []
+    end
+
+    # Raises an NoMethodError if the property doesn't exist
+    #
+    def property_exists?(property)
+      unless self.class.property?(property.to_sym)
+        raise NoMethodError, "The property '#{property}' is not defined for this Trash."
+      end
+      true
+    end
+  end
+end

data/lib/wahashie/version.rb

@@ -0,0 +1,3 @@
+module Wahashie
+  VERSION = '1.2.0'
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--colour
+--format progress
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'wahashie'
+require 'rspec'
+require 'rspec/autorun'
+
+RSpec.configure do |config|
+
+end

data/spec/wahashie/clash_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Wahashie::Clash do
+  before do
+    @c = Wahashie::Clash.new
+  end
+  
+  it 'should be able to set an attribute via method_missing' do
+    @c.foo('bar')
+    @c[:foo].should == 'bar'
+  end
+  
+  it 'should be able to set multiple attributes' do
+    @c.foo('bar').baz('wok')
+    @c.should == {:foo => 'bar', :baz => 'wok'}
+  end
+  
+  it 'should convert multiple arguments into an array' do
+    @c.foo(1, 2, 3)
+    @c[:foo].should == [1,2,3]
+  end
+  
+  it 'should be able to use bang notation to create a new Clash on a key' do
+    @c.foo!
+    @c[:foo].should be_kind_of(Wahashie::Clash)
+  end
+  
+  it 'should be able to chain onto the new Clash when using bang notation' do
+    @c.foo!.bar('abc').baz(123)
+    @c.should == {:foo => {:bar => 'abc', :baz => 123}}
+  end
+  
+  it 'should be able to jump back up to the parent in the chain with #_end!' do
+    @c.foo!.bar('abc')._end!.baz(123)
+    @c.should == {:foo => {:bar => 'abc'}, :baz => 123}
+  end
+  
+  it 'should merge rather than replace existing keys' do
+    @c.where(:abc => 'def').where(:hgi => 123)
+    @c.should == {:where => {:abc => 'def', :hgi => 123}}
+  end
+end

data/spec/wahashie/dash_spec.rb

@@ -0,0 +1,215 @@
+require 'spec_helper'
+
+Wahashie::Hash.class_eval do
+  def self.inherited(klass)
+    klass.instance_variable_set('@inheritance_test', true)
+  end
+end
+
+class DashTest < Wahashie::Dash
+  property :first_name, :required => true
+  property :email
+  property :count, :default => 0
+end
+
+class DashNoRequiredTest < Wahashie::Dash
+  property :first_name
+  property :email
+  property :count, :default => 0
+end
+
+class Subclassed < DashTest
+  property :last_name, :required => true
+end
+
+describe DashTest do
+
+  subject { DashTest.new(:first_name => 'Bob', :email => 'bob@example.com') }
+
+  it('subclasses Wahashie::Hash') { should respond_to(:to_mash) }
+
+  its(:to_s) { should == '#<DashTest count=0 email="bob@example.com" first_name="Bob">' }
+
+  it 'lists all set properties in inspect' do
+    subject.first_name = 'Bob'
+    subject.email = 'bob@example.com'
+    subject.inspect.should == '#<DashTest count=0 email="bob@example.com" first_name="Bob">'
+  end
+
+  its(:count) { should be_zero }
+
+  it { should respond_to(:first_name) }
+  it { should respond_to(:first_name=) }
+  it { should_not respond_to(:nonexistent) }
+
+  it 'errors out for a non-existent property' do
+    lambda { subject['nonexistent'] }.should raise_error(NoMethodError)
+  end
+
+  it 'errors out when attempting to set a required property to nil' do
+    lambda { subject.first_name = nil }.should raise_error(ArgumentError)
+  end
+
+  context 'writing to properties' do
+
+    it 'fails writing a required property to nil' do
+      lambda { subject.first_name = nil }.should raise_error(ArgumentError)
+    end
+
+    it 'fails writing a required property to nil using []=' do
+      lambda { subject['first_name'] = nil }.should raise_error(ArgumentError)
+    end
+
+    it 'fails writing to a non-existent property using []=' do
+      lambda { subject['nonexistent'] = 123 }.should raise_error(NoMethodError)
+    end
+
+    it 'works for an existing property using []=' do
+      subject['first_name'] = 'Bob'
+      subject['first_name'].should == 'Bob'
+      subject[:first_name].should == 'Bob'
+    end
+
+    it 'works for an existing property using a method call' do
+      subject.first_name = 'Franklin'
+      subject.first_name.should == 'Franklin'
+    end
+  end
+
+  context 'reading from properties' do
+    it 'fails reading from a non-existent property using []' do
+      lambda { subject['nonexistent'] }.should raise_error(NoMethodError)
+    end
+
+    it "should be able to retrieve properties through blocks" do
+      subject["first_name"] = "Aiden"
+      value = nil
+      subject.[]("first_name") { |v| value = v }
+      value.should == "Aiden"
+    end
+
+    it "should be able to retrieve properties through blocks with method calls" do
+      subject["first_name"] = "Frodo"
+      value = nil
+      subject.first_name { |v| value = v }
+      value.should == "Frodo"
+    end
+  end
+
+  describe '.new' do
+    it 'fails with non-existent properties' do
+      lambda { described_class.new(:bork => '') }.should raise_error(NoMethodError)
+    end
+
+    it 'should set properties that it is able to' do
+      obj = described_class.new :first_name => 'Michael'
+      obj.first_name.should == 'Michael'
+    end
+
+    it 'accepts nil' do
+      lambda { DashNoRequiredTest.new(nil) }.should_not raise_error
+    end
+
+    it 'accepts block to define a global default' do
+      obj = described_class.new { |hash, key| key.to_s.upcase }
+      obj.first_name.should == 'FIRST_NAME'
+      obj.count.should be_zero
+    end
+
+    it "fails when required values are missing" do
+      expect { DashTest.new }.to raise_error(ArgumentError)
+    end
+
+  end
+
+  describe 'properties' do
+    it 'lists defined properties' do
+      described_class.properties.should == Set.new([:first_name, :email, :count])
+    end
+
+    it 'checks if a property exists' do
+      described_class.property?('first_name').should be_true
+      described_class.property?(:first_name).should be_true
+    end
+
+    it 'checks if a property is required' do
+      described_class.required?('first_name').should be_true
+      described_class.required?(:first_name).should be_true
+    end
+
+    it 'doesnt include property from subclass' do
+      described_class.property?(:last_name).should be_false
+    end
+
+    it 'lists declared defaults' do
+      described_class.defaults.should == { :count => 0 }
+    end
+  end
+end
+
+describe Wahashie::Dash, 'inheritance' do
+  before do
+    @top = Class.new(Wahashie::Dash)
+    @middle = Class.new(@top)
+    @bottom = Class.new(@middle)
+  end
+
+  it 'reports empty properties when nothing defined' do
+    @top.properties.should be_empty
+    @top.defaults.should be_empty
+  end
+
+  it 'inherits properties downwards' do
+    @top.property :echo
+    @middle.properties.should include(:echo)
+    @bottom.properties.should include(:echo)
+  end
+
+  it 'doesnt inherit properties upwards' do
+    @middle.property :echo
+    @top.properties.should_not include(:echo)
+    @bottom.properties.should include(:echo)
+  end
+
+  it 'allows overriding a default on an existing property' do
+    @top.property :echo
+    @middle.property :echo, :default => 123
+    @bottom.properties.to_a.should == [:echo]
+    @bottom.new.echo.should == 123
+  end
+
+  it 'allows clearing an existing default' do
+    @top.property :echo
+    @middle.property :echo, :default => 123
+    @bottom.property :echo
+    @bottom.properties.to_a.should == [:echo]
+    @bottom.new.echo.should be_nil
+  end
+
+  it 'should allow nil defaults' do
+    @bottom.property :echo, :default => nil
+    @bottom.new.should have_key('echo')
+  end
+
+end
+
+describe Subclassed do
+
+  subject { Subclassed.new(:first_name => 'Bob', :last_name => 'McNob', :email => 'bob@example.com') }
+
+  its(:count) { should be_zero }
+
+  it { should respond_to(:first_name) }
+  it { should respond_to(:first_name=) }
+  it { should respond_to(:last_name) }
+  it { should respond_to(:last_name=) }
+
+  it 'has one additional property' do
+    described_class.property?(:last_name).should be_true
+  end
+
+  it "didn't override superclass inheritance logic" do
+    described_class.instance_variable_get('@inheritance_test').should be_true
+  end
+
+end