kind 5.1.0 → 5.5.0

data/lib/kind/functional/action.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'kind/functional'
+require 'kind/functional/steps'
+
+module Kind
+  module Functional::Action
+    CALL_TMPL = [
+      'def call(%s)',
+      '  result = call!(%s)',
+      '',
+      '  return result if Kind::Result::Monad === result',
+      '',
+      '  raise Kind::Error, "#{self.class.name}#call! must return a Kind::Success or Kind::Failure"',
+      'end'
+    ].join("\n").freeze
+
+    module Macros
+      def kind_functional_action!
+        return self if Kind.is?(Result::Methods, self)
+
+        public_methods = self.public_instance_methods - ::Object.new.methods
+
+        unless public_methods.include?(:call!)
+          raise Kind::Error.new("expected #{self} to implement `#call!`")
+        end
+
+        if public_methods.size > 1
+          raise Kind::Error.new("#{self} can only have `#call!` as its public method")
+        end
+
+        call_parameters = public_instance_method(:call!).parameters
+
+        if call_parameters.empty?
+          raise ArgumentError, "#{self.name}#call! must receive at least one argument"
+        end
+
+        def self.inherited(_)
+          raise RuntimeError, "#{self.name} is a Kind::Functional::Action and it can't be inherited"
+        end
+
+        call_parameters.flatten!
+
+        call_with_args = call_parameters.include?(:req) || call_parameters.include?(:rest)
+        call_with_kargs = call_parameters.include?(:keyreq) || call_parameters.include?(:keyrest)
+
+        call_tmpl_args = '*args, **kargs' if call_with_args && call_with_kargs
+        call_tmpl_args = '*args'          if call_with_args && !call_with_kargs
+        call_tmpl_args = '**kargs'        if !call_with_args && call_with_kargs
+
+        self.class_eval(
+          "def to_proc; @to_proc ||= method(:call!).to_proc; end" \
+          "\n" \
+          "def curry; @curry ||= to_proc.curry; end" \
+          "\n" \
+          "#{CALL_TMPL % [call_tmpl_args, call_tmpl_args]}"
+        )
+
+        if Kind.of_module?(self)
+          self.send(:extend, Functional::Steps)
+        else
+          self.send(:include, Functional::Steps)
+          self.send(:include, Functional::Behavior)
+
+          __dependencies__.freeze
+        end
+
+        self.send(:protected, :call!)
+
+        self
+      end
+    end
+
+    def self.included(base)
+      Kind.of_class(base).send(:extend, Functional::DependencyInjection)
+
+      base.send(:extend, Macros)
+    end
+
+    def self.extended(base)
+      base.send(:extend, Kind.of_module(base))
+      base.send(:extend, Macros)
+    end
+
+    private_constant :Macros, :CALL_TMPL
+  end
+end

data/lib/kind/functional/steps.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'kind/basic'
+require 'kind/empty'
+require 'kind/result'
+require 'kind/__lib__/action_steps'
+
+module Kind
+  module Functional
+    module Steps
+      def self.extended(base)
+        base.extend(Result::Methods)
+        base.extend(ACTION_STEPS)
+      end
+
+      def self.included(base)
+        base.send(:include, Result::Methods)
+        base.send(:include, ACTION_STEPS)
+      end
+    end
+  end
+end

data/lib/kind/immutable_attributes.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'kind/basic'
+require 'kind/__lib__/attributes'
+
+module Kind
+  module ImmutableAttributes
+    require 'kind/immutable_attributes/initializer'
+    require 'kind/immutable_attributes/reader'
+
+    module ClassMethods
+      def __attributes__ # :nodoc:
+        @__attributes__ ||= {}
+      end
+
+      def attribute(name, kind = nil, default: UNDEFINED, visibility: :public)
+        __attributes__[ATTRIBUTES.name!(name)] = ATTRIBUTES.value(kind, default, visibility)
+
+        attr_reader(name)
+
+        private(name) if visibility == :private
+        protected(name) if visibility == :protected
+
+        name
+      end
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.send(:include, Reader)
+      base.send(:include, Initializer)
+    end
+  end
+end

data/lib/kind/immutable_attributes/initializer.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'kind/__lib__/attributes'
+require 'kind/basic'
+require 'kind/empty'
+
+module Kind
+  module ImmutableAttributes
+    module Initializer
+      def initialize(arg)
+        input = __resolve_attribute_input(arg)
+
+        hash = call_before_initialize_to_prepare_the_input(input)
+
+        @_nil_attrs = ::Set.new
+        @_____attrs = {}
+        @attributes = {}
+
+        self.class.__attributes__.each do |name, (kind, default, visibility)|
+          value_to_assign = __resolve_attribute_value_to_assign(kind, default, hash, name)
+
+          @_nil_attrs << name if value_to_assign.nil?
+          @_____attrs[name] = value_to_assign
+          @attributes[name] = value_to_assign if visibility == :public
+
+          instance_variable_set("@#{name}", value_to_assign)
+        end
+
+        @_nil_attrs.freeze
+        @attributes.freeze
+
+        call_after_initialize_and_assign_the_attributes
+      end
+
+      def nil_attributes
+        @_nil_attrs.to_a
+      end
+
+      def nil_attributes?(*names)
+        names.empty? ? !@_nil_attrs.empty? : names.all? { |name| @_nil_attrs.include?(name) }
+      end
+
+      private
+
+        def call_before_initialize_to_prepare_the_input(input)
+          input
+        end
+
+        def call_after_initialize_and_assign_the_attributes
+        end
+
+        def __resolve_attribute_input(arg)
+          return arg.attributes if arg.kind_of?(ImmutableAttributes)
+
+          arg.kind_of?(::Hash) ? arg : Empty::HASH
+        end
+
+        def __resolve_attribute_value_to_assign(kind, default, hash, name)
+          if kind.kind_of?(::Class) && kind < ImmutableAttributes
+            kind.new(hash[name])
+          elsif kind.kind_of?(::Array) && (nkind = kind[0]).kind_of?(::Class) && nkind < ImmutableAttributes
+            Array(hash[name]).map { |item| nkind.new(item) }
+          else
+            ATTRIBUTES.value_to_assign(kind, default, hash, name)
+          end
+        end
+    end
+
+  end
+end

data/lib/kind/immutable_attributes/reader.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'kind/basic'
+require 'kind/__lib__/attributes'
+
+module Kind
+  module ImmutableAttributes
+
+    module Reader
+      def self.included(base)
+        base.send(:attr_reader, :attributes)
+      end
+
+      def attribute?(name)
+        self.class.__attributes__.key?(name.to_sym)
+      end
+
+      def attribute(name)
+        @attributes[name.to_sym]
+      end
+
+      def attribute!(name)
+        @attributes.fetch(name.to_sym)
+      end
+
+      def with_attribute(name, value)
+        self.class.new(@_____attrs.merge(name.to_sym => value))
+      end
+
+      def with_attributes(arg)
+        hash = STRICT.kind_of(::Hash, arg)
+
+        self.class.new(@_____attrs.merge(hash))
+      end
+    end
+
+  end
+end

data/lib/kind/maybe.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'kind/basic'
+
+module Kind
+  module Maybe
+    require 'kind/maybe/monad'
+    require 'kind/maybe/none'
+    require 'kind/maybe/some'
+    require 'kind/maybe/wrapper'
+    require 'kind/maybe/typed'
+    require 'kind/maybe/methods'
+
+    extend self
+
+    def new(value)
+      (::Exception === value || KIND.nil_or_undefined?(value) ? None : Some)
+        .new(value)
+    end
+
+    alias_method :[], :new
+
+    module Buildable
+      def maybe(value = UNDEFINED, &block)
+        return __maybe[value] if UNDEFINED != value && !block
+        return __maybe.wrap(&block) if UNDEFINED == value && block
+        return __maybe.wrap(value, &block) if UNDEFINED != value && block
+
+        __maybe
+      end
+
+      alias_method :optional, :maybe
+
+      private
+
+        def __maybe
+          @__maybe ||= Maybe::Typed[self]
+        end
+    end
+
+    extend Wrapper
+  end
+
+  Optional = Maybe
+
+  None = Maybe::NONE_INSTANCE
+
+  def self.None
+    Maybe::NONE_INSTANCE
+  end
+
+  def self.Some(value)
+    Maybe::Some[value]
+  end
+
+  def self.Maybe(kind)
+    warn '[DEPRECATION] Kind::Maybe() is deprecated; use Kind::Maybe::Typed[] instead. ' \
+        'It will be removed on next major release.'
+
+    Maybe::Typed[kind]
+  end
+
+  def self.Optional(kind)
+    warn '[DEPRECATION] Kind::Optional() is deprecated; use Kind::Optional::Typed[] instead. ' \
+        'It will be removed on next major release.'
+
+    Optional::Typed[kind]
+  end
+end

data/lib/kind/maybe/methods.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Kind
+  module Maybe::Methods
+    def Maybe(&block)
+      Kind::Maybe.from(&block)
+    end
+
+    def None
+      Kind::Maybe::NONE_INSTANCE
+    end
+
+    def Some(value = UNDEFINED, &block)
+      UNDEFINED == value && block ? Maybe(&block) : Kind::Maybe[value]
+    end
+
+    def self.included(base)
+      base.send(:private, :Some, :None)
+    end
+  end
+end

data/lib/kind/maybe/monad.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Kind
+  module Maybe
+    class Monad
+      require 'kind/maybe/monad/wrapper'
+
+      attr_reader :value
+
+      Value = ->(arg) { arg.kind_of?(Maybe::Monad) ? arg.value : arg } # :nodoc:
+
+      def initialize(value)
+        @value = Value[value]
+      end
+
+      def value_or(_method_name = UNDEFINED, &block)
+        raise NotImplementedError
+      end
+
+      def none?
+        raise NotImplementedError
+      end
+
+      def some?; !none?; end
+
+      def map(&fn)
+        raise NotImplementedError
+      end
+
+      alias_method :map!, :map
+      alias_method :then, :map
+      alias_method :then!, :map
+      alias_method :and_then, :map
+      alias_method :and_then!, :map!
+
+      def check(&fn)
+        raise NotImplementedError
+      end
+
+      alias_method :accept, :check
+      alias_method :reject, :check
+
+      def try(_method_name = UNDEFINED, &block)
+        raise NotImplementedError
+      end
+
+      alias_method :try!, :try
+
+      def dig(*keys)
+        raise NotImplementedError
+      end
+
+      def presence
+        raise NotImplementedError
+      end
+
+      def on
+        monad = Wrapper.new(self)
+
+        yield(monad)
+
+        monad.output
+      end
+
+      def on_some(matcher = UNDEFINED)
+        yield(value) if some? && maybe?(matcher)
+
+        self
+      end
+
+      def on_none(matcher = UNDEFINED)
+        yield(value) if none? && maybe?(matcher)
+
+        self
+      end
+
+      def maybe?(matcher)
+        UNDEFINED == matcher || matcher === value
+      end
+    end
+  end
+end

data/lib/kind/maybe/monad/wrapper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Kind
+  require 'kind/monad'
+
+  class Maybe::Monad::Wrapper < Kind::Monad::Wrapper
+    def none(matcher = UNDEFINED)
+      return if @monad.some? || output?
+
+      @output = yield(@monad.value) if @monad.maybe?(matcher)
+    end
+
+    def some(matcher = UNDEFINED)
+      return if @monad.none? || output?
+
+      @output = yield(@monad.value) if @monad.maybe?(matcher)
+    end
+  end
+end