ofstruct 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4affb006d45fd6c59e88924ba63450b0e6b6d96b
-  data.tar.gz: 50be84fa6237ee7bb9fad0136dee2388b5499a86
+  metadata.gz: cc0d0332d4b8b6ce6adc7df06f8d9aaf63c463bf
+  data.tar.gz: 67e0a85b29683cef3e2e495f71a37e05b05defb2
 SHA512:
-  metadata.gz: 604e21308a123f6bffb74c11c338966bade15f65ded6f525cf4b553b76bc98801d586dd8d8827ed4c87c069dfced7bf5d0869bd2433574f342f2ab98ed5c8400
-  data.tar.gz: 6f1049641791961250cb4e82a71d4d596df361493be598ffda3bda86843c13233b961fa8929de70ec61bf6263def1276a41510d8588c5a0dac1dc60afb500e89
+  metadata.gz: f2d567ec0621b81122b5924b8a49b9c9111a497a1d6fe53740f75e55ed46c008fc4952bad472ad16e7688fb37ada5b1871ed3eb765b25a4aff778a40e28d4444
+  data.tar.gz: 11f6e81aec9ff93a8f7da30942df17392204a3f3a9fc249946eda3465e8b1935b1e2ae902b62a3a97fcc276f0124a337ef3711b96c6bcfee008e71cfa6a0b88e

data/README.md

@@ -1,10 +1,30 @@
 # OpenFastStruct
 
+[![Code Climate](https://codeclimate.com/github/arturoherrero/ofstruct/badges/gpa.svg)](https://codeclimate.com/github/arturoherrero/ofstruct)
+[![Build Status](https://travis-ci.org/arturoherrero/ofstruct.svg)](https://travis-ci.org/arturoherrero/ofstruct)
+
 OpenStruct allows the creation of data objects with arbitrary attributes.
 
-**OpenFastStruct** is a data structure, similar to an OpenStruct, that allows the
+**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.
+~3x slower than a Hash, but **it's ~4x faster than OpenStruct**.
+
+*An OpenFastStruct is not exactly like an OpenStruct, these are the main
+differences between them:
+- OpenFastStruct doesn't allow hash access like `person[:name]`.
+- OpenFastStruct doesn't provide marshalling.
+- OpenFastStruct allows infinite chaining of attributes <sup>[example](#black-hole-object)</sup>.
+
+
+## Installation
+
+Install the gem:
+
+    $ gem install ofstruct
+
+Use the gem in a project managed with Bundler adding it into the Gemfile:
+
+    gem "ofstruct"
 
 
 ## Examples
@@ -72,7 +92,7 @@ puts person.address.number  # -> 4
 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:
+#### Comparation between Hash, OpenFastStruct and OpenStruct:
 
 ```
 $ ruby benchmark/hash_ofstruct_ostruct.rb
@@ -91,7 +111,7 @@ Comparison:
           OpenStruct:    45601.6 i/s - 10.69x slower
 ```
 
-### Comparation between RSpec Stubs, OpenFastStruct and OpenStruct:
+#### Comparation between RSpec Stubs, OpenFastStruct and OpenStruct:
 
 ```
 $ ruby benchmark/double_ofstruct_ostruct.rb

data/lib/ofstruct.rb

@@ -17,7 +17,9 @@ class OpenFastStruct
   end
 
   def to_h
-    @members
+    @members.inject({}) do |result, (k, v)|
+      result.tap { |result| result[k] = v.is_a?(self.class) ? v.to_h : v }
+    end
   end
 
   def inspect
@@ -29,6 +31,11 @@ class OpenFastStruct
     nil
   end
 
+  def ==(other)
+    return false unless other.is_a?(self.class)
+    self.to_h == other.to_h
+  end
+
   private
 
   def method_missing(name, *args)

data/spec/lib/ofstruct_spec.rb

@@ -14,15 +14,18 @@ RSpec.describe OpenFastStruct do
 
   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
+
+  it "equals to other with same attributes" do
+    ofstruct.user.name = "John"
+    other_ofstruct = described_class.new
+    other_ofstruct.user.name = "John"
+    expect(ofstruct).to eq(other_ofstruct)
   end
 
   context "instantiated from arguments" do
@@ -59,7 +62,7 @@ RSpec.describe OpenFastStruct do
           end
         end
 
-        describe "#each_field" do
+        describe "#each_pair" do
           it "yields all keys with the values" do
             expect(ofstruct.each_pair.to_a).to eq([[:name, "John"]])
           end
@@ -92,6 +95,20 @@ RSpec.describe OpenFastStruct do
           it "converts to a hash" do
             expect(ofstruct.to_h).to eq(args)
           end
+
+          it "converts to a hash with chained attributes" do
+            ofstruct.address.street = "Sunset Boulevar"
+            ofstruct.address.number = 4
+            expect(ofstruct.to_h).to eq(
+              {
+                :name   => "John",
+                :address => {
+                  :street => "Sunset Boulevar",
+                  :number => 4,
+                }
+              }
+            )
+          end
         end
 
         describe "#inspect" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ofstruct
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Arturo Herrero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-26 00:00:00.000000000 Z
+date: 2015-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips