dry-matcher 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6d10419e259ad298f3f7406069c3abedaf6d0b3a
-  data.tar.gz: 73c64df0c8dcdbfa5729e1788af55c59c464d1ca
+SHA256:
+  metadata.gz: a452c874d6095df3fd8a932dfc0a604fa2ef531dff6ca30ee2c850f1012ce13c
+  data.tar.gz: 8a061065d80d1821fdb4e9b020050cd380ee69a73af6351bbc78bfeab5153911
 SHA512:
-  metadata.gz: 7fe5b016af423a72b690fea03bc18f310fca34d580665345096a283cf937ee26c27bac3f0de69d2a279308700b1ddc85e478e70bb8518a194ae79ae2ac692f3b
-  data.tar.gz: 669f02bcb69d4f0c57fb38bdd0534561cf1924c4e2ecdf7cc4bf40fe928e7af585f3b5ee8c7d91799475e3b37565f609b1620c1d192538da3fb96987d42c797b
+  metadata.gz: 8af536933244d441747638bcf7244f1918c4cb626717d48be1087704628f0c3b09266e6b55917fd18b776a464eaae4fc25e8382e22b661d3f408dc99c69c93bf
+  data.tar.gz: 5ca949c319b53001db633bdf6493eb2f99ab27bea4171b3429523991f9c3063ef5edceb3a5ee068ec75f9af5269f0795d7d09d1b03437d57cbdfee2e6fd8e8b3

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 0.7.0 / to-be-released
+
+## Changed
+
+- `EitherMatcher` was renamed to `ResultMatcher` according to match the rename of `Either` to `Result` in dry-monads 0.4.0. The previous name is still there for backward compatibility, we'll deprecate and drop it in furure releases (flash-gordon in [#13](https://github.com/dry-rb/dry-matcher/pull/13))
+
+[Compare v0.6.0...v0.7.0](https://github.com/dry-rb/dry-matcher/compare/v0.6.0...v0.7.0)
+
 # 0.6.0 / 2016-12-19
 
 ## Added
@@ -9,15 +17,11 @@
 - Matches must now be exhaustive - when matching against a value, at least one match block must be provided for each of a matcher's cases (timriley in [#7](https://github.com/dry-rb/dry-matcher/pull/7))
 - `Dry::Matcher::Case` objects can now be created without a `resolve:` proc. In this case, a default will be provided that passes the result value through (timriley in [#9](https://github.com/dry-rb/dry-matcher/pull/9))
 
-[Compare v0.5.1...v0.6.0](https://github.com/dry-rb/dry-result_matcher/compare/v0.5.1...v0.6.0)
-
-# 0.5.1 / 2016-07-06
-
 ## Fixed
 
 - Fixed handling of calls to non-existent cases within a matcher block (timriley)
 
-[Compare v0.5.0...v0.5.1](https://github.com/dry-rb/dry-result_matcher/compare/v0.5.0...v0.5.1)
+[Compare v0.5.0...v0.6.0](https://github.com/dry-rb/dry-matcher/compare/v0.5.0...v0.6.0)
 
 # 0.5.0 / 2016-06-30
 
@@ -80,7 +84,7 @@
     ```
 - The previous `Dry::ResultMatcher.match` behaviour (for matching `Either` monads) has been moved to `Dry::Matcher::EitherMatcher.call`
 
-[Compare v0.4.0...v0.5.0](https://github.com/dry-rb/dry-result_matcher/compare/v0.4.0...v0.5.0)
+[Compare v0.4.0...v0.5.0](https://github.com/dry-rb/dry-matcher/compare/v0.4.0...v0.5.0)
 
 # 0.4.0 / 2016-06-08
 
@@ -92,7 +96,7 @@
 
 * Expect monads from [dry-monads](https://github.com/dry-rb/dry-monads) instead of [Kleisli](https://github.com/txus/kleisli) (ttdonovan)
 
-[Compare v0.3.0...v0.4.0](https://github.com/dry-rb/dry-result_matcher/compare/v0.3.0...v0.4.0)
+[Compare v0.3.0...v0.4.0](https://github.com/dry-rb/dry-matcher/compare/v0.3.0...v0.4.0)
 
 # 0.3.0 / 2016-03-23
 
@@ -100,7 +104,7 @@
 
 * Renamed to `dry-result_matcher`. Match results using `Dry::ResultMatcher.match` or extend your own classes with `Dry::ResultMatcher.for`.
 
-[Compare v0.2.0...v0.3.0](https://github.com/dry-rb/dry-result_matcher/compare/v0.2.0...v0.3.0)
+[Compare v0.2.0...v0.3.0](https://github.com/dry-rb/dry-matcher/compare/v0.2.0...v0.3.0)
 
 # 0.2.0 / 2016-02-10
 
@@ -108,7 +112,7 @@
 
 * Added `EitherResultMatcher.for(*methods)` to return a module wrapping the specified methods (returning an `Either`) with the match block API. Example usage, in a class with a `#call` method: `include EitherResultMatcher.for(:call)`.
 
-[Compare v0.1.0...v0.22.0](https://github.com/dry-rb/dry-result_matcher/compare/v0.1.0...v0.2.0)
+[Compare v0.1.0...v0.22.0](https://github.com/dry-rb/dry-matcher/compare/v0.1.0...v0.2.0)
 
 # 0.1.0 / 2015-12-03
 

data/Gemfile

@@ -5,7 +5,7 @@ gemspec
 group :test do
   gem "simplecov"
   gem "codeclimate-test-reporter"
-  gem "dry-monads", "~> 0.0.2"
+  gem "dry-monads", '>= 0.4.0'
 end
 
 group :tools do

data/lib/dry/matcher.rb

@@ -13,10 +13,10 @@ module Dry
     #
     # @example Usage with `dry-monads`
     #   class MonadicOperation
-    #     include Dry::Matcher.for(:call, with: Dry::Matcher::EitherMatcher)
+    #     include Dry::Matcher.for(:call, with: Dry::Matcher::ResultMatcher)
     #
     #     def call
-    #       Dry::Monads::Either::Right.new('Success')
+    #       Dry::Monads::Result::Success.new('Success')
     #     end
     #   end
     #
@@ -71,11 +71,11 @@ module Dry
     #
     # @example Usage with `dry-monads`
     #   require 'dry-monads'
-    #   require 'dry/matcher/either_matcher'
+    #   require 'dry/matcher/result_matcher'
     #
-    #   value = Dry::Monads::Either::Left.new('failure!')
+    #   value = Dry::Monads::Result::Failure.new('failure!')
     #
-    #   Dry::Matcher::EitherMatcher.(value) do |m|
+    #   Dry::Matcher::ResultMatcher.(value) do |m|
     #     m.success { |v| "Yay: #{v}" }
     #     m.failure { |v| "Boo: #{v}" }
     #   end #=> "Boo: failure!"

data/lib/dry/matcher/either_matcher.rb

@@ -1,74 +1,7 @@
-require "dry/matcher"
+require "dry/matcher/result_matcher"
 
 module Dry
   class Matcher
-    # Built-in {Matcher} ready to use with `Either` or `Try` monads from
-    # [dry-monads](/gems/dry-monads) or any other compatible gems.
-    #
-    # Provides {Case}s for two matchers:
-    # * `:success` matches `Dry::Monads::Either::Right`
-    #   and `Dry::Monads::Try::Success` (or any other monad that responds to
-    #   `#to_either` returning either monad that is `#right?`)
-    # * `:failure` matches `Dry::Monads::Either::Left` and
-    #   `Dry::Monads::Try::Failure` (or any other monad that responds to
-    #   `#to_either` returning either monad that is `#left?`)
-    #
-    # @return [Dry::Matcher]
-    #
-    # @example Usage with `dry-monads`
-    #   require 'dry-monads'
-    #   require 'dry/matcher/either_matcher'
-    #
-    #   value = Dry::Monads::Either::Right.new('success!')
-    #
-    #   Dry::Matcher::EitherMatcher.(value) do |m|
-    #     m.success do |v|
-    #       "Yay: #{v}"
-    #     end
-    #
-    #     m.failure do |v|
-    #       "Boo: #{v}"
-    #     end
-    #   end #=> "Yay: success!"
-    #
-    # @example Usage with custom monad
-    #   require 'dry/matcher/either_matcher'
-    #
-    #   class CustomBooleanMonad
-    #     def initialize(value); @value = value; end
-    #     attr_reader :value
-    #     alias_method :right?, :value
-    #     def left?; !right?; end
-    #     def to_either; self; end
-    #   end
-    #
-    #   value = CustomBooleanMonad.new(nil)
-    #
-    #   Dry::Matcher::EitherMatcher.(value) do |m|
-    #     m.success { |v| "#{v.inspect} is truthy" }
-    #     m.failure { |v| "#{v.inspect} is falsey" }
-    #   end # => "nil is falsey"
-    EitherMatcher = Dry::Matcher.new(
-      success: Case.new(
-        match: -> result, *pattern {
-          result = result.to_either
-          result.right?
-        },
-        resolve: -> result {
-          result = result.to_either
-          result.value
-        },
-      ),
-      failure: Case.new(
-        match: -> result, *pattern {
-          result = result.to_either
-          result.left?
-        },
-        resolve: -> result {
-          result = result.to_either
-          result.value
-        },
-      )
-    )
+    EitherMatcher = ResultMatcher
   end
 end

data/lib/dry/matcher/result_matcher.rb

@@ -0,0 +1,74 @@
+require "dry/matcher"
+
+module Dry
+  class Matcher
+    # Built-in {Matcher} ready to use with `Result` or `Try` monads from
+    # [dry-monads](/gems/dry-monads) or any other compatible gems.
+    #
+    # Provides {Case}s for two matchers:
+    # * `:success` matches `Dry::Monads::Result::Success`
+    #   and `Dry::Monads::Try::Value` (or any other monad that responds to
+    #   `#to_result` returning result monad that is `#success?`)
+    # * `:failure` matches `Dry::Monads::Result::Failure` and
+    #   `Dry::Monads::Try::Error` (or any other monad that responds to
+    #   `#to_result` returning result monad that is `#failure?`)
+    #
+    # @return [Dry::Matcher]
+    #
+    # @example Usage with `dry-monads`
+    #   require 'dry-monads'
+    #   require 'dry/matcher/result_matcher'
+    #
+    #   value = Dry::Monads::Result::Success.new('success!')
+    #
+    #   Dry::Matcher::ResultMatcher.(value) do |m|
+    #     m.success do |v|
+    #       "Yay: #{v}"
+    #     end
+    #
+    #     m.failure do |v|
+    #       "Boo: #{v}"
+    #     end
+    #   end #=> "Yay: success!"
+    #
+    # @example Usage with custom monad
+    #   require 'dry/matcher/result_matcher'
+    #
+    #   class CustomBooleanMonad
+    #     def initialize(value); @value = value; end
+    #     attr_reader :value
+    #     alias_method :success?, :value
+    #     def failure?; !success?; end
+    #     def to_result; self; end
+    #   end
+    #
+    #   value = CustomBooleanMonad.new(nil)
+    #
+    #   Dry::Matcher::ResultMatcher.(value) do |m|
+    #     m.success { |v| "#{v.inspect} is truthy" }
+    #     m.failure { |v| "#{v.inspect} is falsey" }
+    #   end # => "nil is falsey"
+    ResultMatcher = Dry::Matcher.new(
+      success: Case.new(
+        match: -> result, *pattern {
+          result = result.to_result
+          result.success?
+        },
+        resolve: -> result {
+          result = result.to_result
+          result.value!
+        },
+      ),
+      failure: Case.new(
+        match: -> result, *pattern {
+          result = result.to_result
+          result.failure?
+        },
+        resolve: -> result {
+          result = result.to_result
+          result.failure
+        },
+      )
+    )
+  end
+end

data/lib/dry/matcher/version.rb

@@ -1,5 +1,5 @@
 module Dry
   class Matcher
-    VERSION = "0.6.0".freeze
+    VERSION = "0.7.0".freeze
   end
 end

data/spec/examples.txt

@@ -1,18 +1,18 @@
 example_id                                            | status | run_time        |
 ----------------------------------------------------- | ------ | --------------- |
-./spec/integration/class_enhancement_spec.rb[1:1:1:1] | passed | 0.00015 seconds |
-./spec/integration/class_enhancement_spec.rb[1:1:2:1] | passed | 0.00014 seconds |
-./spec/integration/class_enhancement_spec.rb[1:2:1:1] | passed | 0.00088 seconds |
-./spec/integration/class_enhancement_spec.rb[1:2:2:1] | passed | 0.00013 seconds |
-./spec/integration/either_matcher_spec.rb[1:1:1:1]    | passed | 0.00011 seconds |
-./spec/integration/either_matcher_spec.rb[1:1:2:1]    | passed | 0.0001 seconds  |
-./spec/integration/either_matcher_spec.rb[1:1:3:1:1]  | passed | 0.00016 seconds |
-./spec/integration/either_matcher_spec.rb[1:1:3:2:1]  | passed | 0.00015 seconds |
-./spec/integration/matcher_spec.rb[1:1:1]             | passed | 0.00016 seconds |
-./spec/integration/matcher_spec.rb[1:1:2]             | passed | 0.00015 seconds |
-./spec/integration/matcher_spec.rb[1:1:3]             | passed | 0.00159 seconds |
-./spec/integration/matcher_spec.rb[1:1:4:1]           | passed | 0.00018 seconds |
-./spec/integration/matcher_spec.rb[1:1:4:2]           | passed | 0.00185 seconds |
-./spec/unit/case_spec.rb[1:1:1]                       | passed | 0.00054 seconds |
-./spec/unit/case_spec.rb[1:2:1]                       | passed | 0.00048 seconds |
-./spec/unit/case_spec.rb[1:2:2]                       | passed | 0.00008 seconds |
+./spec/integration/class_enhancement_spec.rb[1:1:1:1] | passed | 0.00011 seconds |
+./spec/integration/class_enhancement_spec.rb[1:1:2:1] | passed | 0.0001 seconds  |
+./spec/integration/class_enhancement_spec.rb[1:2:1:1] | passed | 0.00014 seconds |
+./spec/integration/class_enhancement_spec.rb[1:2:2:1] | passed | 0.0001 seconds  |
+./spec/integration/matcher_spec.rb[1:1:1]             | passed | 0.00017 seconds |
+./spec/integration/matcher_spec.rb[1:1:2]             | passed | 0.0001 seconds  |
+./spec/integration/matcher_spec.rb[1:1:3]             | passed | 0.00122 seconds |
+./spec/integration/matcher_spec.rb[1:1:4:1]           | passed | 0.00009 seconds |
+./spec/integration/matcher_spec.rb[1:1:4:2]           | passed | 0.00147 seconds |
+./spec/integration/result_matcher_spec.rb[1:1:1:1]    | passed | 0.00012 seconds |
+./spec/integration/result_matcher_spec.rb[1:1:2:1]    | passed | 0.00008 seconds |
+./spec/integration/result_matcher_spec.rb[1:1:3:1:1]  | passed | 0.00015 seconds |
+./spec/integration/result_matcher_spec.rb[1:1:3:2:1]  | passed | 0.00017 seconds |
+./spec/unit/case_spec.rb[1:1:1]                       | passed | 0.00087 seconds |
+./spec/unit/case_spec.rb[1:2:1]                       | passed | 0.00008 seconds |
+./spec/unit/case_spec.rb[1:2:2]                       | passed | 0.00056 seconds |

data/spec/integration/class_enhancement_spec.rb

@@ -1,13 +1,13 @@
 require "dry-monads"
-require "dry/matcher/either_matcher"
+require "dry/matcher/result_matcher"
 
 RSpec.describe "Class enhancement with Dry::Matcher.for" do
   let(:operation) {
     Class.new do
-      include Dry::Matcher.for(:call, with: Dry::Matcher::EitherMatcher)
+      include Dry::Matcher.for(:call, with: Dry::Matcher::ResultMatcher)
 
       def call(bool)
-        bool ? Dry::Monads::Right("a success") : Dry::Monads::Left("a failure")
+        bool ? Dry::Monads::Success("a success") : Dry::Monads::Failure("a failure")
       end
     end.new
   }
@@ -49,7 +49,7 @@ RSpec.describe "Class enhancement with Dry::Matcher.for" do
       let(:input) { true }
 
       it "returns the result" do
-        expect(result).to eq Dry::Monads::Right("a success")
+        expect(result).to eq Dry::Monads::Success("a success")
       end
     end
 
@@ -57,7 +57,7 @@ RSpec.describe "Class enhancement with Dry::Matcher.for" do
       let(:input) { false }
 
       it "returns the result" do
-        expect(result).to eq Dry::Monads::Left("a failure")
+        expect(result).to eq Dry::Monads::Failure("a failure")
       end
     end
   end

data/spec/integration/matcher_spec.rb

@@ -4,15 +4,15 @@ RSpec.describe Dry::Matcher do
   context "with match cases provided" do
     let(:success_case) {
       Dry::Matcher::Case.new(
-        match: -> result { result.right? },
-        resolve: -> result { result.value },
+        match: -> result { result.success? },
+        resolve: -> result { result.value! },
       )
     }
 
     let(:failure_case) {
       Dry::Matcher::Case.new(
-        match: -> result { result.left? },
-        resolve: -> result { result.value },
+        match: -> result { result.failure? },
+        resolve: -> result { result.failure },
       )
     }
 
@@ -36,17 +36,17 @@ RSpec.describe Dry::Matcher do
     end
 
     it "matches on success" do
-      input = Dry::Monads::Right("Yes!")
+      input = Dry::Monads::Success("Yes!")
       expect(call_match(input)).to eq "Success: Yes!"
     end
 
     it "matches on failure" do
-      input = Dry::Monads::Left("No!")
+      input = Dry::Monads::Failure("No!")
       expect(call_match(input)).to eq "Failure: No!"
     end
 
     it "requires an exhaustive match" do
-      input = Dry::Monads::Right("Yes!")
+      input = Dry::Monads::Success("Yes!")
 
       expect {
         matcher.(input) do |m|

data/spec/integration/{either_matcher_spec.rb → result_matcher_spec.rb}

@@ -1,10 +1,10 @@
 require "dry-monads"
-require "dry/matcher/either_matcher"
+require "dry/matcher/result_matcher"
 
-RSpec.describe "Dry::Matcher::EitherMatcher" do
+RSpec.describe "Dry::Matcher::ResultMatcher" do
   describe "external matching" do
     subject(:match) {
-      Dry::Matcher::EitherMatcher.(result) do |m|
+      Dry::Matcher::ResultMatcher.(result) do |m|
         m.success do |v|
           "Matched success: #{v}"
         end
@@ -16,7 +16,7 @@ RSpec.describe "Dry::Matcher::EitherMatcher" do
     }
 
     context "successful result" do
-      let(:result) { Dry::Monads::Right("a success") }
+      let(:result) { Dry::Monads::Success("a success") }
 
       it "matches on success" do
         expect(match).to eq "Matched success: a success"
@@ -24,14 +24,14 @@ RSpec.describe "Dry::Matcher::EitherMatcher" do
     end
 
     context "failed result" do
-      let(:result) { Dry::Monads::Left("a failure") }
+      let(:result) { Dry::Monads::Failure("a failure") }
 
       it "matches on failure" do
         expect(match).to eq "Matched failure: a failure"
       end
     end
 
-    context "result convertible to either" do
+    context "result convertible to result" do
       context "converts to success" do
         let(:result) {
           Dry::Monads::Try.lift([StandardError], -> { 'a success' })

data/spec/unit/case_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe Dry::Matcher::Case do
 
   describe "#resolve" do
     it "calls the resolve proc with the value" do
-      kase = described_class.new(match: -> * { true }, resolve: resolve = -> value { value.to_s })
+      kase = described_class.new(match: -> * { true }, resolve: -> value { value.to_s })
 
       expect(kase.resolve(123)).to eq "123"
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-matcher
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Tim Riley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-18 00:00:00.000000000 Z
+date: 2018-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,11 +97,12 @@ files:
 - lib/dry/matcher/case.rb
 - lib/dry/matcher/either_matcher.rb
 - lib/dry/matcher/evaluator.rb
+- lib/dry/matcher/result_matcher.rb
 - lib/dry/matcher/version.rb
 - spec/examples.txt
 - spec/integration/class_enhancement_spec.rb
-- spec/integration/either_matcher_spec.rb
 - spec/integration/matcher_spec.rb
+- spec/integration/result_matcher_spec.rb
 - spec/spec_helper.rb
 - spec/unit/case_spec.rb
 homepage: http://dry-rb.org/gems/dry-matcher
@@ -116,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -124,9 +125,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Flexible, expressive pattern matching for Ruby
 test_files: []
-has_rdoc: