maybelline 1.1.0 → 1.1.1

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Allen Madsen
+
+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

@@ -1,21 +1,65 @@
 # Maybelline
 
-An implementation of the maybe monad.
+[![Build Status](http://travis-ci.org/blatyo/maybelline.png)](http://travis-ci.org/blatyo/maybelline)
+
+An implementation of the [maybe monad](http://en.wikipedia.org/wiki/Monad_(functional_programming)#The_Maybe_monad).
+
+## Setup
+
+**Gemfile**
+``` ruby
+gem 'maybelline'
+```
+
+**Manual**
+``` ruby
+require 'maybelline'
+```
 
 ## Usage
 
+Say you have some objects like the ones below:
+
 ``` ruby
-class B
-  def b
-    nil
-  end
-end
-
-# if any method in the chain of calls returns nil, the 
-# block will return nil
-Maybe(B){|b| b.new.b.this_method_wont_get_called} #=> nil
-B.maybe{|b| b.new.b.this_method_wont_get_called}  #=> nil
-
-# if it is successful, it will return the value
-1.maybe{|n| n.to_s(16).to_i.to_s(8)}              #=> 1
-```
+require 'ostruct'
+
+data = {
+  "neat" => {
+    "super" => "cool",
+    "lame"  => nil
+  }
+}
+
+object = OpenStruct.new(data)
+object.neat = OpenStruct.new(object.neat)
+```
+
+If any method in the chain of calls returns nil, the block will return nil.
+
+``` ruby
+Maybe(data){|d| d["this_key_doesnt_exist"]["this_key_wont_get_called"]} #=> nil
+data.maybe{|d| d["this_key_doesnt_exist"]["this_key_wont_get_called"]}  #=> nil
+object.maybe{|o| o.neat.lame.this_method_never_gets_called}             #=> nil
+```
+
+If it is successful, it will return the value.
+
+``` ruby
+data.maybe{|d| d["neat"]["super"]}  #=> "cool"
+object.maybe{|o| o.neat.super}      #=> "cool"
+```
+
+## Note on Reporting Issues
+
+* Try to make a failing test case
+* Tell me which version of ruby you're using
+* Tell me which OS you are using
+* Provide me with any extra files if necessary
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec
+task :test => :spec

data/lib/maybelline/version.rb

@@ -1,3 +1,3 @@
 module Maybelline
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

data/maybelline.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Maybelline::VERSION
   s.authors     = ["Allen Madsen"]
   s.email       = ["blatyo@gmail.com"]
-  s.homepage    = ""
+  s.homepage    = "https://blatyo.github.com/maybelline"
   s.summary     = %q{Maybe you should start using the maybe monad, stop checking for nil, and be confident}
   s.description = %q{Maybe you should start using the maybe monad, stop checking for nil, and be confident}
 
@@ -20,5 +20,6 @@ Gem::Specification.new do |s|
 
   # specify any dependencies here; for example:
   s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
   # s.add_runtime_dependency "rest-client"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maybelline
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-24 00:00:00.000000000 Z
+date: 2012-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70188494085700 !ruby/object:Gem::Requirement
+  requirement: &70277833452260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70188494085700
+  version_requirements: *70277833452260
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70277833451820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70277833451820
 description: Maybe you should start using the maybe monad, stop checking for nil,
   and be confident
 email:
@@ -32,7 +43,9 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - lib/maybelline.rb
@@ -40,7 +53,7 @@ files:
 - maybelline.gemspec
 - spec/maybelline_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://blatyo.github.com/maybelline
 licenses: []
 post_install_message: 
 rdoc_options: []