proc_extensions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 64b24b11314915d666312d064d8b407a806d1d52
+  data.tar.gz: 8967295d202dd6760653a67212a693835a83f852
+SHA512:
+  metadata.gz: 21327da9034eb81da77ba3a00834337707d70c5a8037c2e65dc53f3354aa2c624c4c814a3290123dbfbdafc9a8281265e68238afccdea1878f1e72317a836fe8
+  data.tar.gz: 3d19d0258e4555b5de0ea378b8dd6319a8f365ff79431ce1c70e93c4624928a72ba00cd45a276294e00ddcecb6ad02fd276d1047e5bcef77e79d93f2976f59b6

data/.codeclimate.yml

@@ -0,0 +1,11 @@
+---
+engines:
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- spec/**/*

data/.gitignore

@@ -0,0 +1,6 @@
+/Gemfile.lock
+/coverage/
+/pkg/
+/tmp/
+.idea/
+*.swp

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,9 @@
+Metrics/LineLength:
+  Max: 110
+
+Style/Documentation:
+  Enabled: false
+
+AllCops:
+  Exclude:
+    - 'tmp/**/*'

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# 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, ethnicity, 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](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,4 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^lib/(.+)\.rb$})  { 'spec' }
+  watch(%r{^spec/(.+)\.rb$}) { 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Declan Whelan
+
+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,204 @@
+[![Gem Version](https://badge.fury.io/rb/proc_extensions.png)](http://badge.fury.io/rb/proc_extensions)
+[![Build Status](https://travis-ci.org/dwhelan/proc_extensions.png?branch=master)](https://travis-ci.org/dwhelan/proc_extensions)
+[![Code Climate](https://codeclimate.com/github/dwhelan/proc_extensions/badges/gpa.svg)](https://codeclimate.com/github/dwhelan/proc_extensions)
+[![Coverage Status](https://coveralls.io/repos/dwhelan/proc_extensions/badge.svg?branch=master&service=github)](https://coveralls.io/github/dwhelan/proc_extensions?branch=master)
+
+### ProcSource Class
+
+The gem includes the `ProcSource` class which provides
+access to the proc extensions without monkey patching the `Proc` class itself.
+
+You can create a `ProcSource` with either a proc as a parameter or by passing a block to `ProcSource`.
+
+```ruby
+p = proc { |a| a.to_s }
+
+
+ps1 = ProcSource.new p
+ps2 = ProcSource.new { |b| b.to_s }
+```
+
+You can use the `raw_source` method to return the original source and
+the  `source` method to return the *sanitized* version of the source.
+
+```ruby
+ps1.source     # => "proc { |a| a.to_s }"
+ps1.raw_source # => "proc { |a| a.to_s }"
+ps1.to_s       # => "proc { |a| a.to_s }"
+ps1.inspect    # => "proc { |a| a.to_s }"
+
+ps1 == ps2     # => false
+ps1.match ps2  # => true
+```
+
+# Proc Extensions
+
+Extensions to Proc support source extraction and comparison.
+
+Optionsally methods can be added to the `Proc` class:
+ * `inspect`: returns source code if it can be extracted
+ * `source`, `raw_source`: returns source code
+ * `==`: determines if two procs have exactly the same source code
+ * `match`, `=~`: determines if two procs have the source code allowing for different parameter names
+
+The above methods are not automatically included into the `Proc` class.
+You need to explicitly include modules included in this gem.
+
+**Note** This gem uses the [sourcify](https://github.com/ngty/sourcify) gem to extact proc source code. The `sourcify` gem
+is no longer supported although it works as needed for the `proc_extensions` gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'proc_extensions'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install proc_extensions
+
+## Usage
+
+```
+require proc_extensions
+```
+
+### Extensions to the Proc class
+
+#### inspect Method
+
+The `inspect` methods is added to `Proc` when `ProcExtensions::Inspect` is included with `Proc`:
+
+```ruby
+Proc.include ProcExtensions::Inspect        # Ruby 2
+Proc.send :include, ProcExtensions::Inspect # Ruby 1.9.3
+
+```
+
+The `inspect` method will return the source code for the proc.
+
+```ruby
+p = proc { |a| a.to_s }
+l = lambda { |a| a.to_s }
+
+p.inspect # => "proc { |a| a.to_s }"
+l.inspect # => "lambda { |a| a.to_s }"
+```
+
+If the source code cannot be extracted then the original `Proc#inspect` method will be called:
+
+```ruby
+# Can't get source if multiple procs declared on the same line
+p = proc { proc {} }
+p.inspect # => "#<Proc:0x007fe72b879b90>"
+```
+
+#### source Methods
+
+The `source` and `raw_source` methods are added to `Proc` when `ProcExtensions::Source` is included with `Proc`:
+
+```ruby
+Proc.include ProcExtensions::Source        # Ruby 2
+Proc.send :include, ProcExtensions::Source # Ruby 1.9.3
+```
+
+The `Proc#source` method will return the source code for the Proc with
+white space and comments removed. The `raw_source` method will return the original source.
+
+```ruby
+p = proc { | a |  a.to_s  }
+p.source # "proc { |a| a.to_s }"
+p.raw_source # "proc { | a |  a.to_s  }"
+```
+Lambda source will have the prefix 'lambda' rather than 'proc':
+
+```ruby
+l = lambda { |a| a.to_s }
+l.source # "lambda { |a| a.to_s }"
+```
+
+If the source cannot be extracted then an exception will be raised by the `sourcify` gem.
+
+#### match Methods
+
+The `match` and `=~` methods are added to `Proc` when `ProcExtensions::Match` is included with `Proc`:
+
+```ruby
+Proc.include ProcExtensions::Match        # Ruby 2
+Proc.send :include, ProcExtensions::Match # Ruby 1.9.3
+```
+
+The `match(other)` method will return `true` if the procs are the same proc or
+if the two procs have the same source code. The `=~` method is created as an alias for `match`.
+
+```ruby
+proc1 = proc {}
+proc2 = proc {}
+proc3 = proc { |a| a.to_s }
+
+proc1.match(proc2) # => true
+proc1.match(proc3) # => false
+
+proc1 =~ proc2     # => true
+proc1 =~ proc3     # => false
+```
+
+The source code for two procs are considered equal if they have the same body
+even with different parameter names:
+
+```ruby
+proc1 = proc { |a| a.to_s }
+proc2 = proc { |b| b.to_s }
+
+proc1.match(proc2) # => true
+```
+
+If the procs are created via `&:method` then they will
+be considered equal if they reference the same method:
+
+```ruby
+proc1 = proc(&:to_s)
+proc2 = proc(&:to_s)
+proc3 = proc(&:to_a)
+
+proc1.match(proc2) # => true
+proc1.match(proc3) # => false
+```
+
+If the source code cannot be extracted from either proc then `false` will be returned:
+
+```ruby
+# Can't get source if multiple procs declared on the same line
+proc1 = proc { proc {} }
+proc2 = proc { proc {} }
+
+proc1.match(proc2) # => false
+```
+
+## Ruby Versions Supported
+
+* 1.9.3
+* 2.0
+* 2.1
+* 2.2
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dwhelan/proc_extensions.
+This project is intended to be a safe, welcoming space for collaboration, 
+and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) 
+code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new do |task|
+  task.options << '--display-cop-names'
+end
+
+task default: [:spec, :rubocop, :build]

data/lib/core_extensions/proc/inspect.rb

@@ -0,0 +1,14 @@
+module ProcExtensions
+  module Inspect
+    def self.included(base)
+      base.class_eval do
+        # rubocop:disable Lint/NestedMethodDefinition
+        def inspect
+          ProcSource.new(self).inspect
+        rescue
+          super
+        end
+      end
+    end
+  end
+end

data/lib/core_extensions/proc/match.rb

@@ -0,0 +1,14 @@
+module ProcExtensions
+  module Match
+    def self.included(base)
+      base.class_eval do
+        # rubocop:disable Lint/NestedMethodDefinition
+        def match(other)
+          ProcSource.new(other) == ProcSource.new(self)
+        end
+
+        alias_method :=~, :match
+      end
+    end
+  end
+end

data/lib/core_extensions/proc/source.rb

@@ -0,0 +1,16 @@
+module ProcExtensions
+  module Source
+    def self.included(base)
+      base.class_eval do
+        # rubocop:disable Lint/NestedMethodDefinition
+        def source
+          ProcSource.new(self).source
+        end
+
+        def raw_source
+          ProcSource.new(self).raw_source
+        end
+      end
+    end
+  end
+end

data/lib/proc_extensions/proc_source.rb

@@ -0,0 +1,93 @@
+require 'sourcify'
+require 'forwardable'
+
+class ProcSource
+  extend Forwardable
+
+  SOURCIFY_ERRORS = [
+    Sourcify::MultipleMatchingProcsPerLineError,
+    Sourcify::CannotParseEvalCodeError,
+    Sourcify::CannotHandleCreatedOnTheFlyProcError
+  ]
+
+  def initialize(proc = nil, &block)
+    if proc
+      fail ArgumentError, 'cannot pass both an argument and a block' if block
+      fail ArgumentError, 'argument must be a Proc'                  unless proc.is_a?(Proc)
+    end
+
+    @proc = proc || block
+  end
+
+  def ==(other)
+    case
+    when other.proc == proc
+      true
+    when other.arity != arity || other.lambda? != lambda?
+      false
+    else
+      other.sexp == sexp
+    end
+  rescue *SOURCIFY_ERRORS
+    false
+  end
+
+  def match(other)
+    self == other || source_equal(other)
+  rescue *SOURCIFY_ERRORS
+    false
+  end
+
+  alias_method :=~, :match
+
+  def raw_source
+    extract_source(:to_raw_source)
+  end
+
+  def source
+    extract_source(:to_source)
+  end
+
+  def to_s
+    source
+  rescue *SOURCIFY_ERRORS
+    super
+  end
+
+  alias_method :inspect, :to_s
+
+  protected
+
+  attr_reader :proc
+
+  def_delegators :proc, :arity, :lambda?
+  def_delegators :sexp, :sexp_body, :count
+
+  def sexp
+    @sexp ||= proc.to_sexp
+  end
+
+  def parameters
+    sexp[2].sexp_body.to_a
+  end
+
+  def source_equal(other)
+    other.count == count && other.lambda? == lambda? && other.sexp == sexp_with_parameters_from(other)
+  end
+
+  private
+
+  def sexp_with_parameters_from(other_proc)
+    new_sexp = sexp.sub(sexp[2], other_proc.sexp[2])
+    other_proc.parameters.each_with_index do |to, index|
+      from = parameters[index]
+      new_sexp = new_sexp.gsub(s(:lvar, from), s(:lvar, to))
+    end
+    new_sexp
+  end
+
+  def extract_source(method)
+    proc_source = proc.public_send(method)
+    lambda? ? proc_source.sub('proc ', 'lambda ') : proc_source
+  end
+end

data/lib/proc_extensions/version.rb

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

data/lib/proc_extensions.rb

@@ -0,0 +1,6 @@
+require_relative 'proc_extensions/version'
+require_relative 'proc_extensions/proc_source'
+
+require_relative 'core_extensions/proc/inspect'
+require_relative 'core_extensions/proc/match'
+require_relative 'core_extensions/proc/source'

data/proc_extensions.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'proc_extensions/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'proc_extensions'
+  gem.version       = ProcExtensions::VERSION
+  gem.authors       = ['Declan Whelan']
+  gem.email         = ['dwhelan@leanintuit.com']
+
+  gem.summary       = 'Extensions to the Proc class to support source extraction and comparison.'
+  gem.description   = 'Extensions to the Proc class to support source extraction and comparison.'
+  gem.homepage      = 'https://github.com/dwhelan/proc_extensions'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'sourcify', '~> 0.5'
+
+  gem.add_development_dependency 'bundler',     '~>  1.10'
+  gem.add_development_dependency 'coveralls',   '~>  0.7'
+  gem.add_development_dependency 'guard',       '~>  2.13'
+  gem.add_development_dependency 'guard-rspec', '~>  4.6'
+
+  if RUBY_VERSION =~ /2/
+    gem.add_development_dependency 'pry-byebug', '~> 3.3'
+  else
+    gem.add_development_dependency 'pry-debugger', '~> 0.2'
+  end
+
+  gem.add_development_dependency 'rake',        '~> 10.0'
+  gem.add_development_dependency 'rspec',       '~>  3.0'
+  gem.add_development_dependency 'rspec-its',   '~>  1.1'
+  gem.add_development_dependency 'rubocop',     '~>  0.30'
+  gem.add_development_dependency 'simplecov',   '~>  0.9'
+end

metadata

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification
+name: proc_extensions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Declan Whelan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sourcify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Extensions to the Proc class to support source extraction and comparison.
+email:
+- dwhelan@leanintuit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/core_extensions/proc/inspect.rb
+- lib/core_extensions/proc/match.rb
+- lib/core_extensions/proc/source.rb
+- lib/proc_extensions.rb
+- lib/proc_extensions/proc_source.rb
+- lib/proc_extensions/version.rb
+- proc_extensions.gemspec
+homepage: https://github.com/dwhelan/proc_extensions
+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.6
+signing_key: 
+specification_version: 4
+summary: Extensions to the Proc class to support source extraction and comparison.
+test_files: []