railway_operation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f98482d3c4408b13a570eb7ef7aa82ed476d202
+  data.tar.gz: 50c63207bc89ab21e457a5103e0a1fb59fc1a565
+SHA512:
+  metadata.gz: 9ebde675b7cd14b824bd6ee2ef6f9038418ce28fcb728a12e8290faaa76f68d81f5dff45eff9c41ea3086aaa40ffa441ed2a26726a0a657440bfe633aca59b44
+  data.tar.gz: f01a2016c484614e6a3563f4b3b7b1cd2ae290b972b7650caf89ef1ccc7a0c316514ee195d277112af73d7f92fa3369d50bc9452658d0992ee675df4e91911d3

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/.rubocop.yml

@@ -0,0 +1,31 @@
+inherit_from: .rubocop_todo.yml
+
+Gemspec/OrderedDependencies:
+  Exclude:
+    - 'railway_operation.gemspec'
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'Gemfile'
+    - 'bin/console'
+
+Metrics/BlockLength:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Style/DoubleNegation:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
+Style/Lambda:
+  Enabled: false
+Style/LambdaCall:
+  Enabled: false
+Style/SymbolArray:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/WordArray:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,73 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-03-10 19:36:36 -0500 using RuboCop version 0.52.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/Void:
+  Exclude:
+    - 'lib/railway_operation/filled_matrix.rb'
+
+# Offense count: 3
+Metrics/AbcSize:
+  Max: 41
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 10
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: braces, no_braces, context_dependent
+Style/BracesAroundHashParameters:
+  Exclude:
+    - 'lib/railway_operation/operator.rb'
+
+# Offense count: 5
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/railway_operation.rb'
+    - 'lib/railway_operation/filled_matrix.rb'
+    - 'lib/railway_operation/operator.rb'
+    - 'lib/railway_operation/surround.rb'
+    - 'lib/railway_operation/visualizer.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: compact, exploded
+Style/RaiseArgs:
+  Exclude:
+    - 'lib/railway_operation/operator.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: implicit, explicit
+Style/RescueStandardError:
+  Exclude:
+    - 'lib/railway_operation/operator.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'bin/console'
+
+# Offense count: 13
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 105

data/.ruby-version

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

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install:
+  - gem install bundler -v 1.14.6
+  - "sudo apt-get install graphviz"
+script:
+  - bundle exec rspec spec

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 felixflores@gmail.com. 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 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in railway_operation.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Felix Flores
+
+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,326 @@
+[![Build Status](https://travis-ci.org/felixflores/railway_operation.svg?branch=master)](https://travis-ci.org/felixflores/railway_operation)
+
+# RailwayOperation
+
+This gem allows you to declare and compose a set of operations into a functional execution tree inspired by the railway oriented programming pattern. See ([https://fsharpforfunandprofit.com/rop/](https://fsharpforfunandprofit.com/rop/)) for more details.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'railway_operation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install railway_operation
+    
+Then in any of your ruby class `include RailwayOperation::Operator`.
+
+## Basic Usage
+Let's say we have the following class
+
+```ruby
+module Readme
+  class Example1
+    def initialize(someone = 'someone')
+      @someone = someone
+    end
+
+    def first_method(argument)
+      argument << "Hello #{@someone}, from first_method."
+    end
+
+    def another_method(argument)
+      argument << 'Hello from another_method.'
+    end
+
+    def final_method(argument)
+      argument << 'Hello from final_method.'
+    end
+  end
+end
+```
+
+We could perform the follow chain of execution, to yield the following result.
+
+```ruby
+ex1 = Readme::Example1.new('Felix')
+
+argument = []
+argument = ex1.first_method(argument)
+argument = ex1.another_method(argument)
+result = ex1.final_method(argument)
+
+result == [
+  'Hello Felix, from first_method.'
+  'Hello from another_method.'
+  'Hello from final_method.'
+]
+```
+
+RailwayOperation provides a way for you to declare the same execution chain as a series of steps in an operation. 
+
+If we add the following
+
+```ruby
+module Readme
+  class Example1
+    include RailwayOperation
+```
+
+to your class, we can then declare an operation block
+
+```ruby
+    operation do |o|
+      o.add_step 1, :first_method
+      o.add_step 1, :another_method
+      o.add_step 1, :final_method
+    end
+```
+
+Before we can take advantage of RailwayOperation we need to modify our method signatures slightly from `def first_method(argument)` to `def first_method(arugment, **)`. This allows our methods to accept an addtional has called info (we will cover this topic of `info` in more detail shortly)
+
+[./spec/readme/example_1\_spec.rb](https://github.com/felixflores/railway_operation/blob/master/spec/readme/example_1_spec.rb)
+
+```ruby
+module Readme
+  class Example1
+    include RailwayOperation
+
+    operation do |o|
+      o.add_step 1, :first_method
+      o.add_step 1, :another_method
+      o.add_step 1, :final_method
+    end
+
+    def initialize(someone = 'someone')
+      @someone = someone
+    end
+
+    def first_method(argument, **)
+      argument << "Hello #{@someone}, from first_method."
+    end
+
+    def another_method(argument, **)
+      argument << 'Hello from another_method.'
+    end
+
+    def final_method(argument, **)
+      argument << 'Hello from final_method.'
+    end
+  end
+end
+```
+
+Now we can call the `.run` method on the class to yeild the same result.
+
+```ruby
+arugment = []
+result, info = Readme::Example1.new('Felix').run(argument)
+
+result == [
+  'Hello Felix, from first_method.'
+  'Hello from another_method.'
+  'Hello from final_method.'
+]
+```
+
+Additionally, if your class does not require any arguments in its initializer you can call.
+
+```ruby
+result, info = Readme::Example1.run(argument)
+
+result == [
+  'Hello someone, from first_method.',
+  'Hello from another_method.',
+  'Hello from final_method.'
+]
+```
+
+One important detail to call out here is that calling run returns the `result` object (which is the return value of the operation) and an `info` object which is a hash like object containing information about the execution of the operation. To see a brief overview of the types of information `info` see [./spec/readme/example\_1_spec.rb](https://github.com/felixflores/railway_operation/blob/master/spec/readme/example_1_spec.rb)
+
+A more detailed explanation of `info` is on the [RailwayOperation: Info](https://github.com/felixflores/railway_operation#info) section.
+
+## Multitrack Execution
+
+### Stepper Function
+So far we've seen a single track execution of an operation. The track is the first argument of the `add_step` method. In our previous example all our steps executed on track 1.
+
+![basic - page 1](https://user-images.githubusercontent.com/65030/38450687-5067bd94-39f0-11e8-9b85-198ba7b28b1b.png)
+
+
+Let's now consider the following example
+
+```ruby
+module Readme
+  class Example2_1
+    include RailwayOperation
+
+    operation do |o|
+      o.add_step 1, :method_1
+      o.add_step 1, :method_2
+      o.add_step 2, :method_3
+      o.add_step 2, :method_4
+    end
+
+    def initialize(someone = 'someone')
+      @someone = someone
+    end
+
+    def method_1(argument, **)
+      argument << 1
+    end
+
+    def method_2(argument, **)
+      argument << 2
+    end
+
+    def method_3(argument, **)
+      argument << 3
+    end
+
+    def method_4(argument, **)
+      argument << 4
+    end
+  end
+end
+```
+
+When we invoke `run` this we'll get the following result.
+
+```ruby
+result, _info = Readme::Example2_1.run([])
+result == [1, 2]
+```
+
+What happened here? Instead of `method_3` and `method_4` being on track one, they are now set to execute on track 2. So when we ran the operation it only ran the methods on track one.
+
+![example 2 1 - page 1 1](https://user-images.githubusercontent.com/65030/38447196-f4b65800-39c9-11e8-94fc-310c4931d7fb.png)
+
+In order to change the execution path of the operation to track 2 we need to introduce a new concept called `stepper_function`. The `stepper_function` is responsible for executing each step of the operation and deciding the direction of next step of the operation.
+
+```
+operation do |o|
+  o.stepper_function do |stepper, _, &step|
+    argument, _ = step.call
+
+    if argument.length >= 2
+      stepper.switch_to(2)
+    end
+
+    stepper.continue
+  end
+
+  o.add_step 1, :method_1
+  o.add_step 1, :method_2
+  o.add_step 2, :method_3
+  o.add_step 2, :method_4
+end
+```
+
+Now, when we call run we get the folling result.
+
+```ruby
+argument = []
+result, _info = Readme::Example2_2.run(argument)
+result == [1, 2, 3, 4]
+```
+
+![example 2 2 - page 1](https://user-images.githubusercontent.com/65030/38449378-5b1c6ac8-39dc-11e8-9cf9-f9e5c1a40cb6.png)
+
+For now you can think of the `stepper_function` as a `lambda` that surrounds a step (this is not entirely accurate, but it's good enough for now). This `lambda` has the following shape.
+
+```ruby
+lambda do |stepper, info, &step|
+
+  ...
+
+end
+```
+
+The `stepper` argument is control structure that dictates the movement of the execution. 
+
+```ruby
+stepper.continue
+stepper.switch_to(specified_track)
+stepper.successor_track
+stepper.halt_operation
+stepper.fail_operation
+```
+In our example we used the `switch_to` and `continue` methods to switch from track 1 to 2 and continue the execution of our operation.
+
+The `info` argument is the same `info` object we've seen from calling `run`, it is passed from one step to another.
+
+Finally, `step` is a `lambda` which runs the step once called. Overlayed on top of our previous diagram, it would roughly look like this.
+
+![example 2 2 info - page 1 2](https://user-images.githubusercontent.com/65030/38457951-3c76074e-3a65-11e8-9243-3dfe412dd645.png)
+
+To overlay the `stepper_function` in our example more concretely, looks something like this.
+
+![example 2 2 decisions - page 1 3](https://user-images.githubusercontent.com/65030/38458117-270bbb80-3a68-11e8-8e48-ecfba0e8512b.png)
+
+This process is recursed until the highest index step in the operation is reached. In this case the `operation.last_step_index` is 3. When the final step recursion is reach the value of the argument and info at that point is returned as the result of the operation.
+
+### Track Alias
+
+Another important concept for multi-tract execution is the idea of track alias. Instead of simply relying on the ordinal track index of 1, 2, 3, and so on, we can instead map those indices to a symbol.
+
+
+```ruby
+operation do |o|
+  o.tracks :track1, :track2
+
+  o.stepper_function do |stepper, _, &step|
+    # this returns result, info identical to how
+    # calling run returns result and info
+    argument, _ = step.call
+
+    if argument.length >= 2
+      stepper.switch_to(2)
+    end
+
+    stepper.continue
+  end
+
+  o.add_step :track1, :method_1
+  o.add_step :track1, :method_2
+  o.add_step :track2, :method_3
+  o.add_step :track2, :method_4
+end
+
+```
+
+![example 2 3 - page 1](https://user-images.githubusercontent.com/65030/38451877-42d5d24a-3a06-11e8-9b94-dc6ec9f0edc9.png)
+
+`stepper_function` and `track_alias` combine are known as a strategy. The next section will dig into this more deeply.
+
+## Strategy
+![strategy - page 1](https://user-images.githubusercontent.com/65030/38476310-004026b2-3b7b-11e8-8f63-f96ef5f3fe1e.png)
+
+
+
+## Info
+
+TODO
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/railway_operation. 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+