encapsulate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e780a5ee6b125851b50a31ac06d586b7d53071d
+  data.tar.gz: c68e720426f79ad6ea3158b6c5f48d5dee7450a6
+SHA512:
+  metadata.gz: 4c028bd04704ce813ccd553246292ad11d82abc14aedd0ec49a2f3ca56061f55b7a9b9408591a92387e99a2947081afb870646dd3bf819f3a8108feb17f21d84
+  data.tar.gz: 5f2f28a451cc43a617ffc5a7c2f5810b7d5f9cecd1513cca60c51b575d5f07ff477a94b21444b45453fc279feae7a4c6c80350ce4301dd593742b7e933b9b732

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in encapsulate.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 
+
+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,222 @@
+# Encapsulate
+
+#### A small Ruby framework that enables encapsulating pieces of code within eachother.
+
+| Branch | Status |
+| ------ | ------ |
+| Release | [![Build Status](https://travis-ci.org/thisismydesign/encapsulate.svg?branch=release)](https://travis-ci.org/thisismydesign/encapsulate)   [![Coverage Status](https://coveralls.io/repos/github/thisismydesign/encapsulate/badge.svg?branch=release)](https://coveralls.io/github/thisismydesign/encapsulate?branch=release)   [![Gem Version](https://badge.fury.io/rb/encapsulate.svg)](https://badge.fury.io/rb/encapsulate)   [![Total Downloads](http://ruby-gem-downloads-badge.herokuapp.com/encapsulate?type=total)](https://rubygems.org/gems/encapsulate) |
+| Development | [![Build Status](https://travis-ci.org/thisismydesign/encapsulate.svg?branch=master)](https://travis-ci.org/thisismydesign/encapsulate)   [![Coverage Status](https://coveralls.io/repos/github/thisismydesign/encapsulate/badge.svg?branch=master)](https://coveralls.io/github/thisismydesign/encapsulate?branch=master) |
+
+## What is this?
+
+Ever get tired of writing exception handling blocks? Ever think it's not really DRY (Don't Repeat Yourself)?
+
+Wouldn't it be better instead of...
+
+```ruby
+begin
+  read_file
+rescue IOError => e
+  handle_io_error
+ensure
+  close_io
+end
+```
+
+... to just write
+
+```ruby
+run callback: read_file, with: io_error_handling
+```
+
+Not to mention code duplications you just can't get rid of
+
+```ruby
+signal_processing_start
+start_time_measurement
+
+process
+
+stop_time_measurement
+signal_processing_end
+```
+
+How about
+
+```ruby
+run callback: process, with: [time_measurement, lifecycle_signals]
+```
+
+Encapsulate enables you to do just that.
+
+## How does it work?
+
+We essentially want to create the following structure:
+```ruby
+encapsulator1
+  # ...
+  encapsulator2
+    # ...
+      base_function
+        # ...
+      end
+    # ...
+  end
+  # ...
+end
+```
+
+In order to achieve this each encapsulator function must know the next one in the chain (the last one being the base function). Also the parameters of the base function must be carried by the encapsulators. Our pseudocode should look something like this:
+
+```ruby
+def encapsulator1(callback:, params: nil)
+  # some logic...
+  def encapsulator2(callback:, params: nil)
+    # some logic...
+      base_function(params)
+    # some logic...
+  end
+  # some logic...
+end
+```
+
+## How to use it?
+
+Below you will find some insight on how to create and structure your call chains but you can also head right to the [unit tests](https://github.com/thisismydesign/encapsulate/blob/master/spec/encapsulate_spec.rb) for hands-on examples.
+
+### Building the chain
+
+```ruby
+# Single encapsulator
+Encapsulate.run callback: base_function, with: [encapsulator]
+
+# Multiple encapsulators
+# They will apply in the given order: encapsulator2(encapsulator1(callback))
+Encapsulate.run callback: base_function, with: [encapsulator1, encapsulator2]
+
+# Parameters
+Encapsulate.run callback: base_function, with: [encapsulator1, encapsulator2], params: {arg: 'something'}
+```
+
+### Base function
+
+To sidestep the issue of varying number of parameters we must use [keyword arguments or a single Hash parameter](https://robots.thoughtbot.com/ruby-2-keyword-arguments) in the base function.
+
+```ruby
+def self.base_function(my_param:, my_other_param:)
+  # ...
+end
+
+base_function = self.method(:base_function)
+```
+
+### Encapsulators
+
+Encapsulators should be implemented (for reasons detailed in the previous chapter) along the lines of:
+
+```ruby
+def self.my_encapsulator(callback:, params: nil)
+  # ...
+  params.nil? ? callback.call : callback.call(params)
+  # ...
+end
+
+my_encapsulator = self.method(:my_encapsulator)
+```
+
+The base function may take no parameters which is why `params` in our interface must default to nil and we also need to take care of calling the `callback` accordingly. This small piece of logic is implemented in the gem [reflection_utils](https://github.com/thisismydesign/reflection_utils) (as seen below) alongside with other useful reflection related functions.
+
+You may use any objects that respond to `call`. The only difference will be in how you reference these objects.
+These are also valid skeletons:
+
+```ruby
+my_encapsulator = lambda do |callback:, params: nil|
+  # ...
+  ReflectionUtils.call(callback, params)
+  # ...
+end
+```
+
+```ruby
+my_encapsulator = Proc.new do |callback:, params: nil|
+  # ...
+  ReflectionUtils.call(callback, params)
+  # ...
+end
+```
+
+Encapsulators will ideally not use any parameters. They do take the base function's parameter hash as second parameter and you could *technically* hide additional parameters there but it's not a good practice. Instead:
+- try to keep encapsulators simple
+- use their own classes to configure them
+
+This brings us to how to structure encapsulators. You have several options.
+
+#### 1 class per encapsulator
+
+```ruby
+class ExceptionEncapsulator
+  def self.callback(callback:, params: nil)
+    # ...
+  end
+end
+```
+
+#### Collcetor class
+
+```ruby
+class Encapsulators
+  def self.exception_handling(callback:, params: nil)
+    # ...
+  end
+  
+  def self.time_measurement(callback:, params: nil)
+    # ...
+  end
+  
+  # ...
+end
+```
+
+#### In place
+
+```ruby
+my_encapsulator = lambda do |callback:, params: nil|
+  # ...
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'encapsulate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install encapsulate
+
+## Feedback
+
+Any feedback is much appreciated.
+
+I can only tailor this project to fit use-cases I know about - which are usually my own ones. If you find that this might be the right direction to solve your problem too but you find that it's suboptimal or lacks features don't hesitate to contact me.
+
+Please let me know if you make use of this project so that I can prioritize further efforts.
+
+## Development
+
+This gem is developed using Bundler conventions. A good overview can be found [here](http://bundler.io/v1.14/guides/creating_gem.html).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/thisismydesign/encapsulate.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Check if source can be required locally"
+task :require do
+  sh "ruby -e \"require '#{File.dirname __FILE__}/lib/encapsulate'\""
+end
+
+task :default => [:require, :spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "encapsulate"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/encapsulate.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'encapsulate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "encapsulate"
+  spec.version       = Encapsulate::VERSION
+  spec.authors       = ["thisismydesign"]
+  spec.email         = ["thisismydesign@users.noreply.github.com"]
+
+  spec.summary       = "A small framework that enables encapsulating pieces of code within eachother."
+  spec.homepage      = "https://github.com/thisismydesign/encapsulate"
+
+  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.add_dependency "reflection_utils"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "coveralls"
+end

data/lib/encapsulate.rb

@@ -0,0 +1,23 @@
+require 'reflection_utils'
+
+module Encapsulate
+
+  @@encapsulator_params = [[:keyreq, :callback], [:key, :params]]
+
+  def self.run(callback:, with:, params:nil)
+    ReflectionUtils.call(create(callback: callback, with: with), params)
+  end
+
+  def self.create(callback:, with:)
+    lambdas = []
+    lambdas[0] = callback
+
+    with.each_with_index do |encapsulator, index|
+      ReflectionUtils.assert_parameters(encapsulator, @@encapsulator_params)
+      lambdas[index + 1] = lambda { |params = nil| encapsulator.call(callback: lambdas[index], params: params) }
+    end
+
+    lambdas.last
+  end
+
+end

data/lib/encapsulate/version.rb

@@ -0,0 +1,3 @@
+module Encapsulate
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: encapsulate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- thisismydesign
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: reflection_utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+description: 
+email:
+- thisismydesign@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- encapsulate.gemspec
+- lib/encapsulate.rb
+- lib/encapsulate/version.rb
+homepage: https://github.com/thisismydesign/encapsulate
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A small framework that enables encapsulating pieces of code within eachother.
+test_files: []