limonad 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 842e58b8be3b186e2bf15d8a4fd30da41c8503af
+  data.tar.gz: f063e0540939917baad9d597d7f193d3027f06b2
+SHA512:
+  metadata.gz: 611c5863fd154fbfb57894eeca10c00b6cac246ceddf4be869b4e9eeecfa789e5718da627328facbdb69003ed94884cb845faa68d348a6265858aabc4581dc04
+  data.tar.gz: 4772c55b1dadc98d6ba4e959db74a839552b70abab357168e6a173be134aecb6a3264a1a18d07f6625e434ba1cef1d50835728cfea7651146a99cce5d52bc1fb

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Chaker Nakhli - chaker.nakhli@sinbadsoft.com
+
+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,85 @@
+# LiMonad
+
+LiMonad is a tiny library for building monads.
+
+Here are some examples of how to build common monads with LiMonad:
+
+## Maybe Monad
+
+Example:
+
+```ruby
+MaybeMonad >>
+    -> x { 5 / x unless x == 0 } >>
+    -> x { x + 1 } >>
+    -> x { 3 * x } >>
+    -> x { Math.log(x) unless x < 0 } >>
+    -> x { x.round }
+```
+
+Monad Definition:
+
+```ruby
+class MaybeMonad < LiMonad
+  def bind(f, g, *args)
+    result = f[*args]
+    g[result] if result
+  end
+end
+```
+
+## Logger Monad
+
+Example:
+```ruby
+LoggerMonad >>
+    -> x { [x * x, "#{x} was squared"] } >>
+    -> x { [x / 2, "#{x} was halved"]  }
+```
+Monad Definition:
+
+```ruby
+class LoggerMonad < LiMonad
+  def bind(f, g, *args)
+    f_result, f_log = f[*args]
+    g_result, g_log = g[f_result]
+    [g_result, "#{f_log}\n#{g_log}"]
+  end
+
+  def unit(g, *args)
+    [g[*args], args.inspect]
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'limonad'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install limonad
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/nakhli/limonad/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
+
+## License
+
+Licensed under the [MIT License](http://opensource.org/licenses/MIT).
+
+Copyright Chaker Nakhli.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/limonad.rb

@@ -0,0 +1,48 @@
+require 'limonad/version'
+
+class LiMonad
+
+  def initialize(f=nil)
+    self.fn = f
+  end
+
+  def [](*args)
+    fn[*args]
+  end
+
+  def >>(g)
+    do_bind(g)
+  end
+
+  def self.>>(g)
+    self.new >> g
+  end
+
+  def self.unit(f, *args)
+    self.new.unit(f, *args)
+  end
+
+  protected
+
+  # child monads should override these methods
+  def unit(f, *args)
+    f[*args]
+  end
+
+  def bind(f, g, *args)
+    g[f[*args]]
+  end
+
+  private
+
+  attr_accessor :fn
+
+  def do_unit(f)
+    self.class.new -> *args { unit(f, *args) }
+  end
+
+  def do_bind(g)
+    fn ? self.class.new(-> *args { bind(fn, g, *args) }) : self.class.new(g)
+  end
+end
+

data/lib/limonad/version.rb

@@ -0,0 +1,3 @@
+class LiMonad
+  VERSION = '0.0.1'
+end

data/spec/examples.txt

@@ -0,0 +1,7 @@
+example_id                       | status | run_time        |
+-------------------------------- | ------ | --------------- |
+./spec/logger_monad_spec.rb[1:1] | passed | 0.00009 seconds |
+./spec/logger_monad_spec.rb[1:2] | passed | 0.00052 seconds |
+./spec/maybe_monad_spec.rb[1:1]  | passed | 0.00012 seconds |
+./spec/maybe_monad_spec.rb[1:2]  | passed | 0.00011 seconds |
+./spec/maybe_monad_spec.rb[1:3]  | passed | 0.00233 seconds |

data/spec/logger_monad_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+class LoggerMonad < LiMonad
+  def bind(f, g, *args)
+    f_result, f_log = f[*args]
+    g_result, g_log = g[f_result]
+    [g_result, "#{f_log}\n#{g_log}"]
+  end
+
+  def unit(g, *args)
+    [g[*args], args.inspect]
+  end
+end
+
+RSpec.describe LoggerMonad do
+
+  let(:op) do
+    LoggerMonad >>
+        -> x { [x * x, "#{x} was squared"] } >>
+        -> x { [x / 2, "#{x} was halved"]  }
+  end
+
+  it 'computes the correct result' do
+    result, _ = op[100]
+    expect(result).to eq(5000)
+  end
+
+  it 'does the correct logging' do
+    _, log = op[100]
+    expect(log).to eq("100 was squared\n10000 was halved")
+  end
+end

data/spec/maybe_monad_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+class MaybeMonad < LiMonad
+  def bind(f, g, *args)
+    result = f[*args]
+    g[result] if result
+  end
+end
+
+RSpec.describe MaybeMonad do
+
+  let(:math_op) do
+    MaybeMonad >>
+        -> x { 5 / x unless x == 0 } >>
+        -> x { x + 1 } >>
+        -> x { 3 * x } >>
+        -> x { Math.log(x) unless x < 0 } >>
+        -> x { x.round }
+
+  end
+
+  it 'propagates not nil values' do
+    expect(math_op[0.01]).to eq(7)
+  end
+
+  it 'does not propagate nil values' do
+    expect(math_op[0]).to be_nil
+  end
+
+  it 'does not propagate nil values' do
+    expect(math_op[-0.8]).to be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+require 'limonad'
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered     = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = 'spec/examples.txt'
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order            = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: limonad
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chaker Nakhli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-14 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: A tiny Monad library.
+email:
+- chaker.nakhli@sinbadsoft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/limonad.rb
+- lib/limonad/version.rb
+- spec/examples.txt
+- spec/logger_monad_spec.rb
+- spec/maybe_monad_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nakhli/limonad
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A tiny Monad library.
+test_files:
+- spec/examples.txt
+- spec/logger_monad_spec.rb
+- spec/maybe_monad_spec.rb
+- spec/spec_helper.rb