dry-monads 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 613808228df63dd17a3199ed374ed227b5286340
-  data.tar.gz: df17cfd8dafdee56feb611a0acae4dca01c6a17c
+  metadata.gz: 90f99efaec5f7f88c8f150a6af7d9f3ee2bc2a64
+  data.tar.gz: 82c6bb698fa47243c44367c14ab182d893c0b59c
 SHA512:
-  metadata.gz: be3207f4e98696f3f4abc2f9b72d3c912198a1581492a9190c6d6388d86613484b6577db46138e2725cf2e6bdf078150ba8185586a1d0a8e66e4d528ab6c163d
-  data.tar.gz: 5349bf6489ed7ec11b1300858e74a321ec963a7475465560a49318200286632fad5c06dda39e525cf6d7f5d05d3ce56bf5af776dd23543bb7bb123d8f3d066a4
+  metadata.gz: 559a48263fd284e9c93c1773846b66960653a37ca811b249f5482a1cc518aa83a40e71e7adb5d206c50066293e353317793cb68893935c37f8f12a36654ad854
+  data.tar.gz: 8c06400c56a9b753d83df82cd011477cc29ba492a3383d1df325e9fa7eaafd56bef653590cde58c4b415994c63817eac1574b12a769267cf2060ab8c0eead8d5

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+log/

data/.travis.yml

@@ -2,32 +2,24 @@ language: ruby
 dist: trusty
 sudo: false
 cache: bundler
-bundler_args: --without benchmarks
+bundler_args: --without benchmarks docs
 script:
   - bundle exec rake spec
 after_success:
-  # Send coverage report from the job #1 == current MRI release
-  - '[ "${TRAVIS_JOB_NUMBER#*.}" = "1" ] && [ "$TRAVIS_BRANCH" = "master" ] && bundle exec codeclimate-test-reporter'
+  - '[ -d coverage ] && bundle exec codeclimate-test-reporter'
 rvm:
-  - 2.4.0
-  - 2.3.3
-  - 2.2.6
-  - 2.1.10
-  - jruby-9.1.7.0
+  - 2.2.8
+  - 2.3.5
+  - 2.4.2
+  - jruby-9.1.13.0
   - ruby-head
 env:
   global:
     - JRUBY_OPTS='--dev -J-Xmx1024M'
+    - COVERAGE=true
 matrix:
   allow_failures:
     - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: rbx-3
-  include:
-    - rvm: jruby-head
-      before_install: gem update bundler
-    - rvm: rbx-3
-      before_install: gem update bundler
 
 notifications:
   email:

data/.yardopts

@@ -0,0 +1,4 @@
+--markup-provider=redcarpet
+--markup=markdown
+--plugin junk
+lib/**/*.rb

data/CHANGELOG.md

@@ -1,10 +1,39 @@
+# v0.4.0 2017-11-11
+
+## Changed
+
+* The `Either` monad was renamed to `Result` which sounds less nerdy but better reflects the purpose of the type. `Either::Right` became `Result::Success` and `Either::Left` became `Result::Failure`. This change is backward-compatible overall but you will see the new names when using old `Left` and `Right` methods (citizen428)
+* Consequently, `Try::Success` and `Try::Failure` were renamed to `Try::Value` and `Try::Error` (flash-gordon)
+
+## Added
+
+* `Try#or`, works as `Result#or` (flash-gordon)
+* `Maybe#success?` and `Maybe#failure?` (aliases for `#some?` and `#none?`) (flash-gordon)
+* `Either#flip` inverts a `Result` value  (flash-gordon)
+* `List#map` called without a block returns an `Enumerator` object (flash-gordon)
+* Right-biased monads (`Maybe`, `Result`, and `Try`) now implement the `===` operator which is used for equality checks in the `case` statement (flash-gordon)
+  ```ruby
+    case value
+    when Some(1..100)       then :ok
+    when Some { |x| x < 0 } then :negative
+    when Some(Integer)      then :invalid
+    else raise TypeError
+    end
+  ```
+
+## Deprecated
+
+* Direct accessing `value` on right-biased monads has been deprecated, use the `value!` method instead. `value!` will raise an exception if it is called on a Sailure/None/Error instance (flash-gordon)
+
+[Compare v0.3.1...v0.4.0](https://github.com/dry-rb/dry-monads/compare/v0.3.1...v0.4.0)
+
 # v0.3.1 2017-03-18
 
 ## Fixed
 
 * Fixed unexpected coercing to `Hash` on `.bind` call (flash-gordon)
 
-[Compare v0.3.1...v0.3.0](https://github.com/dry-rb/dry-monads/compare/v0.3.0...v0.3.1)
+[Compare v0.3.0...v0.3.1](https://github.com/dry-rb/dry-monads/compare/v0.3.0...v0.3.1)
 
 # v0.3.0 2017-03-16
 
@@ -17,7 +46,7 @@
 * Added `List#traverse` that "flips" the list with an embedded monad (flash-gordon + damncabbage)
 * Added `#tee` for all right-biased monads (flash-gordon)
 
-[Compare v0.3.0...v0.2.1](https://github.com/dry-rb/dry-monads/compare/v0.2.1...v0.3.0)
+[Compare v0.2.1...v0.3.0](https://github.com/dry-rb/dry-monads/compare/v0.2.1...v0.3.0)
 
 # v0.2.1 2016-11-13
 
@@ -30,7 +59,7 @@
 * `Right(nil).to_maybe` now returns `None` with a warning instead of failing (orisaka)
 * `Some#value_or` doesn't require an argument because `None#value_or` doesn't require it either if a block was passed (flash-gordon)
 
-[Compare v0.2.1...v0.2.0](https://github.com/dry-rb/dry-monads/compare/v0.2.0...v0.2.1)
+[Compare v0.2.0...v0.2.1](https://github.com/dry-rb/dry-monads/compare/v0.2.0...v0.2.1)
 
 # v0.2.0 2016-09-18
 

data/CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Issue Guidelines
+
+## Reporting bugs
+
+If you found a bug, report an issue and describe what's the expected behavior versus what actually happens. If the bug causes a crash, attach a full backtrace. If possible, a reproduction script showing the problem is highly appreciated.
+
+## Reporting feature requests
+
+Report a feature request **only after discourseing it first on [discourse.dry-rb.org](https://discourse.dry-rb.org)** where it was accepted. Please provide a concise description of the feature, don't link to a discourseion thread, and instead summarize what was discourseed.
+
+## Reporting questions, support requests, ideas, concerns etc.
+
+**PLEASE DON'T** - use [discourse.dry-rb.org](https://discourse.dry-rb.org) instead.
+
+# Pull Request Guidelines
+
+A Pull Request will only be accepted if it addresses a specific issue that was reported previously, or fixes typos, mistakes in documentation etc.
+
+Other requirements:
+
+1) Do not open a pull request if you can't provide tests along with it. If you have problems writing tests, ask for help in the related issue.
+2) Follow the style conventions of the surrounding code. In most cases, this is standard ruby style.
+3) Add API documentation if it's a new feature
+4) Update API documentation if it changes an existing feature
+5) Bonus points for sending a PR to [github.com/dry-rb/dry-rb.org](github.com/dry-rb/dry-rb.org) which updates user documentation and guides
+
+# Asking for help
+
+If these guidelines aren't helpful, and you're stuck, please post a message on [discourse.dry-rb.org](https://discourse.dry-rb.org).

data/Gemfile

@@ -9,5 +9,11 @@ end
 
 group :tools do
   gem 'pry-byebug', platform: :mri
-  gem 'pry'
+  gem 'pry', platform: :jruby
+end
+
+group :docs do
+  gem 'yard'
+  gem 'yard-junk'
+  gem 'redcarpet'
 end

data/dry-monads.gemspec

@@ -25,11 +25,12 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.required_ruby_version = ">= 2.1.0"
+  spec.required_ruby_version = ">= 2.2.0"
   spec.add_dependency 'dry-equalizer'
-  spec.add_dependency 'dry-core'
+  spec.add_dependency 'dry-core', '~> 0.3', '>= 0.3.3'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'dry-types', '>= 0.12'
 end

data/lib/dry/monads.rb

@@ -1,43 +1,66 @@
-require 'dry/monads/either'
+require 'dry/core/constants'
 require 'dry/monads/maybe'
 require 'dry/monads/try'
 require 'dry/monads/list'
+require 'dry/monads/result'
+require 'dry/monads/result/fixed'
 
 module Dry
   # @api public
   module Monads
-    extend self
+    Undefined = Dry::Core::Constants::Undefined
 
-    # Stores the given value in one of the subtypes of {Maybe} monad.
-    # It is essentially a wrapper for {Maybe.lift}.
-    #
-    # @param value [Object] the value to be stored in the monad
-    # @return [Maybe::Some, Maybe::None]
-    def Maybe(value)
-      Maybe.lift(value)
-    end
+    CONSTRUCTORS = [
+      Maybe::Mixin::Constructors,
+      Result::Mixin::Constructors
+    ].freeze
 
-    # @param value [Object] the value to be stored in the monad
-    # @return [Maybe::Some]
-    def Some(value)
-      Maybe::Some.new(value)
-    end
+    Some = Maybe::Some
+    None = Maybe::None
+    Success = Result::Success
+    Failure = Result::Failure
 
-    # @return [Maybe::None]
-    def None
-      Maybe::Some::None.instance
-    end
+    extend(*CONSTRUCTORS)
+
+    def self.included(base)
+      super
 
-    # @param value [Object] the value to be stored in the monad
-    # @return [Either::Right]
-    def Right(value)
-      Either::Right.new(value)
+      base.include(*CONSTRUCTORS)
     end
 
-    # @param value [Object] the value to be stored in the monad
-    # @return [Either::Left]
-    def Left(value)
-      Either::Left.new(value)
+    # Creates a module that has two methods: `Success` and `Failure`.
+    # `Success` is identical to {Result::Mixin::Constructors#Success} and Failure
+    # rejects values that don't conform the value of the `error`
+    # parameter. This is essentially a Result type with the `Failure` part
+    # fixed.
+    #
+    # @example using dry-types
+    #   module Types
+    #     include Dry::Types.module
+    #   end
+    #
+    #   class Operation
+    #     # :user_not_found and :account_not_found are the only
+    #     # values allowed as failure results
+    #     Error =
+    #       Types.Value(:user_not_found) |
+    #       Types.Value(:account_not_found)
+    #
+    #     def find_account(id)
+    #       account = acount_repo.find(id)
+    #
+    #       account ? Success(account) : Failure(:account_not_found)
+    #     end
+    #
+    #     def find_user(id)
+    #       # ...
+    #     end
+    #   end
+    #
+    # @param error [#===] the type of allowed failures
+    # @return [Module]
+    def self.Result(error, **options)
+      Result::Fixed[error, **options]
     end
   end
 end

data/lib/dry/monads/either.rb

@@ -1,193 +1 @@
-require 'dry/equalizer'
-
-require 'dry/monads/right_biased'
-require 'dry/monads/transformer'
-
-module Dry
-  module Monads
-    # Represents a value which is either correct or an error.
-    #
-    # @api public
-    class Either
-      include Dry::Equalizer(:right, :left)
-      include Transformer
-
-      attr_reader :right, :left
-
-      class << self
-        # Wraps the given value with Right
-        #
-        # @param value [Object] the value to be stored inside Right
-        # @return [Either::Right]
-        def pure(value)
-          Right.new(value)
-        end
-      end
-
-      # Returns self, added to keep the interface compatible with other monads.
-      #
-      # @return [Either::Right, Either::Left]
-      def to_either
-        self
-      end
-
-      # Returns the Either monad.
-      # This is how we're doing polymorphism in Ruby 😕
-      #
-      # @return [Monad]
-      def monad
-        Either
-      end
-
-      # Represents a value that is in a correct state, i.e. everything went right.
-      #
-      # @api public
-      class Right < Either
-        include RightBiased::Right
-
-        alias value right
-
-        # @param right [Object] a value in a correct state
-        def initialize(right)
-          @right = right
-        end
-
-        # Apply the second function to value.
-        #
-        # @api public
-        def either(_, f)
-          f.call(value)
-        end
-
-        # Returns false
-        def left?
-          false
-        end
-        alias failure? left?
-
-        # Returns true
-        def right?
-          true
-        end
-        alias success? right?
-
-        # Does the same thing as #bind except it also wraps the value
-        # in an instance of Either::Right monad. This allows for easier
-        # chaining of calls.
-        #
-        # @example
-        #   Dry::Monads.Right(4).fmap(&:succ).fmap(->(n) { n**2 }) # => Right(25)
-        #
-        # @param args [Array<Object>] arguments will be transparently passed through to #bind
-        # @return [Either::Right]
-        def fmap(*args, &block)
-          Right.new(bind(*args, &block))
-        end
-
-        # @return [String]
-        def to_s
-          "Right(#{value.inspect})"
-        end
-        alias inspect to_s
-
-        # @return [Maybe::Some]
-        def to_maybe
-          Kernel.warn 'Right(nil) transformed to None' if value.nil?
-          Dry::Monads::Maybe(value)
-        end
-      end
-
-      # Represents a value that is in an incorrect state, i.e. something went wrong.
-      #
-      # @api public
-      class Left < Either
-        include RightBiased::Left
-
-        alias value left
-
-        # @param left [Object] a value in an error state
-        def initialize(left)
-          @left = left
-        end
-
-        # Apply the first function to value.
-        #
-        # @api public
-        def either(f, _)
-          f.call(value)
-        end
-
-        # Returns true
-        def left?
-          true
-        end
-        alias failure? left?
-
-        # Returns false
-        def right?
-          false
-        end
-        alias success? right?
-
-        # If a block is given passes internal value to it and returns the result,
-        # otherwise simply returns the parameter val.
-        #
-        # @example
-        #   Dry::Monads.Left(ArgumentError.new('error message')).or(&:message) # => "error message"
-        #
-        # @param args [Array<Object>] arguments that will be passed to a block
-        #                             if one was given, otherwise the first
-        #                             value will be returned
-        # @return [Object]
-        def or(*args)
-          if block_given?
-            yield(value, *args)
-          else
-            args[0]
-          end
-        end
-
-        # A lifted version of `#or`. Wraps the passed value or the block result with Either::Right.
-        #
-        # @example
-        #   Dry::Monads.Left.new('no value').or_fmap('value') # => Right("value")
-        #   Dry::Monads.Left.new('no value').or_fmap { 'value' } # => Right("value")
-        #
-        # @param args [Array<Object>] arguments will be passed to the underlying `#or` call
-        # @return [Either::Right] Wrapped value
-        def or_fmap(*args, &block)
-          Right.new(self.or(*args, &block))
-        end
-
-        # @return [String]
-        def to_s
-          "Left(#{value.inspect})"
-        end
-        alias inspect to_s
-
-        # @return [Maybe::None]
-        def to_maybe
-          Maybe::None.instance
-        end
-      end
-
-      # A module that can be included for easier access to Either monads.
-      module Mixin
-        Right = Right
-        Left = Left
-
-        # @param value [Object] the value to be stored in the monad
-        # @return [Either::Right]
-        def Right(value)
-          Right.new(value)
-        end
-
-        # @param value [Object] the value to be stored in the monad
-        # @return [Either::Left]
-        def Left(value)
-          Left.new(value)
-        end
-      end
-    end
-  end
-end
+require 'dry/monads/result'