patme 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f270e55081adb2c27a467a59a88dcce06996a14f
+  data.tar.gz: 5fb92273c02545651cb7b0b2033c61c5f87c7f6a
+SHA512:
+  metadata.gz: 60c5a51bb417bf20fe806040ab9f1e14428e4aa57021f134ddc007154fc69b955856aa97942abdf18fb6619fff21def8161f91fbaaf62e310ffe4ca846bcf184
+  data.tar.gz: 8d5b443bab40c29f57b1982931f0827d1a53227e9824b9fbcbf3b2606f3883480d9b48390691312d61f729abb162d65f488dbc895406a13c7b6827aada0c52ef

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# built gems
+*.gem

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.10
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
+before_install: gem update bundler

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 vizvamitra
+
+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,229 @@
+# Patme
+
+[![Build Status](https://travis-ci.org/vizvamitra/patme.svg?branch=master)](https://travis-ci.org/vizvamitra/patme)
+
+This gem is my experiment on elixir-style pattern matching in ruby.
+
+The implementation is neither production-ready, nor complete. It is just a proof of concept.
+
+## Info
+
+Patme module stores your instance methods internally and removes them from your class. Then, when method is called, it tries to pattern-match given arguments with existing method implementations. If implementation was found, it executes it, othervise you'll get a NoMethodError.
+
+Currently this gem supports 3 types of arguments: specific, arbitrary and optional. In method definition `def foo(agr1, arg2=1, _arg3=false)` arg1 is an arbitrary argument, arg2 is specific and arg3 is optional.
+
+Patme supports class-based pattern matching. If method's specific argument is a `Class`, then it will be matched based on given argument's class using `is_a?`
+
+
+## Limitations
+
+Only pattern matching on instance methods is supported. Also you must use parentheses around method arguments.
+
+
+## Usage
+
+#### Recursion example
+
+```ruby
+require 'patme'
+
+class Factorial
+  include Patme::PatternMatching
+
+  def calculate(n=0)
+    1
+  end
+
+  def calculate(n)
+    n * self.of(n-1)
+  end
+end
+
+factorial_calculator = Factorial.new
+
+factorial_calculator.calculate(0) # => 1
+factorial_calculator.calculate(5) # => 120
+factorial_calculator.calculate(-1) # => endless recursion, don't do so ^_^
+```
+
+
+#### Class-based pattern matching
+
+```ruby
+require 'parme'
+
+SeriousError = Class.new(StandardError)
+RegularError = Class.new(StandardError)
+UnexpectedError = Class.new(StandardError)
+
+class ErrorHandler
+  include Patme::PatternMatching
+
+  def initialize(error)
+    @error = error
+  end
+
+  def handle
+    do_handle(@error)
+  end
+
+  # Will match if error.is_a?(SeriousError)
+  def do_handle(error=SeriousError)
+    puts "Alarm! SeriousError! Details: #{error.message}"
+  end
+
+  # Will match if error.is_a?(RegularError)
+  def do_handle(error=RegularError)
+    puts "Don't worry, just a RegularError: #{error.message}"
+  end
+
+  # Will match for all other StandardErrors
+  def do_handle(error=StandardError)
+    puts "Unexpected error: #{error.class}. Details: #{error.message}"
+  end
+end
+
+begin
+  raise SeriousError, 'boom!'
+rescue => error
+  ErrorHandler.new(error).handle
+end
+# => Alarm! SeriousError! Details: boom!
+
+begin
+  raise RegularError, 'we need to fix this'
+rescue => error
+  ErrorHandler.new(error).handle
+end
+# => Don't worry, just a RegularError: we need to fix this
+
+begin
+  raise UnexpectedError, 'something went completely wrong'
+rescue => error
+  ErrorHandler.new(error).handle
+end
+# => Unexpected error: UnexpectedError. Details: something went completely wrong
+```
+
+
+#### Full-featured example
+
+```ruby
+require 'patme'
+
+class MyClass
+  include Patme::PatternMatching
+
+  # This method will match only when arg1  ='test'
+  def foo(arg1='test')
+    "runned foo('test') with #{arg1}"
+  end
+
+  # Will match only when arg1  ='other'
+  def foo(arg1='other')
+    "runned foo('other') with #{arg1}"
+  end
+
+  # You can also use other basic types
+  def foo(arg1={a: 1, b: 2})
+    "runned foo({a: 1, b: 2}) with #{arg1}"
+  end
+
+  # Will match when arg2 = 'test' no matter what arg1 is
+  def foo(arg1, arg2='test')
+    "runned foo(any, 'test') with [#{arg1}, #{arg2}]"
+  end
+
+  # Will match with any arg1 and both with and without arg2
+  # if arg2 is not supplied, method will receive arg2 = 'default'
+  def foo(arg1, _arg2="default")
+    "runned foo(any, optional) with [#{arg1}, #{_arg2}]"
+  end
+
+
+  # Will match with any one argument.
+  def bar(arg1)
+    "runned bar(any) with #{arg1}"
+  end
+
+  # Won't ever match because previous definition of bar will be pattern-matched
+  # before this one
+  def bar(arg1='never')
+    "runned bar('never') with #{arg1}"
+  end
+
+
+  def baz(arg1='test')
+    "runned baz('test') with #{arg1}"
+  end
+end
+
+my_obj = MyClass.new
+
+my_obj.foo('test') # => "runned foo('test') with test"
+my_obj.foo('other') # => "runned foo('other') with other"
+my_obj.foo({a: 1, b: 2}) # => "runned foo({a: 1, b: 2}) with {:a => 1, :b => 2}"
+my_obj.foo(1, 'test') # => "runned foo(any, 'test') with [1, test]"
+my_obj.foo(1) # => "runned foo(any, optional) with [1, default]"
+my_obj.foo(1, 'some') # => "runned foo(any, optional) with [1, some]"
+
+my_obj.bar(1) # => "runned bar(any) with 1"
+my_obj.bar('never') # => "runned bar(any) with never"
+
+my_obj.baz('test') # => "runned baz('test') with test"
+my_obj.baz(1) # => NoMethodError
+```
+
+
+## Todos
+
+1. Add support for keyword arguments (`key:` - arbitrary, `key: value` - specific, `_key: value` - optional)
+2. Add support for class methods
+3. Add something to tell Parme not to pattern-match on given methods
+
+    ```ruby
+    # Possible example
+    class Hello
+      include Parme::PatternMatching
+
+      # Comment after method header will tell Parme not to touch this method
+      def tell(name) # ::pm_off
+        puts "Hello, #{name}"
+      end
+    end
+    ```
+
+4. Add support for method headers without parentheses
+5. Add watchers
+
+    ```ruby
+    # Possible example
+    class Factorial
+      include Patme::PatternMatch
+
+      def calculate(n=0)
+        1
+      end
+
+      def calculate(n) # ::when( n < 0 )
+        raise ArgumentError, "Can't calculate factorial of a negative number: #{n}"
+      end
+
+      def calculate(n) # ::when( n > 0 )
+        n * self.of(n-1)
+      end
+    end
+    ```
+
+6. Your suggestions?
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vizvamitra/patme.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "patme"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/patme/arguments/arbitrary.rb

@@ -0,0 +1,20 @@
+module Patme
+  module Arguments
+    class Arbitrary
+      def initialize(_value=nil)
+      end
+
+      def get_value(given=nil)
+        given
+      end
+
+      def ==(other)
+        true
+      end
+
+      def any?; true; end
+      def optional?; false; end
+      def specific?; false; end
+    end
+  end
+end

data/lib/patme/arguments/optional.rb

@@ -0,0 +1,22 @@
+module Patme
+  module Arguments
+    class Optional
+      def initialize(default_value)
+        @default_value = default_value
+      end
+
+      # *given is an array to distinguish cases with no value or nil
+      def get_value(*given)
+        given.size == 1 ? given[0] : @default_value
+      end
+
+      def ==(other)
+        true
+      end
+
+      def any?; false; end
+      def optional?; true; end
+      def specific?; false; end
+    end
+  end
+end

data/lib/patme/arguments/specific.rb

@@ -0,0 +1,21 @@
+module Patme
+  module Arguments
+    class Specific
+      def initialize(value)
+        @value = value
+      end
+
+      def get_value(given)
+        given
+      end
+
+      def ==(other)
+        @value.is_a?(Class) ? other.is_a?(@value) : @value == other
+      end
+
+      def any?; false; end
+      def optional?; false; end
+      def specific?; true; end
+    end
+  end
+end

data/lib/patme/implementation.rb

@@ -0,0 +1,21 @@
+module Patme
+  class Implementation
+
+    def initialize(method_obj, args)
+      @method_proc = method_obj
+      @args = args
+    end
+
+    def match?(given_args)
+      required_args = @args.reject(&:optional?)
+
+      (required_args.size..@args.size).cover?(given_args.size)\
+        && required_args == given_args.first(required_args.size)
+    end
+
+    def call(object, args)
+      @method_proc.bind(object).call(*args)
+    end
+
+  end
+end

data/lib/patme/implementation_builder.rb

@@ -0,0 +1,61 @@
+module Patme
+
+  # Gets method's header (for example, def foo(arg1, arg2='spec', _arg3='opt') )
+  # parses it and creates method implementation with the following arguments:
+  #    arg1 - any argument
+  #    arg2 - specific argument, 'spec'
+  #   _arg3 - optional argument which defaults to 'opt'
+  class ImplementationBuilder
+    def initialize(method_obj)
+      @method_obj = method_obj
+    end
+
+    def build
+      values = get_values(method_header, method_params)
+      args = build_args(method_params, values)
+
+      Patme::Implementation.new(@method_obj, args)
+    end
+
+    private
+
+    def get_values(header, params)
+      return {} if params.size == 0
+
+      regex_str = params.map do |type, name|
+        case type
+        when :opt then "#{name}=(?<#{name}>.+)"
+        when :req
+          name =~ /^_/ ? "#{name}=(?<#{name}>.+)" : "#{name}"
+        end
+      end.join(', ') + '\s*\)\s*$'
+
+      match_data = header.match( Regexp.new(regex_str) )
+      match_data.names.map do |name|
+        [name.to_sym, eval(match_data[name.to_s])]
+      end.to_h
+    end
+
+    def method_header
+      path, line = @method_obj.source_location
+      File.read(path).split("\n")[line - 1]
+    end
+
+    def method_params
+      @method_obj.parameters
+    end
+
+    def build_args(params, values)
+      return [] if params.size == 0
+
+      params.map do |type, name|
+        case type
+        when :opt
+          (name =~ /^_/ ? Arguments::Optional : Arguments::Specific).new(values[name])
+        when :req then Arguments::Arbitrary.new
+        end
+      end
+    end
+  end
+
+end

data/lib/patme/method.rb

@@ -0,0 +1,22 @@
+module Patme
+  class Method
+
+    def initialize(name)
+      @name = name
+      @implementations = []
+    end
+
+    def add_implementation(implementation)
+      @implementations << implementation
+    end
+
+    def implemented_for?(args)
+      @implementations.any?{|i| i.match?(args)}
+    end
+
+    def call(object, args)
+      @implementations.find{|i| i.match?(args)}.call(object, args)
+    end
+
+  end
+end

data/lib/patme/pattern_matching.rb

@@ -0,0 +1,38 @@
+module Patme
+
+  module PatternMatching
+    def self.included(klass)
+      klass.include(InstanceMethods)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def method_added(name)
+        @patme_methods ||= {}
+        @patme_methods[name] ||= Patme::Method.new(name)
+
+        method_obj = self.instance_method(name)
+        impl = Patme::ImplementationBuilder.new(method_obj).build
+        @patme_methods[name].add_implementation(impl)
+
+        undef_method(name)
+      end
+
+      def patme_method(name)
+        @patme_methods[name]
+      end
+    end
+
+    module InstanceMethods
+      def method_missing name, *args, &block
+        method = self.class.patme_method(name)
+        if method && method.implemented_for?(args)
+          method.call(self, args)
+        else
+          super
+        end
+      end
+    end
+  end
+
+end

data/lib/patme/version.rb

@@ -0,0 +1,3 @@
+module Patme
+  VERSION = "0.1.0"
+end

data/lib/patme.rb

@@ -0,0 +1,6 @@
+Dir[File.join(__dir__, "/patme/arguments/*")].each{|path| require path}
+Dir[File.join(__dir__, "/patme/*.rb")].each{|path| require path}
+
+module Patme
+
+end

data/patme.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'patme/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "patme"
+  spec.version       = Patme::VERSION
+  spec.authors       = ["Dmitrii Krasnov"]
+  spec.email         = ["vizvamitra@gmail.com"]
+
+  spec.summary       = "Pattern matching for ruby methods"
+  spec.description   = "Elixir-style pattern matching for ruby methods"
+  spec.homepage      = "http://github.com/vizvamitra/patme"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: patme
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dmitrii Krasnov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-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.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: pry
+  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: Elixir-style pattern matching for ruby methods
+email:
+- vizvamitra@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/patme.rb
+- lib/patme/arguments/arbitrary.rb
+- lib/patme/arguments/optional.rb
+- lib/patme/arguments/specific.rb
+- lib/patme/implementation.rb
+- lib/patme/implementation_builder.rb
+- lib/patme/method.rb
+- lib/patme/pattern_matching.rb
+- lib/patme/version.rb
+- patme.gemspec
+homepage: http://github.com/vizvamitra/patme
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Pattern matching for ruby methods
+test_files: []