hollandaise 0.1.0

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+index.html
+screenshots/
+.DS_Store
+chromedriver.log
+

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 John Bintz
+
+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,43 @@
+# Hollandaise sauce is a delicious delicacy.
+
+    TODO: Easily take a bunch of screenshots using Sauce Labs or with your local browsers
+    FIXME: The method for instantiating Sauce Labs Selenium WebDriver browsers
+    TODO: Run all the screenshot taking in parallel for SPEEDS
+    BUG: Find them and destroy them!
+
+## Preparation and Serving
+
+* `gem install hollandaise`
+* Create a ~/.sauce/ondemand.yml with:
+
+    username: my-sauce-labs-username
+    access_key: my-secret-access-key
+
+* `hollandaise sauce http://my.cool.website/url/to/test/ browser browser ...`
+
+Browsers! Locally, using Selenium:
+
+* `firefox`
+* `chrome`
+
+On Sauce labs:
+
+* `ie7`
+* `ie8`
+* `ie9`
+* `chromewin`
+* `ffwin10`
+
+### Projects
+
+`hollandaise project NAME` creates a new `hollandaise.rb` file. Fill it in with your project details.
+`hollandaise cook` runs that project, making appropriately-named directories. Sweet!
+
+## Adding your own ingredients
+
+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
+6. Be *awesome*.

data/Rakefile

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

data/bin/hollandaise

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'thor'
+require 'builder'
+
+$: << File.expand_path('../../lib', __FILE__)
+
+require 'hollandaise'
+require 'hollandaise/cli'
+
+begin
+  load File.join(Dir.pwd, 'hollandaise.rb')
+rescue LoadError => e
+end
+
+Hollandaise::CLI.start
+

data/hollandaise.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/hollandaise/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["John Bintz"]
+  gem.email         = ["john@coswellproductions.com"]
+  gem.description   = %q{Get delicious screenshots from Sauce Labs, easily}
+  gem.summary       = %q{Get delicious screenshots from Sauce Labs, easily}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "hollandaise"
+  gem.require_paths = ["lib"]
+  gem.version       = Hollandaise::VERSION
+
+  gem.add_dependency 'sauce'
+  gem.add_dependency 'capybara'
+  gem.add_dependency 'thor'
+  gem.add_dependency 'arbre'
+end
+

data/hollandaise.rb

@@ -0,0 +1,9 @@
+Hollandaise.project "cats" do |p|
+  p.root 'http://my.site/'
+
+  p.screenshot 'Home', '/'
+  p.screenshot 'Archive', '/archive'
+
+  p.browsers :chrome
+end
+

data/lib/hollandaise.rb

@@ -0,0 +1,41 @@
+require "hollandaise/version"
+require 'hollandaise/browsers'
+require 'hollandaise/project'
+require 'hollandaise/browser'
+
+module Hollandaise
+  class << self
+    attr_accessor :url, :browsers, :delay
+  end
+
+  def self.configure
+    yield self
+  end
+
+  def self.project(name)
+    project = Project.new(name)
+    projects << project
+
+    yield project
+
+    project
+  end
+
+  def self.dir
+    @dir ||= Pathname("screenshots")
+  end
+
+  def self.chdir(name)
+    _odir = dir.clone
+    @dir = @dir.join(name)
+
+    yield
+
+    @dir = _odir
+  end
+
+  def self.projects
+    @projects ||= []
+  end
+end
+

data/lib/hollandaise/browser.rb

@@ -0,0 +1,19 @@
+require 'hollandaise/browser/base'
+require 'hollandaise/browser/sauce'
+require 'hollandaise/browser/selenium'
+
+module Hollandaise
+  module Browser
+    def self.for(browser, options)
+      browser = browser.dup
+
+      case browser.shift
+      when :sauce
+        Hollandaise::Browser::Sauce.new(*browser, options)
+      when :selenium
+        Hollandaise::Browser::Selenium.new(*browser, options)
+      end
+    end
+  end
+end
+

data/lib/hollandaise/browser/base.rb

@@ -0,0 +1,33 @@
+module Hollandaise
+  module Browser
+    class Base
+      attr_reader :browser
+
+      def run_and_take_screenshot(url)
+        @url = url
+
+        selenium.navigate.to url
+        sleep @options[:delay].to_i
+        selenium.execute_script %{window.resizeTo(1280, 1024)}
+        take_screenshot
+      end
+
+      def take_screenshot
+        target.parent.mkpath
+
+        selenium.save_screenshot(target.to_s)
+      end
+
+      def close
+        selenium.quit
+
+        @selenium = nil
+      end
+
+      def dir
+        Hollandaise.dir
+      end
+    end
+  end
+end
+

data/lib/hollandaise/browser/sauce.rb

@@ -0,0 +1,31 @@
+module Hollandaise
+  module Browser
+    class Sauce < Base
+      def initialize(browser, version, os, options)
+        @browser, @version, @os, @options = browser, version, os, options
+      end
+
+      def selenium
+        require 'sauce'
+        require 'sauce/selenium'
+
+        @selenium ||= ::Sauce::Selenium2.new(info)
+      end
+
+      def target
+        dir.join(@os.to_s).join("#{@browser} #{@version}.png")
+      end
+
+      def info
+        {
+          :browser => @browser,
+          :browser_version => @version,
+          :os => @os,
+          :browser_url => @url,
+          :job_name => "#{@url}"
+        }
+      end
+    end
+  end
+end
+

data/lib/hollandaise/browser/selenium.rb

@@ -0,0 +1,20 @@
+module Hollandaise
+  module Browser
+    class Selenium < Base
+      def initialize(browser, options)
+        @browser, @options = browser, options
+      end
+
+      def selenium
+        require 'selenium/webdriver'
+
+        @selenium ||= ::Selenium::WebDriver.for(@browser)
+      end
+
+      def target
+        dir.join("#{@browser}.png")
+      end
+    end
+  end
+end
+

data/lib/hollandaise/browsers.rb

@@ -0,0 +1,53 @@
+module Hollandaise
+  class Browsers
+    def self.for(browsers, options = {})
+      new(browsers.flatten.collect { |browser| Hollandaise::Browser.for(self.send(browser), options) })
+    end
+
+    def self.ie7
+      [ :sauce, 'iexplore', '7', 'Windows 2003' ]
+    end
+
+    def self.ie8
+      [ :sauce, 'iexplore', '8', 'Windows 2003' ]
+    end
+
+    def self.ie9
+      [ :sauce, 'iexplore', '9', 'Windows 2008' ]
+    end
+
+    def self.ffwin10
+      [ :sauce, 'firefox', '10', 'Windows 2008' ]
+    end
+
+    def self.chromewin
+      [ :sauce, 'chrome', '', 'Windows 2008' ]
+    end
+
+    def self.firefox
+      [ :selenium, :firefox ]
+    end
+
+    def self.chrome
+      [ :selenium, :chrome ]
+    end
+
+    def initialize(browsers)
+      @browsers = browsers
+    end
+
+    def each(&block)
+      @browsers.each(&block)
+    end
+
+    def run
+      @browsers.each do |browser|
+        begin
+          yield browser
+        ensure
+          browser.close
+        end
+      end
+    end
+  end
+end

data/lib/hollandaise/cli.rb

@@ -0,0 +1,73 @@
+require 'arbre'
+require 'pathname'
+
+module Hollandaise
+  class CLI < Thor
+    include Thor::Actions
+    source_root File.expand_path('../../../skel', __FILE__)
+
+    desc "cook", "Use the config file and take all the screenshots listed in there"
+    def cook
+      Hollandaise.projects.each(&:run)
+    end
+
+    desc "project NAME", "Create a skeletal project file"
+    def project(name)
+      @name = name
+
+      template 'hollandaise.rb.tt', 'hollandaise.rb'
+    end
+
+    desc "sauce URL BROWSER BROWSER...", "Take screenshots of a URL on Sauce Labs"
+    method_options :delay => 0
+    def sauce(*browsers)
+      if browsers.first && browsers.first[%r{^http}]
+        url = browsers.shift
+      else
+        url = Hollandaise.url
+      end
+
+      if Hollandaise.browsers && browsers.empty?
+        browsers = Hollandaise.browsers
+      end
+
+      browser_objects = Hollandaise::Browsers.for(browsers, options)
+
+      browser_objects.run do |browser|
+        browser.run_and_take_screenshot(url)
+      end
+
+      html = Arbre::Context.new do
+        html do
+          head do
+            title "Sauce Labs screenshots for #{url}" 
+          end
+
+          body do
+            table do
+              thead do
+                tr do
+                  browser_objects.each do |browser|
+                    th browser.browser
+                  end
+                end
+              end
+
+              tbody do
+                browser_objects.each do |browser|
+                  td(:valign => :top) do
+                    img(:src => browser.target)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+
+      File.open('index.html', 'wb') { |fh| fh.print html.to_s }
+    end
+
+    default_task :sauce
+  end
+end

data/lib/hollandaise/project.rb

@@ -0,0 +1,45 @@
+require 'uri'
+
+module Hollandaise
+  class Project
+    def initialize(project_name)
+      @project_name = project_name
+    end
+
+    def root(root)
+      @root = URI(root)
+    end
+
+    def screenshot(name, uri)
+      @screenshots ||= []
+
+      @screenshots << [ name, uri ]
+    end
+
+    def browsers(*browsers)
+      @browsers = browsers
+    end
+
+    def run
+      urls.each do |url, name|
+        Hollandaise.chdir "#{@project_name}/#{name}" do
+          browser_objects.run do |browser|
+            browser.run_and_take_screenshot(url)
+          end
+        end
+      end
+    end
+
+    private
+    def urls
+      @screenshots.collect do |name, uri|
+        [ @root.merge(URI(uri)), name ]
+      end
+    end
+
+    def browser_objects
+      @browser_objects ||= Hollandaise::Browsers.for(@browsers)
+    end
+  end
+end
+

data/lib/hollandaise/version.rb

@@ -0,0 +1,3 @@
+module Hollandaise
+  VERSION = "0.1.0"
+end

data/skel/hollandaise.rb.tt

@@ -0,0 +1,9 @@
+Hollandaise.project "<%= @name %>" do |p|
+  p.root 'http://my.site/'
+
+  p.screenshot 'Home', '/'
+  p.screenshot 'Archive', '/archive'
+
+  p.browsers :chrome
+end
+

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: hollandaise
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- John Bintz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sauce
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: arbre
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Get delicious screenshots from Sauce Labs, easily
+email:
+- john@coswellproductions.com
+executables:
+- hollandaise
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/hollandaise
+- hollandaise.gemspec
+- hollandaise.rb
+- lib/hollandaise.rb
+- lib/hollandaise/browser.rb
+- lib/hollandaise/browser/base.rb
+- lib/hollandaise/browser/sauce.rb
+- lib/hollandaise/browser/selenium.rb
+- lib/hollandaise/browsers.rb
+- lib/hollandaise/cli.rb
+- lib/hollandaise/project.rb
+- lib/hollandaise/version.rb
+- skel/hollandaise.rb.tt
+homepage: ''
+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.23
+signing_key: 
+specification_version: 3
+summary: Get delicious screenshots from Sauce Labs, easily
+test_files: []
+has_rdoc: