bsflow 2.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 457b3db7aef819c0684ec2ed6b74e6e4f3586f2072da8ca8e855c25dc7e86790
+  data.tar.gz: 2fa0aeccb978acc29aac5c7c5b0fc599abd01e3033eb1241600d18afdef58c4e
+SHA512:
+  metadata.gz: cb427d952b5e8d27aa30daba5e5c0ddd7ef9e9b5f0c5c72f1d12e7ae5525c01d1cfaccc9ab213a65bc7c152dcde97c973d8b70f4c32b61eedcfac96f23ba5f3a
+  data.tar.gz: 70bf14e6fed64895ab7bde2326626d72a436019a7f35472c1976227fe95124c91edbcf42c3f93741fea593c4572b45536c4922e71b3b9d2c0d65e3865cdedca6

data/.gitignore

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

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,35 @@
+PATH
+  remote: .
+  specs:
+    bsflow (2.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    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
+  bsflow!
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.5

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,362 @@
+# bsflow
+
+A couple of classes that represent useful control flow patterns (conditional loops, pipelines etc).
+
+## When to use it?
+
+In pseudo-funtional programming.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bsflow'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bsflow
+
+## Usage
+
+Reqiure proper class.
+
+```ruby
+require "bsflow/pipeline"
+```
+
+Use it.
+
+```ruby
+square_number_generator = BSFlow:Pipeline.new(procs: [random_int, square])
+
+```
+
+All classes have just one public method: ***#call***.
+
+Some classes have dependencies (injected in constructor) called "procs". They are objects that respond to ***#call*** method.
+
+## API
+
+
+### Class BSFlow::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 BSFlow
+  class Pipeline
+    def initialize(procs:)
+      @procs = procs
+    end
+    
+    def call(*args)
+      output = @procs[0].call(*args)
+      if @procs.length == 1
+        return output
+      else
+        @procs[1..-1].each do |proc|
+          output = proc.call(output)
+        end
+        output
+      end
+    end
+  end
+```
+
+#### Require
+
+```ruby
+require "bsflow/pipeline"
+```
+
+#### Constructor
+
+```ruby
+BSFlow:Pipeline.new(procs: procs) # => new_pipeline
+```
+
+Paramaters:
+
+  - **_procs_** - an array of procs or objects responding on `.call` message. The first **_proc_** takes the "main" input of the class (any number of arguments). 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 BSFlow::FirstArg
+
+It just returns first pased argument and ignores the rest. Used to reduce number of arguments.
+
+Source code:
+
+```ruby
+module BSFlow
+  class FirstArg
+    def call(*args)
+      args.first
+    end
+  end
+end
+```
+
+#### Require
+
+```ruby
+require "bsflow/first_arg"
+```
+
+#### Constructor
+
+```ruby
+BSFlow:FirstArg.new # => new_first_arg
+```
+
+
+### Class BSFlow::LastArg
+
+It just returns last pased argument and ignores the rest. Used to reduce number of arguments.
+
+Source code:
+
+```ruby
+module BSFlow
+  class LastArg
+    def call(*args)
+      args.last
+    end
+  end
+end
+```
+
+#### Require
+
+```ruby
+require "bsflow/last_arg"
+```
+
+#### Constructor
+
+```ruby
+BSFlow:LastArg.new # => new_last_arg
+```
+
+
+### Class BSFlow::Self
+
+It returns unmodified argument.
+
+Source code:
+
+```ruby
+module BSFlow
+  class Self
+    def call(input)
+      input
+    end
+  end
+end
+```
+
+#### Require
+
+```ruby
+require "bsflow/self"
+```
+
+#### Constructor
+
+```ruby
+BSFlow:Self.new # => new_self
+```
+
+### Class BSFlow::True
+
+It returns **_true_** no matter what input it takes.
+
+Source code:
+
+```ruby
+module BSFlow
+  class True
+    def call(input)
+      true
+    end
+  end
+end
+```
+
+#### Require
+
+```ruby
+require "bsflow/true"
+```
+
+#### Constructor
+
+```ruby
+BSFlow:True.new # => new_true
+```
+
+### Class BSFlow::False
+
+It returns **_false_** no matter what input it takes.
+
+Source code:
+
+```ruby
+module BSFlow
+  class False
+    def call(input)
+      false
+    end
+  end
+end
+```
+
+#### Require
+
+```ruby
+require "bsflow/false"
+```
+
+#### Constructor
+
+```ruby
+BSFlow:False.new # => new_false
+```
+
+### Class BSFlow::Pass
+
+It passes a value to a proc and returns the unmodified value. So it is a one way ticket for data but it is usefull for sending data to some output stream or queue.
+
+Source code:
+
+```ruby
+module BSFlow
+  class Pass
+    def initialize(proc:)
+      @proc = proc
+    end
+    
+    def call(input)
+      @proc.call(input)
+      input
+    end
+  end
+end
+```
+
+#### Require
+
+```ruby
+require "bsflow/pass"
+```
+
+#### Constructor
+
+```ruby
+BSFlow:Pass.new(proc: proc) # => new_pass
+```
+
+Paramaters:
+
+  - **_proc_** - an objects responding on `.call` message with one argument.
+
+### Class BSFlow::Combine
+
+It passes its `.call` arguments to each injected sub_proc, then it passes their outputs to injected combine_proc and returns the output.
+
+Source code:
+
+```ruby
+module BSFlow
+  class Combine
+    def initialize(combine_proc:, sub_procs:)
+      @sub_procs = sub_procs
+      @combine_proc = combine_proc
+    end
+    
+    def call(*args)
+      sub_proc_outputs = []
+      @sub_procs.each do |sub_proc|
+        sub_proc_outputs << sub_proc.call(*args)
+      end
+      @combine_proc.call(*sub_proc_outputs)
+    end
+  end
+end
+```
+
+#### Require
+
+```ruby
+require "bsflow/combine"
+```
+
+#### Constructor
+
+```ruby
+BSFlow::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. Each of them takes arguments from combine object's call method and return an output. All aoutpus are pased to **_combine_proc_**.
+  - **_combine_procs_** - a proc or object responding on `.call` message. The output of this proc is the output of the `.call` method of the **Combine** class.
+
+
+### Class BSFlow::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 BSFlow
+  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 "bsflow/until_true_loop"
+```
+
+#### Constructor
+
+```ruby
+BSFlow::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/bsflow.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bsflow/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bsflow"
+  spec.version       = BSFlow::VERSION
+  spec.authors       = ["Bart\xC5\x82omiej Sielski"]
+  spec.email         = ["b.sielski.webdev@gmail.com"]
+
+  spec.summary       = %q{A couple of classes that represent useful control flow patterns (conditional loops, pipelines etc.}
+  spec.homepage      = "https://github.com/bsielski/bsflow"
+  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"
+end

data/lib/bsflow.rb

@@ -0,0 +1,5 @@
+require "bsflow/version"
+
+module BSFlow
+
+end

data/lib/bsflow/combine.rb

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

data/lib/bsflow/false.rb

@@ -0,0 +1,7 @@
+module BSFlow
+  class False
+    def call(input)
+      false
+    end
+  end
+end

data/lib/bsflow/first_arg.rb

@@ -0,0 +1,7 @@
+module BSFlow
+  class FirstArg
+    def call(*args)
+      args.first
+    end
+  end
+end

data/lib/bsflow/last_arg.rb

@@ -0,0 +1,7 @@
+module BSFlow
+  class LastArg
+    def call(*args)
+      args.last
+    end
+  end
+end

data/lib/bsflow/pass.rb

@@ -0,0 +1,12 @@
+module BSFlow
+  class Pass
+    def initialize(proc:)
+      @proc = proc
+    end
+    
+    def call(input)
+      @proc.call(input)
+      input
+    end
+  end
+end

data/lib/bsflow/pipeline.rb

@@ -0,0 +1,19 @@
+module BSFlow
+  class Pipeline
+    def initialize(procs:)
+      @procs = procs
+    end
+    
+    def call(*args)
+      output = @procs[0].call(*args)
+      if @procs.length == 1
+        return output
+      else
+        @procs[1..-1].each do |proc|
+          output = proc.call(output)
+        end
+        output
+      end
+    end
+  end
+end

data/lib/bsflow/self.rb

@@ -0,0 +1,7 @@
+module BSFlow
+  class Self
+    def call(input)
+      input
+    end
+  end
+end

data/lib/bsflow/true.rb

@@ -0,0 +1,7 @@
+module BSFlow
+  class True
+    def call(input)
+      true
+    end
+  end
+end

data/lib/bsflow/until_true_loop.rb

@@ -0,0 +1,15 @@
+module BSFlow
+  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

data/lib/bsflow/version.rb

@@ -0,0 +1,3 @@
+module BSFlow
+  VERSION = "2.2.0"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: bsflow
+version: !ruby/object:Gem::Version
+  version: 2.2.0
+platform: ruby
+authors:
+- Bartłomiej Sielski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: 
+email:
+- b.sielski.webdev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bsflow.gemspec
+- lib/bsflow.rb
+- lib/bsflow/combine.rb
+- lib/bsflow/false.rb
+- lib/bsflow/first_arg.rb
+- lib/bsflow/last_arg.rb
+- lib/bsflow/pass.rb
+- lib/bsflow/pipeline.rb
+- lib/bsflow/self.rb
+- lib/bsflow/true.rb
+- lib/bsflow/until_true_loop.rb
+- lib/bsflow/version.rb
+homepage: https://github.com/bsielski/bsflow
+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.7.6
+signing_key: 
+specification_version: 4
+summary: A couple of classes that represent useful control flow patterns (conditional
+  loops, pipelines etc.
+test_files: []