value_protocol 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 118ca477a99d2a6c8b2c39461ee9c14aa584f504
+  data.tar.gz: b6d79496c2979eb4b527001644270fc771e8b911
+SHA512:
+  metadata.gz: 18a9e55649e92741c7b49ff9e3a3d7a82351dd0e9013ee6857a3c0461f1c4e709a2f429be20be65469051cb4fa13c39637380fe0dfded4bdf0e72f72d72663b6
+  data.tar.gz: 54452b1627e8d3ed04fa35ef065145a770a811f16e7f335726073e16a51a0358785f4db3d0cf2e504a6b370ebba26f480a00d08f879abf9036fe0e10f23bc892

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 10Pines
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nicolas Papagna Maldonado
+
+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,67 @@
+# ValueProtocol
+
+Allows passing any object where a block is expected.  
+It is inspired by the way Smalltalk deals with the same scenario, making use of the ```#value``` message.
+
+## Motivation
+
+I wrote this gem to avoid having to wrap objects inside lambdas (and thus, avoid repeating code) when working with messages like ```:detect```.
+
+I wanted to turn this:
+
+```ruby
+numbers.detect(lambda{ 2 }) { |number| number.even? }
+```
+
+Into something like this, reducing the noise introduced by the ```lambda``` part:
+
+```ruby
+numbers.detect(2) { |number| number.even? }
+```
+
+Also, I wanted to be able to pass any object when an implicit block is expected:
+
+```ruby
+# create an instance of a complex condition
+even_numbers = EvenNumberConition.new
+numbers.select &even_numbers
+```
+
+## How does it works?
+
+Basically, it works by implementing ```:call``` (returning ```self```), and implementing ```:to_proc``` (returning a proc that evaluates ```self.call```) in ```Object```.
+
+It sound more complicated than it really is. Take a look at the [implementation](lib/value_protocol/protocol.rb) and [specs](spec/value_protocol_spec.rb)!
+
+## Usage
+
+Just pass any object where a block is expected (respecting the & operator when needed). That's all.  
+If you want to implement custom behavior, override the ```:call``` method in your class (remember to respect the signature!).
+
+For most scenarios, you won't need to override ```:to_proc```.
+
+## Feel like reading a blog post?
+
+Check this out! (TODO: add url)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'value_protocol'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install value_protocol
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/value_protocol.rb

@@ -0,0 +1,4 @@
+require 'value_protocol/version'
+require 'value_protocol/protocol'
+
+Object.send :include, ValueProtocol::Protocol

data/lib/value_protocol/protocol.rb

@@ -0,0 +1,15 @@
+module ValueProtocol
+
+  module Protocol
+
+    def call *args
+      self
+    end
+
+    def to_proc
+      proc{ |*args| self.call *args }
+    end
+
+  end
+
+end

data/lib/value_protocol/version.rb

@@ -0,0 +1,3 @@
+module ValueProtocol
+  VERSION = '0.0.1'
+end

data/spec/fruit_filter.rb

@@ -0,0 +1,11 @@
+class FruitFilter
+
+  def initialize a_fruit
+    @fruit = a_fruit
+  end
+
+  def call a_fruit
+    @fruit == a_fruit
+  end
+
+end

data/spec/method_backwards_compatibility_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe 'Method backwards compatibility' do
+
+  it 'should not override :call behavior in Method when arguments are not expected' do
+    upcase_method = 'ruby'.method :upcase
+
+    result = upcase_method.call
+
+    result.should == 'RUBY'
+  end
+
+  it 'should not override :call behavior in Method when arguments are expected' do
+    add_method = 1.method :+
+
+    result = add_method.call 1
+
+    result.should == 2
+  end
+
+  it 'should not override :to_proc behavior in Method' do
+    upcase_method = 'ruby'.method :upcase
+    to_upcase = upcase_method.to_proc
+
+    result = to_upcase.call
+
+    result.should == 'RUBY'
+  end
+
+end

data/spec/proc_backwards_compatibility_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe 'Proc backwards compatibility' do
+
+  it 'should not override :call behavior in procs when arguments are not expected' do
+    proc = Proc.new { 7 }
+
+    result = proc.call
+
+    result.should == 7
+  end
+
+  it 'should not override :call behavior in procs when arguments are expected' do
+    proc = Proc.new { |number| 1 + number }
+
+    result = proc.call 1
+
+    result.should == 2
+  end
+
+  it 'should not override :call behavior in lambdas when arguments are not expected' do
+    lambda = lambda { 7 }
+
+    result = lambda.call
+
+    result.should == 7
+  end
+
+  it 'should not override :call behavior in lambdas when arguments are expected' do
+    lambda = lambda { |number| 1 + number }
+
+    result = lambda.call 1
+
+    result.should == 2
+  end
+
+  it 'should not override :to_proc behavior in procs' do
+    proc = Proc.new {}
+
+    result = proc.to_proc
+
+    result.should == proc
+  end
+
+  it 'should not override :to_proc behavior in lambdas' do
+    lambda = lambda {}
+
+    result = lambda.to_proc
+
+    result.should == lambda
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'fruit_filter'
+require 'value_protocol'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/symbol_backwards_compatibility_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'Symbol backwards compatibility' do
+
+  it 'should not override :to_proc behavior in Symbol' do
+    to_upcase = :upcase.to_proc
+
+    result = to_upcase.call 'ruby'
+
+    result.should == 'RUBY'
+  end
+
+end

data/spec/value_protocol_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe ValueProtocol::Protocol do
+
+  let(:apple) { Object.new }
+  let(:orange) { Object.new }
+  let(:fruits) { [apple, orange] }
+
+  it 'should be possible to pass any object when an explicit block without arguments is expected' do
+    fruit = fruits.detect(apple) { |_| false }
+
+    fruit.should == apple
+  end
+
+  it 'should be possible to pass any object when an implicit block with arguments is expected' do
+    apples_only = FruitFilter.new apple
+
+    selected_fruits = fruits.select &apples_only
+
+    selected_fruits.should have(1).item
+    selected_fruits.should include apple
+  end
+
+  def evaluate_implicit_block_without_arguments &a_block
+    a_block.call
+  end
+
+  it 'should be possible to pass any object when an implicit block without arguments is expected' do
+    result = self.evaluate_implicit_block_without_arguments &apple
+
+    result.should == apple
+  end
+
+  def evaluate_explicit_block_with_arguments a_block
+    a_block.call :foo
+  end
+
+  it 'should be possible to pass any object when an explicit block with arguments is expected' do
+    result = self.evaluate_explicit_block_with_arguments apple
+
+    result.should == apple
+  end
+
+end

data/value_protocol.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'value_protocol/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'value_protocol'
+  spec.version       = ValueProtocol::VERSION
+  spec.authors       = ['Nicolas Papagna Maldonado']
+  spec.email         = ['nicolas.papagna@10pines.com']
+  spec.summary       = %q{Makes all objects polymorphic with respect to the :call message, allowing to use any objects where a block is expected.}
+  spec.description   = %q{Makes all objects polymorphic with respect to the :call message, allowing to use any objects where a block is expected.}
+  spec.homepage      = 'https://github.com/10Pines/value_protocol.git'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: value_protocol
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nicolas Papagna Maldonado
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Makes all objects polymorphic with respect to the :call message, allowing
+  to use any objects where a block is expected.
+email:
+- nicolas.papagna@10pines.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/value_protocol.rb
+- lib/value_protocol/protocol.rb
+- lib/value_protocol/version.rb
+- spec/fruit_filter.rb
+- spec/method_backwards_compatibility_spec.rb
+- spec/proc_backwards_compatibility_spec.rb
+- spec/spec_helper.rb
+- spec/symbol_backwards_compatibility_spec.rb
+- spec/value_protocol_spec.rb
+- value_protocol.gemspec
+homepage: https://github.com/10Pines/value_protocol.git
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Makes all objects polymorphic with respect to the :call message, allowing
+  to use any objects where a block is expected.
+test_files:
+- spec/fruit_filter.rb
+- spec/method_backwards_compatibility_spec.rb
+- spec/proc_backwards_compatibility_spec.rb
+- spec/spec_helper.rb
+- spec/symbol_backwards_compatibility_spec.rb
+- spec/value_protocol_spec.rb