super_struct 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f1671cda7646a760788b60b4e57f2c019d3a2c39
+  data.tar.gz: b5550c15630c199d189985a6e627918bc7ab2dc7
+SHA512:
+  metadata.gz: 5d817cb4f2f7d83894ebce53bdf7dd166de9e6bb59e4e9b87bb5b5631aa286ae62fd565bc53e1ac5eacdef595ed98f4637c5b8f7a2d1fd649b1aa3f5ba5760da
+  data.tar.gz: 667da4f7025e13ba9837a09a6ad7d6f7dfe257aac49181458d5f7c4faa6d0c08ab738ec2c882944966e26b529732e889cd8d9d09b71da83d47035c9d1579a1f4

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.swp

data/.rspec

@@ -0,0 +1,4 @@
+--require spec_helper
+--format documentation
+--color
+--seed 99513377

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.5
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec
+group :development, :test do
+  gem 'byebug', '~> 3.5.1', platforms: [ :ruby_20, :ruby_21 ]
+  gem 'debugger', platforms: [ :ruby_19 ]
+end

data/Guardfile

@@ -0,0 +1,9 @@
+require 'guard/rspec/dsl'
+dsl   = Guard::RSpec::Dsl.new(self)
+rspec = dsl.rspec
+ruby  = dsl.ruby
+
+guard :rspec, cmd: 'bundle exec rspec', spec_paths: %w( spec ) do
+  watch(%r{^lib/(.+)\.rb$}) { |m| "#{rspec.spec_dir}/#{m[1]}_spec.rb" }
+  watch(%r{^spec/.+\.rb$})
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Bram Swenson
+
+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,54 @@
+# SuperStruct
+
+[![Build Status](https://travis-ci.org/bramswenson/super_struct.svg?branch=master)](https://travis-ci.org/bramswenson/super_struct)
+
+Simple extensions to `Struct` to make it more compatable with `Hash` without the performance penalties of `OpenStruct`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'super_struct'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install super_struct
+
+## Usage
+
+```ruby
+require 'super_struct'
+
+attributes = { name: 'John Doe' }
+class Customer < SuperStruct.new(attributes)
+  def has_attribute?(attribute)
+    members.include?(attribute.to_sym)
+  end
+end
+
+john_doe = Customer.new(attributes)
+=> #<struct Customer name="John Doe">
+john_doe.name
+=> 'John Doe'
+```
+
+## Testing
+
+```ruby
+bundle install --path .bundle/bundle
+bundle exec rake spec
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/super_struct/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,105 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :benchmark do
+  require 'super_struct'
+  require 'hashie'
+  require 'ostruct'
+  require 'benchmark'
+  require 'benchmark/ips'
+
+  class PORO
+    attr_reader :foo, :bar, :baz
+
+    def initialize attrs={}
+      attrs.each do |attr, value|
+        instance_variable_set "@#{attr}", value
+      end
+    end
+  end
+
+  attrs = { foo: 1, bar: true, baz: 'quux' }
+  hashie = Hashie::Mash.new(attrs)
+  struct_klass = Struct.new(*attrs.keys)
+  struct = struct_klass.new(*attrs.values)
+  ostruct = OpenStruct.new(attrs)
+  poro = PORO.new(attrs)
+  super_struct_klass = SuperStruct.new(attrs)
+  super_struct = super_struct_klass.new(attrs)
+
+  Benchmark.ips do |x|
+    x.report 'Hashie alloc' do
+      Hashie::Mash.new(attrs)
+    end
+
+    x.report 'Hash alloc' do
+      Hash.new(attrs)
+    end
+
+    x.report 'OpenStruct alloc' do
+      OpenStruct.new(attrs)
+    end
+
+    x.report 'PORO alloc' do
+      PORO.new(attrs)
+    end
+
+    x.report 'Struct alloc' do
+      struct_klass.new(*attrs.values)
+    end
+
+    x.report 'SuperStruct hash alloc' do
+      super_struct_klass.new(attrs)
+    end
+
+    x.report 'SuperStruct array alloc' do
+      super_struct_klass.new(*attrs.sort.map(&:last))
+    end
+
+    x.compare!
+  end
+
+  Benchmark.ips do |x|
+    x.report 'Hashie access' do
+      hashie.foo
+      hashie.bar
+      hashie.baz
+    end
+
+    x.report 'Hash access' do
+      attrs[:foo]
+      attrs[:bar]
+      attrs[:baz]
+    end
+
+    x.report 'OStruct access' do
+      ostruct.foo
+      ostruct.bar
+      ostruct.baz
+    end
+
+    x.report 'PORO access' do
+      poro.foo
+      poro.bar
+      poro.baz
+    end
+
+    x.report 'Struct access' do
+      struct.foo
+      struct.bar
+      struct.baz
+    end
+
+    x.report 'SuperStruct access' do
+      super_struct.foo
+      super_struct.bar
+      super_struct.baz
+    end
+
+    x.compare!
+  end
+end

data/lib/super_struct/version.rb

@@ -0,0 +1,3 @@
+module SuperStruct
+  VERSION = "0.0.1"
+end

data/lib/super_struct.rb

@@ -0,0 +1,36 @@
+require "super_struct/version"
+
+module SuperStruct
+  module InstanceMethods
+    def initialize(*input)
+      if input.first.respond_to?(:has_key?)
+        keys, values = input.first.sort.transpose
+        unless keys.map(&:to_sym) == members
+          raise ArgumentError.new("#{self.class.name} expects a hash with keys #{members.join(', ')}")
+        end
+        super(*values)
+      else
+        super(*input)
+      end
+    end
+
+    def attributes
+      members.inject({}) do |attributes, member|
+        attributes[member] = send(member)
+        attributes
+      end
+    end
+  end
+
+  def self.new(array_or_hash, &block)
+    keys = if array_or_hash.respond_to?(:has_key?)
+      array_or_hash.keys.sort.map(&:to_sym)
+    else
+      array_or_hash.sort.map(&:to_sym)
+    end
+
+    Struct.new(*keys, &block).tap do |struct|
+      struct.send(:include, InstanceMethods)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'super_struct'
+require 'pry'

data/spec/super_struct_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe SuperStruct do
+  let(:constructor_input)  { { foo: :bar, fiz: :bang } }
+  let(:klass)              { SuperStruct.new(constructor_input) }
+  let(:input)              { constructor_input }
+  subject                  { klass.new(input) }
+
+  describe '::new' do
+    subject { klass }
+
+    it 'creates a new Class' do
+      expect(subject.class).to eq Class
+    end
+
+    it 'extends the new Class with the SuperStruct methods' do
+      expect(subject.new).to respond_to :attributes
+    end
+
+    context 'given a block upon construction' do
+      let(:klass) do
+        SuperStruct.new(constructor_input) do
+          def has_attribute?(attribute)
+            members.include?(attribute.to_sym)
+          end
+        end
+      end
+
+      it 'extends the Class with the block' do
+        expect(klass.new).to have_attribute :foo
+      end
+    end
+  end
+
+  describe '#new' do
+    context 'given multiple arguments as input' do
+      subject { klass.new(:bar, :bang) }
+
+      it 'accepts an array as input' do
+        expect(subject.foo).to eq :bang
+      end
+    end
+  end
+
+  describe '#members' do
+    it 'is the keys given to the constructor, sorted' do
+      expect(subject.members).to eq input.keys.sort
+    end
+  end
+
+  describe '#attributes' do
+    it 'is a hash of the attributes and their values' do
+      expect(subject.attributes).to eq constructor_input
+    end
+  end
+end

data/super_struct.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'super_struct/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'super_struct'
+  spec.version       = SuperStruct::VERSION
+  spec.authors       = ['Bram Swenson']
+  spec.email         = ['bram@craniumisajar.com']
+  spec.summary       = %q{Extended struct constructors}
+  spec.description   = %q{Extended struct constructors}
+  spec.homepage      = 'http://github.com/bramswenson/super_struct'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 'bundler',       '~> 1.7'
+  spec.add_development_dependency 'rake',          '~> 10.0'
+  spec.add_development_dependency 'rspec',         '~> 3.1.0'
+  spec.add_development_dependency 'guard',         '~> 2.11.1'
+  spec.add_development_dependency 'guard-rspec',   '~> 4.5.0'
+  spec.add_development_dependency 'pry',           '~> 0.10.1'
+  spec.add_development_dependency 'hashie',        '~> 3.4.0'
+  spec.add_development_dependency 'benchmark-ips', '~> 2.1.1'
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: super_struct
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bram Swenson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.11.1
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.1
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+description: Extended struct constructors
+email:
+- bram@craniumisajar.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/super_struct.rb
+- lib/super_struct/version.rb
+- spec/spec_helper.rb
+- spec/super_struct_spec.rb
+- super_struct.gemspec
+homepage: http://github.com/bramswenson/super_struct
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Extended struct constructors
+test_files:
+- spec/spec_helper.rb
+- spec/super_struct_spec.rb