simulacrum 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c310ede91a08d7f1f3dc4a8117b2c819cbae6106
-  data.tar.gz: 0baa8198be24a7d440e3c18bc1f2cc3dcf7a155c
+  metadata.gz: 7687eec5b004b38792cf95b1c4dc725c060f9a00
+  data.tar.gz: 794e8cd0f33574cc2290cfcdb407b21a99c5d27e
 SHA512:
-  metadata.gz: 73c02e295c5a64c54b5698b9ab635b13949e539f0acbaa246be388b7179c90faf369ea90812e2e7ef0372c66efca1f12a513beba83b7c316efcd72a4d2ffab75
-  data.tar.gz: 43d26d53bbb8562d4bdf036a45206fd09830dc892661244d848f73537e40ba9e1566201d7d01781fdf4a780ca9956755ea4c5d3611e5444aae8e7b284741ad69
+  metadata.gz: 7e570746996c898fdaba924b2f885637640dae8c1734b433942ba1da5fcec94b1860daaa54b2df3aec0138c34be784fae34635d54d44b13994333460415a1a62
+  data.tar.gz: 1e356ca93bd87a2483f7e13855ac7eb561520d7e927f06619229fa4e1da97d70b29a37964d7c79d42b2509c05ff81f5d523c5b93eaf5dc94ee6898da6fab1605

data/lib/simulacrum/browser.rb

@@ -1,7 +1,44 @@
 require 'capybara'
-require 'capybara/dsl'
 
 module Simulacrum
   class Browser
+    attr_reader :name, :options
+
+    def initialize(name, options)
+      @name = name
+      @options = options
+    end
+
+    def use
+      register_driver
+      Capybara.default_driver = name.to_sym
+    end
+
+    def configure(config)
+      puts config.inspect
+    end
+
+    def capture_delay
+      @options.capture_delay || Simulacrum.configuration.capture_delay
+    end
+
+    def remote?
+      @options.remote.nil? ? false : @options.remote
+    end
+
+    private
+
+    def driver_options
+      options = { desired_capabilities: @options.caps }
+      options[:browser] = :remote if remote?
+      options[:url] = Simulacrum.configuration.remote_url if remote?
+      options
+    end
+
+    def register_driver
+      Capybara.register_driver name.to_sym do |app|
+        Capybara::Selenium::Driver.new(app, driver_options)
+      end
+    end
   end
 end

data/lib/simulacrum/browser_options.rb

@@ -0,0 +1,5 @@
+module Simulacrum
+  class BrowserOptions < OpenStruct
+
+  end
+end

data/lib/simulacrum/comparator.rb

@@ -1,4 +1,4 @@
-require_relative 'diff/rmagick'
+require_relative './diff/rmagick'
 
 module Simulacrum
   # The Comparator class is responsible for comparing and handling
@@ -10,11 +10,10 @@ module Simulacrum
 
     def initialize(component)
       @component = component
+      @component.render
     end
 
     def test
-      @candidate = @component.capture_candidate
-
       # If the component has a reference then we should diff the candidate
       # image against the reference
       if @component.reference?
@@ -34,6 +33,7 @@ module Simulacrum
 
     def pass
       @component.remove_candidate
+      @component.remove_diff
       true
     end
 
@@ -48,12 +48,12 @@ module Simulacrum
 
     def perform_diff()
       @diff = Simulacrum::RmagicDiff.new(@component.reference_path,
-                                    @component.candidate_path)
+                                         @component.candidate_path)
       diff_delta_percent_is_acceptable
     end
 
     def diff_delta_percent_is_acceptable
-      (@diff.delta * 1000) < @component.acceptable_delta
+      @diff.delta_percent < @component.acceptable_delta
     end
   end
 end

data/lib/simulacrum/component.rb

@@ -1,32 +1,41 @@
-require 'capybara'
+require 'capybara/dsl'
 
 module Simulacrum
   class Component
     include Capybara::DSL
-    Capybara.default_driver = :selenium
 
-    attr_reader :name
+    attr_reader :name, :browser
+    attr_accessor :options
 
-    def initialize(name, options)
+    def initialize(name, browser = nil, options = {})
       @name = name
       @options = options
+      @browser = browser
     end
 
     # Load up the component url and capture an image, returns a File object
-    def capture_candidate
+    def render
+      use_browser
       ensure_example_path
       visit(@options.url)
-      within(capture_selector) do
-        page.save_screenshot(candidate_path)
-      end
+      page.driver.save_screenshot(candidate_path, options)
+      kill_driver
+    end
+
+    def render_with(browser)
+      self.class.new(name, browser, @options)
     end
 
     def remove_candidate
       FileUtils.rm(candidate_path) if candidate?
     end
 
+    def remove_diff
+      FileUtils.rm(diff_path) if diff?
+    end
+
     def root_path
-      File.join(Simulacrum.configuration.images_path, name.to_s)
+      File.join(Simulacrum.configuration.images_path, render_path)
     end
 
     def reference_path
@@ -49,12 +58,35 @@ module Simulacrum
       File.exists?(candidate_path)
     end
 
+    def diff?
+      File.exists?(diff_path)
+    end
+
     def acceptable_delta
       @options.acceptable_delta || Simulacrum.configuration.acceptable_delta
     end
 
     private
 
+    def kill_driver
+      if not @browser.nil? and @browser.remote?
+        page.driver.quit
+      end
+    end
+
+    def render_path
+      path = [name.to_s]
+      path << @browser.name unless @browser.nil?
+      File.join(path.map(&:to_s))
+    end
+
+    def use_browser
+      unless @browser.nil?
+        @browser.use
+        sleep @browser.capture_delay.to_i
+      end
+    end
+
     def ensure_example_path
       FileUtils.mkdir_p(root_path)
     end

data/lib/simulacrum/configuration.rb

@@ -3,7 +3,7 @@ require 'ostruct'
 module Simulacrum
   class Configuration
     attr_reader :images_path, :reference_filename, :candidate_filename,
-      :diff_filename, :capture_selector, :acceptable_delta
+      :diff_filename, :capture_selector, :acceptable_delta, :capture_delay
 
     def initialize
       @config = OpenStruct.new
@@ -29,12 +29,16 @@ module Simulacrum
       @config.diff_filename || 'diff.png'
     end
 
-    def capture_selector
-      @config.capture_selector || 'html'
+    def capture_delay
+      @config.capture_delay || 0
     end
 
     def acceptable_delta
       @config.acceptable_delta || 0.0
     end
+
+    def remote_url
+      @config.remote_url
+    end
   end
 end

data/lib/simulacrum/diff/pdiff.rb

@@ -1,16 +1,16 @@
-require 'chunky_png'
-require_relative '../diff'
-
-module Simulacrum
-  class Pdiff < Simulacrum::Diff
-    include ChunkyPNG::Color
-
-    def compare
-      a_image = ChunkyPNG::Image.from_file(@a_path)
-      b_image = ChunkyPNG::Image.from_file(@b_path)
-    end
-  end
-end
+# require 'chunky_png'
+# require_relative '../diff'
+
+# module Simulacrum
+#   class Pdiff < Simulacrum::Diff
+#     include ChunkyPNG::Color
+
+#     def compare
+#       a_image = ChunkyPNG::Image.from_file(@a_path)
+#       b_image = ChunkyPNG::Image.from_file(@b_path)
+#     end
+#   end
+# end
 
 # require 'chunky_png'
 # include ChunkyPNG::Color

data/lib/simulacrum/diff/rmagick.rb

@@ -3,16 +3,27 @@ require_relative '../diff'
 
 module Simulacrum
   class RmagicDiff < Simulacrum::Diff
+    def delta_percent
+      @delta * 100
+    end
+
     private
 
     def compare
-      a_image = Magick::Image.read(@a_path)
-      b_image = Magick::Image.read(@b_path)
-      @image, @delta = compare_images(a_image, b_image)
+      a = Magick::Image.read(@a_path)
+      b = Magick::Image.read(@b_path)
+      @image, @delta = compare_images(a, b)
     end
 
-    def compare_images(a_image, b_image)
-      a_image[0].compare_channel(b_image[0], Magick::MeanSquaredErrorMetric)
+    def compare_images(a, b)
+      # Calculate the Square Root Mean Squared Error for the comparison of the
+      # two images.
+      #
+      # Gets the color difference for each pixel, and square it, average all the
+      # squared differences, then return the square root.
+      #
+      # http://www.imagemagick.org/discourse-server/viewtopic.php?f=1&t=17284
+      a[0].compare_channel(b[0], Magick::MeanSquaredErrorMetric)
     end
   end
 end

data/lib/simulacrum/diff.rb

@@ -12,9 +12,5 @@ module Simulacrum
     def save(path)
       @image.write(path)
     end
-
-    def percent_change
-      (@delta * 1000).round(2)
-    end
   end
 end

data/lib/simulacrum/matchers.rb

@@ -1,17 +1,30 @@
-require_relative 'comparator'
+require_relative './comparator'
 
 module Simulacrum
   module Matchers
     extend RSpec::Matchers::DSL
 
     matcher :look_the_same do
+      # browser = options[:in_browser]
+      # browser.use unless browser.nil?
+
       match do |component|
+        component = component
         comparator = Simulacrum::Comparator.new(component)
+
         case comparator.test
         when true
           true
         when false
-          fail <<-eos
+          fail Simulacrum::Matchers.fail_message(component, comparator)
+        when nil
+          pending Simulacrum::Matchers.pending_message(component)
+        end
+      end
+    end
+
+    def self.fail_message(component, comparator)
+      <<-eos
 The pixel change percentage exceeded the maximum threshold of #{component.acceptable_delta}%.
 
 There was a #{comparator.diff.percent_change}% pixel difference found between \
@@ -22,9 +35,11 @@ Candidate: #{component.candidate_path}
 Diff:      #{component.diff_path}
 
 Please review the diff and resolve manually.
-          eos
-        when nil
-          pending <<-eos
+      eos
+    end
+
+    def self.pending_message(component)
+      <<-eos
 No reference image found! New candidate created:
 
       #{component.candidate_path}
@@ -34,9 +49,7 @@ No reference image found! New candidate created:
         - mark it as a reference image by renaming it to 'reference.png'
         - commit 'reference.png' file to your SCM of choice
         - rerun this spec making sure it passes using the new reference image
-          eos
-        end
-      end
+      eos
     end
   end
 end

data/lib/simulacrum/methods.rb

@@ -1,25 +1,37 @@
 require 'ostruct'
-require_relative 'browser'
-require_relative 'component'
+require_relative './browser'
+require_relative './component'
 
 module Simulacrum
-  # Rspec utility methods for defining components, browser environments and
+  # Rspec utility methods for defining components, browser environments
   module Methods
     def component(name, &block)
       options = OpenStruct.new
       yield options
-      component = Simulacrum::Component.new(name, options)
+      component = Simulacrum::Component.new(name, nil, options)
       Simulacrum.components[name] = component
-
-      subject do
-        component
-      end
+      subject { component }
+      let(:component) { component }
     end
 
-    def configure_browser(name, &block)
+    def browser(name, &block)
       options = OpenStruct.new
+      options.caps = {}
       yield options
-      @browser = Simulacrum::Browser.new(name, options)
+      Simulacrum.browsers[name] = Simulacrum::Browser.new(name, options)
+      let(name.to_sym) { browser }
+    end
+
+    def use_browser(name, extra_config = {})
+      previous_browser = Simulacrum.current_browser
+      current_browser = Simulacrum.browsers[name]
+      current_browser.configure(extra_config)
+      Simulacrum.current_browser = current_browser
+      subject { component.render_with(current_browser) }
+      after(:each) {
+        Simulacrum.current_browser = previous_browser
+        component.render_with(previous_browser)
+      }
     end
   end
 end

data/lib/simulacrum/version.rb

@@ -1,5 +1,5 @@
 # Package information
 module Simulacrum
   PACKAGE = 'simulacrum'
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/simulacrum.rb

@@ -1,17 +1,36 @@
 require 'ostruct'
-require_relative 'Simulacrum/methods'
-require_relative 'Simulacrum/matchers'
-require_relative 'Simulacrum/configuration'
+require 'capybara'
+require_relative './simulacrum/methods'
+require_relative './simulacrum/matchers'
+require_relative './simulacrum/configuration'
 
 # Gem module
 module Simulacrum
+  @current_browser = nil
+  @browsers = {}
   @components = {}
   @configuration = Simulacrum::Configuration.new
 
+  Capybara.configure do |config|
+    config.default_driver = :selenium
+  end
+
   def self.components
     @components
   end
 
+  def self.browsers
+    @browsers
+  end
+
+  def self.current_browser
+    @current_browser
+  end
+
+  def self.current_browser=(browser)
+    @current_browser = browser
+  end
+
   def self.configuration
     @configuration
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simulacrum
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Justin Morris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-26 00:00:00.000000000 Z
+date: 2014-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -173,6 +187,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/simulacrum/browser.rb
+- lib/simulacrum/browser_options.rb
 - lib/simulacrum/comparator.rb
 - lib/simulacrum/component.rb
 - lib/simulacrum/configuration.rb
@@ -184,6 +199,7 @@ files:
 - lib/simulacrum/version.rb
 - lib/simulacrum.rb
 - README.md
+- LICENSE
 - spec/fixtures/a.png
 - spec/fixtures/a2.png
 - spec/spec_helper.rb