green_onion 0.1.1 → 0.1.3

data/README.md

@@ -1,5 +1,5 @@
 
-[<img src="https://secure.travis-ci.org/tomeara/green_onion.png" />](http://travis-ci.org/#!/tomeara/green_onion) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/tomeara/green_onion)
+[<img src="https://secure.travis-ci.org/intridea/green_onion.png" />](http://travis-ci.org/#!/intridea/green_onion) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/intridea/green_onion)
 
 # GreenOnion
 
@@ -60,13 +60,27 @@ For adding GreenOnion to your integration tests in RSpec, add `require 'green_on
 
     GreenOnion.configure do |c|
       c.skins_dir = 'your/path/to/skins'
+      c.skin_name = {
+        :match => /[\/]/, 
+        :replace => "_", 
+        :prefix => nil,
+        :root => "root" 
+      }
+      c.dimensions = { 
+        :width => 1440, 
+        :height => 768 
+      }
       c.threshold = 20
-      c.dimensions = { :width => 1440, :height => 768 }
     end
 
 * `skins_dir` is the directory that GreenOnion will store all skins. The namespace for skins is {URI name}.png (original), {URI name}_fresh.png (testing), and {URI name}_diff.png. The default directory will be './spec/skins'
-* `threshold` is the percentage of acceptable change that the screenshots can take. This number can always be overwritten for an instance.
+* `skin_name` is a hash that defines the skin namespace. The options include:
+    * `:match` - a regex pattern that will replace characters from the URI. The default pattern will match to all "/" in a URI.
+    * `:replace` - the string that replaces what is matched. These options are just abstractions of String.gsub in GreenOnion::Screenshot.
+    * `:prefix` - a value that will be concatenated to the front of the filename. A good example would be if you wanted to add a timestamp: `:prefix => Time.now.strftime("%m_%Y_")`.
+    * `:root` - the string that will be used to name the root of a domain.
 * `dimensions` is a hash with the height and width of the browser window. The default dimensions are 1024x768.
+* `threshold` is the percentage of acceptable change that the screenshots can take. This number can always be overwritten for an instance.
 
 Then use one of the three methods below in a test...
 
@@ -105,7 +119,7 @@ The best way to run the specs is with...
 * Screenshots can either be viewed as a visual diff, or overlayed newest over oldest and viewed as an onion-skin with sliding transparency.
 * Allow for flexibility in picking browsers
 * Skinner generator needs love <3
-** Should allow for testing using fixtures/factories
+    * Should allow for testing using fixtures/factories
 * More robust tests, especially around the visual diffs themselves
 * More documentation
 * More configuration/customizable settings

data/green_onion.gemspec

@@ -6,12 +6,10 @@ Gem::Specification.new do |gem|
   gem.email         = ["ted@intridea.com"]
   gem.description   = %q{UI testing/screenshot diffing tool}
   gem.summary       = %q{Regressions in the view making you cry? Have more confidence with GreenOnion.}
-  gem.homepage      = ""
+  gem.homepage      = "http://intridea.github.com/green_onion"
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec"
-  gem.add_development_dependency "pry"
-  gem.add_development_dependency "debugger"
   gem.add_development_dependency "sinatra"
   
   gem.add_dependency "capybara", "1.1.2"

data/lib/green_onion.rb

@@ -23,7 +23,8 @@ module GreenOnion
     def skin(url)
       @screenshot = Screenshot.new(
         :dir => @configuration.skins_dir,
-        :dimensions => @configuration.dimensions
+        :dimensions => @configuration.dimensions,
+        :skin_name => @configuration.skin_name
       )
       @compare = GreenOnion::Compare.new
 

data/lib/green_onion/configuration.rb

@@ -19,5 +19,22 @@ module GreenOnion
       @skins_dir ||= './spec/skins'
     end
 
+    def skin_name=(options)
+      @skin_name = skin_namespace_hash(options)
+    end
+
+    def skin_name
+      @skin_name ||= skin_namespace_hash
+    end
+
+    def skin_namespace_hash(options = {})
+      { 
+        :match   =>  options[:match] ? options[:match] : /[\/]/, 
+        :replace =>  options[:replace] ? options[:replace] : "_", 
+        :prefix  =>  options[:prefix] ? options[:prefix] : nil,
+        :root    =>  options[:root] ? options[:root] : "root"
+      }
+    end
+
   end
 end

data/lib/green_onion/screenshot.rb

@@ -6,13 +6,14 @@ module GreenOnion
   class Screenshot
     include Capybara::DSL
 
-    attr_accessor :dir, :dimensions 
+    attr_accessor :dir, :dimensions, :skin_name
     attr_reader :paths_hash
 
     def initialize(params = {})
       Capybara.default_driver = :webkit
       @dimensions = params[:dimensions]
       @dir = params[:dir]
+      @skin_name = params[:skin_name]
       @paths_hash = {}
     end
 
@@ -45,13 +46,19 @@ module GreenOnion
       end
     end
 
+    def file_namer
+      @filename.slice!(/^\//) # remove the beginning "/" if there is one
+      @filename = @filename.gsub(@skin_name[:match], @skin_name[:replace]) # by default, all "/" in a URI string will be replaced with "_"
+      @filename = @skin_name[:prefix] + @filename if @skin_name[:prefix] # add on a prefix defined in the configuration block
+      @paths_hash[:original] = "#{@dir}/#{@filename}.png"
+    end
+
     def get_path(url)
       url_matcher(url)
       if @filename.empty? || @filename == '/' 
-        @paths_hash[:original] = "#{@dir}/root.png"
+        @paths_hash[:original] = "#{@dir}/#{@skin_name[:root]}.png"
       else
-        @filename = @filename.gsub(/[\/]/, '')
-        @paths_hash[:original] = "#{@dir}/#{@filename}.png"
+        file_namer
       end
     end
 

data/lib/green_onion/version.rb

@@ -1,3 +1,3 @@
 module GreenOnion
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/spec/sample_app/sample_app.rb

@@ -18,4 +18,8 @@ class SampleApp < Sinatra::Base
     "<img src='onion_face_#{rand(2)}.jpg' />"
   end
 
+  get "/another/uri/string" do
+    "<h1>It was the best of times, it was the blorst of times.</h1>"
+  end
+
 end

data/spec/unit/green_onion_spec.rb

@@ -118,6 +118,42 @@ describe GreenOnion do
     end
   end
 
+  describe "Skins with custom file namespace" do
+
+    after(:each) do
+      FileUtils.rm_r(@tmp_path, :force => true)
+    end
+
+    it "should allow custom file namespacing" do  
+      GreenOnion.configure do |c|
+        c.skins_dir = @tmp_path
+        c.skin_name = { 
+          :match => /[\/a-z]/,
+          :replace => "-",
+          :prefix => "start",
+          :root => "first"
+        }
+      end
+      ( (GreenOnion.configuration.skin_name[:match] == /[\/a-z]/) && 
+        (GreenOnion.configuration.skin_name[:replace] == "-")     && 
+        (GreenOnion.configuration.skin_name[:prefix] == "start")  && 
+        (GreenOnion.configuration.skin_name[:root] == "first")  ).should be_true
+    end
+
+    it "should allow incomplete setting of skin_name hash" do  
+      GreenOnion.configure do |c|
+        c.skins_dir = @tmp_path
+        c.skin_name = { 
+          :replace => "o"
+        }
+      end
+      ( (GreenOnion.configuration.skin_name[:match] == /[\/]/) && 
+        (GreenOnion.configuration.skin_name[:replace] == "o")     && 
+        (GreenOnion.configuration.skin_name[:prefix] == nil)  && 
+        (GreenOnion.configuration.skin_name[:root] == "root")  ).should be_true
+    end
+  end
+
   describe "Errors" do
     before(:each) do  
       GreenOnion.configure do |c|

data/spec/unit/screenshot_spec.rb

@@ -14,7 +14,13 @@ describe GreenOnion::Screenshot do
     before(:each) do
       @screenshot = GreenOnion::Screenshot.new(
         :dir => @tmp_path,
-        :dimensions => @dimensions
+        :dimensions => @dimensions,
+        :skin_name => { 
+          :match => /[\/]/,
+          :replace => "",
+          :prefix => nil,
+          :root => "root"
+        }
       )
       @file = "#{@tmp_path}/fake_uri.png"
     end
@@ -51,7 +57,13 @@ describe GreenOnion::Screenshot do
     before(:each) do
       @screenshot = GreenOnion::Screenshot.new(
         :dir => @tmp_path,
-        :dimensions => @dimensions
+        :dimensions => @dimensions,
+        :skin_name => { 
+          :match => /[\/]/,
+          :replace => "",
+          :prefix => nil,
+          :root => "root"
+        }
       )
       @file1 = "#{@tmp_path}/fake_uri.png"
       @file2 = "#{@tmp_path}/fake_uri_fresh.png"
@@ -79,4 +91,54 @@ describe GreenOnion::Screenshot do
       ( File.exist?(@file1) && File.exist?(@file2) ).should be_false
     end
   end
+
+  describe "Custom filenaming" do
+
+    after(:each) do
+      FileUtils.rm_r(@tmp_path, :force => true)
+    end
+
+    it "should allow users to create a naming convention" do
+      @screenshot = GreenOnion::Screenshot.new(
+        :dir => @tmp_path,
+        :skin_name => { 
+          :match => /[\/]/, 
+          :replace => "#", 
+          :prefix => nil,
+          :root => "root"
+        }
+      )
+      @screenshot.get_path("#{@url}/another/uri/string")
+      @screenshot.paths_hash[:original].should eq("#{@tmp_path}/another#uri#string.png")
+    end
+
+    it "should allow filenames to have a timestamp" do
+      this_month = Time.now.strftime("%m_%Y_")
+      @screenshot = GreenOnion::Screenshot.new(
+        :dir => @tmp_path,
+        :skin_name => { 
+          :match => /[\/]/,
+          :replace => "-",
+          :prefix => this_month,
+          :root => "root"
+        }
+      )
+      @screenshot.get_path("#{@url}/another/uri/string")
+      @screenshot.paths_hash[:original].should eq("#{@tmp_path}/#{this_month}another-uri-string.png")
+    end
+
+     it "should allow renaming for root skins" do
+      @screenshot = GreenOnion::Screenshot.new(
+        :dir => @tmp_path,
+        :skin_name => { 
+          :match => /[\/]/,
+          :replace => "-",
+          :prefix => nil,
+          :root => "first"
+        }
+      )
+      @screenshot.get_path(@url)
+      @screenshot.paths_hash[:original].should eq("#{@tmp_path}/first.png")
+    end
+  end
 end

metadata

@@ -2,7 +2,7 @@
 name: green_onion
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors: 
 - Ted O'Meara
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-06 00:00:00 Z
+date: 2012-08-08 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -35,7 +35,7 @@ dependencies:
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: pry
+  name: sinatra
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -45,94 +45,72 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: debugger
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-  type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: sinatra
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-  type: :development
-  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: capybara
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
         version: 1.1.2
   type: :runtime
-  version_requirements: *id006
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: capybara-webkit
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
         version: 0.12.1
   type: :runtime
-  version_requirements: *id007
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: oily_png
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
         version: 1.0.2
   type: :runtime
-  version_requirements: *id008
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: rainbow
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
         version: 1.1.4
   type: :runtime
-  version_requirements: *id009
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: fileutils
   prerelease: false
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
         version: "0.7"
   type: :runtime
-  version_requirements: *id010
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: thor
   prerelease: false
-  requirement: &id011 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
         version: 0.15.4
   type: :runtime
-  version_requirements: *id011
+  version_requirements: *id009
 description: UI testing/screenshot diffing tool
 email: 
 - ted@intridea.com
@@ -170,7 +148,7 @@ files:
 - spec/unit/compare_spec.rb
 - spec/unit/green_onion_spec.rb
 - spec/unit/screenshot_spec.rb
-homepage: ""
+homepage: http://intridea.github.com/green_onion
 licenses: []
 
 post_install_message: