hstruct 0.5.0 → 0.6.0

data/CHANGELOG.md

@@ -1,6 +1,14 @@
+### v0.6.0
+
+* Support for hashes with string keys. We came across this problem when
+  persisting a hash with symbol keys and were getting back string keys.
+  Thanks @bestie!
+
+* removed `to_hash`
+
 ### v0.5.0
 
-* to_h deprecates to_hash method, should serve as a reminder about Ruby
+* `to_h` deprecates `to_hash` method, should serve as a reminder about Ruby
   2.0. Thanks @bestie!
 
 ### v0.4.0

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in hstruct.gemspec
 gemspec
+
+gem 'attr_extras'

data/README.md

@@ -1,4 +1,4 @@
-[![travis](https://secure.travis-ci.org/cambridge-healthcare/hstruct.png)]
+[![travis](https://secure.travis-ci.org/cambridge-healthcare/hstruct.png)](https://travis-ci.org/cambridge-healthcare/hstruct)
 
 Struct with the convenience of instantiating from a Hash.
 
@@ -10,14 +10,13 @@ a `to_h` method by default (no, you don't have to be running Ruby 2.0).
 
 ```ruby
 class ClassWithArgsHash
-  attr_reader :foo, :bar, :baz, :qux, :quux
+  attr_reader :foo, :bar, :baz, :qux
 
   def initialize(args)
     @foo  = args[:foo]
     @bar  = args[:bar]
     @baz  = args[:baz]
     @qux  = args[:qux]
-    @quux = args[:quux]
   end
 end
 
@@ -26,7 +25,7 @@ end
 And this is the HStruct equivalent:
 
 ```ruby
-MyHStruct = HStruct.new(:foo, :bar, :baz, :qux, :quux)
+MyHStruct = HStruct.new(:foo, :bar, :baz, :qux)
 ```
 
 If you're thinking about setting the class instance variables

data/benchmarks/hstruct.rb

@@ -49,6 +49,12 @@ hash = {
   :qux  => 4,
 }
 
+#require 'attr_extras'
+#class AttrExtrasClass
+  #attr_initialize [:foo, :bar, :baz, :qux]
+  #attr_reader :foo, :bar, :baz, :qux
+#end
+
 # All benchmarks were run on:
 # * ruby 1.9.3p392 (2013-02-22 revision 39386) [x86_64-darwin12.3.0]
 # * Intel i7 2.2Ghz (MBP 8,2)
@@ -81,6 +87,11 @@ Benchmark.ips(runs) do |x|
     }
   end
 
+  # 200k/s
+  #x.report('Class AttrExtras') do
+    #AttrExtrasClass.new(hash)
+  #end
+
   # 385k/s
   x.report('Class Hash Args') do
     HashArgsClass.new(hash)
@@ -104,4 +115,5 @@ end
 # FastOpenStruct => 30k/s
 # Hashie::Dash   => 35k/s
 # Hashie MI & MA => 100k/s
-
+# AttrExtras     => 200k/s
+#

data/hstruct.gemspec

@@ -4,9 +4,9 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "hstruct"
-  spec.version       = "0.5.0"
-  spec.authors       = ["Gerhard Lazu"]
-  spec.email         = ["gerhard@lazu.co.uk"]
+  spec.version       = "0.6.0"
+  spec.authors       = ["Gerhard Lazu", "Stephen Best"]
+  spec.email         = ["gerhard@lazu.co.uk", "bestie@gmail.com"]
   spec.description   = %q{Struct with the convenience of instantiating from a Hash}
   spec.summary       = %q{When you care about speed and convenience, this is what you've been looking for}
   spec.homepage      = "https://github.com/cambridge-healthcare/hstruct"

data/lib/hstruct.rb

@@ -1,10 +1,17 @@
 class HStruct < Struct
-  def initialize(args = nil)
-    super(*members.map { |m| args[m] }) if args
+  def initialize(args = {})
+    raise ArgumentError unless args.is_a?(Enumerable)
+
+    unless args.keys.first.is_a?(Symbol)
+      args = args.each_with_object({}) do |(k,v), result|
+        result[k.to_sym] = v
+      end
+    end
+
+    super(*members.map { |m| args[m] })
   end
 
   def to_h
     Hash[each_pair.to_a]
   end
-  alias_method :to_hash, :to_h
 end

data/test/lib/hstruct_test.rb

@@ -1,6 +1,7 @@
 require_relative '../test_helper'
 
 require 'hstruct'
+require 'pry'
 
 Person = HStruct.new(:first_name, :last_name)
 
@@ -13,25 +14,51 @@ describe "Person defined from an HStruct" do
     Person.new.must_be_instance_of Person
   end
 
+  it "argument must be enumerable" do
+    not_enumerable = Object.new
+
+    ->{ Person.new(not_enumerable) }.must_raise ArgumentError
+  end
+
   describe "instantiated from a hash" do
-    let(:person) { Person.new(:first_name => "Jimmy") }
+    describe "with Symbol keys" do
+      let(:person_hash) { {
+        :first_name => "Jimmy",
+      } }
+
+      let(:person) { Person.new(person_hash) }
 
-    it "first name" do
-      person.first_name.must_equal "Jimmy"
+      it "first name" do
+        person.first_name.must_equal "Jimmy"
+      end
+
+      it "last name" do
+        person.last_name.must_equal nil
+      end
     end
 
-    it "last name" do
-      person.last_name.must_equal nil
+    describe "with String keys" do
+      let(:person_hash) { {
+        "first_name" => "Alex",
+      } }
+
+      let(:person) { Person.new(person_hash) }
+
+      it "first name" do
+        person.first_name.must_equal "Alex"
+      end
+
+      it "last name" do
+        person.last_name.must_equal nil
+      end
     end
 
     describe "when converting back to a hash" do
+      let(:person) { Person.new( :first_name => "Jimmy" ) }
+
       it "includes empty values" do
         person.to_h.must_equal Hash[:first_name => "Jimmy", :last_name => nil]
       end
-
-      it "to_hash alias" do
-        person.to_h.must_equal person.to_hash
-      end
     end
   end
 end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: hstruct
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
 - Gerhard Lazu
+- Stephen Best
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-23 00:00:00.000000000 Z
+date: 2013-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -110,6 +111,7 @@ dependencies:
 description: Struct with the convenience of instantiating from a Hash
 email:
 - gerhard@lazu.co.uk
+- bestie@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -155,4 +157,3 @@ summary: When you care about speed and convenience, this is what you've been loo
 test_files:
 - test/lib/hstruct_test.rb
 - test/test_helper.rb
-has_rdoc: