fear 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b04f2a97dbf830e68f70c42b703e2e70f7baf389da09871b2024effe95f51c68
-  data.tar.gz: 7852518363fe60c10e9c60da873462e84e9b1ad567c760992bbf595b5eb388fb
+  metadata.gz: d67c81eee97a98c49a029602c26e6835f8bcf2875971619f173899a8986275ae
+  data.tar.gz: 345d18874fdfc360f72816757d5cb74acaa4291ee931c38fb19f82ea9cac3e6f
 SHA512:
-  metadata.gz: 3b166826f4b02237d1614e334b98991271b8825d98cdb879d863abacdfc72587c0dfa47fe8762cab3b29cd7fa8472a5069092e1f8766e68807f8311bfe1c1614
-  data.tar.gz: 8393f1845627f280e8e65caf2f4f36b329106beef35445ef58d3a8d053b8f2fb6644060a0139256bb7e120d4005efcb1427debbec495c97205719614361c73ab
+  metadata.gz: 3ae2c56f15d445dc73a56c11e1d035daacabdc4df85e4752fcf8500ce2ae7d3e9dd0aef9ae92a7f1e1a0560ead65e8ac774c4ffe7c6c251fa809fdf9b70cfda3
+  data.tar.gz: a0458d44ba7e29725f41285a9687f553b7c2227d99399c28e13502505a5b98844ab5ce31f423f20fdd2b1b015c42b56ea2f4b8bc1f3e01672a851f50ffe87b1f

data/.rubocop.yml

@@ -1,63 +1,7 @@
-inherit_mode:
-  merge:
-  - Exclude
+inherit_gem:
+  ruby_coding_standard: .rubocop.yml
 
 AllCops:
+  TargetRubyVersion: 2.4
   Exclude:
-  - 'gemfiles/**/*'
-  - 'vendor/bundle/'
-
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
-
-Metrics/ClassLength:
-  Enabled: false
-
-Naming/MethodName:
-  Enabled: false
-
-Naming/UncommunicativeMethodParamName:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/CaseEquality:
-  Enabled: false
-
-Style/AccessModifierDeclarations:
-  EnforcedStyle: inline
-
-Style/GuardClause:
-  Enabled: false
-
-Style/IfUnlessModifier:
-  Enabled: false
-
-Style/TrailingCommaInArguments:
-  EnforcedStyleForMultiline: comma
-
-Style/TrailingCommaInArrayLiteral:
-  EnforcedStyleForMultiline: comma
-
-Style/TrailingCommaInHashLiteral:
-  EnforcedStyleForMultiline: comma
-
-Style/NumericPredicate:
-  Enabled: false
-
-Style/CommentedKeyword:
-  Enabled: false
-
-Layout/IndentHeredoc:
-  Enabled: false
-
-Metrics/BlockLength:
-  Exclude:
-    - spec/**/*
-    - Rakefile
-    - fear.gemspec
-    - examples/**/*
-
-Metrics/LineLength:
-  Max: 120
+    - vendor/**/*

data/.travis.yml

@@ -3,10 +3,14 @@ cache:
   bundler: true
 language: ruby
 rvm:
-- 2.4.5
-- 2.5.3
-- 2.6.1
-before_script:
+- 2.4.6
+- 2.5.5
+- 2.6.3
+before_install:
+- rvm use @global
+- gem uninstall bundler -x || true
+- gem install bundler --force --version=2.0.1
+- bundler --version
 - bundle install
 script:
 - bundle exec rspec

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-## 0.x
+## 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` 
+
+## 1.0.0
 
 * Rename `Fear::Done` to `Fear::Unit` ([@bolshakov][])
 * Don't treat symbols as procs while pattern matching. See [#46](https://github.com/bolshakov/fear/pull/46) for motivation ([@bolshakov][])

data/Gemfile

@@ -1,9 +1,11 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+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'
+gem "irb"
+gem "qo", github: "baweaver/qo"

data/Gemfile.lock

@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    fear (1.0.0)
+    fear (1.1.0)
       lru_redux
       treetop
 
@@ -29,16 +29,14 @@ GEM
       dry-core (~> 0.4, >= 0.4.4)
       dry-equalizer
     irb (1.0.0)
-    jaro_winkler (1.5.2)
+    jaro_winkler (1.5.3)
     lru_redux (1.1.0)
-    parallel (1.14.0)
-    parser (2.6.0.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
       ast (~> 2.4.0)
     polyglot (0.3.5)
-    powerpack (0.1.2)
-    psych (3.1.0)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (12.3.2)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -52,22 +50,22 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    rubocop (0.65.0)
+    rubocop (0.72.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
-      psych (>= 3.1.0)
+      parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
-    rubocop-rspec (1.32.0)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-rspec (1.33.0)
       rubocop (>= 0.60.0)
-    ruby-progressbar (1.10.0)
+    ruby-progressbar (1.10.1)
+    ruby_coding_standard (0.1.0)
+      rubocop
     treetop (1.6.10)
       polyglot (~> 0.3)
-    unicode-display_width (1.4.1)
-    yard (0.9.18)
+    unicode-display_width (1.6.0)
+    yard (0.9.20)
 
 PLATFORMS
   ruby
@@ -81,11 +79,11 @@ DEPENDENCIES
   fear!
   irb
   qo!
-  rake (~> 10.0)
+  rake (~> 12.3)
   rspec (~> 3.1)
-  rubocop (= 0.65.0)
-  rubocop-rspec (= 1.32.0)
+  rubocop-rspec (= 1.33.0)
+  ruby_coding_standard
   yard
 
 BUNDLED WITH
-   1.17.2
+   2.0.1

data/README.md

@@ -101,7 +101,7 @@ Fear.none.or_else { Fear.some(21) }   #=> Fear.some(21)
 Fear.none.or_else { None }     #=> None
 ```
 
-#### Option#inlude?
+#### Option#include?
 
 Checks if `Option` has an element that is equal (as determined by `==`) to given values.
 
@@ -143,9 +143,9 @@ Fear.none.flat_map { |v| Fear.some(v/2) }     #=> None
 Returns `false` if `None` or returns the result of the application of the given predicate to the `Some` value.
 
 ```ruby 
-Fear.some(12).any?( |v| v > 10)  #=> true
-Fear.some(7).any?( |v| v > 10)   #=> false
-Fear.none.any?( |v| v > 10)    #=> false
+Fear.some(12).any? { |v| v > 10 }  #=> true
+Fear.some(7).any? { |v| v > 10 }   #=> false
+Fear.none.any? { |v| v > 10 }    #=> false
 ```
 
 #### Option#select
@@ -300,9 +300,9 @@ Fear.failure(ArgumentError.new).to_option  #=> None
 Returns `false` if `Failure` or returns the result of the application of the given predicate to the `Success` value.
 
 ```ruby
-Fear.success(12).any?( |v| v > 10)                #=> true
-Fear.success(7).any?( |v| v > 10)                 #=> false
-Fear.failure(ArgumentError.new).any?( |v| v > 10) #=> false
+Fear.success(12).any? { |v| v > 10 }                #=> true
+Fear.success(7).any? { |v| v > 10 }                 #=> false
+Fear.failure(ArgumentError.new).any? { |v| v > 10 } #=> false
 ```
 
 #### Try#success? and Try#failure?
@@ -533,9 +533,9 @@ Fear.left('undefined').to_option  #=> Fear::None
 Returns `false` if `Left` or returns the result of the application of the given predicate to the `Right` value.
 
 ```ruby
-Fear.right(12).any?( |v| v > 10)         #=> true
-Fear.right(7).any?( |v| v > 10)          #=> false
-Fear.left('undefined').any?( |v| v > 10) #=> false
+Fear.right(12).any? { |v| v > 10 }         #=> true
+Fear.right(7).any? { |v| v > 10 }          #=> false
+Fear.left('undefined').any? { |v| v > 10 } #=> false
 ```
 
 #### Either#right?, Either#success?
@@ -764,7 +764,7 @@ end #=> returns new future of Fear.success(0)
 
 If the future resolved to success or recovery matcher did not matched, it returns the future `Fear::Failure`.
 
-The second option is `Future#fallbock_to` method. It allows to fallback to result of another future in case of failure
+The second option is `Future#fallback_to` method. It allows to fallback to result of another future in case of failure
 
 ```ruby
 future = Fear.future { fail 'error' }
@@ -784,6 +784,20 @@ end.and_then do |m|
 end
 ```
 
+#### Testing future values
+
+Sometimes it may be helpful to await for future completion. You can await either future,
+or result. Don't forget to pass timeout in seconds:
+
+
+```ruby 
+future = Fear.future { 42 }
+
+Fear::Await.result(future, 3) #=> 42
+
+Fear::Await.ready(future, 3) #=> Fear::Future.successful(42)
+```
+
 ### For composition ([API Documentation](http://www.rubydoc.info/github/bolshakov/fear/master/Fear/ForApi))
 
 Provides syntactic sugar for composition of multiple monadic operations. 
@@ -1095,13 +1109,13 @@ factorial.(10) #=> 3628800
 Fibonacci number
 
 ```ruby
-fibonnaci = Fear.matcher do |m|
+fibonacci = Fear.matcher do |m|
   m.case(0) { 0 }
   m.case(1) { 1 }
-  m.case(->(n) { n > 1}) { |n| fibonnaci.(n - 1) + fibonnaci.(n - 2) }
+  m.case(->(n) { n > 1}) { |n| fibonacci.(n - 1) + fibonacci.(n - 2) }
 end
 
-fibonnaci.(10) #=> 55
+fibonacci.(10) #=> 55
 ```
 
 Binary tree set implemented using pattern matching https://gist.github.com/bolshakov/3c51bbf7be95066d55d6d1ac8c605a1d

data/Rakefile

@@ -1,28 +1,30 @@
-require 'bundler/gem_tasks'
-require 'benchmark/ips'
-require_relative 'lib/fear'
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "benchmark/ips"
+require_relative "lib/fear"
 
 namespace :perf do
   # Contains benchmarking against Dry-rb
   namespace :dry do
     task :some_fmap_vs_fear_some_map do
-      require 'dry/monads/maybe'
+      require "dry/monads/maybe"
 
       dry = Dry::Monads::Some.new(42)
       fear = Fear.some(42)
 
       Benchmark.ips do |x|
-        x.report('Dry') { dry.fmap(&:itself) }
+        x.report("Dry") { dry.fmap(&:itself) }
 
-        x.report('Fear') { fear.map(&:itself) }
+        x.report("Fear") { fear.map(&:itself) }
 
         x.compare!
       end
     end
 
     task :do_vs_fear_for do
-      require 'dry/monads/maybe'
-      require 'dry/monads/do'
+      require "dry/monads/maybe"
+      require "dry/monads/do"
 
       class Operation
         include Dry::Monads::Maybe::Mixin
@@ -42,9 +44,9 @@ namespace :perf do
       op = Operation.new
 
       Benchmark.ips do |x|
-        x.report('Dry') { op.call }
+        x.report("Dry") { op.() }
 
-        x.report('Fear') do |_n|
+        x.report("Fear") do |_n|
           Fear.for(Fear.some(1), Fear.some(2)) do |one, two|
             one + two
           end
@@ -58,21 +60,21 @@ namespace :perf do
   # Contains internal benchmarking to if optimization works
   namespace :fear do
     task :fear_pattern_extracting_with_vs_without_cache do
-      some = Fear.some([:err, 'not found'])
+      some = Fear.some([:err, "not found"])
 
       class WOCache < Fear::Extractor::Pattern
         def initialize(pattern)
           @matcher = compile_pattern_without_cache(pattern)
         end
       end
-      pattern = 'Fear::Some([:err, code])'
+      pattern = "Fear::Some([:err, code])"
 
       Benchmark.ips do |x|
-        x.report('With cache') do |_n|
+        x.report("With cache") do |_n|
           Fear::Extractor::Pattern.new(pattern).extracted_arguments(some)
         end
 
-        x.report('Without cache') do |_n|
+        x.report("Without cache") do |_n|
           WOCache.new(pattern).extracted_arguments(some)
         end
 
@@ -85,11 +87,11 @@ namespace :perf do
         condition = Integer
 
         Benchmark.ips do |x|
-          x.report('Guard.new') do |n|
+          x.report("Guard.new") do |n|
             Fear::PartialFunction::Guard.new(condition) === n
           end
 
-          x.report('Guard.and1') do |n|
+          x.report("Guard.and1") do |n|
             Fear::PartialFunction::Guard.and1(condition) === n
           end
 
@@ -105,11 +107,11 @@ namespace :perf do
         and_and = Fear::PartialFunction::Guard.new(first).and(Fear::PartialFunction::Guard.new(second))
 
         Benchmark.ips do |x|
-          x.report('and2') do |n|
+          x.report("and2") do |n|
             and2 === n
           end
 
-          x.report('Guard#and') do |n|
+          x.report("Guard#and") do |n|
             and_and === n
           end
 
@@ -120,7 +122,7 @@ namespace :perf do
       task :and3_vs_and_and do
         first = Integer
         second = ->(x) { x > 2 }
-        third = ->(x) {  x < 10 }
+        third = ->(x) { x < 10 }
 
         and3 = Fear::PartialFunction::Guard.and3(first, second, third)
 
@@ -129,11 +131,11 @@ namespace :perf do
           .and(Fear::PartialFunction::Guard.new(third))
 
         Benchmark.ips do |x|
-          x.report('Guard.and3') do |n|
+          x.report("Guard.and3") do |n|
             and3 === n
           end
 
-          x.report('Guard#and') do |n|
+          x.report("Guard#and") do |n|
             and_and_and === n
           end
 
@@ -149,15 +151,15 @@ namespace :perf do
       end
 
       Benchmark.ips do |x|
-        x.report('construction') do
+        x.report("construction") do
           Fear::PatternMatch.new do |m|
             m.case(Integer) { |y| y * 2 }
             m.case(String) { |y| y.to_i(10) * 2 }
           end
         end
 
-        x.report('execution') do
-          matcher.call(42)
+        x.report("execution") do
+          matcher.(42)
         end
 
         x.compare!
@@ -166,23 +168,23 @@ namespace :perf do
   end
 
   namespace :pattern_matching do
-    require 'qo'
-    require 'dry/matcher'
+    require "qo"
+    require "dry/matcher"
 
     task :qo_vs_fear_pattern_extraction do
       User = Struct.new(:id, :name)
-      user = User.new(42, 'Jane')
+      user = User.new(42, "Jane")
 
       Benchmark.ips do |x|
-        x.report('Qo') do
+        x.report("Qo") do
           Qo.case(user, destructure: true) do |m|
             m.when(User) { |id, name| [id, name] }
           end
         end
 
-        x.report('Fear') do
+        x.report("Fear") do
           Fear.match(user) do |m|
-            m.xcase('User(id, name)') { |id:, name:| [id, name] }
+            m.xcase("User(id, name)") { |id:, name:| [id, name] }
           end
         end
 
@@ -198,25 +200,24 @@ namespace :perf do
         end
       end
 
-      SuccessBranch = Qo.create_branch(name: 'success', precondition: Fear::Success, extractor: :get)
-      FailureBranch = Qo.create_branch(name: 'failure', precondition: Fear::Failure, extractor: :exception)
+      SuccessBranch = Qo.create_branch(name: "success", precondition: Fear::Success, extractor: :get)
+      FailureBranch = Qo.create_branch(name: "failure", precondition: Fear::Failure, extractor: :exception)
 
       PatternMatch = Qo.create_pattern_match(
-        branches: [SuccessBranch,
-                   FailureBranch],
+        branches: [SuccessBranch, FailureBranch],
       ).prepend(ExhaustivePatternMatch)
 
       Fear::Success.include(PatternMatch.mixin(as: :qo_match))
 
       success_case = Dry::Matcher::Case.new(
-        match: lambda { |try, *pattern|
+        match: ->(try, *pattern) {
           try.is_a?(Fear::Success) && pattern.all? { |p| p === try.get }
         },
         resolve: ->(try) { try.get },
       )
 
       failure_case = Dry::Matcher::Case.new(
-        match: lambda { |try, *pattern|
+        match: ->(try, *pattern) {
           try.is_a?(Fear::Failure) && pattern.all? { |p| p === try.exception }
         },
         resolve: ->(value) { value.exception },
@@ -228,27 +229,27 @@ namespace :perf do
       success = Fear::Success.new(4)
 
       Benchmark.ips do |x|
-        x.report('Qo') do
+        x.report("Qo") do
           success.qo_match do |m|
             m.failure(&:itself)
             m.success(Integer, ->(y) { y % 5 == 0 }, &:itself)
-            m.success { 'else' }
+            m.success { "else" }
           end
         end
 
-        x.report('Fear') do
+        x.report("Fear") do
           success.match do |m|
             m.failure(&:itself)
             m.success(Integer, ->(y) { y % 5 == 0 }, &:itself)
-            m.success { 'else' }
+            m.success { "else" }
           end
         end
 
-        x.report('Dr::Matcher') do
-          matcher.call(success) do |m|
+        x.report("Dr::Matcher") do
+          matcher.(success) do |m|
             m.failure(&:itself)
             m.success(Integer, ->(y) { y % 5 == 0 }, &:itself)
-            m.success { 'else' }
+            m.success { "else" }
           end
         end
 
@@ -264,8 +265,8 @@ namespace :perf do
         end
       end
 
-      SuccessBranch = Qo.create_branch(name: 'success', precondition: Fear::Success, extractor: :get)
-      FailureBranch = Qo.create_branch(name: 'failure', precondition: Fear::Failure, extractor: :exception)
+      SuccessBranch = Qo.create_branch(name: "success", precondition: Fear::Success, extractor: :get)
+      FailureBranch = Qo.create_branch(name: "failure", precondition: Fear::Failure, extractor: :exception)
 
       QoPatternMatch = Qo.create_pattern_match(
         branches: [SuccessBranch, FailureBranch],
@@ -278,22 +279,22 @@ namespace :perf do
       qo_matcher = QoPatternMatch.new do |m|
         m.success(1, &:itself)
         m.success(4, &:itself)
-        m.failure { 'failure' }
+        m.failure { "failure" }
       end
 
       fear_matcher = Fear::TryPatternMatch.new do |m|
         m.success(1, &:itself)
         m.success(4, &:itself)
-        m.failure { 'failure' }
+        m.failure { "failure" }
       end
 
       Benchmark.ips do |x|
-        x.report('Qo') do
-          qo_matcher.call(success)
+        x.report("Qo") do
+          qo_matcher.(success)
         end
 
-        x.report('Fear') do
-          fear_matcher.call(success)
+        x.report("Fear") do
+          fear_matcher.(success)
         end
 
         x.compare!
@@ -305,33 +306,33 @@ namespace :perf do
         if n <= 1
           1
         else
-          n * factorial_proc.call(n - 1)
+          n * factorial_proc.(n - 1)
         end
       end
 
       factorial_pm = Fear.matcher do |m|
         m.case(1, &:itself)
         m.case(0, &:itself)
-        m.else { |n| n * factorial_pm.call(n - 1) }
+        m.else { |n| n * factorial_pm.(n - 1) }
       end
 
       factorial_qo = Qo.match do |m|
         m.when(1, &:itself)
         m.when(0, &:itself)
-        m.else { |n| n * factorial_qo.call(n - 1) }
+        m.else { |n| n * factorial_qo.(n - 1) }
       end
 
       Benchmark.ips do |x|
-        x.report('Proc') do
-          factorial_proc.call(100)
+        x.report("Proc") do
+          factorial_proc.(100)
         end
 
-        x.report('Fear') do
-          factorial_pm.call(100)
+        x.report("Fear") do
+          factorial_pm.(100)
         end
 
-        x.report('Qo') do
-          factorial_qo.call(100)
+        x.report("Qo") do
+          factorial_qo.(100)
         end
 
         x.compare!