poltergeist-screenshot_overview 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1744d28bde763b93b11818cca9b4421b4c71b241
+  data.tar.gz: 35cedb245667cd83dcac2d4b0bc38015f5317930
+SHA512:
+  metadata.gz: 2b69854cc37a6691dbf63e28a6071985e2be9a83a5c67111a5cd9b7929c6f09e723679f30401562aa2397f590e523b219cc5a602cc44dd72101203b295ab333b
+  data.tar.gz: 059a2ca4bb34395b6f8119a1c8c28c75413110c2e9753bdcf039bfd3e3f04732100dd7c425ac84d9aedee0e3cfeb35583f8d3222c78bfa773d5cd177ec46fcd8

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Stefan Wienert
+
+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,58 @@
+# Poltergeist::ScreenshotOverview
+
+Hooks into Capybara poltergeist to automatically make screenshots after each click. Until now, only rspec supported. (Different test environments should be easy to plug in).
+
+
+## Motivation
+
+Sometimes we ran into problems:
+* Some recent design changes broke something on a completly different site.
+*
+
+We run this on the Continuos Integration server, so we get an up2date overview of most application's views rendered on a full blown Chromium (thx to poltergeist and Phantomjs).
+
+## Usage
+
+Add this line to your application's Gemfile:
+
+    group :test do
+      gem 'poltergeist-screenshot_overview'
+    end
+
+
+As the gem's name suggest, poltergeist and so Capybara is required.
+
+### Rspec
+
+puts this in your spec_helper.rb somewhere below application loading:
+
+    require "poltergeist/screenshot_overview/rspec"
+
+Run your feature specs. Every visit, click_button and click_link will create a screenshot into public/cockpit.
+
+After test run, visit localhost:3000/cockpit/index.html in your browser to view the screenshots.
+
+NOTE: only feature specs with ``js: true`` will be run, to avoid problems with
+
+## Configuration
+
+Change setting with:
+
+    Poltergeist::ScreenshotOverview.target_directory = 'public/cockpit'
+    Poltergeist::ScreenshotOverview.layout = 'GEM_DIR/templates/layout.erb'
+    Poltergeist::ScreenshotOverview.template = 'GEM_DIR/templates/screenshot.erb'
+
+NOTE: before test execution, all jpg's in target_directory are deleted.
+
+To render different Styles
+
+## Contributing
+
+Possibly needed features
+* Other than rspec's adapters (mini-test)
+* Could run with different Browsers that support screenshoting, but so far only Poltergeist implemented
+* UI
+  * general styling
+  * some kind of TOC, affix or stuff
+  * line numbers, file open links
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/poltergeist/screenshot_overview.rb

@@ -0,0 +1,49 @@
+require "poltergeist/screenshot_overview/manager"
+module Poltergeist
+  module ScreenshotOverview
+    class << self
+      attr_writer :target_directory
+      attr_writer :layout
+      attr_writer :template
+
+      def target_directory
+        @target_directory ||  "public/cockpit"
+      end
+
+      def layout
+        @layout || File.join(File.dirname(__FILE__), "../../templates/layout.erb")
+      end
+      def template
+        @layout || File.join(File.dirname(__FILE__), "../../templates/screenshot.erb")
+      end
+    end
+
+    # @override
+    def visit(*args)
+      super
+      make_screenshot(args.first)
+    end
+
+    # @override
+    def click_button(*args)
+      super
+      make_screenshot(args.first)
+    end
+
+    # @override
+    def click_link(*args)
+      super
+      make_screenshot(args.first)
+    end
+
+    private
+
+    def make_screenshot(argument)
+      if self.example.metadata[:js] || self.example.metadata[:screenshot]
+        filename = Manager.instance.add_image_from_rspec(argument, self.example, current_path)
+        page.driver.render(Rails.root.join(filename).to_s,full: true)
+      end
+    end
+
+  end
+end

data/lib/poltergeist/screenshot_overview/manager.rb

@@ -0,0 +1,52 @@
+require "erb"
+require "ostruct"
+module Poltergeist::ScreenshotOverview
+  class Manager
+    include Singleton
+
+    def start
+      Dir[File.join Poltergeist::ScreenshotOverview.target_directory, "*jpg"].each do |file|
+        File.unlink file
+      end
+      @files = []
+    end
+
+    # adds image_path and metadata to our list, returns a full path where the
+    # Engine should put the screenshot in
+    def add_image_from_rspec(argument, example, url_path)
+      filename = [example.description, argument, Digest::MD5.hexdigest("foo")[0..6] ].join(" ").gsub(/\W+/,"_") + ".jpg"
+
+      full_name = File.join(Poltergeist::ScreenshotOverview.target_directory, filename )
+      FileUtils.mkdir_p Poltergeist::ScreenshotOverview.target_directory
+      describe = example.metadata[:example_group][:description_args]
+      @files << {
+        :url => url_path,
+        :argument => argument,
+        :local_image => filename,
+        :full_path => full_name,
+        :test_file => example.file_path,
+        :describe_descriptions => describe,
+        :example_description => example.description
+      }
+      full_name
+    end
+
+    def generate_html
+      title = "Screenshot Overview (#{Time.now.to_s})"
+      template = ERB.new File.new(Poltergeist::ScreenshotOverview.layout).read, nil, "%"
+      html = template.result(binding)
+      File.open( File.join(Poltergeist::ScreenshotOverview.target_directory, "index.html"), "w+") { |f|
+        f.write html }
+    end
+
+
+    def rendered_screenshots
+      template = ERB.new File.read(Poltergeist::ScreenshotOverview.template), nil, "%"
+      @files.map do |file|
+        namespace = OpenStruct.new(file)
+        template.result(namespace.instance_eval { binding })
+      end.join
+    end
+
+  end
+end

data/lib/poltergeist/screenshot_overview/rspec.rb

@@ -0,0 +1,13 @@
+require "poltergeist/screenshot_overview"
+require "poltergeist/screenshot_overview/manager"
+RSpec.configure do |config|
+  config.before(:suite) do
+    Poltergeist::ScreenshotOverview::Manager.instance.start
+  end
+  config.after(:suite) do
+    Poltergeist::ScreenshotOverview::Manager.instance.generate_html
+  end
+
+  config.include Poltergeist::ScreenshotOverview, :type => :feature, :js => true
+
+end

data/lib/poltergeist/screenshot_overview/version.rb

@@ -0,0 +1,5 @@
+module Poltergeist
+  module ScreenshotOverview
+    VERSION = "0.0.1"
+  end
+end

data/poltergeist-screenshot_overview.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'poltergeist/screenshot_overview/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "poltergeist-screenshot_overview"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Stefan Wienert"]
+  spec.email         = ["stefan.wienert@pludoni.de"]
+  spec.description   = %q{hooks into Capybara poltergeist to automatically make screenshots after each click}
+  spec.summary       = %q{Useful for running in Continuos integration server, so the designer can look up, after recent design changes, if anything broke. One get's a brief overview over the application wide style renderings (on Chrome).}
+  spec.homepage      = "https://github.com/zealot128/poltergeist-screenshot_overview"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "poltergeist"
+  spec.add_runtime_dependency "erb"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/templates/layout.erb

@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<html class="no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+    <title><%= title %></title>
+<meta name="description" content="">
+<meta name="viewport" content="width=device-width">
+
+<style type='text/css'>
+  .screenshot {
+    margin-bottom: 15px;
+    padding-bottom: 15px;
+    border-bottom: 2px solid #aaa;
+  }
+  #container {
+    width: 80%;
+    margin: 0 auto;
+    padding: 0 20px;
+    font-family: Calibri, Candara, Segoe, "Segoe UI", Optima, Arial, sans-serif;
+  }
+</style
+
+</head>
+
+<body>
+
+<div id='container'>
+  <h1><%= title %></h1>
+
+<%= rendered_screenshots %>
+</div>
+
+</body>
+</html>

data/templates/screenshot.erb

@@ -0,0 +1,13 @@
+<div class='screenshot'>
+  <img src='<%= local_image %>' alt=''/>
+
+  <ul>
+    <li>
+  <strong><%= describe_descriptions.join(" >> ") %>:
+    <%= example_description %></strong>
+  </li>
+  <li>on <%= url %></li>
+  <li>in <%= test_file %></li>
+  <li>clicked on /visited: "<%= argument %>"</li>
+</table>
+</div>

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: poltergeist-screenshot_overview
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stefan Wienert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  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: erb
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: hooks into Capybara poltergeist to automatically make screenshots after
+  each click
+email:
+- stefan.wienert@pludoni.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/poltergeist/screenshot_overview.rb
+- lib/poltergeist/screenshot_overview/manager.rb
+- lib/poltergeist/screenshot_overview/rspec.rb
+- lib/poltergeist/screenshot_overview/version.rb
+- poltergeist-screenshot_overview.gemspec
+- templates/layout.erb
+- templates/screenshot.erb
+homepage: https://github.com/zealot128/poltergeist-screenshot_overview
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0.rc.2
+signing_key: 
+specification_version: 4
+summary: Useful for running in Continuos integration server, so the designer can look
+  up, after recent design changes, if anything broke. One get's a brief overview over
+  the application wide style renderings (on Chrome).
+test_files: []
+has_rdoc: