nilable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f34025249959bb94ff93e7bbc004ae32d8359975
+  data.tar.gz: 0849a912bb235455fd8084cec523daa389758f58
+SHA512:
+  metadata.gz: 3ee7dfb2e14b1706e7931bc2e2d6ee719fb51e6436e257e3a2c30c647163a446f751c78c2fb4c8f77e822442889c9fca26d1b62c8e3e3d31c661b823151cd5ab
+  data.tar.gz: 1a0ad64a5936843b1947704495ed4181acc0fa6d3159db80ab1c7d238fd0cd8f7f997da71cef74951cbfebd50066db741fdd111e60d5ea2d69d2d860ab0fec7f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,30 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all
+people who contribute through reporting issues, posting feature requests,
+updating documentation, submitting pull requests or patches, and other
+activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual
+language or imagery, derogatory comments or personal attacks, trolling, public
+or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct. Project maintainers who do not
+follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by opening an issue or contacting one or more of the project
+maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant] version
+1.0.0, available at [http://contributor-covenant.org/version/1/0/0/].
+
+[Contributor Covenant]: http:contributor-covenant.org
+[http://contributor-covenant.org/version/1/0/0/]: http://contributor-covenant.org/version/1/0/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in none.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Genadi Samokovarov
+
+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,74 @@
+# Nilable
+
+Nilable object is a tool to handle nil invocations.
+
+Any nilable object wraps a single value object and proxy method invocations to
+it. In turn, every method result is wrapped in an nilable object.
+
+If somewhere along the call chain, a method result is `nil`, no `NoMethodError`
+will be raised and you can keep on chaining method calls. It acts as a black
+hole object.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nilable'
+```
+
+## Usage
+
+Nilable objects come to the rescue, when you're working on legacy code bases,
+where you can't avoid the nils and you have to deal with them. In fresh
+projects, you don't wanna use nilable objects, but avoid leaking the nils in
+the first place. With that out of the way, here is how you can use the nilable
+objects.
+
+Imagine a legacy system where an user has an account. There are no database
+constraints and `User#account` can always be nil. In fact, it already is in old
+production users.
+
+Every time you get to work with an user object and have to get its account, you
+have to check whether its nil. Even worse, if the account has nilable fields as
+well, you have to check them too:
+
+```ruby
+def format_currency(user)
+  if account = user.account
+    if currency = account.currency
+      currency.format
+    end
+  end
+end
+```
+
+Forget one check and you break. Forget a test and you break in production.
+
+In such hostile systems, you can use the nilable objects to save yourself all
+those checks. Wrap your hostile objects and call your methods away. If a `nil`
+happens anywhere in the call chain, another nilable object will be returned.
+When done, call `Nilable#value` to extract the value out of the nilable object.
+
+```ruby
+def format_currency(user)
+  Nilable(user.account).currency.format.value
+end
+```
+
+That's it. Wrap your hostile objects in nilable and have your newer code free
+of defensive nil checks.
+
+## Credits
+
+What I call a nilable object, is well documented in the wild as the [Option
+type]. There are many implementations of it in Ruby land, with the most popular
+of them being [Tom Stuart]'s [monads]. If you need more utils to deal with your
+nils, check it out.
+
+Where nilable shines for me, is the simple implementation. That's all I need
+for my legacy projects.
+
+[Option type]: https://en.wikipedia.org/wiki/Option_type
+[monads]: https://github.com/tomstuart/monads
+[Tom Stuart]: https://github.com/tomstuart

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task default: 'test'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nilable"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nilable.rb

@@ -0,0 +1,25 @@
+require 'nilable/kernel'
+
+# Nilable object is a tool to handle nil invocations.
+#
+# Any Nilable object wraps a single value object and proxy method
+# invocations to it. In turn, every method result is wrapped in an Nilable
+# object.
+#
+# That way, if somewhere along the call chain, method result is `nil`, no
+# `NoMethodError` will be raised. It acts as a black hole object.
+class Nilable < BasicObject
+  attr_reader :value
+
+  def initialize(object)
+    @value = object.is_a?(::Nilable) ? object.value : object
+  end
+
+  def method_missing(name, *args, &block)
+    if value
+      ::Nilable.new(value.public_send(name, *args, &block))
+    else
+      self
+    end
+  end
+end

data/lib/nilable/kernel.rb

@@ -0,0 +1,5 @@
+module Kernel
+  def Nilable(object)
+    ::Nilable.new(object)
+  end
+end

data/lib/nilable/version.rb

@@ -0,0 +1,3 @@
+class Nilable < BasicObject
+  VERSION = '1.0.0'
+end

data/nilable.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nilable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nilable"
+  spec.version       = Nilable::VERSION
+  spec.authors       = ["Genadi Samokovarov"]
+  spec.email         = ["gsamokovarov@gmail.com"]
+
+  spec.summary       = "Nilable object is a tool to handle nil invocations."
+  spec.description   = "Nilable object is a tool to handle nil invocations."
+  spec.homepage      = "https://github.com/gsamokovarov/nilable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.4"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: nilable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Genadi Samokovarov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+description: Nilable object is a tool to handle nil invocations.
+email:
+- gsamokovarov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nilable.rb
+- lib/nilable/kernel.rb
+- lib/nilable/version.rb
+- nilable.gemspec
+homepage: https://github.com/gsamokovarov/nilable
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Nilable object is a tool to handle nil invocations.
+test_files: []