isomorphic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb66cf9f00f2000d639046e108691ee363a55597
+  data.tar.gz: 8a48219b9e729e869346d7a69cb11f894986ca0b
+SHA512:
+  metadata.gz: 56fc30f14036d40d50ab7b5e57cda670b6e032a31efd6b783c6d64b8b68b02cd1027f1a9b9b3fdca8856a88add40386ce2457ecd4ead14d0f56214484cc8387d
+  data.tar.gz: 4d9764956509e58bfb72feebcb887cf716b5316b3646a0dfcf2247c72bb956363af6018fb40fcd3716c4c6cea47c2b59554225063be4396066c7578e68b841d0

data/.gitignore

@@ -0,0 +1,53 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in isomorphic.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,32 @@
+isomorphic
+
+Copyright (c) 2019, Battelle Memorial Institute
+All rights reserved.
+
+1. Battelle Memorial Institute (hereinafter Battelle) hereby grants permission
+   to any person or entity lawfully obtaining a copy of this software and
+   associated documentation files (hereinafter "the Software") to redistribute
+   and use the Software in source and binary forms, with or without
+   modification.  Such person or entity may use, copy, modify, merge, publish,
+   distribute, sublicense, and/or sell copies of the Software, and may permit
+   others to do so, subject to the following conditions:
+
+   * Redistributions of source code must retain the above copyright notice, this
+     list of conditions and the following disclaimers.
+   * Redistributions in binary form must reproduce the above copyright notice,
+     this list of conditions and the following disclaimer in the documentation
+     and/or other materials provided with the distribution.
+   * Other than as used herein, neither the name Battelle Memorial Institute or
+     Battelle may be used in any form whatsoever without the express written
+     consent of Battelle.
+
+2. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL BATTELLE OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,228 @@
+# isomorphic
+
+Isomorphic is a Ruby library for specifying isomorphisms between Ruby objects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'isomorphic'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install isomorphic
+
+## Usage
+
+In this example, we demonstrate how to use Isomorphic to specify an isomorphism between a Ruby on Rails model and a non-trivial `module`/`class` definition: [BuildingSync](https://buildingsync.net), an XML schema for building energy audit data.
+
+We begin with the definition of the Ruby on Rails model:
+```ruby
+class Address < ActiveRecord::Base
+  validates_presence_of :street_address, :city, :state, :postal_code
+end
+```
+
+Our goal is to map instances of the Ruby on Rails model to/from the `<auc:Address>` XML element in [BuildingSync](https://buildingsync.net).
+
+The [`soap4r`](https://github.com/rubyjedi/soap4r) gem provides the [`xsd2ruby.rb`](https://github.com/rubyjedi/soap4r/blob/master/bin/xsd2ruby.rb) binary for auto-generating Ruby code from an XML schema document.
+
+An excerpt of the auto-generated Ruby code for [BuildingSync](https://buildingsync.net) is as follows:
+```ruby
+module BuildingSync
+  # {http://buildingsync.net/schemas/bedes-auc/2019}Address
+  #   streetAddressDetail - BuildingSync::Address::StreetAddressDetail
+  #   city - SOAP::SOAPString
+  #   state - BuildingSync::State
+  #   postalCode - SOAP::SOAPString
+  #   postalCodePlus4 - SOAP::SOAPString
+  #   county - SOAP::SOAPString
+  #   country - SOAP::SOAPString
+  class Address
+
+    # inner class for member: StreetAddressDetail
+    # {http://buildingsync.net/schemas/bedes-auc/2019}StreetAddressDetail
+    #   simplified - BuildingSync::Address::StreetAddressDetail::Simplified
+    #   complex - BuildingSync::Address::StreetAddressDetail::Complex
+    class StreetAddressDetail
+
+      # inner class for member: Simplified
+      # {http://buildingsync.net/schemas/bedes-auc/2019}Simplified
+      #   streetAddress - SOAP::SOAPString
+      #   streetAdditionalInfo - SOAP::SOAPString
+      class Simplified
+        attr_accessor :streetAddress
+        attr_accessor :streetAdditionalInfo
+
+        def initialize(streetAddress = nil, streetAdditionalInfo = nil)
+          @streetAddress = streetAddress
+          @streetAdditionalInfo = streetAdditionalInfo
+        end
+      end
+
+      # inner class for member: Complex
+      # {http://buildingsync.net/schemas/bedes-auc/2019}Complex
+      #   streetNumberPrefix - SOAP::SOAPString
+      #   streetNumberNumeric - BuildingSync::Address::StreetAddressDetail::Complex::StreetNumberNumeric
+      #   streetNumberSuffix - SOAP::SOAPString
+      #   streetDirPrefix - SOAP::SOAPString
+      #   streetName - SOAP::SOAPString
+      #   streetAdditionalInfo - SOAP::SOAPString
+      #   streetSuffix - SOAP::SOAPString
+      #   streetSuffixModifier - SOAP::SOAPString
+      #   streetDirSuffix - SOAP::SOAPString
+      #   subaddressType - SOAP::SOAPString
+      #   subaddressIdentifier - SOAP::SOAPString
+      class Complex
+
+        # inner class for member: StreetNumberNumeric
+        # {http://buildingsync.net/schemas/bedes-auc/2019}StreetNumberNumeric
+        #   xmlattr_Source - SOAP::SOAPString
+        class StreetNumberNumeric < ::String
+          AttrSource = XSD::QName.new("http://buildingsync.net/schemas/bedes-auc/2019", "Source")
+
+          def __xmlattr
+            @__xmlattr ||= {}
+          end
+
+          def xmlattr_Source
+            __xmlattr[AttrSource]
+          end
+
+          def xmlattr_Source=(value)
+            __xmlattr[AttrSource] = value
+          end
+
+          def initialize(*arg)
+            super
+            @__xmlattr = {}
+          end
+        end
+
+        attr_accessor :streetNumberPrefix
+        attr_accessor :streetNumberNumeric
+        attr_accessor :streetNumberSuffix
+        attr_accessor :streetDirPrefix
+        attr_accessor :streetName
+        attr_accessor :streetAdditionalInfo
+        attr_accessor :streetSuffix
+        attr_accessor :streetSuffixModifier
+        attr_accessor :streetDirSuffix
+        attr_accessor :subaddressType
+        attr_accessor :subaddressIdentifier
+
+        def initialize(streetNumberPrefix = nil, streetNumberNumeric = nil, streetNumberSuffix = nil, streetDirPrefix = nil, streetName = nil, streetAdditionalInfo = nil, streetSuffix = nil, streetSuffixModifier = nil, streetDirSuffix = nil, subaddressType = nil, subaddressIdentifier = nil)
+          @streetNumberPrefix = streetNumberPrefix
+          @streetNumberNumeric = streetNumberNumeric
+          @streetNumberSuffix = streetNumberSuffix
+          @streetDirPrefix = streetDirPrefix
+          @streetName = streetName
+          @streetAdditionalInfo = streetAdditionalInfo
+          @streetSuffix = streetSuffix
+          @streetSuffixModifier = streetSuffixModifier
+          @streetDirSuffix = streetDirSuffix
+          @subaddressType = subaddressType
+          @subaddressIdentifier = subaddressIdentifier
+        end
+      end
+
+      attr_accessor :simplified
+      attr_accessor :complex
+
+      def initialize(simplified = nil, complex = nil)
+        @simplified = simplified
+        @complex = complex
+      end
+    end
+
+    attr_accessor :streetAddressDetail
+    attr_accessor :city
+    attr_accessor :state
+    attr_accessor :postalCode
+    attr_accessor :postalCodePlus4
+    attr_accessor :county
+    attr_accessor :country
+
+    def initialize(streetAddressDetail = nil, city = nil, state = nil, postalCode = nil, postalCodePlus4 = nil, county = nil, country = nil)
+      @streetAddressDetail = streetAddressDetail
+      @city = city
+      @state = state
+      @postalCode = postalCode
+      @postalCodePlus4 = postalCodePlus4
+      @county = county
+      @country = country
+    end
+  end
+end
+```
+
+First, we define a factory:
+```ruby
+class BuildingSyncFactory < Isomorphic::Factory::AbstractFactory
+  include Singleton
+
+  def initialize
+    super(BuildingSync)
+  end
+end
+```
+
+Next, we define an inflector:
+```ruby
+class BuildingSyncInflector < Isomorphic::Factory::AbstractInflector
+  include Singleton
+
+  def initialize
+    super(BuildingSync)
+  end
+end
+```
+
+Finally, we declare the isomorphism using the domain-specific language:
+```ruby
+class Address < ActiveRecord::Base
+  validates_presence_of :street_address, :city, :state, :postal_code
+
+  include Isomorphic::Model
+
+  isomorphism_for(BuildingSyncFactory.instance, BuildingSyncInflector.instance, BuildingSync::Address) do
+    member :streetAddressDetail, BuildingSync::Address::StreetAddressDetail do
+      member :simplified, BuildingSync::Address::StreetAddressDetail::Simplified do
+        attribute_for reflect_on_attribute(:street_address), :streetAddress
+      end
+    end
+    attribute_for reflect_on_attribute(:city), :city
+    attribute_for reflect_on_attribute(:state), :state
+    attribute_for reflect_on_attribute(:postal_code), :postalCode
+  end
+end
+```
+
+Now, we can map instances of the Ruby on Rails model to/from the `<auc:Address>` XML element in [BuildingSync](https://buildingsync.net):
+```ruby
+orig_record = Address.new(street_address: '123 Fake Street', city: 'York', state: 'PA', postal_code: '17402')
+
+building_sync_address = orig_record.to_building_sync_address
+
+new_record = Address.from_building_sync_address(building_sync_address)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then 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).
+
+## License
+
+[The 2-Clause BSD License](https://opensource.org/licenses/BSD-2-Clause)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pnnl/isomorphic.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/WARRANTY.txt

@@ -0,0 +1,22 @@
+This material was prepared as an account of work sponsored by an agency of the
+United States Government.  Neither the United States Government nor the United
+States Department of Energy, nor Battelle, nor any of their employees, nor any
+jurisdiction or organization that has cooperated in the development of these
+materials, makes any warranty, express or implied, or assumes any legal
+liability or responsibility for the accuracy, completeness, or usefulness or any
+information, apparatus, product, software, or process disclosed, or represents
+that its use would not infringe privately owned rights.
+
+Reference herein to any specific commercial product, process, or service by
+trade name, trademark, manufacturer, or otherwise does not necessarily
+constitute or imply its endorsement, recommendation, or favoring by the United
+States Government or any agency thereof, or Battelle Memorial Institute. The
+views and opinions of authors expressed herein do not necessarily state or
+reflect those of the United States Government or any agency thereof.
+
+                      PACIFIC NORTHWEST NATIONAL LABORATORY
+                                   operated by
+                                    BATTELLE
+                                     for the
+                       UNITED STATES DEPARTMENT OF ENERGY
+                        under Contract DE-AC05-76RL01830

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "isomorphic"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/isomorphic.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "isomorphic/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "isomorphic"
+  spec.version       = Isomorphic::VERSION
+  spec.authors       = ["Mark Borkum"]
+  spec.email         = ["mark.borkum@pnnl.gov"]
+
+  spec.summary       = %q{Reversible morphisms between Ruby objects.}
+  spec.description   = %q{Isomorphic is a Ruby library for specifying isomorphisms between Ruby objects.}
+  spec.homepage      = "https://github.com/pnnl/isomorphic"
+
+  # # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 4.2.11"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/isomorphic.rb

@@ -0,0 +1,13 @@
+require "isomorphic/version"
+
+module Isomorphic
+  extend ::ActiveSupport::Autoload
+
+  autoload :Factory,                   "isomorphic/factory"
+  autoload :HashWithIndifferentAccess, "isomorphic/hash_with_indifferent_access"
+  autoload :Inflector,                 "isomorphic/inflector"
+  autoload :Lens,                      "isomorphic/lens"
+  autoload :Memoization,               "isomorphic/memoization"
+  autoload :Model,                     "isomorphic/model"
+  autoload :Node,                      "isomorphic/node"
+end

data/lib/isomorphic/errors.rb

@@ -0,0 +1,20 @@
+module Isomorphic
+  # Generic base class for all Isomorphic errors.
+  #
+  # @abstract
+  class IsomorphicError < ::StandardError
+    # @!attribute [r] base
+    #   @return [Module] the base module
+    attr_reader :base
+
+    # Default constructor.
+    #
+    # @param message [String] the message
+    # @param base [Module] the base module
+    def initialize(message = nil, base)
+      @base = base
+
+      super(message)
+    end
+  end
+end