receptacle 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c3b2dda14cdba3e98e04dbe1c8610f5718f4979
+  data.tar.gz: d8ab4f84c9826113be2b566c659ee24b045bff96
+SHA512:
+  metadata.gz: 299d55e1aa3afa8ed26a9a92083afd4f9c2320314a1fb3489f87123ed4d4c55774167fc5323b666de706e3cfece8f1a4c2705ce052068041cd23dc7feb3c6c2b
+  data.tar.gz: 9531ff2e7ce214b57a7fdbd9755058682551a4cbc3f5a527140b2ef3a67b261f215999be70292b44f56740e19493b5c295f2f96884dbe5bee559922991ea454a

data/.dir-locals.el

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

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.ruby-version

data/.rubocop.yml

@@ -0,0 +1,27 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/LineLength:
+  Max: 99
+  Exclude:
+    - test/*
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+
+Metrics/AbcSize:
+  Exclude:
+    - test/*
+
+Metrics/ClassLength:
+  Exclude:
+    - test/*
+
+Metrics/MethodLength:
+  Exclude:
+    - test/*
+
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,27 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.3
+  - 2.4.0
+  - jruby-9.1.7.0
+jdk:
+  - oraclejdk8
+  # - openjdk7
+env:
+  - "JRUBY_OPTS='--dev'"
+  - "JRUBY_OPTS='-Xcompile.invokedynamic=true'"
+matrix:
+  exclude:
+    - rvm: 2.3.3
+      jdk: oraclejdk8
+      env: "JRUBY_OPTS='-Xcompile.invokedynamic=true'"
+    - rvm: 2.4.0
+      jdk: oraclejdk8
+      env: "JRUBY_OPTS='-Xcompile.invokedynamic=true'"
+  allow_failures:
+    - rvm: jruby-9.1.7.0
+      jdk: oraclejdk8
+      env: "JRUBY_OPTS='-Xcompile.invokedynamic=true'"
+before_install:
+  - gem update --system
+  - gem install bundler -v 1.14.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dev@eger-andreas.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,30 @@
+# 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{^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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,355 @@
+# Receptacle
+
+
+[![Gem Version](https://badge.fury.io/rb/receptacle.svg)](https://badge.fury.io/rb/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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'receptacle'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install receptacle
+
+## Usage
+
+A repository mediates requests based on it's configuration to a strategy which
+then itself implements the necessary functions to access the data source.
+
+```
+                                                +--------------------+      +--------+
+                                                |                    |      |Database|
+                                                |  DatabaseStrategy  +------>        |
+                                                |                    |      |        |
++--------------------+     +--------------+     +----------^---------+      |        |
+|                    |     |              |                |                +--------+
+|   Business Logic   +----->  Repository  +----------------+
+|                    |     |              |
++--------------------+     +--------|-----+     +--------------------+
+                                    |           |                    |
+                                    |           |  InMemoryStrategy  |
+                            +-------|-----+     |                    |
+                            |Configuration|     +--------------------+
+                            +-------------+
+```
+
+Let's look at the pieces:
+
+1. the repository itself - which is a simple module including the
+   `Receptacle` mixin
+
+```ruby
+module Repository
+  module User
+    include Receptacle::Repo
+    
+    mediate :find
+  end
+end
+```
+
+2. at least one strategy class which are implemented as plain ruby classes
+
+```ruby
+module Strategy
+  class Database
+    def find(id:)
+      # get data from data source and return a business entity
+    end
+  end
+end
+```
+
+Optionally wrapper classes can be defined
+
+```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
+```
+
+### Example
+
+Everything combined a simple example could look like the following:
+
+```ruby
+require "receptacle"
+
+module Repository
+  module User
+    include Receptacle::Repo
+    mediate :find
+
+    module Strategy
+      class DB
+        def find(id:)
+          # code to find from the database
+        end
+      end
+      class InMemory
+        def find(id:)
+          # code to find from InMemory store
+        end
+      end
+    end
+
+    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
+  end
+end
+```
+
+For better separation to other repositories the fact that the repository itself
+is a module can be used to nest both strategies and wrapper underneath.
+
+Somewhere in your application config you now need to setup the strategy and the
+wrappers for this repository like this:
+
+```ruby
+Repository::User.strategy Repository::User::Strategy::DB
+Repository::User.wrappers [Repository::User::Wrapper::Validator,
+                           Repository::User::Wrapper::ModelMapper])
+```
+
+With this setup to use the repository method is as simple and straight forward
+as calling `Repository::User.find(id: 123)`
+
+## Repository Pattern
+
+What is the matter with this repository pattern and why should I care using it?
+
+### Motivation
+
+Often the business logic of applications directly accesses a data source like a
+database. This has several disadvantages such as
+
+- code duplication cased by repeated need to transform raw data into business
+  entities
+- no separation between business logic and access to the data source
+- harder to add or change global policies like caching
+- caused by missing isolation it's harder to test the business logic independent
+  from the data source
+
+### Solution
+
+To improve on the disadvantages above and more we can introduce a repository
+which mediates between the business logic and the data source. The data source
+can be for example a database, an API(be it internal or external) or other web
+services.
+
+A repository provides the business logic with a stable interface to interact
+with the data source. Hereby is the repository mapping the data to business
+entities. Because the repository is a central place to access the data source
+caching policies or similar can be applied easily there.
+
+During testing the repository can be switched to a different strategy for
+example a fast and lightweight in memory data store to ease the process of
+testing the business logic.
+
+Due to the ability to switch strategies a repository can also help to keep the
+application architecture flexible as a change in strategy has no impact on the
+business logic above.
+
+## Details
+
+### Strategy
+
+A strategy is implemented as simple ruby class which implements the direct
+access to a data source by implementing the same method (as instance method)
+which was setup in the repository.
+
+On each call to the repository a new instance of this class is created on which
+then the mediated method is called.
+
+```ruby
+module Strategy
+  class Database
+    def find(id:)
+      # get data from data source and return a business entity
+    end
+  end
+end
+```
+
+Due to the nature of creating a new instance on each method call persistent
+connections to the data source like a connection pool should be maintained
+outside the strategy itself. For example in a singleton class.
+
+### Wrapper
+
+In addition to create a separation between data access and business logic often
+there is the need to perform certain actions in the context of a data source
+access. For example there can be the need to send message on a message bus whenever a
+resource was created - independent of the strategy.
+
+This gem allow one to add such actions without adding them to all strategies or
+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.
+
+#### 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.
+
+```ruby
+module Wrapper
+  class Validator
+    def before_find(id:)
+      raise ArgumentError if id.nil?
+      {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.
+
+### Memory Strategy
+
+Although currently not part of the gem a simple memory strategy can be
+implemented in this way:
+
+```ruby
+class MemoryStore
+  class << self; attr_accessor :store end
+  
+  def clear
+    self.class.store = []
+  end
+  
+  private def store
+    self.class.store || clear
+  end
+end
+```
+
+## How does it compare to other repository pattern implementations
+
+Compared to other gem implementing the repository pattern this gem makes no
+assumptions regarding the interface of your repository or what kind of data
+source is used.
+Some alternative have some interesting features nevertheless:
+
+- [Hanami::Repository](https://github.com/hanami/model#repositories) is for one
+  closely tied to the the Hanami entities and does not separate the repository
+  interface from the implementing strategies. For straight forward mapping of
+  entity to data source this might be enough though. Another caveat is that it
+  currently only supports SQL data sources.
+- [ROM::Repository](http://rom-rb.org/learn/repositories/) similarly is tied to
+  other facilities of ROM like the ROM containers. It also appears to take a
+  similar approach as Hanami to custom queries which should not leak to the
+  outside application. There is predefined interface for manipulating resources
+  through. The addition of `ROM::Changeset` brings an interesting addition to
+  the mix which might make it an interesting alternative if using `ROM` fits
+  into the applications structure.
+  
+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
+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,
+the [faraday](https://github.com/lostisland/faraday) gem is essentially doing
+this by giving all the different http libraries a common interface).
+
+
+## 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
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file
+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,
+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
+the [MIT License](http://opensource.org/licenses/MIT).
+
+[runtastic]: https://github.com/runtastic

data/Rakefile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+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']
+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
+
+task default: :test

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+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'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+bundle exec rake rubocop:install