ruby-overload 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 245e0e2cad16c3f0bdb7d0d772adac2b3f1a33297b44e28eab5b980970f6797e
+  data.tar.gz: 89b475ad0da4d5af3a0b0cdc9884c3dd95503d01063d494ba1437d154add7cc6
+SHA512:
+  metadata.gz: b80121742f6486d36526077f24b56203784b4ee06f8eb22da61dd5eb40d078d93af9aeaf088d38d10e38a0eb3edc4162ae6edc2b80be4a75bb2d6ab9be39b133
+  data.tar.gz: 0dd581b7b939715877185ea8aa33d9ed1032dc3a397e4fe6e6f2ed5bacaf84ca813e476eb33a28828ba5efbcc0264ff39b0ade1aa5eef99c30d9090432747ae0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.1.0 (07/25/2020)
+
+* Initial public release - [@jodosha](https://github.com/jodosha), [@baweaver](https://gist.github.com/baweaver), [@dblock](https://github.com/dblock).

data/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing to Ruby-Overload
+
+This project is work of [many contributors](https://github.com/dblock/ruby-overload/graphs/contributors).
+
+You're encouraged to submit [pull requests](https://github.com/dblock/ruby-overload/pulls), [propose features and discuss issues](https://github.com/dblock/ruby-overload/issues).
+
+In the examples below, substitute your Github username for `contributor` in URLs.
+
+### Fork the Project
+
+Fork the [project on Github](https://github.com/dblock/ruby-overload) and check out your copy.
+
+```
+git clone https://github.com/contributor/ruby-overload.git
+cd ruby-overload
+git remote add upstream https://github.com/dblock/ruby-overload.git
+```
+
+### Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+## Contribute Code
+
+### Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+### Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add tests to [spec](spec).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+### Write Code
+
+Implement your feature or bug fix.
+
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop). Run `bundle exec rubocop` and fix any style issues highlighted, auto-correct issues when possible with `bundle exec rubocop -a`. To silence generally ingored issues, including line lengths or code complexity metrics, run `bundle exec rubocop --auto-gen-config`.
+
+Make sure that `bundle exec rake` completes without errors.
+
+### Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+### Update Changelog
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*. Don't remove *Your contribution here*.
+
+Make it look like every other line, including a link to the issue being fixed, your name and link to your Github account.
+
+### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+### Push
+
+```
+git push origin my-feature-branch
+```
+
+### Make a Pull Request
+
+Go to https://github.com/contributor/ruby-overload and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+### Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/dblock/ruby-overload/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+### Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+### Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+## Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
+
+gemspec
+
+gem 'rake'
+
+group :development, :test do
+  gem 'benchmark-ips'
+  gem 'rspec', '~> 3.0'
+  gem 'rubocop', '0.88.0'
+end

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    ruby-overload (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ast (2.4.1)
+    benchmark-ips (2.8.2)
+    diff-lcs (1.3)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.88.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.2.0)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  benchmark-ips
+  rake
+  rspec (~> 3.0)
+  rubocop (= 0.88.0)
+  ruby-overload!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2020 Luca Guidi, Brandon Weaver, Daniel Doubrovkine and contributors.
+
+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,47 @@
+Ruby::Overload
+==========
+
+[![Gem Version](http://img.shields.io/gem/v/ruby-overload.svg)](http://badge.fury.io/rb/ruby-overload)
+[![Build Status](https://travis-ci.org/dblock/ruby-overload.svg?branch=master)](https://travis-ci.org/dblock/ruby-overload)
+
+Runtime method overloading behavior for Ruby from [this blog post](https://lucaguidi.com/2020/07/22/ruby-method-overloading/) by [@jodosha](https://www.github.com/jodosha). Incorporates changes from [ptolemybarnes/overlord](https://github.com/ptolemybarnes/overlord), performance improvements from [baweaver@](https://gist.github.com/jodosha/e3097ed693e9b7c255b658ac39c2e403#gistcomment-3388594), and other ideas from [this tweet](https://twitter.com/jodosha/status/1285850349845254144).
+
+## Disclaimer
+
+The original author of this idea, Luca Guidi, [does not recommend](https://twitter.com/jodosha/status/1285941282381139969) using this in production, but YOLO.
+
+## Usage
+
+```ruby
+require 'ruby-overload'
+
+class Foo
+  include Ruby::Overload
+
+  def call
+    puts "foo"
+  end
+
+  def call(arg)
+    puts "foo #{arg}"
+  end
+end
+
+foo = Foo.new
+foo.call # => "foo"
+foo.call(23) # => "foo 23"
+```
+
+## Contributing
+
+You're encouraged to contribute to this gem. See [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+## Copyright and License
+
+Copyright (c) 2020, Luca Guidi, Brandon Weaver, Daniel Doubrovkine and [Contributors](CHANGELOG.md).
+
+This project is licensed under the [MIT License](LICENSE.md).
+
+## Similar Projects
+
+* [overloader](https://github.com/pocke/overloader)

data/RELEASING.md

@@ -0,0 +1,60 @@
+# Releasing Ruby-Overload
+
+There are no hard rules about when to release ruby-overload. Release bug fixes frequently, features not so frequently and breaking API changes rarely.
+
+### Release
+
+Run tests, check that all tests succeed locally.
+
+```
+bundle install
+rake
+```
+
+Check that the last build succeeded in [Travis CI](https://travis-ci.org/dblock/ruby-overload) for all supported platforms.
+
+Add a date to this release in [CHANGELOG.md](CHANGELOG.md).
+
+```
+### 0.2.2 (2015/7/10)
+```
+
+Remove the line with "Your contribution here.", since there will be no more contributions to this release.
+
+Commit your changes.
+
+```
+git add README.md CHANGELOG.md lib/ruby-overload/version.rb
+git commit -m "Preparing for release, 0.2.2."
+```
+
+Release.
+
+```
+$ rake release
+
+ruby-overload 0.2.2 built to pkg/ruby-overload-0.2.2.gem.
+Tagged v0.2.2.
+Pushed git commits and tags.
+Pushed ruby-overload 0.2.2 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```
+### 0.2.3 (Next)
+
+* Your contribution here.
+```
+
+Increment the third version number in [lib/ruby-overload/version.rb](lib/ruby-overload/version.rb).
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/ruby-overload/version.rb
+git commit -m "Preparing for next development iteration, 0.2.3."
+git push origin master
+```

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler/gem_tasks'
+
+Bundler.setup :default, :development
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[rubocop spec]

data/benchmarks/overload.rb

@@ -0,0 +1,29 @@
+require 'benchmark/ips'
+require 'ruby-overload'
+
+class Foo
+  include Ruby::Overload
+
+  def call(number)
+    "foo #{number}"
+  end
+
+  def call
+    'foo 42'
+  end
+end
+
+class Bar
+  def call(number)
+    "bar #{number}"
+  end
+end
+
+foo = Foo.new
+bar = Bar.new
+
+Benchmark.ips do |x|
+  x.report('method overloading') { foo.call(23) }
+  x.report('method') { bar.call(23) }
+  x.compare!
+end

data/lib/ruby-overload.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'ruby-overload/version'
+require 'ruby-overload/overload'

data/lib/ruby-overload/overload.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Ruby
+  module Overload
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def method_added(method_name)
+        if @_recurse_catch
+          @_recurse_catch = nil
+          return
+        end
+
+        original_method = instance_method(method_name)
+
+        @_matches ||= Hash.new { |h, k| h[k] = {} }
+        @_matches[method_name][original_method.arity] = original_method
+        undef_method method_name
+
+        # Prevent recursive calls to method_added if we're doing it
+        # intentionally here.
+        @_recurse_catch = true
+
+        # Localize for closure
+        method_matches = @_matches[method_name]
+
+        if @_methods && @_methods[method_name]
+          define_method(method_name, @_methods[method_name])
+        else
+          define_method(method_name) do |*as|
+            method_matches[as.size].bind(self).call(*as)
+          end
+
+          @_methods ||= {}
+          @_methods[method_name] = instance_method(method_name)
+        end
+      end
+    end
+
+    def method_missing(method_name, *args, &blk)
+      super unless self.class.respond_to_matching?(method_name, *args, &blk)
+
+      self.class.matched_call(self, method_name, *args, &blk)
+    end
+
+    def respond_to_missing?(method_name, *)
+      self.class.respond_to_method?(method_name)
+    end
+  end
+end

data/lib/ruby-overload/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ruby
+  module Overload
+    VERSION = '0.1.0'
+  end
+end

data/lib/ruby_overload.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'ruby-overload'

data/ruby-overloard.gemspec

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'ruby-overload/version'
+
+Gem::Specification.new do |s|
+  s.name = 'ruby-overload'
+  s.version = Ruby::Overload::VERSION
+  s.authors = ['Luca Guidi', 'Brandon Weaver', 'Daniel Doubrovkine']
+  s.email = 'dblock@dblock.org'
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 2.4'
+  s.required_rubygems_version = '>= 1.3.6'
+  s.files = Dir['**/*']
+  s.require_paths = ['lib']
+  s.homepage = 'http://github.com/dblock/ruby-overload'
+  s.licenses = ['MIT']
+  s.summary = 'Method overload behavior for Ruby.'
+end

data/spec/ruby-overload/overload_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Ruby::Overload do
+  let(:klass) do
+    Class.new do
+      include Ruby::Overload
+
+      def call
+        nil
+      end
+
+      def call(arg)
+        arg
+      end
+
+      def call(first, second)
+        [first, second]
+      end
+    end
+  end
+  subject do
+    klass.new
+  end
+  it 'matches on a method with no arguments' do
+    expect(subject.call).to be nil
+  end
+  it 'matches on methods with one argument' do
+    expect(subject.call(1)).to eq 1
+  end
+  it 'matches on methods with two arguments' do
+    expect(subject.call(%w[a b])).to eq(%w[a b])
+  end
+  it 'raises undefined method when method is not defined' do
+    expect { subject.call 1, 2, 3 }.to raise_error NoMethodError
+  end
+end

data/spec/ruby-overload/version_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Ruby::Overload do
+  it 'has a version' do
+    expect(Ruby::Overload::VERSION).not_to be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'rspec'
+require 'ruby-overload'
+
+RSpec.configure(&:raise_errors_for_deprecations!)

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: ruby-overload
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Luca Guidi
+- Brandon Weaver
+- Daniel Doubrovkine
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-07-25 00:00:00.000000000 Z
+dependencies: []
+description:
+email: dblock@dblock.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- RELEASING.md
+- Rakefile
+- benchmarks/overload.rb
+- lib/ruby-overload.rb
+- lib/ruby-overload/overload.rb
+- lib/ruby-overload/version.rb
+- lib/ruby_overload.rb
+- pkg/ruby-enum-0.8.0.gem
+- ruby-overloard.gemspec
+- spec/ruby-overload/overload_spec.rb
+- spec/ruby-overload/version_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/dblock/ruby-overload
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Method overload behavior for Ruby.
+test_files: []