ribimaybe 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTI2MGNiZjZlOWJkYzA4ZWYxZTQ2ZDJlN2RkODBkNGM3Y2Q0YzljMw==
+  data.tar.gz: !binary |-
+    NDdjZThjMmNlMTI2MjBkMTVjN2Y4MGNmZmNmMTdkNGZmZmY2MWY0Mw==
+SHA512:
+  metadata.gz: !binary |-
+    OWI1Yzk3OTEzZjE5ZThjMDMwNWExMGNlOGJjNmE3MmViYTMxNTc1Nzc5N2E0
+    YTkzZjM4YjNkYTFiMzJjZTVmMjI5ODJiZjgwOTg2N2I3ZjE2Mzc3MmQ5YzQz
+    ODhiODdkM2YxNTU4YTZiNzI1ZTEwYzMwOGZkZjQ2Zjg4ZWEzY2I=
+  data.tar.gz: !binary |-
+    ZTY0OTY3ZWJkZDhiMDRlNWRmNjJkZWE4NWM0MTMxMzIyODVmOTNiYmU3NTlh
+    ODk1OWY3NTFhYmEyOWI1MmUwMjhkZDUyZTVhOTBiOGM5ZmZkMDdkZmNkMTNi
+    MTQxZGU2ZjNkNTg2MWMxZmM4MTQxYTYwZTQ3OTgzMWEwZjlmNzY=

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/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+script:
+  - bundle exec rake spec

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+gemspec
+gem "contracts", "~> 0.4"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 unsymbol
+
+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,91 @@
+# Ribimaybe
+
+![](maybe.gif)
+
+A tiny Ruby library that provides a Maybe datatype which is a Functor, 
+Applicative Functor and Monad instance.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ribimaybe'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ribimaybe
+
+## Usage
+
+This is a small library and so it doesn't offer lots of creature comforts. The 
+one escape hatch it does offer is the ability to convert `nil` into `Nothing`. 
+
+``` ruby
+include Ribimaybe::Maybe
+
+Maybe(42)  # => Just(42)
+Maybe(nil) # => Nothing
+```
+
+And that's it, once you have lifted your value into a `Maybe` you can treat it 
+as a `Functor`, `Applicative Functor` or `Monad`. If you want to pull your value
+out of a `Maybe`, we got you covered too.
+
+``` ruby
+Just(42).maybe(false) { |x| x == 42 } # => true
+Nothing.maybe(false)  { |x| x == 42 } # => false 
+```
+
+### Functor [\[info\]](http://learnyouahaskell.com/functors-applicative-functors-and-monoids)
+
+``` ruby
+include Ribimaybe::Maybe
+
+# Apply functions within Maybe and retain structure.
+Just(42).map { |x| x * x } # => Just(1764)
+Nothing.map  { |x| x * x } # => Nothing
+```
+
+### Applicative Functor [\[info\]](http://learnyouahaskell.com/functors-applicative-functors-and-monoids)
+
+``` ruby
+include Ribimaybe::Maybe
+
+# Wrap functions inside functors and apply them to other functors! 
+Just do |x|
+  x * x
+end.apply(pure(42)) # => Just(1764)
+
+Just do |x|
+  x * x
+end.apply(Nothing) # => Nothing
+```
+
+### Monad [\[info\]](http://www.learnyouahaskell.com/a-fistful-of-monads)
+
+``` ruby
+include Ribimaybe::Maybe
+
+# Chain together computations and pretend you're a Haskeller.
+Just(42).bind do |x|
+  rturn(x - 21)
+end.bind do |x|
+  rturn(x * 2)
+end # => Just(42)
+
+# You guessed it! If have Nothing, you get Nothing.
+Nothing.bind do |x|
+  rturn(x * x)
+end # => Nothing
+```
+## Contributing
+
+1. Fork it
+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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:default) do |spec|
+  spec.pattern = FileList["spec/**/*_spec.rb"]
+end

data/lib/ribimaybe.rb

@@ -0,0 +1,216 @@
+require "contracts"
+
+module Ribimaybe
+  VERSION = "0.0.1"
+
+  module Maybe
+    include Contracts
+
+    module Nothing
+      include Contracts
+
+      # Nothing string representation.
+      #
+      def self.to_s
+        "Nothing"
+      end
+
+      # No operation. Always returns the default value.
+      #
+      Contract Any, Proc => Any
+      def self.maybe(default, &_)
+        default
+      end
+
+      # No operation. Always returns Nothing.
+      #
+      Contract Proc => Nothing
+      def self.map(&_)
+        self
+      end
+
+      # No operation. Always returns Nothing.
+      #
+      Contract Any => Nothing
+      def self.apply(_)
+        self
+      end
+
+      # No operation. Always returns Nothing.
+      #
+      Contract Proc => Nothing
+      def self.bind(&_)
+        self
+      end
+    end
+
+    class Just
+      include Contracts
+
+      def initialize(value)
+        @value = value
+      end
+
+      def to_s
+        "Just(#{@value.inspect})"
+      end
+
+      # Compares a Just to another Maybe.
+      #
+      # ==== Attributes
+      #
+      # * +other+ - The other Maybe value.
+      #
+      # ==== Examples
+      #
+      # Just(1) == Just(1) # => true
+      # Just(1) == Just(2) # => false
+      # Just(1) == Nothing # => false
+      #
+      Contract Or[Nothing, Just] => Bool
+      def ==(other)
+        other.maybe(false) do |value|
+          @value == value
+        end
+      end
+
+      # Fetches a value out of a Just and returns the application
+      # of fn to the internal value.
+      #
+      # ==== Attributes
+      #
+      # * +_+  - Irrelevant default.
+      # * +fn+ - Function to be applied inside our Just.
+      #
+      # ==== Examples
+      #
+      # Just(1).maybe(false) { |x| x == 1 } # => true
+      # Just(1).maybe(42)    { |x| x }      # => 1
+      #
+      Contract Any, Proc => Any
+      def maybe(_, &fn)
+        fn.(@value)
+      end
+
+      # Applies fn to a value inside Just and re-wraps it in another Just.
+      #
+      # ==== Attributes
+      #
+      # * +fn+ - Function to be applied inside Just.
+      #
+      # ==== Examples
+      #
+      # Just(1).map { |x| x + 1 } # => Just(2)
+      #
+      Contract Proc => Just
+      def map(&fn)
+        Just.new(fn.(@value))
+      end
+
+      # Applies fn inside Just to a value in another Just and re-wraps the
+      # result in another Just.
+      #
+      # ==== Attributes
+      #
+      # * +value+ - Maybe whose value will be use in function application.
+      #
+      # ==== Examples
+      #
+      # Just do |x|
+      #   x + x
+      # end.apply(Just(1)) # => Just(2)
+      #
+      Contract Or[Nothing, Just] => Or[Nothing, Just]
+      def apply(value)
+        value.map { |v| @value.(v) }
+      end
+
+      # Applies fn to value inside Just (note contract constraint).
+      #
+      # ==== Attributes
+      #
+      # * +fn+ - Function to be applied inside our Just.
+      #
+      # ==== Examples
+      #
+      # Just(1).bind do |x|
+      #   rturn(x + x)
+      # end # => Just(2)
+      #
+      Contract Proc => Just
+      def bind(&fn)
+        fn.(@value)
+      end
+    end
+
+    # Converts nil to Nothing or lifts value into a Just. Pass either a block
+    # or a function.
+    #
+    # ==== Attributes
+    #
+    # * +value+ - Value to be wrapped.
+    # * +fn+    - Block or function to be wrapped.
+    #
+    # ==== Examples
+    #
+    # Maybe(nil)      # => Nothing
+    # Maybe(1)        # => Just(1)
+    # Maybe { |x| x } # => Just(#<Proc:0x007fdecc03a478@(irb):6>)
+    #
+    Contract Any, Or[nil, Proc] => Or[Nothing, Just]
+    def Maybe(value = nil, &fn)
+      (value || fn) ? Just(value || fn) : Nothing
+    end
+
+    # Wraps a value or a function in a Just or returns a Nothing.
+    #
+    # ==== Attributes
+    #
+    # * +value+ - Value to be wrapped.
+    # * +fn+    - Block or function to be wrapped.
+    #
+    # ==== Examples
+    #
+    # Just(nil)      # => Nothing
+    # Just(1)        # => Just(1)
+    # Just { |x| x } # => Just(#<Proc:0x007fdecc03a478@(irb):6>)
+    #
+    Contract Any, Or[nil, Proc] => Or[Nothing, Just]
+    def Just(value = nil, &fn)
+      return Nothing unless (value || fn)
+      Just.new(value || fn)
+    end
+
+    # Wraps a value in a Just or returns a Nothing.
+    #
+    # ==== Attributes
+    #
+    # * +value+ - Value to be wrapped.
+    #
+    # ==== Examples
+    #
+    # pure(nil) # => Nothing
+    # pure(1)   # => Just(1)
+    #
+    Contract Any => Or[Nothing, Just]
+    def pure(value)
+      Maybe(value)
+    end
+
+    # Wraps a value in a Just or returns a Nothing.
+    #
+    # ==== Attributes
+    #
+    # * +value+ - Value to be wrapped.
+    #
+    # ==== Examples
+    #
+    # rturn(nil) # => Nothing
+    # rturn(1)   # => Just(1)
+    #
+    Contract Any => Or[Nothing, Just]
+    def rturn(value)
+      pure(value)
+    end
+  end
+end

data/ribimaybe.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ribimaybe"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ribimaybe"
+  spec.version       = Ribimaybe::VERSION
+  spec.authors       = ["unsymbol"]
+  spec.email         = ["hello@philipcunningham.org"]
+  spec.description   = "Maybe Functor, Applicative and Monad"
+  spec.summary       = "A tiny Ruby library that provides a Maybe datatype which is a Functor, Applicative Functor and Monad instance."
+  spec.homepage      = "https://github.com/unsymbol/ribimaybe"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/applicative_functor_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+include Ribimaybe::Maybe
+
+describe "Applicative Instance" do
+  describe "#pure" do
+    context "when i provide a nil" do
+      it "should give me back nothing" do
+        result = pure(nil)
+        expect(result).to eq Nothing
+      end
+    end
+
+    context "when i provide a value" do
+      it "should wrap the value" do
+        result = pure(42)
+        expect(result).to eq Just(42)
+      end
+    end
+  end
+
+  describe "#apply" do
+    context "when i have nothing" do
+      it "should give me back nothing" do
+        result = Nothing.apply Just(42)
+        expect(result).to eq Nothing
+      end
+    end
+
+    context "when i something containing a fn" do
+      it "should be apply to apply that fn to something" do
+        result = Just do |x|
+          x + x
+        end.apply Just(21)
+        expect(result).to eq Just(42)
+      end
+    end
+  end
+end

data/spec/functor_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+include Ribimaybe::Maybe
+
+describe "Functor Instance" do
+  describe "#map" do
+    context "when i have nothing" do
+      it "should give me back nothing" do
+        result = Nothing.map { |x| x + 1 }
+        expect(result).to eq Nothing
+      end
+    end
+
+    context "when i have something" do
+      it "should apply the fn and we-wrap the value" do
+        result = Just(41).map { |x| x + 1 }
+        expect(result).to eq Just(42)
+      end
+    end
+  end
+end

data/spec/maybe_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+include Ribimaybe::Maybe
+
+describe Ribimaybe::Maybe do
+  describe ".maybe" do
+    context "when i have nothing" do
+      it "should give me back a default" do
+        result = Nothing.maybe(42) { |x| x + 1 }
+        expect(result).to eq 42
+      end
+    end
+
+    context "when i have something" do
+      it "should give me back something" do
+        result = Just(42).maybe(1) { |x| x }
+        expect(result).to eq 42
+      end
+    end
+  end
+end

data/spec/monad_instance_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+include Ribimaybe::Maybe
+
+describe "Monad Instance" do
+  describe "#rturn" do
+    context "when i provide a nil" do
+      it "should give me back nothing" do
+        result = rturn(nil)
+        expect(result).to eq Nothing
+      end
+    end
+
+    context "when i provide a value" do
+      it "should wrap the value" do
+        result = rturn(42)
+        expect(result).to eq Just(42)
+      end
+    end
+  end
+
+  describe "#bind" do
+    context "when i have nothing" do
+      it "should give me back nothing" do
+        result = Nothing.bind do |x|
+          rturn x + x
+        end
+        expect(result).to eq Nothing
+      end
+    end
+
+    context "when i something containing a fn" do
+      it "should be apply to apply that fn to something" do
+        result = Just(21).bind do |x|
+          rturn x + x
+        end
+        expect(result).to eq Just(42)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + "/../lib")
+
+require "bundler/setup"
+require "pry"
+require "ribimaybe"
+require "rubygems"
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: ribimaybe
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- unsymbol
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 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: rspec
+  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'
+description: Maybe Functor, Applicative and Monad
+email:
+- hello@philipcunningham.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ribimaybe.rb
+- maybe.gif
+- ribimaybe.gemspec
+- spec/applicative_functor_spec.rb
+- spec/functor_spec.rb
+- spec/maybe_spec.rb
+- spec/monad_instance_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/unsymbol/ribimaybe
+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.1.11
+signing_key: 
+specification_version: 4
+summary: A tiny Ruby library that provides a Maybe datatype which is a Functor, Applicative
+  Functor and Monad instance.
+test_files:
+- spec/applicative_functor_spec.rb
+- spec/functor_spec.rb
+- spec/maybe_spec.rb
+- spec/monad_instance_spec.rb
+- spec/spec_helper.rb