mayhaps 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ad9d2a355737f9f8031116906dbb644e3a76929
+  data.tar.gz: 27598791c1bf5ce7278b314a53190449de0da058
+SHA512:
+  metadata.gz: 7e5330cb5822377a2cecfff2c1609e5ef7a0ef4aa7f299ea5d9b870937ec3e055e56c0cf003564c7fb74154de0be1969c02b12dcf97047e9aebe815956710a49
+  data.tar.gz: 552ad065e2b519f24138f5816f9dc124d2860db4a6050997f3462d3490ad897a2fa14fa9307fc4290f140b37f61426e292484ee0726fda36595a04bff8ecc46d

data/README.md

@@ -0,0 +1,82 @@
+# Mayhaps
+
+Mayhaps call Ruby methods.
+
+## Usage
+
+Mayhaps allows you to call methods on objects that may or may not be
+nil.
+
+First, install the gem or add it to your `Gemfile`:
+
+```ruby
+gem "mayhaps", "~> 0.1.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.
+
+```ruby
+hash = {:foo => "foo"}
+
+hash[:foo].maybe.upcase #=> "FOO"
+hash[:bar].maybe.upcase #=> nil
+```
+
+### Chaining
+
+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.
+
+```ruby
+hash = {:foo => " foo "}
+
+hash[:foo].maybe_chain.strip.upcase.end #=> "FOO"
+hash[:bar].maybe_chain.strip.upcase.end #=> nil
+```
+
+### Examples
+
+```ruby
+# Without Mayhaps
+if customer && customer.order && customer.order.id == some_id
+  # Do something with customer
+end
+
+# With Mayhaps
+require 'mayhaps/maybe'
+
+if customer.maybe_chain.order.id.end == some_id
+  # Do something with customer
+end
+```
+
+## License
+
+Copyright © 2013, Curtis McEnroe <programble@gmail.com>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/lib/mayhaps.rb

@@ -0,0 +1,39 @@
+require 'singleton'
+
+module Mayhaps
+  class Nothing
+    include Singleton
+
+    def method_missing(*args)
+      nil
+    end
+  end
+
+  class Chain
+    attr_reader :end
+
+    def initialize(obj)
+      @end = obj
+    end
+
+    def method_missing(*args, &block)
+      @end.nil? ? self : Chain.new(@end.public_send(*args, &block))
+    end
+  end
+end
+
+class Object
+  def mayhaps
+    self
+  end
+
+  def mayhaps_chain
+    Mayhaps::Chain.new(self)
+  end
+end
+
+class NilClass
+  def mayhaps
+    Mayhaps::Nothing.instance
+  end
+end

data/lib/mayhaps/maybe.rb

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

data/mayhaps.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name        = 'mayhaps'
+  s.version     = '0.1.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.description = s.summary
+
+  s.files           = `git ls-files`.split("\n")
+  s.require_paths   = ['lib']
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: mayhaps
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Curtis McEnroe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-05 00:00:00.000000000 Z
+dependencies: []
+description: Mayhaps call Ruby methods
+email:
+- programble@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/mayhaps.rb
+- lib/mayhaps/maybe.rb
+- mayhaps.gemspec
+homepage: https://github.com/programble/mayhaps
+licenses:
+- ISC
+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.0.2
+signing_key: 
+specification_version: 4
+summary: Mayhaps call Ruby methods
+test_files: []