torihiki 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4749f71c67656610525b0be4d494d353afb8f22b
+  data.tar.gz: 4a4284e6c6966d9ff342e90bede9d73bf99697d4
+SHA512:
+  metadata.gz: 1e2491e48b8acd097f4d9eee050220af1ca8ea9bafee086f34ae60d7034d000c01ff92629c80dd9b32d0f658402434fd3a282454a2b47bf84e4da249d8536b30
+  data.tar.gz: 14f9f2e583de2551efd0062c24fdc5618c02b5cddf651922040e1635558de407e838b77545bf23738a08f875e8e679b7025300019ead7c348073ba09f25058e2

data/.gitignore

@@ -0,0 +1,45 @@
+*.rbc
+capybara-*.html
+.rspec
+.rspec_status
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+*.orig
+rerun.txt
+pickle-email-*.html
+
+# TODO Comment out this rule if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+
+# Only include if you have production secrets in this file, which is no longer a Rails default
+# config/secrets.yml
+
+# dotenv
+# TODO Comment out this rule if environment variables can be committed
+.env
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+# Ignore Byebug command history file.
+.byebug_history

data/.travis.yml

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

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 v@vforvova.ru. 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,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    torihiki (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ast (2.3.0)
+    coderay (1.1.1)
+    diff-lcs (1.3)
+    method_source (0.8.2)
+    parallel (1.11.2)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rainbow (2.2.2)
+      rake
+    rake (12.0.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubocop (0.49.1)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    slop (3.6.0)
+    unicode-display_width (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.5.0)
+  pry (~> 0.10.4)
+  rspec (~> 3.2)
+  rubocop (~> 0.49.0)
+  torihiki!
+
+BUNDLED WITH
+   1.15.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Vladimir Smyshlyaev
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Vladimir Smyshlyaev
+
+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,81 @@
+# Torihiki
+
+Torihiki is a simple DSL inspired by [dry-transaction]() gem.
+It builds a composition of functions which would help you create business transactions without magic.
+
+Torihiki doesn’t include error handling out of the box, but you feel free to use [dry-either]()
+or anything esle for error handling.
+
+## What function composition exactly is?
+
+## Usage
+Include Torihiki into your class to make it store your composition
+nclude DSL similar to dry-transaction.
+
+### Build simple composition
+```ruby
+class Transaction
+  include Torihiki
+  include Torihiki::Handlers
+
+  map AuthenticationService
+  map ValidationService
+  map do
+    # some operations
+  end
+  map do
+    # persistence operation
+  end
+end
+
+Transaction.call(context)
+```
+### Build chainable composition
+### Usage with Dry::Either
+
+### Handlers
+
+#### tap
+```ruby
+def tap(input)
+  map do |context|
+    input.call(context)
+    context
+  end
+end
+```
+
+#### reduce / merge
+```ruby
+def reduce(input)
+  map do |context|
+    context.merge(input.call context)
+  end
+end
+```
+
+#### try
+```ruby
+def try(input)
+  map do |context|
+    input.call(context)
+  rescue
+    context
+  end
+end
+```
+
+#### either
+```ruby
+def either(input)
+  map do |context|
+    Left(input.call(context))
+  rescue error
+    Right(error)
+  end
+end
+```
+
+#### sequence ???
+
+## Contribution Guide

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "torihiki"
+
+# 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
+
+# Do any other automated setup that you need to do here

data/lib/torihiki.rb

@@ -0,0 +1,24 @@
+require 'torihiki/composition'
+
+module Torihiki
+  def self.included(host)
+    host.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def map(input)
+      @io = io.map(input.is_a?(Symbol) ? method(input) : input)
+      self
+    end
+
+    def call(context)
+      io.call(context)
+    end
+
+    private
+
+    def io
+      @io ||= Composition.new
+    end
+  end
+end

data/lib/torihiki/composition.rb

@@ -0,0 +1,23 @@
+module Torihiki
+  class Composition
+    def initialize(composition = [])
+      @composition = composition.freeze
+    end
+
+    def call(context)
+      @composition.reduce(context) { |acc, func| func.call(acc) }
+    end
+
+    def map(callable = nil, &block)
+      input = block || callable
+      raise ComposedNonCallableError.new(@composition.size) unless input.respond_to? :call
+      self.class.new(@composition + [input])
+    end
+  end
+
+  class ComposedNonCallableError < StandardError
+    def message
+      "Composition recieved a function which does not respond to method call"
+    end
+  end
+end

data/lib/torihiki/version.rb

@@ -0,0 +1,3 @@
+module Torihiki
+  VERSION = '0.1.0'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require "bundler/setup"
+require 'pry'
+require "torihiki"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/torihiki/composition_spec.rb

@@ -0,0 +1,146 @@
+require "spec_helper"
+
+RSpec.describe Torihiki::Composition do
+  it { expect(subject.instance_variable_get(:@composition).frozen?).to be_truthy }
+  it { is_expected.to respond_to :map }
+  it { is_expected.to respond_to :call }
+
+  context 'with lambdas' do
+    let(:io) do
+      subject
+        .map(->(num) { num + 2 })
+        .map(->(sum) { sum * 2 })
+    end
+
+    describe '#map' do
+      it 'returns new object' do
+        expect(io).not_to eq subject
+      end
+
+      it 'returns object with expanded composition' do
+        expect(subject.instance_variable_get(:@composition).size).to be_zero
+        expect(io.instance_variable_get(:@composition).size).to eq 2
+      end
+    end
+
+    describe '#call' do
+      it 'does all the calculation through the composition' do
+        expect(io.call(0)).to eq 4
+        expect(io.call(1)).to eq 6
+        expect(io.call(2)).to eq 8
+      end
+    end
+  end
+
+  context 'with procs' do
+    let(:io) do
+      subject
+        .map(proc { |num| num + 2 })
+        .map(proc { |sum| sum * 2 })
+    end
+
+    describe '#map' do
+      it 'returns new object' do
+        expect(io).not_to eq subject
+      end
+
+      it 'returns object with expanded composition' do
+        expect(subject.instance_variable_get(:@composition).size).to be_zero
+        expect(io.instance_variable_get(:@composition).size).to eq 2
+      end
+    end
+
+    describe '#call' do
+      it 'does all the calculation through the composition' do
+        expect(io.call(0)).to eq 4
+        expect(io.call(1)).to eq 6
+        expect(io.call(2)).to eq 8
+      end
+    end
+  end
+
+  context 'with blocks' do
+    let(:io) do
+      subject
+        .map { |num| num + 2 }
+        .map { |sum| sum * 2 }
+    end
+
+    describe '#map' do
+      it 'returns new object' do
+        expect(io).not_to eq subject
+      end
+
+      it 'returns object with expanded composition' do
+        expect(subject.instance_variable_get(:@composition).size).to be_zero
+        expect(io.instance_variable_get(:@composition).size).to eq 2
+      end
+    end
+
+    describe '#call' do
+      it 'does all the calculation through the composition' do
+        expect(io.call(0)).to eq 4
+        expect(io.call(1)).to eq 6
+        expect(io.call(2)).to eq 8
+      end
+    end
+  end
+
+  context 'with callable' do
+    module Callable
+      class A
+        def call(context)
+          context + 2
+        end
+      end
+
+      module B
+        def self.call(context)
+          context * 2
+        end
+      end
+    end
+
+    let(:io) do
+      subject
+        .map(Callable::A.new)
+        .map(Callable::B)
+    end
+
+    describe '#map' do
+      it 'returns new object' do
+        expect(io).not_to eq subject
+      end
+
+      it 'returns object with expanded composition' do
+        expect(subject.instance_variable_get(:@composition).size).to be_zero
+        expect(io.instance_variable_get(:@composition).size).to eq 2
+      end
+    end
+
+    describe '#call' do
+      it 'does all the calculation through the composition' do
+        expect(io.call(0)).to eq 4
+        expect(io.call(1)).to eq 6
+        expect(io.call(2)).to eq 8
+      end
+    end
+  end
+
+  context 'with noncallable' do
+    module Noncallable; end
+
+    let(:io) do
+      subject.map(Noncallable)
+    end
+
+    describe '#map' do
+      it 'raises an error' do
+        expect { io }.to raise_error(
+          Torihiki::CompositionError,
+          'You have to specify block or provide callable argument'
+        )
+      end
+    end
+  end
+end

data/spec/torihiki_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+
+RSpec.describe Torihiki do
+  it "has a version number" do
+    expect(Torihiki::VERSION).not_to be nil
+  end
+
+  context 'when included' do
+    class TransactionClass
+      include Torihiki
+    end
+
+    subject { TransactionClass }
+
+    it { is_expected.to respond_to :map }
+    it { is_expected.to respond_to :call }
+
+    describe 'operation inside' do
+      class A < TransactionClass
+        map ->(context) { context * 2 }
+      end
+
+      it 'returns expected value' do
+        expect(A.call(1)).to eq 2
+      end
+
+      it 'contains one operation' do
+        composition = A.send(:io).instance_variable_get(:@composition)
+        expect(composition.size).to eq 1
+      end
+    end
+
+    describe 'operation as pipeline' do
+      class B < TransactionClass
+        map ->(context) { context * 2 }
+      end
+      B.map ->(context) { context * 3 }
+
+      it 'returns correct result' do
+        expect(B.call(1)).to eq 6
+      end
+
+      it 'contains three operations' do
+        composition = B.send(:io).instance_variable_get(:@composition)
+        expect(composition.size).to eq 2
+      end
+    end
+
+    describe 'handler registration' do
+      class C < TransactionClass
+        def self.tap(input)
+          map ->(context) { input.call(context); context; }
+        end
+
+        tap ->(context) { context * 2 }
+      end
+
+      it 'returns correct result' do
+        expect(C.call(1)).to eq 1
+      end
+    end
+  end
+end

data/torihiki.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/torihiki/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = "torihiki"
+  s.version = Torihiki::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Vladimir Smyshlyaev']
+  s.email = ['v@vforvova.ru']
+  s.homepage = ""
+  s.summary = ""
+  s.description = ""
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project = "torihiki"
+
+  s.add_development_dependency "bundler", ">= 1.5.0"
+  s.add_development_dependency "rubocop", "~> 0.49.0"
+  s.add_development_dependency "rspec", "~> 3.2"
+  s.add_development_dependency "pry", "~> 0.10.4"
+
+  s.files = `git ls-files`.split("\n")
+  s.executables = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: torihiki
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vladimir Smyshlyaev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.49.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+description: ''
+email:
+- v@vforvova.ru
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/torihiki.rb
+- lib/torihiki/composition.rb
+- lib/torihiki/version.rb
+- spec/spec_helper.rb
+- spec/torihiki/composition_spec.rb
+- spec/torihiki_spec.rb
+- torihiki.gemspec
+homepage: ''
+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: 1.3.6
+requirements: []
+rubyforge_project: torihiki
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []