receptacle 0.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c9fe755e41253d67a0be871fab1aebf01ed201ec
-  data.tar.gz: 246b2cb847fd611e9886c75992667dae615f6a84
+SHA256:
+  metadata.gz: eaa2e6a1b1e530f37984a21a68e20f465a0a5dc5c5549074879a9ef52dc44776
+  data.tar.gz: 691bee1a039ad306c3ca3e9e8cf4e71f139649a3c47b81b54e5feff8a7908b56
 SHA512:
-  metadata.gz: f6f2eb8a27fc37b7838c43c1cf2534415bbb76200f4db266cb5ceb4576f09f1f99250862ca8392463295b791a7b63792888b6a806971637b2beab306130ca81d
-  data.tar.gz: 69f486884c18e7eaf28ef651a15c007ac17dde96b4ce40eb99ea53dd06c0f9f162372c6fa2585fad03994f8a621b841bc10e0a07b7de3b27860b21d88f89838f
+  metadata.gz: 03ae765ccf54fe2ee01c20b9a2bb69d8ee8005c6f16e13b7787473512c1ce3848f9118911df840aebc2b1a1523f6c105417c62b96474893ed58c62b49c338ccb
+  data.tar.gz: c2fe5fa8b67040271899b1ab0ac0fadbdd33c6a2e0eeb32b2b4cb762961eeb8b9169913d2e88cdfd2c4172d3a18965c46bc6d88050d9f00f6c63ee40bb2cc607

data/.github/workflows/matrix.yml

@@ -0,0 +1,32 @@
+---
+name: matrix-testing
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        experimental: [false]
+        ruby-version: ["2.7", "3.0", "3.1", "3.2", "jruby-9.3"]
+        include:
+          - ruby-version: jruby-9.4
+            experimental: true
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - run: bundle exec rspec
+      - run: bundle exec rubocop

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
@@ -9,3 +8,4 @@
 /tmp/
 
 .ruby-version
+.rspec_status

data/.rubocop.yml

@@ -1,14 +1,15 @@
-AllCops:
-  TargetRubyVersion: 2.1
+require: rt_rubocop_defaults
 
-Metrics/LineLength:
-  Max: 99
+AllCops:
+  TargetRubyVersion: 2.6
+  # vendor directory is used by github actions and causes issues if not excluded here
   Exclude:
-    - test/*
+    - vendor/bundle/**/*
 
 Metrics/BlockLength:
   Exclude:
     - '*.gemspec'
+    - 'spec/*'
 
 Metrics/AbcSize:
   Exclude:
@@ -21,6 +22,3 @@ Metrics/ClassLength:
 Metrics/MethodLength:
   Exclude:
     - test/*
-
-Style/Documentation:
-  Enabled: false

data/CHANGELOG.md

@@ -1,35 +1,47 @@
-Changelog
-===
+# Changelog
 
-master
----
+All notable changes to this project will be documented in this file.
 
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-0.3.1
----
+## [Unreleased]
 
-* fix after wrapper ordering bug [PR#6](https://github.com/andreaseger/receptacle/pull/6)
+## [2.0.0] - 2023-01-17
+### Changed
+* switch CI to github actions
+* remove danger
+* remove codecov
+* Support for ruby 3
+* The wrapper interface has been redesigned (breaking change, see [upgrade notes](./upgrade_notes.md))
+
+
+## [1.0.0]
+### Changed
+* repackage 0.3.1 as 1.0.0
+* setup circleci
+* drop ruby < 2.4
 
-0.3.0
----
 
+## [0.3.1]
+### Fixed
+* fix after wrapper ordering bug [PR#6](https://github.com/andreaseger/receptacle/pull/6)
+
+## [0.3.0}
+### Added 
 * add danger
 * also support higher arity methods (== method with more than one argument)
 
-0.2.0
----
-
+## [0.2.0]
+### Changed
 * update documentation
 * enable ruby 2.1+
 
-0.1.1
----
-
+## [0.1.1]
+## Added 
 * add changelog, update copyright
 * add test helper method `ensure_method_delegators` to make rspec stubs/mocks work as expected
 
-0.1.0
----
-
+## [0.1.0]
+## Added
 * initial release
-

data/Gemfile

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
-source 'https://rubygems.org'
 
-gemspec
+source "https://rubygems.org"
 
-group :development, :test do
-  gem 'danger'
-  gem 'danger-commit_lint'
-  gem 'danger-rubocop'
-end
+gemspec

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    receptacle (2.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    ffi (1.15.5-java)
+    json (2.6.2)
+    json (2.6.2-java)
+    method_source (1.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry (0.14.1-java)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+      spoon (~> 0.0)
+    rainbow (3.1.1)
+    rake (10.5.0)
+    regexp_parser (2.6.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rspec_junit_formatter (0.6.0)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rt_rubocop_defaults (2.4.0)
+      rubocop (~> 1.25)
+    rubocop (1.38.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    rubocop-rspec (2.14.2)
+      rubocop (~> 1.33)
+    rubocop_runner (2.2.1)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    spoon (0.0.6)
+      ffi
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  universal-java-11
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (>= 1.13, < 3)
+  pry
+  rake (~> 10.0)
+  receptacle!
+  rspec (~> 3.11)
+  rspec_junit_formatter
+  rt_rubocop_defaults (~> 2.4)
+  rubocop (~> 1.37)
+  rubocop-rspec (~> 2.14)
+  rubocop_runner (~> 2.2)
+  simplecov (~> 0.13)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Andreas Eger
+Copyright (c) 2022 Andreas Eger
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -2,15 +2,14 @@
 
 [![Gem Version](https://badge.fury.io/rb/receptacle.svg)](https://badge.fury.io/rb/receptacle)
 [![Gem Downloads](https://img.shields.io/gem/dt/receptacle.svg)](https://rubygems.org/gems/receptacle)
-[![Build Status](https://travis-ci.org/andreaseger/receptacle.svg?branch=master)](https://travis-ci.org/andreaseger/receptacle)
-[![codecov](https://codecov.io/gh/andreaseger/receptacle/branch/master/graph/badge.svg)](https://codecov.io/gh/andreaseger/receptacle)
+
 
 ## About
 
 Provides easy and fast means to use the repository pattern to create separation
 between your business logic and your data sources.
 
-Battle tested at [Runtastic](https://github.com/runtastic).
+The ownership of this project has been taken over from https://github.com/andreaseger/receptacle, where you can still find version 1.0
 
 ## Installation
 
@@ -82,14 +81,14 @@ Optionally wrapper classes can be defined
 ```ruby
 module Wrapper
   class Validator
-    def before_find(id:)
+    def find(id:)
       raise ArgumentError if id.nil?
-      {id: id}
+      yield(id: id)
     end
   end
   class ModelMapper
-    def after_find(return_value, **_kwargs)
-      Model::User.new(return_value)
+    def find(id:)
+      Model::User.new(yield(id: id))
     end
   end
 end
@@ -122,14 +121,14 @@ module Repository
 
     module Wrapper
       class Validator
-        def before_find(id:)
+        def find(id:)
           raise ArgumentError if id.nil?
-          {id: id}
+          yield(id: id)
         end
       end
       class ModelMapper
-        def after_find(return_value, **_kwargs)
-          Model::User.new(return_value)
+        def find(id:)
+          Model::User.new(yield(id: id))
         end
       end
     end
@@ -225,47 +224,28 @@ applying them in the business logic by using wrappers.
 
 One or multiple wrappers sit logically between the repository and the
 strategies. Based on the repository configuration it knows when and in which
-order they should be applied. Right now there is support for 2 1/2 types of
-actions.
-
-1. a _before_ method action: This action is called before the final strategy
-   method is executed. It has access to the method parameter and can even modify
-   them.
-2. a _after_ method action: This action is called after the strategy method was
-   executed and has access to the method parameters passed to the strategy
-   method and the return value. The return value could be modified here too.
-
-The extra 1/2 action type is born by the fact that if a single wrapper class
-implements both an before and after action for the same method the same wrapper
-instance is used to execute both. Although this doesn't cover the all use cases
-an _around_ method action would but many which need state before and after the
-data source is accessed are covered.
+order they should be applied. 
 
 #### Implementation
 
 Wrapper actions are implemented as plain ruby classes which provide instance
-methods named like `before_<method_name>` or `after_<method_name>` where
-`<method_name>` is the repository/strategy method this action should be applied
-to.
+methods named like the method that the repository/strategy method this action should be applied to.
 
 ```ruby
 module Wrapper
   class Validator
-    def before_find(id:)
+    def find(id:)
       raise ArgumentError if id.nil?
-      {id: id}
+      yield(id: id)
     end
   end
 end
 ```
 
-This wrapper class would provide a before action for the `find` method. The
-return value of this wrapper will be used as parameters for the strategy method
-(or the next wrapper in line). Keyword arguments can simply be returned as hash.
-
-If multiple wrapper classes are defined the before wrapper actions are executed
-in the order the wrapper classes are defined while the after actions are applied
-in reverse order.
+This wrapper class would execute on any `find` call. You can use it to execute code
+before or after the next wrapper/strategy is called. Calling `yield` executes the next
+wrapper in line or the strategy, if this is the last wrapper that is called. The return
+value is passed down to the previous wrapper and in the end to the repository caller.
 
 ### Memory Strategy
 
@@ -315,8 +295,8 @@ Some alternative have some interesting features nevertheless:
   
 This gem on the other hand makes absolutely no assumptions about your data
 source or general structure of your code. It can be simply plugged in between
-your business logic and data source to abstract the two. Of cause like the other
-repository pattern implementations strategy details should be hidden from the
+your business logic and data source to abstract the two. Of course, like the other
+repository pattern implementations, strategy details should be hidden from the
 interface. The data source can essentially be anything. A SQL database, a no-SQL
 database, a JSON API or even a gem. Placing a gem behind a repository can be
 useful if you're not yet sure this is the correct or best possible gem,
@@ -327,15 +307,11 @@ this by giving all the different http libraries a common interface).
 
 A module called `TestSupport` can be found
 [here](https://github.com/andreaseger/receptacle/blob/master/lib/receptacle/test_support.rb).
-Right now it provides 2 helper methods `with_strategy` to easily toggle
-temporarily to another strategy and `ensure_method_delegators` to solve issues
-caused by Rspec when attempting to stub a repository method. Both methods and
-how to use them is described in more detail in the inline documentation. 
+Right now it provides a helper method `with_strategy` to easily toggle temporarily to another strategy. How to use it is described in more detail in the inline documentation. 
 
 ## Goals of this implementation
 
 - small core codebase
-- minimal processing overhead - fast method dispatching
 - flexible - all kind of methods should possible to be mediated
 - basic but powerful callbacks/hooks/observer possibilities
 
@@ -354,16 +330,10 @@ to [rubygems.org](https://rubygems.org).
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at
-https://github.com/andreaseger/receptacle. This project is intended to be a safe,
+https://github.com/runtastic/receptacle. This project is intended to be a safe,
 welcoming space for collaboration, and contributors are expected to adhere to
 the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-## Attribution
-
-[Runtastic][runtastic] is using the repository pattern extensively in its
-backend services and inspired the creation of this library. Nevertheless no code
-developed at [Runtastic][runtastic] was used in this library.
-
 ## License
 
 The gem is available as open source under the terms of

data/Rakefile

@@ -1,25 +1,15 @@
 # frozen_string_literal: true
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+
+require "bundler/gem_tasks"
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/**/test_*.rb']
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
 end
 
-begin
-  require 'rubocop/rake_task'
-  RuboCop::RakeTask.new
-  namespace :rubocop do
-    desc 'Install Rubocop as pre-commit hook'
-    task :install do
-      require 'rubocop_runner'
-      RubocopRunner.install
-    end
-  end
-rescue LoadError
-  p 'rubocop not installed'
-end
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
 
 task default: :test

data/bin/console

@@ -1,11 +1,11 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'receptacle'
+require "bundler/setup"
+require "receptacle"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-require 'pry'
+require "pry"
 Pry.start

data/examples/simple_repo.rb

@@ -1,12 +1,13 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require 'bundler/inline'
+require "bundler/inline"
 gemfile true do
-  source 'https://rubygems.org'
-  gem 'receptacle', '~>0.3'
-  gem 'mongo'
+  source "https://rubygems.org"
+  gem "receptacle", "~> 2"
+  gem "mongo"
 end
-require 'irb'
+require "irb"
 
 # a simple struct to act as business entity
 User = Struct.new(:id, :name)
@@ -18,10 +19,11 @@ module Connection
 
     def initialize
       ::Mongo::Logger.logger.level = Logger::INFO
-      @client = ::Mongo::Client.new(['127.0.0.1:27017'], database: 'receptacle')
+      @client = ::Mongo::Client.new(["127.0.0.1:27017"], database: "receptacle")
       client[:users].delete_many # empty collection
     end
     attr_reader :client
+
     def self.client
       instance.client
     end
@@ -45,7 +47,7 @@ module Repository
       class Mongo
         def find(id:)
           mongo_to_model(collection.find(_id: id).first)
-        rescue
+        rescue StandardError
           nil
         end
 
@@ -61,7 +63,7 @@ module Repository
         private
 
         def mongo_to_model(doc)
-          ::User.new(doc['_id'], doc['name'])
+          ::User.new(doc["_id"], doc["name"])
         end
 
         def collection
@@ -100,21 +102,21 @@ end
 # configure the repository and use it
 Repository::User.strategy Repository::User::Strategy::InMemory
 
-user = Repository::User.create(name: 'foo')
-print 'created user: '
+user = Repository::User.create(name: "foo")
+print "created user: "
 p user
-print 'find user by id: '
+print "find user by id: "
 p Repository::User.find(id: user.id)
 
 # switching to mongo and we see it's using a different store but keeps the same interface
 Repository::User.strategy Repository::User::Strategy::Mongo
 
-print 'search same user in other strategy: '
+print "search same user in other strategy: "
 p Repository::User.find(id: user.id)
 #-> nil
 
-user = Repository::User.create(name: 'foo mongo')
-print 'create new user: '
+user = Repository::User.create(name: "foo mongo")
+print "create new user: "
 p user
-print 'find new user by id: '
+print "find new user by id: "
 p Repository::User.find(id: user.id)

data/lib/receptacle/errors.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
+
 module Receptacle
   module Errors
     class NotConfigured < StandardError
       attr_reader :repo
+
       def initialize(repo:)
         @repo = repo
         super("Missing Configuration for repository: <#{repo}>")
       end
     end
-    class ReservedMethodName < StandardError; end
   end
 end

data/lib/receptacle/repo.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "receptacle/errors"
+
+module Receptacle
+  module Repo
+    module ClassMethods
+      def mediate(method_name)
+        define_singleton_method(method_name) do |*args, **kwargs|
+          raise Errors::NotConfigured.new(repo: self) unless @strategy
+
+          with_wrappers(@wrappers.dup, method_name, *args, **kwargs) do |*sub_args, **sub_kwargs|
+            strategy.new.public_send(method_name, *sub_args, **sub_kwargs)
+          end
+        end
+      end
+
+      def wrappers(wrappers)
+        @wrappers = wrappers
+      end
+
+      def strategy(value = nil)
+        if value
+          @strategy = value
+        else
+          @strategy
+        end
+      end
+
+      private
+
+      def with_wrappers(wrappers, method_name, *args, **kwargs, &block)
+        next_wrapper = wrappers.shift
+        if next_wrapper&.method_defined?(method_name)
+          next_wrapper.new.public_send(method_name, *args, **kwargs) do |*sub_args, **sub_kwargs|
+            with_wrappers(wrappers, method_name, *sub_args, **sub_kwargs, &block)
+          end
+        elsif next_wrapper
+          with_wrappers(wrappers, method_name, *args, **kwargs, &block)
+        else
+          yield(*args, **kwargs)
+        end
+      end
+    end
+
+    def self.included(base)
+      base.instance_variable_set(:@wrappers, [])
+      base.extend(ClassMethods)
+    end
+  end
+end

data/lib/receptacle/test_support.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Receptacle
   module TestSupport
     # with_strategy
@@ -7,7 +8,7 @@ module Receptacle
     #
     # can be used in rspec like this
     #
-    #    require 'receptacle/test_support'y
+    #    require 'receptacle/test_support'
     #    RSpec.configure do |c|
     #      c.include Receptacle::TestSupport
     #    end
@@ -46,21 +47,5 @@ module Receptacle
     ensure
       repo.strategy original_strategy
     end
-
-    # ensure_method_delegators
-    #
-    # When using something like `allow(SomeRepo).to receive(:find)` (where find
-    # is a mediated method) before the method was called the first time Rspec
-    # would stub the method with the wrong arity of 0 when also using jruby.
-    # This seems to be caused by the lazily defined methods. Simply calling the
-    # following method in a before hook when method stubbing is need solves this
-    # issue. As it's a problem which only affects mocking libraries it's
-    # currently not planned to change this behavior.
-    #
-    def ensure_method_delegators(repo)
-      Receptacle::Registration.repositories[repo].methods.each do |method_name|
-        repo.__build_method(method_name)
-      end
-    end
   end
 end

data/lib/receptacle/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Receptacle
-  VERSION = '0.3.1'.freeze
+  VERSION = "2.0.0"
 end