flows 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be39f457170b0b70b8c54073f5ae4c75c19ee90fdfa0a5d4e8e8bd6762d910ae
-  data.tar.gz: e3bb541f406ae2c935273a9a915cd19ef6f680b165c01ed9acd59d3cc5665100
+  metadata.gz: 3408a7cfa09415262d76e3cdc1d2d28529103928bbbc379dc0c02a14b1f25eee
+  data.tar.gz: 55b10a5f99d6c0b33185a9e0ba193ab39abd3f43ae88b39b5cb7b48c30fbe23d
 SHA512:
-  metadata.gz: 4c4a2444bb62c7f4e1f40d9a7c45e060154fdfb434a1fa80557b322bead0a6b1e890f2cca6643b0d07b6ecb337a888839dee05838d096b9024073a39fb3871b1
-  data.tar.gz: fc9c68ec2cf6b7c507db598fdd6615b07f12b618cedcba5a86012966d26d5f7829908c98fbc4c7dfbfe3265d83f13d7b9f3c2cce4b4e0141cf969955a3931fec
+  metadata.gz: 23ef64c88317d77233cf9eb837d3318a73523fd8ac270ec7166eb42c57b0310a015af887bab0018423290eba49f7fb9d735b4c079940bbb1c2cb394857155779
+  data.tar.gz: fa7baaa93dc8836ab470e873624feaa15a3a6a29a25e483d2efe2b34e228bb2ad88c1c31ed0905c5635aa51b8cb9760fcd76bc2fdc62806ff61ff72eba737e6d

data/.github/workflows/{build.yml → test.yml}

@@ -1,4 +1,4 @@
-name: Build
+name: Test
 
 on:
   push:
@@ -11,7 +11,7 @@ on:
     - cron: 0 2 * * 1-5
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
@@ -19,6 +19,7 @@ jobs:
         ruby:
           - 2.5.x
           - 2.6.x
+          # - 2.7.x
     steps:
       - uses: actions/checkout@v1
       - name: Set up Ruby
@@ -31,13 +32,7 @@ jobs:
         run: sudo apt-get install hunspell
       - name: Install Deps
         run: bundle install --jobs 4 --retry 3
-      - name: Rubocop
-        run: bundle exec rubocop
-      - name: RSpec
+      - name: Test
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-        run: bundle exec rspec
-      - name: Markdown Linter (docs)
-        run: bundle exec mdl docs/**/*.md README.md
-      - name: Spelling Check (docs & code)
-        run: bundle exec forspell
+        run: bundle exec rake

data/.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
+/.vendor/
 /.yardoc
 /_yardoc/
 /coverage/

data/.reek.yml

@@ -0,0 +1,42 @@
+# default config: https://github.com/troessner/reek/blob/master/docs/defaults.reek.yml
+# detectors' docs: https://github.com/troessner/reek/tree/master/docs
+---
+exclude_paths:
+  - 'bin/'
+  - 'spec/'
+
+detectors:
+  LongParameterList:
+    enabled: true
+    exclude: []
+    max_params: 4 # +1 to default value
+    overrides:
+      initialize:
+        max_params: 6 # +1 to default value
+  ModuleInitialize:
+    enabled: false
+  TooManyInstanceVariables:
+    enabled: true
+    exclude: []
+    max_instance_variables: 5 # +1 to default value
+  DataClump:
+    exclude:
+      - Flows::Result::Helpers
+  IrresponsibleModule:
+    exclude:
+      - Flows::SharedContextPipeline
+  FeatureEnvy:
+    exclude:
+      - Flows::SharedContextPipeline#call
+      - Flows::Contract # too many false positives here
+  TooManyStatements:
+    exclude:
+      - Flows::SharedContextPipeline#call
+      - initialize
+  DuplicateMethodCall:
+    exclude:
+      - Flows::SharedContextPipeline#call
+      - 'length'
+  MissingSafeMethod:
+    exclude:
+      - Flows::Contract

data/.rubocop.yml

@@ -4,9 +4,18 @@ require:
   - rubocop-md
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
 
-LineLength:
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Layout/LineLength:
   Max: 120
 
 Metrics/BlockLength:
@@ -22,9 +31,10 @@ Metrics/ParameterLists:
 Style/WhileUntilModifier:
   Enabled: false
 
-Naming/UncommunicativeMethodParamName:
+Naming/MethodParameterName:
   Exclude:
     - '**/*.md'
+    - 'spec/**/*'
 
 Style/MixinUsage:
   Exclude:
@@ -38,10 +48,13 @@ Lint/UnusedBlockArgument:
   Exclude:
     - '**/*.md'
 
-Lint/UnreachableCode:
+Style/CaseEquality:
   Exclude:
-    - 'docs/result_objects/do_notation.md'
+    - 'lib/flows/contract/**/*'
+
+Naming/RescuedExceptionsVariableName:
+  PreferredName: err
 
-Lint/Void:
+Style/Documentation:
   Exclude:
-    - 'docs/result_objects/do_notation.md'
+    - 'lib/flows/shared_context_pipeline/step.rb' # false positive here

data/.ruby-version

@@ -1 +1 @@
-2.6.2
+2.6.5

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/CHANGELOG.md

@@ -0,0 +1,42 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+Types of changes:
+
+* _Added_ - for new features.
+* _Changed_ -  for changes in existing functionality.
+* _Deprecated_ - for soon-to-be removed features.
+* _Removed_ - for now removed features.
+* _Fixed_ -- for any bug fixes.
+* _Security_ - in case of vulnerabilities.
+
+## [Unreleased]
+
+## [0.4.0] - 2020-04-21
+
+### Added
+
+* `Flows::Contract` - type contracts with specific transformation feature.
+* `Flows::Flow` - fast and lightweight logic execution engine, designed for
+  internal usage and library writers.
+* `Flows::Plugin::DependencyInjector` - simple dependency injection plugin for your classes
+* `Flows::Plugin::ImplicitInit` - allows to use `MyClass.call` instead of
+  `MyClass.new.call`, an class instance will be created once.
+* `Flows::Plugin::OutputContract` - plugin for output type checks and
+  transformations for service objects which return `Flows::Result`.
+* `Flows::Railway` - stupid simple implementation of the railway pattern.
+* `Flows::Result` - general purpose Result Object designed after Rust Result type.
+* `Flows::Result::Do` - do-notation for Result Objects.
+* `Flows::SharedContextPipeline` - much more flexible adoption of the railway
+  pattern for Ruby.
+* `Flows::Util::InheritableSingletonVars` - allows to define behavior for
+  singleton variables in the context of inheritance.
+* `Flows::Util::PrependToClass` - allows to prepend some module to class even if
+  target module did not included directly into class.
+
+[unreleased]: https://github.com/ffloyd/flows/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/ffloyd/flows/compare/v0.3.0...v0.4.0

data/Gemfile

@@ -2,9 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in flows.gemspec
 gemspec
-
-# temporary dev dependencies,
-# move it to gemspec after PRs will be merged into realesed version of a gem
-group :development do
-  gem 'mdl', github: 'ffloyd/markdownlint', branch: 'update-kramdown-dep'
-end

data/Gemfile.lock

@@ -1,50 +1,53 @@
-GIT
-  remote: git://github.com/ffloyd/markdownlint.git
-  revision: 801cb12f645d894e0d262bb4908d8086b6dd23bc
-  branch: update-kramdown-dep
-  specs:
-    mdl (0.5.0)
-      kramdown (~> 2.0)
-      kramdown-parser-gfm (~> 1.0)
-      mixlib-cli (~> 1.7, >= 1.7.0)
-      mixlib-config (~> 2.2, >= 2.2.1)
-
 PATH
   remote: .
   specs:
-    flows (0.3.0)
+    flows (0.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
-    backports (3.15.0)
+    awesome_print (1.8.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    backports (3.17.0)
     benchmark-ips (2.7.2)
-    codecov (0.1.14)
+    codeclimate-engine-rb (0.4.1)
+      virtus (~> 1.0)
+    codecov (0.1.16)
       json
       simplecov
       url
     coderay (1.1.2)
-    concurrent-ruby (1.1.5)
-    crass (1.0.4)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    declarative (0.0.10)
+    declarative-option (0.1.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.3)
     docile (1.3.2)
-    dry-configurable (0.8.3)
+    dry-configurable (0.11.5)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.4, >= 0.4.7)
+      dry-equalizer (~> 0.2)
     dry-container (0.7.2)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
     dry-core (0.4.9)
       concurrent-ruby (~> 1.0)
-    dry-equalizer (0.2.2)
+    dry-equalizer (0.3.0)
     dry-events (0.2.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.4)
       dry-equalizer (~> 0.2)
-    dry-matcher (0.8.2)
+    dry-matcher (0.8.3)
       dry-core (>= 0.4.8)
-    dry-monads (1.3.1)
+    dry-monads (1.3.5)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.4, >= 0.4.4)
       dry-equalizer
@@ -53,9 +56,10 @@ GEM
       dry-events (>= 0.1.0)
       dry-matcher (>= 0.7.0)
       dry-monads (>= 0.4.0)
+    equalizer (0.0.11)
     equatable (0.6.1)
-    ffi (1.11.1)
-    ffi-hunspell (0.4.0)
+    ffi (1.12.2)
+    ffi-hunspell (0.5.0)
       ffi (~> 1.0)
     forspell (0.0.8)
       backports (~> 3.0)
@@ -69,97 +73,156 @@ GEM
       sanitize (~> 5.0)
       slop (~> 4.6)
       yard
-    highline (2.0.2)
-    jaro_winkler (1.5.3)
-    json (2.2.0)
+    gli (2.19.0)
+    highline (2.0.3)
+    hirb (0.7.3)
+    ice_nine (0.11.2)
+    inch (0.8.0)
+      pry
+      sparkr (>= 0.2.0)
+      term-ansicolor
+      yard (~> 0.9.12)
+    jaro_winkler (1.5.4)
+    json (2.3.0)
+    kalibera (0.1)
+      memoist (~> 0.11.0)
+      rbzip2 (~> 0.2.0)
     kramdown (2.1.0)
     kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
-    method_source (0.9.2)
+    kwalify (0.7.2)
+    mdl (0.9.0)
+      kramdown (~> 2.0)
+      kramdown-parser-gfm (~> 1.0)
+      mixlib-cli (~> 2.1, >= 2.1.1)
+      mixlib-config (>= 2.2.1, < 4)
+    memoist (0.11.0)
+    method_source (1.0.0)
     mini_portile2 (2.4.0)
-    mixlib-cli (1.7.0)
-    mixlib-config (2.2.18)
+    mixlib-cli (2.1.5)
+    mixlib-config (3.0.6)
       tomlrb
-    nokogiri (1.10.4)
+    nokogiri (1.10.9)
       mini_portile2 (~> 2.4.0)
-    nokogumbo (2.0.1)
+    nokogumbo (2.0.2)
       nokogiri (~> 1.8, >= 1.8.4)
-    parallel (1.17.0)
-    parser (2.6.4.1)
+    parallel (1.19.1)
+    parser (2.7.0.5)
       ast (~> 2.4.0)
     pastel (0.7.3)
       equatable (~> 0.6)
       tty-color (~> 0.5)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
+    pry (0.13.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    psych (3.1.0)
     rainbow (3.0.0)
-    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.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rake (13.0.1)
+    rbzip2 (0.2.0)
+    reek (5.6.0)
+      codeclimate-engine-rb (~> 0.4.0)
+      kwalify (~> 0.7.0)
+      parser (>= 2.5.0.0, < 2.8, != 2.5.1.1)
+      psych (~> 3.1.0)
+      rainbow (>= 2.0, < 4.0)
+    representable (3.0.4)
+      declarative (< 0.1.0)
+      declarative-option (< 0.2.0)
+      uber (< 0.2.0)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    rubocop (0.74.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.80.1)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      rexml
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-md (0.3.0)
+    rubocop-md (0.3.2)
       rubocop (~> 0.60)
-    rubocop-performance (1.4.1)
+    rubocop-performance (1.5.2)
       rubocop (>= 0.71.0)
-    rubocop-rspec (1.35.0)
-      rubocop (>= 0.60.0)
-    ruby-prof (1.0.0)
+    rubocop-rspec (1.38.1)
+      rubocop (>= 0.68.1)
+    ruby-prof (1.3.1)
     ruby-progressbar (1.10.1)
     sanitize (5.1.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.8.0)
       nokogumbo (~> 2.0)
-    simplecov (0.17.1)
+    simplecov (0.18.5)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    slop (4.7.0)
-    stackprof (0.2.12)
-    tomlrb (1.2.8)
-    trailblazer-activity (0.9.0)
-      trailblazer-context (>= 0.1.4)
-    trailblazer-activity-dsl-linear (0.2.0)
-      trailblazer-activity (>= 0.9.0, < 1.0.0)
-    trailblazer-context (0.1.4)
-    trailblazer-operation (0.5.2)
-      trailblazer-activity-dsl-linear (>= 0.1.6, < 1.0.0)
-    tty-color (0.5.0)
-    unicode-display_width (1.6.0)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    slop (4.8.0)
+    sparkr (0.4.1)
+    stackprof (0.2.15)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thread_safe (0.3.6)
+    tins (1.24.1)
+      sync
+    tomlrb (1.3.0)
+    trailblazer-activity (0.10.0)
+      trailblazer-context (>= 0.2.0, < 0.3.0)
+    trailblazer-activity-dsl-linear (0.2.6)
+      trailblazer-activity (>= 0.9.1, < 1.0.0)
+    trailblazer-context (0.2.0)
+    trailblazer-developer (0.0.12)
+      hirb
+      representable
+      trailblazer-activity (>= 0.10.0, < 1.0.0)
+      trailblazer-activity-dsl-linear
+    trailblazer-operation (0.6.0)
+      trailblazer-activity (>= 0.10.0, < 1.0.0)
+      trailblazer-activity-dsl-linear (>= 0.2.1, < 1.0.0)
+      trailblazer-developer (>= 0.0.8)
+    tty-color (0.5.1)
+    uber (0.1.0)
+    unicode-display_width (1.6.1)
     url (0.3.2)
-    yard (0.9.20)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+    warning (1.0.0)
+    yard (0.9.24)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  awesome_print
   benchmark-ips
   bundler (~> 2.0)
   codecov
+  dry-monads (~> 1.3)
   dry-transaction
   flows!
   forspell (~> 0.0.8)
-  mdl!
+  gli
+  inch
+  kalibera
+  mdl
   pry
-  rake (~> 10.0)
+  rainbow
+  rake (~> 13.0)
+  reek
   rspec (~> 3.0)
   rubocop
   rubocop-md
@@ -169,6 +232,8 @@ DEPENDENCIES
   simplecov
   stackprof
   trailblazer-operation
+  warning
+  yard
 
 BUNDLED WITH
-   2.0.1
+   2.1.4