hstruct 0.4.0 → 0.5.0

data/.travis.yml

@@ -0,0 +1 @@
+script: "bundle exec ruby test/test_helper.rb"

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### v0.5.0
+
+* to_h deprecates to_hash method, should serve as a reminder about Ruby
+  2.0. Thanks @bestie!
+
 ### v0.4.0
 
 * leaving empty values out when converting to a hash was too intrusive.

data/README.md

@@ -1,10 +1,12 @@
+[![travis](https://secure.travis-ci.org/cambridge-healthcare/hstruct.png)]
+
 Struct with the convenience of instantiating from a Hash.
 
 When you care about speed, this is the Ruby structure that you've been
 looking for. HStructs are faster than any other gem out there, but still
 only half as fast as when compared to a Class with hash arguments.
 To make up for it, you will end up writing less code and you will get
-a `to_hash` method by default (no, you don't have to be running Ruby 2.0).
+a `to_h` method by default (no, you don't have to be running Ruby 2.0).
 
 ```ruby
 class ClassWithArgsHash
@@ -69,7 +71,7 @@ end
 => 88
 [5] pry(main)> heart_rate.timestamp
 => 1368786389
-[6] pry(main)> heart_rate.to_hash
+[6] pry(main)> heart_rate.to_h
 => {:patient_id=>1, :bpm=>88, :timestamp=>1368786389}
 ```
 

data/benchmarks/hstruct.rb

@@ -5,27 +5,26 @@ require 'pry'
 require 'ostruct'
 
 # Struct
-PlainStruct = Struct.new(:foo, :bar, :baz, :qux, :quux)
+PlainStruct = Struct.new(:foo, :bar, :baz, :qux)
 
 # HStruct
 require_relative '../lib/hstruct'
-PlainHStruct = HStruct.new(:foo, :bar, :baz, :qux, :quux)
+PlainHStruct = HStruct.new(:foo, :bar, :baz, :qux)
 
 # Class
 class SimpleClass
-  attr_reader :foo, :bar, :baz, :qux, :quux
+  attr_reader :foo, :bar, :baz, :qux
 
-  def initialize(foo, bar, baz, qux, quux)
+  def initialize(foo, bar, baz, qux)
     @foo = foo
     @bar = bar
     @baz = baz
     @qux = qux
-    @quux = quux
   end
 end
 
 class CleverClass
-  attr_reader :foo, :bar, :baz, :qux, :quux
+  attr_reader :foo, :bar, :baz, :qux
 
   def initialize(args)
     args.each { |k, v| instance_variable_set("@#{k}", v) }
@@ -33,14 +32,13 @@ class CleverClass
 end
 
 class HashArgsClass
-  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
 
@@ -49,63 +47,61 @@ hash = {
   :bar  => 2,
   :baz  => 3,
   :qux  => 4,
-  :quux => 5,
 }
 
-# All commented benchmarks were run on:
+# 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)
 
 runs = ENV.fetch('RUNS', 5).to_i
 
 Benchmark.ips(runs) do |x|
-  # 10k/s
+  # 14k/s
   x.report('OpenStruct') do
     OpenStruct.new(hash)
   end
 
-  # 65k/s
+  # 80k/s
   x.report('Class Clever') do
     CleverClass.new(hash)
   end
 
-  # 170k/s
+  # 185k/s
   x.report('HStruct') do
     PlainHStruct.new(hash)
   end
 
-  # 325k/s
+  # 380k/s
   x.report('Hash') do
     hash = {
       :foo  => 1,
       :bar  => 2,
       :baz  => 3,
       :qux  => 4,
-      :quux => 5,
     }
   end
 
-  # 350k/s
+  # 385k/s
   x.report('Class Hash Args') do
     HashArgsClass.new(hash)
   end
 
-  # 450k/s
+  # 470k/s
   x.report('Class Plain') do
-    SimpleClass.new(1, 2, 3, 4, 5)
+    SimpleClass.new(1, 2, 3, 4)
   end
 
-  # 600k/s
+  # 620k/s
   x.report('Struct') do
-    PlainStruct.new(1, 2, 3, 4, 5)
+    PlainStruct.new(1, 2, 3, 4)
   end
 end
 
 ### This is how some of the more popular gems compare to the above:
 #
 # Virtus         => 12k/s (no coercions) & 17k/s (coercions)
-# Hashr          => 21k/s
+# Hashr          => 20k/s
 # FastOpenStruct => 30k/s
-# Hashie::Dash   => 34k/s
-# Hashie MI & MA => 98k/s
+# Hashie::Dash   => 35k/s
+# Hashie MI & MA => 100k/s
 

data/hstruct.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "hstruct"
-  spec.version       = "0.4.0"
+  spec.version       = "0.5.0"
   spec.authors       = ["Gerhard Lazu"]
   spec.email         = ["gerhard@lazu.co.uk"]
   spec.description   = %q{Struct with the convenience of instantiating from a Hash}
@@ -19,7 +19,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "benchmark-ips", "~> 1.2"
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest", "~> 4.7"
+  spec.add_development_dependency "minitest-reporters", "~> 0.14.19"
   spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
 end

data/lib/hstruct.rb

@@ -3,7 +3,8 @@ class HStruct < Struct
     super(*members.map { |m| args[m] }) if args
   end
 
-  def to_hash
+  def to_h
     Hash[each_pair.to_a]
   end
+  alias_method :to_hash, :to_h
 end

data/test/lib/{hstruct_spec.rb → hstruct_test.rb}

@@ -26,7 +26,11 @@ describe "Person defined from an HStruct" do
 
     describe "when converting back to a hash" do
       it "includes empty values" do
-        person.to_hash.must_equal Hash[:first_name => "Jimmy", :last_name => nil]
+        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

data/test/test_helper.rb

@@ -1,3 +1,7 @@
+#!/usr/bin/env ruby
+
 require 'minitest/autorun'
+require "minitest/reporters"
+MiniTest::Reporters.use! MiniTest::Reporters::SpecReporter.new
 
-Dir.glob('./test/**/*_spec.rb', &method(:require)) if __FILE__ == $0
+Dir.glob('./test/**/*_test.rb', &method(:require)) if __FILE__ == $0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hstruct
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-22 00:00:00.000000000 Z
+date: 2013-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -44,13 +44,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '4.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,15 +58,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '4.7'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 0.14.19
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +74,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 0.14.19
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +91,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
 description: Struct with the convenience of instantiating from a Hash
 email:
 - gerhard@lazu.co.uk
@@ -99,7 +115,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rspec
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -108,7 +124,7 @@ files:
 - benchmarks/hstruct.rb
 - hstruct.gemspec
 - lib/hstruct.rb
-- test/lib/hstruct_spec.rb
+- test/lib/hstruct_test.rb
 - test/test_helper.rb
 homepage: https://github.com/cambridge-healthcare/hstruct
 licenses:
@@ -137,6 +153,6 @@ specification_version: 3
 summary: When you care about speed and convenience, this is what you've been looking
   for
 test_files:
-- test/lib/hstruct_spec.rb
+- test/lib/hstruct_test.rb
 - test/test_helper.rb
 has_rdoc: 

data/.rspec

@@ -1,2 +0,0 @@
---color
---format doc