look_like 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1baeea6bcba7b7808e9c2544b26ebc63d9385c8f
-  data.tar.gz: b56daa0e4153b0b65c90b55d3b71fd8eb5531740
+  metadata.gz: d9c585287d41ac062e6f2ae3b1198487761aaa39
+  data.tar.gz: 494d617b9a9f152a8ddb45b0b50c2c820d408afd
 SHA512:
-  metadata.gz: 2cb721b150dd6e5fbe0573d28631140eea679de1743a338c5fc3a293f72acd9f852f2877b2ca85168ea16f72db9be3bc606af4bd9e0c3541e1e6bbb2d1740284
-  data.tar.gz: 7c5048f7c6e056c825a36b4b6a2aba9695d58c5ba7d83ac1c8f81fd11861b3cd43c8f4058b76f6f85a9b5ad44b9b535da2305814d3b41315ebcbccaf82e1b014
+  metadata.gz: 32af77c7ea96abdd0739f64bd77a0f1506bcea1f10b44a01948829050634f6c628ac0f40fc6d35d6ca7e57652b31c9860316a7b661329888958bd1cf49419c22
+  data.tar.gz: 88ec374c3dcf61b73ba4564e0a5efb098a61ea4e7d7d6c50ec57f20dec4d139383a71c0a176f8455587b60f5a56f0280e87f38cd0cdd5d0442c113922ddecf73

data/.gitignore

@@ -8,4 +8,5 @@
 /spec/reports/
 /tmp/
 .idea
-*.iml
+*.iml
+coverage

data/Gemfile

@@ -3,3 +3,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in look_like.gemspec
 gem "rspec"
 gem "rake"
+gem 'coveralls', require: false

data/README.md

@@ -1,8 +1,11 @@
-# look_like matcher
-This gem is a collection of rspec matchers, for writing wireframe tests.
-These are useful for writing sanity tests in higher environments where we cannot control the data consumed by an app.
-This can also be used in a production environment.
-You can reuse your code/specs for regression tests.  
+# look_like matcher [![Build Status](https://travis-ci.org/nishants/look_like.svg?branch=master)](https://travis-ci.org/nishants/look_like) [![Coverage Status](https://coveralls.io/repos/github/nishants/look_like/badge.svg)](https://coveralls.io/github/nishants/look_like) [![Gem Version](https://badge.fury.io/rb/look_like.svg)](https://badge.fury.io/rb/look_like)
+
+- This gem is a collection of rspec matchers, for writing wireframe tests.
+- Such tests search for visual clues for detecting presence of a bug.
+- Useful for writing sanity tests in higher environments, e.g. testing your fresh deploy to production.
+- These can reuse your code for regression tests.  
+- Meaningful assertion reports help in quick diagnosis of faults. 
+- For example you can write test for fresh deployments to make sure the currency and language are correct by domain/user. 
 
 ## Installation
 
@@ -14,10 +17,11 @@ gem 'look_like'
 
 And then execute:
 
-    $ bundle install
+```bash
+$ bundle install
+```
 
 ## Usage
-Following will result in error : 
 ```ruby
 it "single word is different than two words" do
     expect("Sam").to look_like("Sam Dam")
@@ -34,25 +38,44 @@ end
 LookLike::Matchers.define({
                               :name     => :single_word,
                               :desc     => "single word",
-                              :priority => 7,
-                              :select   => lambda{|keyword|},
+                              :select   => lambda{|expected|},
                               :match    => lambda{|actual, expected|} 
                           })
 ```
 
 
-## Development
+## Writing wireframe tests
+In your feature file, define how your table should look like (visually) : 
+```gherkin
+Scenario: View employees detail table
+  Given I am an admin
+  Then  I should see employees table like
+        |FirstName  |LastName   |  Salary   |Email  |
+        |Magan      |Sharma     |  $200,00  |a@b.com|
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+In your steps, get table rows as array of array
+```ruby
+Then(/^I should see employees table like:$/) do |table_definition|
+  table = homepage.open.employee_table
+  expect(table).to look_like(table_definition)
+end
+```
 
-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).
+## Development
+- After checking out the repo, run `bin/setup` to install dependencies. 
+- Then, run `rake spec` to run the tests. 
+- You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+- To install this gem locally, run `bundle exec rake install`. 
+- To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`
+- Release task  will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+- Build report : https://travis-ci.org/nishants/look_like
+- Coverage Repoprt : https://coveralls.io/github/nishants/look_like
 
 ## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[nishants]/look_like. 
-
+- Report bugs or suggest improvements at https://github.com/nishants/look_like/issues.
+- Pull requests are highly welcome at at https://github.com/nishants/look_like. 
 
 ## License
-
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 

data/lib/look_like/array-matcher.rb

@@ -0,0 +1,60 @@
+module LookLike
+  class ArrayMatcher < Matcher
+
+    def initialize(matchers)
+      @matchers = matchers
+    end
+
+
+    def element_error(actual, expected)
+      @matchers.find { |matcher| matcher.select(expected) }.error(actual, expected)
+    end
+
+
+    def match_element(actual, expected)
+      @matchers.find { |matcher| matcher.select(expected) }.match(actual, expected)
+    end
+
+    def match(actual_array, expected_array)
+      match_array(actual_array, expected_array)
+    end
+
+    def match_array(actual_array, expected_array)
+      matches = expected_array.length == actual_array.length
+      actual_array.each_with_index { |actual, index|
+        expected = expected_array[index]
+        matches = matches && match_element(actual, expected)
+      }
+      matches
+    end
+
+    def select(expected)
+      expected.is_a? Array
+    end
+
+    def error(actual_array, expected_array)
+      array_error(actual_array, expected_array)
+    end
+
+    def array_error(actual_array, expected_array)
+      message = []
+      if (expected_array.length > actual_array.length)
+        message.push("Expected #{ expected_array.length } elements, but found #{actual_array.length}.")
+        message.push("Expected : [#{ expected_array.join(", ") }]")
+        message.push("Found    : [#{ actual_array.join(", ") }]")
+        return message.join(". ")
+      end
+      actual_array.each_with_index { |actual, index|
+        expected = expected_array[index]
+        message.push(match_element(actual, expected) ? "✓" : "x [#{element_error(actual, expected)}]")
+      }
+      "[#{message.join(", ")}]"
+    end
+
+    def negate_error(actual, expected)
+      "#{"Expected not to match." + error(actual, expected)}"
+    end
+
+  end
+
+end

data/lib/look_like/matcher.rb

@@ -1,27 +1,36 @@
-
 module LookLike
   class Matcher
     attr_accessor :name
     attr_accessor :desc
-    attr_accessor :priority
     attr_accessor :select
     attr_accessor :match
+    attr_accessor :error
 
     def initialize(config)
       @name     = config[:name]
       @desc     = config[:desc]
-      @priority = config[:priority]
       @selector = config[:select]
       @matcher  = config[:match]
     end
 
+    def error(actual, expected)
+      "\"#{actual}\" does not look like \"#{expected}\" (#{@desc})"
+    end
+
+    def negate_error(actual, expected)
+      "Did not expect    :\"#{actual}\" to look like  : \"#{expected}\" (#{@desc})"
+    end
+
     def match(actual, expected)
-      @matcher.call(actual, expected)
+      optionally_empty     = expected.is_a?(String) && expected.end_with?("*") && (actual.nil? || actual.strip.eql?(""))
+      expected             = expected.is_a?(String) ? expected.sub("*", "").strip : expected
+      optionally_empty || !actual.nil? && (@matcher.parameters.length == 2 ? @matcher.call(actual, expected) : @matcher.call(actual))
     end
 
-    def apply(key)
-      @selector.call(key)
+    def select(expected)
+      @selector.call(expected.sub("*", "").strip)
     end
 
   end
-end
+
+end

data/lib/look_like/matchers/any-value.rb

@@ -0,0 +1,12 @@
+LookLike::Matchers.define(
+    {
+        :name     => :any_value,
+        :desc     => "any value",
+        :select   => lambda{|expected|
+          expected.strip.eql?("") || expected.strip.eql?("*")
+        },
+        :match    => lambda{|actual, expected|
+          true
+        }
+    })
+

data/lib/look_like/matchers/email.rb

@@ -0,0 +1,12 @@
+LookLike::Matchers.define(
+    {
+        :name     => :email,
+        :desc     => "email",
+        :select   => lambda{|expected|
+          expected.eql?("email") || LookLike::Support.email?(expected)
+        },
+        :match    => lambda{|actual|
+          LookLike::Support.email?(actual)
+        }
+    })
+

data/lib/look_like/matchers/enum.rb

@@ -0,0 +1,8 @@
+LookLike::Matchers.define(
+    {
+        :name     => :enum,
+        :desc     => "enum",
+        :select   => lambda{|expected| LookLike::Support.enum?(expected) },
+        :match    => lambda{|actual, expected| LookLike::Support.enum_values(expected).include?(actual) }
+    })
+

data/lib/look_like/matchers/formatted-amount.rb

@@ -0,0 +1,16 @@
+LookLike::Matchers.define(
+    {
+        :name     => :amount,
+        :desc     => "amount",
+        :select   => lambda{|expected|
+          expected.end_with?("amount") || LookLike::Support.amount?(expected)
+        },
+        :match    => lambda{|actual, expected|
+          currency = LookLike::Support.currency_of(expected)
+          unless currency == "$"
+            actual = actual.sub("$", "x").sub(currency, "$")
+          end
+          LookLike::Support.amount?(actual)
+        }
+    })
+

data/lib/look_like/matchers/formatted-number.rb

@@ -0,0 +1,8 @@
+format = /^[\d,]+\d$/
+LookLike::Matchers.define(
+    {
+        :name     => :fomatted_number,
+        :desc     => "formatted number",
+        :select   => lambda{|expected| format === expected },
+        :match    => lambda{|actual| format === actual }
+    })

data/lib/look_like/matchers/number.rb

@@ -0,0 +1,9 @@
+format = /^[\d]+$/
+LookLike::Matchers.define(
+    {
+        :name     => :number,
+        :desc     => "number",
+        :select   => lambda{|expected| format === expected },
+        :match    => lambda{|actual| format === actual }
+    })
+

data/lib/look_like/matchers/regex.rb

@@ -0,0 +1,12 @@
+LookLike::Matchers.define(
+    {
+        :name     => :regex,
+        :desc     => "regex ",
+        :select   => lambda{|expected|
+          expected.start_with?("/") && expected.end_with?("/")
+        },
+        :match    => lambda{|actual, expected|
+          Regexp.new(expected.tr("/", "").strip) === actual
+        }
+    })
+

data/lib/look_like/matchers/string.rb

@@ -0,0 +1,12 @@
+LookLike::Matchers.define(
+    {
+        :name     => :string,
+        :desc     => "string",
+        :select   => lambda{|expected|
+          expected.strip.length > 0
+        },
+        :match    => lambda{ |actual|
+          actual.strip.length > 0
+        }
+    })
+

data/lib/look_like/matchers/url.rb

@@ -0,0 +1,13 @@
+require("uri")
+
+LookLike::Matchers.define(
+    {
+        :name     => :url,
+        :desc     => "url",
+        :select   => lambda { |expected|
+          expected.eql?("url") || LookLike::Support.url?(expected)
+        },
+        :match    => lambda { |actual|
+          LookLike::Support.url?(actual) || LookLike::Support.loose_url?(actual)
+        }
+    })

data/lib/look_like/matchers.rb

@@ -0,0 +1,27 @@
+module LookLike
+  class Matchers
+    @@matchers = []
+
+    def self.define(config)
+      @@matchers.unshift(LookLike::Matcher.new(config))
+    end
+
+    def self.find(expected)
+      matchers = [LookLike::NestedArrayMatcher.new(@@matchers), LookLike::ArrayMatcher.new(@@matchers)] + @@matchers
+      matchers.find { |matcher| matcher.select(expected) }
+    end
+
+    def self.match(actual, expected)
+      find(expected).match(actual, expected)
+    end
+
+    def self.error(actual, expected)
+      find(expected).error(actual, expected)
+    end
+
+    def self.negate_error(actual, expected)
+      find(expected).negate_error(actual, expected)
+    end
+  end
+
+end

data/lib/look_like/nested-array-matcher.rb

@@ -0,0 +1,26 @@
+module LookLike
+  class NestedArrayMatcher < ArrayMatcher
+    def match(actual, expected)
+      matches = true
+      expected_array = expected[0]
+      actual.each { |actual_array|
+        matches &&= match_array(actual_array, expected_array)
+      }
+      matches
+    end
+
+    def select(expected)
+      expected.is_a?(Array) && expected.length > 0 && expected[0].is_a?(Array)
+    end
+
+    def error(actual, expected)
+      message = []
+      expected_array = expected[0]
+      actual.each { |actual_array|
+        message.push(match_array(actual_array, expected_array) ? "✓" : "x [#{array_error(actual_array, expected_array)}]")
+      }
+      "[#{message.join(", ")}]"
+    end
+    
+  end
+end

data/lib/look_like/rspec-matcher.rb

@@ -0,0 +1,16 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :look_like do |expected|
+
+  match do |actual|
+    LookLike::Matchers.match(actual, expected)
+  end
+
+  failure_message do |actual|
+    LookLike::Matchers.error(actual, expected)
+  end
+
+  failure_message_when_negated do |actual|
+    LookLike::Matchers.negate_error(actual, expected)
+  end
+end

data/lib/look_like/support.rb

@@ -0,0 +1,38 @@
+require "uri"
+module LookLike
+  class Support
+
+    def self.url?(string)
+      !!(string =~ /\A#{URI::regexp}\z/)
+    end
+
+    def self.amount?(string)
+      rounded = string.sub(".", ",").strip
+      /^\$[\s]*[\d,]+\d$/ === rounded
+    end
+
+    def self.enum?(string)
+      /^[^\/]+[\/][^\/]/ === string
+    end
+
+    def self.loose_url?(string)
+      if(string.strip.length && string.include?("."))
+        string = "http://" + string
+      end
+      !!(string =~ /\A#{URI::regexp}\z/)
+    end
+
+    def self.currency_of(amount)
+      amount.end_with?("amount") ? amount.split("amount")[0].strip :  amount[/^[^\d]+/].strip
+    end
+
+    def self.enum_values(list)
+      list.split("/").map{|value| value.strip()}
+    end
+
+    def self.email?(string)
+      string.include?("@") && !string.include?("/")  && loose_url?(string)
+    end
+
+  end
+end

data/lib/look_like/version.rb

@@ -1,3 +1,3 @@
 module LookLike
-  VERSION = "0.1.6"
+  VERSION = "0.2.0"
 end

data/lib/look_like.rb

@@ -1,24 +1,18 @@
 require "look_like/version"
 require "look_like/matcher"
+require "look_like/array-matcher"
+require "look_like/nested-array-matcher"
+require "look_like/matchers"
+require "look_like/rspec-matcher"
+require "look_like/support"
 
-module LookLike
-  class Matchers
-    @@matchers = []
-    def self.define(config)
-      @@matchers.push(LookLike::Matcher.new(config))
-    end
+require "look_like/matchers/any-value"
+require "look_like/matchers/string"
+require "look_like/matchers/email"
+require "look_like/matchers/enum"
+require "look_like/matchers/url"
+require "look_like/matchers/regex"
+require "look_like/matchers/formatted-number"
+require "look_like/matchers/formatted-amount"
+require "look_like/matchers/number"
 
-    def self.find(keyword)
-      @@matchers.find { |matcher|
-        matcher.apply(keyword)
-      }
-    end
-
-    def self.load
-      Dir[File.expand_path(File.join(File.dirname(File.absolute_path(__FILE__)), "matchers")) + "/**/*.rb"].each { |file| require file }
-    end
-
-  end
-end
-
-LookLike::Matchers.load()

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: look_like
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - nishant
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-18 00:00:00.000000000 Z
+date: 2016-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,12 +71,23 @@ files:
 - bin/console
 - bin/setup
 - lib/look_like.rb
+- lib/look_like/array-matcher.rb
 - lib/look_like/matcher.rb
+- lib/look_like/matchers.rb
+- lib/look_like/matchers/any-value.rb
+- lib/look_like/matchers/email.rb
+- lib/look_like/matchers/enum.rb
+- lib/look_like/matchers/formatted-amount.rb
+- lib/look_like/matchers/formatted-number.rb
+- lib/look_like/matchers/number.rb
+- lib/look_like/matchers/regex.rb
+- lib/look_like/matchers/string.rb
+- lib/look_like/matchers/url.rb
+- lib/look_like/nested-array-matcher.rb
+- lib/look_like/rspec-matcher.rb
+- lib/look_like/support.rb
 - lib/look_like/version.rb
-- lib/matchers/equality.rb
-- lib/matchers/rspec-matcher.rb
 - look_like.gemspec
-- look_like.iml
 homepage: http://amoeba.social
 licenses:
 - MIT

data/lib/matchers/equality.rb

@@ -1,12 +0,0 @@
-LookLike::Matchers.define({
-                              :name     => :equality,
-                              :desc     => "",
-                              :priority => 6,
-                              :select   => lambda{|keyword|
-                                true
-                              },
-                              :match    => lambda{|actual, expected|
-                                actual == expected
-                              }
-                          })
-

data/lib/matchers/rspec-matcher.rb

@@ -1,17 +0,0 @@
-require 'rspec/expectations'
-
-RSpec::Matchers.define :look_like do |expected|
-  messages = {}
-
-  match do |actual|
-    messages[actual] = LookLike::Matchers.find(expected).match(actual, expected)
-  end
-
-  def method_name(actual, actual_desc, expected, expected_desc)
-    "expected  \"#{actual}\" (#{actual_desc}), \nto look like \"#{expected}\" (#{expected_desc})"
-  end
-
-  failure_message do |actual|
-    messages[actual]
-  end
-end

data/look_like.iml

@@ -1,28 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="RUBY_MODULE" version="4">
-  <component name="FacetManager">
-    <facet type="gem" name="Ruby Gem">
-      <configuration>
-        <option name="GEM_APP_ROOT_PATH" value="$MODULE_DIR$" />
-        <option name="GEM_APP_TEST_PATH" value="$MODULE_DIR$/test" />
-        <option name="GEM_APP_LIB_PATH" value="$MODULE_DIR$/lib" />
-      </configuration>
-    </facet>
-  </component>
-  <component name="NewModuleRootManager" inherit-compiler-output="true">
-    <exclude-output />
-    <content url="file://$MODULE_DIR$">
-      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
-    </content>
-    <orderEntry type="jdk" jdkName="rbenv: 2.1.4" jdkType="RUBY_SDK" />
-    <orderEntry type="sourceFolder" forTests="false" />
-    <orderEntry type="library" scope="PROVIDED" name="bundler (v1.13.0.rc.1, rbenv: 2.1.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.2.5, rbenv: 2.1.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rake (v11.2.2, rbenv: 2.1.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec (v3.5.0, rbenv: 2.1.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.5.3, rbenv: 2.1.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.5.0, rbenv: 2.1.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.5.0, rbenv: 2.1.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.5.0, rbenv: 2.1.4) [gem]" level="application" />
-  </component>
-</module>