repository-support 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d697e19788520158f868c0deeaadb25da7d12ea3001cca38f3efc6b0c8fe7bf0
+  data.tar.gz: 37116b8077c2e96418351ddc3fa87058b1ca8d1846039e74fb1a86ba444518c6
+SHA512:
+  metadata.gz: fba43d8df0a90410ae0d78c1afff9ca525c2f674aaaffb215db11eb365efb99f944323f7cb97846c1102f5c3c1153e2e3af11667bafe2563d43436534512448e
+  data.tar.gz: e70d253855608257ab9b4bcf354d70421ae35c8cc163e04ad902f7856817664f0780bf7ad7a37d9a475fbca0eb78279ac376ab944e42669c6aae0919b1cba1c1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rbenv-gemsets

@@ -0,0 +1 @@
+./tmp/gemset

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,24 @@
+
+AllCops:
+  TargetRubyVersion: 2.5
+
+Metrics/BlockLength:
+  Max: 300
+  Include:
+    - 'spec/**/*_spec.rb'
+
+Metrics/ModuleLength:
+  Max: 300
+  Include:
+    - 'spec/**/*_spec.rb'
+
+Style/CommentedKeyword:
+  Enabled: false
+
+# This silences 'Missing top-level class documentation comment.', which we
+# particularly want to do on (initially-)generated files.
+Style/Documentation:
+  Enabled: false
+  Include:
+    - 'apps/**/*.rb'
+    - 'lib/**/*.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.5
+  - 2.2.1
+  - jruby-9.0.0.0.pre1
+  # - rbx
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in repository-support.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jeff Dickey
+
+MIT License
+
+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,204 @@
+<h1>Repository::Support</h1>
+
+[![Gem Version](https://badge.fury.io/rb/repository-support.svg)](http://badge.fury.io/rb/repository-support)
+[![Code Climate](https://codeclimate.com/github/jdickey/repository-support/badges/gpa.svg)](https://codeclimate.com/github/jdickey/repository-support)
+[ ![Codeship Status for jdickey/repository-support](https://codeship.com/projects/224d6180-997e-0132-c9c3-165733f17d49/status?branch=master)](https://codeship.com/projects/63652)
+[![security](https://hakiri.io/github/jdickey/repository-support/master.svg)](https://hakiri.io/github/jdickey/repository-support/master)
+[![Dependency Status](https://gemnasium.com/jdickey/repository-support.svg)](https://gemnasium.com/jdickey/repository-support)
+
+<h2>Contents</h2>
+
+- [Overview](#overview)
+- [IMPORTANT LEGACY NOTICE](#important-legacy-notice)
+- [Installation](#installation)
+- [Usage](#usage)
+  * [`StoreResult`](#storeresult)
+    + [`StoreResult::Success`](#storeresultsuccess)
+    + [`StoreResult::Failure`](#storeresultfailure)
+  * [`ErrorFactory`](#errorfactory)
+  * [`TestAttributeContainer`](#testattributecontainer)
+  * [A Note on Parameters](#a-note-on-parameters)
+- [Contributing](#contributing)
+- [Version History](#version-history)
+- [Legal](#legal)
+
+## Overview
+
+This Gem provides several support classes and modules for
+[`Repository::Base`](https://github.com/jdickey/repository-base) and its
+user-created subclasses, which implement the Repository layer of a typical Data
+Mapper pattern architecture.
+
+These classes and modules are:
+
+* `ErrorFactory` provides a single class method, `.create` which, when supplied with an `ActiveModel::Errors`-quacking object as a parameter, produces an Array of Hashes containing JSON-compatible error information;
+* `ResultBuilder` is a Command-pattern class whose `#initialize` method takes one parameter and whose `#build` method evaluates that value. If it is truthy, then `#build` returns a `StoreResult::Success` (see below) with that value as its "paylaaod". If the value is falsy, then `#build` returns a `StoreResult#Failure`, yielding the value to a block that returns the payload for the `StoreResult`.
+* `StoreResult` is a simple value object with three accessors for values passed in to the `#initialize` method: namely `#entity` (some value object); `#success` (a Boolean, aliased as `#success?`); and `#errors` an Array of error records as created by `ErrorFactory.create`. It has two subclasses: `StoreResult::Success` fills in a `StoreResult` using its single parameter (the entity) and defaults for the other fields; and `StoreResult::Failure`, which does likewise initialised with an array of error hashes.
+* `TestAttributeContainer` is a module that, when used to extend a class, adds an `attributes` Hash property (reader and writer) to the extending class. While `attributes` is initially empty, it may be added to either by defining a single key, or by mass-assigning a Hash to `attributes`. Once an individual "attribute" is defined for a class instance, it can be read from or written to using a direct method on that instance. See the discussion in "Usage" below for more details.
+
+## IMPORTANT LEGACY NOTICE
+
+**_NOTICE!_** This Gem was created to support a solo, ad-hoc, early learning experience in what is now known as Clean Architecture. It was part of our first attempt to build an alternative to the ActiveRecord/ActiveModel scheme native to Ruby on Rails.
+
+As such, it has been superseded and far outshone by other, team efforts, notably [ROM](http://rom-rb.org/) as used with [Hanami](http://hanamirb.org/) and [Trailblazer](http://trailblazer.to/). You are *strongly advised* to examine these and other tools rather than to use this for *any* new development. The Gem is being republished as an 0.1.0 release purely for internal archaeologigical purposes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'repository-support'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install repository-support
+
+## Usage
+
+### `StoreResult`
+
+`StoreReult` is used as the return value from all `Repository::Base` instance
+methods (actions) *except* `#all`.
+
+If the action implemented by the method was successful, it returns a
+`StoreResult` where
+
+* the `entity` attribute is an entity matching the state of the record persisted or accessed by the action;
+* the `success` attribute (or `#success?` method) is `true`; and
+* the `errors` attribute is an empty Array.
+
+If the action was unsuccessful, the repository method returns a `StoreResult`
+where
+
+* the `entity` attribute is `nil`;
+* the `success` attribute (or `#success?` method) is `false`; and
+* the `errors` attribute contains one error Hash for each error preventing the action from succeeding.
+
+#### `StoreResult::Success`
+
+This subclass of `StoreResult` is a convenience for initialising a successful
+`StoreResult`. Its `#initialize` method takes a single parameter, the entity to
+be used in the result, with the other fields set as described above for a
+successful result.
+
+#### `StoreResult::Failure`
+
+This subclass of `StoreResult` is a convenience for initialising an unsuccessful
+`StoreResult`. Its `#initialize` method takes a single parameter, the Array of
+error hashes to be used in the result, with the other fields set as described
+above for an unsuccessful result.
+
+### `ErrorFactory`
+
+This class has a single class method, `.create`. Given a parameter value that
+quacks as an[`ActiveModel::Errors`](http://api.rubyonrails.org/classes/ActiveModel/Errors.html)
+instance, it returns an Array where each item is a Hash derived from each error
+reported by the parameter object, or an empty Array if there are no errors. Each
+Hash in the Array has two fields:
+
+1. `field`, which contains the attribute passed to [`ActiveModel::Errors#add`](http://api.rubyonrails.org/classes/ActiveModel/Errors.html#method-i-add) *as a string*; and
+1. `message`, which contains the message as passed into the same `#add` call.
+
+So, given an `ActiveModel::Errors` object that resulted from the following code:
+
+```ruby
+  errors = ActiveModel::Errors.new self
+  # ...
+  errors.add :frobulator, 'does not frob'
+  errors.add :frobulator, `is busted'
+  errors.add :foo, 'is :foo'
+  # ...
+  error_data = ErrorFactory.create errors
+  @logger.log error_data
+```
+
+the value of `error_data` written to the log would be (formatted for clarity)
+
+```
+[
+  {field: 'frobulator', message: 'does not frob'},
+  {field: 'frobulator', message: 'is busted'},
+  {field: 'foo', 'is :foo'}
+]
+```
+
+Note that no guarantees are made for ordering, just as seems to be the case for
+`ActiveModel::Errors`.
+
+### `TestAttributeContainer`
+
+This module implements support for attributes in a way that can be thought of as "halfway between a [`Struct`](http://ruby-doc.org//core-2.1.5/Struct.html) and an [`OpenStruct`](http://ruby-doc.org/stdlib-2.1.5/libdoc/ostruct/rdoc/OpenStruct.html) or [`FancyOpenStruct`](https://github.com/tomchapin/fancy-open-struct/)."
+
+By extending a class with the module and invoking the `init_empty_attribute_container` class method within that class, a Hash is added as the `attributes` attribute of each instance of that class. It can be assigned to directly; once having done so, individual "attributes" may be accessed *or modified* through a method call using the name of the attribute.
+
+For example:
+
+```ruby
+class Foo
+  extend Repository::Support::TestAttributeContainer
+
+  init_empty_attribute_container
+end
+
+# interactively
+foo = Foo.new
+# => #<Foo:0x007fd2b4b9da28>
+foo.attributes
+# => {}
+foo.attributes = { foo: true, bar: 42 }
+# => {:foo=>true, :bar=>42}
+foo.foo
+# => true
+foo.foo = :whatever_you_want
+# => :whatever_you_want
+foo.attributes
+# => {:foo=>:whatever_you_want, :bar=>42}
+foo.quux
+# => NoMethodError: undefined method `quux' # ...
+foo.attributes[:quux] = 'hello'
+# => "hello"
+foo.quux
+# => "hello"
+```
+
+To create a new attribute after the container has been set up, assign to a new key in the `attributes` property Hash. As demonstrated above, the "attribute" can then be accessed or modified by using its name as a reader or writer method name. Without explicitly assigning to `attributes`, however, undefined methods raise errors as usual.
+
+### A Note on Parameters
+
+All *public* methods having multiple arguments (including `#initialize`) in each
+of the classes defined above use the keyword-argument specification introduced
+in Ruby 2.0. By removing order dependency of arguments, inadvertent-reordering
+errors are no longer a
+[hunt-the-typo](http://en.wikipedia.org/wiki/Hunt_the_Wumpus)
+exercise. This rule *does not* apply to single-parameter methods, nor to
+`private` methods.
+
+## Contributing
+
+1. Fork it ( https://github.com/jdickey/repository-support/fork )
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Ensure that your changes are completely covered by *passing* specs, and comply with the [Ruby Style Guide](https://github.com/bbatsov/ruby-style-guide) as enforced by [RuboCop](https://github.com/bbatsov/rubocop). To verify this, run `bundle exec rake`, noting and repairing any lapses in coverage or style violations;
+1. Commit your changes (`git commit -a`). Please *do not* use a single-line commit message (`git commit -am "some message"`). A good commit message notes what was changed and why in sufficient detail that a relative newcomer to the code can understand your reasoning and your code;
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create a new Pull Request. Describe at some length the rationale for your new feature; your implementation strategy at a higher level than each individual commit message; anything future maintainers should be aware of; and so on. *If this is a modification to existing code, reference the open issue being addressed*.
+1. Don't be discouraged if the PR generates a discussion that leads to further refinement of your PR through additional commits. These should *generally* be discussed in comments on the PR itself; discussion in the Gitter room (see below) may also be useful;
+1. If you've comments, questions, or just want to talk through your ideas, don't hesitate to hang out in the `Repository::Base` [room on Gitter](https://gitter.im/jdickey/repository-base). Ask away!
+
+## Version History
+
+| Version | Date | Notes |
+| ------- | ---- | ----- |
+| v0.1.0 | 2 February 2018 | Changed MRI supported version from 2.2.2 to 2.5.0; **published legacy notice** |
+| v0.0.4 | 9 March 2015 | Added experimental, one-off JRuby 9000 support |
+| v0.0.3 | 21 February 2015 | Completed initial feature development |
+| v0.0.2 | 18 February 2015 | Internal; incremental feature development |
+| v0.0.1 | 18 February 2015 | Internal; incremental feature development |
+
+## Legal
+
+This document and the accompanying code are Copyright &copy; 2015-2018 by Jeff Dickey/Seven Sigma Agility, and are released under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,20 @@
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = [
+    'lib/**/*.rb',
+    'spec/spec_helper.rb',
+    'spec/**/*_spec.rb'
+  ]
+  task.formatters = ['simple', 'd']
+  task.fail_on_error = true
+  task.options << '--rails'
+end
+
+RSpec::Core::RakeTask.new :spec
+
+task(:default).clear
+task default: [:spec, :rubocop]

data/bin/bundle

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bundle' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "rubygems"
+
+m = Module.new do
+    module_function
+
+  def invoked_as_script?
+    File.expand_path($0) == File.expand_path(__FILE__)
+  end
+
+  def env_var_version
+    ENV["BUNDLER_VERSION"]
+  end
+
+  def cli_arg_version
+    return unless invoked_as_script? # don't want to hijack other binstubs
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
+    bundler_version = nil
+    update_index = nil
+    ARGV.each_with_index do |a, i|
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
+      next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
+      bundler_version = $1 || ">= 0.a"
+      update_index = i
+    end
+    bundler_version
+  end
+
+  def gemfile
+    gemfile = ENV["BUNDLE_GEMFILE"]
+    return gemfile if gemfile && !gemfile.empty?
+
+    File.expand_path("../../Gemfile", __FILE__)
+  end
+
+  def lockfile
+    lockfile =
+      case File.basename(gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
+      else "#{gemfile}.lock"
+      end
+    File.expand_path(lockfile)
+  end
+
+  def lockfile_version
+    return unless File.file?(lockfile)
+    lockfile_contents = File.read(lockfile)
+    return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
+    Regexp.last_match(1)
+  end
+
+  def bundler_version
+    @bundler_version ||= begin
+      env_var_version || cli_arg_version ||
+        lockfile_version || "#{Gem::Requirement.default}.a"
+    end
+  end
+
+  def load_bundler!
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
+
+    # must dup string for RG < 1.8 compatibility
+    activate_bundler(bundler_version.dup)
+  end
+
+  def activate_bundler(bundler_version)
+    if Gem::Version.correct?(bundler_version) && Gem::Version.new(bundler_version).release < Gem::Version.new("2.0")
+      bundler_version = "< 2"
+    end
+    gem_error = activation_error_handling do
+      gem "bundler", bundler_version
+    end
+    return if gem_error.nil?
+    require_error = activation_error_handling do
+      require "bundler/version"
+    end
+    return if require_error.nil? && Gem::Requirement.new(bundler_version).satisfied_by?(Gem::Version.new(Bundler::VERSION))
+    warn "Activating bundler (#{bundler_version}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_version}'`"
+    exit 42
+  end
+
+  def activation_error_handling
+    yield
+    nil
+  rescue StandardError, LoadError => e
+    e
+  end
+end
+
+m.load_bundler!
+
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/bin/bundler

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'bundler' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('bundler', 'bundler')

data/bin/htmldiff

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 150) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("diff-lcs", "htmldiff")