deterministic 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 120b61f2caf3653ca63fc4bca59908c8c3add91b
-  data.tar.gz: 2813dd0b90f301a5afcbc7861e446c3bdc507f15
+  metadata.gz: fe29459fee3d92f463a0acaa8e70cf765c57117f
+  data.tar.gz: 487e54e8a8957da68a1e5c1e9e857db6aed572bb
 SHA512:
-  metadata.gz: d3195c0fbd1f114843e7003e84b9e24ba129933986ef948f44f19be83202719148b44554d27146acd0addd728aab98bb265356ea1d14e8338b8eaee705bdd91e
-  data.tar.gz: 721194e06a0618864efffcf079f6cc4220c58b3e0a962e7f2c43186d01e2bcc8825d34999c7c8a4abe8270bd6153901d30dd46393f7e8327a14bdb640a95f094
+  metadata.gz: 5ada388430cee5f44676ca39a125ee6ada3790934b791df1d119e7519ad58dbb45b42146e99fc5da833e56b198642ea2063c43a4ef364830d0aa6702002bfd11
+  data.tar.gz: f0bb1742c625e01e6f5143afefab1e8c0a3c6cf8a91b5f573bb35538eee6f5a61aee4b3c0dd934144f3290f7020ed8b74d4bcf3662bed5442b79b62ea4ab264e

data/HISTORY.md

@@ -1,3 +1,10 @@
+## v0.14.0
+
+- Add `Result#+`
+- Alias pipe with << for left association
+- Make the None convenience wrapper always return instance
+- Add global convenience typdef for Success, Failure
+
 ## v0.13.0
 
 - Add `Option#value_to_a`

data/README.md

@@ -59,14 +59,14 @@ Failure(1).bind { |v| Success(v - 1) } # => Success(0)
 Maps a `Success` with the value `a` to another `Result` with the value `b`. It works like `#bind` but only on `Success`.
 
 ```ruby
-Success(1).map { |n| n + 1 }           # => Success(2)
-Failure(0).map { |n| n + 1 }           # => Failure(0)
+Success(1).map { |n| Success(n + 1) }  # => Success(2)
+Failure(0).map { |n| Success(n + 1) }  # => Failure(0)
 ```
 Maps a `Failure` with the value `a` to another `Result` with the value `b`. It works like `#bind` but only on `Failure`.
 
 ```ruby
-Failure(1).map_err { |n| n + 1 }       # => Success(2)
-Success(0).map_err { |n| n + 1 }       # => Success(0)
+Failure(1).map_err { |n| Success(n + 1) } # => Success(2)
+Success(0).map_err { |n| Success(n + 1) } # => Success(0)
 ```
 
 ```ruby

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

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", "~>3.0.0.beta2"
+  spec.add_development_dependency "rspec", ">= 3"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-bundler"
   spec.add_development_dependency "guard-rspec"

data/lib/deterministic/core_ext/result.rb

@@ -1,5 +1,3 @@
-include Deterministic
-
 module Deterministic
   module CoreExt
     module Result

data/lib/deterministic/option.rb

@@ -79,7 +79,14 @@ module Deterministic
     end
 
     class None < Option
-      class << self; public :new; end
+      class << self
+        public :new
+
+        def instance
+          @instance ||= new
+        end
+      end
+
       def initialize(*args)
         @value = self
       end
@@ -107,6 +114,7 @@ module_function
     Option::Some.new(value)
   end
 
-  None = Deterministic::Option::None.new
+  Some = Deterministic::Option::Some
+  None = Deterministic::Option::None.instance
 end
 # p Deterministic::Option::Some::Match.new(.methods

data/lib/deterministic/result.rb

@@ -40,6 +40,7 @@ module Deterministic
     end
 
     alias :** :pipe
+    alias :<<  :pipe
 
     # `pipe(self: Result(a), op: |Result(a)| -> b) -> Result(a)`
     # Replaces `Success a` with `Result b`. If a `Failure` is passed as argument, it is ignored.
@@ -49,14 +50,7 @@ module Deterministic
       other
     end
 
-    # `and_then(self: Success(a), op: |a| -> Result(b)) -> Result(b)`
-    # Replaces `Success a` with the result of the block. If a `Failure` is passed as argument, it is ignored.
-    def and_then(&block)
-      return self if failure?
-      bind(&block)
-    end
-
-    # `or(self: Failure(a), other: Result(b)) -> Result(b)` 
+    # `or(self: Failure(a), other: Result(b)) -> Result(b)`
     # Replaces `Failure a` with `Result`. If a `Failure` is passed as argument, it is ignored.
     def or(other)
       return self if success?
@@ -64,13 +58,6 @@ module Deterministic
       return other
     end
 
-    # `or_else(self: Failure(a),  op: |a| -> Result(b)) -> Result(b)`
-    # Replaces `Failure a` with the result of the block. If a `Success` is passed as argument, it is ignored.
-    def or_else(&block)
-      return self if success?
-      bind(&block)
-    end
-
     # `map(self: Success(a), op: |a| -> Result(b)) -> Result(b)`
     # Maps a `Success` with the value `a` to another `Result` with the value `b`. It works like `#bind` but only on `Success`.
     def map(proc=nil, &block)
@@ -79,6 +66,7 @@ module Deterministic
     end
 
     alias :>> :map
+    alias :and_then :map
 
     # `map_err(self: Failure(a), op: |a| -> Result(b)) -> Result(b)`
     # Maps a `Failure` with the value `a` to another `Result` with the value `b`. It works like `#bind` but only on `Failure`.
@@ -87,26 +75,40 @@ module Deterministic
       bind(proc || block)
     end
 
+    alias :or_else :map_err
+
     # `pipe(self: Result(a), op: |Result(a)| -> b) -> Result(a)`
     # Executes the block passed, but completely ignores its result. If an error is raised within the block it will **NOT** be catched.
     def try(proc=nil, &block)
       map(proc, &block)
     rescue => err
-      Failure(err)
+      Result::Failure.new(err)
+    end
+
+    # `+(self: Result(a), other: Result(a)) -> Result(a -> a)`
+    # Add the inner values of two Result
+    def +(other)
+      raise Deterministic::Monad::NotMonadError, "Expected #{other.inspect} to be an Result" unless other.is_a? Result
+      match {
+        success -> (_) { other.success? } { |s| Result::Success.new(s + other.value)}
+        failure -> (_) { other.failure? } { |f| Result::Failure.new(f + other.value)}
+        success { other } # implied other.failure?
+        failure { self }   # implied other.success?
+      }
     end
 
     alias :>= :try
-    
+
     class Failure < Result
       class << self; public :new; end
     end
-    
+
     class Success < Result
       class << self; public :new; end
     end
   end
 
-module_function
+  module_function
   def Success(value)
     Result::Success.new(value)
   end
@@ -114,4 +116,7 @@ module_function
   def Failure(value)
     Result::Failure.new(value)
   end
+
+  Success = Result::Success
+  Failure = Result::Failure
 end

data/lib/deterministic/version.rb

@@ -1,3 +1,3 @@
 module Deterministic
-  VERSION = "0.13.1"
+  VERSION = "0.14.0"
 end

data/spec/examples/controller_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+module Deterministic
+  module Procify
+    def py(m, *args)
+      args.count > 0 ? method(m).to_proc.curry[*args] : method(m)
+    end
+  end
+end
+
+class BookingController
+  include Deterministic
+  include Deterministic::Procify
+
+  Context = Struct.new(:booking, :ability, :format)
+
+  def index(id, format=:html)
+    get_booking(id)           << log(:booking) >>
+    py(:ability)              << log(:ability) >>
+    py(:present, format)      << log(:presenter) >>
+    py(:render)               << log(:render)
+  end
+
+  def log(step)
+    ->(data) { p [step, data] }
+  end
+
+  def ability(ctx)
+    ctx.ability  = {} #Ability.new(@booking)
+    Success(ctx)
+  end
+
+  def present(format, ctx)
+    ctx.format = format
+
+    Success(ctx)
+  end
+
+  def render(ctx)
+    send(ctx.format, ctx)
+  end
+
+  def html(ctx)
+    Success(ctx)
+  end
+
+  def get_booking(id)
+    ctx = Context.new
+    ctx.booking = {ref_anixe: id}
+    Success(ctx)
+    # @booking = @bms.booking_by_id(id)
+  # rescue BSON::InvalidObjectId => ex
+    # @booking = nil
+    # @ui.error(404, ex.message)
+  end
+end
+
+describe BookingController do
+  it "does something" do
+    bc = BookingController.new
+    bc.index('1234', :html)
+  end
+end

data/spec/examples/logger_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+
+class Logger
+    alias :m :method
+
+    def initialize(repository)
+      @repository = repository
+    end
+
+    def log(item)
+      validate(item) >> m(:transform) >= m(:save)
+    end
+
+  private
+    attr_reader :repository
+
+    def validate(item)
+      return Failure(["Item cannot be empty"]) if item.blank?
+      return Failure(["Item must be a Hash"]) unless item.is_a?(Hash)
+ 
+      validate_required_params(item).match {
+         none { Success(item) }
+         some { |errors| Failure(errors) }
+      }
+    end
+
+    def transform(params)
+      ttl = params.delete(:ttl)
+      params.merge!(_ttl: ttl) unless ttl.nil?
+      Success(params)
+    end
+
+    def save(item)
+      Success(repository.bulk_insert([item]))
+    end
+
+    def validate_required_params(params)
+      required_params = %w(date tenant contract user facility short data)
+      Option.any?(required_params
+                  .select{|key| Option.some?(params[key.to_sym]).none? }
+                  .map{|key| "#{key} is required"}
+      )
+    end
+  end
+
+class Ensure
+  include Deterministic
+  include Deterministic::Monad
+  None = Deterministic::Option::None.instance
+
+  attr_accessor :value
+
+  def method_missing(m, *args)
+    validator_m = "#{m}!".to_sym
+    super unless respond_to? validator_m
+    send(validator_m, *args).map { |v| Some([Error.new(m, v)])}
+  end
+
+  class Error
+    attr_accessor :name, :value
+    def initialize(name, value)
+      @name, @value = name, value
+    end
+
+    def inspect
+      "#{@name}(#{@value.inspect})"
+    end
+  end
+
+  def not_empty!
+    value.nil? || value.empty?  ? Some(value) : None
+  end
+
+  def is_a!(type)
+    value.is_a?(type) ? None : Some({obj: value, actual: value.class, expected: type})
+  end
+
+  def has_key!(key)
+    value.has_key?(key) ? None : Some(key)
+  end
+end
+
+class Validator < Ensure
+  
+  def date_is_one!
+    value[:date] == 1 ? None : Some({actual: value[:date], expected: 1})
+  end
+
+  def required_params!
+    params = %w(date tenant contract user facility short data)
+    params.inject(None) { |errors, param| 
+      errors + (value[:param].nil? || value[:param].empty? ? Some([param]) : None)
+    }
+  end
+
+  def call
+    not_empty + is_a(Array) + None + has_key(:tenant) + Some("error").value_to_a + date_is_one + required_params
+  end
+
+end
+
+describe Ensure do
+  # None = Deterministic::Option::None.instance
+  
+  it "Ensure" do
+    params = {date: 2}
+
+    v = Validator.new(params)
+
+    errors = v.call
+    expect(errors).to be_a Deterministic::Some
+    expect(errors.value).not_to be_empty
+  end
+end

data/spec/lib/deterministic/class_mixin_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe 'Class Mixin' do
+
+  describe 'try' do
+    module MyApp
+      class Thing
+        include Deterministic
+
+        def run
+          Success(11) >= method(:double)
+        end
+
+        def double(num)
+          Success(num * 2)
+        end
+      end
+    end
+
+    it "cleanly mixes into a class" do
+      result = MyApp::Thing.new.run
+      expect(result).to eq Deterministic::Success.new(22)
+    end
+  end
+end

data/spec/lib/deterministic/either_spec.rb

@@ -1,8 +1,9 @@
 require 'spec_helper'
 
-include Deterministic
-
 describe Deterministic::Either do
+  include Deterministic
+  Either = Deterministic::Either
+
   it "+ does not change operands" do
     l = Left(1)
     r = Right(2)

data/spec/lib/deterministic/option_spec.rb

@@ -1,9 +1,12 @@
 require 'spec_helper'
 require_relative 'monad_axioms'
 
-include Deterministic
 
 describe Deterministic::Option do
+  include Deterministic
+  Some = Deterministic::Some
+  None = Deterministic::None
+
   # nil?
   specify { expect(described_class.some?(nil)).to eq None }
   specify { expect(described_class.some?(1)).to be_some }
@@ -23,6 +26,9 @@ describe Deterministic::Option do
 end
 
 describe Deterministic::Option do
+  include Deterministic
+  Option = Deterministic::Option
+
   #  it_behaves_like 'a Monad' do
   #   let(:monad) { described_class }
   # end
@@ -109,13 +115,17 @@ describe Deterministic::Option do
 end
 
 describe Deterministic::Option::Some do
-   it_behaves_like 'a Monad' do
+  include Deterministic
+
+  it_behaves_like 'a Monad' do
     let(:monad) { described_class }
   end
 end
 
 describe Deterministic::Option::None do
-   it_behaves_like 'a Monad' do
+  include Deterministic
+
+  it_behaves_like 'a Monad' do
     let(:monad) { described_class }
   end
 end

data/spec/lib/deterministic/result/failure_spec.rb

@@ -2,9 +2,9 @@ require 'spec_helper'
 require_relative '../monad_axioms'
 require_relative 'result_shared'
 
-include Deterministic
 
 describe Deterministic::Result::Failure do
+  include Deterministic
 
   it_behaves_like 'a Monad' do
     let(:monad) { described_class }
@@ -40,6 +40,8 @@ end
 
 
 describe "Chaining" do
+  include Deterministic
+
   it "#or" do
     expect(Success(1).or(Failure(2))).to eq Success(1)
     expect(Failure(1).or(Success(2))).to eq Success(2)

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

@@ -1,8 +1,9 @@
 require 'spec_helper'
 
-include Deterministic
 
 describe Deterministic::Result::Match do
+  include Deterministic
+
   it "can match Success" do
     expect(
       Success(1).match do

data/spec/lib/deterministic/result/result_map.rb

@@ -1,14 +1,17 @@
 require 'spec_helper'
 
-include Deterministic
 
 describe Deterministic::Result do
+  include Deterministic
+
   context ">> (map)" do
     specify { expect(Success(0).map { |n| Success(n + 1) }).to eq Success(1) }
     specify { expect(Failure(0).map { |n| Success(n + 1) }).to eq Failure(0) }
 
     it "Failure stops execution" do
       class ChainUnderTest
+        include Deterministic
+
         alias :m :method
 
         def call
@@ -72,6 +75,8 @@ describe Deterministic::Result do
 
   context "using self as the context for success" do
     class SelfContextUnderTest
+      include Deterministic
+
       def call
         @step = 0
         Success(self).

data/spec/lib/deterministic/result/success_spec.rb

@@ -2,9 +2,9 @@ require 'spec_helper'
 require_relative '../monad_axioms'
 require_relative 'result_shared'
 
-include Deterministic
 
 describe Deterministic::Result::Success do
+  include Deterministic
 
   it_behaves_like 'a Monad' do
     let(:monad) { described_class }

data/spec/lib/deterministic/result_spec.rb

@@ -2,7 +2,22 @@ require 'spec_helper'
 
 describe Deterministic::Result do
   it "can't call Result#new directly" do
-   expect { described_class.new(1)}
+    expect { described_class.new(1)}
     .to raise_error(NoMethodError, "protected method `new' called for Deterministic::Result:Class")
   end
 end
+
+describe Deterministic::Result do
+  include Deterministic
+  describe "+" do
+    specify { expect(Success(1) + Success(1)).to eq Success(2) }
+    specify { expect(Failure(1) + Failure(1)).to eq Failure(2) }
+    specify { expect { Success([1]) + Success(1)}.to raise_error TypeError}
+    specify { expect { Failure([1]) + Failure(1)}.to raise_error TypeError}
+    specify { expect(Success(1) + Failure(2)).to eq Failure(2) }
+    specify { expect(Failure(1) + Success(2)).to eq Failure(1) }
+    specify { expect(Success(1) + Failure(2) + Failure(3)).to eq Failure(5) }
+    specify { expect(Failure([2]) + Failure([3]) + Success(1)).to eq Failure([2, 3]) }
+    specify { expect(Success([1]) + Success([1])).to eq Success([1, 1]) }
+  end
+end

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: deterministic
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Piotr Zolnierek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-27 00:00:00.000000000 Z
+date: 2014-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta2
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A gem providing failsafe flow
@@ -115,8 +115,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - Guardfile
 - HISTORY.md
@@ -137,7 +137,10 @@ files:
 - lib/deterministic/version.rb
 - spec/examples/bookings_spec.rb
 - spec/examples/config_spec.rb
+- spec/examples/controller_spec.rb
+- spec/examples/logger_spec.rb
 - spec/examples/validate_address_spec.rb
+- spec/lib/deterministic/class_mixin_spec.rb
 - spec/lib/deterministic/core_ext/object/either_spec.rb
 - spec/lib/deterministic/core_ext/result_spec.rb
 - spec/lib/deterministic/either_spec.rb
@@ -163,12 +166,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -180,7 +183,10 @@ summary: see above
 test_files:
 - spec/examples/bookings_spec.rb
 - spec/examples/config_spec.rb
+- spec/examples/controller_spec.rb
+- spec/examples/logger_spec.rb
 - spec/examples/validate_address_spec.rb
+- spec/lib/deterministic/class_mixin_spec.rb
 - spec/lib/deterministic/core_ext/object/either_spec.rb
 - spec/lib/deterministic/core_ext/result_spec.rb
 - spec/lib/deterministic/either_spec.rb