RubyGems - repository-base - Versions diffs - 0.4.0 - Mend

repository-base 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (57) hide show

checksums.yaml +7 -0
data/.gitignore +15 -0
data/.rspec +2 -0
data/.rubocop.yml +27 -0
data/.travis.yml +6 -0
data/.yardopts +1 -0
data/CHANGELOG.md +128 -0
data/Gemfile +4 -0
data/LICENSE +22 -0
data/README.md +132 -0
data/Rakefile +33 -0
data/bin/bundle +105 -0
data/bin/htmldiff +29 -0
data/bin/kramdown +29 -0
data/bin/ldiff +29 -0
data/bin/rake +29 -0
data/bin/rspec +29 -0
data/bin/rubocop +29 -0
data/bin/ruby-parse +29 -0
data/bin/ruby-rewrite +29 -0
data/bin/setup +43 -0
data/bin/yard +29 -0
data/bin/yardoc +29 -0
data/bin/yri +29 -0
data/doc/Repository.html +128 -0
data/doc/Repository/Base.html +1248 -0
data/doc/Repository/Base/Internals.html +133 -0
data/doc/Repository/Base/Internals/RecordDeleter.html +687 -0
data/doc/Repository/Base/Internals/RecordSaver.html +816 -0
data/doc/Repository/Base/Internals/RecordUpdater.html +1026 -0
data/doc/Repository/Base/Internals/SlugFinder.html +986 -0
data/doc/_index.html +176 -0
data/doc/class_list.html +51 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +58 -0
data/doc/css/style.css +499 -0
data/doc/file.CHANGELOG.html +240 -0
data/doc/file.README.html +218 -0
data/doc/file_list.html +61 -0
data/doc/frames.html +17 -0
data/doc/index.html +218 -0
data/doc/js/app.js +248 -0
data/doc/js/full_list.js +216 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +363 -0
data/doc/top-level-namespace.html +110 -0
data/lib/repository/base.rb +115 -0
data/lib/repository/base/internals/internals.rb +6 -0
data/lib/repository/base/internals/record_deleter.rb +46 -0
data/lib/repository/base/internals/record_saver.rb +58 -0
data/lib/repository/base/internals/record_updater.rb +54 -0
data/lib/repository/base/internals/slug_finder.rb +70 -0
data/lib/repository/base/version.rb +12 -0
data/repository-base.gemspec +37 -0
data/spec/repository/base_spec.rb +398 -0
data/spec/spec_helper.rb +14 -0
metadata +281 -0

data/doc/top-level-namespace.html ADDED

@@ -0,0 +1,110 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.9.12
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Top Level Namespace
+</h1>
+<div class="box_info">
+</div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Repository.html" title="Repository (module)">Repository</a></span>
+</p>
+</div>
+      <div id="footer">
+  Generated on Sat Feb  3 03:00:17 2018 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.12 (ruby-2.5.0).
+</div>
+    </div>
+  </body>
+</html>

data/lib/repository/base.rb ADDED

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+require 'repository/base/version'
+require 'repository/base/internals/internals'
+require 'repository/support/store_result'
+# The `Repository` module functions as a namespace for implementing the
+# repository logic in a [Data Mapper pattern](http://martinfowler.com/eaaCatalog/dataMapper.html)
+# implementation.
+# The Repository module initially included two names:
+#
+#  1. `Base`; and
+#  1. `Support` (a namespace containing several related classes).
+#
+module Repository
+  # Base class for Repository in Data Mapper pattern.
+  class Base
+    # Internal support code exclusively used by Repository::Base
+    # @since 0.0.1
+    module Internals
+    end
+    private_constant :Internals
+    include Internals
+    attr_reader :dao, :factory
+    # Initialise a new `Repository::Base` instance.
+    # @param factory Has a .create method to create entities from DAO records.
+    # @param dao Data Access Object implements persistence without business
+    #            logic.
+    def initialize(factory:, dao:)
+      validate_initializer_argument(:dao, dao)
+      validate_initializer_argument(:factory, factory)
+      @factory = factory
+      @dao = dao
+    end
+    # Add a new record with attributes matching the specified entity to the
+    # associated DAO.
+    # @param entity Entity specifying record to be persisted to new DAO record.
+    # @return [Repository::Support::StoreResult] An object containing
+    #     information about the success or failure of an action.
+    def add(entity)
+      record = dao.new filtered_attributes_for(entity)
+      RecordSaver.new(record: record, factory: factory).result
+    end
+    # Return an array of entities matching all records currently in the
+    # associated DAO.
+    # @return [Array] Array of entities as supplied by the `factory`.
+    # @since 0.0.2
+    def all
+      dao.all.map { |record| factory.create record }
+    end
+    # Remove a record from the underlying DAO whose slug matches the passed-in
+    # identifier.
+    # @param identifier [String] [Slug](http://en.wikipedia.org/wiki/Semantic_URL#Slug)
+    #                   for record to be deleted.
+    # @return [Repository::Support::StoreResult] An object containing
+    #     information about the success or failure of an action.
+    # @since 0.0.5
+    def delete(identifier)
+      RecordDeleter.new(identifier: identifier, dao: dao, factory: factory)
+                   .delete
+    end
+    # Find a record in the DAO and, on success, return a corresponding entity
+    # using the specified [slug](http://en.wikipedia.org/wiki/Semantic_URL#Slug),
+    # *not* a numeric record ID, as a search identifier.
+    # @param slug [String] [Slug](http://en.wikipedia.org/wiki/Semantic_URL#Slug)
+    #                      for record to be deleted.
+    # @return [Repository::Support::StoreResult] An object containing
+    #     information about the success or failure of an action.
+    # @since 0.0.3
+    def find_by_slug(slug)
+      SlugFinder.new(slug: slug, dao: dao, factory: factory).find
+    end
+    # Update a record in the DAO corresponding to the specified identifier,
+    # using the specified attribute-name/value pairs.
+    # @param identifier [String] [Slug](http://en.wikipedia.org/wiki/Semantic_URL#Slug)
+    #                      for record to be deleted.
+    # @param updated_attrs [Hash] Attributes to be updated.
+    # @since 0.0.4
+    # @example
+    #   result = user_repo.update @user.slug, params[:user_params]
+    #   @user = result.entity if result.success?
+    def update(identifier:, updated_attrs:)
+      RecordUpdater.new(identifier: identifier, updated_attrs: updated_attrs,
+                        dao: dao, factory: factory).update
+    end
+    private
+    # supporting #initialize
+    # Verifies that parameter passed to #initialize is a Class.
+    # @param arg_sym [Symbol] Which parameter is being validated, either `:dao`
+    #                         or `:factory`.
+    # @param value Parameter value being validated. Must be a Class.
+    # @return [boolean]
+    def validate_initializer_argument(arg_sym, value)
+      message = "the :#{arg_sym} argument must be a Class"
+      raise ArgumentError, message unless value.respond_to? :new
+    end
+    # supporting #add
+    def filtered_attributes_for(entity) # :nodoc:
+      entity.attributes.to_hash.reject { |k, _v| k == :errors }
+    end
+  end # class Repository::Base
+end

data/lib/repository/base/internals/internals.rb ADDED

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+require_relative 'record_deleter'
+require_relative 'record_saver'
+require_relative 'record_updater'
+require_relative 'slug_finder'

data/lib/repository/base/internals/record_deleter.rb ADDED

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+require 'repository/support/store_result'
+require_relative 'slug_finder'
+module Repository
+  # Base class for Repository in Data Mapper pattern.
+  class Base
+    # Internal support code exclusively used by Repository::Base
+    module Internals
+      # Stows away details of reporting update success/failure.
+      # @since 0.0.5
+      class RecordDeleter
+        include Repository::Support
+        # Initializes a new instance of `SlugFinder`.
+        # @param identifier [String] [Slug](http://en.wikipedia.org/wiki/Semantic_URL#Slug)
+        #                   for record to be deleted.
+        # @param dao Data Access Object implements persistence without business
+        #            logic.
+        # @param factory Factory-pattern class to build an entity from an
+        #                existing DAO record.
+        def initialize(identifier:, dao:, factory:)
+          @identifier = identifier
+          @dao = dao
+          @factory = factory
+        end
+        # Command-pattern method returning indication of success or failure of
+        # attempt to delete identified record.
+        # @return Repository::Support::StoreResult
+        def delete
+          finder = SlugFinder.new slug: identifier, dao: dao, factory: factory
+          result = finder.find
+          return result unless result.success
+          dao.delete identifier
+          result
+        end
+        private
+        attr_reader :dao, :factory, :identifier
+      end # class Repository::Base::Internals::RecordDeleter
+    end
+  end
+end

data/lib/repository/base/internals/record_saver.rb ADDED

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+require 'repository/support/error_factory'
+require 'repository/support/store_result'
+module Repository
+  # Base class for Repository in Data Mapper pattern.
+  class Base
+    # Internal support code exclusively used by Repository::Base
+    module Internals
+      # Reports on the success or failure of saving a *DAO record*, using the
+      # `Repository::Support::StoreResult` instance returned from `#result`.
+      # @since 0.0.1
+      class RecordSaver
+        include Repository::Support
+        # Sets instance variable(s) on a new `RecordSaver` instanace.
+        # @param record DAO record to attempt to save.
+        def initialize(record:, factory:)
+          @record = record
+          @factory = factory
+        end
+        # Command-pattern method returning indication of success or failure of
+        # attempt to save record.
+        # @return Repository::Support::StoreResult
+        # @see #failed_result
+        # @see #successful_result
+        def result
+          if record.save
+            successful_result
+          else
+            failed_result
+          end
+        end
+        private
+        attr_reader :factory, :record
+        # Represent error data sourced from an `ActiveModel::Errors` object as
+        # an Array of `{field: 'field', message: 'message'}` hashes.
+        def error_hashes
+          ErrorFactory.create record.errors
+        end
+        def failed_result
+          StoreResult::Failure.new error_hashes
+        end
+        def successful_result
+          entity = factory.create record
+          StoreResult::Success.new entity
+        end
+      end # class Internals::RecordSaver
+    end # module Repository::Base::Internals
+  end # class Repository::Base
+end

data/lib/repository/base/internals/record_updater.rb ADDED

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+require 'repository/support/store_result'
+module Repository
+  # Base class for Repository in Data Mapper pattern.
+  class Base
+    # Internal support code exclusively used by Repository::Base
+    module Internals
+      # Stows away details of reporting update success/failure.
+      # @since 0.0.4
+      class RecordUpdater
+        include Repository::Support
+        # Initializes a new instance of `RecordUpdater`.
+        # @param identifier [String] Slug uniquely identifying the record in the
+        #                   DAO to update
+        # @param updated_attrs [Hash] Attributes to be updated.
+        # @param dao Data Access Object implements persistence without business
+        #            logic.
+        # @param factory Class whose `#create` method converts a DAO record to
+        #                an entity.
+        def initialize(identifier:, updated_attrs:, dao:, factory:)
+          @identifier = identifier
+          @updated_attrs = updated_attrs
+          @dao = dao
+          @factory = factory
+        end
+        # Command-pattern method to update a record in the persistence layer,
+        # based on the parameters sent to `#initialize`.
+        # @return [Repository::Support::StoreResult]
+        def update
+          @record = dao.where(slug: identifier).first
+          return failed_result unless @record.update(updated_attrs.to_h)
+          successful_result
+        end
+        private
+        attr_reader :dao, :factory, :identifier, :record, :updated_attrs
+        def failed_result # :nodoc:
+          StoreResult::Failure.new record.errors
+        end
+        def successful_result # :nodoc:
+          entity = factory.create record
+          StoreResult::Success.new entity
+        end
+      end # class Repository::Base::Internals::RecordUpdater
+    end
+  end
+end

data/lib/repository/base/internals/slug_finder.rb ADDED

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+require 'repository/support/result_builder'
+module Repository
+  # Base class for Repository in Data Mapper pattern.
+  class Base
+    # Internal support code exclusively used by Repository::Base
+    module Internals
+      # Find a slug in the DAO, reporting errors if not successful.
+      # @since 0.0.3
+      class SlugFinder
+        include Repository::Support
+        # Initializes a new instance of `SlugFinder`.
+        # @param slug [String] [Slug](http://en.wikipedia.org/wiki/Semantic_URL#Slug)
+        #                      for record to be deleted.
+        # @param dao Data Access Object implements persistence without business
+        #            logic.
+        def initialize(slug:, dao:, factory:)
+          @slug = slug
+          @dao = dao
+          @factory = factory
+        end
+        # Command-pattern method to search underlying DAO for record matching
+        # slug. Returns a `Repository::Support::StoreResult` instance with the
+        # corresponding entity on success, or with the error hash built by
+        # `Repository::Support::ErrorFactory.create` on failure.
+        # @return [Repository::Support::StoreResult]
+        # @see #errors_for_slug
+        # @see #result_builder
+        def find
+          result_builder(entity_for_slug).build do |_failed_record|
+            ErrorFactory.create errors_for_slug
+          end
+        end
+        private
+        attr_reader :dao, :factory, :slug
+        # Builds an entity from an existing DAO record matching the slug.
+        # @return If the slug matches an existing DAO record, returns an entity
+        #         as built from that record, otherwise returns `nil`.
+        def entity_for_slug
+          record = dao.where(slug: slug).first
+          factory.create(record) if record
+        end
+        # Builds an [`ActiveModel::Errors`](http://api.rubyonrails.org/classes/ActiveModel/Errors.html)
+        # instance and adds a slug-not-found message to it.
+        # @return [ActiveModel::Errors]
+        # @see #find
+        def errors_for_slug
+          errors = ActiveModel::Errors.new dao
+          errors.add :slug, "not found: '#{slug}'"
+          errors
+        end
+        # Returns a new `Repository::Support::ResultBuilder` instance, passing
+        # the parameter specified to this method as its `#initialize` parameter.
+        # @param record DAO record to pass to `ResultBuilder#initialize`.
+        def result_builder(record)
+          ResultBuilder.new record
+        end
+      end # class Repository::Base::Internals::SlugFinder
+    end
+  end
+end