ruby-try 1.0.0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--warnings
+--require spec_helper
+--format documentation

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby-try.gemspec
+gemspec
+
+group :development do
+  gem 'rspec', '~> 3.0.0'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Orel Sokolov, RoR team
+
+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,103 @@
+Ruby Try
+========
+This gem has two versions of `try()`. 
+
+* **Vanilla `try()`** 
+  * This is RoR vanilla `try()` and `try!()`. Nothing new.
+* **Boolean `try?()`** 
+  * This is `try()` for boolean functions. It is returns `false` instead of `nil`, when trying to call
+something like `nil.try(:some_boolean_method?)`
+
+```ruby
+irb(main):001:0> require 'ruby-try'
+=> true
+irb(main):002:0> nil.try(:admin?)
+=> nil
+irb(main):003:0> nil.try?(:admin?)
+=> false
+```
+
+Why boolean `try?`
+=================
+
+Imagine, we have something like this:
+```ruby
+def admin_in_team?(team)
+  if m = team_members.find_by_team_id(team.id)
+    m.admin?
+  else
+    false
+  end
+end
+```
+
+Of course, it is better to write something like
+```
+def admin_in_team?(team)
+  team_members.find_by_team_id(team.id).try(:admin?)
+end
+```
+
+But there is a TRAP! If `find_by_team_id(team.id)` returns `nil`,
+`nil.try(:anything)` returns `nil`. Is it a reason for writing this HUGE `if`?
+I don't think so. 
+
+First idea is to patch `try()`. But it is not best idea. Many developers expects
+vanilla behavior from `try()`, so that's why a new `try?()` method appears. It is looks not
+elegant, but one line is better than 5 with misty logic.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby-try'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-try
+
+## Documentation
+  Please, use specs to explore behavior of this gem. Or refer to RoR documentation.
+
+  ```
+    git clone https://github.com/OrelSokolov/ruby-try
+    cd ruby-try
+    bundle
+    rspec spec/
+  ```
+
+## Contributing
+
+1. Fork it ( https://github.com/OrelSokolov/ruby-try/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
+
+
+AUTHORS
+========
+
+* [Oleg Orlov](https://github.com/OrelSokolov)
+* [RoR team](https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/object/try.rb)
+
+
+LICENSE
+=======
+
+This gem is released under the MIT License.
+
+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/Rakefile

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

data/lib/ruby-try.rb

@@ -0,0 +1,64 @@
+class Object
+  def try(*a, &b)
+    if a.empty? && block_given?
+      yield self
+    else
+      public_send(*a, &b) if respond_to?(a.first)
+    end
+  end
+
+  # Same as #try, but will raise a NoMethodError exception if the receiving is not nil and
+  # does not implement the tried method.
+  def try!(*a, &b)
+    if a.empty? && block_given?
+      yield self
+    else
+      public_send(*a, &b)
+    end
+  end
+
+  def try?(*a, &b)
+    if a.empty? && block_given?
+      yield self
+    else
+      if respond_to?(a.first)
+        public_send(*a, &b)
+      else
+        nil.try?(*a, &b)
+      end
+    end
+  end
+
+end
+
+class NilClass
+  # Calling +try+ on +nil+ returns +nil+
+  # It becomes specially helpful when navigating through associations that may return +nil+.
+  #
+  #   nil.try(:name) # => nil
+  #
+  # Without +try+
+  #   @person && !@person.children.blank? && @person.children.first.name
+  #
+  # With +try+
+  #   @person.try(:children).try(:first).try(:name)
+  #
+  def try(*args)
+    nil
+  end
+
+  # Calling +try?+ on +nil+ returns +false+
+  # With +try?+
+  #   @person.try(:children).try(:first).try?(:has_dark_hairs?)
+  def try?(*args)
+    if args.first =~ /[?]$/
+     false
+    else
+      raise ArgumentError, "For non-boolean methods use only try()"
+    end
+  end
+
+  def try!(*args)
+    nil
+  end
+end

data/lib/ruby/try.rb

@@ -0,0 +1,7 @@
+require "ruby/try/version"
+
+module Ruby
+  module Try
+    # Your code goes here...
+  end
+end

data/lib/ruby/try/version.rb

@@ -0,0 +1,5 @@
+module Ruby
+  module Try
+    VERSION = "0.0.1"
+  end
+end

data/ruby-try.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name        = 'ruby-try'
+  spec.version     = '1.0.0'
+  spec.date        = '2014-08-01'
+  spec.summary     = "Provides RoR try() and extends it by new try?() method."
+  spec.description = <<-DESC
+    This gem has two versions of `try()`. 
+
+    Vanilla `try()`
+      This is RoR vanilla `try()` and `try!()` methods. Nothing new.
+    Boolean `try?()`
+      It is returns `false` instead of `nil`, when trying to call something like 
+      `nil.try?(:some_boolean_method?)`
+  DESC
+  spec.authors     = ["Oleg Orlov"]
+  spec.email       = 'orelcokolov@gmail.com'
+  spec.homepage    = 'http://rubygems.org/gems/ruby-try'
+  spec.license     = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/spec/ruby_try_spec.rb

@@ -0,0 +1,196 @@
+require 'spec_helper'
+require 'ruby-try'
+
+#########################################################################3
+
+shared_context "#try, method not exists" do
+  it "should return nil for general method" do
+    subject.try(:non_existing_method).should eq(nil)
+  end
+
+  it "should return nil for boolean method" do
+    subject.try(:non_existing_method?).should eq(nil)
+  end
+end
+
+#########################################################################3
+
+shared_context "#try?, method exists" do
+  it "should raise an exception for general method" do
+    expect {subject.try?(:zero) }.to raise_error(ArgumentError)
+  end
+
+end
+
+shared_context "#try?, method not exists" do
+  it "should raise an exception for general method" do
+    expect {subject.try?(:non_existing_method) }.to raise_error(ArgumentError)
+  end
+
+  it "should return false for boolean method" do
+    subject.try?(:non_existing_method?).should eq(false)
+  end
+end
+
+
+#########################################################################3
+
+shared_context "object with try" do
+  before do
+    allow_message_expectations_on_nil
+    subject.stub(:get_zero).and_return(0)
+    subject.stub(:zero?).and_return(true)
+  end
+
+  it { should respond_to(:try)  }
+  it { should respond_to(:try?) }
+  it { should respond_to(:try!) }
+
+  it { should_not respond_to(:non_existing_method) }
+  it { should_not respond_to(:non_existing_method?) }
+
+end
+
+describe Object do
+  include_context 'object with try'
+
+
+  ###############################################################################
+
+  describe "#try" do
+    context "for existing method" do
+      include_context "#try, method exists" 
+
+      it "should return value for general method" do
+        subject.try(:get_zero).should eq(0)
+      end
+
+      it "should return value for boolean method" do
+        subject.try(:zero?).should eq(true)
+      end
+    end
+
+    context "for non-existing method" do
+      include_context "#try, method not exists" 
+
+    end
+
+  end
+
+  ###############################################################################
+
+  describe "#try?" do
+    context "for existing method" do
+      include_context "#try?, method exists" 
+      
+      it "should return value for boolean method" do
+        subject.try?(:zero?).should eq(true)
+      end
+    end
+
+    context "for non-existing method" do
+      include_context "#try?, method not exists" 
+
+    end
+  end
+
+  ###############################################################################
+
+  describe "#try!" do
+    context "for existing method" do
+      it "should return value for general method" do
+        subject.try!(:get_zero).should eq(0)
+      end
+
+      it "should return value for boolean method" do
+        subject.try!(:zero?).should eq(true)
+      end
+    end
+
+    context "for non-existing method" do
+      it "should raise an exception for general method" do
+        expect {subject.try!(:non_existing_method) }.to raise_error(NoMethodError)
+      end
+
+      it "should raise an exception for boolean method" do
+        expect {subject.try!(:non_existing_method?) }.to raise_error(NoMethodError)
+      end
+    end
+  end
+
+end
+
+describe NilClass do
+  subject { nil }
+  include_context 'object with try'
+
+  ###############################################################################
+
+  describe "#try" do
+    context "for existing method" do
+      it "should return nil for general method" do
+        subject.try(:get_zero).should eq(nil)
+      end
+
+      it "should return nil for boolean method" do
+        subject.try(:zero?).should eq(nil)
+      end
+    end
+
+    context "for non-existing method" do
+      it "should return nil for general method" do
+        subject.try(:get_zero).should eq(nil)
+      end
+
+      it "should return nil for boolean method" do
+        subject.try(:zero?).should eq(nil)
+      end
+    end
+
+
+  end
+
+  ###############################################################################
+
+  describe "#try?" do
+    context "for existing method" do
+      include_context "#try?, method exists" 
+
+      it "should return false for boolean method" do
+        subject.try?(:zero?).should eq(false)
+      end
+    end
+
+    context "for non-existing method" do
+      include_context "#try?, method not exists" 
+    end
+  end
+
+  ###############################################################################
+
+  describe "#try!" do
+    context "for existing method" do
+
+      it "should return nil for boolean method" do
+        subject.try!(:zero?).should eq(nil)
+      end
+
+      it "should return nil for general method" do
+        subject.try!(:get_zero).should eq(nil)
+      end
+    end
+
+    context "for non-existing method" do
+
+      it "should return nil for general method" do
+        subject.try!(:non_existing_method).should eq(nil)
+      end
+
+      it "should return nil for boolean method" do
+        subject.try!(:non_existing_method?).should eq(nil)
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+RSpec.configure do |config|
+  config.mock_with :rspec do |c|
+    c.syntax = [:should, :expect] # Disable warnings
+  end
+end
+
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect] # Disable warnings
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: ruby-try
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Oleg Orlov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: ! "    This gem has two versions of `try()`. \n\n    Vanilla `try()`\n
+  \     This is RoR vanilla `try()` and `try!()` methods. Nothing new.\n    Boolean
+  `try?()`\n      It is returns `false` instead of `nil`, when trying to call something
+  like \n      `nil.try?(:some_boolean_method?)`\n"
+email: orelcokolov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby-try.rb
+- lib/ruby/try.rb
+- lib/ruby/try/version.rb
+- ruby-try.gemspec
+- spec/ruby_try_spec.rb
+- spec/spec_helper.rb
+homepage: http://rubygems.org/gems/ruby-try
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Provides RoR try() and extends it by new try?() method.
+test_files:
+- spec/ruby_try_spec.rb
+- spec/spec_helper.rb