fear 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d67c81eee97a98c49a029602c26e6835f8bcf2875971619f173899a8986275ae
-  data.tar.gz: 345d18874fdfc360f72816757d5cb74acaa4291ee931c38fb19f82ea9cac3e6f
+  metadata.gz: 27594ab99bc8a361057d1222bd4e70aa49f5c8535c95f622f338ab17e216cd31
+  data.tar.gz: dfbd5982e2da247cdb74edb7a218023195c4806d56af786098e294165bf345ec
 SHA512:
-  metadata.gz: 3ae2c56f15d445dc73a56c11e1d035daacabdc4df85e4752fcf8500ce2ae7d3e9dd0aef9ae92a7f1e1a0560ead65e8ac774c4ffe7c6c251fa809fdf9b70cfda3
-  data.tar.gz: a0458d44ba7e29725f41285a9687f553b7c2227d99399c28e13502505a5b98844ab5ce31f423f20fdd2b1b015c42b56ea2f4b8bc1f3e01672a851f50ffe87b1f
+  metadata.gz: 4c880fdc1a916306cd222bb4d63526aa3b9ab19eadb095df1ea2aef4343e443015b8067628a34a0b436dc5d994f39fd8810b03dbb05adc7d6df975eb1943bee7
+  data.tar.gz: f9e9c441b5d208b65cbd678ae38412d404879834e1ca3ac6636140aa9b53bbb6c1ddf88b613c52d74cb6b09c481a0983c5a3e903c19ee5f98ca94161eb541ba9

data/.github/workflows/rubocop.yml

@@ -0,0 +1,39 @@
+# pulled from repo
+name: "Rubocop"
+
+on: push
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      # If running on a self-hosted runner, check it meets the requirements
+      # listed at https://github.com/ruby/setup-ruby#using-self-hosted-runners
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      # This step is not necessary if you add the gem to your Gemfile
+      - name: Install Code Scanning integration
+        run: bundle add code-scanning-rubocop --version 0.4.0 --skip-install
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Rubocop run
+        run: |
+          bash -c "
+            bundle exec rubocop --require code_scanning --format CodeScanning::SarifFormatter -o rubocop.sarif
+            [[ $? -ne 2 ]]
+          "
+      - name: Upload Sarif output
+        uses: github/codeql-action/upload-sarif@v1
+        with:
+          sarif_file: rubocop.sarif

data/.github/workflows/spec.yml

@@ -0,0 +1,42 @@
+name: Spec
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.5.x', '2.6.x', '2.7.x' ]
+    name: ${{ matrix.ruby }}
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up ruby
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install dependencies
+      run: |
+        gem install bundler --force --version=2.0.1
+        bundler --version
+        bundle install --jobs 4 --retry 3
+    - name: Test
+      run: bundle exec rspec
+    - name: Coveralls
+      uses: coverallsapp/github-action@v1.1.2
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        flag-name: ruby-${{ matrix.ruby }}
+        parallel: true
+
+
+  finish:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Coveralls Finished
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel-finished: true

data/.rubocop.yml

@@ -2,6 +2,6 @@ inherit_gem:
   ruby_coding_standard: .rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.7
   Exclude:
     - vendor/**/*

data/.simplecov

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "simplecov-lcov"
+
+SimpleCov::Formatter::LcovFormatter.config do |c|
+  c.report_with_single_file = true
+  c.single_report_path = "coverage/lcov.info"
+end
+SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new(
+  [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::LcovFormatter,
+  ],
+)
+SimpleCov.start do
+  add_filter "spec/"
+end

data/CHANGELOG.md

@@ -1,8 +1,17 @@
+## 1.2.0
+
+* Implement `Fear::Option#zip` and `Fear::Future#zip` with block argument ([@bolshakov][]) 
+* Drop ruby 2.4.x support, test against ruby 2.7.x ([@bolshakov][])
+* Implement `Fear::Option#filter_map`  ([@bolshakov][])
+* Add dry-types extentions to wrap nullable values. ([@bolshakov][])
+* Implement pattern matching for ruby >= 2.7
+* Deprecate `Fear.xcase`
+
 ## 1.1.0 
 
-* Add `Fear::Await.ready` and `Fear::Await.result`.
-* Add callback versions with pattern matching `Fear::Future#on_success_match`, `#on_failure_match` and `#on_complete_match`.
-* Implement immutable `Fear::Struct` 
+* Add `Fear::Await.ready` and `Fear::Await.result`. ([@bolshakov][])
+* Add callback versions with pattern matching `Fear::Future#on_success_match`, `#on_failure_match` and `#on_complete_match`. ([@bolshakov][])
+* Implement immutable `Fear::Struct`. ([@bolshakov][])
 
 ## 1.0.0
 

data/Gemfile

@@ -5,7 +5,5 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in functional.gemspec
 gemspec
 
-# gem 'codeclimate-test-reporter', group: :test, require: nil
-
 gem "irb"
 gem "qo", github: "baweaver/qo"

data/Gemfile.lock

@@ -1,5 +1,5 @@
 GIT
-  remote: git://github.com/baweaver/qo.git
+  remote: https://github.com/baweaver/qo.git
   revision: 8951ce899559118eb60321014b43cf4211730bd0
   specs:
     qo (0.99.0)
@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    fear (1.1.0)
+    fear (1.2.0)
       lru_redux
       treetop
 
@@ -16,56 +16,92 @@ GEM
   remote: https://rubygems.org/
   specs:
     any (0.1.0)
-    ast (2.4.0)
-    benchmark-ips (2.7.2)
-    concurrent-ruby (1.1.5)
-    diff-lcs (1.3)
-    dry-core (0.4.7)
+    ast (2.4.1)
+    benchmark-ips (2.8.3)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    dry-configurable (0.11.6)
       concurrent-ruby (~> 1.0)
-    dry-equalizer (0.2.2)
-    dry-matcher (0.7.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.3.0)
+    dry-inflector (0.2.0)
+    dry-logic (1.0.6)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-matcher (0.8.0)
+      dry-core (>= 0.4.7)
     dry-monads (1.2.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.4, >= 0.4.4)
       dry-equalizer
-    irb (1.0.0)
-    jaro_winkler (1.5.3)
+    dry-types (1.4.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.3)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    fear-rspec (0.3.0)
+      fear (>= 1.0.0)
+      rspec (~> 3.0)
+    irb (1.1.0)
+      reline (>= 0.0.1)
     lru_redux (1.1.0)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
+    parallel (1.20.0)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
     polyglot (0.3.5)
     rainbow (3.0.0)
-    rake (12.3.2)
-    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.2)
+    rake (13.0.1)
+    regexp_parser (1.8.2)
+    reline (0.0.7)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.72.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.0.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-rspec (1.33.0)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.1.1)
+      parser (>= 2.7.1.5)
+    rubocop-rspec (1.34.0)
       rubocop (>= 0.60.0)
     ruby-progressbar (1.10.1)
-    ruby_coding_standard (0.1.0)
-      rubocop
-    treetop (1.6.10)
+    ruby_coding_standard (0.3.0)
+      rubocop (~> 1.0.0)
+    simplecov (0.19.1)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.3)
+    simplecov-lcov (0.8.0)
+    treetop (1.6.11)
       polyglot (~> 0.3)
-    unicode-display_width (1.6.0)
-    yard (0.9.20)
+    unicode-display_width (1.7.0)
+    yard (0.9.25)
 
 PLATFORMS
   ruby
@@ -76,14 +112,19 @@ DEPENDENCIES
   concurrent-ruby
   dry-matcher
   dry-monads
+  dry-types
   fear!
+  fear-rspec
   irb
   qo!
-  rake (~> 12.3)
+  rake (~> 13.0)
   rspec (~> 3.1)
-  rubocop-rspec (= 1.33.0)
+  rubocop (= 1.0.0)
+  rubocop-rspec (= 1.34.0)
   ruby_coding_standard
+  simplecov
+  simplecov-lcov
   yard
 
 BUNDLED WITH
-   2.0.1
+   2.0.2

data/README.md

@@ -1,6 +1,8 @@
 # Fear
-[![Build Status](https://travis-ci.org/bolshakov/fear.svg?branch=master)](https://travis-ci.org/bolshakov/fear)
 [![Gem Version](https://badge.fury.io/rb/fear.svg)](https://badge.fury.io/rb/fear)
+![Specs](https://github.com/bolshakov/fear/workflows/Spec/badge.svg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/01030620c59e9f40961b/maintainability)](https://codeclimate.com/github/bolshakov/fear/maintainability)
+[![Coverage Status](https://coveralls.io/repos/github/bolshakov/fear/badge.svg?branch=master)](https://coveralls.io/github/bolshakov/fear?branch=master)
 
 This gem provides `Option`, `Either`, and `Try` monads implemented an idiomatic way. 
  It is highly inspired by scala's implementation. 
@@ -23,11 +25,11 @@ Or install it yourself as:
 
 ## Usage
 
-* [Option](#option-documentation) 
-* [Try](#try-documentation)
-* [Either](#either-documentation)
-* [Future](#future-documentation)
-* [For composition](#for-composition)
+* [Option](#option-api-documentation) 
+* [Try](#try-api-documentation)
+* [Either](#either-api-documentation)
+* [Future](#future-api-documentation)
+* [For composition](#for-composition-api-documentation)
 * [Pattern Matching](#pattern-matching-api-documentation)
 
 ### Option ([API Documentation](https://www.rubydoc.info/github/bolshakov/fear/master/Fear/Option))
@@ -153,12 +155,24 @@ Fear.none.any? { |v| v > 10 }    #=> false
 Returns self if it is nonempty and applying the predicate to this `Option`'s value returns `true`. Otherwise, 
 return `None`.
 
-```ruby 
+```ruby
 Fear.some(42).select { |v| v > 40 } #=> Fear.success(21)
 Fear.some(42).select { |v| v < 40 } #=> None
 Fear.none.select { |v| v < 40 }   #=> None
 ```
 
+#### Option#filter_map
+
+Returns a new `Some` of truthy results (everything except `false` or `nil`) of
+running the block or `None` otherwise.
+
+```ruby
+Fear.some(42).filter_map { |v| v/2 if v.even? } #=> Fear.some(21)
+Fear.some(42).filter_map { |v| v/2 if v.odd? } #=> Fear.none
+Fear.some(42).filter_map { |v| false } #=> Fear.none
+Fear.none.filter_map { |v| v/2 }   #=> Fear.none
+```
+
 #### Option#reject
 
 Returns `Some` if applying the predicate to this `Option`'s value returns `false`. Otherwise, return `None`.
@@ -182,6 +196,19 @@ Fear.some(42).empty? #=> false
 Fear.none.empty?   #=> true
 ```
 
+#### Option#zip
+
+Returns a `Fear::Some` formed from this Option and another Option by combining the corresponding elements in a pair. 
+If either of the two options is empty, `Fear::None` is returned.
+
+```ruby
+Fear.some("foo").zip(Fear.some("bar")) #=> Fear.some(["foo", "bar"])
+Fear.some("foo").zip(Fear.some("bar")) { |x, y| x + y } #=> Fear.some("foobar")
+Fear.some("foo").zip(Fear.none) #=> Fear.none
+Fear.none.zip(Fear.some("bar")) #=> Fear.none
+
+```
+
 @see https://github.com/scala/scala/blob/2.11.x/src/library/scala/Option.scala
  
 
@@ -625,7 +652,7 @@ Fear.left("flower").join_right        #=> Fear.left("flower")
 Fear.left(Fear.right("flower")).join_right #=> Fear.left(Fear.right("flower"))
 ```
 
-#### Either#join_right
+#### Either#join_left
 
 Joins an `Either` through `Left`. This method requires that the left side of this `Either` is itself an
 `Either` type. This method, and `join_right`, are analogous to `Option#flatten`
@@ -1171,7 +1198,7 @@ matcher.(Fear.some(40)) #=> 'Nope'
 #### Under the hood 
 
 Pattern matcher is a combination of partial functions wrapped into nice DSL. Every partial function 
-defined on domain described with guard.
+defined on domain described with a guard.
 
 ```ruby
 pf = Fear.case(Integer) { |x| x / 2 }
@@ -1233,6 +1260,128 @@ handle.(12) #=> 'bigger than ten'
 handle.('one') #=> 1
 ```
 
+### Native pattern-matching 
+
+Starting from ruby 2.7 you can use native pattern matching capabilities:
+
+```ruby 
+case Fear.some(42)
+in Fear::Some(x)
+  x * 2
+in Fear::None 
+  'none'
+end #=> 84
+
+case Fear.some(41)
+in Fear::Some(x) if x.even?
+  x / 2
+in Fear::Some(x) if x.odd? && x > 0
+  x * 2
+in Fear::None
+  'none'
+end #=> 82
+
+case Fear.some(42)
+in Fear::Some(x) if x.odd?
+  x * 2 
+else 
+  'nothing'
+end #=> nothing
+```
+
+It's possible to pattern match against Fear::Either and Fear::Try as well:
+
+```ruby 
+case either 
+in Fear::Right(Integer | String => x)
+  "integer or string: #{x}"
+in Fear::Left(String => error_code) if error_code = :not_found 
+  'not found'
+end  
+```
+
+```ruby 
+case Fear.try { 10 / x } 
+in Fear::Failure(ZeroDivisionError)
+  # ..
+in Fear::Success(x) 
+  # ..
+end  
+```
+
+### Dry-Types integration
+
+#### Option
+
+    NOTE: Requires the dry-tyes gem to be loaded.
+
+Load the `:fear_option` extension in your application.
+
+```ruby
+require 'dry-types'
+require 'dry/types/fear'
+
+Dry::Types.load_extensions(:fear_option)
+
+module Types
+  include Dry.Types()
+end
+```
+
+Append .option to a Type to return a `Fear::Option` object:
+
+```ruby
+Types::Option::Strict::Integer[nil] 
+#=> Fear.none
+Types::Option::Coercible::String[nil] 
+#=> Fear.none
+Types::Option::Strict::Integer[123] 
+#=> Fear.some(123)
+Types::Option::Strict::String[123]
+#=> Fear.some(123)
+Types::Option::Coercible::Float['12.3'] 
+#=> Fear.some(12.3)
+```
+
+'Option' types can also accessed by calling '.option' on a regular type:
+
+```ruby
+Types::Strict::Integer.option # equivalent to Types::Option::Strict::Integer
+```
+
+
+You can define your own optional types:
+
+```ruby
+option_string = Types::Strict::String.option
+option_string[nil]
+# => Fear.none
+option_string[nil].map(&:upcase)
+# => Fear.none
+option_string['something']
+# => Fear.some('something')
+option_string['something'].map(&:upcase)
+# => Fear.some('SOMETHING')
+option_string['something'].map(&:upcase).get_or_else { 'NOTHING' }
+# => "SOMETHING"
+```
+
+You can use it with dry-struct as well:
+
+```ruby
+class User < Dry::Struct
+  attribute :name, Types::Coercible::String
+  attribute :age,  Types::Coercible::Integer.option
+end
+
+user = User.new(name: 'Bob', age: nil)
+user.name #=> "Bob"
+user.age #=> Fear.none 
+
+user = User.new(name: 'Bob', age: 42)
+user.age #=> Fear.some(42) 
+```
+
 ## Testing
 
 To simplify testing, you may use [fear-rspec](https://github.com/bolshakov/fear-rspec) gem. It