fear 1.0.0 → 1.1.0

data/examples/pattern_extracting.rb

@@ -1,15 +1,17 @@
-require 'fear'
+# frozen_string_literal: true
+
+require "fear"
 
 User = Struct.new(:id, :name, :admin)
 
 matcher = Fear.matcher do |m|
-  m.xcase('User(_, name, true)') do |name:|
+  m.xcase("User(_, name, true)") do |name:|
     puts "Hi #{name}, you are welcome"
   end
-  m.xcase('User(_, _, false)') do
-    puts 'Only admins allowed here'
+  m.xcase("User(_, _, false)") do
+    puts "Only admins allowed here"
   end
 end
 
-matcher.call User.new(1, 'Jane', true)
-matcher.call User.new(1, 'John', false)
+matcher.(User.new(1, "Jane", true))
+matcher.(User.new(1, "John", false))

data/examples/pattern_matching_binary_tree_set.rb

@@ -1,4 +1,6 @@
-require 'fear'
+# frozen_string_literal: true
+
+require "fear"
 
 # @example Usage
 #   set = BinaryTreeSet.new
@@ -87,7 +89,7 @@ class BinaryTreeSet
   # @param position [Position]
   # @return [Fear::Option<BinaryTreeSet>]
   private def leaf(position)
-    if subtrees.key?(position)
+    if subtrees.has_key?(position)
       Fear.some(subtrees[position])
     else
       Fear.none

data/examples/pattern_matching_number_in_words.rb

@@ -1,54 +1,58 @@
-require 'fear'
+# frozen_string_literal: true
+
+require "fear"
 
 class ToWords
+  NUMBERS = {
+    0 => "zero",
+    1 => "one",
+    2 => "two",
+    3 => "three",
+    4 => "four",
+    5 => "five",
+    6 => "six",
+    7 => "seven",
+    8 => "eight",
+    9 => "nine",
+    10 => "ten",
+    11 => "eleven",
+    12 => "twelve",
+    13 => "thirteen",
+    14 => "fourteen",
+    15 => "fifteen",
+    16 => "sixteen",
+    17 => "seventeen",
+    18 => "eighteen",
+    19 => "nineteen",
+    20 => "twenty",
+    30 => "thirty",
+    40 => "forty",
+    50 => "fifty",
+    60 => "sixty",
+    70 => "seventy",
+    80 => "eighty",
+    90 => "ninety",
+  }.freeze
+
   CONVERTER = Fear.matcher do |m|
-    {
-      0 => 'zero',
-      1 => 'one',
-      2 => 'two',
-      3 => 'three',
-      4 => 'four',
-      5 => 'five',
-      6 => 'six',
-      7 => 'seven',
-      8 => 'eight',
-      9 => 'nine',
-      10 => 'ten',
-      11 => 'eleven',
-      12 => 'twelve',
-      13 => 'thirteen',
-      14 => 'fourteen',
-      15 => 'fifteen',
-      16 => 'sixteen',
-      17 => 'seventeen',
-      18 => 'eighteen',
-      19 => 'nineteen',
-      20 => 'twenty',
-      30 => 'thirty',
-      40 => 'forty',
-      50 => 'fifty',
-      60 => 'sixty',
-      70 => 'seventy',
-      80 => 'eighty',
-      90 => 'ninety',
-    }.each_pair do |number, in_words|
+    NUMBERS.each_pair do |number, in_words|
       m.case(number) { in_words }
     end
-    m.case(->(n) { n < 0 }) { |n| "minus #{CONVERTER.call(-n)}" }
-    m.case(->(n) { n < 100 }) { |n| "#{CONVERTER.call((n / 10) * 10)}-#{CONVERTER.call(n % 10)}" }
-    m.case(->(n) { n < 200 }) { |n| "one hundred #{CONVERTER.call(n % 100)}" }
-    m.case(->(n) { n < 1_000 }) { |n| "#{CONVERTER.call(n / 100)} hundreds #{CONVERTER.call(n % 100)}" }
-    m.case(->(n) { n < 2_000 }) { |n| "one thousand #{CONVERTER.call(n % 1000)}" }
-    m.case(->(n) { n < 1_000_000 }) { |n| "#{CONVERTER.call(n / 1_000)} thousands #{CONVERTER.call(n % 1_000)}" }
+    m.case(->(n) { n < 0 }) { |n| "minus #{CONVERTER.(-n)}" }
+    m.case(->(n) { n < 100 }) { |n| "#{CONVERTER.((n / 10) * 10)}-#{CONVERTER.(n % 10)}" }
+    m.case(->(n) { n < 200 }) { |n| "one hundred #{CONVERTER.(n % 100)}" }
+    m.case(->(n) { n < 1_000 }) { |n| "#{CONVERTER.(n / 100)} hundreds #{CONVERTER.(n % 100)}" }
+    m.case(->(n) { n < 2_000 }) { |n| "one thousand #{CONVERTER.(n % 1000)}" }
+    m.case(->(n) { n < 1_000_000 }) { |n| "#{CONVERTER.(n / 1_000)} thousands #{CONVERTER.(n % 1_000)}" }
     m.else { |n| raise "#{n} too big " }
   end
 
   def self.call(number)
-    Fear.case(Integer, &:itself).and_then(CONVERTER).call(number)
+    Fear.case(Integer, &:itself).and_then(CONVERTER).(number)
   end
 end
 
-ToWords.call(99) #=> 'ninety-nine'
-ToWords.call(133) #=> 'one hundred thirty-three
-ToWords.call(777) #=> 'seven hundreds seventy-seven'
-ToWords.call(254_555) #=> 'two hundreds fifty-four thousands five hundreds fifty-five'
+ToWords.(99) #=> 'ninety-nine'
+ToWords.(133) #=> 'one hundred thirty-three
+ToWords.(777) #=> 'seven hundreds seventy-seven'
+ToWords.(254_555) #=> 'two hundreds fifty-four thousands five hundreds fifty-five'

data/fear.gemspec

@@ -1,22 +1,24 @@
-lib = File.expand_path('lib', __dir__)
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
 
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require 'fear/version'
+require "fear/version"
 Gem::Specification.new do |spec|
-  spec.name          = 'fear'
-  spec.version       = Fear::VERSION
-  spec.authors       = ['Tema Bolshakov']
-  spec.email         = ['abolshakov@spbtv.com']
-  spec.summary       = "%q{Ruby port of some Scala's monads.}"
-  spec.description   = "Ruby port of some Scala's monads."
-  spec.homepage      = 'https://github.com/bolshakov/fear'
-  spec.license       = 'MIT'
+  spec.name = "fear"
+  spec.version = Fear::VERSION
+  spec.authors = ["Tema Bolshakov"]
+  spec.email = ["abolshakov@spbtv.com"]
+  spec.summary = "%q{Ruby port of some Scala's monads.}"
+  spec.description = "Ruby port of some Scala's monads."
+  spec.homepage = "https://github.com/bolshakov/fear"
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin\/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^spec\/})
-  spec.require_paths = ['lib']
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin\/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^spec\/})
+  spec.require_paths = ["lib"]
 
   spec.post_install_message = <<-MSG
     Fear v0.11.0 introduces backwards-incompatible changes.
@@ -24,18 +26,18 @@ Gem::Specification.new do |spec|
     Successfully installed fear-#{Fear::VERSION}
   MSG
 
-  spec.add_runtime_dependency 'lru_redux'
-  spec.add_runtime_dependency 'treetop'
+  spec.add_runtime_dependency "lru_redux"
+  spec.add_runtime_dependency "treetop"
 
-  spec.add_development_dependency 'benchmark-ips'
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'concurrent-ruby'
-  spec.add_development_dependency 'dry-matcher'
-  spec.add_development_dependency 'dry-monads'
-  spec.add_development_dependency 'qo'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.1'
-  spec.add_development_dependency 'rubocop', '0.65.0'
-  spec.add_development_dependency 'rubocop-rspec', '1.32.0'
-  spec.add_development_dependency 'yard'
+  spec.add_development_dependency "benchmark-ips"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "concurrent-ruby"
+  spec.add_development_dependency "dry-matcher"
+  spec.add_development_dependency "dry-monads"
+  spec.add_development_dependency "qo"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "rubocop-rspec", "1.33.0"
+  spec.add_development_dependency "ruby_coding_standard"
+  spec.add_development_dependency "yard"
 end

data/lib/fear.rb

@@ -1,11 +1,13 @@
-require 'fear/either_api'
-require 'fear/extractor_api'
-require 'fear/for_api'
-require 'fear/future_api'
-require 'fear/option_api'
-require 'fear/pattern_matching_api'
-require 'fear/try_api'
-require 'fear/version'
+# frozen_string_literal: true
+
+require "fear/either_api"
+require "fear/extractor_api"
+require "fear/for_api"
+require "fear/future_api"
+require "fear/option_api"
+require "fear/pattern_matching_api"
+require "fear/try_api"
+require "fear/version"
 
 module Fear
   Error = Class.new(StandardError)
@@ -22,40 +24,45 @@ module Fear
   extend PatternMatchingApi
   extend TryApi
 
-  autoload :EmptyPartialFunction, 'fear/empty_partial_function'
-  autoload :PartialFunction, 'fear/partial_function'
-  autoload :PartialFunctionClass, 'fear/partial_function_class'
-  autoload :PatternMatch, 'fear/pattern_match'
-  autoload :Extractor, 'fear/extractor'
+  autoload :EmptyPartialFunction, "fear/empty_partial_function"
+  autoload :PartialFunction, "fear/partial_function"
+  autoload :PartialFunctionClass, "fear/partial_function_class"
+  autoload :PatternMatch, "fear/pattern_match"
+  autoload :Extractor, "fear/extractor"
+
+  autoload :Unit, "fear/unit"
+  autoload :For, "fear/for"
+  autoload :RightBiased, "fear/right_biased"
+  autoload :Utils, "fear/utils"
 
-  autoload :Unit, 'fear/unit'
-  autoload :For, 'fear/for'
-  autoload :RightBiased, 'fear/right_biased'
-  autoload :Utils, 'fear/utils'
+  autoload :None, "fear/none"
+  autoload :NoneClass, "fear/none"
+  autoload :NonePatternMatch, "fear/none_pattern_match"
+  autoload :Option, "fear/option"
+  autoload :OptionPatternMatch, "fear/option_pattern_match"
+  autoload :Some, "fear/some"
+  autoload :SomePatternMatch, "fear/some_pattern_match"
 
-  autoload :None, 'fear/none'
-  autoload :NoneClass, 'fear/none'
-  autoload :NonePatternMatch, 'fear/none_pattern_match'
-  autoload :Option, 'fear/option'
-  autoload :OptionPatternMatch, 'fear/option_pattern_match'
-  autoload :Some, 'fear/some'
-  autoload :SomePatternMatch, 'fear/some_pattern_match'
+  autoload :Failure, "fear/failure"
+  autoload :FailurePatternMatch, "fear/failure_pattern_match"
+  autoload :Success, "fear/success"
+  autoload :SuccessPatternMatch, "fear/success_pattern_match"
+  autoload :Try, "fear/try"
+  autoload :TryPatternMatch, "fear/try_pattern_match"
 
-  autoload :Failure, 'fear/failure'
-  autoload :FailurePatternMatch, 'fear/failure_pattern_match'
-  autoload :Success, 'fear/success'
-  autoload :SuccessPatternMatch, 'fear/success_pattern_match'
-  autoload :Try, 'fear/try'
-  autoload :TryPatternMatch, 'fear/try_pattern_match'
+  autoload :Either, "fear/either"
+  autoload :EitherPatternMatch, "fear/either_pattern_match"
+  autoload :Left, "fear/left"
+  autoload :LeftPatternMatch, "fear/left_pattern_match"
+  autoload :Right, "fear/right"
+  autoload :RightPatternMatch, "fear/right_pattern_match"
 
-  autoload :Either, 'fear/either'
-  autoload :EitherPatternMatch, 'fear/either_pattern_match'
-  autoload :Left, 'fear/left'
-  autoload :LeftPatternMatch, 'fear/left_pattern_match'
-  autoload :Right, 'fear/right'
-  autoload :RightPatternMatch, 'fear/right_pattern_match'
+  autoload :Await, "fear/await"
+  autoload :Awaitable, "fear/awaitable"
+  autoload :Future, "fear/future"
+  autoload :Promise, "fear/promise"
 
-  autoload :Future, 'fear/future'
+  autoload :Struct, "fear/struct"
 
   module Mixin
     include Either::Mixin

data/lib/fear/await.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Fear
+  # You're strongly discouraged to use this module since it may lead to deadlocks,
+  # and reduced performance. Although, blocking may be useful in some cases (e.g. in tests)
+  #
+  # @see https://stackoverflow.com/questions/38155159/why-doesnt-scalas-future-have-a-get-getmaxduration-method-forcing-us-to
+  module Await
+    # Blocks until +Fear::Awaitable+ reached completed state and returns itself
+    # or raises +TimeoutError+
+    #
+    # @param awaitable [Fear::Awaitable]
+    # @param at_most [Fixnum] timeout in seconds
+    # @return [Fear::Awaitable]
+    # @raise [Timeout::Error]
+    #
+    module_function def ready(awaitable, at_most)
+      awaitable.__ready__(at_most)
+    end
+
+    # Blocks until +Fear::Awaitable+ reached completed state and returns its value
+    # or raises +TimeoutError+
+    #
+    # @param awaitable [Fear::Awaitable]
+    # @param at_most [Fixnum] timeout in seconds
+    # @return [any]
+    # @raise [Timeout::Error]
+    #
+    module_function def result(awaitable, at_most)
+      awaitable.__result__(at_most)
+    end
+  end
+end

data/lib/fear/awaitable.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Fear
+  # An object which may eventually be completed and awaited using blocking methods.
+  #
+  # @abstract
+  # @api private
+  # @see Fear::Await
+  module Awaitable
+    # Await +completed+ state of this +Awaitable+
+    #
+    # @param at_most [Fixnum] maximum timeout in seconds
+    # @return [Fear::Awaitable]
+    # @raise [Timeout::Error]
+    def __ready__(_at_most)
+      raise NotImplementedError
+    end
+
+    # Await and return the result of this +Awaitable+
+    #
+    # @param at_most [Fixnum] maximum timeout in seconds
+    # @return [any]
+    # @raise [Timeout::Error]
+    def __result__(_at_most)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/fear/either.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   # Represents a value of one of two possible types (a disjoint union.)
   # An instance of +Either+ is either an instance of +Left+ or +Right+.

data/lib/fear/either_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   module EitherApi
     # @param value [any]

data/lib/fear/either_pattern_match.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   # Either pattern matcher
   #

data/lib/fear/empty_partial_function.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   # Use singleton version of EmptyPartialFunction -- PartialFunction::EMPTY
   # @api private
@@ -28,7 +30,7 @@ module Fear
     end
 
     def to_s
-      'Empty partial function'
+      "Empty partial function"
     end
   end
 

data/lib/fear/extractor.rb

@@ -1,24 +1,26 @@
-require 'treetop'
-require 'fear/extractor/grammar'
-Treetop.load File.expand_path('extractor/grammar.treetop', __dir__)
+# frozen_string_literal: true
+
+require "treetop"
+require "fear/extractor/grammar"
+Treetop.load File.expand_path("extractor/grammar.treetop", __dir__)
 
 module Fear
   # @api private
   module Extractor
-    autoload :Pattern, 'fear/extractor/pattern'
-    autoload :Matcher, 'fear/extractor/matcher'
+    autoload :Pattern, "fear/extractor/pattern"
+    autoload :Matcher, "fear/extractor/matcher"
 
-    autoload :AnonymousArraySplatMatcher, 'fear/extractor/anonymous_array_splat_matcher'
-    autoload :AnyMatcher, 'fear/extractor/any_matcher'
-    autoload :ArrayHeadMatcher, 'fear/extractor/array_head_matcher'
-    autoload :ArrayMatcher, 'fear/extractor/array_matcher'
-    autoload :ArraySplatMatcher, 'fear/extractor/array_splat_matcher'
-    autoload :EmptyListMatcher, 'fear/extractor/empty_list_matcher'
-    autoload :ExtractorMatcher, 'fear/extractor/extractor_matcher'
-    autoload :IdentifierMatcher, 'fear/extractor/identifier_matcher'
-    autoload :NamedArraySplatMatcher, 'fear/extractor/named_array_splat_matcher'
-    autoload :TypedIdentifierMatcher, 'fear/extractor/typed_identifier_matcher'
-    autoload :ValueMatcher, 'fear/extractor/value_matcher'
+    autoload :AnonymousArraySplatMatcher, "fear/extractor/anonymous_array_splat_matcher"
+    autoload :AnyMatcher, "fear/extractor/any_matcher"
+    autoload :ArrayHeadMatcher, "fear/extractor/array_head_matcher"
+    autoload :ArrayMatcher, "fear/extractor/array_matcher"
+    autoload :ArraySplatMatcher, "fear/extractor/array_splat_matcher"
+    autoload :EmptyListMatcher, "fear/extractor/empty_list_matcher"
+    autoload :ExtractorMatcher, "fear/extractor/extractor_matcher"
+    autoload :IdentifierMatcher, "fear/extractor/identifier_matcher"
+    autoload :NamedArraySplatMatcher, "fear/extractor/named_array_splat_matcher"
+    autoload :TypedIdentifierMatcher, "fear/extractor/typed_identifier_matcher"
+    autoload :ValueMatcher, "fear/extractor/value_matcher"
 
     ExtractorNotFound = Class.new(Error)
 
@@ -26,7 +28,7 @@ module Fear
     @registry = PartialFunction::EMPTY
 
     EXTRACTOR_NOT_FOUND = proc do |klass|
-      raise ExtractorNotFound, 'could not find extractor for ' + klass.inspect
+      raise ExtractorNotFound, "could not find extractor for " + klass.inspect
     end
 
     class << self
@@ -58,7 +60,7 @@ module Fear
 
         @mutex.synchronize do
           keys.uniq.each do |key|
-            @registry = BUILD_EXTRACTOR.call(key, extractor).or_else(@registry)
+            @registry = BUILD_EXTRACTOR.(key, extractor).or_else(@registry)
           end
         end
         self
@@ -81,16 +83,16 @@ module Fear
     end
 
     # Multiple arguments extractor example
-    register_extractor('Date', proc do |other|
-      if other.class.name == 'Date'
+    register_extractor("Date", proc do |other|
+      if other.class.name == "Date"
         Fear.some([other.year, other.month, other.day])
       else
         Fear.none
       end
     end)
-    register_extractor(Struct, Fear.case(Struct, &:to_a).lift)
+    register_extractor(::Struct, Fear.case(::Struct, &:to_a).lift)
     # No argument boolean extractor example
-    register_extractor('IsEven', proc do |int|
+    register_extractor("IsEven", proc do |int|
       if int.is_a?(Integer) && int.even?
         Fear.some([])
       else
@@ -98,11 +100,11 @@ module Fear
       end
     end)
     # Single argument extractor example
-    register_extractor('Fear::Some', 'Some', Some::EXTRACTOR)
-    register_extractor('Fear::None', 'None', NoneClass::EXTRACTOR)
-    register_extractor('Fear::Right', 'Right', Right::EXTRACTOR)
-    register_extractor('Fear::Left', 'Left', Left::EXTRACTOR)
-    register_extractor('Fear::Success', 'Success', Success::EXTRACTOR)
-    register_extractor('Fear::Failure', 'Failure', Failure::EXTRACTOR)
+    register_extractor("Fear::Some", "Some", Some::EXTRACTOR)
+    register_extractor("Fear::None", "None", NoneClass::EXTRACTOR)
+    register_extractor("Fear::Right", "Right", Right::EXTRACTOR)
+    register_extractor("Fear::Left", "Left", Left::EXTRACTOR)
+    register_extractor("Fear::Success", "Success", Success::EXTRACTOR)
+    register_extractor("Fear::Failure", "Failure", Failure::EXTRACTOR)
   end
 end