ofstruct 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4affb006d45fd6c59e88924ba63450b0e6b6d96b
+  data.tar.gz: 50be84fa6237ee7bb9fad0136dee2388b5499a86
+SHA512:
+  metadata.gz: 604e21308a123f6bffb74c11c338966bade15f65ded6f525cf4b553b76bc98801d586dd8d8827ed4c87c069dfced7bf5d0869bd2433574f342f2ab98ed5c8400
+  data.tar.gz: 6f1049641791961250cb4e82a71d4d596df361493be598ffda3bda86843c13233b961fa8929de70ec61bf6263def1276a41510d8588c5a0dac1dc60afb500e89

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Arturo Herrero, http://arturoherrero.com/
+
+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,111 @@
+# OpenFastStruct
+
+OpenStruct allows the creation of data objects with arbitrary attributes.
+
+**OpenFastStruct** is a data structure, similar to an OpenStruct, that allows the
+definition of arbitrary attributes with their accompanying values. It benchmarks
+~3x slower than a Hash, but it's ~4x faster than OpenStruct.
+
+
+## Examples
+
+### Basic usage
+
+```ruby
+require "ofstruct"
+
+person = OpenFastStruct.new
+person.name = "John Smith"
+person.age  = 70
+
+puts person.name     # -> "John Smith"
+puts person.age      # -> 70
+puts person.address  # -> #<OpenFastStruct>
+```
+
+### Initialize and update from a Hash
+
+An OpenFastStruct employs a Hash internally to store the methods and values and
+can even be initialized or updated with one:
+
+```ruby
+require "ofstruct"
+
+person = OpenFastStruct.new(:name => "John Smith")
+puts person.name  # -> "John Smith"
+
+person.update(:name => "David Smith", :age => 70)
+puts person.name  # -> "David Smith"
+puts person.age   # -> 70
+```
+
+### Remove attributes
+
+Removing the presence of a method requires the execution the `#delete_field`
+method as setting the property value to a new empty OpenFastStruct.
+
+```ruby
+require "ofstruct"
+
+person = OpenFastStruct.new
+person.name = "John Smith"
+person.delete_field(:name)
+puts person.name  # -> #<OpenFastStruct>
+```
+
+### *Black hole* object
+
+An OpenFastStruct instance is a *black hole* object that supports infinite
+chaining of attributes.
+
+```ruby
+require "ofstruct"
+
+person = OpenFastStruct.new
+person.address.number = 4
+puts person.address.number  # -> 4
+```
+
+
+## Benchmarks
+
+Probably you heard that you should never, ever use OpenStruct because the
+performance penalty is prohibitive. You can use OpenFastStruct instead!
+
+### Comparation between Hash, OpenFastStruct and OpenStruct:
+
+```
+$ ruby benchmark/hash_ofstruct_ostruct.rb
+Calculating -------------------------------------
+                Hash    25.518k i/100ms
+      OpenFastStruct    10.527k i/100ms
+          OpenStruct     3.236k i/100ms
+-------------------------------------------------
+                Hash    487.517k (±11.9%) i/s -      2.399M
+      OpenFastStruct    159.952k (± 4.0%) i/s -    800.052k
+          OpenStruct     45.602k (± 4.7%) i/s -    229.756k
+
+Comparison:
+                Hash:   487516.9 i/s
+      OpenFastStruct:   159952.4 i/s - 3.05x slower
+          OpenStruct:    45601.6 i/s - 10.69x slower
+```
+
+### Comparation between RSpec Stubs, OpenFastStruct and OpenStruct:
+
+```
+$ ruby benchmark/double_ofstruct_ostruct.rb
+Calculating -------------------------------------
+         RSpec Stubs   103.000  i/100ms
+      OpenFastStruct   108.000  i/100ms
+          OpenStruct    45.000  i/100ms
+-------------------------------------------------
+         RSpec Stubs    297.809  (±17.1%) i/s -      1.545k in   5.346697s
+      OpenFastStruct    262.381  (±12.2%) i/s -      1.404k in   5.430345s
+          OpenStruct    185.150  (± 7.0%) i/s -    945.000
+
+Comparison:
+         RSpec Stubs:      297.8 i/s
+      OpenFastStruct:      262.4 i/s - 1.14x slower
+          OpenStruct:      185.2 i/s - 1.61x slower
+```

data/lib/ofstruct.rb

@@ -0,0 +1,52 @@
+class OpenFastStruct
+  def initialize(args = {})
+    @members = {}
+    assign(args)
+  end
+
+  def delete_field(key)
+    @members[key.to_sym] = self.class.new
+  end
+
+  def each_pair
+    @members.each_pair
+  end
+
+  def update(args)
+    assign(args)
+  end
+
+  def to_h
+    @members
+  end
+
+  def inspect
+    @members.each_with_object("#<#{self.class}") { |(k,v), output| output << " :#{k}=#{v.inspect}" } << ">"
+  end
+  alias :to_s :inspect
+
+  def to_ary
+    nil
+  end
+
+  private
+
+  def method_missing(name, *args)
+    @members.fetch(name) do
+      if name[-1] == "="
+        @members[name[0..-2].to_sym] = args.first
+      else
+        @members[name.to_sym] = self.class.new
+      end
+    end
+  end
+
+  def assign(args)
+    ensure_hash(args)
+    args.each { |k,v| @members[k.to_sym] = v }
+  end
+
+  def ensure_hash(args)
+    raise ArgumentError unless args.is_a?(Hash)
+  end
+end

data/spec/lib/ofstruct_spec.rb

@@ -0,0 +1,125 @@
+require "ofstruct"
+
+RSpec.describe OpenFastStruct do
+  subject(:ofstruct) { described_class.new }
+
+  it "can be instantiated with no arguments" do
+    expect(ofstruct).to be_a(described_class)
+  end
+
+  it "works accessor" do
+    ofstruct.name = "John"
+    expect(ofstruct.name).to eq("John")
+  end
+
+  it "works recursive accessor" do
+    ofstruct.user.name = "John"
+    ofstruct.name = "OpenFastStruct"
+    expect(ofstruct.user).to be_a(described_class)
+    expect(ofstruct.user.name).to eq("John")
+    expect(ofstruct.name).to eq("OpenFastStruct")
+  end
+
+  it "works with unexisting values" do
+    expect(ofstruct.name).to be_a(described_class)
+    expect(ofstruct.nam).to be_a(described_class)
+  end
+
+  context "instantiated from arguments" do
+    subject(:ofstruct) { described_class.new(args) }
+
+    context "without Hash" do
+      let(:args) { double }
+
+      it "raises an exception" do
+        expect { ofstruct }.to raise_error(ArgumentError)
+      end
+    end
+
+    context "with Hash" do
+      let(:symbol_args) { Hash[:name  => "John"] }
+      let(:string_args) { Hash["name" => "John"] }
+
+      context "with Symbol keys" do
+        let(:args) { symbol_args }
+
+        it "works with reader" do
+          expect(ofstruct.name).to eq("John")
+        end
+
+        it "works accessor" do
+          ofstruct.name = "John Smith"
+          expect(ofstruct.name).to eq("John Smith")
+        end
+
+        describe "#delete_field" do
+          it "removes the named key" do
+            ofstruct.delete_field(:name)
+            expect(ofstruct.name).to be_a(described_class)
+          end
+        end
+
+        describe "#each_field" do
+          it "yields all keys with the values" do
+            expect(ofstruct.each_pair.to_a).to eq([[:name, "John"]])
+          end
+
+          it "returns an enumerator" do
+            expect(ofstruct.each_pair).to be_a(Enumerator)
+          end
+        end
+
+        describe "#update" do
+          it "overwrite previous keys" do
+            ofstruct.update(:name => "John Smith")
+            expect(ofstruct.name).to eq("John Smith")
+          end
+
+          it "adds new keys" do
+            ofstruct.update(:surname => "Smith")
+            expect(ofstruct.name).to eq("John")
+            expect(ofstruct.surname).to eq("Smith")
+          end
+
+          context "without Hash" do
+            it "raises an exception" do
+              expect { ofstruct.update(double) }.to raise_error(ArgumentError)
+            end
+          end
+        end
+
+        describe "#to_h" do
+          it "converts to a hash" do
+            expect(ofstruct.to_h).to eq(args)
+          end
+        end
+
+        describe "#inspect" do
+          it "returns the human-readable representation" do
+            expect(ofstruct.inspect).to eq('#<OpenFastStruct :name="John">')
+          end
+        end
+      end
+
+      context "with String keys" do
+        let(:args) { string_args }
+
+        it "works with reader" do
+          expect(ofstruct.name).to eq("John")
+        end
+
+        describe "#to_h" do
+          it "converts to a hash with keys as symbols" do
+            expect(ofstruct.to_h).to eq(symbol_args)
+          end
+        end
+
+        describe "#inspect" do
+          it "returns the human-readable representation" do
+            expect(ofstruct.inspect).to eq('#<OpenFastStruct :name="John">')
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: ofstruct
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Arturo Herrero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: OpenFastStruct is a data structure, similar to an OpenStruct but faster.
+email: arturo.herrero@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/ofstruct.rb
+- spec/lib/ofstruct_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/arturoherrero/ofstruct
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.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: OpenFastStruct
+test_files:
+- spec/lib/ofstruct_spec.rb
+- spec/spec_helper.rb