kleisli-run 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDE2YjNmMDJlMGFjYjc5YjAyMmJkNjQ0MWE0NWJmYTZkZmY2OGRjYw==
+  data.tar.gz: !binary |-
+    ODgxY2NkYjUwYTdhMWJkYmE5OTA4OGM3YzI5ZTRkZDQ2NDcwNDExYg==
+SHA512:
+  metadata.gz: !binary |-
+    Y2Q4NDNmMjgxZjM1OWU3MGE3NWJiZDUxNGFhNmNhZWEwNWE2ODVjZWIxOTdh
+    ZWJhYTNhM2JkYjk4MTFhMTA4NDMyZTBlMzkwNDBiN2JlMjM5ODFkZDgyMzVl
+    NTNmNDQ2OGRkOGE1YTFjOGIyZDFiZmM3MmI0ZjkwNDQ4N2QyODg=
+  data.tar.gz: !binary |-
+    NTAxMWFjY2FmODI5M2ZhMmE3NTBkOGM3MTNhNGIxNGUwODE4NThiOGY3NWYz
+    NjhmZjgxZGE1NDFkNDE4Yzc0NmMwMDI2NTJlYjM1Mjc0Y2U4NGEyZTdiODg4
+    MGUzMGY5MTdjNTc1ODE2NzcyYWIzOGQxNzEzNjM1MjA3MDYzNjc=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kleisli-run.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,62 @@
+# Kleisli.run
+
+Provides a ruby version of do-notation syntax for the monads provided in the
+[Kleisli](https://github.com/txus/kleisli) gem.
+
+More concise than nested fmap/binds, more readable (to me) than point-free syntax
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kleisli-run'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kleisli-run
+
+## Usage
+
+With this gem installed, you can map over a bunch of dependent monads to
+work with their inner values using a concise procedural syntax. Plenty more
+examples in the tests, but here's a few basic illustrations:
+
+```ruby
+Kleisli.run do
+  a from: Success(1)
+  b from: Success(2)
+  a + b
+end
+# Success(3)
+
+Kleisli.run do
+  a from: Failure(["not gonna happen here"])
+  b from: Success(2)
+  c from: Success(5)
+  a + b + c
+end
+# Failure(["not gonna happen here"])
+# note - nothing after the first line of the block is executed
+```
+A few notes about the behavior within a block
+
+  * Extract values from monads using the variable from: Monad(value) syntax
+    * You can use method calls for the from: value, as long as they return a monad
+  * Inline assignment is possible eg: a = somevalue, and somevalue does not have
+      to be a monad, however you must call from: on at least one monad inside a
+      block
+  * Methods and values from the scope in which the block is created are given
+    precedence, so you cannot name values inside the block after any names
+    that exist in the scope where you define the block
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/kleisli-run/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 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-run.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/run/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kleisli-run"
+  spec.version       = Kleisli::Run::VERSION
+  spec.authors       = ["Brian Zeligson"]
+  spec.email         = ["brian.zeligson@gmail.com"]
+  spec.summary       = %q{do notation 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.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_runtime_dependency "kleisli-validation"
+end

data/lib/kleisli/run.rb

@@ -0,0 +1,57 @@
+require "kleisli/run/version"
+require 'ostruct'
+
+module Kleisli
+
+  def self.run(&block)
+    r = Runner.new(block.binding)
+    begin
+      res = r.instance_eval(&block)
+      r.start.fmap { res }
+    rescue MonadTerminator => ex
+      ex.m
+    end
+  end
+
+  class Runner
+    attr_reader :start
+
+    def initialize(block_binding)
+      @struct = OpenStruct.new
+      @stopped = false
+      @start = false
+      @o_self = block_binding.eval('self')
+    end
+
+    def extract(val, m)
+      called = false
+      @start = m unless @start
+      m >-> i { called = true; @struct.send("#{val}=".to_sym, i) }
+      raise MonadTerminator.new(m) unless called
+      @struct.send(val)
+    end
+
+    def method_missing(m, *args)
+      if @o_self.respond_to?(m)
+        return @o_self.send(m, *args)
+      end
+      if args.first.kind_of?(Hash) && args.first[:from] && args.size == 1
+        return extract(m, args.first[:from])
+      end
+      if args.empty?
+        @struct.send(m)
+      else
+        @struct.send("#{m}=".to_sym, args.first)
+      end
+    end
+  end
+
+  class MonadTerminator < Exception
+    attr_accessor :m
+
+    def initialize(msg)
+      super(msg)
+      self.m = msg
+    end
+  end
+end

data/lib/kleisli/run/version.rb

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

data/test/kleisli/run_test.rb

@@ -0,0 +1,100 @@
+require 'test_helper'
+
+class RunTest < Minitest::Test
+
+  def sums(a, b)
+    a + b
+  end
+
+  def test_completion
+    s = Kleisli.run do
+      a from: Success(3)
+      b from: Success(4)
+      sums(a, b)
+    end
+    assert(Success(7), s)
+  end
+
+  def test_completion_mixed_types
+    s = Kleisli.run do
+      a from: Success(3)
+      b from: Some(4)
+      sums(a, b)
+    end
+    assert(Success(7), s)
+
+    s = Kleisli.run do
+      a from: Some(3)
+      b from: Success(4)
+      sums(a, b)
+    end
+    assert(Some(7), s)
+
+    s = Kleisli.run do
+      a from: Right(3)
+      b from: Success(4)
+      c from: Some(5)
+      sums(c, sums(a, b))
+    end
+    assert(Right(12), s)
+  end
+
+  def test_short_circuit
+    s = Kleisli.run do
+      a from: Some(3)
+      b from: None()
+      c from: Some(5)
+      sums(c, sums(a, b))
+    end
+    assert(None(), s)
+
+    s = Kleisli.run do
+      a from: Success(3)
+      b from: Failure(['nopenope'])
+      g from: Failure(['heyo'])
+      c from: Success(5)
+      sums(c, sums(a, b))
+    end
+    assert(Failure(['nopenope']), s)
+  end
+
+  def test_short_circuit_mixed_types
+    s = Kleisli.run do
+      a from: Some(3)
+      b from: Failure(['nopenope'])
+      g from: None()
+      c from: Success(5)
+      sums(c, sums(a, b))
+    end
+    assert(Failure(['nopenope']), s)
+  end
+
+  def test_inline_assignment
+    s = Kleisli.run do
+      a from: Some(3)
+      b = 4
+      c from: Success(5)
+      sums(c, sums(a, b))
+    end
+    assert(Some(12), s)
+
+    s = Kleisli.run do
+      a = Success(1)
+      b = Failure(b: "no num")
+      c = Failure(c: "still no num")
+      d from: Success(-> x, y, z { x + y + z }) * a * b * c
+      e = sums(d, 3)
+    end
+    assert(Failure(b: "no num", c: "still no num"), s)
+
+    s = Kleisli.run do
+      a = Success(1)
+      b = Success(2)
+      c = Success(3)
+      d from: Success(-> x, y, z { x + y + z }) * a * b * c
+      e = sums(d, 4)
+    end
+    assert(Success(10), s)
+  end
+
+end

data/test/test_helper.rb

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

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: kleisli-run
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Zeligson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: 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-run.gemspec
+- lib/kleisli/run.rb
+- lib/kleisli/run/version.rb
+- test/kleisli/run_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: do notation for monads provided by the Kleisli gem
+test_files:
+- test/kleisli/run_test.rb
+- test/test_helper.rb