objectable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 013a205540d4adb9c25e8a33b48adff324b4148e4df2101e8ddb14f562d3f38e
+  data.tar.gz: 91c1df05393e5f4aa3aa9b0b088841d0d216f3e5cff5d187ae83410842f3a022
+SHA512:
+  metadata.gz: 33bc889fb0d9cef7123e9e46b8b0e604a74ed19d6350993bcee452e5360f27ec67cc59942354b604d69991e20b06a90c8fef165d75186a05c26c394997c89c9e
+  data.tar.gz: 1fc615875100e850d1c32638a623ef2f7bd02853c12b19cab00d05c2a645c2a3e69f04d62b63f22d849eac00ec387a86d3227c7ca1eaeebf7e6d5a1cfef81639

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,5 @@
+.DS_Store
+*.gem
+/tmp
+/coverage
+/pkg

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Metrics/LineLength:
+  Max: 100
+
+Metrics/BlockLength:
+  ExcludedMethods: ['it', 'describe', 'context', 'let', 'specify']
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Style/RescueModifier:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.6.0

data/.travis.yml

@@ -0,0 +1,20 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=a9355f1cf8d8baea41e5e58aec43984979a8ae508a99d80c15ae1dcd6232eb0b
+language: ruby
+rvm:
+  # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
+cache: bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rubocop
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# 1.1.0 (May 3rd, 2019)
+
+* Added objectable_factory to dynamically create objects.
+
+# 1.0.5 (February 5th, 2019)
+
+* Fixed equality bug in array reject block.
+
+# 1.0.4 (January 30th, 2019)
+
+Maintenance Release
+
+* Added bin/console script
+* Added CHANGELOG
+* Updated README with publication steps, additional testing steps
+* Bumped minimum Ruby to 2.3.8
+* Added Guard

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at oss@bluemarblepayroll.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,110 @@
+PATH
+  remote: .
+  specs:
+    objectable (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.0)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    ffi (1.10.0)
+    formatador (0.2.5)
+    guard (2.15.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hirb (0.7.3)
+    jaro_winkler (1.5.2)
+    json (2.1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.13.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    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)
+    rubocop (0.63.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.4.2)
+      ansi
+      hirb
+      simplecov
+    simplecov-html (0.10.2)
+    thor (0.20.3)
+    unicode-display_width (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard-rspec (~> 4.7)
+  objectable!
+  pry
+  pry-byebug (~> 3)
+  rake (~> 10.0)
+  rspec
+  rubocop (~> 0.63.1)
+  simplecov (~> 0.16.1)
+  simplecov-console (~> 0.4.2)
+
+BUNDLED WITH
+   1.17.3

data/Guardfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'DISABLE_SIMPLECOV=true bundle exec rspec --format=documentation' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

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,177 @@
+# Objectable
+
+[![Gem Version](https://badge.fury.io/rb/objectable.svg)](https://badge.fury.io/rb/objectable) [![Build Status](https://travis-ci.org/bluemarblepayroll/objectable.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/objectable) [![Maintainability](https://api.codeclimate.com/v1/badges/047c45ae0016941706e1/maintainability)](https://codeclimate.com/github/bluemarblepayroll/objectable/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/047c45ae0016941706e1/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/objectable/test_coverage) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+This library streamlines value setting and getting for any type of object.  It can give an object a hash-like interface without modifying/changing the underlying object's implementation.  It uses the following methodology:
+
+* If the object is a hash and a string key exists then return the key's value.
+* If the object is a hash and a symbol key exists then return the key's value.
+* If the object publicly responds to the key then call key on the object.
+
+This seems rather trivial but consider the following additional value propositions:
+
+* It can handle dot-notation/key paths for nested objects.
+* It can recursively traverse object graphs to set/get the desired value.  This can be used to build up deep object graphs.
+
+See the `examples` section for more information.
+
+## Installation
+
+To install through Rubygems:
+
+````
+gem install install objectable
+````
+
+You can also add this to your Gemfile:
+
+````
+bundle add objectable
+````
+
+## Examples
+
+Let's define a set of objects built using different constructs but all essentially represent the same graphs:
+
+```ruby
+Employee      = Struct.new(:id, :demographics)
+Demographics  = Struct.new(:first)
+
+symbol_based_hash = { id: 1, demographics: { first: 'Matt' } }
+string_based_hash = { 'id' => 1, 'demographics' => { 'first' => 'Matt' } }
+open_struct       = OpenStruct.new(id: 1, demographics: OpenStruct.new(first: 'Matt'))
+object            = Employee.new(1, Demographics.new('Matt'))
+```
+
+### Getting Values
+
+The following calls will all resolve to the same respective values:
+
+```ruby
+resolver = Objectable.resolver
+
+# All resolve to the value of: 1
+resolver.get(symbol_based_hash, :id)
+resolver.get(symbol_based_hash, 'id')
+resolver.get(string_based_hash, :id)
+resolver.get(string_based_hash, 'id')
+resolver.get(open_struct, :id)
+resolver.get(open_struct, 'id')
+resolver.get(object, :id)
+resolver.get(object, 'id')
+
+# All resolve to the value of: Matt
+resolver.get(symbol_based_hash, :'demographics.first')
+resolver.get(symbol_based_hash, 'demographics.first')
+resolver.get(string_based_hash, :'demographics.first')
+resolver.get(string_based_hash, 'demographics.first')
+resolver.get(open_struct, :'demographics.first')
+resolver.get(open_struct, 'demographics.first')
+resolver.get(object, :'demographics.first')
+resolver.get(object, 'demographics.first')
+```
+
+As you can see you do not have to worry about nested object traversal, dot-notation, or key type; this library gives you a unified interface when accessing values.
+
+### Setting Values
+
+Say we want to update a the `id` and `first` attributes from the objects:
+
+```ruby
+resolver = Objectable.resolver
+
+# All calls will set the object's respective id attribute to: 999
+resolver.set(symbol_based_hash, :id, 999)
+resolver.set(symbol_based_hash, 'id', 999)
+resolver.set(string_based_hash, :id, 999)
+resolver.set(string_based_hash, 'id', 999)
+resolver.set(open_struct, :id, 999)
+resolver.set(open_struct, 'id', 999)
+resolver.set(object, :id, 999)
+resolver.set(object, 'id', 999)
+
+# All calls will set the object's respective id attribute to: Nick
+resolver.set(symbol_based_hash, :'demographics.first', 'Nick')
+resolver.set(symbol_based_hash, 'demographics.first', 'Nick')
+resolver.set(string_based_hash, :'demographics.first', 'Nick')
+resolver.set(string_based_hash, 'demographics.first', 'Nick')
+resolver.set(open_struct, :'demographics.first', 'Nick')
+resolver.set(open_struct, 'demographics.first', 'Nick')
+resolver.set(object, :'demographics.first', 'Nick')
+resolver.set(object, 'demographics.first', 'Nick')
+```
+
+### Dot-Notation Customization
+
+By default dot-notation is turned on and the path separator is set as a period.  You can disable or customize this by passing in a separator option into `resolver`:
+
+```ruby
+resolver_without_dot_notation     = Objectable.resolver(separator: nil)
+resolver_with_custom_dot_notation = Objectable.resolver(separator: '$')
+```
+
+Also note that you can choose to pass in an array into the expression and it will be used for customized traversal but without using dot-notation.  The following are equivalent:
+
+```ruby
+Objectable.resolver.get([:demographics, :first], symbol_based_hash)
+Objectable.resolver.get('demographics.first', symbol_based_hash)
+```
+
+### Gaps
+
+When setting values of nested objects:
+
+* If the parent object is null then the parent object will be initialized based on the preceding class.  This is not ideal for complex object graphs but works quite lovely for Hash and OpenStruct objects.  In the future this can be extended so the object type graph can be passed in and used as a blueprint for parent initialization.
+
+## 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 objectable.gemspec for versions supported)
+2. Install bundler (gem install bundler)
+3. Clone the repository (git clone git@github.com:bluemarblepayroll/objectable.git)
+4. Navigate to the root folder (cd objectable)
+5. Install dependencies (bundle)
+
+### Running Tests
+
+To execute the test suite run:
+
+````
+bundle exec rspec spec --format documentation
+````
+
+Alternatively, you can have Guard watch for changes:
+
+````
+bundle exec guard
+````
+
+Also, do not forget to run Rubocop:
+
+````
+bundle exec rubocop
+````
+
+### Publishing
+
+Note: ensure you have proper authorization before trying to publish new versions.
+
+After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions:
+
+1. Merge Pull Request into master
+2. Update ```lib/objectable/version.rb``` using [semantic versioning](https://semver.org)
+3. Install dependencies: ```bundle```
+4. Update ```CHANGELOG.md``` with release notes
+5. Commit & push master to remote and ensure CI builds master successfully
+6. Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Code of Conduct
+
+Everyone interacting in this codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bluemarblepayroll/objectable/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+This project is MIT Licensed.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'objectable'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+Pry.start

data/lib/objectable.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+#
+# 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 'objectable/resolver'
+
+# Top-level API
+module Objectable
+  class << self
+    # Really just syntactic sugar that proxies a new Resolver instance creation.
+    def resolver(*args)
+      Resolver.new(*args)
+    end
+  end
+end

data/lib/objectable/interface.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-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 Objectable
+  # This class defines the direct interface with an object.  Unlike the resolver, this class
+  #  cannot handle traversal or nesting, it can only deal with the immediate object interface.
+  class Interface
+    def get(object, key)
+      if object.is_a?(Hash)
+        indifferent_hash_get(object, key)
+      elsif object.respond_to?(key)
+        object.public_send(key)
+      end
+    end
+
+    def set(object, key, val)
+      object.tap do |o|
+        setter_method = "#{key}="
+        if o.respond_to?(setter_method)
+          o.send(setter_method, val)
+        elsif o.respond_to?(:[])
+          o[key] = val
+        end
+      end
+    end
+
+    private
+
+    def indifferent_hash_get(hash, key)
+      if hash.key?(key.to_s)
+        hash[key.to_s]
+      elsif hash.key?(key.to_s.to_sym)
+        hash[key.to_s.to_sym]
+      end
+    end
+  end
+end

data/lib/objectable/resolver.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-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 'interface'
+
+module Objectable
+  # The main logic value proposition of this library.  An instance of this class can act as
+  # a value-get and value-set arbiter for objects.
+  class Resolver
+    DEFAULT_SEPARATOR = '.'
+
+    attr_reader :separator
+
+    def initialize(separator: DEFAULT_SEPARATOR)
+      @interface = Interface.new
+      @separator = separator.to_s
+
+      freeze
+    end
+
+    def get(object, expression)
+      traverse(object, key_path(expression))
+    end
+
+    def set(object, expression, value)
+      build_up(object, key_path(expression), value)
+    end
+
+    def ==(other)
+      eql?(other)
+    end
+
+    def eql?(other)
+      return false unless other.is_a?(self.class)
+
+      separator == other.separator
+    end
+
+    private
+
+    attr_reader :interface
+
+    def key_path(expression)
+      return expression        if expression.is_a?(Array)
+      return Array(expression) if separator.empty?
+
+      expression.to_s.split(separator)
+    end
+
+    def traverse(object, through)
+      pointer = object
+
+      through.each do |key|
+        next unless pointer
+
+        pointer = interface.get(pointer, key)
+      end
+
+      pointer
+    end
+
+    def build_up(object, through, value)
+      object.tap do |o|
+        pointer = o
+
+        preceding_keys = through[0..-2]
+        last_key       = through.last
+
+        preceding_keys.each do |key|
+          pointer = interface.get(pointer, key) || build_and_set(pointer, key)
+        end
+
+        interface.set(pointer, last_key, value)
+      end
+    end
+
+    def build_and_set(pointer, key)
+      interface.get(interface.set(pointer, key, pointer.class.new), key)
+    end
+  end
+end

data/lib/objectable/version.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+#
+# 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 Objectable
+  VERSION = '1.0.0'
+end

data/objectable.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require './lib/objectable/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'objectable'
+  s.version     = Objectable::VERSION
+  s.summary     = 'Unified get/set interface for disparate objects'
+
+  s.description = <<-DESCRIPTION
+  DESCRIPTION
+
+  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/objectable'
+  s.license     = 'MIT'
+
+  s.required_ruby_version = '>= 2.3.8'
+
+  s.add_development_dependency('guard-rspec', '~>4.7')
+  s.add_development_dependency('pry')
+  s.add_development_dependency('pry-byebug', '~> 3')
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('rubocop', '~> 0.63.1')
+  s.add_development_dependency('simplecov', '~>0.16.1')
+  s.add_development_dependency('simplecov-console', '~>0.4.2')
+end

data/spec/objectable/resolver_spec.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-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 'spec_helper'
+
+describe Objectable::Resolver do
+  subject { described_class.new }
+
+  context 'when input is a hash' do
+    let(:input) do
+      {
+        'id' => 1,
+        demographics: {
+          'first' => 'Matt'
+        }
+      }
+    end
+
+    describe '#get' do
+      it 'resolves correct value' do
+        expect(subject.get(input, :id)).to  eq(input['id'])
+        expect(subject.get(input, 'id')).to eq(input['id'])
+      end
+
+      it 'resolves correct value for nested objects' do
+        expect(subject.get(input, 'demographics.first')).to eq(input.dig(:demographics, 'first'))
+      end
+    end
+
+    describe '#set' do
+      it 'sets correct value' do
+        subject.set(input, :active, true)
+        expect(subject.get(input, :active)).to  be true
+        expect(subject.get(input, 'active')).to be true
+
+        subject.set(input, 'super_power', :thunder)
+        expect(subject.get(input, 'super_power')).to  eq(:thunder)
+        expect(subject.get(input, :super_power)).to   eq(:thunder)
+      end
+
+      it 'sets correct value for nested objects' do
+        subject.set(input, :'statuses.active', true)
+        expect(subject.get(input, 'statuses.active')).to  be true
+        expect(subject.get(input, :'statuses.active')).to be true
+
+        subject.set(input, 'powers.super_power', :thunder)
+        expect(subject.get(input, 'powers.super_power')).to   eq(:thunder)
+        expect(subject.get(input, :'powers.super_power')).to  eq(:thunder)
+
+        expect(subject.get(input, 'powers')).to eq('super_power' => :thunder)
+      end
+    end
+  end
+
+  context 'when input is an OpenStruct' do
+    let(:input) do
+      OpenStruct.new(
+        id: 1,
+        demographics: OpenStruct.new(
+          first: 'Matt'
+        )
+      )
+    end
+
+    describe '#get' do
+      it 'resolves correct value' do
+        expect(subject.get(input, :id)).to  eq(input.id)
+        expect(subject.get(input, 'id')).to eq(input.id)
+      end
+
+      it 'resolves correct value for nested objects' do
+        expect(subject.get(input, 'demographics.first')).to eq(input.demographics.first)
+      end
+    end
+
+    describe '#set' do
+      it 'sets correct value' do
+        subject.set(input, :active, true)
+        expect(subject.get(input, :active)).to  be true
+        expect(subject.get(input, 'active')).to be true
+
+        subject.set(input, 'super_power', :thunder)
+        expect(subject.get(input, 'super_power')).to  eq(:thunder)
+        expect(subject.get(input, :super_power)).to   eq(:thunder)
+      end
+
+      it 'sets overrides existing value' do
+        subject.set(input, :id, 999)
+        expect(subject.get(input, :id)).to  eq(999)
+        expect(subject.get(input, 'id')).to eq(999)
+
+        subject.set(input, 'id', 123)
+        expect(subject.get(input, :id)).to  eq(123)
+        expect(subject.get(input, 'id')).to eq(123)
+      end
+
+      it 'set correct value for nested objects' do
+        subject.set(input, :'statuses.active', true)
+        expect(subject.get(input, 'statuses.active')).to  be true
+        expect(subject.get(input, :'statuses.active')).to be true
+
+        subject.set(input, 'powers.super_power', :thunder)
+        expect(subject.get(input, 'powers.super_power')).to   eq(:thunder)
+        expect(subject.get(input, :'powers.super_power')).to  eq(:thunder)
+
+        expect(subject.get(input, 'powers')).to eq(OpenStruct.new('super_power' => :thunder))
+      end
+    end
+  end
+end

data/spec/objectable_spec.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+#
+# 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 './spec/spec_helper'
+
+describe Objectable do
+  describe '#resolver' do
+    specify 'with no arguments' do
+      resolver = described_class.resolver
+
+      expect(resolver).to be_a(Objectable::Resolver)
+      expect(resolver.separator).to eq('.')
+    end
+
+    specify 'with arguments' do
+      resolver1 = described_class.resolver(separator: '$')
+      resolver2 = described_class.resolver(separator: '$')
+
+      expect(resolver1).to eq(resolver2)
+      expect(resolver1.separator).to eq('$')
+      expect(resolver2.separator).to eq('$')
+    end
+  end
+
+  describe 'README examples' do
+    Employee      = Struct.new(:id, :demographics)
+    Demographics  = Struct.new(:first)
+
+    let(:symbol_based_hash) do
+      { id: 1, demographics: { first: 'Matt' } }
+    end
+
+    let(:string_based_hash) do
+      { 'id' => 1, 'demographics' => { 'first' => 'Matt' } }
+    end
+
+    let(:open_struct) do
+      OpenStruct.new(id: 1, demographics: OpenStruct.new(first: 'Matt'))
+    end
+
+    let(:object) do
+      Employee.new(1, Demographics.new('Matt'))
+    end
+
+    specify 'getting examples' do
+      resolver = Objectable.resolver
+
+      expect(resolver.get(symbol_based_hash, :id)).to eq(1)
+      expect(resolver.get(symbol_based_hash, 'id')).to eq(1)
+      expect(resolver.get(string_based_hash, :id)).to eq(1)
+      expect(resolver.get(string_based_hash, 'id')).to eq(1)
+      expect(resolver.get(open_struct, :id)).to eq(1)
+      expect(resolver.get(open_struct, 'id')).to eq(1)
+      expect(resolver.get(object, :id)).to eq(1)
+      expect(resolver.get(object, 'id')).to eq(1)
+
+      expect(resolver.get(symbol_based_hash, :'demographics.first')).to eq('Matt')
+      expect(resolver.get(symbol_based_hash, 'demographics.first')).to eq('Matt')
+      expect(resolver.get(string_based_hash, :'demographics.first')).to eq('Matt')
+      expect(resolver.get(string_based_hash, 'demographics.first')).to eq('Matt')
+      expect(resolver.get(open_struct, :'demographics.first')).to eq('Matt')
+      expect(resolver.get(open_struct, 'demographics.first')).to eq('Matt')
+      expect(resolver.get(object, :'demographics.first')).to eq('Matt')
+      expect(resolver.get(object, 'demographics.first')).to eq('Matt')
+    end
+
+    specify 'setting examples using symbols' do
+      resolver = Objectable.resolver
+
+      resolver.set(symbol_based_hash, :id, 999)
+      resolver.set(string_based_hash, :id, 999)
+      resolver.set(open_struct, :id, 999)
+      resolver.set(object, :id, 999)
+
+      expect(resolver.get(symbol_based_hash, :id)).to eq(999)
+      expect(resolver.get(symbol_based_hash, 'id')).to eq(999)
+      expect(resolver.get(string_based_hash, :id)).to eq(999)
+      expect(resolver.get(string_based_hash, 'id')).to eq(999)
+      expect(resolver.get(open_struct, :id)).to eq(999)
+      expect(resolver.get(open_struct, 'id')).to eq(999)
+      expect(resolver.get(object, :id)).to eq(999)
+      expect(resolver.get(object, 'id')).to eq(999)
+
+      resolver.set(symbol_based_hash, :'demographics.first', 'Nick')
+      resolver.set(string_based_hash, :'demographics.first', 'Nick')
+      resolver.set(open_struct, :'demographics.first', 'Nick')
+      resolver.set(object, :'demographics.first', 'Nick')
+
+      expect(resolver.get(symbol_based_hash, :'demographics.first')).to eq('Nick')
+      expect(resolver.get(symbol_based_hash, 'demographics.first')).to eq('Nick')
+      expect(resolver.get(string_based_hash, :'demographics.first')).to eq('Nick')
+      expect(resolver.get(string_based_hash, 'demographics.first')).to eq('Nick')
+      expect(resolver.get(open_struct, :'demographics.first')).to eq('Nick')
+      expect(resolver.get(open_struct, 'demographics.first')).to eq('Nick')
+      expect(resolver.get(object, :'demographics.first')).to eq('Nick')
+      expect(resolver.get(object, 'demographics.first')).to eq('Nick')
+    end
+
+    specify 'setting examples using strings' do
+      resolver = Objectable.resolver
+
+      resolver.set(symbol_based_hash, 'id', 999)
+      resolver.set(string_based_hash, 'id', 999)
+      resolver.set(open_struct, 'id', 999)
+      resolver.set(object, 'id', 999)
+
+      expect(resolver.get(symbol_based_hash, :id)).to eq(999)
+      expect(resolver.get(symbol_based_hash, 'id')).to eq(999)
+      expect(resolver.get(string_based_hash, :id)).to eq(999)
+      expect(resolver.get(string_based_hash, 'id')).to eq(999)
+      expect(resolver.get(open_struct, :id)).to eq(999)
+      expect(resolver.get(open_struct, 'id')).to eq(999)
+      expect(resolver.get(object, :id)).to eq(999)
+      expect(resolver.get(object, 'id')).to eq(999)
+
+      resolver.set(symbol_based_hash, 'demographics.first', 'Nick')
+      resolver.set(string_based_hash, 'demographics.first', 'Nick')
+      resolver.set(open_struct, 'demographics.first', 'Nick')
+      resolver.set(object, 'demographics.first', 'Nick')
+
+      expect(resolver.get(symbol_based_hash, :'demographics.first')).to eq('Nick')
+      expect(resolver.get(symbol_based_hash, 'demographics.first')).to eq('Nick')
+      expect(resolver.get(string_based_hash, :'demographics.first')).to eq('Nick')
+      expect(resolver.get(string_based_hash, 'demographics.first')).to eq('Nick')
+      expect(resolver.get(open_struct, :'demographics.first')).to eq('Nick')
+      expect(resolver.get(open_struct, 'demographics.first')).to eq('Nick')
+      expect(resolver.get(object, :'demographics.first')).to eq('Nick')
+      expect(resolver.get(object, 'demographics.first')).to eq('Nick')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+#
+# 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 'pry'
+require 'pry-byebug'
+
+unless ENV['DISABLE_SIMPLECOV'] == 'true'
+  require 'simplecov'
+  require 'simplecov-console'
+
+  SimpleCov.formatter = SimpleCov::Formatter::Console
+  SimpleCov.start do
+    add_filter %r{\A/spec/}
+  end
+end
+
+require './lib/objectable'

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: objectable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matthew Ruggio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+description: ''
+email:
+- mruggio@bluemarblepayroll.com
+executables:
+- console
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- lib/objectable.rb
+- lib/objectable/interface.rb
+- lib/objectable/resolver.rb
+- lib/objectable/version.rb
+- objectable.gemspec
+- spec/objectable/resolver_spec.rb
+- spec/objectable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bluemarblepayroll/objectable
+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.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Unified get/set interface for disparate objects
+test_files:
+- spec/objectable/resolver_spec.rb
+- spec/objectable_spec.rb
+- spec/spec_helper.rb