ataulfo 1.0.0 → 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8c268635bc6dd13739c0be60f885f02c4a619c2
+  data.tar.gz: 163fc9e5dcb168721be19f05211b1853bca14be7
+SHA512:
+  metadata.gz: ee6e8b448026e2a3a570010bd31caa9ad3e6e085931930f6b3b4b445948bf6fe241388045c6e2cbcb11b1d1ca5c435f084effb10cc38b38e11b1ea47591d03b5
+  data.tar.gz: 6a3912c3aeb245f740341fccd5d0bd2021b8940e5767d64fa5f96bc5135d162271df07f842f11ad6bf3b9d6be9150a6c6a068b868d277d78e8a7f32ddc74a2be

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,120 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-09-28 12:01:20 -0300 using RuboCop version 0.43.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 20
+
+# Offense count: 7
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 138
+
+# Offense count: 4
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/ataulfo/kernel_extension.rb'
+    - 'lib/ataulfo/pattern_matching.rb'
+
+# Offense count: 8
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: when_needed, always
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'Gemfile'
+    - 'Guardfile'
+    - 'Rakefile'
+    - 'ataulfo.gemspec'
+    - 'lib/ataulfo.rb'
+    - 'lib/ataulfo/kernel_extension.rb'
+    - 'lib/ataulfo/pattern_matching.rb'
+    - 'lib/ataulfo/version.rb'
+
+# Offense count: 2
+Style/MethodMissing:
+  Exclude:
+    - 'lib/ataulfo/pattern_matching.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/MutableConstant:
+  Exclude:
+    - 'lib/ataulfo/version.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'ataulfo.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
+# SupportedStyles: slashes, percent_r, mixed
+Style/RegexpLiteral:
+  Exclude:
+    - 'Guardfile'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowAsExpressionSeparator.
+Style/Semicolon:
+  Exclude:
+    - 'lib/ataulfo/pattern_matching.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: space, no_space
+Style/SpaceBeforeBlockBraces:
+  Exclude:
+    - 'ataulfo.gemspec'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SupportedStyles.
+# SupportedStyles: space, no_space, compact
+Style/SpaceInsideHashLiteralBraces:
+  Exclude:
+    - 'Guardfile'
+    - 'lib/ataulfo/pattern_matching.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: use_perl_names, use_english_names
+Style/SpecialGlobalVars:
+  Exclude:
+    - 'ataulfo.gemspec'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'Rakefile'
+    - 'ataulfo.gemspec'
+    - 'lib/ataulfo/kernel_extension.rb'
+    - 'lib/ataulfo/version.rb'
+
+# Offense count: 1
+Style/StructInheritance:
+  Exclude:
+    - 'lib/ataulfo/pattern_matching.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/UnneededPercentQ:
+  Exclude:
+    - 'ataulfo.gemspec'

data/.ruby-gemset

@@ -0,0 +1 @@
+ataulfo

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.1

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,17 @@
+group :tdd, halt_on_fail: true do
+  guard :rspec,
+        cmd: 'bundle exec rspec -f documentation --color',
+        run_all: {cmd: 'bundle exec rspec -f documentation --color'},
+        keep: true,
+        all_on_start: true,
+        all_after_pass: true do
+
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+    watch('lib/mcgee.rb') { 'spec' }
+  end
+  guard :rubocop, cmd: 'bundle exec rubocop', cli: '-fs -c./.rubocop.yml' do
+    watch(%r{.+\.rb$})
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+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,77 @@
+# Ataulfo
+
+A DSL for **pattern matching** over object in Ruby.
+
+What does it do? It's a conditional clause based on the object interface. It also allows you do make "multi-assignment".
+
+Example:
+
+    object = Struct.new(:method1, :method2).new
+    object.method1 = 'something'
+    object.method2 = 'something else'
+
+    with object do
+      like method1: m1, method2: m2 do
+        puts m1 # 'something'
+        puts m2 # 'something else'
+      end
+    end
+
+Another example:
+
+    object = Struct.new(:a_method).new
+    object.a_method = 'something'
+
+    with object do
+      like this_method_does_not_exist: x do
+        fail 'it will not reach here'
+      end
+      like a_method: x do
+        puts x # 'something'
+      end
+    end
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ataulfo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ataulfo
+
+## Contributing
+
+If you want to play around, clone the project, run the specs and have fun.
+
+Since this is really tiny and more a "Proof of Concept" than something I would use in production code, I'm not planning
+to actively work on it. But if you need some help, send me an e-mail: ronie.uliana at gmail. I'll be happy to help you.
+
+## Licensing
+
+(MIT License)
+
+Copyright (c) 2012 Ronie Uliana
+
+ 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/Rakefile

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

data/ataulfo.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ataulfo/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "ataulfo"
+  gem.version       = Ataulfo::VERSION
+  gem.authors       = ['Ronie Uliana']
+  gem.email         = ['ronie.uliana@gmail.com']
+  gem.description   = %q{Pattern Matching for Ruby (objects only)}
+  gem.summary       = %q{A DSL for pattern matching over object in Ruby.}
+  gem.homepage      = 'https://github.com/ruliana/ataulfo'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = %w[lib]
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'guard-rubocop'
+end

data/lib/ataulfo.rb

@@ -0,0 +1,3 @@
+require 'ataulfo/version'
+require 'ataulfo/pattern_matching'
+require 'ataulfo/kernel_extension'

data/lib/ataulfo/kernel_extension.rb

@@ -0,0 +1,7 @@
+module Kernel
+  def with(object, &block)
+    other_self = eval "self", block.binding
+    to_match   = Ataulfo::PatternMatching.new(object, other_self)
+    to_match.instance_eval(&block)
+  end
+end

data/lib/ataulfo/pattern_matching.rb

@@ -0,0 +1,64 @@
+module Ataulfo
+  class PatternMatching
+    class Var < Struct.new(:value);
+    end
+
+    class Body
+      def initialize(vars, other_self)
+        @other_self = other_self
+        vars.each do |k, v|
+          define_singleton_method(k) { v.value }
+        end
+      end
+
+      def method_missing(method_name, *args, &block)
+        @other_self.send method_name, *args, &block
+      end
+    end
+
+    class Matcher
+      def initialize(object, pattern)
+        @object                      = object
+        @pattern_vars                = pattern.select { |_, v| v.is_a? Var }
+        inner_matches                = pattern.select { |_, v| v.is_a? Hash }
+        fixed_values                 = pattern.select { |_, v| !v.is_a?(Var) && !v.is_a?(Hash) }
+        @object_respond_to_methods   = pattern.keys.all? { |k| @object.respond_to? k }
+        @object_answers_right_values = fixed_values.all? { |k, v| @object.send(k) == v }
+
+        @matchers = inner_matches.map { |k, v| Matcher.new(object.send(k), v) }
+      end
+
+      def matches?
+        @matchers.all?(&:matches?) if @object_respond_to_methods && @object_answers_right_values
+      end
+
+      def fill_vars
+        @pattern_vars.each { |k, v| v.value = @object.send k }
+        @matchers.each(&:fill_vars)
+      end
+    end
+
+    def initialize(object, other_self)
+      @object       = object
+      @other_self   = other_self
+      @context_vars = { }
+    end
+
+    def like(pattern, &block)
+      matcher = Matcher.new(@object, pattern)
+      return unless matcher.matches?
+
+      matcher.fill_vars
+
+      Body.new(@context_vars, @other_self).instance_eval(&block)
+      @context_vars = { }
+    end
+
+    def method_missing(method_name, *_)
+      # The line below also returns the "Var" to the
+      # pattern. That makes it a collector parameter
+      # already distributed where it belongs to.
+      @context_vars[method_name] = Var.new
+    end
+  end
+end

data/lib/ataulfo/version.rb

@@ -0,0 +1,3 @@
+module Ataulfo
+  VERSION = "1.0.1"
+end

data/spec/lib/ataulfo/pattern_matching_spec.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+describe Ataulfo::PatternMatching do
+  it 'matches a single method' do
+    passed_through_match = false
+
+    object = Struct.new(:a_method).new('something')
+
+    with object do
+      like a_method: some_var do
+        expect(some_var).to eq('something')
+        passed_through_match = true
+      end
+    end
+
+    expect(passed_through_match).to be_truthy
+  end
+
+  it 'matches two methods' do
+    passed_through_match = false
+
+    object = Struct.new(:method1, :method2).new('something', 'something else')
+
+    with object do
+      like method2: m2, method1: m1 do
+        expect(m1).to eq('something')
+        expect(m2).to eq('something else')
+        passed_through_match = true
+      end
+    end
+
+    expect(passed_through_match).to be_truthy
+  end
+
+  it 'two bodies, one execution' do
+    passed_through_match = false
+
+    object = Struct.new(:a_method).new('something')
+
+    with object do
+      like this_does_not_exist: x do
+        raise 'should not match a method that does not exist'
+      end
+      like a_method: x do
+        expect(x).to eq('something')
+        passed_through_match = true
+      end
+    end
+
+    expect(passed_through_match).to be_truthy
+  end
+
+  it 'matches fixed values' do
+    passed_through_match = false
+
+    object = Struct.new(:a_method).new('something')
+
+    with object do
+      like a_method: 'other_thing' do
+        raise 'should not match a method with wrong value'
+      end
+      like a_method: 'something' do
+        passed_through_match = true
+      end
+    end
+
+    expect(passed_through_match).to be_truthy
+  end
+
+  it 'matches fixed values in variables' do
+    passed_through_match = false
+
+    object = Struct.new(:a_method).new('something')
+    other_thing = 'other_thing'
+    something = 'something'
+
+    with object do
+      like a_method: other_thing do
+        raise 'should not match a method with wrong value'
+      end
+      like a_method: something do
+        passed_through_match = true
+      end
+    end
+
+    expect(passed_through_match).to be_truthy
+  end
+
+  it 'matches fixed and var values mixed' do
+    passed_through_match = false
+
+    object = Struct.new(:a_method, :another_method).new('something', 'other value')
+
+    with object do
+      like a_method: 'does not match', another_method: my_var do
+        raise 'should not match a method with wrong value'
+      end
+      like a_method: 'something', another_method: my_var do
+        expect(my_var).to eq('other value')
+        passed_through_match = true
+      end
+    end
+
+    expect(passed_through_match).to be_truthy
+  end
+
+  it 'matches a simple nested object' do
+    passed_through_match = false
+
+    object = Struct.new(:a_method).new(Struct.new(:inner).new('something'))
+
+    with object do
+      like a_method: { inner: my_var } do
+        expect(my_var).to eq('something')
+        passed_through_match = true
+      end
+    end
+
+    expect(passed_through_match).to be_truthy
+  end
+
+  it 'matches complex nested expression' do
+    passed_through_match = false
+
+    num  = Struct.new(:value)
+    add  = Struct.new(:augend, :addend)
+    prod = Struct.new(:multiplicand, :multiplier)
+
+    object = prod[add[num[1], num[2]], add[num[3], num[4]]]
+
+    with object do
+      like multiplicand: { augend: { value: 99 }, addend: { value: x2 } }, multiplier: { augend: { value: x3 }, addend: { value: x4 } } do
+        raise 'should not match a method with wrong value'
+      end
+      like multiplicand: { augend: { value: 1 }, addend: n2 }, multiplier: { augend: { value: x3 }, addend: { value: x4 } } do
+        expect(n2).to eq(num[2])
+        expect(x3).to eq(3)
+        expect(x4).to eq(4)
+        passed_through_match = true
+      end
+    end
+
+    expect(passed_through_match).to be_truthy
+  end
+
+  it 'matches hashes'
+  it 'matches arrays'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+require 'rspec'
+require 'ataulfo'

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: ataulfo
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.0.1
 platform: ruby
 authors:
 - Ronie Uliana
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-26 00:00:00.000000000 Z
+date: 2016-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rb-inotify
+  name: guard-rubocop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Pattern Matching for Ruby (objects only)
@@ -65,29 +58,47 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ataulfo.gemspec
+- lib/ataulfo.rb
+- lib/ataulfo/kernel_extension.rb
+- lib/ataulfo/pattern_matching.rb
+- lib/ataulfo/version.rb
+- spec/lib/ataulfo/pattern_matching_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/ruliana/ataulfo
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A DSL for pattern matching over object in Ruby.
-test_files: []
+test_files:
+- spec/lib/ataulfo/pattern_matching_spec.rb
+- spec/spec_helper.rb