poltergeist-screenshot_overview 0.0.3 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c4c0775884ba430446abd2cfbd82614c3545c08
-  data.tar.gz: 1043d1359bcfb8903ac0eabb9971e18671b51ddf
+  metadata.gz: b43612594d07f1ad1194b19a341e32abb3a65c7f
+  data.tar.gz: aa91e1375f94cfc87b3e8cb8d53d86dda4ffb094
 SHA512:
-  metadata.gz: d550c3fcc3e32c4e6988f5a988d0061fbbfeb0e3a7cda7655db6432be2eb563fe027f7e9493253e722d394f3914d913a97e24531595007214c65bc1461b57972
-  data.tar.gz: 4b5afdd5e765ba092c85fe51570c449ffb4ae557a47314cbadfa7e0f34fef2a27d643872c4d6ca76af63de67a58b06682d96f0de8a83ec460b37f556de52b12b
+  metadata.gz: e9e0b877c56e0e58a49b72784ae8018d845274513f3d07943835ebf9843d1d3be799031216f7138f2a94ddc4989a18021e917e2a58a765f592646a8a5b44f38a
+  data.tar.gz: 2823da18c09e8b37caac98f198025d65bc731423993068eb608f845824c326a0ee900201668fb6da5c4f782e2bca2cb5af33a85b6ec28c0e628d7453e6e6d3c8

data/lib/poltergeist/screenshot_overview/manager.rb

@@ -1,6 +1,56 @@
 require "erb"
 require "ostruct"
 module Poltergeist::ScreenshotOverview
+  class ScreenshotGroup
+    attr_accessor :screenshots, :file_name
+
+    def initialize(file,screenshots)
+      @file_name = file
+      @screenshots = screenshots
+    end
+
+    def to_id
+      file_name.gsub(/\W+/, "-").gsub(/^-/, "")
+    end
+  end
+
+  class Screenshot
+    ATTR = :url, :argument, :local_image, :full_path, :group_description, :example_description, :file_with_line
+    attr_accessor(*ATTR)
+    def initialize(opts={})
+      opts.each do |k,v|
+        self.send("#{k}=", v)
+      end
+    end
+
+    def to_hash
+      Hash[
+        ATTR.map{|k|[k, self.send(k)]}
+      ]
+    end
+
+    def line_number
+      file_with_line.split(":")[1].to_i rescue 0
+    end
+
+    def full_test_path
+      file_with_line.split(":")[0]
+    end
+
+    def snippet
+      File.read(full_test_path).lines[ line_number - 3, 5].join
+    end
+
+    def test_file
+      full_test_path.gsub(Dir.pwd, "").gsub("spec/features/","")
+    end
+
+    def render
+      template = ERB.new File.read(Poltergeist::ScreenshotOverview.template), nil, "%"
+      template.result(binding)
+    end
+  end
+
   class Manager
     include Singleton
 
@@ -16,23 +66,26 @@ module Poltergeist::ScreenshotOverview
     def add_image_from_rspec(argument, example, url_path)
       filename = [example.description, argument, Digest::MD5.hexdigest("foo")[0..6] ].join(" ").gsub(/\W+/,"_") + ".jpg"
 
+      blob = caller.find{|i| i[ example.file_path.gsub(/:\d*|^\./,"") ]}
+      file_with_line = blob.split(":")[0,2].join(":")
+
       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
-      }
+      @files << Screenshot.new({
+        :url                 => url_path,
+        :argument            => argument,
+        :local_image         => filename,
+        :full_path           => full_name,
+        :group_description   => describe,
+        :example_description => example.description,
+        :file_with_line      => file_with_line
+      })
       full_name
     end
 
     def generate_html
-      title = "Screenshot Overview (#{Time.now.to_s})"
+      title = 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|
@@ -40,12 +93,10 @@ module Poltergeist::ScreenshotOverview
     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
+    def groups
+      @files.
+        group_by{ |screenshot| screenshot.test_file}.
+        map{|file,screenshots| ScreenshotGroup.new(file,screenshots) }
     end
 
   end

data/poltergeist-screenshot_overview.gemspec

@@ -5,7 +5,7 @@ require 'poltergeist/screenshot_overview/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "poltergeist-screenshot_overview"
-  spec.version       = "0.0.3"
+  spec.version       = "0.1.3"
   spec.authors       = ["Stefan Wienert"]
   spec.email         = ["stefan.wienert@pludoni.de"]
   spec.description   = %q{hooks into Capybara poltergeist to automatically make screenshots after each click}

data/templates/layout.erb

@@ -3,6 +3,7 @@
     <title><%= title %></title>
 <meta name="description" content="">
 <meta name="viewport" content="width=device-width">
+<link href="//netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap-combined.min.css" rel="stylesheet">
 
 <style type='text/css'>
   .screenshot {
@@ -16,17 +17,64 @@
     padding: 0 20px;
     font-family: Calibri, Candara, Segoe, "Segoe UI", Optima, Arial, sans-serif;
   }
-</style
+  #toc {
+    width: 200px;
+    background-color: #FFFFFF;
+    border-radius: 6px 6px 6px 6px;
+    box-shadow: 0 1px 4px rgba(0, 0, 0, 0.067);
+    margin: 30px 0 0;
+    padding: 0;
+  }
+  #toc a {
+    border: 1px solid #E5E5E5;
+    display: block;
+    margin: 0 0 -1px;
+    padding: 8px 14px;
+    text-shadow: 0 1px 0 rgba(255, 255, 255, 0.5);
+  }
+</style>
+
+<script type='text/javascript'>
+  url = window.location.toString();
+  console.log(url)
+  if (!/\/$/.test(url)) {
+      url = url + '/';
+      console.log("CHANGING" + url)
+      window.location = url
+  }
+</script>
 
 </head>
 
-<body>
+<body data-spy="scroll" data-target=".navbar">
 
-<div id='container'>
-  <h1><%= title %></h1>
+  <div id='container' class='row'>
+    <div class='span10'>
+      <h1><%= title %></h1>
+      <% groups.each do |group| %>
+        <div class='group'>
+          <h2 id='<%=group.to_id%>'><%= group.file_name %></h2>
+          <% group.screenshots.each do |screenshot| %>
+            <%= screenshot.render %>
+          <% end %>
+        </div>
+      <% end %>
+    </div>
 
-<%= rendered_screenshots %>
-</div>
+    <div class='span2'>
+      <div class='navbar' id='toc' data-spy="affix" data-offset-top="200">
+        <ul class='nav nav-list'>
+          <% groups.each do |group| %>
+            <li>
+            <a href='#<%=group.to_id %>'><%= group.file_name %></a>
+            </li>
+          <% end %>
+      </div>
+    </div>
+  </div>
 
+<script src="http://code.jquery.com/jquery-1.10.0.min.js"></script>
+<script src="http://code.jquery.com/jquery-migrate-1.2.1.min.js"></script>
+<script src="//netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/js/bootstrap.min.js"></script>
 </body>
 </html>

data/templates/screenshot.erb

@@ -1,13 +1,12 @@
 <div class='screenshot'>
   <img src='<%= local_image %>' alt=''/>
-
   <ul>
     <li>
-  <strong><%= describe_descriptions.join(" >> ") %>:
-    <%= example_description %></strong>
+    <strong><%= group_description.join(" >> ") %> <%= example_description %></strong>
   </li>
-  <li>on <%= url %></li>
-  <li>in <%= test_file %></li>
-  <li>clicked on /visited: "<%= argument %>"</li>
+  <li>URL: <code><%= url %></code></li>
+  <li>clicked on: <code><%= argument %></code></li>
+  <li><a href='file://<%= file_with_line %>'><%= file_with_line %></a></li>
+  <code><pre><%= snippet %></pre></code>
 </table>
 </div>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poltergeist-screenshot_overview
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.3
 platform: ruby
 authors:
 - Stefan Wienert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-25 00:00:00.000000000 Z
+date: 2013-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: poltergeist