hstruct 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hstruct.gemspec
+gemspec

data/Guardfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Gerhard Lazu
+
+MIT License
+
+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.md

@@ -0,0 +1,82 @@
+Ruby 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).
+
+```ruby
+class ClassWithArgsHash
+  attr_reader :foo, :bar, :baz, :qux, :quux
+
+  def initialize(args)
+    @foo  = args[:foo]
+    @bar  = args[:bar]
+    @baz  = args[:baz]
+    @qux  = args[:qux]
+    @quux = args[:quux]
+  end
+end
+
+```
+
+And this is the HStruct equivalent:
+
+```ruby
+MyHStruct = HStruct.new(:foo, :bar, :baz, :qux, :quux)
+```
+
+If you're thinking about setting the class instance variables
+dynamically, the performance penalty might surprise you (run the
+benchmarks to see what I mean).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hstruct'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hstruct
+
+## Usage
+
+This is a surprisingly simple gem, just a few lines of code. Usage is
+equally simple and straightforward. Here's an HStruct example with a
+default value:
+
+```ruby
+HeartRate = HStruct.new(:patient_id, :bpm, :timestamp) do
+  def initialize(args)
+    super(args)
+    self[:timestamp] ||= Time.now.utc.to_i
+  end
+end
+
+[1] pry(main)> heart_rate = HeartRate.new(:patient_id => 1, :bpm => 88)
+=> #<struct HeartRate patient_id=1, bpm=88, timestamp=1368786389>
+[2] pry(main)> heart_rate.class
+=> HeartRate
+[3] pry(main)> heart_rate.patient_id
+=> 1
+[4] pry(main)> heart_rate.bpm
+=> 88
+[5] pry(main)> heart_rate.timestamp
+=> 1368786389
+[6] pry(main)> heart_rate.to_hash
+=> {:patient_id=>1, :bpm=>88, :timestamp=>1368786389}
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/benchmarks/hstruct.rb

@@ -0,0 +1,111 @@
+require 'benchmark/ips'
+require 'pry'
+
+# OpenStruct
+require 'ostruct'
+
+# Struct
+PlainStruct = Struct.new(:foo, :bar, :baz, :qux, :quux)
+
+# HStruct
+require_relative '../lib/hstruct'
+PlainHStruct = HStruct.new(:foo, :bar, :baz, :qux, :quux)
+
+# Class
+class SimpleClass
+  attr_reader :foo, :bar, :baz, :qux, :quux
+
+  def initialize(foo, bar, baz, qux, quux)
+    @foo = foo
+    @bar = bar
+    @baz = baz
+    @qux = qux
+    @quux = quux
+  end
+end
+
+class CleverClass
+  attr_reader :foo, :bar, :baz, :qux, :quux
+
+  def initialize(args)
+    args.each { |k, v| instance_variable_set("@#{k}", v) }
+  end
+end
+
+class HashArgsClass
+  attr_reader :foo, :bar, :baz, :qux, :quux
+
+  def initialize(args)
+    @foo  = args[:foo]
+    @bar  = args[:bar]
+    @baz  = args[:baz]
+    @qux  = args[:qux]
+    @quux = args[:quux]
+  end
+end
+
+hash = {
+  :foo  => 1,
+  :bar  => 2,
+  :baz  => 3,
+  :qux  => 4,
+  :quux => 5,
+}
+
+# All commented 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
+  x.report('OpenStruct') do
+    OpenStruct.new(hash)
+  end
+
+  # 65k/s
+  x.report('Class Clever') do
+    CleverClass.new(hash)
+  end
+
+  # 170k/s
+  x.report('HStruct') do
+    PlainHStruct.new(hash)
+  end
+
+  # 325k/s
+  x.report('Hash') do
+    hash = {
+      :foo  => 1,
+      :bar  => 2,
+      :baz  => 3,
+      :qux  => 4,
+      :quux => 5,
+    }
+  end
+
+  # 350k/s
+  x.report('Class Hash Args') do
+    HashArgsClass.new(hash)
+  end
+
+  # 450k/s
+  x.report('Class Plain') do
+    SimpleClass.new(1, 2, 3, 4, 5)
+  end
+
+  # 600k/s
+  x.report('Struct') do
+    PlainStruct.new(1, 2, 3, 4, 5)
+  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
+# FastOpenStruct => 30k/s
+# Hashie::Dash   => 34k/s
+# Hashie MI & MA => 98k/s
+

data/hstruct.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "hstruct"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Gerhard Lazu"]
+  spec.email         = ["gerhard@lazu.co.uk"]
+  spec.description   = %q{Ruby Struct with the convenience of instantiating from a hash.}
+  spec.summary       = %q{When you care about speed, this is the Ruby structure that you've been looking for.}
+  spec.homepage      = "https://github.com/cambridge-healthcare/hstruct"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "benchmark-ips"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/lib/hstruct.rb

@@ -0,0 +1,9 @@
+class HStruct < Struct
+  def initialize(args)
+    super(*members.map { |m| args[m] })
+  end
+
+  def to_hash
+    Hash[each_pair.to_a]
+  end
+end

data/spec/lib/hstruct_spec.rb

@@ -0,0 +1,26 @@
+require_relative '../spec_helper'
+
+require 'hstruct'
+
+Person = HStruct.new(:first_name, :last_name)
+
+describe HStruct do
+  let(:person) {  }
+
+  it "is a Struct" do
+    Person.ancestors.should include Struct
+  end
+
+  it "can be instantiated from hash" do
+    person = Person.new(:first_name => "Jimmy")
+    person.first_name.should eql "Jimmy"
+    person.last_name.should be_nil
+  end
+
+  it "can be converted back to a hash" do
+    person = Person.new(:first_name => "Jimmy")
+    person.last_name = "Kiel"
+    person.to_hash.should eql Hash[:first_name => "Jimmy", :last_name => "Kiel"]
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: hstruct
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Gerhard Lazu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby Struct with the convenience of instantiating from a hash.
+email:
+- gerhard@lazu.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmarks/hstruct.rb
+- hstruct.gemspec
+- lib/hstruct.rb
+- spec/lib/hstruct_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/cambridge-healthcare/hstruct
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: When you care about speed, this is the Ruby structure that you've been looking
+  for.
+test_files:
+- spec/lib/hstruct_spec.rb
+- spec/spec_helper.rb
+has_rdoc: