goggles 0.1.0 → 0.1.1

data/.gitignore

@@ -17,3 +17,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+empty_config.yml

data/README.md

@@ -1,4 +1,5 @@
 # goggles
+[![Gem Version](https://badge.fury.io/rb/goggles.png)](http://badge.fury.io/rb/goggles)
 
 Goggles is a visual testing tool inspired by [wraith](http://github.com/bbc-news/wraith) and powered by [watir-webdriver](http://github.com/watir/watir-webdriver). It allows you to compare screenshots of your web application in different browsers, and you can execute Ruby scripts to setup as many screenshots as you need.
 
@@ -23,27 +24,30 @@ Or install it yourself with:
 
 ## Usage
 
-Create a config file to point goggles in the right direction.
+Generate a config file with `swim --init` to point goggles in the right direction.
+
+    $ swim -i /home/configs/config.yaml
+
 ``` yaml
 # config.yaml
 # Directory where you want to store your results. Required.
-results_directory: "/home/results"
+results_directory: "/home/example/results"
 
 # Directory where you're storing your scripts. Optional.
-scripts_directory: "/home/scripts"
+scripts_directory: "/home/example/scripts"
 
 # Scripts to execute in the scripts directory. Optional.
 scripts_to_execute:
-  - "search.rb"
-  - "login.rb"
+  - "first_script.rb"
+  - "second_script.rb"
 
 # Domain to test. Required.
-domain_under_test: "http://www.manta.com"
+domain_under_test: "http://www.google.com"
 
 # Paths to pages you want to test. Label them with a page name. Required.
 paths_to_capture: 
   home: "/"
-  search: "/mb"
+  gmail: "/gmail"
 
 # Browsers you want to compare. Cannot specify more than two (yet). Required.
 browsers:
@@ -53,14 +57,12 @@ browsers:
 # Widths at which you would like screenshots compared. All screenshots will be taken at a height of 768. Required.
 browser_widths:
   - 1024
-  - 600
-  - 320
 
 # Fuzzing percentage. Play around with this to find the right fit. Required.
 image_fuzzing: "20%"
 ```
 
-If you pass scripts to goggles as part of your testing, you **must** specify when screenshots should be taken with the `#grab_screenshot` method. Otherwise, goggles will open each of your paths and take a screenshot.
+If you pass scripts to goggles as part of your testing, you **must** specify when screenshots should be taken with the `#grab_screenshot` method. If you do not specify scripts in configuration, goggles will open each of your paths and take a screenshot.
 
 NOTE: I've tried to keep variable names as unlikely to interrupt your code as possible, but `@watir` is reserved for the browser instance currently executing scripts.
 
@@ -81,6 +83,12 @@ Execute a goggles test through the command line with `swim --config CONFIG_FILE`
 
 1. Fork it ( http://github.com/jdenen/goggles/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+3. Code until specs pass (`rspec`)*
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+
+\*Chrome and [ChromeDriver](http://code.google.com/p/selenium/wiki/ChromeDriver) are required to pass specs. Download the latest version and add it to your PATH before running `rspec`.
+
+## Questions, Comments, Concerns
+Easiest place to reach me is Twitter, [@jpdenen](http://twitter.com/jpdenen)

data/lib/goggles/cli.rb

@@ -1,5 +1,6 @@
 require 'goggles'
 require 'optparse'
+require 'pathname'
 
 module Goggles
   class CLI
@@ -14,6 +15,16 @@ module Goggles
           run_conf(config)
         end
 
+        opts.on("-i", "--init CONFIG_FILE", "create empty config file") do |config|
+          file = Pathname.new(config)
+
+          if file.exist?
+            puts "Configuration file already exists: #{Pathname.new(config).realpath}"
+          else
+            File.open(file, 'w+') { |f| f.write(YAML::dump(EMPTY_CONFIG)) }
+          end
+        end
+
         opts.on("-v", "--version", "Goggles::VERSION") do
           puts Goggles::VERSION
         end
@@ -34,5 +45,15 @@ module Goggles
       end
     end
 
+    EMPTY_CONFIG = {
+      'results_directory' => "/home/example/results",
+      'scripts_directory' => "/home/example/scripts",
+      'scripts_to_execute' => ["first_example.rb", "second_example.rb"],
+      'domain_under_test' => "http://www.google.com",
+      'paths_to_capture' => { 'home' => "/", 'gmail' => "/gmail" },
+      'browsers' => ["chrome", "firefox"],
+      'browser_widths' => [1024, 600],
+      'image_fuzzing' => "20%"
+    }
   end
 end

data/lib/goggles/version.rb

@@ -1,3 +1,3 @@
 module Goggles
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/goggles_spec.rb

@@ -31,4 +31,11 @@ describe Goggles do
     end
   end
 
+  describe "creating empty configuration with --init" do
+    Given(:conf) { "spec/support/configs/empty_config.yml" }
+    Given { FileUtils.rm_f conf }
+    When { `swim -i #{conf}` }
+    Then { File.exists?(conf).should be_true }
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: goggles
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-20 00:00:00.000000000 Z
+date: 2014-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler