kleisli-conversions 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDcxNmI4ZGUwMWQ2NGE0MGI5N2YyMGNhZDQ5NjhmYjUxYjcxZThiZA==
+  data.tar.gz: !binary |-
+    MjVlYzcxZGE2NTE5ZDgzMjBmYTc4NjE4YjE0NWYyNzI0MzIxNDdiOQ==
+SHA512:
+  metadata.gz: !binary |-
+    NGFkNDc4YTVlMTFlZGUxODZiNWYwMGI1NDI1NjRlNTllZWE0NjIwYmVkZWZi
+    ODNjZjg0OTZjYTc0YThkZDJjMGQxOGUxZWE1Yzk3NjMwNDA2ODQxNjc0NjY2
+    YWY3NjExYmFjZDgzMDIyMTNlNWE5MzlmODY3OWIyMmVjOGU0MDY=
+  data.tar.gz: !binary |-
+    ZjczOGYyNzcxM2Q5ODA1NWNlMjc5MmI4MjU2ZmE4ZmNlNzg3MTk0YjcwMmRh
+    YmUzZDcyODU0NjZlOTRkZjYzMzc3NjZiNWJkNjhjMGQwYmVmNzNlNGJhZmNj
+    OTkxMzk5NTcwNWRhYTFhNjBjNWExMGRmYWJjNDMyZWFkMDMzZGI=

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-conversions.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,95 @@
+# Kleisli::Conversions
+
+Adds conversion and lift methods for monads provided by the
+[Kleisli](https://github.com/txus/kleisli) and
+[Kleisli Validation](https://github.com/beezee/kleisli-validation) gems.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kleisli-conversions'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kleisli-conversions
+
+## Usage
+
+###Conversions
+
+The following conversions are provided by requiring kleisli/conversions:
+
+####Maybe#to_success(msg)
+
+Converts Some(value) to Success(value), and None to Failure(msg)
+
+####Either#to_validation
+
+Converts Right(value) to Success(value), and Left(value) to Failure(value)
+
+####Try#to_validation
+
+Converts Try::Success(value) to Success(value),
+and Try::Failure(value) to Failure(value)
+
+####Validation#fail_hash(key)
+
+Converts Failure(value) to Failure(key => value) and noop on Success.
+Useful for accumulating failures with applicative syntax
+
+####Validation#fail_array
+
+Converts Failure(value) to Failure([value]) and noop on Success
+Useful for accumulating failures with applicative syntax
+
+###Lift methods
+
+The following lift methods are added to any class by calling the following
+
+```ruby
+Kleisli::Conversions::Lift.enrich(MyClass)
+# Kleisli::Conversions::Lift.enrich(Object) to add to everything
+```
+
+####\#maybe
+
+Converts nil to None and non-nil value to Some(value)
+
+####\#some
+
+Converts any value to Some(value)
+
+####\#none
+
+Converts any value to None
+
+####\#success
+
+Converts any value to Success(value)
+
+####\#failure
+
+Converts any value to Failure(value)
+
+####\#right
+
+Converts any value to Right(value)
+
+####\#left
+
+Converts any value to Left(value)
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/kleisli-conversions/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,12 @@
+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-conversions.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kleisli/conversions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kleisli-conversions"
+  spec.version       = Kleisli::Conversions::VERSION
+  spec.authors       = ["Brian Zeligson"]
+  spec.email         = ["brian.zeligson@gmail.com"]
+  spec.summary       = %q{Lift and conversion methods for monads provided by the Kleisli gem}
+  spec.description   = %q{}
+  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"
+  spec.add_runtime_dependency "kleisli-validation"
+end

data/lib/kleisli/conversions.rb

@@ -0,0 +1,111 @@
+require "kleisli/conversions/version"
+require "kleisli/validation"
+
+module Kleisli
+
+  module Conversions
+
+    module Lift
+      def self.enrich(klass)
+        klass.send(:include, Kleisli::Conversions::Lift)
+      end
+
+      def maybe
+        Maybe(self)
+      end
+
+      def some
+        # explicit request for some should support Some(nil)
+        Kleisli::Maybe::Some.new(self)
+      end
+
+      def none
+        None()
+      end
+
+      def success
+        Success(self)
+      end
+
+      def failure
+        Failure(self)
+      end
+
+      def left
+        Left(self)
+      end
+
+      def right
+        Right(self)
+      end
+    end
+
+    module ToValidation
+
+      GetRight = -> x { x.right }
+      GetLeft = -> x { x.left }
+      GetVal = -> x { x.value }
+      GetEx = -> x { x.exception.message }
+
+      def self.enrich(o_self, sc, fc, sp , fp)
+        o_self.send(:define_method, :to_validation) do
+          case
+          when is_a?(sc)
+            Success(sp.call(self))
+          when is_a?(fc)
+            Failure(fp.call(self))
+          end
+        end
+      end
+    end
+  end
+
+  class Validation
+
+    class Success
+      def fail_array
+        self
+      end
+
+      def fail_hash(_)
+        self
+      end
+    end
+
+    class Failure
+      def fail_array
+        Failure([left])
+      end
+
+      def fail_hash(key)
+        Failure(key => left)
+      end
+    end
+  end
+
+  class Maybe
+
+    def to_success(msg)
+      case
+      when is_a?(Some)
+        Success(value)
+      when is_a?(None)
+        Failure(msg)
+      end
+    end
+  end
+
+  class Either
+    Conversions::ToValidation.
+      enrich(self, Right, Left,
+         Conversions::ToValidation::GetRight,
+         Conversions::ToValidation::GetLeft)
+  end
+
+  class Try
+    Conversions::ToValidation.
+      enrich(self, Success, Failure,
+        Conversions::ToValidation::GetVal,
+        Conversions::ToValidation::GetEx)
+  end
+end

data/lib/kleisli/conversions/version.rb

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

data/test/kleisli/conversions_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+class ConversionsTest < Minitest::Test
+  include Kleisli::Conversions
+  Kleisli::Conversions::Lift.enrich(Object)
+
+  def test_to_success
+    assert_equal(Success(1), 1.some.to_success('nope'))
+    assert_equal(Failure('nope'), 1.none.to_success('nope'))
+  end
+
+  def test_to_validation
+    assert_equal(Success(1), 1.right.to_validation)
+    assert_equal(Failure(1), 1.left.to_validation)
+    assert_equal(Success(1), Try { 1 }.to_validation)
+    assert_equal(Failure('nope'), Try { raise 'nope' }.to_validation)
+  end
+
+  def test_fail_hash
+    assert_equal(Failure(a: 1), 1.failure.fail_hash(:a))
+    assert_equal(Success(1), 1.success.fail_hash(:a))
+  end
+
+  def test_fail_array
+    assert_equal(Failure([1]), 1.failure.fail_array)
+    assert_equal(Success(1), 1.success.fail_array)
+  end
+
+  def test_lift
+    assert_equal(Some(1), 1.maybe)
+    assert_equal(None(), nil.maybe)
+    assert_equal(Some(nil), nil.some)
+    assert_equal(Some(1), 1.some)
+    assert_equal(None(), 1.none)
+    assert_equal(Success(1), 1.success)
+    assert_equal(Failure(1), 1.failure)
+    assert_equal(Right(1), 1.right)
+    assert_equal(Left(1), 1.left)
+  end
+end

data/test/test_helper.rb

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

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: kleisli-conversions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Zeligson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: kleisli-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- brian.zeligson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kleisli-conversions.gemspec
+- lib/kleisli/conversions.rb
+- lib/kleisli/conversions/version.rb
+- test/kleisli/conversions_test.rb
+- test/test_helper.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.4.4
+signing_key: 
+specification_version: 4
+summary: Lift and conversion methods for monads provided by the Kleisli gem
+test_files:
+- test/kleisli/conversions_test.rb
+- test/test_helper.rb