receptacle 1.0.0 → 2.0.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: receptacle
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Andreas Eger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-10 00:00:00.000000000 Z
+date: 2023-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -31,7 +31,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -45,35 +45,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: guard-minitest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
-  name: guard-rubocop
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,81 +87,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rt_rubocop_defaults
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
-- !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'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.37'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.37'
 - !ruby/object:Gem::Dependency
-  name: rt_rubocop_defaults
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.2
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: rubocop_runner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -183,15 +163,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
-- ".dir-locals.el"
+- ".github/workflows/matrix.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
-- Dangerfile
 - Gemfile
-- Guardfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -200,36 +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.4'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: repository pattern

data/.circleci/config.yml

@@ -1,64 +0,0 @@
-# Ruby CircleCI 2.0 configuration file
-#
-# Check https://circleci.com/docs/2.0/language-ruby/ for more details
-#
-
-version: 2
-
-common_steps: &common_steps
-  - checkout
-  - run: gem update --system
-  - restore_cache:
-      key: gem-cache-{{ .Branch }}-{{ checksum "Gemfile" }}
-  - run:
-      name: install dependencies
-      command: |
-        gem update bundler
-        bundle install --jobs=4 --retry=3 --path vendor/bundle
-  - save_cache:
-      key: gem-cache-{{ .Branch }}-{{ checksum "Gemfile" }}
-      paths:
-        - vendor/bundle
-  - run: bundle exec danger
-  - run: bundle exec rake test
-  
-jobs:
-  ruby-2.4:
-    docker:
-      - image: circleci/ruby:2.4
-    steps:
-      *common_steps
-  ruby-2.5:
-    docker:
-      - image: circleci/ruby:2.5
-    steps:
-      *common_steps
-  ruby-2.6:
-    docker:
-      - image: circleci/ruby:2.6
-    steps:
-      *common_steps
-  jruby-9.2:
-    docker:
-      - image: circleci/jruby:9.2
-    environment:
-      JRUBY_OPTS: '--dev'
-    steps:
-      *common_steps
-  jruby-9.2-indy:
-    docker:
-      - image: circleci/jruby:9.2
-    environment:
-      JRUBY_OPTS: '-Xcompile.invokedynamic=true'
-    steps:
-      *common_steps
-
-workflows:
-  version: 2
-  build:
-    jobs:
-      - ruby-2.4
-      - ruby-2.5
-      - ruby-2.6
-      - jruby-9.2
-      - jruby-9.2-indy

data/.dir-locals.el

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

data/Dangerfile

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-# -------------------------------------------------------------------------
-# 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(<<~MSG)
-    Please include a CHANGELOG entry.
-    You can find it at [CHANGELOG.md](https://github.com/andreaseger/receptacle/blob/master/CHANGELOG.md).
-  MSG
-  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 force_exclusion: true

data/Guardfile

@@ -1,32 +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,51 +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,43 +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:)
-      @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

data/lib/receptacle/method_delegation.rb

@@ -1,141 +0,0 @@
-# frozen_string_literal: true
-
-require "receptacle/method_cache"
-require "receptacle/registration"
-require "receptacle/errors"
-
-module Receptacle
-  # module which enables a repository to mediate methods dynamically to wrappers and strategy
-  # @api private
-  module MethodDelegation
-    # dynamically build mediation method on first invocation if the method is registered
-    def method_missing(method_name, *arguments, &block)
-      if Registration.repositories[self].methods.include?(method_name)
-        public_send(__build_method(method_name), *arguments, &block)
-      else
-        super
-      end
-    end
-
-    def respond_to_missing?(method_name, include_private = false)
-      Registration.repositories[self].methods.include?(method_name) || super
-    end
-
-    # @param method_name [#to_sym]
-    # @return [void]
-    def __build_method(method_name)
-      method_cache = __build_method_call_cache(method_name)
-      if method_cache.wrappers.nil? || method_cache.wrappers.empty?
-        __define_shortcut_method(method_cache)
-      elsif method_cache.arity.abs > 1
-        __define_full_method_high_arity(method_cache)
-      else
-        __define_full_method(method_cache)
-      end
-    end
-
-    # build method cache for given method name
-    # @param method_name [#to_sym]
-    # @return [MethodCache]
-    def __build_method_call_cache(method_name)
-      config = Registration.repositories[self]
-
-      raise Errors::NotConfigured.new(repo: self) if config.strategy.nil?
-
-      MethodCache.new(
-        strategy:    config.strategy,
-        wrappers:    config.wrappers,
-        method_name: method_name
-      )
-    end
-
-    # build lightweight method to mediate method calls to strategy without wrappers
-    # @param method_cache [MethodCache] method_cache of the method to be build
-    # @return [void]
-    def __define_shortcut_method(method_cache)
-      define_singleton_method(method_cache.method_name) do |*args, &inner_block|
-        method_cache.strategy.new.public_send(method_cache.method_name, *args, &inner_block)
-      end
-    end
-
-    # build method to mediate method calls of arity 1 to strategy with full wrapper support
-    # @param method_cache [MethodCache] method_cache of the method to be build
-    # @return [void]
-    def __define_full_method(method_cache)
-      define_singleton_method(method_cache.method_name) do |*args, &inner_block|
-        __run_wrappers(method_cache, *args) do |*call_args|
-          method_cache.strategy.new.public_send(method_cache.method_name, *call_args, &inner_block)
-        end
-      end
-    end
-
-    # build method to mediate method calls of higher arity to strategy with full wrapper support
-    # @param method_cache [MethodCache] method_cache of the method to be build
-    # @return [void]
-    def __define_full_method_high_arity(method_cache)
-      define_singleton_method(method_cache.method_name) do |*args, &inner_block|
-        __run_wrappers(method_cache, args, true) do |*call_args|
-          method_cache.strategy.new.public_send(method_cache.method_name, *call_args, &inner_block)
-        end
-      end
-    end
-
-    # runtime method to call before and after wrapper in correct order
-    # @param method_cache [MethodCache] method_cache for the current method
-    # @param input_args input parameter of the repository method call
-    # @param high_arity [Boolean] if are intended for a higher arity method
-    # @return strategy method return value after all wrappers where applied
-    def __run_wrappers(method_cache, input_args, high_arity = false)
-      wrappers = method_cache.wrappers.map(&:new)
-      args =
-        if method_cache.skip_before_wrappers?
-          input_args
-        else
-          __run_before_wrappers(wrappers, method_cache.before_method_name, input_args, high_arity)
-        end
-      ret = high_arity ? yield(*args) : yield(args)
-      return ret if method_cache.skip_after_wrappers?
-
-      __run_after_wrappers(wrappers, method_cache.after_method_name, args, ret, high_arity)
-    end
-
-    # runtime method to execute all before wrappers
-    # @param wrappers [Array] all wrapper instances to be executed
-    # @param method_name [Symbol] name of method to be executed on wrappers
-    # @param args input args of the repository method
-    # @param high_arity [Boolean] if are intended for a higher arity method
-    # @return processed method args by before wrappers
-    def __run_before_wrappers(wrappers, method_name, args, high_arity = false)
-      wrappers.each do |wrapper|
-        next unless wrapper.respond_to?(method_name)
-
-        args = if high_arity
-                 wrapper.public_send(method_name, *args)
-               else
-                 wrapper.public_send(method_name, args)
-               end
-      end
-      args
-    end
-
-    # runtime method to execute all after wrappers
-    # @param wrappers [Array] all wrapper instances to be executed
-    # @param method_name [Symbol] name of method to be executed on wrappers
-    # @param args input args to the strategy method (after processing in before wrappers)
-    # @param return_value return value of strategy method
-    # @param high_arity [Boolean] if are intended for a higher arity method
-    # @return processed return value by all after wrappers
-    def __run_after_wrappers(wrappers, method_name, args, return_value, high_arity = false)
-      wrappers.reverse_each do |wrapper|
-        next unless wrapper.respond_to?(method_name)
-
-        return_value = if high_arity
-                         wrapper.public_send(method_name, return_value, *args)
-                       else
-                         wrapper.public_send(method_name, return_value, args)
-                       end
-      end
-      return_value
-    end
-  end
-end

data/lib/receptacle/registration.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require "singleton"
-require "set"
-module Receptacle
-  # keeps global state of repositories, the defined strategy, set wrappers and methods to mediate
-  class Registration
-    include Singleton
-    Tuple = Struct.new(:strategy, :wrappers, :methods)
-
-    attr_reader :repositories
-
-    def initialize
-      @repositories = Hash.new do |h, k|
-        h[k] = Tuple.new(nil, [], Set.new)
-      end
-    end
-
-    def self.repositories
-      instance.repositories
-    end
-
-    # {clear_method_cache} removes dynamically defined methods
-    # this is needed to make strategy and wrappers changes inside the codebase possible
-    def self.clear_method_cache(receptacle)
-      instance.repositories[receptacle].methods.each do |method_name|
-        begin
-          receptacle.singleton_class.send(:remove_method, method_name)
-        rescue NameError
-          nil
-        end
-      end
-    end
-  end
-end

data/performance/benchmark.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/inline"
-
-gemfile false do
-  source "https://rubygems.org"
-  gem "benchmark-ips"
-  gem "receptacle", path: "./.."
-end
-
-require_relative "speed_receptacle"
-
-Speed.strategy(Speed::Strategy::One)
-Speed.wrappers [Speed::Wrappers::W1,
-                Speed::Wrappers::W2,
-                Speed::Wrappers::W3,
-                Speed::Wrappers::W4,
-                Speed::Wrappers::W5,
-                Speed::Wrappers::W6]
-
-print "w/ wrappers"
-Benchmark.ips do |x|
-  x.warmup = 10 if RUBY_ENGINE == "jruby"
-  x.report("a: 2x around, 1x before, 1x after") { Speed.a(1) }
-  x.report("b: 1x around, 1x before, 1x after") { Speed.b(1) }
-  x.report("c: 1x before, 1x after") { Speed.c(1) }
-  x.report("d: 1x after") { Speed.d(1) }
-  x.report("e: 1x before") { Speed.e(1) }
-  x.report("f: 1x around") { Speed.f(1) }
-  x.report("g: no wrappers") { Speed.g(1) }
-end
-
-Speed.wrappers []
-print "method dispatching w/ wrappers"
-Benchmark.ips do |x|
-  x.warmup = 10 if RUBY_ENGINE == "jruby"
-  x.report("via receptacle") { Speed.a(:foo) }
-  x.report("direct via public_send") { Speed::Strategy::One.new.public_send(:a, :foo) }
-  x.report("direct via method-method") do
-    m = Speed::Strategy::One.new.method(:a)
-    m.call(:foo)
-  end
-  x.report("direct method-call") { Speed::Strategy::One.new.a(:foo) }
-  x.compare!
-end