simulacrum 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7687eec5b004b38792cf95b1c4dc725c060f9a00
-  data.tar.gz: 794e8cd0f33574cc2290cfcdb407b21a99c5d27e
+  metadata.gz: 6ac13e91d6381485d3876e060ce5b106a7f08b17
+  data.tar.gz: b080c8f22ff2d7269d8103976a77da6d5d61dcc4
 SHA512:
-  metadata.gz: 7e570746996c898fdaba924b2f885637640dae8c1734b433942ba1da5fcec94b1860daaa54b2df3aec0138c34be784fae34635d54d44b13994333460415a1a62
-  data.tar.gz: 1e356ca93bd87a2483f7e13855ac7eb561520d7e927f06619229fa4e1da97d70b29a37964d7c79d42b2509c05ff81f5d523c5b93eaf5dc94ee6898da6fab1605
+  metadata.gz: 636c3df6a29a58103c9d32930de147b845eb712b489b2f0c1cedfca2b35094e22d387722468a8ccfdafa2801a52144c3ea4ad89aa2c5aa79f016c3f70f8e71c8
+  data.tar.gz: bafe2f7328c674a8c4ede41babb0f8bacdc8b3a72bd3f92195fb646c8f0cd2890b26f4e740e1eeccaf42528de57c4e7adab81284f4920d6d969fae387346f09d

data/README.md

@@ -11,16 +11,21 @@ An opinionated UI component regression testing tool built to be tightly integrat
 
 ```ruby
 RSpec.configure do |config|
-  config.include Simulacrum
+  include Simulacrum
 end
 ```
 
 Simulacrum can also be configured once included;
 
 ```ruby
-Simulacrum.configure do |config|
-	config.images_path = 'somewhere/example/spec/ui_specs'
-	config.acceptable_delta = 2 # allow a maximum of 2% difference
+RSpec.configure do |config|
+	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
 end
 ```
 

data/lib/simulacrum.rb

@@ -6,37 +6,21 @@ require_relative './simulacrum/configuration'
 
 # Gem module
 module Simulacrum
-  @current_browser = nil
   @browsers = {}
   @components = {}
+  @current_browser = nil
   @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
 
   def self.configure(&block)
-    options = OpenStruct.new
+    options = OpenStruct.new(defaults: OpenStruct.new)
     yield options
     @configuration.configure(options.to_h)
   end
@@ -44,5 +28,10 @@ module Simulacrum
   def self.included(receiver, &block)
     receiver.extend         Simulacrum::Methods
     receiver.send :include, Simulacrum::Matchers
+
+    if defined?(Rails)
+      receiver.send :include, Rails.application.routes.url_helpers
+      receiver.send :include, Rails.application.routes.mounted_helpers
+    end
   end
 end

data/lib/simulacrum/comparator.rb

@@ -1,3 +1,4 @@
+require 'rspec'
 require_relative './diff/rmagick'
 
 module Simulacrum
@@ -46,7 +47,7 @@ module Simulacrum
       nil
     end
 
-    def perform_diff()
+    def perform_diff
       @diff = Simulacrum::RmagicDiff.new(@component.reference_path,
                                          @component.candidate_path)
       diff_delta_percent_is_acceptable

data/lib/simulacrum/component.rb

@@ -1,90 +1,93 @@
 require 'capybara/dsl'
+require 'fileutils'
+require 'rmagick'
+require_relative 'renderer'
 
 module Simulacrum
   class Component
-    include Capybara::DSL
-
     attr_reader :name, :browser
     attr_accessor :options
 
-    def initialize(name, browser = nil, options = {})
+    def initialize(name, options = {})
       @name = name
       @options = options
-      @browser = browser
+      @renderer = Simulacrum::Renderer.new(options.url)
     end
 
     # Load up the component url and capture an image, returns a File object
     def render
-      use_browser
       ensure_example_path
-      visit(@options.url)
-      page.driver.save_screenshot(candidate_path, options)
-      kill_driver
+      save_candidate(@renderer.render)
+      crop_candidate_to_selector
+    ensure
+      cleanup
     end
 
-    def render_with(browser)
-      self.class.new(name, browser, @options)
+    def reference?
+      File.exists?(reference_path)
     end
 
-    def remove_candidate
-      FileUtils.rm(candidate_path) if candidate?
+    def candidate?
+      File.exists?(candidate_path)
     end
 
-    def remove_diff
-      FileUtils.rm(diff_path) if diff?
+    def diff?
+      File.exists?(diff_path)
     end
 
-    def root_path
-      File.join(Simulacrum.configuration.images_path, render_path)
+    def acceptable_delta
+      options.acceptable_delta || Simulacrum.configuration.acceptable_delta
     end
 
     def reference_path
-      File.join(root_path, Simulacrum.configuration.reference_filename)
+      filename = Simulacrum.configuration.reference_filename
+      File.join(root_path, "#{filename}.png")
     end
 
     def candidate_path
-      File.join(root_path, Simulacrum.configuration.candidate_filename)
+      filename = Simulacrum.configuration.candidate_filename
+      File.join(root_path, "#{filename}.png")
     end
 
     def diff_path
-      File.join(root_path, Simulacrum.configuration.diff_filename)
+      filename = Simulacrum.configuration.diff_filename
+      File.join(root_path, "#{filename}.png")
     end
 
-    def reference?
-      File.exists?(reference_path)
+    def remove_candidate
+      FileUtils.rm(candidate_path) if candidate?
     end
 
-    def candidate?
-      File.exists?(candidate_path)
+    def remove_diff
+      FileUtils.rm(diff_path) if diff?
     end
 
-    def diff?
-      File.exists?(diff_path)
-    end
+    private
 
-    def acceptable_delta
-      @options.acceptable_delta || Simulacrum.configuration.acceptable_delta
+    def cleanup
+      @renderer.cleanup
+      # FileUtils.remove_entry(root_path) unless reference? || candidate? || diff?
     end
 
-    private
+    def save_candidate(tmp_image_path)
+      FileUtils.mv(tmp_image_path, candidate_path)
+    end
 
-    def kill_driver
-      if not @browser.nil? and @browser.remote?
-        page.driver.quit
+    def crop_candidate_to_selector
+      unless capture_selector.nil?
+        candidate_image = Magick::Image::read(candidate_path).first
+        bounds = @renderer.get_bounds_for_selector(capture_selector)
+        candidate_image.crop!(*bounds)
+        candidate_image.write(candidate_path)
       end
     end
 
-    def render_path
-      path = [name.to_s]
-      path << @browser.name unless @browser.nil?
-      File.join(path.map(&:to_s))
+    def root_path
+      File.join(Simulacrum.configuration.references_path, name.to_s, driver_path)
     end
 
-    def use_browser
-      unless @browser.nil?
-        @browser.use
-        sleep @browser.capture_delay.to_i
-      end
+    def driver_path
+      Capybara.current_driver == :default ? '' : Capybara.current_driver.to_s
     end
 
     def ensure_example_path
@@ -92,7 +95,7 @@ module Simulacrum
     end
 
     def capture_selector
-      @options.capture_selector || Simulacrum.configuration.capture_selector
+      options.capture_selector || Simulacrum.configuration.capture_selector
     end
   end
 end

data/lib/simulacrum/configuration.rb

@@ -2,43 +2,56 @@ require 'ostruct'
 
 module Simulacrum
   class Configuration
-    attr_reader :images_path, :reference_filename, :candidate_filename,
-      :diff_filename, :capture_selector, :acceptable_delta, :capture_delay
+
+    COMPONENT_DEFAULTS = {
+      acceptable_delta: 1,
+      window_size:      [1024, 768],
+      capture_delay:    nil,
+      capture_selector: :html,
+    }
+
+    attr_reader :references_path, :reference_filename, :candidate_filename,
+      :diff_filename, :acceptable_delta, :capture_delay, :window_size,
+      :capture_selector, :default_browser
 
     def initialize
-      @config = OpenStruct.new
+      @config = OpenStruct.new(defaults: OpenStruct.new(COMPONENT_DEFAULTS))
     end
 
     def configure(config)
       @config = OpenStruct.new(@config.to_h.merge!(config))
     end
 
-    def images_path
-      @config.images_path
+    def default_browser
+      @config.default_browser || :selenium
+    end
+
+    def references_path
+      if @config.references_path
+        @config.references_path
+      elsif defined?(Rails)
+        File.join(Rails.root, 'spec/ui/references')
+      end
     end
 
     def reference_filename
-      @config.reference_filename || 'reference.png'
+      @config.reference_filename || 'reference'
     end
 
     def candidate_filename
-      @config.candidate_filename || 'candidate.png'
+      @config.candidate_filename || 'candidate'
     end
 
     def diff_filename
-      @config.diff_filename || 'diff.png'
-    end
-
-    def capture_delay
-      @config.capture_delay || 0
+      @config.diff_filename || 'diff'
     end
 
     def acceptable_delta
-      @config.acceptable_delta || 0.0
+      @config.defaults.acceptable_delta || 0.0
     end
 
-    def remote_url
-      @config.remote_url
+    def capture_selector
+      @config.defaults.capture_selector || nil
     end
   end
 end

data/lib/simulacrum/matchers.rb

@@ -1,3 +1,4 @@
+require 'rspec'
 require_relative './comparator'
 
 module Simulacrum
@@ -5,9 +6,6 @@ module Simulacrum
     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)
@@ -27,7 +25,7 @@ module Simulacrum
       <<-eos
 The pixel change percentage exceeded the maximum threshold of #{component.acceptable_delta}%.
 
-There was a #{comparator.diff.percent_change}% pixel difference found between \
+There was a #{comparator.diff.delta_percent}% pixel difference found between \
 the reference and the candidate.
 
 Reference: #{component.reference_path}

data/lib/simulacrum/methods.rb

@@ -1,5 +1,4 @@
 require 'ostruct'
-require_relative './browser'
 require_relative './component'
 
 module Simulacrum
@@ -8,30 +7,26 @@ module Simulacrum
     def component(name, &block)
       options = OpenStruct.new
       yield options
-      component = Simulacrum::Component.new(name, nil, options)
+      component = Simulacrum::Component.new(name, options)
       Simulacrum.components[name] = component
-      subject { component }
-      let(:component) { component }
-    end
 
-    def browser(name, &block)
-      options = OpenStruct.new
-      options.caps = {}
-      yield options
-      Simulacrum.browsers[name] = Simulacrum::Browser.new(name, options)
-      let(name.to_sym) { browser }
+      subject do
+        component
+      end
+
+      let(:component) do
+        component
+      end
     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)
-      }
+    def use_window_size(dimensions)
+      subject do
+        component.set_window_size(dimensions)
+      end
+
+      after(:each) do
+        subject.reset_window_size
+      end
     end
   end
 end

data/lib/simulacrum/renderer.rb

@@ -0,0 +1,49 @@
+require 'capybara'
+require 'tmpdir'
+
+module Simulacrum
+  class Renderer
+    include Capybara::DSL
+
+    attr_reader :url, :tmp_path
+
+    def initialize(url)
+      @url = url
+      @tmp_dir = Dir.mktmpdir
+    end
+
+    def render
+      page.visit(url)
+      resize_window!
+      save_screenshot!
+    end
+
+    def cleanup
+      FileUtils.remove_entry(@tmp_dir)
+    end
+
+    def get_bounds_for_selector(selector)
+      element = page.find(selector)
+      location = element.native.location
+      size = element.native.size
+      [location.x, location.y, size.width, size.height]
+    end
+
+    private
+
+    def resize_window!
+      begin
+        page.driver.browser.manage.window.resize_to(1024, 768)
+      rescue Selenium::WebDriver::Error::UnknownError => e
+      end
+    end
+
+    def save_screenshot!
+      page.driver.save_screenshot(tmp_path)
+    end
+
+    def tmp_path
+      @tmp_path ||= File.join(@tmp_dir, Simulacrum.configuration.candidate_filename)
+    end
+  end
+end

data/lib/simulacrum/version.rb

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

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: simulacrum
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Justin Morris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-07 00:00:00.000000000 Z
+date: 2014-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: rmagick
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.13.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.13.2
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.40.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.40.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -108,20 +108,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-nc
   requirement: !ruby/object:Gem::Requirement
@@ -186,20 +172,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/simulacrum/browser.rb
-- lib/simulacrum/browser_options.rb
+- LICENSE
+- README.md
+- lib/simulacrum.rb
 - lib/simulacrum/comparator.rb
 - lib/simulacrum/component.rb
 - lib/simulacrum/configuration.rb
+- lib/simulacrum/diff.rb
 - lib/simulacrum/diff/pdiff.rb
 - lib/simulacrum/diff/rmagick.rb
-- lib/simulacrum/diff.rb
 - lib/simulacrum/matchers.rb
 - lib/simulacrum/methods.rb
+- lib/simulacrum/renderer.rb
 - lib/simulacrum/version.rb
-- lib/simulacrum.rb
-- README.md
-- LICENSE
 - spec/fixtures/a.png
 - spec/fixtures/a2.png
 - spec/spec_helper.rb
@@ -225,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A gem for visually testing and inspecting user interface components.

data/lib/simulacrum/browser.rb

@@ -1,44 +0,0 @@
-require 'capybara'
-
-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

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