bsielski_control_flow 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 63f652164013e65f70ad9f9d4c42b8756d05d5b500a9b8e29204a7d2a021ab12
+  data.tar.gz: a16e49a14d26acad15a757bdadd8a1beb4b892b60aa77fe867b13ec1765c1c70
+SHA512:
+  metadata.gz: 834949513b171feadc745201be4eb1ceb06e00732ea462c74868e46a7ad348ee60736dce1bbe5efea4250cb6c981958ff76baca2ff49aac043e7c7d63c736d15
+  data.tar.gz: 423fe56a0cb397d2f97c486f16b23fb6d12eae86d3dc1fb8524374532a74709937944a13ee58529612bc44c05427578b4e7cd7ba077a2d5f61c24df00becd427

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bsielski_control_flow.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    bsielski_control_flow (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bsielski_value_generator (1.4.0)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  bsielski_control_flow!
+  bsielski_value_generator
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Bartłomiej Sielski
+
+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,265 @@
+# bsielski Control Flow
+
+A couple of classes for organizing objects in simple data flow structures (conditional loops, pipelines etc.).
+
+## When to use it?
+
+Who knows. Maybe in pseudo-funtional programming.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bsielski_control_flow'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bsielski_control_flow
+
+## Usage
+
+Reqiure proper class.
+
+```ruby
+require "c_flow/pipeline"
+```
+
+Use it.
+
+```ruby
+square_number_generator = CFlow:Pipeline.new(procs: [random_int, square])
+
+```
+
+All classes have just one public method: ***#call***. This method takes always one argument.
+
+Some classes have dependencies (injected in constructor) called "procs". They are objects that respond to ***#call*** method. This method takes one argument or variable number of arguments (it depends of object's role).
+
+
+## API
+
+
+### Class CFlow::Pipeline
+
+It passes a value through every proc and returns a final value. Output of the previous proc is input of the next proc.
+
+Source code:
+
+```ruby
+module CFlow
+  class Pipeline
+    def initialize(procs:)
+      @procs = procs
+    end
+    
+    def call(input)
+      @procs.each do |proc|
+        input = proc.call(input)
+      end
+      input
+    end
+  end
+end
+```
+
+#### Require
+
+```ruby
+require "c_flow/pipeline"
+```
+
+#### Constructor
+
+```ruby
+CFlow:Pipeline.new(procs: procs) # => new_pipeline
+```
+
+Paramaters:
+
+  - **_procs_** - an array of procs or objects responding on `.call` message with one argument. The first **_proc_** takes the "main" input of the class. THe result is passed to the next **_proc_** as input. The output of the last **_proc_** is the output of `.call` method of **Pipeline** class.
+
+
+### Class CFlow::Self
+
+It returns unmodified argument.
+
+Source code:
+
+```ruby
+module CFlow
+  class Self
+    def call(input)
+      input
+    end
+  end
+end
+```
+
+#### Require
+
+```ruby
+require "c_flow/self"
+```
+
+#### Constructor
+
+```ruby
+CFlow:Self.new # => new_self
+```
+
+### Class CFlow::True
+
+It returns **_true_** no matter what input it takes.
+
+Source code:
+
+```ruby
+module CFlow
+  class True
+    def call(input)
+      true
+    end
+  end
+end
+```
+
+#### Require
+
+```ruby
+require "c_flow/true"
+```
+
+#### Constructor
+
+```ruby
+CFlow:True.new # => new_true
+```
+
+### Class CFlow::False
+
+It returns **_false_** no matter what input it takes.
+
+Source code:
+
+```ruby
+module CFlow
+  class False
+    def call(input)
+      false
+    end
+  end
+end
+```
+
+#### Require
+
+```ruby
+require "c_flow/false"
+```
+
+#### Constructor
+
+```ruby
+CFlow:False.new # => new_false
+```
+
+
+### Class CFlow::Combine
+
+It passes input to each helper proc, then it passes the outputs to one proc and returns the output.
+
+Source code:
+
+```ruby
+module CFlow
+  class Combine
+    def initialize(combine_proc:, sub_procs:)
+      @sub_procs = sub_procs
+      @combine_proc = combine_proc
+    end
+    
+    def call(input)
+      sub_proc_outputs = []
+      @sub_procs.each do |sub_proc|
+        sub_proc_outputs << sub_proc.call(input)
+      end
+      @combine_proc.call(*sub_proc_outputs)
+    end
+  end
+end
+```
+
+#### Require
+
+```ruby
+require "c_flow/combine"
+```
+
+#### Constructor
+
+```ruby
+CFlow::Combine.new(sub_procs: sub_procs, combine_proc: combine_proc) # => new_combine
+```
+
+Paramaters:
+
+  - **_sub_procs_** - an array of procs or objects responding on `.call` message with one argument. Each of them takes the "main" value a an argument and return an output. All aoutpus are pased to **_combine_proc_**.
+  - **_combine_procs_** - a proc or object responding on `.call` message with one or many arguments. The output of this proc is the output of the `.call` method of the **Combine** class.
+  
+
+### Class CFlow::UntilTrueLoop
+
+It passes input to condition_proc and if the result is not true it pases the input to loop_proc until the result is true.
+
+Source code:
+
+```ruby
+module CFlow
+  class UntilTrueLoop
+    def initialize(condition_proc:, loop_proc:)
+      @loop_proc = loop_proc
+      @condition_proc = condition_proc
+    end
+    
+    def call(input)
+      until @condition_proc.call(input) do
+        input = @loop_proc.call(input)
+      end
+      input
+    end
+  end
+end
+```
+
+#### Require
+
+```ruby
+require "c_flow/until_true_loop"
+```
+
+#### Constructor
+
+```ruby
+CFlow::UntilTrueLoop.new(condition_proc: condition_proc, loop_proc: loop_proc) # => new_loop
+```
+
+Paramaters:
+
+  - **_condition_proc_** - proc or object responding on `.call` message with one argument. At the beginning it takes the input from `.call` method from UntilTrueLoop class. If an output is truthy the output is returned as the output of `.call` message of UntilTrueLoop class.
+  - **_loop_proc_** - a proc or objects responding on `.call` message with one argument.
+
+
+## To do features
+
+  - Examples in the documentation and source code.
+  - More classes.
+  
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bsielski_control_flow"
+
+# 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/bsielski_control_flow.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "c_flow/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bsielski_control_flow"
+  spec.version       = CFlow::VERSION
+  spec.authors       = ["Bart\xC5\x82omiej Sielski"]
+  spec.email         = ["b.sielski@yandex.com"]
+
+  spec.summary       = %q{A couple of classes for organizing objects in simple data flow structures (conditional loops, pipelines etc.}
+  spec.homepage      = "https://github.com/bsielski/bsielski_control_flow"
+  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 "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bsielski_value_generator", "~> 1.0"
+end

data/lib/c_flow.rb

@@ -0,0 +1,5 @@
+require "c_flow/version"
+
+module CFlow
+  # Your code goes here...
+end

data/lib/c_flow/combine.rb

@@ -0,0 +1,16 @@
+module CFlow
+  class Combine
+    def initialize(combine_proc:, sub_procs:)
+      @sub_procs = sub_procs
+      @combine_proc = combine_proc
+    end
+    
+    def call(input)
+      sub_proc_outputs = []
+      @sub_procs.each do |sub_proc|
+        sub_proc_outputs << sub_proc.call(input)
+      end
+      @combine_proc.call(*sub_proc_outputs)
+    end
+  end
+end