callable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ef39ede893ce0a86d29f34da19b77b7b2850090
+  data.tar.gz: d05ad76db5f5914b825e8c23f2a4b6453c598c33
+SHA512:
+  metadata.gz: 00df6afe990ba3facb4d54ac73fb9ee4057086db2546afaba496eec83181ef7147e89b84a9691873357fab4f30adaa6a18ee3db371353618017879be35d0bde6
+  data.tar.gz: 7ed99cd5b51200dbce8bd34192272af15bf7c7b9c627eb661f6647f6d8145a48ba31a6516c11e89bc3d1fb475a230a1517faeae890df41bf875a3be455c4f139

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+gemspec 
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Federico Iachetti
+
+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,180 @@
+# Callable
+
+Create callable objects on the fly.
+
+It's easy to create a calable object in Ruby (understandong callable
+as an object that supports the call method), you just wrap it in a
+lambda and that's it. 
+
+Although this approach is correct, it lucks some expresiveness. Wouldn't it
+be better to just say:
+
+```ruby
+Callable( :i_wasnt_callable_but_i_am_now )
+```
+
+This line of code tells you exacly what it's doing.
+
+This gem allows you to do exactly that (see Usage)
+
+
+## Usage
+
+If you need to return a callable object for some reason, you can do it
+in one of two ways (don't forget to install the gem first).
+
+The first way is by invoking the callable method:
+
+```ruby
+c = Callable( :ret_val )
+c.call
+=> ret_val
+```
+
+Take into account that if you pass a callable object (such as a
+lambda), you'll get it back as the return value:
+
+```ruby
+c = Callable( ->{ :ret_val } )
+c.call
+=> ret_val
+```
+
+The second way to use it is invoking the #callable directly on the object you
+want to be callable:
+
+```ruby
+c = :ret_val.callable
+c.call
+=> ret_val
+```
+
+Like the example before, lambda, you'll get it back as the return value:
+
+```ruby
+c = ->{ :ret_val }.callable
+c.call
+=> ret_val
+```
+
+The gem also ships with a #callable? method thar returns true if the
+object is callable and false if it's not.
+
+```ruby
+:not_callable.callable?
+=> false
+->{ :not_callable }.callable?
+=> true
+```
+
+This is the same as saying
+
+```ruby
+xxx.respond_to? :call
+```
+
+But I felt it would be more illustrative of it's purpose.
+
+## Where to use it?
+
+Let me say where to use this gem (with a very
+trivial example).
+
+Imagine we have some class that admits an informer object that
+responds to the get_info method and returns a some information on a
+String.
+
+```ruby
+class SomeClass
+  attr_writer :informer
+  def info
+    @informer.get_info
+  end
+end
+```
+
+If we want to use this "informer" object, we must define a new class
+or module that responds to the "get_info" method.
+
+When we have a case like this, is a common practice to name that
+method "call", instead of "get_info", because we now can toss a simple
+lambda to substitute it. We can rewrite the code above like this:
+
+```ruby
+class SomeClass
+  attr_writer :informer
+  def info
+    @informer.call
+  end
+end
+```
+
+And now we can define a class or module that responds to the call
+method. In that call method, we can get as fancy as we want:
+
+```ruby
+module Informer
+  def call
+    # retrieve the information we need from wherever we want
+    # maybe a web service
+    # maybe a local file
+  end
+end
+```
+
+So, when we do:
+
+```ruby
+  something = SomeClass.new
+  something.informer = Informer
+  something.info
+```
+
+We trigger some weird and complex logic.
+
+But when we test our code (or in some special case), we need that
+logic to be as simple (an decoupled) as it can get. 
+
+Say we now want info to return just a fixed string saying "No info
+available". With a lambda is fairly easy to do it
+
+```ruby
+  something = SomeClass.new
+  something.informer = ->{ "No info available" }
+  something.info
+```
+
+Here is where the Callable gem comes in handy, we could say the same
+thing like this:
+
+```ruby
+  something = SomeClass.new
+  something.informer = Callable "No info available" 
+  something.info
+```
+
+And now is much more expressive.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'callable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install callable
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/callable/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

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+require "matest/spec_tasks"

data/callable.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'callable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "callable"
+  spec.version       = Callable::VERSION
+  spec.authors       = ["Federico Iachetti"]
+  spec.email         = ["iachetti.federico@gmail.com"]
+  spec.summary       = %q{It allows you to define callable objects.}
+  spec.description   = %q{It makes available the callable, Callable and callable? methods that allows you to make callable objects and know if an object can be called.}
+  spec.homepage      = ""
+  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.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "matest", "~> 1.5"
+end

data/lib/callable.rb

@@ -0,0 +1,5 @@
+require "callable/version"
+
+module Callable
+  # Your code goes here...
+end

data/lib/callable/version.rb

@@ -0,0 +1,3 @@
+module Callable
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: callable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Federico Iachetti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: matest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: It makes available the callable, Callable and callable? methods that
+  allows you to make callable objects and know if an object can be called.
+email:
+- iachetti.federico@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- callable.gemspec
+- lib/callable.rb
+- lib/callable/version.rb
+homepage: ''
+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: It allows you to define callable objects.
+test_files: []