fear 1.0.0 → 1.1.0

data/lib/fear/future_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   # rubocop: disable Metrics/LineLength
   module FutureApi

data/lib/fear/left.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   class Left
     include Either
@@ -52,7 +54,7 @@ module Fear
     # @param reduce_left [Proc]
     # @return [any]
     def reduce(reduce_left, _reduce_right)
-      reduce_left.call(value)
+      reduce_left.(value)
     end
 
     # @return [self]

data/lib/fear/left_pattern_match.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   # @api private
   class LeftPatternMatch < Fear::EitherPatternMatch

data/lib/fear/none.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   # @api private
   class NoneClass
@@ -40,7 +42,7 @@ module Fear
 
     # @return [String]
     def inspect
-      '#<Fear::NoneClass>'
+      "#<Fear::NoneClass>"
     end
 
     # @return [String]
@@ -70,7 +72,7 @@ module Fear
     end
 
     def inherited(*)
-      raise 'you are not allowed to inherit from NoneClass, use Fear::None instead'
+      raise "you are not allowed to inherit from NoneClass, use Fear::None instead"
     end
   end
 end

data/lib/fear/none_pattern_match.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   # @api private
   class NonePatternMatch < OptionPatternMatch

data/lib/fear/option.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   # Represents optional values. Instances of +Option+
   # are either an instance of +Some+ or the object +None+.
@@ -187,7 +189,7 @@ module Fear
       end
 
       def match(value, &block)
-        matcher(&block).call(value)
+        matcher(&block).(value)
       end
     end
 

data/lib/fear/option_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   module OptionApi
     # An +Option+ factory which creates +Some+ if the argument is

data/lib/fear/option_pattern_match.rb

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

data/lib/fear/partial_function.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   # A partial function is a unary function defined on subset of all possible inputs.
   # The method +defined_at?+ allows to test dynamically if an arg is in
@@ -43,13 +45,13 @@ module Fear
   #   @return [#call]
   #   @abstract
   module PartialFunction
-    autoload :AndThen, 'fear/partial_function/and_then'
-    autoload :Any, 'fear/partial_function/any'
-    autoload :Combined, 'fear/partial_function/combined'
-    autoload :EMPTY, 'fear/partial_function/empty'
-    autoload :Guard, 'fear/partial_function/guard'
-    autoload :Lifted, 'fear/partial_function/lifted'
-    autoload :OrElse, 'fear/partial_function/or_else'
+    autoload :AndThen, "fear/partial_function/and_then"
+    autoload :Any, "fear/partial_function/any"
+    autoload :Combined, "fear/partial_function/combined"
+    autoload :EMPTY, "fear/partial_function/empty"
+    autoload :Guard, "fear/partial_function/guard"
+    autoload :Lifted, "fear/partial_function/lifted"
+    autoload :OrElse, "fear/partial_function/or_else"
 
     # Checks if a value is contained in the function's domain.
     #
@@ -125,7 +127,7 @@ module Fear
     #   @return [Fear::PartialFunction]
     #
     def and_then(other = Utils::UNDEFINED, &block)
-      Utils.with_block_or_argument('Fear::PartialFunction#and_then', other, block) do |fun|
+      Utils.with_block_or_argument("Fear::PartialFunction#and_then", other, block) do |fun|
         if fun.is_a?(Fear::PartialFunction)
           Combined.new(self, fun)
         else

data/lib/fear/partial_function/and_then.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   module PartialFunction
     # Composite function produced by +PartialFunction#and_then+ method
@@ -23,7 +25,7 @@ module Fear
       # @param arg [any]
       # @return [any ]
       def call(arg)
-        function.call(partial_function.call(arg))
+        function.(partial_function.(arg))
       end
 
       # @param arg [any]
@@ -39,7 +41,7 @@ module Fear
         result = partial_function.call_or_else(arg) do
           return yield(arg)
         end
-        function.call(result)
+        function.(result)
       end
     end
 

data/lib/fear/partial_function/any.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   module PartialFunction
     # Any is an object which is always truthy

data/lib/fear/partial_function/combined.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   module PartialFunction
     # Composite function produced by +PartialFunction#and_then+ method
@@ -22,7 +24,7 @@ module Fear
       # @param arg [any]
       # @return [any ]
       def call(arg)
-        f2.call(f1.call(arg))
+        f2.(f1.(arg))
       end
 
       alias === call

data/lib/fear/partial_function/empty.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   module PartialFunction
     EMPTY = EmptyPartialFunction.new

data/lib/fear/partial_function/guard.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module Fear
   module PartialFunction
     # Guard represents PartialFunction guardian
     #
     # @api private
     class Guard
-      autoload :And, 'fear/partial_function/guard/and'
-      autoload :And3, 'fear/partial_function/guard/and3'
-      autoload :Or, 'fear/partial_function/guard/or'
+      autoload :And, "fear/partial_function/guard/and"
+      autoload :And3, "fear/partial_function/guard/and3"
+      autoload :Or, "fear/partial_function/guard/or"
 
       class << self
         # Optimized version for combination of two guardians
@@ -35,7 +37,7 @@ module Fear
           when 0 then Any
           else
             head, *tail = conditions
-            tail.inject(new(head)) { |acc, condition| acc.and(new(condition)) }
+            tail.reduce(new(head)) { |acc, condition| acc.and(new(condition)) }
           end
         end
 
@@ -45,7 +47,7 @@ module Fear
           return Any if conditions.empty?
 
           head, *tail = conditions
-          tail.inject(new(head)) { |acc, condition| acc.or(new(condition)) }
+          tail.reduce(new(head)) { |acc, condition| acc.or(new(condition)) }
         end
       end
 

data/lib/fear/partial_function/guard/and.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   module PartialFunction
     class Guard

data/lib/fear/partial_function/guard/and3.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   module PartialFunction
     class Guard

data/lib/fear/partial_function/guard/or.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   module PartialFunction
     class Guard

data/lib/fear/partial_function/lifted.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   module PartialFunction
     # @api private

data/lib/fear/partial_function/or_else.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   module PartialFunction
     # Composite function produced by +PartialFunction#or_else+ method
@@ -36,7 +38,7 @@ module Fear
 
       # @see Fear::PartialFunction#and_then
       def and_then(other = Utils::UNDEFINED, &block)
-        Utils.with_block_or_argument('Fear::PartialFunction::OrElse#and_then', other, block) do |fun|
+        Utils.with_block_or_argument("Fear::PartialFunction::OrElse#and_then", other, block) do |fun|
           OrElse.new(f1.and_then(&fun), f2.and_then(&fun))
         end
       end

data/lib/fear/partial_function_class.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   # @api private
   class PartialFunctionClass
@@ -25,7 +27,7 @@ module Fear
     # @yield [arg] if function not defined
     def call_or_else(arg)
       if defined_at?(arg)
-        function.call(arg)
+        function.(arg)
       else
         yield arg
       end

data/lib/fear/pattern_match.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   # Pattern match builder. Provides DSL for building pattern matcher
   # Pattern match is just a combination of partial functions
@@ -59,7 +61,7 @@ module Fear
 
         Module.new do
           define_method(as) do |&matchers|
-            matcher_class.new(&matchers).call(self)
+            matcher_class.new(&matchers).(self)
           end
         end
       end

data/lib/fear/pattern_matching_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   # @api private
   module PatternMatchingApi
@@ -83,7 +85,7 @@ module Fear
     # @yieldparam matcher [Fear::PartialFunction]
     # @return [any]
     def match(value, &block)
-      matcher(&block).call(value)
+      matcher(&block).(value)
     end
 
     # Creates partial function defined on domain described with guards

data/lib/fear/promise.rb

@@ -1,8 +1,16 @@
+# frozen_string_literal: true
+
+begin
+  require "concurrent"
+rescue LoadError
+  puts "You must add 'concurrent-ruby' to your Gemfile in order to use Fear::Future"
+end
+
 module Fear
   # @api private
   class Promise < Concurrent::IVar
-    # @param options [Hash] options passed to underlying +Concurrent::Future+
-    def initialize(options = {})
+    # @param options [Hash] options passed to underlying +Concurrent::Promise+
+    def initialize(**options)
       super()
       @options = options
       @promise = Concurrent::Promise.new(options) do
@@ -64,7 +72,7 @@ module Fear
       if complete(result)
         self
       else
-        raise IllegalStateException, 'Promise already completed.'
+        raise IllegalStateException, "Promise already completed."
       end
     end
 

data/lib/fear/right.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   class Right
     include Either
@@ -65,7 +67,7 @@ module Fear
     # @param reduce_right [Proc]
     # @return [any]
     def reduce(_reduce_left, reduce_right)
-      reduce_right.call(value)
+      reduce_right.(value)
     end
 
     # @return [Either]

data/lib/fear/right_biased.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   # @private
   module RightBiased
@@ -7,14 +9,14 @@ module Fear
       # Returns the value from this `RightBiased::Right` or the given argument if
       # this is a `RightBiased::Left`.
       def get_or_else(*args, &block)
-        Utils.assert_arg_or_block!('get_or_else', *args, &block)
+        Utils.assert_arg_or_block!("get_or_else", *args, &block)
         super
       end
 
       # Returns this `RightBiased::Right` or the given alternative if
       # this is a `RightBiased::Left`.
       def or_else(*args, &block)
-        Utils.assert_arg_or_block!('or_else', *args, &block)
+        Utils.assert_arg_or_block!("or_else", *args, &block)
         super.tap do |result|
           Utils.assert_type!(result, left_class, right_class)
         end

data/lib/fear/right_pattern_match.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   # @api private
   class RightPatternMatch < EitherPatternMatch

data/lib/fear/some.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   class Some
     include Option

data/lib/fear/some_pattern_match.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Fear
   # @api private
   class SomePatternMatch < OptionPatternMatch

data/lib/fear/struct.rb

@@ -0,0 +1,235 @@
+# frozen_string_literal: true
+
+module Fear
+  # Structs are like regular classes and good for modeling immutable data.
+  #
+  # A minimal struct requires just a list of attributes:
+  #
+  #     User = Fear::Struct.with_attributes(:id, :email, :admin)
+  #     john = User.new(id: 2, email: 'john@example.com', admin: false)
+  #
+  #     john.email #=> 'john@example.com'
+  #
+  # Instead of `.with_attributes` factory method you can use classic inheritance:
+  #
+  #     class User < Fear::Struct
+  #       attribute :id
+  #       attribute :email
+  #       attribute :admin
+  #     end
+  #
+  # Since structs are immutable, you are not allowed to reassign their attributes
+  #
+  #     john.email = ''john.doe@example.com'' #=> raises NoMethodError
+  #
+  # Two structs of the same type with the same attributes are equal
+  #
+  #     john1 = User.new(id: 2, email: 'john@example.com', admin: false)
+  #     john2 = User.new(id: 2, admin: false, email: 'john@example.com')
+  #     john1 == john2 #=> true
+  #
+  # You can create a shallow copy of a +Struct+ by using copy method optionally changing its attributes.
+  #
+  #     john = User.new(id: 2, email: 'john@example.com', admin: false)
+  #     admin_john = john.copy(admin: true)
+  #
+  #     john.admin #=> false
+  #     admin_john.admin #=> true
+  #
+  # It's possible to match against struct attributes. The following example extracts email from
+  # user only if user is admin
+  #
+  #     john = User.new(id: 2, email: 'john@example.com', admin: false)
+  #     john.match |m|
+  #       m.xcase('Fear::Struct(_, email, true)') do |email|
+  #         email
+  #       end
+  #     end
+  #
+  # Note, parameters got extracted in order they was defined.
+  #
+  class Struct
+    include PatternMatch.mixin
+
+    @attributes = [].freeze
+
+    class << self
+      # @param base [Fear::Struct]
+      # @api private
+      def inherited(base)
+        base.instance_variable_set(:@attributes, attributes)
+        Fear.register_extractor(base, Fear.case(base, &:to_a).lift)
+      end
+
+      # Defines attribute
+      #
+      # @param name [Symbol]
+      # @return [Symbol] attribute name
+      #
+      # @example
+      #   class User < Fear::Struct
+      #     attribute :id
+      #     attribute :email
+      #   end
+      #
+      def attribute(name)
+        name.to_sym.tap do |symbolized_name|
+          @attributes << symbolized_name
+          attr_reader symbolized_name
+        end
+      end
+
+      # Members of this struct
+      #
+      # @return [<Symbol>]
+      def attributes
+        @attributes.dup
+      end
+
+      # Creates new struct with given attributes
+      # @param members [<Symbol>]
+      # @return [Fear::Struct]
+      #
+      # @example
+      #   User = Fear::Struct.with_attributes(:id, :email, :admin) do
+      #     def admin?
+      #       @admin
+      #     end
+      #   end
+      #
+      def with_attributes(*members, &block)
+        members = members
+        block = block
+
+        Class.new(self) do
+          members.each { |member| attribute(member) }
+          class_eval(&block) if block
+        end
+      end
+    end
+
+    # @param attributes [{Symbol => any}]
+    def initialize(**attributes)
+      _check_missing_attributes!(attributes)
+      _check_unknown_attributes!(attributes)
+
+      @values = members.each_with_object([]) do |name, values|
+        attributes.fetch(name).tap do |value|
+          _set_attribute(name, value)
+          values << value
+        end
+      end
+    end
+
+    # Creates a shallow copy of this struct optionally changing the attributes arguments.
+    # @param attributes [{Symbol => any}]
+    #
+    # @example
+    #   User = Fear::Struct.new(:id, :email, :admin)
+    #   john = User.new(id: 2, email: 'john@example.com', admin: false)
+    #   john.admin #=> false
+    #   admin_john = john.copy(admin: true)
+    #   admin_john.admin #=> true
+    #
+    def copy(**attributes)
+      self.class.new(to_h.merge(attributes))
+    end
+
+    # Returns the struct attributes as an array of symbols
+    # @return [<Symbol>]
+    #
+    # @example
+    #   User = Fear::Struct.new(:id, :email, :admin)
+    #   john = User.new(email: 'john@example.com', admin: false, id: 2)
+    #   john.attributes #=> [:id, :email, :admin]
+    #
+    def members
+      self.class.attributes
+    end
+
+    # Returns the values for this struct as an Array.
+    # @return [Array]
+    #
+    # @example
+    #   User = Fear::Struct.new(:id, :email, :admin)
+    #   john = User.new(email: 'john@example.com', admin: false, id: 2)
+    #   john.to_a #=> [2, 'john@example.com', false]
+    #
+    def to_a
+      @values.dup
+    end
+
+    # @overload to_h()
+    #   Returns a Hash containing the names and values for the struct's attributes
+    #   @return [{Symbol => any}]
+    #
+    # @overload to_h(&block)
+    #   Applies block to pairs of name name and value and use them to construct hash
+    #   @yieldparam pair [<Symbol, any>] yields pair of name name and value
+    #   @return [{Symbol => any}]
+    #
+    # @example
+    #   User = Fear::Struct.new(:id, :email, :admin)
+    #   john = User.new(email: 'john@example.com', admin: false, id: 2)
+    #   john.to_h #=> {id: 2, email: 'john@example.com', admin: false}
+    #   john.to_h do |key, value|
+    #     [key.to_s, value]
+    #   end #=> {'id' => 2, 'email' => 'john@example.com', 'admin' => false}
+    #
+    def to_h(&block)
+      pairs = members.zip(@values)
+      if block_given?
+        Hash[pairs.map(&block)]
+      else
+        Hash[pairs]
+      end
+    end
+
+    # @param other [any]
+    # @return [Boolean]
+    def ==(other)
+      other.is_a?(other.class) && to_h == other.to_h
+    end
+
+    INSPECT_TEMPLATE = "<#Fear::Struct %{class_name} %{attributes}>"
+
+    # @return [String]
+    #
+    # @example
+    #   User = Fear::Struct.with_attributes(:id, :email)
+    #   user = User.new(id: 2, email: 'john@exmaple.com')
+    #   user.inspect #=> "<#Fear::Struct User id=2, email=>'john@exmaple.com'>"
+    #
+    def inspect
+      attributes = to_h.map { |key, value| "#{key}=#{value.inspect}" }.join(", ")
+
+      format(INSPECT_TEMPLATE, class_name: self.class.name, attributes: attributes)
+    end
+    alias to_s inspect
+
+    MISSING_KEYWORDS_ERROR = "missing keywords: %{keywords}"
+
+    private def _check_missing_attributes!(provided_attributes)
+      missing_attributes = members - provided_attributes.keys
+
+      unless missing_attributes.empty?
+        raise ArgumentError, format(MISSING_KEYWORDS_ERROR, keywords: missing_attributes.join(", "))
+      end
+    end
+
+    UNKNOWN_KEYWORDS_ERROR = "unknown keywords: %{keywords}"
+
+    private def _check_unknown_attributes!(provided_attributes)
+      unknown_attributes = provided_attributes.keys - members
+
+      unless unknown_attributes.empty?
+        raise ArgumentError, format(UNKNOWN_KEYWORDS_ERROR, keywords: unknown_attributes.join(", "))
+      end
+    end
+
+    # @return [void]
+    private def _set_attribute(name, value)
+      instance_variable_set(:"@#{name}", value)
+    end
+  end
+end