deterministic 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24278b8af8e996a30226c448b0677f8669e14606
-  data.tar.gz: 6a67ad79ac2e6ff81e0530b547c658f0cfb4633a
+  metadata.gz: a99a96ae91c0ed68fd47e14ba991e03c1302349c
+  data.tar.gz: c9de7570b1ef16aab2b10ee4aa97f927d7661048
 SHA512:
-  metadata.gz: 0fd77c14af51a1814426d1c33bffccda8b97a58c5266638503dca676e1cbd78ac8a159becabfb3e4fe262016b5a2d0bf1663111f76d0fcbe92e7d105fa296f52
-  data.tar.gz: 6181518d77416ec8cf02712cd738f56b842deaf212a4ac368b8babcc141c01bf718fb7b9b10f2d11d6109cf36a35db0b3306fce8629cdafca940d239d9a2c675
+  metadata.gz: c15b124c022ae997e29be36a63237cb50963268c6642d6f55c6f3a5e79f5de047b76182d3eb3d69b57b3a4e6ef207e9ace98b3579613154788fb706429cd750f
+  data.tar.gz: efe04519bfbca769720df381304134c72b4e21ebea770aabb1f0dff73dadca7bb98e0735f90ae0f569e7182fdba7ffd6d4f736ba5c238053a589e5cd55e42324

data/README.md

@@ -72,7 +72,7 @@ Success(1).match do
   success { |v| "success #{v}"}
   failure { |v| "failure #{v}"}
   either  { |v| "either #{v}"}
-end # => "either 1"
+end # => "success 1"
 ```
 Note1: the inner value has been unwrapped! 
 
@@ -84,7 +84,7 @@ Values for patterns are good, too:
 
 ```ruby
 Success(1).match do
-  success(1) { "Success #{v}" }
+  success(1) {|v| "Success #{v}" }
 end # => "Success 1"
 ```
 
@@ -92,7 +92,7 @@ You can and should also use procs for patterns:
 
 ```ruby
 Success(1).match do
-  success ->(v) { v == 1} { "Success #{v}" }
+  success ->(v) { v == 1 } {|v| "Success #{v}" }
 end # => "Success 1"
 ```
 
@@ -132,6 +132,59 @@ Success(1).match do
 end # => "catch-all"
 ```
 
+## core_ext
+You can use a core extension, to include Either in your own class or in Object, i.e. in all classes.
+
+In a class, as a mixin
+
+```ruby
+require "deterministic/core_ext/either" # this includes Deterministic in the global namespace!
+class UnderTest
+  include Deterministic::CoreExt::Either
+  def test
+    attempt_all do
+      try { foo }
+    end
+  end
+
+  def foo
+    1
+  end
+end
+
+ut = UnderTest.new
+```
+
+To add it to all classes
+
+```ruby
+require "deterministic/core_ext/object/either" # this includes Deterministic  to Object
+
+class UnderTest
+  def test
+    attempt_all do
+      try { foo }
+    end
+  end
+
+  def foo
+    1
+  end
+end
+
+ut = UnderTest.new
+```
+
+or use it on built-in classes
+
+```ruby
+require "deterministic/core_ext/object/either"
+h = {a:1}
+h.attempt_all do
+  try { |s| self[:a] + 1}
+end
+```
+
 ## Inspirations
  * My [Monadic gem](http://github.com/pzol/monadic) of course
  * `#attempt_all` was somewhat inspired by [An error monad in Clojure](http://brehaut.net/blog/2011/error_monads)

data/deterministic.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "~>3.0.0.beta1"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-bundler"
   spec.add_development_dependency "guard-rspec"

data/lib/deterministic/core_ext/either.rb

@@ -0,0 +1,23 @@
+include Deterministic
+
+module Deterministic
+  module CoreExt
+    module Either
+      def success?
+        self.is_a? Success
+      end
+
+      def failure?
+        self.is_a? Failure
+      end
+
+      def either?
+        success? || failure?
+      end
+
+      def attempt_all(context=self, &block)
+        Deterministic::Either::AttemptAll.new(context, &block).call(self)
+      end
+    end
+  end
+end

data/lib/deterministic/core_ext/object/either.rb

@@ -0,0 +1,6 @@
+require "deterministic/core_ext/either"
+
+include Deterministic
+class Object
+  include Deterministic::CoreExt::Either
+end

data/lib/deterministic/either/attempt_all.rb

@@ -14,7 +14,7 @@ class Deterministic::Either
     end
 
     def call(initial=nil)
-      result = @tries.inject(Success(initial)) do |acc, try|
+      result = @tries.inject(Deterministic::Success(initial)) do |acc, try|
         acc.success? ? acc << try.call(acc) : acc
       end
     end
@@ -24,9 +24,9 @@ class Deterministic::Either
       try_p = ->(acc) {
         begin
           value = @context.instance_exec(acc.value, &block)
-          Success(value)
+          Deterministic::Success(value)
         rescue => ex
-          Failure(ex)
+          Deterministic::Failure(ex)
         end
       }
 
@@ -35,7 +35,7 @@ class Deterministic::Either
 
     # Basicly a monad
     def let(sym=nil, &block)
-      @tries << ->(acc) { 
+      @tries << ->(acc) {
         @context.instance_exec(acc.value, &block).tap do |value|
           raise EitherExpectedError, "Expected the result to be either Success or Failure" unless value.is_a? Either
         end

data/lib/deterministic/either/match.rb

@@ -1,6 +1,7 @@
 module Deterministic::PatternMatching
 
-  def match(context=self, &block)
+  def match(context=nil, &block)
+    context ||= block.binding.eval('self')
     match = Match.new(self, context)
     match.instance_eval &block
     match.result
@@ -35,7 +36,7 @@ module Deterministic::PatternMatching
     end
 
   private
-    Matcher = Struct.new(:condition, :block) do 
+    Matcher = Struct.new(:condition, :block) do
       def matches?(value)
         condition.call(value)
       end
@@ -46,7 +47,7 @@ module Deterministic::PatternMatching
       when condition.nil?;          ->(v) { true }
       when condition.is_a?(Proc);   condition
       when condition.is_a?(Class);  ->(v) { condition === @container.value }
-      else                          ->(v) { condition == @container.value }
+      else                          ->(v) { @container.value == condition }
       end
 
       matcher_pred = compose_predicates(type_pred[type], condition_pred)

data/lib/deterministic/version.rb

@@ -1,3 +1,3 @@
 module Deterministic
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/spec/lib/deterministic/attempt_all_spec.rb

@@ -29,7 +29,7 @@ describe Deterministic::Either::AttemptAll do
     expect(attempt).to be_a RuntimeError
     expect(attempt.message).to eq "error"
   end
-  
+
   it "don't continue on failure" do
     fake = double()
     expect(

data/spec/lib/deterministic/core_ext/either_spec.rb

@@ -0,0 +1,50 @@
+require "spec_helper"
+require "deterministic"
+require "deterministic/core_ext/either"
+
+describe Deterministic::CoreExt::Either do
+  it "does something" do
+    h = {}
+    h.extend(Deterministic::CoreExt::Either)
+    expect(h.success?).to be_falsey
+    expect(h.failure?).to be_falsey
+    expect(h.either?).to be_falsey
+  end
+
+  it "enables #success?, #failure?, #either? on all Objects" do
+    ary = [Deterministic::Success(true), Deterministic::Success(1)]
+    expect(ary.all?(&:success?)).to be_truthy
+
+    ary = [Deterministic::Success(true), Deterministic::Failure(1)]
+    expect(ary.all?(&:success?)).to be_falsey
+    expect(ary.any?(&:failure?)).to be_truthy
+  end
+
+  it "allows using attempt_all on all Objects" do
+    h = {a: 1}
+    h.extend(Deterministic::CoreExt::Either)
+    res = h.attempt_all do
+      try { |s| self[:a] + 1}
+    end
+
+    expect(res).to eq Deterministic::Success(2)
+  end
+
+  it "use attempt_all in an instance" do
+    class UnderTest
+      include Deterministic::CoreExt::Either
+      def test
+        attempt_all do
+          try { foo }
+        end
+      end
+
+      def foo
+        1
+      end
+    end
+
+    ut = UnderTest.new
+    expect(ut.test).to eq Success(1)
+  end
+end

data/spec/lib/deterministic/core_ext/object/either_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+require "deterministic/core_ext/object/either"
+
+describe Deterministic::CoreExt::Either, "object", isolate: true do
+  it "does something" do
+    h = {a: 1}
+    expect(h.success?).to be_falsey
+    expect(h.failure?).to be_falsey
+    expect(h.either?).to be_falsey
+  end
+
+  it "use attempt_all in an instance" do
+    class UnderTest
+      def test
+        attempt_all do
+          try { foo }
+        end
+      end
+
+      def foo
+        1
+      end
+    end
+
+    ut = UnderTest.new
+    expect(ut.test).to eq Success(1)
+  end
+end

data/spec/lib/deterministic/either/match_spec.rb

@@ -9,7 +9,7 @@ describe Deterministic::Either::Match do
         success { |v| "Success #{v}" }
         failure { |v| "Failure #{v}" }
       end
-    ).to eq "Success 1" 
+    ).to eq "Success 1"
   end
 
   it "can match Failure" do
@@ -18,7 +18,7 @@ describe Deterministic::Either::Match do
         success { |v| "Success #{v}" }
         failure { |v| "Failure #{v}" }
       end
-    ).to eq "Failure 1" 
+    ).to eq "Failure 1"
   end
 
   it "can match with values" do
@@ -81,4 +81,35 @@ describe Deterministic::Either::Match do
       end
     }.to raise_error Deterministic::PatternMatching::NoMatchError
   end
+
+  it "can use methods from the caller's binding scope by default" do
+    def my_method
+      "it works"
+    end
+    expect(
+      Success(1).match do
+        success { my_method }
+      end
+    ).to eq "it works"
+  end
+
+  it "allows for Either values to play with pattern matching comparisons" do
+    class MyErrorHash < Hash
+      def ==(error_type_symbol)
+        self[:type] == error_type_symbol
+      end
+    end
+
+    error_hash = MyErrorHash.new.merge(:type => :needs_more_salt, :arbitrary => 'data')
+
+    expect(
+      Failure(error_hash).match do
+        failure(:nothing) {|v| raise "We should not get to this point" }
+        failure(:needs_more_salt) do |error|
+          "Successfully failed with #{error[:arbitrary]}!"
+        end
+        failure { raise "We should also not get to this point" }
+      end
+    ).to eq "Successfully failed with data!"
+  end
 end

data/spec/lib/deterministic/monad_axioms.rb

@@ -3,7 +3,7 @@ shared_examples 'a Monad' do
     it '1st monadic law: left-identity' do
       f = ->(value) { monad.new(value + 1) }
       expect(
-        monad::new(1).bind do |value|
+        monad.new(1).bind do |value|
           f.(value)
         end
       ).to eq f.(1)

data/spec/lib/deterministic/monad_spec.rb

@@ -26,7 +26,6 @@ describe Deterministic::Monad do
     it "passes the monad class, this is ruby-fu?!" do
      Identity.new(1)
       .bind do |_, monad|
-        p self.class
         expect(monad).to eq Identity
         monad.new(_)
       end

data/spec/spec_helper.rb

@@ -20,5 +20,7 @@ RSpec.configure do |config|
     c.syntax = :expect
   end
   config.order = 'random'
+
+  config.filter_run_excluding isolate: true
 end
 require 'deterministic'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deterministic
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Zolnierek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-06 00:00:00.000000000 Z
+date: 2014-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,16 +42,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0.beta1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0.beta1
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -125,6 +125,8 @@ files:
 - deterministic.gemspec
 - either.rb
 - lib/deterministic.rb
+- lib/deterministic/core_ext/either.rb
+- lib/deterministic/core_ext/object/either.rb
 - lib/deterministic/either.rb
 - lib/deterministic/either/attempt_all.rb
 - lib/deterministic/either/failure.rb
@@ -135,6 +137,8 @@ files:
 - spec/examples/bookings_spec.rb
 - spec/examples/validate_address_spec.rb
 - spec/lib/deterministic/attempt_all_spec.rb
+- spec/lib/deterministic/core_ext/either_spec.rb
+- spec/lib/deterministic/core_ext/object/either_spec.rb
 - spec/lib/deterministic/either/match_spec.rb
 - spec/lib/deterministic/either/success_spec.rb
 - spec/lib/deterministic/either_spec.rb
@@ -161,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: see above
@@ -169,6 +173,8 @@ test_files:
 - spec/examples/bookings_spec.rb
 - spec/examples/validate_address_spec.rb
 - spec/lib/deterministic/attempt_all_spec.rb
+- spec/lib/deterministic/core_ext/either_spec.rb
+- spec/lib/deterministic/core_ext/object/either_spec.rb
 - spec/lib/deterministic/either/match_spec.rb
 - spec/lib/deterministic/either/success_spec.rb
 - spec/lib/deterministic/either_spec.rb