mayhaps 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ad9d2a355737f9f8031116906dbb644e3a76929
-  data.tar.gz: 27598791c1bf5ce7278b314a53190449de0da058
+  metadata.gz: 6b040f7ea36f59ace8e9eeff30c3d60dbdd10e56
+  data.tar.gz: bd7c93a5baa9debaf9cf5408f8ba5cec9fa3502f
 SHA512:
-  metadata.gz: 7e5330cb5822377a2cecfff2c1609e5ef7a0ef4aa7f299ea5d9b870937ec3e055e56c0cf003564c7fb74154de0be1969c02b12dcf97047e9aebe815956710a49
-  data.tar.gz: 552ad065e2b519f24138f5816f9dc124d2860db4a6050997f3462d3490ad897a2fa14fa9307fc4290f140b37f61426e292484ee0726fda36595a04bff8ecc46d
+  metadata.gz: 34ac68a02130ef8f656421ce90b91073131b977a90bde11b4fc505ac61bc43ace4fed87ce37df8733782dd822848130c7f40273e68bd0232526367877e9b50ae
+  data.tar.gz: 0792ea6963a010e375802c14c66d0aaab069ad16f7acacfc6946d5bb5445a089a5ce735cade6aaaa790c52c7d49eeaee1665a367035eb0046384d63b2fa02b91

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.md

@@ -1,6 +1,6 @@
-# Mayhaps
+# Mayhaps [![Gem Version](https://badge.fury.io/rb/mayhaps.png)](http://badge.fury.io/rb/mayhaps)
 
-Mayhaps call Ruby methods.
+Mayhaps (maybe) call Ruby methods.
 
 ## Usage
 
@@ -10,46 +10,37 @@ nil.
 First, install the gem or add it to your `Gemfile`:
 
 ```ruby
-gem "mayhaps", "~> 0.1.0"
+gem "mayhaps", "~> 0.2.0"
 ```
 
-Next, require it. There are two choices for using Mayhaps:
-
-1. `require 'mayhaps'`: Provides the `mayhaps` and `mayhaps_chain`
-   methods.
-2. `require 'mayhaps/maybe'`: Provides the `maybe` and `maybe_chain`
-   methods as aliases for the above.
-
-For the following examples, `require 'mayhaps/maybe'` is used.
-
-### Maybe
-
-The `maybe` method allows you to call a method on an object that may or
-may not be nil. If the object is nil, then the result of calling the
-method will also be nil.
+Next, require it:
 
 ```ruby
-hash = {:foo => "foo"}
-
-hash[:foo].maybe.upcase #=> "FOO"
-hash[:bar].maybe.upcase #=> nil
+require 'mayhaps'
 ```
 
-### Chaining
+### On the surface
+
+Mayhaps adds a `maybe` method to all objects that allows you to call
+methods on the object regardless of whether or not it is nil. It does
+this by wrapping the object in a `Maybe` object, more specifically a
+`Nothing` object for nil or a `Just` object for anything else. To unwrap
+the value, use unary `+` on the `Maybe` object.
 
-The `maybe_chain` method works similarly, except it allows you to chain
-method calls and requires you to call `end` in order to retrieve the
-result, which is either the result of the chain of method calls, or nil
-if any of the methods in the chain returned nil.
+#### Examples
 
 ```ruby
 hash = {:foo => " foo "}
 
-hash[:foo].maybe_chain.strip.upcase.end #=> "FOO"
-hash[:bar].maybe_chain.strip.upcase.end #=> nil
-```
+hash[:foo].maybe.upcase #=> #<Just " FOO ">
+hash[:bar].maybe.upcase #=> #<Nothing>
 
-### Examples
++hash[:foo].maybe.upcase #=> " FOO "
++hash[:bar].maybe.upcase #=> nil
+
++hash[:foo].maybe.upcase.strip #=> "FOO"
++hash[:bar].maybe.upcase.strip #=> nil
+```
 
 ```ruby
 # Without Mayhaps
@@ -58,13 +49,56 @@ if customer && customer.order && customer.order.id == some_id
 end
 
 # With Mayhaps
-require 'mayhaps/maybe'
+require 'mayhaps'
 
-if customer.maybe_chain.order.id.end == some_id
+if +customer.maybe.order.id == some_id
   # Do something with customer
 end
 ```
 
+### The nitty gritty
+
+`Just` and `Nothing` both inherit from `BasicObject` rather than
+`Object` in order to allow the maximum number of methods to fall through
+to the wrapped object. This includes methods like `class` and `is_a?`,
+therefore the `===` method of the `Maybe` classes should be used to
+check if an object is wrapped in a `Maybe`.
+
+```ruby
+Maybe === :a.maybe #=> true
+Just === :a.maybe #=> true
+Maybe === nil.maybe #=> true
+Nothing === nil.maybe #=> true
+```
+
+The methods that will be called on the `Maybe` object itself and not the
+wrapped object are:
+
+* `+@`
+* `method_missing`
+* `inspect`
+* `maybe`
+* `_dump`
+* `==`
+* `equal?`
+* `!`
+* `!=`
+* `instance_eval`
+* `instance_exec`
+* `__send__`
+* `__id__`
+
+`_dump` is a method added by the `Singleton` module, which `Nothing`
+includes.
+
+The `maybe` method defined on `Maybe` objects simply returns `self`.
+
+The `maybe` method should be used to wrap objects in `Maybe` objects,
+but they can also be created directly. Since `Nothing` is a `Singleton`,
+its instance can be accessed using `Nothing.instance`. A `Just` object
+can be created by calling `Just.new`. If the object passed to `Just.new`
+is `nil`, an ArgumentError will be raised.
+
 ## License
 
 Copyright © 2013, Curtis McEnroe <programble@gmail.com>

data/lib/mayhaps.rb

@@ -1,39 +1,54 @@
 require 'singleton'
 
-module Mayhaps
-  class Nothing
-    include Singleton
-
-    def method_missing(*args)
-      nil
+class Object
+  def maybe
+    if nil?
+      Nothing.instance
+    else
+      Just.new(self)
     end
   end
+end
 
-  class Chain
-    attr_reader :end
+module Maybe
+  def maybe
+    self
+  end
+end
 
-    def initialize(obj)
-      @end = obj
-    end
+class Just < BasicObject
+  include ::Maybe
 
-    def method_missing(*args, &block)
-      @end.nil? ? self : Chain.new(@end.public_send(*args, &block))
-    end
+  def initialize(obj)
+    ::Kernel.raise ::ArgumentError, 'object is nil' if obj.nil?
+    @value = obj
   end
-end
 
-class Object
-  def mayhaps
-    self
+  def +@
+    @value
+  end
+
+  def method_missing(*args, &block)
+    @value.public_send(*args, &block).maybe
   end
 
-  def mayhaps_chain
-    Mayhaps::Chain.new(self)
+  def inspect
+    "#<Just #{@value.inspect}>"
   end
 end
 
-class NilClass
-  def mayhaps
-    Mayhaps::Nothing.instance
+class Nothing < BasicObject
+  include ::Maybe, ::Singleton
+
+  def +@
+    nil
+  end
+
+  def method_missing(*args)
+    self
+  end
+
+  def inspect
+    '#<Nothing>'
   end
 end

data/mayhaps.gemspec

@@ -1,11 +1,11 @@
 Gem::Specification.new do |s|
   s.name        = 'mayhaps'
-  s.version     = '0.1.0'
+  s.version     = '0.2.0'
   s.license     = 'ISC'
   s.authors     = ['Curtis McEnroe']
   s.email       = ['programble@gmail.com']
   s.homepage    = 'https://github.com/programble/mayhaps'
-  s.summary     = 'Mayhaps call Ruby methods'
+  s.summary     = 'Mayhaps (maybe) call Ruby methods'
   s.description = s.summary
 
   s.files           = `git ls-files`.split("\n")

metadata

@@ -1,25 +1,25 @@
 --- !ruby/object:Gem::Specification
 name: mayhaps
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Curtis McEnroe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-05 00:00:00.000000000 Z
+date: 2013-10-11 00:00:00.000000000 Z
 dependencies: []
-description: Mayhaps call Ruby methods
+description: Mayhaps (maybe) call Ruby methods
 email:
 - programble@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - README.md
 - lib/mayhaps.rb
-- lib/mayhaps/maybe.rb
 - mayhaps.gemspec
 homepage: https://github.com/programble/mayhaps
 licenses:
@@ -44,5 +44,5 @@ rubyforge_project:
 rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
-summary: Mayhaps call Ruby methods
+summary: Mayhaps (maybe) call Ruby methods
 test_files: []

data/lib/mayhaps/maybe.rb

@@ -1,6 +0,0 @@
-require 'mayhaps'
-
-class Object
-  alias_method :maybe, :mayhaps
-  alias_method :maybe_chain, :mayhaps_chain
-end