kleisli-validation 0.0.1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kleisli-validation.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Brian Zeligson
+
+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,76 @@
+# Kleisli::Validation
+
+A Validation monad built on top of the nice [Kleisli](https://github.com/txus/kleisli)
+gem.
+
+Validation is like an Either, but it allows you to accumulate Failures of the
+same Semigroup using the applicative functor's apply operator.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kleisli-validation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kleisli-validation
+
+## Usage
+
+Usage is practically identical to the [Either](https://github.com/txus/kleisli#either)
+Monad provided by kleisli, substituting Success for Right (and .success for .right)
+as well as Failure for Left (and .failure for .left).
+
+The main difference is in the handling of errors when using the applicative
+functor's apply, as seen here.
+
+```ruby
+require "kleisli-validation"
+
+add = -> x, y { x + y }
+Success(add) * Success(10) * Success(2)
+# => Success(12)
+Success(add) * Failure("error") * Success(2)
+# => Failure("error")
+
+# new case supported by Validation
+add3 = -> x, y, z { x + y + z }
+Success(add3) * Failure(["error"]) * Success(2) * Failure(["another error"])
+# => Failure(["error", "another error"])
+
+Success(add3) * Failure(x: "No good") * Success(2) * Failure(x: "Still no good", y: "Also no good")
+# => Failure(x: ["No good", "Still no good"], y: "Also no good")
+```
+
+
+###Semigroups
+
+The values inside your Failures must all belong to the same Semigroup in
+order to accumulate errors using the apply operator.
+
+A Semigroup is any class that implements the sappend method as follows:
+
+```haskell
+sappend :: a -> a -> a
+```
+
+This gem provides a Semigroup monkeypatch for Array and Hash, see
+semigroup\_instances.rb for examples and implementation.
+
+Using Failure values with no sappend implementation or Failure values of
+differing types in one application will yield an ArgumentError.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/kleisli-validation/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/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test
+

data/kleisli-validation.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kleisli/validation'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kleisli-validation"
+  spec.version       = Kleisli::Validation::VERSION
+  spec.authors       = ["Brian Zeligson"]
+  spec.email         = ["brian.zeligson@gmail.com"]
+  spec.summary       = %q{Validation Monad for Kleisli gem}
+  spec.description   = %q{Validation is an Either which can accumulate
+                          failures when used with the apply operator (*)
+                          and a Semigroup on the Left.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.5"
+  spec.add_dependency "kleisli", "~> 0.2.6"
+end

data/lib/kleisli/semigroup_instances.rb

@@ -0,0 +1,21 @@
+require "kleisli"
+
+# monkey patch some default semigroup instances
+
+class Array
+
+  def sappend(other)
+    concat(other)
+  end
+end
+
+class Hash
+
+  def sappend(other)
+    merge(other) do |k, va, vb|
+      va = [va] unless va.kind_of?(Array)
+      vb = [vb] unless vb.kind_of?(Array)
+      va.concat(vb)
+    end
+  end
+end

data/lib/kleisli/validation/version.rb

@@ -0,0 +1,5 @@
+module Kleisli
+  class Validation
+    VERSION = "0.0.1"
+  end
+end

data/lib/kleisli/validation.rb

@@ -0,0 +1,112 @@
+#require "kleisli/validation/version"
+require "kleisli"
+require "kleisli/semigroup_instances.rb"
+
+module Kleisli
+  class Validation < Either
+    VERSION = "0.0.1"
+    attr_accessor :success, :failure
+
+    def *(other)
+      self >-> f {
+        other >-> val {
+          Success(f.arity > 1 ? f.curry.call(val) : f.call(val))
+        }
+      }
+    end
+
+    class Success < Validation
+      alias value success
+
+      def *(other)
+        if other.class == Success
+          super
+        else
+          other
+        end
+      end
+
+      def initialize(success)
+        @success = success
+      end
+
+      def >(f)
+        f.call(@success)
+      end
+
+      def fmap(&f)
+        Success.new(f.call(@success))
+      end
+
+      def to_maybe
+        Maybe::Some.new(@success)
+      end
+
+      def or(other=nil, &other_blk)
+        self
+      end
+
+      def to_s
+        "Success(#{@success.inspect})"
+      end
+      alias inspect to_s
+    end
+
+    class Failure < Validation
+      alias value failure
+
+      def *(other)
+        if other.class == Failure
+          unless self.failure.class == other.failure.class &&
+                  self.failure.respond_to?(:sappend)
+            raise ArgumentError,
+                    "Failures must contain members of a common Semigroup"
+          end
+          Failure(self.failure.sappend(other.failure))
+        else
+          self
+        end
+      end
+
+      def initialize(failure)
+        @failure = failure
+      end
+
+      def >(f)
+        self
+      end
+
+      def fmap(&f)
+        self
+      end
+
+      def to_maybe
+        Maybe::None.new
+      end
+
+      def or(other=self, &other_blk)
+        if other_blk
+          other_blk.call(@failure)
+        else
+          other
+        end
+      end
+
+      def to_s
+        "Failure(#{@failure.inspect})"
+      end
+      alias inspect to_s
+    end
+  end
+end
+
+Success = Kleisli::Validation::Success.method(:new)
+Failure = Kleisli::Validation::Failure.method(:new)
+
+def Success(v)
+  Kleisli::Validation::Success.new(v)
+end
+
+def Failure(v)
+  Kleisli::Validation::Failure.new(v)
+end

data/test/kleisli/validation_test.rb

@@ -0,0 +1,73 @@
+require 'test_helper'
+
+class ValidationTest < Minitest::Test
+  def test_lift_right
+    assert_equal 3, Success(3).value
+  end
+
+  def test_lift_left
+    assert_equal "error", Failure("error").value
+  end
+
+  def test_bind_right
+    v = Success(1) >-> x {
+      if x == 1
+        Success(x + 90)
+      else
+        Failure("FAIL")
+      end
+    }
+    assert_equal Success(91), v
+  end
+
+  def test_bind_left
+    v = Failure("error") >-> x {
+      Success(x * 20)
+    }
+    assert_equal Failure("error"), v
+  end
+
+  def test_fmap_right
+    assert_equal Success(2), Success(1).fmap { |x| x * 2 }
+  end
+
+  def test_fmap_left
+    assert_equal Failure("error"), Failure("error").fmap { |x| x * 2 }
+  end
+
+  def test_to_maybe_right
+    assert_equal Some(2), Success(1).fmap { |x| x * 2 }.to_maybe
+  end
+
+  def test_to_maybe_left
+    assert_equal None(), Failure("error").fmap { |x| x * 2 }.to_maybe
+  end
+
+  def test_pointfree
+    assert_equal Success(10), Success(5) >> F . fn(&Success) . *(2)
+  end
+
+  def test_applicative_functor_right_arity_1
+    assert_equal Success(20), Success(-> x { x * 2 }) * Success(10)
+  end
+
+  def test_applicative_functor_right_arity_2
+    assert_equal Success(20), Success(-> x, y { x * y }) * Success(10) * Success(2)
+  end
+
+  def test_applicative_functor_left
+    assert_equal Failure("error"), Success(-> x, y { x * y }) * Failure("error") * Success(2)
+  end
+
+  def test_accumulates_failures
+    assert_raises(ArgumentError) { Some(-> x, y { x+y }) * Failure(1) * Failure([2]) }
+
+    assert_equal Failure(["error", "another error"]),
+      (Success(-> x, y, z { x * y * z }) * Failure(["error"]) *
+                              Success(2) * Failure(["another error"]))
+
+    assert_equal Failure(a: 1, b: [2, 3]),
+      (Success(-> x, y, z { x * y * z }) * Failure(a: 1, b: 2) *
+                              Success(2) * Failure(b: 3))
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'kleisli'
+require 'kleisli/validation'
+require 'minitest'
+require 'minitest/autorun'

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: kleisli-validation
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brian Zeligson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.5'
+- !ruby/object:Gem::Dependency
+  name: kleisli
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.6
+description: ! "Validation is an Either which can accumulate\n                          failures
+  when used with the apply operator (*)\n                          and a Semigroup
+  on the Left."
+email:
+- brian.zeligson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kleisli-validation.gemspec
+- lib/kleisli/semigroup_instances.rb
+- lib/kleisli/validation.rb
+- lib/kleisli/validation/version.rb
+- test/kleisli/validation_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Validation Monad for Kleisli gem
+test_files:
+- test/kleisli/validation_test.rb
+- test/test_helper.rb
+has_rdoc: