kleisli-contracts 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YWZiNmM4YmRiNjY0MzcyODMxOGU3NjQ4NTU1ZWU5MDZlZTE5ZWMxOA==
+  data.tar.gz: !binary |-
+    NjZkNjNhYzBmYzE3NzFlMDM4Yjc0YjY0YTk1YWRjMWZkZWU2NDYxMg==
+SHA512:
+  metadata.gz: !binary |-
+    YzBlMGNmMjQxNzIyNzc4MjgyM2QwZGFlMGQyODdiNTY2NGRkZWE1ZjYxM2Mz
+    YTc3OTFlYzQzYjRmZTc2YTI3NTg1ZjhhZWU5ZjlhZjczNGY2NGIyMDBlOTM3
+    ZDE4OTMxZGMzMmU1MTZmYzg0OWQxYWJjZDBhMjRlZmM0MGJhNmU=
+  data.tar.gz: !binary |-
+    OTg2ZWY3MjBmMzA3YzA4YjMyNDQ3YmJjYzhmMDdhZTg0ZjAyM2I4MjJjOTM3
+    OWZiNjBmZTMzYTc5ZTk4ZWMwYmZkOWVmMGMwNTY0MTg0ODUxZjgxNzlhNDg5
+    OWQzMTM2MzRiNDlhYTg5YzEzYWE4NTAwZTQyNDQwZTIwZGFiYzg=

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-contracts.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,44 @@
+# Kleisli::Contracts
+
+Provides the following [Contracts](https://github.com/egonSchiele/contracts.ruby)
+for monads provided by the [Kleisli](https://github.com/txus/kleisli) gem:
+
+```ruby
+MaybeOf[SomeType]
+EitherOf[LeftType, RightType]
+ValidationOf[FailureType, SuccessType]
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kleisli-contracts'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kleisli-contracts
+
+## Usage
+
+Use of Contracts is well documented [here](http://egonschiele.github.io/contracts.ruby/)
+
+Use of Maybe and Either are well documented [here](http://blog.txus.io/kleisli/)
+
+Use of Validation is well documented [here](https://github.com/beezee/kleisli-validation)
+
+Example use can be seen in the [tests](https://github.com/beezee/kleisli-contracts/blob/master/test/kleisli/contracts_test.rb)
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/kleisli-contracts/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-contracts.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kleisli/contracts/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kleisli-contracts"
+  spec.version       = Kleisli::Contracts::VERSION
+  spec.authors       = ["Brian Zeligson"]
+  spec.email         = ["brian.zeligson@gmail.com"]
+  spec.summary       = %q{contracts.ruby Contracts for the monads defined in 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"
+  spec.add_runtime_dependency "contracts"
+end

data/lib/kleisli/contracts/version.rb

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

data/lib/kleisli/contracts.rb

@@ -0,0 +1,51 @@
+require "kleisli/contracts/version"
+require "kleisli/validation"
+require "contracts"
+
+module Kleisli
+  module Contracts
+    include ::Contracts
+
+    def self.included(base)
+      base.send(:include, ::Contracts)
+    end
+
+    class KContract < CallableClass
+      def initialize(*inner_types)
+        @inner_types = inner_types
+      end
+    end
+
+    class MaybeOf < KContract
+      def valid?(val)
+        return false unless val.kind_of?(Kleisli::Maybe) &&
+          @inner_types.size == 1
+        inner_valid, _ = Contract.valid?(val.value, @inner_types.first)
+        inner_valid || val.value.nil?
+      end
+    end
+
+    class EitherOf < KContract
+      def monad_valid(val)
+        [Kleisli::Either::Left, Kleisli::Either::Right].
+          include?(val.class)
+      end
+      def valid?(val)
+        return false unless monad_valid(val) &&
+          @inner_types.size == 2
+        left_valid, _ = Contract.valid?(val.left, @inner_types.first)
+        right_valid, _ = Contract.valid?(val.right, @inner_types.last)
+        (val.left.nil? && right_valid) ||
+        (val.right.nil? && left_valid)
+      end
+    end
+
+    class ValidationOf < EitherOf
+      def monad_valid(val)
+        [Kleisli::Validation::Failure, Kleisli::Validation::Success].
+          include?(val.class)
+      end
+    end
+  end
+
+end

data/test/kleisli/contracts_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+class ContractsTest < Minitest::Test
+  include Kleisli::Contracts
+
+  Contract MaybeOf[MaybeOf[Num]] => MaybeOf[Num]
+  def maybe_add(m_int)
+    m_int >-> x { x.fmap { |y| y + 1 } }
+  end
+
+  def test_maybe
+    assert_equal(Some(4), maybe_add(Some(Some(3))))
+    assert_raises(ContractError) { maybe_add(Some(Some("b"))) }
+  end
+
+  Contract EitherOf[String, String] => EitherOf[String, Num]
+  def either_to_i(either_string)
+    either_string >-> x { x.to_i > 0 ? Right(x.to_i) : Left("sorry") }
+  end
+
+  def test_either
+    assert_equal(Right(3), either_to_i(Right("3")))
+    assert_equal(Left("nope"), either_to_i(Left("nope")))
+    assert_equal(Left("sorry"), either_to_i(Right("fif")))
+    assert_raises(ContractError) { either_to_i(Right(3)) }
+    assert_raises(ContractError) { either_to_i(Left(5)) }
+  end
+
+  VNum = ValidationOf[ArrayOf[String], Num]
+  Contract VNum, VNum => VNum
+  def validated_sum(n1, n2)
+    Success(-> x, y { x + y }) * n1 * n2
+  end
+
+  def test_validation
+    assert_equal(Success(3), validated_sum(Success(1), Success(2)))
+    assert_equal(Failure(["nope"]), validated_sum(Success(2), Failure(["nope"])))
+    assert_equal(Failure(["sorry", "nope"]), validated_sum(Failure(["sorry"]), Failure(["nope"])))
+    assert_raises(ContractError) { validated_sum(Success(3), Failure("missing array")) }
+    assert_raises(ContractError) { validated_sum(Success("3"), Success(4)) }
+  end
+end

data/test/test_helper.rb

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

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: kleisli-contracts
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Zeligson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-07 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'
+- !ruby/object:Gem::Dependency
+  name: contracts
+  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-contracts.gemspec
+- lib/kleisli/contracts.rb
+- lib/kleisli/contracts/version.rb
+- test/kleisli/contracts_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: contracts.ruby Contracts for the monads defined in the Kleisli gem
+test_files:
+- test/kleisli/contracts_test.rb
+- test/test_helper.rb