openstruct-from_hash.rb 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b918513414685919dd0cfd9912ba7df354d442bff8362916b2621286d7f2f9e
-  data.tar.gz: 9448da3b2e76e02336b052c18213bf7aa70ccbf3f72256cd2977f21dd69f42c3
+  metadata.gz: acab5b4bc8644f21c1240b529886644a54b70c6922a13e09b4c73d21901791e9
+  data.tar.gz: e15db4781da6d1bb2cbbd05ff872e1b703fd6c072604b6bda7a4504f08997fba
 SHA512:
-  metadata.gz: e5cc797cadf4e9df79a93ac2f6a3bac472634d8b96a210dde5aa2b7ec931517341658e102a29364f5401dfcafabb4f89979c1e2cb80deb2f9fe7e88f6094c9e6
-  data.tar.gz: cdbd5e9b6277f8918730fb7f829a7bc3821a75103f5b97301288879fe7107ac3a2c975ca2b0b0b9344f11ae9baf5ff5f4c7536be0360e03bffe9eb2779669705
+  metadata.gz: 8ad00f9a336affbea429f99ad62d2a2752ea0cc8c4d2640965cc14836d17efd133460a8ae79e28f2011d4ba161bc401c55ff9cdca0bdaadae1146b168d4c5647
+  data.tar.gz: 550e0229a30ecdb801ab70b68326224a8051520ef241c8453ba5bc4ebb80bf0c7b0be1dc82f60092bcf127935f066a5baebc96ec1e4a21b2e385e727a6099018

data/.gitignore

@@ -1 +1,2 @@
+Gemfile.lock
 *.gem

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v0.3.3
+
+* Improve `README.md` documentation.
+
 ## v0.3.2
 
 * Document `OpenStruct::FromHash::VERSION`.

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gemspec
+group :test do
+  gem 'rspec'
+end

data/README.md

@@ -13,18 +13,36 @@ constructor for the OpenStruct class that is apart of Ruby's standard library.
 ## <a id='examples'>Examples</a>
 
 
+__1.__
+
+Recursively initialize an OpenStruct:
+
 ```ruby
 require 'ostruct'
 require 'openstruct-from_hash'
 obj = OpenStruct.from_hash(
   str: 'foo',
   ary: [{ number: 20 }],
-  person: { name: 'John', age: 21.5, friends: [{name: 'Amy'}] }
+  person: { name: 'John', friends: [{name: 'Amy'}] }
 )
 obj.str                    # => 'foo'
 obj.ary[0].number          # => 20
 obj.person.name            # => 'John'
-obj.person.age             # => 21.5
+obj.person.friends[0].name # => 'Amy'
+```
+
+__2.__
+
+Recursively initialize an OpenStruct from a JSON object:
+
+```ruby
+require 'json'
+require 'ostruct'
+require 'openstruct-from_hash'
+json = '{ "ary": [{ "number": 20 }], "person": { "name": "John", "friends": [{ "name": "Amy" }] } }'
+obj = OpenStruct.from_hash JSON.parse(json)
+obj.ary[0].number          # => 20
+obj.person.name            # => 'John'
 obj.person.friends[0].name # => 'Amy'
 ```
 

data/Rakefile

@@ -1,5 +1,6 @@
 require 'bundler/gem_tasks'
+desc 'Run the tests.'
 task :test do
-  sh 'ruby test/openstruct-from_hash_test.rb'
+  sh 'bundle exec rspec'
 end
 task default: :test

data/lib/openstruct-from_hash.rb

@@ -4,7 +4,7 @@ class OpenStruct
     # @return [String]
     #   The current version of openstruct-from_hash.rb
     #
-    VERSION = '0.3.2'.freeze
+    VERSION = '0.3.3'.freeze
 
     #
     # @example

data/spec/openstruct-from_hash_spec.rb

@@ -0,0 +1,24 @@
+require 'bundler/setup'
+require 'rspec'
+require 'ostruct'
+require 'openstruct-from_hash'
+
+RSpec.describe OpenStruct::FromHash do
+  let(:ostruct) do
+    OpenStruct.from_hash(
+      str: 'foo',
+      ary: [{ number: 20 }, BasicObject.new],
+      person: { name: 'John', friends: [{ name: 'Amy' }] }
+    )
+  end
+
+  describe '#from_hash' do
+    it 'recursively initializes an OpenStruct' do
+      expect(ostruct.str).to eq('foo')
+      expect(ostruct.ary[0].number).to eq(20)
+      expect(BasicObject === ostruct.ary[1]).to be(true)
+      expect(ostruct.person.name).to eq('John')
+      expect(ostruct.person.friends[0].name).to eq('Amy')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstruct-from_hash.rb
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Robert Gleeson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-01 00:00:00.000000000 Z
+date: 2018-12-02 00:00:00.000000000 Z
 dependencies: []
 description: openstruct-from_hash.rb implements OpenStruct.from_hash(), a recursive
   constructor for the OpenStruct class that is apart of Ruby's standard library.
@@ -20,12 +20,13 @@ files:
 - ".gitignore"
 - ".pryrc"
 - CHANGELOG.md
+- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/openstruct-from_hash.rb
 - openstruct-from_hash.gemspec
-- test/openstruct-from_hash_test.rb
+- spec/openstruct-from_hash_spec.rb
 homepage: https://github.com/r-obert/openstruct-from_hash.rb
 licenses:
 - MIT

data/test/openstruct-from_hash_test.rb

@@ -1,20 +0,0 @@
-require 'bundler/setup'
-require 'ostruct'
-require 'openstruct-from_hash'
-require 'minitest'
-require 'minitest/autorun'
-
-class OpenStructTest < Minitest::Test
-  def test_from_hash_1
-    obj = OpenStruct.from_hash(
-      str: 'foo',
-      ary: [{ number: 20 }, BasicObject.new],
-      person: { name: 'John', friends: [{ name: 'Amy' }] }
-    )
-    assert_equal 'foo', obj.str
-    assert_equal 20, obj.ary[0].number
-    assert BasicObject === obj.ary[1]
-    assert_equal 'John', obj.person.name
-    assert_equal 'Amy', obj.person.friends[0].name
-  end
-end