hashie 0.2.2 → 0.3.0

data/README.rdoc

@@ -30,6 +30,10 @@ to JSON and XML parsed hashes.
     # use bang methods for multi-level assignment
     mash.author!.name = "Michael Bleigh"
     mash.author # => <Hashie::Mash name="Michael Bleigh">
+
+<b>Note:</b> The <tt>?</tt> 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
+<tt>mash.key?('some_key')</tt> method instead.
   
 == Dash
 
@@ -57,6 +61,20 @@ can set defaults for each property.
     p.name       # => 'Bob'
     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')
+    
 == Clash
 
 Clash is a Chainable Lazy Hash that allows you to easily construct

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.0

data/hashie.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hashie}
-  s.version = "0.2.2"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Bleigh"]
-  s.date = %q{2010-07-28}
+  s.date = %q{2010-08-10}
   s.description = %q{Hashie is a small collection of tools that make hashes more powerful. Currently includes Mash (Mocking Hash) and Dash (Discrete Hash).}
   s.email = %q{michael@intridea.com}
   s.extra_rdoc_files = [
@@ -32,10 +32,12 @@ Gem::Specification.new do |s|
      "lib/hashie/hash.rb",
      "lib/hashie/hash_extensions.rb",
      "lib/hashie/mash.rb",
+     "lib/hashie/trash.rb",
      "spec/hashie/clash_spec.rb",
      "spec/hashie/dash_spec.rb",
      "spec/hashie/hash_spec.rb",
      "spec/hashie/mash_spec.rb",
+     "spec/hashie/trash_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
   ]
@@ -49,6 +51,7 @@ Gem::Specification.new do |s|
      "spec/hashie/dash_spec.rb",
      "spec/hashie/hash_spec.rb",
      "spec/hashie/mash_spec.rb",
+     "spec/hashie/trash_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/lib/hashie.rb

@@ -2,4 +2,8 @@ require 'hashie/hash_extensions'
 require 'hashie/hash'
 require 'hashie/mash'
 require 'hashie/dash'
-require 'hashie/clash'
+require 'hashie/clash'
+
+module Hashie
+  autoload :Trash, 'hashie/trash'
+end

data/lib/hashie/dash.rb

@@ -44,7 +44,7 @@ module Hashie
     # properties on this Dash.
     def self.properties
       properties = []
-      ancestors.each do |elder| 
+      ancestors.each do |elder|
         if elder.instance_variable_defined?("@properties")
           properties << elder.instance_variable_get("@properties")
         end
@@ -67,7 +67,7 @@ module Hashie
           properties.merge! elder.instance_variable_get("@defaults")
         end
       end
-      
+
       properties
     end
 
@@ -80,7 +80,7 @@ module Hashie
 
       attributes.each_pair do |att, value|
         self.send("#{att}=", value)
-      end
+      end if attributes
     end
 
     # Retrieve a value from the Dash (will return the
@@ -94,8 +94,8 @@ module Hashie
     def []=(property, value)
       super if property_exists? property
     end
-    
-    private 
+
+    private
       # Raises an NoMethodError if the property doesn't exist
       #
       def property_exists?(property)

data/lib/hashie/mash.rb

@@ -125,7 +125,7 @@ module Hashie
      when "="
        self[match[1]] = args.first
      when "?"
-       key?(match[1])
+       !!self[match[1]]
      when "!"
        initializing_reader(match[1])
      else

data/lib/hashie/trash.rb

@@ -0,0 +1,55 @@
+require 'hashie/dash'
+
+module Hashie
+  # 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 < Hashie::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/spec/hashie/dash_spec.rb

@@ -14,68 +14,74 @@ describe Hashie::Dash do
   it 'should be a subclass of Hashie::Hash' do
     (Hashie::Dash < Hash).should be_true
   end
-  
+
   it '#inspect should be ok!' do
     dash = DashTest.new
     dash.email = "abd@abc.com"
     dash.inspect.should == "<#DashTest count=0 email=\"abd@abc.com\" first_name=nil>"
   end
-   
+
   describe ' creating properties' do
     it 'should add the property to the list' do
       DashTest.property :not_an_att
       DashTest.properties.include?('not_an_att').should be_true
     end
-    
+
     it 'should create a method for reading the property' do
       DashTest.new.respond_to?(:first_name).should be_true
     end
-    
+
     it 'should create a method for writing the property' do
       DashTest.new.respond_to?(:first_name=).should be_true
     end
   end
-  
+
   describe 'reading properties' do
-    it 'should raise an error when reading a non-existent property' do 
+    it 'should raise an error when reading a non-existent property' do
       lambda{@dash['abc']}.should raise_error(NoMethodError)
     end
   end
-  
+
   describe ' writing to properties' do
     before do
       @dash = DashTest.new
     end
-    
+
     it 'should not be able to write to a non-existent property using []=' do
       lambda{@dash['abc'] = 123}.should raise_error(NoMethodError)
     end
-    
+
     it 'should be able to write to an existing property using []=' do
       lambda{@dash['first_name'] = 'Bob'}.should_not raise_error
     end
-    
+
     it 'should be able to read/write to an existing property using a method call' do
       @dash.first_name = 'Franklin'
       @dash.first_name.should == 'Franklin'
     end
   end
-  
+
   describe ' initializing with a Hash' do
     it 'should not be able to initialize non-existent properties' do
       lambda{DashTest.new(:bork => 'abc')}.should raise_error(NoMethodError)
     end
-    
+
     it 'should set properties that it is able to' do
       DashTest.new(:first_name => 'Michael').first_name.should == 'Michael'
     end
   end
-  
+
+  describe 'initializing with a nil' do
+    it 'accepts nil' do
+      lambda { DashTest.new(nil) }.should_not raise_error
+    end
+  end
+
   describe ' defaults' do
     before do
       @dash = DashTest.new
     end
-    
+
     it 'should return the default value for defaulted' do
       DashTest.property :defaulted, :default => 'abc'
       DashTest.new.defaulted.should == 'abc'
@@ -87,17 +93,17 @@ describe Subclassed do
   it "should inherit all properties from DashTest" do
     Subclassed.properties.size.should == 6
   end
-  
+
   it "should inherit all defaults from DashTest" do
     Subclassed.defaults.size.should == 6
   end
-  
+
   it "should init without raising" do
     lambda { Subclassed.new }.should_not raise_error
     lambda { Subclassed.new(:first_name => 'Michael') }.should_not raise_error
   end
-  
+
   it "should share defaults from DashTest" do
     Subclassed.new.count.should == 0
   end
-end
+end

data/spec/hashie/mash_spec.rb

@@ -24,6 +24,13 @@ describe Hashie::Mash do
     @mash.test = "abc"
     @mash.test?.should be_true
   end
+  
+  it "should return false on a ? method if a value has been set to nil or false" do
+    @mash.test = nil
+    @mash.should_not be_test
+    @mash.test = false
+    @mash.should_not be_test
+  end
 
   it "should make all [] and []= into strings for consistency" do
     @mash["abc"] = 123

data/spec/hashie/trash_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Hashie::Trash do
+  class TrashTest < Hashie::Trash
+    property :first_name, :from => :firstName
+  end
+
+  let(:trash) { TrashTest.new }
+
+  describe 'translating properties' do
+    it 'adds the property to the list' do
+      TrashTest.property :not_an_att, :from => :notAnAtt
+      TrashTest.properties.should include('not_an_att')
+    end
+
+    it 'creates a method for reading the property' do
+      trash.should respond_to(:first_name)
+    end
+
+    it 'creates a method for writing the property' do
+      trash.should respond_to(:first_name=)
+    end
+
+    it 'creates a method for writing the translated property' do
+      trash.should respond_to(:firstName=)
+    end
+
+    it 'does not create a method for reading the translated property' do
+      trash.should_not respond_to(:firstName)
+    end
+  end
+
+  describe 'writing to properties' do
+
+    it 'does not write to a non-existent property using []=' do
+      lambda{trash['abc'] = 123}.should raise_error(NoMethodError)
+    end
+
+    it 'writes to an existing property using []=' do
+      lambda{trash['first_name'] = 'Bob'}.should_not raise_error
+    end
+
+    it 'writes to a translated property using []=' do
+      lambda{trash['firstName'] = 'Bob'}.should_not raise_error
+    end
+
+    it 'reads/writes to an existing property using a method call' do
+      trash.first_name = 'Franklin'
+      trash.first_name.should == 'Franklin'
+    end
+
+    it 'writes to an translated property using a method call' do
+      trash.firstName = 'Franklin'
+      trash.first_name.should == 'Franklin'
+    end
+  end
+
+  describe ' initializing with a Hash' do
+    it 'does not initialize non-existent properties' do
+      lambda{TrashTest.new(:bork => 'abc')}.should raise_error(NoMethodError)
+    end
+
+    it 'sets the desired properties' do
+      TrashTest.new(:first_name => 'Michael').first_name.should == 'Michael'
+    end
+
+    it 'sets the translated properties' do
+      TrashTest.new(:firstName => 'Michael').first_name.should == 'Michael'
+    end
+  end
+end

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 2
-  version: 0.2.2
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Michael Bleigh
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-28 00:00:00 -05:00
+date: 2010-08-10 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -57,10 +57,12 @@ files:
 - lib/hashie/hash.rb
 - lib/hashie/hash_extensions.rb
 - lib/hashie/mash.rb
+- lib/hashie/trash.rb
 - spec/hashie/clash_spec.rb
 - spec/hashie/dash_spec.rb
 - spec/hashie/hash_spec.rb
 - spec/hashie/mash_spec.rb
+- spec/hashie/trash_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
@@ -102,4 +104,5 @@ test_files:
 - spec/hashie/dash_spec.rb
 - spec/hashie/hash_spec.rb
 - spec/hashie/mash_spec.rb
+- spec/hashie/trash_spec.rb
 - spec/spec_helper.rb