wildcard_matchers 0.0.1

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,3 @@
+-c
+-f d
+-t wip

data/.rvmrc

@@ -0,0 +1 @@
+rvm gemset use wildcard_matchers --create

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 okitan
+
+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,71 @@
+# wildcard_matchers
+
+## General Usage
+
+```ruby
+require "wildcard_matchers"
+
+WildcardMatchers.wild_card_match("string", /str/) #=> true
+
+require "wildcard_matchers/rspec"
+
+describe "wildcard_matcher" do
+  it "should wildcard match" do
+    { :a => [ "hoge", "fuga" ] }.should wildcard_match(:a => [ is_a_string, /^fu/ ])
+  end
+end
+```
+
+See specs, for more detail.
+
+### wildcard matchers
+* is_a(class)
+ * is_a(String) === String #=> true
+ * is_a_string === String #=> true
+* is_bool
+ * is_bool === true  #=> true
+ * is_bool === false #=> true
+ * is_bool === object #=> false
+* is_time
+ * is_time === "2012-05-13" #=> true
+* hash_includes
+ * hash_includes(:a) === { :a => 1 } #=> true
+ * hash_includes(:b) === { :a => 1 } #=> false
+ * hash_includes(:a => Integer) === { :a => 1 } #=> true
+ * hash_includes(:a => 2) === { :a => 1 } #=> false
+
+## How it works
+
+It is very simple. Recursive match using ===, and Class, Range, and Proc act as wildcard matchers.
+
+You can create original matcher using lambda.
+
+```ruby
+original_matcher = lamda do |actual|
+  (…as you like…)
+end
+
+wildcard_matcher?("actual", original_matcher)
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'wildcard_matchers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wildcard_matchers
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/wildcard_matchers/matchers.rb

@@ -0,0 +1,37 @@
+module WildcardMatchers
+  module Matchers
+    def is_a(klass)
+      klass
+    end
+
+    [ String, Integer, Float, Hash, Array ].each do |klass|
+      module_eval %{
+        def is_a_#{klass.to_s.downcase}
+          #{klass.inspect}
+        end
+      }
+    end
+
+    def is_bool
+      lambda {|bool| TrueClass === bool or FalseClass === bool }
+    end
+
+    def is_time
+      lambda do |time|
+        require "time"
+        time.is_a?(Time) or (Time.parse(time) rescue false)
+      end
+    end
+
+    # RSpeck::Mocks has hash_including
+    def hash_includes(*args)
+      hash_to_match = {}
+      hash_to_match = args.pop if args.last.is_a?(Hash)
+
+      lambda do |hash|
+        (args - hash.keys).size == 0 &&
+          hash_to_match.all? {|key, value| value === hash[key] }
+      end
+    end
+  end
+end

data/lib/wildcard_matchers/rspec.rb

@@ -0,0 +1,16 @@
+require "rspec"
+
+RSpec::Matchers.define :wildcard_match do |expected|
+  match do |actual|
+    WildcardMatchers.wildcard_match?(actual, expected)
+  end
+
+  failure_message_for_should do |actual|
+    failures = [ default_failure_message_for_should ]
+    on_failure = proc {|message| failures << message }
+
+    WildcardMatchers.wildcard_match?(actual, expected, &on_failure)
+
+    failures.join("\n")
+  end
+end

data/lib/wildcard_matchers.rb

@@ -0,0 +1,66 @@
+require "wildcard_matchers/matchers"
+
+module WildcardMatchers
+  include Matchers
+
+  def wildcard_match?(actual, expected, &on_failure)
+    on_failure = proc { return false } unless block_given?
+
+    recursive_match(actual, expected, &on_failure)
+  end
+
+  protected
+  def recursive_match(actual, expected, position = ".", &on_failure)
+    # "case expected" should omit Array or Hash
+    # "case actual" should omit Proc
+    case expected
+    when Class
+      # when expected is Array or Hash (Class) comes here and do nothing
+    when Array
+      return check_array(actual, expected, position, &on_failure)
+    when Hash
+      return check_hash(actual, expected, position, &on_failure)
+    end
+
+    unless expected === actual
+      yield("#{position}: expect #{actual.inspect} to #{expected.inspect}")
+      false
+    else
+      true
+    end
+  end
+
+  # TODO: class ArrayMatcher ?
+  def check_array(actual, expected, position, &on_failure)
+    if expected.size == actual.size
+      actual.zip(expected).map.with_index do |(a, e), index|
+        recursive_match(a, e, position + "[#{index}]", &on_failure)
+      end.all?
+    else
+      yield <<_MESSAGE_
+#{position}: expect Array size #{actual.size} to #{expected.size}
+  actual: #{actual.inspect}
+  expect: #{expected.inspect}
+_MESSAGE_
+      false
+    end
+  end
+
+  # TODO: class HashMatcher ?
+  def check_hash(actual, expected, position, &on_failure)
+    if (actual.keys - expected.keys).size == 0 && (expected.keys - actual.keys).size == 0
+      expected.map do |key, value|
+        recursive_match(actual[key], value, position + "[#{key.inspect}]", &on_failure)
+      end.all?
+    else
+      yield <<_MESSAGE_
+#{position}: expect Hash keys #{actual.size} to #{expected.size}
+  +keys: #{actual.keys   - expected.keys}
+  -keys: #{expected.keys - actual.keys }
+_MESSAGE_
+      false
+    end
+  end
+
+  module_function *self.instance_methods
+end

data/spec/spec.watchr

@@ -0,0 +1,8 @@
+require 'autowatchr'
+
+Autowatchr.new(self) do |config|
+  config.ruby      = 'clear && rspec'
+  config.test_dir  = 'spec'
+  config.test_re   = "^#{config.test_dir}/(.*)_spec\.rb$"
+  config.test_file = '%s_spec.rb'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$: << File.expand_path('../lib', File.dirname(__FILE__))
+require 'wildcard_matchers'
+require "wildcard_matchers/rspec"
+
+Dir[File.expand_path("support/**/*.rb", File.dirname(__FILE__))].each {|f| require f }
+
+require "pry"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+end
+
+# global debug function
+# usage:
+#   wildcard_match?(actual, expected, &$debug)
+$debug = proc {|message| puts message }

data/spec/support/shared_examples.rb

@@ -0,0 +1,25 @@
+shared_examples_for "wildcard match" do |actual, matcher, *args|
+  expected = matcher.inspect + (args.size > 0 ? "(#{args.map(&:inspect).join(", ")})" : "")
+
+  it "#{actual.inspect} with #{expected}" do
+    if matcher.is_a?(Symbol) and WildcardMatchers.respond_to?(matcher)
+      # Note: some symbol comes here and may fail
+      wildcard_match?(actual, send(matcher, *args)).should be_true
+    else
+      wildcard_match?(actual, matcher).should be_true
+    end
+  end
+end
+
+shared_examples_for "not wildcard match" do |actual, matcher, *args|
+  expected = matcher.inspect + (args.size > 0 ? "(#{args.map(&:inspect).join(", ")})" : "")
+
+  it "#{actual.inspect} with #{expected}" do
+    if matcher.is_a?(Symbol) and WildcardMatchers.respond_to?(matcher)
+      # Note: some symbol comes here and may fail
+      wildcard_match?(actual, send(matcher, *args)).should be_false
+    else
+      wildcard_match?(actual, matcher).should be_false
+    end
+  end
+end

data/spec/wildcard_matchers/matchers_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+
+describe WildcardMatchers::Matchers do
+  include WildcardMatchers
+
+  [ [ "string",            String ],
+    [ 0,                   Integer ],
+    [ 0.1,                 Float ],
+    [ 0,                   Numeric ],  # superclass
+    [ { :some => :hash },  Hash  ],
+    [ [ 1, 2, 3 ],         Array ],
+  ].each do |actual, expected|
+    it_should_behave_like "wildcard match", actual, :is_a, expected
+  end
+
+  [ [ "string",           :is_a_string ],
+    [ 0,                  :is_a_integer ],
+    [ 0.1,                :is_a_float ],
+    [ { :some => :hash }, :is_a_hash ],
+    [ [ 1, 2, 3 ],        :is_a_array ],
+
+    # is_bool
+    [ true,  :is_bool ],
+    [ false, :is_bool ],
+
+    # is_time
+    [ Time.now,      :is_time ],
+    [ Time.now.to_s, :is_time ],
+    [ "2012-05-10",  :is_time ],
+
+  ].each do |actual, matcher|
+    it_should_behave_like "wildcard match", actual, matcher
+  end
+
+  [ [ 0, :is_bool ],
+  ].each do |actual, matcher|
+    it_should_behave_like "not wildcard match", actual, matcher
+  end
+
+  [ [ { :a => 1, :b => 1, :c => 1 }, :hash_includes, :a, :b ],
+    [ { :a => 1, :b => 1, :c => 1 }, :hash_includes, :a, :b => 1 ],
+    [ { :a => 1, :b => 1, :c => 1 }, :hash_includes, :a, :b => Integer ],
+  ].each do |actual, matcher, *args|
+    it_should_behave_like "wildcard match", actual, matcher, *args
+  end
+
+  [ [ { :a => 1, :b => 1, :c => 1 }, :hash_includes, :a, :d ],
+    [ { :a => 1, :b => 1, :c => 1 }, :hash_includes, :a, :b => 2 ],
+    [ { :a => 1, :b => 1, :c => 1 }, :hash_includes, :a, :b => String ],
+  ].each do |actual, matcher, *args|
+    it_should_behave_like "not wildcard match", actual, matcher, *args
+  end
+end

data/spec/wildcard_matchers/rspec_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+describe "matcher wildcard_match" do
+  [ [ 1, Integer ]
+  ].each do |actual, expected|
+    it "match #{actual} with #{expected}" do
+      actual.should wildcard_match(expected)
+    end
+  end
+
+  [ [ 1,           String,     ".: expect 1 to String" ],
+    [ [ 1 ],       [ String ], ".[0]: expect 1 to String" ],
+    [ [ 1 ],       [],         ".: expect Array size 1 to 0" ],
+    [ { :a => 1 }, {},         "+keys: [:a]" ],
+    [ {},          {:a => 1},  "-keys: [:a]" ],
+    [ { :a => 1},  {:a => 0},  ".[:a]: expect 1 to 0" ],
+  ].each do |actual, expected, failure_message|
+    it "not match #{actual} with #{expected} and return #{failure_message.inspect} as failure_message" do
+      begin
+        actual.should wildcard_match(expected)
+        fail # if matched come here and must fail
+      rescue => e
+        e.message.should include(failure_message)
+      end
+    end
+  end
+end

data/spec/wildcard_matchers_spec.rb

@@ -0,0 +1,96 @@
+require "spec_helper"
+
+target = WildcardMatchers
+
+describe target do
+  include target
+
+  context ".wildcard_match?" do
+    [ [ "string",            String ],
+      [ "string",            /^str/ ],
+      [ 0,                   Integer ],
+      [ 2,                   (1..3) ],
+      [ 0.1,                 Float ],
+      [ 0,                   Numeric ],  # superclass
+      [ { :some => :hash },  Hash  ],
+      [ [ 1, 2, 3 ],         Array ],
+    ].each do |actual, expected|
+      it_should_behave_like "wildcard match", actual, expected
+    end
+
+    context "matches recursively in Array" do
+      [ [ [ 1, 2, "3"],    [ Integer, Integer, String ] ],
+        [ [ 1, 2, [ 1 ] ], [ Integer, Integer, [ Integer ] ] ],
+      ].each do |actual, expected|
+        it_should_behave_like "wildcard match", actual, expected
+      end
+    end
+
+    context "does not match recursively in Array" do
+      [ [ [ 1, 2, 3 ],     [ Integer, Integer, String ] ],
+        [ [ 1, 2, 3 ],    [ Integer, String,  Integer ] ],
+        [ [ 1, 2, [ 1 ] ], [ Integer, Integer, [ String ] ] ],
+      ].each do |actual, expected|
+        it_should_behave_like "not wildcard match", actual, expected
+      end
+    end
+
+    context "matches recursively in Hash" do
+      [ [ { :hoge => "fuga", :fuga => "ugu" }, { :hoge => String, :fuga => String } ],
+        [ { :hoge => "fuga", :fuga => { :ugu => "piyo" } }, { :hoge => String, :fuga => { :ugu => String } } ],
+      ].each do |actual, expected|
+        it_should_behave_like "wildcard match", actual, expected
+      end
+    end
+
+    context "matches recursively in Hash" do
+      [ [ { :hoge => "fuga" },                 {} ],
+        [ { :hoge => "fuga", :fuga => "ugu" }, { :hoge => String, :fuga => Integer } ],
+        [ { :hoge => "fuga", :fuga => "ugu" }, { :hoge => String, :ugu => String } ],
+        [ { :hoge => "fuga", :fuga => { :ugu => "piyo" } }, { :hoge => String, :fuga => { :ugu => Integer } } ],
+        [ { :hoge => "fuga", :fuga => { :ugu => "piyo" } }, { :hoge => String, :fuga => { :fuga => String } } ],
+      ].each do |actual, expected|
+        it_should_behave_like "not wildcard match", actual, expected
+      end
+    end
+
+    # TODO: more complex example array in hash and hash in array
+    context "match recursively Array and Hash" do
+      [ [ [ 1, [ 2 ], { :first => 4, :second => [ 5, 6 ] } ],
+          [ Integer, [ Integer ], { :first => Integer, :second => [ Integer, Integer ] } ] ],
+
+        [ { :first => 1, :second => [ 2 ], :third => { :one => 3 } },
+          { :first => Integer, :second => [ Integer ], :third => { :one => Integer } }
+        ]
+      ].each do |actual, expected|
+        it_should_behave_like "wildcard match", actual, expected
+      end
+    end
+  end
+
+  context ".wildcard_matches with on_failure callback" do
+    it "can get failure message" do
+      actual   = true
+      expected = false
+
+      failure = nil
+      wildcard_match?(actual, expected) {|message| failure = message }
+      failure.should =~ /#{actual.inspect} .+ #{expected.inspect}/
+    end
+
+    it "can get several failure messages" do
+      actual   = [ 1, 0, 2 ]
+      expected = [ 3, 0, 4 ]
+
+      failures = []
+      wildcard_match?(actual, expected) {|message| failures << message }
+
+      # TODO: dog fooding of rspec-matcher
+      expect_failures = [ /#{actual.first}.+#{expected.first}/,
+                          /#{actual.last}.+#{expected.last}/ ]
+      wildcard_match?(failures, expect_failures, &$debug).should be_true
+    end
+
+    # TODO: more failure message
+  end
+end

data/wildcard_matchers.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.authors       = ["okitan"]
+  gem.email         = ["okitakunio@gmail.com"]
+  gem.description   = "wildcard matchers"
+  gem.summary       = "wildcard matchers which can use in rspec"
+  gem.homepage      = "https://github.com/okitan/wildcard_matchers"
+
+  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.name          = "wildcard_matchers"
+  gem.require_paths = ["lib"]
+
+  gem.version       = File.read(File.join(File.dirname(__FILE__), "VERSION")).chomp
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "autowatchr"
+
+  # for debug
+  gem.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: wildcard_matchers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- okitan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: autowatchr
+  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: pry
+  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: wildcard matchers
+email:
+- okitakunio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/wildcard_matchers.rb
+- lib/wildcard_matchers/matchers.rb
+- lib/wildcard_matchers/rspec.rb
+- spec/spec.watchr
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+- spec/wildcard_matchers/matchers_spec.rb
+- spec/wildcard_matchers/rspec_spec.rb
+- spec/wildcard_matchers_spec.rb
+- wildcard_matchers.gemspec
+homepage: https://github.com/okitan/wildcard_matchers
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: wildcard matchers which can use in rspec
+test_files:
+- spec/spec.watchr
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+- spec/wildcard_matchers/matchers_spec.rb
+- spec/wildcard_matchers/rspec_spec.rb
+- spec/wildcard_matchers_spec.rb