dry-monads 1.3.5 → 1.4.0

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2020 dry-rb team
+Copyright (c) 2015-2021 dry-rb team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.md

@@ -1,3 +1,4 @@
+<!--- this file is synced from dry-rb/template-gem project -->
 [gem]: https://rubygems.org/gems/dry-monads
 [actions]: https://github.com/dry-rb/dry-monads/actions
 [codacy]: https://www.codacy.com/gh/dry-rb/dry-monads
@@ -7,22 +8,22 @@
 # dry-monads [![Join the chat at https://dry-rb.zulipchat.com](https://img.shields.io/badge/dry--rb-join%20chat-%23346b7a.svg)][chat]
 
 [![Gem Version](https://badge.fury.io/rb/dry-monads.svg)][gem]
-[![CI Status](https://github.com/dry-rb/dry-monads/workflows/ci/badge.svg)][actions]
+[![CI Status](https://github.com/dry-rb/dry-monads/workflows/CI/badge.svg)][actions]
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/f2eed41bf7f04b38b0a7691c2cf6e73c)][codacy]
 [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/f2eed41bf7f04b38b0a7691c2cf6e73c)][codacy]
 [![Inline docs](http://inch-ci.org/github/dry-rb/dry-monads.svg?branch=master)][inchpages]
 
 ## Links
 
-* [User documentation](http://dry-rb.org/gems/dry-monads)
+* [User documentation](https://dry-rb.org/gems/dry-monads)
 * [API documentation](http://rubydoc.info/gems/dry-monads)
 
 ## Supported Ruby versions
 
 This library officially supports the following Ruby versions:
 
-* MRI >= `2.4`
-* jruby >= `9.2`
+* MRI `>= 2.6.0`
+* ~~jruby~~ `>= 9.3` (we are waiting for [2.6 support](https://github.com/jruby/jruby/issues/6161))
 
 ## License
 

data/dry-monads.gemspec

@@ -1,39 +1,39 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+# this file is synced from dry-rb/template-gem project
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'dry/monads/version'
+require "dry/monads/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'dry-monads'
+  spec.name          = "dry-monads"
+  spec.authors       = ["Nikita Shilnikov"]
+  spec.email         = ["fg@flashgordon.ru"]
+  spec.license       = "MIT"
   spec.version       = Dry::Monads::VERSION.dup
-  spec.authors       = ['Nikita Shilnikov']
-  spec.email         = ['fg@flashgordon.ru']
-  spec.license       = 'MIT'
 
-  spec.summary       = 'Common monads for Ruby.'
+  spec.summary       = "Common monads for Ruby"
   spec.description   = spec.summary
-  spec.homepage      = 'https://github.com/dry-rb/dry-monads'
-
-  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
-  # delete this section to allow pushing this gem to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
-  end
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.4.0'
-  spec.add_dependency 'concurrent-ruby', '~> 1.0'
-  spec.add_dependency 'dry-core', '~> 0.4', '>= 0.4.4'
-  spec.add_dependency 'dry-equalizer'
-
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'dry-types', '>= 0.12'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
+  spec.homepage      = "https://dry-rb.org/gems/dry-monads"
+  spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "dry-monads.gemspec", "lib/**/*"]
+  spec.bindir        = "bin"
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["changelog_uri"]     = "https://github.com/dry-rb/dry-monads/blob/master/CHANGELOG.md"
+  spec.metadata["source_code_uri"]   = "https://github.com/dry-rb/dry-monads"
+  spec.metadata["bug_tracker_uri"]   = "https://github.com/dry-rb/dry-monads/issues"
+
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # to update dependencies edit project.yml
+  spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"
+  spec.add_runtime_dependency "dry-core", "~> 0.7"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "dry-types", ">= 0.1.2"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

data/lib/dry-monads.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require 'dry/monads'
+require "dry/monads"

data/lib/dry/monads.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'dry/core/constants'
-require 'dry/monads/registry'
+require "dry/core/constants"
+require "dry/monads/registry"
 
 module Dry
   # Common, idiomatic monads for Ruby

data/lib/dry/monads/all.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'dry/monads'
-require 'dry/monads/registry'
+require "dry/monads"
+require "dry/monads/registry"
 
 module Dry
   module Monads

data/lib/dry/monads/constants.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/core/constants'
+require "dry/core/constants"
 
 module Dry
   module Monads

data/lib/dry/monads/do.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'dry/monads/list'
-require 'dry/monads/do/mixin'
-require 'dry/monads/constants'
+require "dry/monads/list"
+require "dry/monads/do/mixin"
+require "dry/monads/constants"
 
 module Dry
   module Monads
@@ -12,7 +12,13 @@ module Dry
     module Do
       extend Mixin
 
-      DELEGATE = ::RUBY_VERSION < '2.7' ? '*' : '...'
+      DELEGATE = ::RUBY_VERSION < "2.7" ? "*" : "..."
+
+      VISIBILITY_WORD = {
+        public: "",
+        private: "private ",
+        protected: "protected "
+      }.freeze
 
       # @api private
       class Halt < StandardError
@@ -26,6 +32,25 @@ module Dry
         end
       end
 
+      # @api private
+      class MethodTracker < ::Module
+        # @api private
+        def initialize(tracked_methods, base, wrapper)
+          module_eval do
+            private
+
+            define_method(:method_added) do |method|
+              super(method)
+
+              if tracked_methods.include?(method)
+                visibility = Do.method_visibility(base, method)
+                Do.wrap_method(wrapper, method, visibility)
+              end
+            end
+          end
+        end
+      end
+
       class << self
         # Generates a module that passes a block to methods
         # that either unwraps a single-valued monadic value or halts
@@ -84,13 +109,11 @@ module Dry
         # @param [Array<Symbol>] methods
         # @return [Module]
         def for(*methods)
-          mod = ::Module.new do
-            methods.each { |method_name| Do.wrap_method(self, method_name) }
-          end
-
           ::Module.new do
             singleton_class.send(:define_method, :included) do |base|
+              mod = ::Module.new
               base.prepend(mod)
+              base.extend(MethodTracker.new(methods, base, mod))
             end
           end
         end
@@ -100,23 +123,34 @@ module Dry
           super
 
           # Actually mixes in Do::All
-          require 'dry/monads/do/all'
+          require "dry/monads/do/all"
           base.include All
         end
 
         # @api private
-        def wrap_method(target, method_name)
+        def wrap_method(target, method, visibility)
           target.module_eval(<<-RUBY, __FILE__, __LINE__ + 1)
-            def #{method_name}(#{DELEGATE})
-              if block_given?
-                super
-              else
-                Do.() { super { |*ms| Do.bind(ms) } }
-              end
-            end
+            #{VISIBILITY_WORD[visibility]} def #{method}(#{DELEGATE}) # private def create_acccount(...)
+              if block_given?                                         #   if block_given?
+                super                                                 #     super
+              else                                                    #   else
+                Do.() { super { |*ms| Do.bind(ms) } }                 #     Do.() { super { |*ms| Do.bind(ms) } }
+              end                                                     #   end
+            end                                                       # end
           RUBY
         end
 
+        # @api private
+        def method_visibility(mod, method)
+          if mod.public_method_defined?(method)
+            :public
+          elsif mod.private_method_defined?(method)
+            :private
+          else
+            :protected
+          end
+        end
+
         # @api private
         def coerce_to_monad(monads)
           return monads if monads.size != 1
@@ -135,7 +169,7 @@ module Dry
 
         # @api private
         def halt(result)
-          raise Halt.new(result), EMPTY_STRING, []
+          raise Halt.new(result), "", []
         end
       end
     end

data/lib/dry/monads/do/all.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/monads/do'
+require "dry/monads/do"
 
 module Dry
   module Monads
@@ -68,9 +68,10 @@ module Dry
             tracker = self
 
             module_eval do
+              private
+
               define_method(:method_added) do |method|
                 super(method)
-
                 tracker.wrap_method(self, method)
               end
 
@@ -93,20 +94,37 @@ module Dry
           end
 
           def wrap_method(target, method)
-            Do.wrap_method(wrappers[target], method)
+            visibility = Do.method_visibility(target, method)
+            Do.wrap_method(wrappers[target], method, visibility)
           end
         end
 
-        # @api private
-        def self.included(base)
-          super
+        class << self
+          # @api private
+          def included(base)
+            super
 
-          wrappers = ::Hash.new { |h, k| h[k] = ::Module.new }
-          tracker = MethodTracker.new(wrappers)
-          base.extend(tracker)
-          base.instance_methods(false).each { |m| tracker.wrap_method(base, m) }
+            wrappers = ::Hash.new { |h, k| h[k] = ::Module.new }
+            tracker = MethodTracker.new(wrappers)
+            base.extend(tracker)
+            base.extend(InstanceMixin) unless base.is_a?(::Class)
+            wrap_defined_methods(base, wrappers[base])
+          end
 
-          base.extend(InstanceMixin) unless base.is_a?(::Class)
+          # @api private
+          def wrap_defined_methods(klass, target)
+            klass.public_instance_methods(false).each do |m|
+              Do.wrap_method(target, m, :public)
+            end
+
+            klass.protected_instance_methods(false).each do |m|
+              Do.wrap_method(target, m, :protected)
+            end
+
+            klass.private_instance_methods(false).each do |m|
+              Do.wrap_method(target, m, :private)
+            end
+          end
         end
 
         # @api private
@@ -116,17 +134,18 @@ module Dry
             super
 
             wrapper = ::Module.new
-            object.singleton_class.prepend(wrapper)
+            eigenclass = object.singleton_class
+            eigenclass.prepend(wrapper)
             object.define_singleton_method(:singleton_method_added) do |method|
               super(method)
 
               next if method.equal?(:singleton_method_added)
 
-              Do.wrap_method(wrapper, method)
-            end
-            object.singleton_class.instance_methods(false).each do |m|
-              Do.wrap_method(wrapper, m)
+              visibility = Do.method_visibility(eigenclass, method)
+              Do.wrap_method(wrapper, method, visibility)
             end
+
+            All.wrap_defined_methods(eigenclass, wrapper)
           end
         end
 
@@ -134,7 +153,7 @@ module Dry
       end
     end
 
-    require 'dry/monads/registry'
+    require "dry/monads/registry"
     register_mixin(:do, Do::All)
   end
 end

data/lib/dry/monads/either.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'dry/core/deprecations'
+require "dry/core/deprecations"
 
-Dry::Core::Deprecations.warn('Either monad was renamed to Result', tag: :'dry-monads')
+Dry::Core::Deprecations.warn("Either monad was renamed to Result", tag: :"dry-monads")
 
-require 'dry/monads/result'
+require "dry/monads/result"
 
 module Dry
   module Monads
@@ -12,7 +12,7 @@ module Dry
     deprecate_constant :Either
 
     class Result
-      extend Dry::Core::Deprecations[:'dry-monads']
+      extend ::Dry::Core::Deprecations[:"dry-monads"]
 
       deprecate :to_either, :to_result
 
@@ -24,7 +24,7 @@ module Dry
 
       module Mixin
         module Constructors
-          extend Dry::Core::Deprecations[:'dry-monads']
+          extend Dry::Core::Deprecations[:"dry-monads"]
 
           Right = Success
           Left = Failure
@@ -51,13 +51,13 @@ module Dry
 
     class Try
       class Value
-        extend Dry::Core::Deprecations[:'dry-monads']
+        extend Dry::Core::Deprecations[:"dry-monads"]
 
         deprecate :to_either, :to_result
       end
 
       class Error
-        extend Dry::Core::Deprecations[:'dry-monads']
+        extend Dry::Core::Deprecations[:"dry-monads"]
 
         deprecate :to_either, :to_result
       end

data/lib/dry/monads/errors.rb

@@ -4,8 +4,11 @@ module Dry
   module Monads
     # An unsuccessful result of extracting a value from a monad.
     class UnwrapError < StandardError
-      def initialize(ctx)
-        super("value! was called on #{ctx.inspect}")
+      attr_reader :receiver
+
+      def initialize(receiver)
+        @receiver = receiver
+        super("value! was called on #{receiver.inspect}")
       end
     end
 

data/lib/dry/monads/lazy.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
-require 'concurrent/promise'
+require "concurrent/promise"
 
-require 'dry/monads/task'
+require "dry/core/deprecations"
+require "dry/monads/task"
 
 module Dry
   module Monads
@@ -11,6 +12,8 @@ module Dry
     # computation is evaluated not more than once (compare with the built-in
     # lazy assignement ||= which does not guarantee this).
     class Lazy < Task
+      extend ::Dry::Core::Deprecations[:"dry-monads"]
+
       class << self
         # @private
         def new(promise = nil, &block)
@@ -41,6 +44,14 @@ module Dry
         self
       end
 
+      # @return [Boolean]
+      def evaluated?
+        @promise.complete?
+      end
+      deprecate :complete?, :evaluated?
+
+      undef_method :wait
+
       # @return [String]
       def to_s
         state = case promise.state
@@ -49,7 +60,7 @@ module Dry
                 when :rejected
                   "!#{promise.reason.inspect}"
                 else
-                  '?'
+                  "?"
                 end
 
         "Lazy(#{state})"
@@ -80,7 +91,7 @@ module Dry
       end
     end
 
-    require 'dry/monads/registry'
+    require "dry/monads/registry"
     register_mixin(:lazy, Lazy::Mixin)
   end
 end