acts_as_hashable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96c41090ceb3c7fa641c3d120194f1f553aec8e3
+  data.tar.gz: ae8c03743c9ecbef87c3944dbcfefa9f056819e0
+SHA512:
+  metadata.gz: 12f6625c97ebc77a3a9c07659836f33a72cc24908733af3c0a46624e0e5ac6094aca062a06e1be296d8da94f315bc7dfb119e86a5efeb145770b85b0c93de521
+  data.tar.gz: 06cbfecd4d49b5bf94f450d539e7b4aacd3cd81f700ce9fb9ac7680c9cd6c27611181b0a9893dfea907c20d6f84456acf92ec3934c56f5f33e41f95438e6b840

data/.editorconfig

@@ -0,0 +1,8 @@
+# See http://editorconfig.org/
+
+[*]
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+end_of_line = lf

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+*.gem

data/.ruby-version

@@ -0,0 +1 @@
+2.3.7

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.3.1
+  - 2.3.7
+cache: bundler
+script:
+  - bundle exec rspec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    acts_as_hashable (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  acts_as_hashable!
+  rspec
+
+BUNDLED WITH
+   1.16.3

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2018 Blue Marble Payroll, LLC
+
+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,150 @@
+# Acts as Hashable
+
+[![Build Status](https://travis-ci.org/bluemarblepayroll/acts_as_hashable.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/acts_as_hashable)
+
+This is a small library that helps increase the pliability of object constructor signatures.  
+Instead of instantiating via the constructor, this library can install helper factory
+class-level methods that you can use with hashes:
+
+* make(): create a single instance of a class
+* array(): create an array of instances of a class
+
+One caveat to this library is that it is not meant to be a complete modeling solution but rather
+just a tool that helps model a domain or complete a modeling framework.  
+The main missing element to this library is that you still have to manage and implement constructors.
+The two class-level factory methods are just meant to create a syntactic hash-like interface.
+
+## Installation
+
+To install through Rubygems:
+
+````
+gem install install acts_as_hashable
+````
+
+You can also add this to your Gemfile:
+
+````
+bundle add acts_as_hashable
+````
+
+## Examples
+
+Consider the following example:
+
+````
+class Person
+  acts_as_hashable
+
+  attr_reader :name, :age
+
+  def initialize(name:, age:)
+    @name = name
+    @age  = age
+  end
+end
+
+class HeadOfHousehold
+  acts_as_hashable
+
+  attr_reader :person, :partner
+
+  def initialize(person:, partner: nil)
+    @person   = Person.make(person)
+    @partner  = Person.make(partner)
+  end
+end
+
+class Family
+  acts_as_hashable
+
+  attr_reader :head_of_household, :children
+
+  def initialize(head_of_household:, children: [])
+    @head_of_household  = HeadOfHousehold.make(head_of_household)
+    @children           = Person.array(children)
+  end
+end
+````
+
+Simply placing:
+
+````
+acts_as_hashable
+````
+
+on a class means it will have the two main factory methods available for you to use.  Then,
+you can leverage these for instantiation:
+
+````
+family = {
+  head_of_household: {
+    person: {
+      name: 'Matt',
+      age:  109,
+    },
+    partner: {
+      name: 'Katie',
+      age:  110,
+    }
+  },
+  children: [
+    { name: 'Martin', age: 29 },
+    { name: 'Short',  age: 99 },
+  ]
+}
+
+family_obj = Family.make(family)
+````
+
+The family_obj will then be a fully hydrated Family instance.  The family instance
+attributes will also be fully hydrated since its constructor also uses acts_as_hashable.
+
+Note that this works nicely with either keyword arguments or a hash-based argument constructor like so:
+
+````
+class Toy
+  acts_as_hashable
+
+  attr_reader :squishy
+
+  def initialize(opts = {})
+    @squishy = opts[:squishy] || false
+  end
+end
+
+class Pet
+  acts_as_hashable
+
+  attr_reader :name, :toy
+
+  def initialize(opts = {})
+    @name = opts[:name]
+    @toy  = Toy.make(opts[:toy])
+  end
+end
+````
+
+## Contributing
+
+### Development Environment Configuration
+
+Basic steps to take to get this repository compiling:
+
+1. Install [Ruby](https://www.ruby-lang.org/en/documentation/installation/) (check acts_as_hashable.gemspec for versions supported)
+2. Install bundler (gem install bundler)
+3. Clone the repository (git clone git@github.com:bluemarblepayroll/acts_as_hashable.git)
+4. Navigate to the root folder (cd acts_as_hashable)
+5. Install dependencies (bundle)
+
+### Running Tests
+
+To execute the test suite run:
+
+````
+rspec spec --format documentation
+````
+
+## License
+
+This project is MIT Licensed.

data/acts_as_hashable.gemspec

@@ -0,0 +1,25 @@
+require "./lib/acts_as_hashable/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'acts_as_hashable'
+  s.version     = ActsAsHashable::VERSION
+  s.summary     = "Simple hash-based factory methods for objects."
+
+  s.description = <<-EOS
+    This is a small library that helps increase the pliability of object constructor signatures.
+    Instead of instantiating via the constructor, this library can install helper factory
+    class-level methods that you can use with hashes.
+  EOS
+
+  s.authors     = [ 'Matthew Ruggio' ]
+  s.email       = [ 'mruggio@bluemarblepayroll.com' ]
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.homepage    = 'https://github.com/bluemarblepayroll/acts_as_hashable'
+  s.license     = 'MIT'
+
+  s.required_ruby_version = '>= 2.3.1'
+
+  s.add_development_dependency('rspec')
+end

data/lib/acts_as_hashable/acts_as_hashable.rb

@@ -0,0 +1,21 @@
+#
+# Copyright (c) 2018-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require_relative 'utilities'
+require_relative 'hashable'
+
+module ActsAsHashable
+  module DslHook
+    def acts_as_hashable
+      extend ::ActsAsHashable::Hashable
+    end
+  end
+end
+
+Object.class_eval do
+  extend ::ActsAsHashable::DslHook
+end

data/lib/acts_as_hashable/hashable.rb

@@ -0,0 +1,36 @@
+#
+# Copyright (c) 2018-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module ActsAsHashable
+  module Hashable
+
+    def array(object, nullable: true)
+      if object.is_a?(Hash)
+        objects = [ object ]
+      else
+        objects = Array(object)
+      end
+
+      objects.select { |o| !!o }.map { |o| make(o, nullable: nullable) }
+    end
+
+    def make(object, nullable: true)
+      if object.is_a?(Hash)
+        self.new(**::ActsAsHashable::Utilities.symbolize_keys(object))
+      elsif object.is_a?(self)
+        object
+      elsif object.nil? && nullable
+        nil
+      elsif object.nil? && !nullable
+        self.new
+      else
+        raise "Cannot create hashable object with class name: #{object.class.name}"
+      end
+    end
+
+  end
+end

data/lib/acts_as_hashable/utilities.rb

@@ -0,0 +1,32 @@
+#
+# Copyright (c) 2018-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module ActsAsHashable
+  class Utilities
+    class << self
+
+      # https://apidock.com/rails/Hash/symbolize_keys
+      def symbolize_keys(hash)
+        transform_keys(hash) { |key| key.to_sym rescue key }
+      end
+
+      # https://apidock.com/rails/v4.2.7/Hash/transform_keys
+      def transform_keys(hash)
+        return enum_for(:transform_keys) unless block_given?
+
+        result = {}
+
+        hash.keys.each do |key|
+          result[yield(key)] = hash[key]
+        end
+
+        result
+      end
+
+    end
+  end
+end

data/lib/acts_as_hashable/version.rb

@@ -0,0 +1,10 @@
+#
+# Copyright (c) 2018-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module ActsAsHashable
+  VERSION = "1.0.0"
+end

data/spec/acts_as_hashable_spec.rb

@@ -0,0 +1,222 @@
+#
+# Copyright (c) 2018-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require './lib/acts_as_hashable/acts_as_hashable'
+
+class Toy
+  acts_as_hashable
+
+  attr_reader :squishy
+
+  def initialize(opts = {})
+    @squishy = opts[:squishy] || false
+  end
+end
+
+class Pet
+  acts_as_hashable
+
+  attr_reader :name, :toy
+
+  def initialize(opts = {})
+    @name = opts[:name]
+    @toy  = Toy.make(opts[:toy])
+  end
+end
+
+class Person
+  acts_as_hashable
+
+  attr_reader :name, :age
+
+  def initialize(name:, age:)
+    @name = name
+    @age  = age
+  end
+end
+
+class HeadOfHousehold
+  acts_as_hashable
+
+  attr_reader :person, :partner
+
+  def initialize(person:, partner: nil)
+    @person   = Person.make(person)
+    @partner  = Person.make(partner)
+  end
+end
+
+class Family
+  acts_as_hashable
+
+  attr_reader :head_of_household, :children
+
+  def initialize(head_of_household:, children: [])
+    @head_of_household  = HeadOfHousehold.make(head_of_household)
+    @children           = Person.array(children)
+  end
+end
+
+describe ActsAsHashable do
+  context '#make' do
+
+    context 'with a hash constructor interface' do
+
+      it 'should properly instantiate objects from a symbol-keyed hash' do
+
+        pet = {
+          name: 'Doug the dog',
+          toy: { squishy: true }
+        }
+
+        pet_obj = Pet.make(pet)
+
+        expect(pet_obj.name).to eq('Doug the dog')
+        expect(pet_obj.toy.squishy).to be true
+      end
+
+    end
+
+    context 'with keyword arguments interface' do
+
+      it 'should properly instantiate objects from symbol-keyed hash' do
+        head_of_household = {
+          person: {
+            name: 'Matt',
+            age:  109,
+          },
+          partner: {
+            name: 'Katie',
+            age:  110,
+          }
+        }
+
+        head_of_household_obj = HeadOfHousehold.make(head_of_household)
+
+        expect(head_of_household_obj.person.name).to eq('Matt')
+        expect(head_of_household_obj.person.age).to eq(109)
+        expect(head_of_household_obj.partner.name).to eq('Katie')
+        expect(head_of_household_obj.partner.age).to eq(110)
+      end
+
+      it 'should properly instantiate objects from symbol-keyed hash' do
+        head_of_household = {
+          'person'  => {
+            'name'  => 'Matt',
+            'age'   => 109,
+          },
+          'partner' => {
+            'name'  => 'Katie',
+            'age'   =>  110,
+          }
+        }
+
+        head_of_household_obj = HeadOfHousehold.make(head_of_household)
+
+        expect(head_of_household_obj.person.name).to eq('Matt')
+        expect(head_of_household_obj.person.age).to eq(109)
+        expect(head_of_household_obj.partner.name).to eq('Katie')
+        expect(head_of_household_obj.partner.age).to eq(110)
+      end
+
+      it 'should raise an ArgumentError for missing required keyword' do
+        head_of_household = {
+          person: {
+            # name: 'Matt',
+            age:  109,
+          },
+          partner: {
+            name: 'Katie',
+            age:  110,
+          }
+        }
+
+        expect { HeadOfHousehold.make(head_of_household) }.to raise_error(ArgumentError)
+      end
+
+      it 'should raise an ArgumentError for unknown required keyword' do
+        head_of_household = {
+          person: {
+            name: 'Matt',
+            age:  109,
+            height_in_inches: 700,
+          },
+          partner: {
+            name: 'Katie',
+            age:  110,
+          }
+        }
+
+        expect { HeadOfHousehold.make(head_of_household) }.to raise_error(ArgumentError)
+      end
+
+    end
+
+    context '#array' do
+
+      it 'should properly instantiate objects and arrays of objects from symbol-keyed hash and arrays' do
+        family = {
+          head_of_household: {
+            person: {
+              name: 'Matt',
+              age:  109,
+            },
+            partner: {
+              name: 'Katie',
+              age:  110,
+            }
+          },
+          children: [
+            { name: 'Martin', age: 29 },
+            { name: 'Short',  age: 99 },
+          ]
+        }
+
+        family_obj = Family.make(family)
+
+        expect(family_obj.head_of_household.person.name).to   eq('Matt')
+        expect(family_obj.head_of_household.person.age).to    eq(109)
+        expect(family_obj.head_of_household.partner.name).to  eq('Katie')
+        expect(family_obj.head_of_household.partner.age).to   eq(110)
+
+        expect(family_obj.children.length).to  eq(2)
+        expect(family_obj.children[0].name).to eq('Martin')
+        expect(family_obj.children[0].age).to  eq(29)
+        expect(family_obj.children[1].name).to eq('Short')
+        expect(family_obj.children[1].age).to  eq(99)
+      end
+
+      it 'should properly instantiate arrays of objects when only a single hash is passed in' do
+        family = {
+          head_of_household: {
+            person: {
+              name: 'Matt',
+              age:  109,
+            },
+            partner: {
+              name: 'Katie',
+              age:  110,
+            }
+          },
+          children: { name: 'Martin', age: 29 }
+        }
+
+        family_obj = Family.make(family)
+
+        expect(family_obj.head_of_household.person.name).to   eq('Matt')
+        expect(family_obj.head_of_household.person.age).to    eq(109)
+        expect(family_obj.head_of_household.partner.name).to  eq('Katie')
+        expect(family_obj.head_of_household.partner.age).to   eq(110)
+
+        expect(family_obj.children.length).to  eq(1)
+        expect(family_obj.children[0].name).to eq('Martin')
+        expect(family_obj.children[0].age).to  eq(29)
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_hashable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matthew Ruggio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      This is a small library that helps increase the pliability of object constructor signatures.
+      Instead of instantiating via the constructor, this library can install helper factory
+      class-level methods that you can use with hashes.
+email:
+- mruggio@bluemarblepayroll.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- acts_as_hashable.gemspec
+- lib/acts_as_hashable/acts_as_hashable.rb
+- lib/acts_as_hashable/hashable.rb
+- lib/acts_as_hashable/utilities.rb
+- lib/acts_as_hashable/version.rb
+- spec/acts_as_hashable_spec.rb
+homepage: https://github.com/bluemarblepayroll/acts_as_hashable
+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.3.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Simple hash-based factory methods for objects.
+test_files:
+- spec/acts_as_hashable_spec.rb