simulacrum 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d1b6233672c83d949f344855c79433f80bcd2ba
-  data.tar.gz: 072cbe46dfb9e299a6984e297f90c482b5cb078f
+  metadata.gz: 1b5b48daea9a3ccb62a51dbfaa8ead40fa214479
+  data.tar.gz: 52f41223d9880503bf2e783d602d41c30c5bed49
 SHA512:
-  metadata.gz: 9e244c3e86ea41cf169d19d89fc2efd97b00dad9ddee1791137e7e265f92df59af52bceed9d2a4f0dcd2abed0fa91cc9e1a21e705910ccb7d83e5e574517c961
-  data.tar.gz: 942d760733846fb7848c9b7bf638709ae341f719a3544b9c62bc18e8fdf955a9badf38a3f4d1bd5bd309337b0aec1e89758bceff4a9e8bf464be0940636e379a
+  metadata.gz: b1bbad472aac323605eec0c96cb07ec5357d2727e6ec9350eeacbf61e4aa9b7bfde72441f0a817d1cb627f8fa15fad0e1597f8354d27c00abc11e185726292da
+  data.tar.gz: 3ad97708041025834d64e6499a3bbb45b524e6883abd74e7a14758653c617c042dbba5600e9e520382fbdfc089a04db645f3d0efc8b8b493d340fb336a9fc3b3

data/.cane

@@ -0,0 +1,9 @@
+--abc-max 10
+--no-style
+--color
+--abc-exclude Simulacrum::Runner::Base#configure_rspec
+--abc-exclude Simulacrum::Driver::BrowserstackDriver#capabilities
+--abc-exclude Simulacrum::Runner::BrowserstackRunner#configure_environment
+--abc-exclude Simulacrum::CLI::Parser#add_runner_options
+--abc-exclude Simulacrum::Browserstack::Summary#dump_commands_to_rerun_failed_examples
+--abc-exclude Simulacrum::Browserstack::Tunnel#ensure_open

data/.env.example

@@ -0,0 +1,2 @@
+SAUCE_USERNAME=
+SAUCE_ACCESS_KEY=

data/.gitignore

@@ -0,0 +1,10 @@
+bin
+/pkg
+/tmp
+/coverage
+/examples/**/references/**/*
+.bundle
+*.sublime-workspace
+*.sublime-project
+Gemfile.lock
+.env

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--profile
+--format progress

data/.rubocop.yml

@@ -0,0 +1,14 @@
+inherit_from: rubocop-todo.yml
+
+AllCops:
+  Include:
+    - bin/simulacrum
+  Exclude:
+    - examples/*
+    - examples/**/*
+    - bin/*
+    - spec/use_simplecov.rb
+
+TrivialAccessors:
+  Exclude:
+    - lib/simulacrum.rb

data/.travis.yml

@@ -0,0 +1,28 @@
+language: ruby
+rvm:
+  - ruby-head
+  - 2.1.1
+  - 2.0
+bundler_args: "--binstubs --standalone --without documentation --path ../bundle"
+cache: bundler
+script:
+  - script/spec
+addons:
+  sauce_connect: true
+  code_climate:
+    repo_token: e5d708da3fc981c10c3d7f95725436b02a0577d21e7ef84514e82057bf2559f0
+matrix:
+  include:
+    - rvm: 2.1.1
+      env: COVERAGE=true
+  allow_failures:
+    - rvm: ruby-head
+  fast_finish: true
+env:
+  global:
+    - AUTOMATE_PROJECT="$TRAVIS_REPO_SLUG"
+    - AUTOMATE_BUILD="Travis build No. $TRAVIS_BUILD_NUMBER for $TRAVIS_REPO_SLUG"
+    - secure: I3cJCwxNLnMsszfwZJNKLhEiseXi2aoz/2PmMa+6sJoPFfRYN6iVTBVtUEHipX3FnGx+rba8tRggcrDfVdvz4h8Pkq+znUfgXpbbta2yRw/zmQjvxxNxsKXAJJvgQ1vPArFukdEXURckIXMxZAHmmeU0NSV61MPD3zbJu36w5OA=
+    - secure: VlisKWdR03cbqSw530do5gnfkmttz1mctdOA4FwMp+KFurfPLFYoMpldxvHzricuB97OuiroBiopEas4Xey5XDjGr1Puklb47UIhqxx+XsBQ0xhd4ZfRZ1hvBCEI1dMSBrwwwq9QXt0gKp0f4ORGqOv6Fg7MrSExthQT9W8AfXs=
+    - secure: PcVAVdrUj1z7fztYklzExbkxCkwEgdKaaSt4eQNNuxdBvj8MwDAp7JvKasqAALBLJgcthj+jt+BU2l3LABPZyZPkl6A6FstoXvmK0fUAPr2k9InuiFX6UgybNKvhIQOyF++9bw0kCTZlkGn3KSw0vLZAx10/+XCb8mu7ghwylrI=
+    - secure: IO5ls6xcCpbgxEJFpKJhh5WT1FxwZOiwdhXs2OMElPCDAoMrQcooClvlSG6MWAY344F9p6jS3JFy0m8AZWw9IuJr5HeS36o5HS1Zf1+A/Awe8BDkyfHZTORZPU6VucFfLmZxgDXSFAmKxTaXUPhPQGXGbXuvT8KdkbqT43eA2HI=

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -1,45 +1,104 @@
 ## Simulacrum
 
-An opinionated UI component regression testing tool built to be tightly integrated with RSpec, Selenium and tools you already use.
+[![Build Status](http://img.shields.io/travis/plasticine/simulacrum.svg?style=flat)][travis]
+[![Code Climate](http://img.shields.io/codeclimate/github/plasticine/simulacrum.svg?style=flat)][codeclimate]
+[![Code Climate](http://img.shields.io/codeclimate/coverage/github/plasticine/simulacrum.svg?style=flat)][codeclimate]
+[![Dependency Status](http://img.shields.io/gemnasium/plasticine/simulacrum.svg?style=flat)][gemnasium]
+[![Gem Version](http://img.shields.io/gem/v/simulacrum.svg?style=flat)][gem_version]
+
+**Simulacrum is a UI regression testing tool. It helps you write unit-like tests for
+user-interface components in web applications.**
+
+It is built around common tools such as [RSpec], [Capybara] & [Selenium Webdriver].
+
+Support for 3rd party Selenium Webdriver services (such as [Browserstack], and [Saucelabs]) is provided via additional collaborating gems;
+
+|                  |                                                                                             | Status |
+| ---------------- |:------------------------------------------------------------------------------------------- |:------:|
+| **Browserstack** | [plasticine/simulacrum-browserstack](https://github.com/plasticine/simulacrum-browserstack) | WIP 🚧 |
+| **Saucelabs**    | [plasticine/simulacrum-saucelabs](https://github.com/plasticine/simulacrum-saucelabs)       | WIP 🚧 |
+
+#### Does this sound like something you might be interested in?
+
+- Test your UI components visually
+- Know when a component is visually altered
+- Integrate with
+- Test component behaviour (JS) that manipulates visual appearance
 
 ***
 
-### Installing
-`gem 'simulacrum'`
+### UI Regression Testing
 
-### Configuring
+Explain the use-case better.
+
+### Opinions
+
+Simulacrum is a little bit opinionated about a few things;
+
+- selenium webdriver (browserstack)
+- testing components
+
+It would be good to explain these opinions, the reason for them and why they are good.
+
+## Setup
+Simulacrum requires Ruby 1.9.3 or later. To install, add this line to your Gemfile and run `bundle install`:
+
+Create a spec helper file for simulacrum — `simulacrum_helper.rb` — and throw this junk in it:
 
 ```ruby
-RSpec.configure do |config|
-  include Simulacrum
-end
+gem 'simulacrum'
+```
+
+The next step is to create a `simulacrum_helper.rb` helper file, and then require Simulacrum there:
+
+```ruby
+require 'simulacrum'
 ```
 
-Simulacrum can also be configured once included;
+Then you can configure Simulacrum within Rspec:
 
 ```ruby
 RSpec.configure do |config|
-	include Simulacrum
+  include Simulacrum
 
-	Simulacrum.configure do |simulacrum|
-		simulacrum.images_path = 'somewhere/example/spec/ui_specs'
-		simulacrum.acceptable_delta = 0.1 # allow a maximum of 0.1% difference
-		config.defaults.capture_selector = '.kayessess__examples'
-	end
+  Simulacrum.configure do |config|
+    config.defaults.acceptable_delta = 1 # up to 1% percentage change allowed
+    config.defaults.capture_selector = '.components__examples' # CSS selector to crop reference image to
+  end
 end
 ```
 
-### Opinions
+## Usage
 
-### Usage
+```shell
+simulacrum --help
+```
 
-Simulacrum provides a small DSL for configuring and managing UI tests from within Rspec. Basically it boils down to these three methods;
+
+
+
+<!-- Simulacrum provides a small DSL for configuring and managing UI tests from within Rspec. Basically it boils down to these three methods;
 
 - `component`
 - `configure_browser`
-- `look_the_same`
+- `look_the_same` -->
 
-#### Inspiration
+***
+
+#### Inspiration / Similar tools
 
 - Huxley
 - Green Onion
+
+
+[huxley]: 			      https://github.com/facebook/huxley
+[green_onion]:  		  http://intridea.github.io/green_onion
+[Browserstack]:       http://www.browserstack.com
+[Saucelabs]:          https://saucelabs.com
+[RSpec]:              http://rspec.info
+[Capybara]:           https://github.com/jnicklas/capybara
+[Selenium Webdriver]: http://docs.seleniumhq.org/projects/webdriver/
+[codeclimate]:        https://codeclimate.com/github/plasticine/simulacrum
+[travis]:             https://travis-ci.org/plasticine/simulacrum
+[gemnasium]:          https://gemnasium.com/plasticine/simulacrum
+[gem_version]:        http://badge.fury.io/rb/simulacrum

data/Rakefile

@@ -0,0 +1,20 @@
+#!/usr/bin/env rake
+require 'rspec/core/rake_task'
+require 'cane/rake_task'
+require 'rdoc/task'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc 'Generate documentation for the Simulacrum plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Simulacrum'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Run cane to check quality metrics'
+Cane::RakeTask.new(:quality) do |cane|
+  cane.canefile = '.cane'
+end

data/examples/README.md

@@ -0,0 +1,3 @@
+# Simulacrum Usage Examples
+
+- Basic usage

data/examples/basic/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'sinatra'
+gem 'simulacrum', path: '../../'

data/examples/basic/README.md

@@ -0,0 +1,13 @@
+# Simulacrum Example App
+
+Serve some files;
+
+```
+./script/start
+```
+
+Then in a new terminal window:
+
+```
+simulacrum
+```

data/examples/basic/config.ru

@@ -0,0 +1,3 @@
+require './example_app'
+
+run ExampleApp.new

data/examples/basic/example_app.rb

@@ -0,0 +1,7 @@
+require 'sinatra/base'
+
+class ExampleApp < Sinatra::Application
+  set :public_folder, File.dirname(__FILE__) + '/public'
+
+  run! if app_file == $PROGRAM_NAME
+end

data/examples/basic/public/button.html

@@ -0,0 +1,13 @@
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <title>Simulacrum Example — Button</title>
+    <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no,user-scalable=0">
+    <link rel="stylesheet" href="/stylesheets/normalize.css">
+    <link rel="stylesheet" href="/stylesheets/main.css">
+    <link rel="stylesheet" href="/stylesheets/button.css">
+  </head>
+  <body>
+    <a href="#" class="button">This is my super sweet example button!</a>
+  </body>
+</html>

data/examples/basic/public/index.html

@@ -0,0 +1,22 @@
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <title>Simulacrum Example — Index</title>
+    <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no,user-scalable=0">
+    <link rel="stylesheet" href="/stylesheets/normalize.css">
+    <link rel="stylesheet" href="/stylesheets/main.css">
+  </head>
+  <body>
+    <h4>Example Components</h4>
+    <nav>
+      <ul>
+        <li>
+          <a href="/button.html">Button</a>
+        </li>
+        <li>
+          <a href="/panel.html">Panel</a>
+        </li>
+      </ul>
+    </nav>
+  </body>
+</html>

data/examples/basic/public/panel.html

@@ -0,0 +1,13 @@
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <title>Simulacrum Example — Panel</title>
+    <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no,user-scalable=0">
+    <link rel="stylesheet" href="/stylesheets/normalize.css">
+    <link rel="stylesheet" href="/stylesheets/main.css">
+    <link rel="stylesheet" href="/stylesheets/panel.css">
+  </head>
+  <body>
+    TODO
+  </body>
+</html>

data/examples/basic/public/stylesheets/button.css

@@ -0,0 +1,15 @@
+.button {
+  border-radius: 5px;
+  border: 3px solid currentColor;
+  color: #4A90E2;
+  display: inline-block;
+  font-weight: 600;
+  padding: 1em 2em;
+  text-decoration: none;
+}
+
+.button:hover {
+  background-color: #4A90E2;
+  color: #fff;
+  border-color: #4A90E2;
+}

data/examples/basic/public/stylesheets/main.css

@@ -0,0 +1,3 @@
+html {
+  padding: 3em;
+}

data/examples/basic/public/stylesheets/normalize.css

@@ -0,0 +1,425 @@
+/*! normalize.css v3.0.1 | MIT License | git.io/normalize */
+
+/**
+ * 1. Set default font family to sans-serif.
+ * 2. Prevent iOS text size adjust after orientation change, without disabling
+ *    user zoom.
+ */
+
+html {
+  font-family: sans-serif; /* 1 */
+  -ms-text-size-adjust: 100%; /* 2 */
+  -webkit-text-size-adjust: 100%; /* 2 */
+}
+
+/**
+ * Remove default margin.
+ */
+
+body {
+  margin: 0;
+}
+
+/* HTML5 display definitions
+   ========================================================================== */
+
+/**
+ * Correct `block` display not defined for any HTML5 element in IE 8/9.
+ * Correct `block` display not defined for `details` or `summary` in IE 10/11 and Firefox.
+ * Correct `block` display not defined for `main` in IE 11.
+ */
+
+article,
+aside,
+details,
+figcaption,
+figure,
+footer,
+header,
+hgroup,
+main,
+nav,
+section,
+summary {
+  display: block;
+}
+
+/**
+ * 1. Correct `inline-block` display not defined in IE 8/9.
+ * 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera.
+ */
+
+audio,
+canvas,
+progress,
+video {
+  display: inline-block; /* 1 */
+  vertical-align: baseline; /* 2 */
+}
+
+/**
+ * Prevent modern browsers from displaying `audio` without controls.
+ * Remove excess height in iOS 5 devices.
+ */
+
+audio:not([controls]) {
+  display: none;
+  height: 0;
+}
+
+/**
+ * Address `[hidden]` styling not present in IE 8/9/10.
+ * Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22.
+ */
+
+[hidden],
+template {
+  display: none;
+}
+
+/* Links
+   ========================================================================== */
+
+/**
+ * Remove the gray background color from active links in IE 10.
+ */
+
+a {
+  background: transparent;
+}
+
+/**
+ * Improve readability when focused and also mouse hovered in all browsers.
+ */
+
+a:active,
+a:hover {
+  outline: 0;
+}
+
+/* Text-level semantics
+   ========================================================================== */
+
+/**
+ * Address styling not present in IE 8/9/10/11, Safari, and Chrome.
+ */
+
+abbr[title] {
+  border-bottom: 1px dotted;
+}
+
+/**
+ * Address style set to `bolder` in Firefox 4+, Safari, and Chrome.
+ */
+
+b,
+strong {
+  font-weight: bold;
+}
+
+/**
+ * Address styling not present in Safari and Chrome.
+ */
+
+dfn {
+  font-style: italic;
+}
+
+/**
+ * Address variable `h1` font-size and margin within `section` and `article`
+ * contexts in Firefox 4+, Safari, and Chrome.
+ */
+
+h1 {
+  font-size: 2em;
+  margin: 0.67em 0;
+}
+
+/**
+ * Address styling not present in IE 8/9.
+ */
+
+mark {
+  background: #ff0;
+  color: #000;
+}
+
+/**
+ * Address inconsistent and variable font size in all browsers.
+ */
+
+small {
+  font-size: 80%;
+}
+
+/**
+ * Prevent `sub` and `sup` affecting `line-height` in all browsers.
+ */
+
+sub,
+sup {
+  font-size: 75%;
+  line-height: 0;
+  position: relative;
+  vertical-align: baseline;
+}
+
+sup {
+  top: -0.5em;
+}
+
+sub {
+  bottom: -0.25em;
+}
+
+/* Embedded content
+   ========================================================================== */
+
+/**
+ * Remove border when inside `a` element in IE 8/9/10.
+ */
+
+img {
+  border: 0;
+}
+
+/**
+ * Correct overflow not hidden in IE 9/10/11.
+ */
+
+svg:not(:root) {
+  overflow: hidden;
+}
+
+/* Grouping content
+   ========================================================================== */
+
+/**
+ * Address margin not present in IE 8/9 and Safari.
+ */
+
+figure {
+  margin: 1em 40px;
+}
+
+/**
+ * Address differences between Firefox and other browsers.
+ */
+
+hr {
+  -moz-box-sizing: content-box;
+  box-sizing: content-box;
+  height: 0;
+}
+
+/**
+ * Contain overflow in all browsers.
+ */
+
+pre {
+  overflow: auto;
+}
+
+/**
+ * Address odd `em`-unit font size rendering in all browsers.
+ */
+
+code,
+kbd,
+pre,
+samp {
+  font-family: monospace, monospace;
+  font-size: 1em;
+}
+
+/* Forms
+   ========================================================================== */
+
+/**
+ * Known limitation: by default, Chrome and Safari on OS X allow very limited
+ * styling of `select`, unless a `border` property is set.
+ */
+
+/**
+ * 1. Correct color not being inherited.
+ *    Known issue: affects color of disabled elements.
+ * 2. Correct font properties not being inherited.
+ * 3. Address margins set differently in Firefox 4+, Safari, and Chrome.
+ */
+
+button,
+input,
+optgroup,
+select,
+textarea {
+  color: inherit; /* 1 */
+  font: inherit; /* 2 */
+  margin: 0; /* 3 */
+}
+
+/**
+ * Address `overflow` set to `hidden` in IE 8/9/10/11.
+ */
+
+button {
+  overflow: visible;
+}
+
+/**
+ * Address inconsistent `text-transform` inheritance for `button` and `select`.
+ * All other form control elements do not inherit `text-transform` values.
+ * Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera.
+ * Correct `select` style inheritance in Firefox.
+ */
+
+button,
+select {
+  text-transform: none;
+}
+
+/**
+ * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio`
+ *    and `video` controls.
+ * 2. Correct inability to style clickable `input` types in iOS.
+ * 3. Improve usability and consistency of cursor style between image-type
+ *    `input` and others.
+ */
+
+button,
+html input[type="button"], /* 1 */
+input[type="reset"],
+input[type="submit"] {
+  -webkit-appearance: button; /* 2 */
+  cursor: pointer; /* 3 */
+}
+
+/**
+ * Re-set default cursor for disabled elements.
+ */
+
+button[disabled],
+html input[disabled] {
+  cursor: default;
+}
+
+/**
+ * Remove inner padding and border in Firefox 4+.
+ */
+
+button::-moz-focus-inner,
+input::-moz-focus-inner {
+  border: 0;
+  padding: 0;
+}
+
+/**
+ * Address Firefox 4+ setting `line-height` on `input` using `!important` in
+ * the UA stylesheet.
+ */
+
+input {
+  line-height: normal;
+}
+
+/**
+ * It's recommended that you don't attempt to style these elements.
+ * Firefox's implementation doesn't respect box-sizing, padding, or width.
+ *
+ * 1. Address box sizing set to `content-box` in IE 8/9/10.
+ * 2. Remove excess padding in IE 8/9/10.
+ */
+
+input[type="checkbox"],
+input[type="radio"] {
+  box-sizing: border-box; /* 1 */
+  padding: 0; /* 2 */
+}
+
+/**
+ * Fix the cursor style for Chrome's increment/decrement buttons. For certain
+ * `font-size` values of the `input`, it causes the cursor style of the
+ * decrement button to change from `default` to `text`.
+ */
+
+input[type="number"]::-webkit-inner-spin-button,
+input[type="number"]::-webkit-outer-spin-button {
+  height: auto;
+}
+
+/**
+ * 1. Address `appearance` set to `searchfield` in Safari and Chrome.
+ * 2. Address `box-sizing` set to `border-box` in Safari and Chrome
+ *    (include `-moz` to future-proof).
+ */
+
+input[type="search"] {
+  -webkit-appearance: textfield; /* 1 */
+  -moz-box-sizing: content-box;
+  -webkit-box-sizing: content-box; /* 2 */
+  box-sizing: content-box;
+}
+
+/**
+ * Remove inner padding and search cancel button in Safari and Chrome on OS X.
+ * Safari (but not Chrome) clips the cancel button when the search input has
+ * padding (and `textfield` appearance).
+ */
+
+input[type="search"]::-webkit-search-cancel-button,
+input[type="search"]::-webkit-search-decoration {
+  -webkit-appearance: none;
+}
+
+/**
+ * Define consistent border, margin, and padding.
+ */
+
+fieldset {
+  border: 1px solid #c0c0c0;
+  margin: 0 2px;
+  padding: 0.35em 0.625em 0.75em;
+}
+
+/**
+ * 1. Correct `color` not being inherited in IE 8/9/10/11.
+ * 2. Remove padding so people aren't caught out if they zero out fieldsets.
+ */
+
+legend {
+  border: 0; /* 1 */
+  padding: 0; /* 2 */
+}
+
+/**
+ * Remove default vertical scrollbar in IE 8/9/10/11.
+ */
+
+textarea {
+  overflow: auto;
+}
+
+/**
+ * Don't inherit the `font-weight` (applied by a rule above).
+ * NOTE: the default cannot safely be changed in Chrome and Safari on OS X.
+ */
+
+optgroup {
+  font-weight: bold;
+}
+
+/* Tables
+   ========================================================================== */
+
+/**
+ * Remove most spacing between table cells.
+ */
+
+table {
+  border-collapse: collapse;
+  border-spacing: 0;
+}
+
+td,
+th {
+  padding: 0;
+}