consequence 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5cdcccf4da40e5989a2efb8bb5bf8d74d3a3a24f
+  data.tar.gz: df4593261d32a4e41a7cbf741b80a59395b1b55d
+SHA512:
+  metadata.gz: 1f964a3833b3393c21f9aa8d4c7be8631885488967b44e4e2ffd832a80f0b24cbfb93e008afeb5a63c19defc9a6f4abdea7859375d558a22e4d7ec60142e3146
+  data.tar.gz: 899f36b13722699b98b811c48b1b9887744afbebe0f94ea85af59c74c535900c180742fe34cfea70ac1f60206dbf9aa83dbd19ee596207b87dd2259bda9d6c81

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Max White
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# Consequence
+
+Monad implementation to be used with [contracts.ruby](https://github.com/egonSchiele/contracts.ruby)
+
+## Example Usage
+
+``` ruby
+require 'consequence'
+
+class LicensePirate
+  include Consequence
+  alias_method :m, :method
+
+  def apply(applicant)
+    Success[applicant] >> m(:eye_patch_check)
+                       << m(:log)
+                       >> :sign_and_date
+  end
+
+  private
+
+  Contract Applicant => Monad
+  def eye_patch_check(applicant)
+    applicant.working_eyes > 1 ? Failure['Too many eyes'] : Success[Pirate.new(applicant)]
+  end
+
+  def log(pirate)
+    puts "#{pirate.name} has joined the crew"
+  end
+end
+```
+
+## Monad Methods
+
+### >>
+
+Chains a method with the result being passed down the chain.
+
+If the method has a contract that requires a Monad, then the method is passed the Monad, otherwise it is passed it's value.
+
+If the method has a contract that returns a Monad, then that Monad is passed down the chain, otherwise the result of the method is taken as the value for a new Monad.
+
+If called with a Symbol instead of a method, it is sent as a message to the value, and the result is taken as the value for a new Monad.
+
+### <<
+
+Method is applied with the result being ignored and the unchanged Monad is passed down the chain.
+
+If the method has a contract that requires a Monad, then the method is passed the Monad, otherwise it is passed it's value.
+
+If called with a Symbol instead of a method, it is sent as a message to the value.
+
+## Monad Types
+
+### Success & Failure
+
+A Success Monad wraps up all exceptions in a Failed Monad and a Failed Monad ignores all chained methods. This allows all possible failures in a long process to be dealt with at the end.
+
+### Others to be implemented shortly.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'consequence'
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/consequence/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/lib/consequence.rb

@@ -0,0 +1,11 @@
+require 'contracts'
+
+module Consequence
+  def self.included(base)
+    base.include(Contracts)
+  end
+end
+
+require 'consequence/monad'
+require 'consequence/failure'
+require 'consequence/success'

data/lib/consequence/failure.rb

@@ -0,0 +1,8 @@
+module Consequence
+  class Failure < Monad
+    def >>(_); self end
+    def <<(_); self end
+    def succeeded?; false end
+    def failed?; true end
+  end
+end

data/lib/consequence/monad.rb

@@ -0,0 +1,61 @@
+module Consequence
+  class Monad
+    include Contracts
+
+    def self.[](value)
+      new(value)
+    end
+
+    def initialize(value)
+      @value = value
+    end
+
+    attr_reader :value
+
+    # >>
+    #########
+    Contract Symbol => Monad
+    define_method(:>>) { |symbol| wrap(vbind(symbol.to_proc)) }
+
+    Contract Func[Not[Monad] => Not[Monad]] => Monad
+    define_method(:>>) { |proc| wrap(vbind(proc)) }
+
+    Contract Func[Not[Monad] => Monad] => Monad
+    define_method(:>>) { |proc| vbind(proc) }
+
+    Contract Func[Monad => Monad] => Monad
+    define_method(:>>) { |proc| bind(proc) }
+
+    Contract Func[Monad => Not[Monad]] => Monad
+    define_method(:>>) { |proc| wrap(bind(proc)) }
+
+    # <<
+    #########
+    Contract Symbol => Monad
+    define_method(:<<) { |symbol| vbind(symbol.to_proc); self }
+
+    Contract Func[Not[Monad] => Any] => Monad
+    define_method(:<<) { |proc| vbind(proc); self }
+
+    Contract Func[Monad => Any] => Monad
+    define_method(:<<) { |proc| bind(proc); self }
+
+    def ==(other)
+      self.class == other.class && value == other.value
+    end
+
+    private
+
+    def bind(proc)
+      proc.call(self)
+    end
+
+    def vbind(proc)
+      proc.call(value)
+    end
+
+    def wrap(value)
+      self.class[value]
+    end
+  end
+end

data/lib/consequence/success.rb

@@ -0,0 +1,18 @@
+module Consequence
+  class Success < Monad
+    def >>(proc)
+      super
+    rescue => err
+      Failure[err]
+    end
+
+    def <<(proc)
+      super
+    rescue => err
+      Failure[err]
+    end
+
+    def succeeded?; true end
+    def failed?; false end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: consequence
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Max White
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: contracts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: 
+email: mushishi78@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/consequence.rb
+- lib/consequence/failure.rb
+- lib/consequence/monad.rb
+- lib/consequence/success.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Monad implementation to used in with contracts.ruby
+test_files: []