either_result_matcher 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c1e5589196cbb40e8ef62a6511a303e0daed1fb
-  data.tar.gz: f5b0fccbf089e4810018e1da59290063ed47fc90
+  metadata.gz: 80a95e0850165a08bd7f7c0f492f9d11844b7b50
+  data.tar.gz: b430504c717d1c6121768c77caaef30644a8df07
 SHA512:
-  metadata.gz: fd6181b2cae7ee09a3eca63c19ae4b0e3a0ec578c7f68cdfb7ac75b88d8531a314d042b28c211bf7eefe69967774eef263141076f9a64311acc95340799ba35f
-  data.tar.gz: c811660449fba53db8ed32da6e969dee9696f2dadde5525c2f02a758a9c7cb67db12edd309ed3f7260b76663fd7e514a9097a28a405792af7819b22f20d68f17
+  metadata.gz: 37f88039789b2bccf79ad32e72c5275472d96b4a8d4bfaadffb58d3f2f57a8bd50d66a47f5cbdf8231cf1628896e825f320a76077d5b2bafce9a9a65c28aaee1
+  data.tar.gz: 2b900cc22f5191ab7559d9d4523b9ca2bd1b290d5d98f6212541a13f86473646459e9f0557578dbc4cdb0689e7d28ff3a6f0161cef36038efd8bd400c8bccdce

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    either_result_matcher (0.1.0)
+    either_result_matcher (0.2.0)
       kleisli
 
 GEM
@@ -13,7 +13,7 @@ GEM
     diff-lcs (1.2.5)
     docile (1.1.5)
     json (1.8.3)
-    kleisli (0.2.6)
+    kleisli (0.2.7)
     parser (2.2.3.0)
       ast (>= 1.1, < 3.0)
     powerpack (0.1.1)
@@ -59,4 +59,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   1.10.6
+   1.11.2

data/README.md

@@ -2,6 +2,8 @@
 
 ## Usage
 
+Operate an an `Either` object from the outside:
+
 ```ruby
 result = Right("some result")
 
@@ -15,3 +17,26 @@ MatchEitherResult(result) do |m|
   end
 end
 ```
+
+Or extend your own `Either`-returning classes to support result match blocks:
+
+```ruby
+class MyOperation
+  include EitherResultMatcher.for(:call)
+
+  def call
+    Right("some result")
+  end
+end
+
+my_op = MyOperation.new
+my_op.call() do |m|
+  m.success do |v|
+    "Success: #{v}"
+  end
+
+  m.failure do |v|
+    "Failure: #{v}"
+  end
+end
+```

data/lib/either_result_matcher.rb

@@ -3,3 +3,29 @@ require "either_result_matcher/matcher"
 def MatchEitherResult(result, &block)
   block.call(EitherResultMatcher::Matcher.new(result))
 end
+
+module EitherResultMatcher
+  def self.for(*match_methods)
+    matchers_mod = Module.new do
+      match_methods.each do |match_method|
+        define_method(match_method) do |*args, &block|
+          result = super(*args)
+
+          if block
+            MatchEitherResult(result, &block)
+          else
+            result
+          end
+        end
+      end
+    end
+
+    Module.new do
+      const_set :Matchers, matchers_mod
+
+      def self.included(klass)
+        klass.prepend const_get(:Matchers)
+      end
+    end
+  end
+end

data/lib/either_result_matcher/version.rb

@@ -1,3 +1,3 @@
 module EitherResultMatcher
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0".freeze
 end

data/spec/examples.txt

@@ -1,4 +1,8 @@
-example_id                                            | status | run_time        |
------------------------------------------------------ | ------ | --------------- |
-./spec/integration/match_either_result_spec.rb[1:1:1] | passed | 0.00089 seconds |
-./spec/integration/match_either_result_spec.rb[1:2:1] | passed | 0.00012 seconds |
+example_id                                                | status | run_time        |
+--------------------------------------------------------- | ------ | --------------- |
+./spec/integration/match_either_result_spec.rb[1:1:1:1]   | passed | 0.00011 seconds |
+./spec/integration/match_either_result_spec.rb[1:1:2:1]   | passed | 0.00011 seconds |
+./spec/integration/match_either_result_spec.rb[1:2:1:1:1] | passed | 0.00146 seconds |
+./spec/integration/match_either_result_spec.rb[1:2:1:2:1] | passed | 0.00024 seconds |
+./spec/integration/match_either_result_spec.rb[1:2:2:1:1] | passed | 0.00012 seconds |
+./spec/integration/match_either_result_spec.rb[1:2:2:2:1] | passed | 0.00012 seconds |

data/spec/integration/match_either_result_spec.rb

@@ -1,29 +1,93 @@
 RSpec.describe "MatchEitherResult" do
-  subject(:match) {
-    MatchEitherResult(result) do |m|
-      m.success do |v|
-        "Matched success: #{v}"
+  describe "external matching" do
+    subject(:match) {
+      MatchEitherResult(result) do |m|
+        m.success do |v|
+          "Matched success: #{v}"
+        end
+
+        m.failure do |v|
+          "Matched failure: #{v}"
+        end
       end
+    }
+
+    context "successful result" do
+      let(:result) { Right("a success") }
 
-      m.failure do |v|
-        "Matched failure: #{v}"
+      it "matches on success" do
+        expect(match).to eq "Matched success: a success"
       end
     end
-  }
 
-  context "successful result" do
-    let(:result) { Right("a success") }
+    context "failed result" do
+      let(:result) { Left("a failure") }
 
-    it "matches on success" do
-      expect(match).to eq "Matched success: a success"
+      it "matches on failure" do
+        expect(match).to eq "Matched failure: a failure"
+      end
     end
   end
 
-  context "failed result" do
-    let(:result) { Left("a failure") }
+  describe "class enhancement" do
+    let(:operation) {
+      Class.new do
+        include EitherResultMatcher.for(:call)
+
+        def call(bool)
+          bool ? Right("a success") : Left("a failure")
+        end
+      end.new
+    }
+
+    describe "match blocks" do
+      subject(:match) {
+        operation.call(input) do |m|
+          m.success do |v|
+            "Matched success: #{v}"
+          end
+
+          m.failure do |v|
+            "Matched failure: #{v}"
+          end
+        end
+      }
+
+      context "successful result" do
+        let(:input) { true }
+
+        it "matches on success" do
+          expect(match).to eq "Matched success: a success"
+        end
+      end
+
+      context "failed result" do
+        let(:input) { false }
 
-    it "matches on failure" do
-      expect(match).to eq "Matched failure: a failure"
+        it "matches on failure" do
+          expect(match).to eq "Matched failure: a failure"
+        end
+      end
+    end
+
+    describe "without match blocks" do
+      subject(:result) { operation.call(input) }
+
+      context "successful result" do
+        let(:input) { true }
+
+        it "returns the result" do
+          expect(result).to eq Right("a success")
+        end
+      end
+
+      context "failed result" do
+        let(:input) { false }
+
+        it "returns the result" do
+          expect(result).to eq Left("a failure")
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: either_result_matcher
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tim Riley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-03 00:00:00.000000000 Z
+date: 2016-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kleisli
@@ -121,7 +121,6 @@ files:
 - README.md
 - Rakefile
 - lib/either_result_matcher.rb
-- lib/either_result_matcher/either_extensions.rb
 - lib/either_result_matcher/matcher.rb
 - lib/either_result_matcher/version.rb
 - spec/examples.txt
@@ -147,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Expressive, all-in-one match API for Kleisli Either monads

data/lib/either_result_matcher/either_extensions.rb

@@ -1,12 +0,0 @@
-require "kleisli"
-require "either_result_matcher"
-
-module EitherResultMatcher
-  module EitherExtensions
-    def match(&block)
-      MatchEitherResult(self, &block)
-    end
-  end
-end
-
-Kleisli::Either.include EitherResultMatcher::EitherExtensions