repository-support 0.1.1

data/bin/ldiff

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' 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", "ldiff")

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' 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("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' 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("rspec-core", "rspec")

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' 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("rubocop", "rubocop")

data/bin/ruby-parse

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'ruby-parse' 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("parser", "ruby-parse")

data/bin/ruby-rewrite

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'ruby-rewrite' 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("parser", "ruby-rewrite")

data/bin/setup

@@ -0,0 +1,36 @@
+#!/bin/bash
+
+# This works for MRI; it may or may not work for other Rubies.
+RUBY_VERSION=`ruby --version | cut -d ' ' -f 2 | sed 's/p.*//'`
+
+##
+## Initialise Gemset and setup if `rbenv` is available
+##
+
+rm -f Gemfile.lock .rbenv-gemsets
+
+if [[ `rbenv --version 2>/dev/null` ]]; then
+  rbenv gemset delete $RUBY_VERSION ./tmp/gemset 2>/dev/null || true
+  find ./tmp/gemset -delete 2>/dev/null || true
+  rbenv rehash
+  rbenv gemset active
+  rbenv gemset create $RUBY_VERSION ./tmp/gemset
+  echo ./tmp/gemset > .rbenv-gemsets
+  rbenv rehash
+fi
+
+##
+## Install Gems
+##
+
+gem install bundler --no-doc -v 1.16.1
+gem install yard -v 0.9.12
+yard config --gem-install-yri
+gem install json -v 2.1.0
+gem install activemodel -v 4.2.10
+gem install rake -v 12.3.0
+gem install rspec -v 3.7.0
+gem install rubocop -v 0.52.1
+gem install simplecov -v 0.15.1
+gem install awesome_print -v 1.8.0
+bundle install --binstubs --local

data/lib/repository/support.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'repository/support/version'
+
+require 'repository/support/error_factory'
+require 'repository/support/result_builder'
+require 'repository/support/store_result'
+require 'repository/support/test_attribute_container'
+
+# Support classes for Repository::Base and subclasses.
+module Repository
+  # Support classes for Repository::Base and subclasses.
+  module Support
+  end
+end

data/lib/repository/support/error_factory.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Support classes for Repository::Base and subclasses.
+module Repository
+  # Support classes for Repository::Base and subclasses.
+  module Support
+    # Factory for our funky error-info hashes.
+    class ErrorFactory
+      class << self
+        def create(errors)
+          errors.map do |field, message|
+            { field: field.to_s, message: message }
+          end
+        end
+      end
+    end # class Repository::Support::ErrorFactory
+  end
+end

data/lib/repository/support/result_builder.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'store_result'
+
+module Repository
+  module Support
+    # Builds a successful or failed StoreResult depending on a record existing.
+    class ResultBuilder
+      def initialize(record)
+        @record = record
+      end
+
+      def build(&_block)
+        return successful_result if record
+        failed_result yield(record)
+      end
+
+      private
+
+      attr_reader :record
+
+      def failed_result(errors)
+        StoreResult::Failure.new errors
+      end
+
+      def successful_result
+        StoreResult::Success.new record
+      end
+    end # class Repository::Support::ResultBuilder
+  end
+end

data/lib/repository/support/store_result.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Repository
+  module Support
+    # Uniform representation of success or failure of a storage-command action.
+    class StoreResult
+      # Convenience class to instantiate a "successful" StoreResult.
+      class Success < StoreResult
+        def initialize(entity)
+          super entity: entity, errors: [], success: true
+        end
+      end # class Repository::Support::StoreResult::Success
+
+      # Convenience class to instantiate a "failed" StoreResult.
+      class Failure < StoreResult
+        def initialize(errors)
+          super entity: nil, errors: errors, success: false
+        end
+      end # class Repository::Support::StoreResult::Failure
+
+      attr_reader :entity, :errors, :success
+      alias_method :success?, :success # rubocop:disable Style/Alias
+
+      def initialize(entity:, errors:, success:)
+        @entity = entity
+        @errors = errors
+        @success = success
+      end
+    end # class Repository::Support::StoreResult
+  end
+end

data/lib/repository/support/test_attribute_container.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# Support classes for Repository::Base and subclasses.
+module Repository
+  # Support classes for Repository::Base and subclasses.
+  module Support
+    # Adds :attributes property to caller, and enhanced attribute getter/setter.
+    module TestAttributeContainer
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/MethodLength
+      def init_empty_attribute_container
+        define_method :attributes do
+          @attributes ||= {}
+        end
+
+        define_method(:attributes=) do |attribs|
+          @attributes = attribs.to_h
+        end
+
+        define_method(:method_missing) do |method_sym, *arguments, &block|
+          method_or_type = attribute_key_for?(method_sym)
+          case method_or_type
+          when :none
+            super method_sym, arguments, block
+          when :reader
+            attributes[method_sym]
+          else
+            attributes[method_or_type] = arguments.first
+          end
+        end
+
+        define_method(:respond_to?) do |method_sym, include_private = false|
+          return true unless attribute_key_for?(method_sym) == :none
+          super method_sym, include_private
+        end
+
+        # private
+        define_method(:attribute_key_for?) do |key_sym|
+          if attributes.to_h.key? key_sym
+            :reader
+          else
+            setter_for_or_none(key_sym)
+          end
+        end
+
+        # private
+        define_method :setter_for_or_none do |key|
+          match = key.to_s.match(/(\S+?)=/)
+          has_setter = match && attributes.key?(match[1].to_sym)
+          has_setter ? match[1].to_sym : :none
+        end
+        instance_eval { private :attribute_key_for?, :setter_for_or_none }
+        self
+      end # end method .init_empty_attribute_container
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/AbcSize
+      self
+    end # module Repository::Support::TestAttributeContainer
+  end
+end

data/lib/repository/support/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# :nocov:
+module Repository
+  module Support
+    VERSION = '0.1.1'
+  end
+end
+# :nocov:

data/repository-support.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'repository/support/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'repository-support'
+  spec.version       = Repository::Support::VERSION
+  spec.authors       = ['Jeff Dickey']
+  spec.email         = ['jdickey@seven-sigma.com']
+  spec.summary       = %q{Support classes for Repository::Base and subclasses.}
+  spec.description   = %q{Support classes for Repository::Base and subclasses.}
+  spec.homepage      = 'https://github.com/jdickey/repository-support'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  # This Gem installs no executables of its own, and developer stubs for bin/setup will be overwritten
+  # spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.4.0'
+
+  spec.add_dependency 'activemodel', '~> 4.2', '>= 4.2.10'
+
+  spec.add_development_dependency 'bundler', '~> 1.16' # '10.5.0'
+  spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.0'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'rubocop', '~> 0.52', '>= 0.52.1'
+  spec.add_development_dependency 'simplecov', '~> 0.15', '>= 0.15.1'
+  spec.add_development_dependency 'awesome_print', '>= 1.8.0'
+#  spec.add_development_dependency 'pry-byebug'
+end

data/spec/repository/support/error_factory_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'active_model'
+
+describe Repository::Support::ErrorFactory do
+  it 'has a .create class method' do
+    expect { described_class.method :create }.not_to raise_error
+  end
+
+  describe 'has a .create class method that, when called' do
+    let(:errors) { ActiveModel::Errors.new self }
+    let(:actual) { described_class.create errors }
+
+    context 'with an empty Errors object' do
+      it 'returns an empty array' do
+        expect(actual).to respond_to :to_ary
+        expect(actual).to be_empty
+      end
+    end # context 'with an empty Errors object'
+
+    context 'with an Errors object containing errors' do
+      let(:samples) do
+        [
+          { field: 'field1', message: 'is invalid' },
+          { field: 'field1', message: 'is empty or blank' },
+          { field: 'field2', message: 'is :field2' }
+        ]
+      end
+
+      before :each do
+        samples.each { |sample| errors.add sample[:field], sample[:message] }
+      end
+
+      it 'returns an array with the correct error hashes' do
+        expect(actual).to eq samples
+      end
+    end # context 'with an Errors object containing errors'
+  end # describe 'has a .create class method that, when called'
+end # describe Repository::Support::ErrorFactory