receptacle 0.3.1 → 2.0.0

data/lib/receptacle.rb

@@ -1,13 +1,7 @@
 # frozen_string_literal: true
-require 'receptacle/version'
-require 'receptacle/interface_methods'
-require 'receptacle/method_delegation'
+
+require "receptacle/version"
+require "receptacle/repo"
 
 module Receptacle
-  module Repo
-    def self.included(base)
-      base.extend(InterfaceMethods)
-      base.extend(MethodDelegation)
-    end
-  end
 end

data/receptacle.gemspec

@@ -1,38 +1,43 @@
-# coding: utf-8
 # frozen_string_literal: true
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'receptacle/version'
+require "receptacle/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'receptacle'
-  spec.version       = Receptacle::VERSION
-  spec.authors       = ['Andreas Eger']
-  spec.email         = ['dev@eger-andreas.de']
+  spec.name = "receptacle"
+  spec.version = Receptacle::VERSION
+  spec.authors = ["Andreas Eger"]
+  spec.email = ["dev@eger-andreas.de"]
 
-  spec.summary       = 'repository pattern'
-  spec.description   = 'provides functionality for the repository or strategy pattern'
-  spec.homepage      = 'https://github.com/andreaseger/receptacle'
-  spec.license       = 'MIT'
+  spec.summary = "repository pattern"
+  spec.description = "provides functionality for the repository or strategy pattern"
+  spec.homepage = "https://github.com/andreaseger/receptacle"
+  spec.license = "MIT"
 
-  spec.required_ruby_version = '~> 2.1'
+  spec.required_ruby_version = if RUBY_ENGINE == "jruby"
+                                 ">= 2.6"
+                               else
+                                 ">= 2.7"
+                               end
 
   spec.files = `git ls-files -z`.split("\x0").reject do |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.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", ">= 1.13", "< 3"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.11"
+  spec.add_development_dependency "rspec_junit_formatter"
+  spec.add_development_dependency "rt_rubocop_defaults", "~> 2.4"
+  spec.add_development_dependency "rubocop", "~> 1.37"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.14"
+  spec.add_development_dependency "rubocop_runner", "~> 2.2"
+  spec.add_development_dependency "simplecov", "~> 0.13"
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rubocop_runner', '~> 2.0'
-  spec.add_development_dependency 'rubocop', '~> 0.46.0'
-  spec.add_development_dependency 'simplecov', '~> 0.13'
-  spec.add_development_dependency 'codecov'
-  spec.add_development_dependency 'guard'
-  spec.add_development_dependency 'guard-minitest'
-  spec.add_development_dependency 'guard-rubocop'
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/upgrade_notes.md

@@ -0,0 +1,45 @@
+# Upgrade notes
+
+## Upgrade from 1.0.0 to 2.0.0
+The test helper `ensure_method_delegators` has been removed. If you used it, just remove its usage.
+
+If you do not use wrappers, there is nothing further you need to do to upgrade.
+
+The wrapper interface changed. With version 1.0 you had to implement methods prefixed with `before_` and `after_`. The return value of before-hooks where used as arguments to the next wrapper, while the return value of after-hooks was passed down to the previous wrapper. E.g:
+
+```ruby
+module Wrapper
+  class Validator
+    def before_find(id:)
+      raise ArgumentError if id.nil?
+      {id: id}
+    end
+  end
+
+  class ModelMapper
+    def after_find(return_value, **_kwargs)
+      Model::User.new(return_value)
+    end
+  end
+end
+```
+
+In version 2.0 there are no before- and after-methods anymore. Instead you provide one method that wraps around the next wrapper or the strategy. You need to name the wrapper methods exactly as they are named in your strategy and you call `yield` to call the next wrapper. E.g:
+
+```ruby
+module Wrapper
+  class Validator
+    def find(id:)
+      raise ArgumentError if id.nil?
+      yield(id: id)
+    end
+  end
+  
+  class ModelMapper
+    def find(id:)
+      return_value = yield(id: id)
+      Model::User.new(return_value)
+    end
+  end
+end
+```

metadata

@@ -1,29 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: receptacle
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Andreas Eger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-14 00:00:00.000000000 Z
+date: 2023-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.13'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.13'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,21 +59,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,103 +87,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop_runner
+  name: rt_rubocop_defaults
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.46.0
+        version: '1.37'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.46.0
+        version: '1.37'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
-- !ruby/object:Gem::Dependency
-  name: codecov
-  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: guard
-  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'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
-  name: guard-minitest
+  name: rubocop_runner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: guard-rubocop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
 description: provides functionality for the repository or strategy pattern
 email:
 - dev@eger-andreas.de
@@ -171,15 +163,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".dir-locals.el"
+- ".github/workflows/matrix.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
-- Dangerfile
 - Gemfile
-- Guardfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -188,37 +178,32 @@ files:
 - examples/simple_repo.rb
 - lib/receptacle.rb
 - lib/receptacle/errors.rb
-- lib/receptacle/interface_methods.rb
-- lib/receptacle/method_cache.rb
-- lib/receptacle/method_delegation.rb
-- lib/receptacle/registration.rb
+- lib/receptacle/repo.rb
 - lib/receptacle/test_support.rb
 - lib/receptacle/version.rb
-- performance/benchmark.rb
-- performance/profile.rb
-- performance/speed_receptacle.rb
 - receptacle.gemspec
+- upgrade_notes.md
 homepage: https://github.com/andreaseger/receptacle
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: repository pattern

data/.dir-locals.el

@@ -1 +0,0 @@
-((ruby-mode . ( (ruby-test-runner . minitest)) ) )

data/.travis.yml

@@ -1,36 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.1.10
-  - 2.2.6
-  - 2.3.4
-  - 2.4.1
-  - jruby-9.1.12.0
-jdk:
-  - oraclejdk8
-env:
-  - "JRUBY_OPTS='--dev --debug'"
-  - "JRUBY_OPTS='-Xcompile.invokedynamic=true --debug'"
-matrix:
-  exclude:
-    - rvm: 2.1.10
-      jdk: oraclejdk8
-      env: "JRUBY_OPTS='-Xcompile.invokedynamic=true --debug'"
-    - rvm: 2.2.6
-      jdk: oraclejdk8
-      env: "JRUBY_OPTS='-Xcompile.invokedynamic=true --debug'"
-    - rvm: 2.3.4
-      jdk: oraclejdk8
-      env: "JRUBY_OPTS='-Xcompile.invokedynamic=true --debug'"
-    - rvm: 2.4.1
-      jdk: oraclejdk8
-      env: "JRUBY_OPTS='-Xcompile.invokedynamic=true --debug'"
-  allow_failures:
-    - rvm: jruby-9.1.12.0
-      jdk: oraclejdk8
-      env: "JRUBY_OPTS='-Xcompile.invokedynamic=true --debug'"
-before_install:
-  - gem update --system
-  - gem install bundler -v 1.15.1
-before_script:
-  - bundle exec danger

data/Dangerfile

@@ -1,26 +0,0 @@
-# --------------------------------------------------------------------------------------------------------------------
-# Has any changes happened inside the actual library code?
-# --------------------------------------------------------------------------------------------------------------------
-has_app_changes = !git.modified_files.grep(/lib/).empty?
-has_test_changes = !git.modified_files.grep(/test/).empty?
-is_version_bump = git.modified_files.sort == ["CHANGELOG.md", "lib/receptacle/version.rb"].sort
-
-if has_app_changes && !has_test_changes && !is_version_bump
-  warn("Tests were not updated. That's OK if you're refactoring existing code.", sticky: false)
-end
-
-if !git.modified_files.include?("CHANGELOG.md") && has_app_changes
-  fail("Please include a CHANGELOG entry. \nYou can find it at [CHANGELOG.md](https://github.com/andreaseger/receptacle/blob/master/CHANGELOG.md).")
-  message "Note, we hard-wrap at 80 chars and use 2 spaces after the last line."
-end
-
-# Make it more obvious that a PR is a work in progress and shouldn't be merged yet
-warn("PR is classed as Work in Progress") if github.pr_title.include? "WIP"
-
-# Warn when there is a big PR
-warn("Big PR") if git.lines_of_code > 500
-
-commit_lint.check warn: :all, disable: [:subject_cap]
-
-# rubocop
-rubocop.lint

data/Guardfile

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-## Uncomment and set this to only include directories you want to watch
-# directories %w(app lib config test spec features) \
-#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
-
-## Note: if you are using the `directories` clause above and you are not
-## watching the project directory ('.'), then you will want to move
-## the Guardfile to a watched dir and symlink it back, e.g.
-#
-#  $ mkdir config
-#  $ mv Guardfile config/
-#  $ ln -s config/Guardfile .
-#
-# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
-group :red_green_refactor, halt_on_fail: true do
-  guard :minitest do
-    # with Minitest::Unit
-    watch(%r{^test/(.*)\/?test_(.*)\.rb$})
-    # watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
-    watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { 'test' }
-    watch(%r{^test/test_helper\.rb$})      { 'test' }
-    watch(%r{^test/fixture\.rb$}) { 'test' }
-  end
-  guard :rubocop, all_on_start: false, cli: ['--auto-correct'] do
-    watch(/.+\.rb$/)
-    watch(%r{(?:.+/)?\.rubocop\.yml%}) { |m| File.dirname(m[0]) }
-  end
-end

data/lib/receptacle/interface_methods.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-require 'receptacle/registration'
-require 'receptacle/errors'
-
-module Receptacle
-  module InterfaceMethods
-    RESERVED_METHOD_NAMES = Set.new(%i(wrappers mediate strategy delegate_to_strategy))
-    private_constant :RESERVED_METHOD_NAMES
-
-    # registers a method_name for the to be mediated or forwarded to the configured strategy
-    #
-    # @param method_name [String] name of method to register
-    def mediate(method_name)
-      raise Errors::ReservedMethodName if RESERVED_METHOD_NAMES.include?(method_name)
-      Registration.repositories[self].methods << method_name
-    end
-    alias delegate_to_strategy mediate
-
-    # get or sets the strategy
-    #
-    # @note will set the strategy for this receptacle if passed in; will only
-    #      return the current strategy if nil or no parameter passed include
-    # @param value [Class,nil]
-    # @return [Class] current configured strategy class
-    def strategy(value = nil)
-      if value
-        Registration.repositories[self].strategy = value
-        Registration.clear_method_cache(self)
-      else
-        Registration.repositories[self].strategy
-      end
-    end
-
-    # get or sets the wrappers
-    #
-    # @note will set the wrappers for this receptacle if passed in; will only
-    #      return the current wrappers if nil or no parameter passed include
-    # @param value [Class,Array(Class),nil] wrappers
-    # @return [Array(Class)] current configured wrappers
-    def wrappers(value = nil)
-      if value
-        Registration.repositories[self].wrappers = Array(value)
-        Registration.clear_method_cache(self)
-      else
-        Registration.repositories[self].wrappers
-      end
-    end
-  end
-end

data/lib/receptacle/method_cache.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-module Receptacle
-  # Cache describing which strategy and wrappers need to be applied for this method
-  # @api private
-  class MethodCache
-    # @return [Symbol] name of the method this cache belongs to
-    attr_reader :method_name
-    # @return [Class] strategy class currently setup
-    attr_reader :strategy
-    # @return [Array(Class)] Array of wrapper classes which implement a wrapper for this method
-    attr_reader :wrappers
-    # @return [Symbol] name of the before action method
-    attr_reader :before_method_name
-    # @return [Symbol] name of the after action method
-    attr_reader :after_method_name
-    # @return [Integer] arity of strategy method according to https://ruby-doc.org/core-2.3.3/Method.html#method-i-arity
-    attr_reader :arity
-
-    def initialize(method_name:, strategy:, wrappers:) # rubocop:disable Metrics/AbcSize
-      @strategy = strategy
-      @before_method_name = :"before_#{method_name}"
-      @after_method_name = :"after_#{method_name}"
-      @method_name = method_name.to_sym
-      before_wrappers = wrappers.select { |w| w.method_defined?(@before_method_name) }
-      after_wrappers = wrappers.select { |w| w.method_defined?(@after_method_name) }
-      @wrappers = wrappers & (before_wrappers | after_wrappers)
-      @skip_before_wrappers = before_wrappers.empty?
-      @skip_after_wrappers = after_wrappers.empty?
-      @arity = strategy.new.method(method_name).arity
-    end
-
-    # @return [Boolean] true if no before wrappers need to be applied for this method
-    def skip_before_wrappers?
-      @skip_before_wrappers
-    end
-
-    # @return [Boolean] true if no after wrappers need to be applied for this method
-    def skip_after_wrappers?
-      @skip_after_wrappers
-    end
-  end
-end