guaranteed 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 68c2106aec66d9a30837abfe4d5e5525efe47aae
+  data.tar.gz: cc3cb198596eab977a55d2e5d92c40395bcdf89f
+SHA512:
+  metadata.gz: dc419d2fc820c2fab345bf281ba53c639677a78cdbfbf2be28c03a53a909086bcbbeb9a3c9e04a8c11c94ccddaa8e8373a35a13a87dff1c903c57784dceee805
+  data.tar.gz: 2ceb544b8822d02421245e388dade94a0d7a1e95908573f01df6b1378dd10008c8dce5a1ad6df941a6c2c23d682dc24f383e168acd01568a4105a5755ee9fe7f

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Giannis Katsanos
+
+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,115 @@
+# guaranteed
+
+> Give me something for nothing!
+
+## What is this?
+
+Guaranteed is a tiny library that ensures you always have an object to act upon. By eliminating continual checks for your objects' capabilities you can focus on your code's functionality.
+
+Guaranteed's primary goal is to __eliminate nil checks__.
+
+## Hmmm... I'm not sure I need this
+
+Hey, I'm with you here, you probably don't. Consider this a "nice to have" library. But the truth is that using the library can lead to much cleaner designs. Plus, it's almost zero overhead for your project. All you need is Ruby.
+
+Here's the basic usage. Let's fire up `irb` and illustrate a frequent problem we face when coding.
+
+```ruby
+# The most explicit approach
+# Too verbose!
+def username
+  user.nil? ? nil : user.name
+end
+
+# An improvement (arguably)
+# What if the name attribute should return a boolean?
+def username
+  user && user.name
+end
+
+# Rails developers think this is a neat trick :(
+def username
+  user.try(:name)
+end
+
+# Guaranteed to the rescue!
+def username
+  Guaranteed.Object(user).name
+end
+```
+
+## I'm still not convinced
+
+The above example is just scratching the surface of Guaranteed's abilities. Let's take a look at some more interesting examples.
+
+Most common Ruby methods on objects are supported. They follow Ruby's implicit type conversions for an instance of [NilClass](https://ruby-doc.org/core-2.3.0/NilClass.html).
+
+```ruby
+object = Guaranteed.Object(nil)
+
+object.nil?     # => true
+!object         # => true
+object.to_a     # => []
+object.to_h     # => {}
+object.to_s     # => ''
+object.to_f     # => 0.0
+object.to_i     # => 0
+object.empty?   # => true
+```
+
+Need method chaining? You're covered.
+
+```ruby
+object = Guaranteed.Object(nil)
+
+object.this.will.definitely.not.work!
+# => Returns self
+```
+
+Agreed, this amount of method chaining breaks the [Law of Demeter](https://en.wikipedia.org/wiki/Law_of_Demeter). Sometimes reality hits you hard in the face though. Let's try the above example using [ActiveSupport::Object](http://api.rubyonrails.org/classes/Object.html).
+
+```ruby
+# Ugh..
+object.try(:this).try(:will).try(:definitely).try(:not).try(:work!)
+# => nil
+```
+
+Bonus Ruby idiom that's supported.
+
+```ruby
+object = Guaranteed.Object(nil)
+
+object.tap do |o|
+  o.name = 'Homer Simpson'
+  o.save!
+end
+# => Returns self
+```
+
+Using Rails? I've got good news for you! The library supports some Rails-specific methods too.
+
+```ruby
+object = Guaranteed.Object(nil)
+
+object.present?     # => false
+object.as_json      # => nil
+object.to_json      # => "null"
+object.persisted?   # => false
+```
+
+## OK, I'm sold. How do I install it?
+
+```
+$ gem install guaranteed
+# or add it to your Gemfile
+```
+
+## Can I contribute?
+
+Yes, please. Feel free to fork the project and create your own branches. Consider creating a pull request back to this repo.
+
+Remember, you can run the tests with
+
+```
+$ rake
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Runs the tests'
+task default: :test
+

data/lib/guaranteed.rb

@@ -0,0 +1,16 @@
+require 'guaranteed/null_object'
+
+module Guaranteed
+  # Ensures there is an object we can confidently pass messages to.
+  #
+  # @param value an object, instance of any class
+  # @return the same object or a NullObject for instances of NilClass.
+  def self.Object(value = nil)
+    case value
+    when nil
+      NullObject.new
+    else
+      value
+    end
+  end
+end

data/lib/guaranteed/null_object.rb

@@ -0,0 +1,63 @@
+require 'forwardable'
+
+module Guaranteed
+  # An implementation the Null Object pattern.
+  #
+  # Overrides some common Ruby and Rails methods to avoid continual
+  #   type-checking. Delegates most of them to an intance of NilClass.
+  class NullObject
+    extend Forwardable
+
+    def_delegators :value, :nil?, :to_a, :to_s, :to_f, :to_i, :to_h
+
+    def persisted?
+      false
+    end
+
+    def present?
+      false
+    end
+
+    def empty?
+      true
+    end
+
+    def blank?
+      true
+    end
+
+    def tap
+      self
+    end
+
+    def !
+      true
+    end
+
+    def as_json(options = nil)
+      nil
+    end
+
+    def to_json
+      "null"
+    end
+
+    # Allows instances of the class to respond to any received message.
+    #
+    # Supports unlimited method chaining. Avoids NoMethodError in any
+    #   part of the method chain.
+    def method_missing(method_name, *args, &block)
+      self
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      true
+    end
+
+    private
+
+    def value
+      nil
+    end
+  end
+end

data/lib/guaranteed/version.rb

@@ -0,0 +1,3 @@
+module Guaranteed
+  VERSION = '0.1.0'
+end

data/test/test_guaranteed.rb

@@ -0,0 +1,25 @@
+require 'minitest/autorun'
+require 'guaranteed'
+
+class TestGuaranteed < Minitest::Test
+  class Example
+  end
+
+  def test_object_returns_a_null_object_if_object_is_nil
+    object = Guaranteed.Object(nil)
+    assert_equal(Guaranteed::NullObject, object.class)
+    assert_equal(true, object.nil?)
+  end
+
+  def test_object_returns_the_object_if_object_is_not_nil
+    assert_equal('the-object', Guaranteed.Object('the-object'))
+    object = Example.new
+    assert_equal(object, Guaranteed.Object(object))
+  end
+
+  def test_object_can_chain_methods
+    res = Guaranteed.Object(nil).this.is.definitely.missing
+    assert_equal(true, res.nil?)
+    assert_equal(Guaranteed::NullObject, res.class)
+  end
+end

data/test/test_null_object.rb

@@ -0,0 +1,57 @@
+require 'minitest/autorun'
+require 'guaranteed/null_object'
+
+class TestNullObject < Minitest::Test
+  def test_to_a_returns_an_empty_array
+    assert_equal([], Guaranteed::NullObject.new.to_a)
+  end
+
+  def test_to_s_returns_an_empty_string
+    assert_equal('', Guaranteed::NullObject.new.to_s)
+  end
+
+  def test_to_h_returns_an_empty_hash
+    assert_equal({}, Guaranteed::NullObject.new.to_h)
+  end
+
+  def test_to_i_returns_zero
+    assert_equal(0, Guaranteed::NullObject.new.to_i)
+  end
+
+  def test_to_f_returns_zero_float
+    assert_equal(0.0, Guaranteed::NullObject.new.to_i)
+  end
+
+  def test_present_returns_false
+    assert_equal(false, Guaranteed::NullObject.new.present?)
+  end
+
+  def test_empty_returns_true
+    assert_equal(true, Guaranteed::NullObject.new.empty?)
+  end
+
+  def test_blank_returns_true
+    assert_equal(true, Guaranteed::NullObject.new.blank?)
+  end
+
+  def test_not_returns_true
+    assert_equal(true, !Guaranteed::NullObject.new)
+  end
+
+  def test_as_json_returns_nil
+    assert_nil(Guaranteed::NullObject.new.as_json)
+  end
+
+  def test_to_json_returns_null
+    assert_equal("null", Guaranteed::NullObject.new.to_json)
+  end
+
+  def test_tap_returns_self
+    object = Guaranteed::NullObject.new
+    assert_equal(true, object.tap { |o| o.foo = 'bar' }.nil?)
+  end
+
+  def test_persisted_returns_false
+    assert_equal(false, Guaranteed::NullObject.new.persisted?)
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: guaranteed
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Giannis Katsanos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-25 00:00:00.000000000 Z
+dependencies: []
+description: |2
+      Guaranteed is a tiny library that ensures you always have an object to act upon.
+      It eliminates checks for your object's capabilities.
+email: giannis.katsanos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/guaranteed.rb
+- lib/guaranteed/null_object.rb
+- lib/guaranteed/version.rb
+- test/test_guaranteed.rb
+- test/test_null_object.rb
+homepage: https://github.com/gkats/guaranteed
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Make something out of nothing!
+test_files:
+- test/test_guaranteed.rb
+- test/test_null_object.rb