cdt-utilities 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b35d92ec31a7122dd1ae13949cceef741fbf338a
-  data.tar.gz: 207f03d7041d2f356701ed17b11bf8405e07bfe4
+  metadata.gz: b4e8878b78d5eabb0daa6cffde78960045a0d1ce
+  data.tar.gz: 82254c3b751bb6545821b59124ee857ba4c586a3
 SHA512:
-  metadata.gz: 40748ace7a1a55a0328369e28b534a36c0feecec27c208340c41e019ba15a35fb5ba55efc7d806506c956e4c6edd95e74c8bd8951dedb51418077bbcc6ac4825
-  data.tar.gz: d2d5eb380260d1f30f8bcba6d8650d45b29ed8b3a5b44c05aeaa8475ed15da70ab9ea3443a5d967296485322352982b8ff75b91e5c9b1c2fb2057d5eb46b0e9b
+  metadata.gz: f691ee2fcf6446639552826ddf11d4ba6ef41fa61489c6a7678ca75fbcc077ea663c01a2a8ac854652fec08330f2e4d2c2fb2324b7bbea9768043acb4ed65c8f
+  data.tar.gz: 3ceca0564c007c4d01c3eb65625d685a22f64eb42b69e8ee6b498dad01c947e33e6087fb6001336281bef7887a9cc64f4a6a51171f29c5145b6a79a3ef629152

data/README.md

@@ -13,7 +13,7 @@ Some Ruby utilities.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'cdt-utilities', "~> 0.1"
+gem 'cdt-utilities', "~> 0.3"
 ```
 
 And then execute:
@@ -26,7 +26,7 @@ Or install it yourself as:
 
 ## Usage
 
-### CdT.bind_evaluation_of
+### CdT.bind_block_evaluation_to
 
 Utility to evaluate blocks binding `self` to an object only if the block
 does not take parameters.
@@ -43,12 +43,12 @@ require 'cdt/utilities/bind'
 
 
 # binds self to 'hello!'
-CdT.bind_evaluation_of proc { puts self }, to: 'hello!'
+CdT.bind_block_evaluation_to('hello!') { puts self }
 
 # binding to self is not changed
-CdT.bind_evaluation_of proc { |string| puts string }, to: 'hello!')
+CdT.bind_block_evaluation_to('hello!') { |string| puts string }
 
-CdT.bind_evaluation_of proc { |string, arg_1, arg_2| puts string + arg_1 + arg_2}, to: 'hello', with_args: [' world', '!'])
+CdT.bind_block_evaluation_to('hello', ' world', '!') { |string, arg_1, arg_2| puts string + arg_1 + arg_2}
 ```
 
 ### CdT.subclass_responsibility
@@ -64,9 +64,55 @@ require 'cdt/utilities'
 require 'cdt/utilities/subclass-responsibility'
 
 class SomeClass
-	def do_somehting()
-		CdT.subclass_responsibility
-	end
+   def do_somehting()
+      CdT.subclass_responsibility
+   end
+end
+```
+
+### CdT.if_nil / if_not_nil
+
+Utility to evaluate a block dependending on if an object is nil or not.
+
+Examples:
+
+```ruby
+require 'cdt/utilities'
+# or if you just want this utility
+require 'cdt/utilities/if-not-nil'
+
+CdT.if_nil(nil)   {7}      # Evaluates to 7
+CdT.if_nil(42)    {7}      # Evaluates to 42
+
+
+CdT.if_not_nil(42)   { |object| object + 1}  # Evaluates to 43
+CdT.if_not_nil(nil)  { |object| object + 1}  # Evaluates to nil
+
+# Evaluates to 43
+CdT.object 42,
+   if_not_nil: proc { |object| object + 1},
+   if_nil:     proc { 7 }
+
+CdT.object 42,
+   if_not_nil: proc { |object| object + 1},
+
+# Evaluates to 7
+CdT.object nil,
+   if_not_nil: proc { |object| object + 1},
+   if_nil:     proc { 7 }
+
+# Evaluates to 42
+CdT.object 42,
+   if_nil: proc { 7 }
+```
+
+A real world example of use is
+
+```ruby
+def customer_name(customer_id)
+   CdT.object find_customer_by_id(customer_id),
+      if_not_nil: proc { |customer| customer.name },
+      if_nil:     proc { raise "Customer with id=#{customer_id} not found." }
 end
 ```
 

data/cdt-utilities.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'cdt/utilities/version'
+require 'cdt/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "cdt-utilities"

data/lib/cdt/utilities.rb

@@ -1,3 +1,4 @@
-require_relative 'utilities/version'
+require_relative 'version'
 require_relative 'utilities/bind'
-require_relative 'utilities/subclass-responsibility'
+require_relative 'utilities/subclass-responsibility'
+require_relative 'utilities/if-not-nil'

data/lib/cdt/utilities/bind.rb

@@ -1,4 +1,13 @@
 module CdT
+	#
+	# This method is deprecated and will be removed in v1.0.0.
+	# Please use #bind_block_evaluation_to instead.
+	#
+	def self.bind_evaluation_of(block, to: nil, with_args: [])
+		warn "[DEPRECATION] `bind_evaluation_of` is deprecated and will be removed in v1.0.0.  Please use `bind_block_evaluation_to` instead."
+		bind_block_evaluation_to(to, *with_args, &block)
+	end
+
 	#
 	# Utility to evaluate blocks binding :self to an object, but only if the block
 	# does not take parameters.
@@ -6,12 +15,11 @@ module CdT
 	# the binding as it is.
 	#
 	# Example:
-	# 		CdT.bind_evaluation_of proc { puts self }, to: 'hello!' # binds self to 'hello!'
+	# 		CdT.bind_block_evaluation_to('hello!') { puts self } # binds self to 'hello!'
 	#
-	# 		CdT.bind_evaluation_of proc { |string| puts string }, to: 'hello!') # same binding
+	# 		CdT.bind_block_evaluation_to('hello!') { |string| puts string } # same binding
 	#
-	def self.bind_evaluation_of(block, to: nil, with_args: [])
-		object = to
-		block.arity == 0 ? object.instance_exec(&block) : block.call(object, *with_args)
+	def self.bind_block_evaluation_to(object, *args, &block)
+		block.arity == 0 ? object.instance_exec(&block) : block.call(object, *args)
 	end
 end

data/lib/cdt/utilities/if-not-nil.rb

@@ -0,0 +1,53 @@
+module CdT
+	#
+	# Utility to evaluate a block only if an object is nil. Otherwise answers nil.
+	#
+	# Examples:
+	# 		CdT.if_nil(nil) 	{7}  	# Evaluates to 7
+	# 		CdT.if_nil(42) 	{7}  		# Evaluates to 42
+	#
+	def self.if_nil(object, &block)
+		return block.call if object.nil?
+		object
+	end
+
+	#
+	# Utility to evaluate a block only if an object is not nil. Otherwise answers nil.
+	#
+	# Examples:
+	# 		CdT.if_not_nil(42) 	{ |object| object + 1}  # Evaluates to 43
+	# 		CdT.if_not_nil(nil) 	{ |object| object + 1}	# Evaluates to nil
+	#
+	def self.if_not_nil(object, &block)
+		return block.call(object) unless object.nil?
+		object
+	end
+
+	#
+	# Utility to evaluate a block dependending on if the object is nil or not.
+	#
+	# Examples:
+	#
+	# 		# Evaluates to 43
+	#		CdT.object 42,
+	#			if_not_nil: proc { |object| object + 1},
+	#			if_nil: 		proc { 7 }
+	#
+	#		CdT.object 42,
+	#			if_not_nil: proc { |object| object + 1},
+	#
+	# 		# Evaluates to 7
+	#		CdT.object nil,
+	#			if_not_nil: proc { |object| object + 1},
+	#			if_nil: 		proc { 7 }
+	#
+	# 		# Evaluates to 42
+	#		CdT.object 42,
+	#			if_nil: proc { 7 }
+	#
+	def self.object(object, if_nil: nil, if_not_nil: nil)
+		return if_nil(object, &if_nil) if object.nil? && !if_nil.nil?
+		return if_not_nil(object, &if_not_nil) if !object.nil? && !if_not_nil.nil?
+		object
+	end
+end

data/lib/cdt/version.rb

@@ -0,0 +1,3 @@
+module CdT
+	VERSION = "0.3.0"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cdt-utilities
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Martin Rubi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-15 00:00:00.000000000 Z
+date: 2015-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,8 +56,9 @@ files:
 - lib/cdt/errors/subclass-responsibility-error.rb
 - lib/cdt/utilities.rb
 - lib/cdt/utilities/bind.rb
+- lib/cdt/utilities/if-not-nil.rb
 - lib/cdt/utilities/subclass-responsibility.rb
-- lib/cdt/utilities/version.rb
+- lib/cdt/version.rb
 homepage: https://github.com/cabeza-de-termo/ruby-utilities
 licenses:
 - MIT
@@ -78,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby utilities. No monkey patching if possible.

data/lib/cdt/utilities/version.rb

@@ -1,3 +0,0 @@
-module CdT
-	VERSION = "0.2.0"
-end