course 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42b93dcd580bb0523ecdab134c05b492f61e4801
+  data.tar.gz: 3d8210ab14b6e2dd573c6535ba589d0dd862f489
+SHA512:
+  metadata.gz: 431a3ca4c25d0a76513866532f52b56850717ac24e00cdd0ced638ecd5676a951726d2a11cc001ef7f8461d47be5c38ea150ff591d84952e6825c9514f284f90
+  data.tar.gz: 10b86c99bdf4d84b921e1d6e5e178aea406cd92efcefbe782c30ba42eb889d1c34617fc202da17af6dc1d73f81621f5865849fef0fd55cdf1989caa07415d608

data/.gitignore

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

data/.overcommit.yml

@@ -0,0 +1,4 @@
+PreCommit:
+  RuboCop:
+    enabled: true
+    on_warn: fail # Treat all warnings as failures

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--order rand

data/.rubocop.yml

@@ -0,0 +1,20 @@
+# https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+
+AllCops:
+  Exclude:
+    - '*.gemspec'
+  TargetRubyVersion: 2.4.1
+  DisplayCopNames: true
+
+Metrics/LineLength:
+  Max: 110
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+
+Style/SignalException:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+course

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in course.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Gleb Sinyavsky
+
+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/Makefile

@@ -0,0 +1,9 @@
+changelog:
+	-!(which conventional-changelog) && npm i -g conventional-changelog-cli
+	conventional-changelog -p angular -i CHANGELOG.md -s -r 0
+
+yard_server:
+	open http://localhost:8808
+	yard server --reload
+
+.PHONY: all

data/README.md

@@ -0,0 +1,110 @@
+# Course
+
+Inspired and forked from [opie](https://github.com/guzart/opie)
+
+**Course gives you a simple API for creating Operations using the
+[Railsway oriented programming](https://vimeo.com/113707214) paradigm.**
+
+## Usage
+
+**Simple Usage:**
+
+```ruby
+# Create an Operation for completing a Todo
+class Todos::CompleteTodo < Course::Operation
+  step :find_todo
+  step :mark_as_complete
+
+  def find_todo(todo_id)
+    todo = Todo.find_by(id: todo_id)
+    fail(:not_found, "Could not find the Todo using id: #{todo_id}") unless todo
+    todo
+  end
+
+  def mark_as_complete(todo)
+    success = todo.update(completed_at: Time.zone.now)
+    fail(:update) unless success
+    todo
+  end
+end
+
+class TodosController < ApplicationController
+  def complete
+    # invoke the operation
+    result = Todos::CompleteTodo.(params[:id])
+    if result.success? # if #success?
+      render status: :created, json: result.output # use output
+    else
+      render status: :bad_request, json: { error: error_message(result.failure) } # otherwise use #failure
+    end
+  end
+
+  private
+
+  def error_message(failure)
+    case failure[:type]
+      when :not_found then failure[:data]
+      when :update then 'We were unable to make the changes to your todo'
+      else 'There was an unexpected error, sorry for the inconvenience'
+    end
+  end
+end
+```
+
+## API
+
+The `Course::Operation` API:
+  * `::step(Symbol) -> void` indicates a method that is executed in the operation sequence
+  * `#success? -> Boolean` indicates  whether the operation was successful
+  * `#failure? -> Boolean` indicates  whether the operation was a failure
+  * `#failure -> Hash | nil` the erorr if the operation is a `failure?`, nil when it's a success
+  * `#failures -> Array<Hash> | nil` an array with all errors
+  * `#output -> *` if succcessful, it returns the operation final output
+  validation error
+
+Internal API:
+  * `#fail(error_type: Symbol, error_data: *) -> Hash`
+
+_Tentative API_
+
+  * `::step(Array<Symbol>) -> void` a series of methods to be called in parallel
+  * `::step(Course::Step) -> void` an enforcer of a step signature which helps to compose other steps
+  * `::failure(Symbol) -> void` indicates the method that handles failures
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'course'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install course
+```
+
+## 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/zhulik/course
+
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'course'
+
+# 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/guard

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', 'guard')

data/bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

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/course.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'course/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'course'
+  spec.version       = Course::VERSION
+  spec.authors       = ['Arturo Guzman', 'Gleb Sinyavsky']
+  spec.email         = ['arturo@guzart.com', 'zhulik.gleb@gmail.com']
+
+  spec.summary       = 'Operations API for Railway oriented programming in Ruby'
+  spec.description   = <<~DOC
+    Course provides an API for building your application operations/transactions using
+    the Railway oriented programming paradigm
+  DOC
+  spec.homepage      = 'https://github.com/zhulik/course'
+  spec.license       = 'MIT'
+
+  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_development_dependency 'awesome_print', '~> 1.7'
+  spec.add_development_dependency 'byebug', '~> 9.0'
+  spec.add_development_dependency 'codecov', '~> 0'
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/lib/course.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Course
+  require 'course/version'
+  require 'course/step'
+  require 'course/result'
+  require 'course/failure_error'
+  require 'course/failure'
+  require 'course/operation'
+end

data/lib/course/failure.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Course
+  class Failure
+    attr_reader :data, :type
+
+    def initialize(type, data = nil)
+      @type = type
+      @data = data
+    end
+
+    def ==(other)
+      type == other.type && data == other.data
+    end
+
+    def hash
+      [type, (data || '').to_sym].hash
+    end
+  end
+end

data/lib/course/failure_error.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Course
+  class FailureError < StandardError
+    attr_reader :failure
+
+    def initialize(failure)
+      super('Step failed')
+      @failure = failure
+    end
+  end
+end

data/lib/course/operation.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Course
+  class Operation
+    class << self
+      def call(*input, &block)
+        new.call(*input, &block)
+      end
+
+      def step(name = nil, **options, &block)
+        steps << Course::Step.new(name, block, **options)
+      end
+
+      def steps
+        @steps ||= []
+      end
+
+      def inherited(child)
+        child.instance_variable_set('@steps', @steps.clone)
+      end
+    end
+
+    def call(*input, &block)
+      execute_steps(input, &block)
+      return yield result if block_given?
+      result
+    end
+
+    def result
+      Course::Result.new(output: @output, failure: @failure)
+    end
+
+    private
+
+    def fail(type, data = nil)
+      raise FailureError, Failure.new(type, data)
+    end
+
+    def execute_steps(*input)
+      @output = self.class.steps.inject(*input, &method(:execute))
+    rescue FailureError => e
+      @failure = e.failure
+    end
+
+    def execute(next_input, step)
+      if step.method?
+        execute_step(method(step.target), next_input)
+      elsif step.block?
+        execute_step(step.block, next_input)
+      else
+        execute_operation(step.target, *next_input)
+      end
+    end
+
+    def execute_step(next_step, input)
+      if input.is_a?(Array) && (next_step.arity == input.count || next_step.arity == -1)
+        next_step.call(*input)
+      else
+        next_step.call(input)
+      end
+    end
+
+    def execute_operation(klass, *input)
+      klass.call(*input) do |res|
+        res.on_success do |output|
+          return output
+        end
+        res.on_fail do |err|
+          raise FailureError, err
+        end
+      end
+    end
+  end
+end

data/lib/course/result.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Course
+  class Result
+    attr_reader :failure, :output
+
+    def initialize(output: nil, failure: nil)
+      @output = output
+      @failure = failure
+    end
+
+    def failure?
+      !success?
+    end
+
+    def on_fail
+      yield failure if block_given? && failure?
+    end
+
+    def success?
+      failure.nil?
+    end
+
+    def on_success
+      yield output if block_given? && success?
+    end
+  end
+end

data/lib/course/step.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Course
+  class Step
+    attr_reader :target, :options, :block
+
+    def initialize(target, block, **options)
+      raise ArgumentError, 'Cannot create a step with both name and block' if !target.nil? && !block.nil?
+      raise ArgumentError, 'Step name or block should be passed' if target.nil? && block.nil?
+
+      @target = target
+      @options = options
+      @block = block
+    end
+
+    def method?
+      target.is_a?(String) || target.is_a?(Symbol)
+    end
+
+    def block?
+      !@block.nil?
+    end
+  end
+end

data/lib/course/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Course
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: course
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Arturo Guzman
+- Gleb Sinyavsky
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  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'
+- !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: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !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.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: |
+  Course provides an API for building your application operations/transactions using
+  the Railway oriented programming paradigm
+email:
+- arturo@guzart.com
+- zhulik.gleb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".overcommit.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- Makefile
+- README.md
+- Rakefile
+- bin/console
+- bin/guard
+- bin/rspec
+- bin/setup
+- course.gemspec
+- lib/course.rb
+- lib/course/failure.rb
+- lib/course/failure_error.rb
+- lib/course/operation.rb
+- lib/course/result.rb
+- lib/course/step.rb
+- lib/course/version.rb
+homepage: https://github.com/zhulik/course
+licenses:
+- MIT
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Operations API for Railway oriented programming in Ruby
+test_files: []