baraviz 0.6.pre → 0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 900176eb3b4b0996216de4f6a5d73252add19d39
-  data.tar.gz: 39e7d85f1b8d8f76ad2665f737722ccc65b22bb5
+  metadata.gz: 1ca77798ad727c9d667210f2a80c436f33dfc3a0
+  data.tar.gz: f9bd0856938c22c7a48a2d0523099977c8601cbe
 SHA512:
-  metadata.gz: 95f50decc62c0ffa825b0177c9a538e9a15fa29fc1bd1e5e325c0ce7870284e9d4a41882d094cfb956c11d383d406b6304aa9b2c06261cac2b0a996c7ef0759f
-  data.tar.gz: 787bbdb31a9c3b411caec54fb9bf1fe1864565636e44e6efa550125ebc1f8931046e2a588350c9b3321e50e2343c32073c97fc94ea7b9acb85a593158fbce075
+  metadata.gz: 752736d2a33dc3d7270a3e89f9f980437ded814f2f4ba4573e640eea2ea0936988faf6eef279ed63bb01c620e8136a48107c891b566d827129b1dcae59d362d3
+  data.tar.gz: ce02663831dd584bf59bb81665c86f7195fa59c83c99777c62744f4049f4c2fc6029d5a46032df624810ba1bb4e4e224c8ab3b7fa9803aeb5fd214a5e550e8f0

data/baraviz.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'capybara', '>= 0.3.5'
   spec.add_dependency 'rgl', '>= 0.4'
+  spec.add_dependency 'capybara-screenshot', '>= 1.0'
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'
 end

data/lib/baraviz/cucumber_formatter.rb

@@ -1,24 +1,30 @@
 require 'cucumber/formatter/io'
 require 'rgl/dot'
-require_relative 'observer'
+require_relative 'screenshot_observer'
 
 module Baraviz
   class CucumberFormatter
     include Cucumber::Formatter::Io
 
     def initialize config
-      @io = ensure_io config.out_stream
+      @io = ensure_file config.out_stream, Baraviz.name
       config.on_event :test_run_started,  &method(:on_test_run_started)
       config.on_event :test_run_finished, &method(:on_test_run_finished)
+      config.on_event :test_case_finished, &method(:on_test_case_finished)
     end
 
     def on_test_run_started event
-      @observer = Baraviz::Observer.new Capybara.current_session
+      screenshot_dir = File.dirname @io.path
+      @observer = Baraviz::ScreenshotObserver.new Capybara.current_session, screenshot_dir
     end
 
     def on_test_run_finished event
-      @io.write @observer.clustered_graph.to_s
+      @io.write @observer.graph.to_s
       @io.close
     end
+
+    def on_test_case_finished event
+      @observer.forget_next!
+    end
   end
 end

data/lib/baraviz/observer.rb

@@ -4,10 +4,12 @@ require 'capybara'
 
 module Baraviz
   class Observer
-    attr_reader :graph
+    attr_accessor :external_call
 
     def initialize session
       @graph = RGL::DirectedAdjacencyGraph.new
+      @forget_next = false
+      @external_call = true
       install_capybara_hooks! session
     end
 
@@ -16,21 +18,62 @@ module Baraviz
       Capybara::Session::DSL_METHODS.each do |method|
         session.define_singleton_method :"_#{method}_old", &session.method(method)
         session.define_singleton_method method do |*args, &block|
-          old_page = session.method(:"_current_url_old").call
-          result = session.method(:"_#{method}_old").call(*args, &block)
-          new_page = session.method(:"_current_url_old").call
+          external_call = this.external_call
+          this.external_call = false
 
-          if old_page != new_page
-            this.observe_page_change old_page, new_page
-          end
+          begin
+            old_page = session.method(:"_current_url_old").call
+            this.observe_page old_page if external_call
+
+            result = session.method(:"_#{method}_old").call(*args, &block)
+            new_page = session.method(:"_current_url_old").call
+            this.observe_page new_page if external_call
+
+            if external_call && old_page != new_page
+              this.observe_page_change old_page, new_page
+            end
 
-          result
+            result
+          ensure
+            this.external_call = true if external_call
+          end
         end
       end
     end
 
+    def forget_next!
+      @forget_next = true
+    end
+
+    def observe_page page
+      # Called for subclasses
+    end
+
     def observe_page_change old_page, new_page
-      @graph.add_edge old_page, new_page
+      @graph.add_edge old_page, new_page unless @forget_next
+      @forget_next = false
+    end
+
+    def make_node v
+      uri = URI.parse v.to_s
+      RGL::DOT::Node.new({'name' => v, 'label' => uri.path})
+    end
+
+    def make_edge u, v
+      RGL::DOT::DirectedEdge.new('from' => u, 'to' => v)
+    end
+
+    def graph
+      graph = RGL::DOT::Digraph.new
+      @graph.each_vertex do |v|
+        graph << make_node(v)
+      end
+
+      @graph.each_edge do |u, v|
+        graph << make_edge(u, v)
+      end
+
+      graph
     end
 
     def clustered_graph
@@ -41,13 +84,13 @@ module Baraviz
       @graph.each_vertex do |v|
         uri = URI.parse v.to_s
         subgraph = subgraphs[[uri.host, uri.port]]
-        subgraph << RGL::DOT::Node.new('name' => v, 'label' => v.to_s)
+        subgraph << make_node(v)
       end
 
       graph = RGL::DOT::Digraph.new
       subgraphs.values.each &graph.method(:<<)
       @graph.each_edge do |u, v|
-        graph << RGL::DOT::DirectedEdge.new('from' => u, 'to' => v)
+        graph << make_edge(u, v)
       end
 
       graph

data/lib/baraviz/screenshot_observer.rb

@@ -0,0 +1,31 @@
+require 'capybara-screenshot'
+require_relative 'observer'
+
+module Baraviz
+  class ScreenshotObserver < Observer
+    def initialize session, screenshot_dir
+      @screenshots = {}
+      @dir = screenshot_dir
+      super session
+    end
+
+    def observe_page page
+      @screenshots[page] ||= take_screenshot
+      super
+    end
+
+    def take_screenshot
+      path = File.join @dir, "#{Capybara.current_url.gsub(/[^A-Za-z0-9_\-]/, '-')}.png"
+      result = Capybara::Screenshot.registered_drivers.fetch(Capybara.current_driver) do |driver_name|
+        warn "capybara-screenshot could not detect a screenshot driver for '#{Capybara.current_driver}'. Saving with default with unknown results."
+        Capybara::Screenshot.registered_drivers[:default]
+      end.call(Capybara.page.driver, path)
+      if (result == :not_supported) then nil else File.basename(path) end
+    end
+
+    def make_node v
+      uri = URI.parse v.to_s
+      RGL::DOT::Node.new({'name' => v, 'label' => uri.path, 'image' => @screenshots[v], 'URL' => @screenshots[v]}, RGL::DOT::NODE_OPTS + ['image'])
+    end
+  end
+end

data/lib/baraviz/version.rb

@@ -1,3 +1,3 @@
 module Baraviz
-  VERSION = "0.6.pre"
+  VERSION = "0.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: baraviz
 version: !ruby/object:Gem::Version
-  version: 0.6.pre
+  version: '0.7'
 platform: ruby
 authors:
 - Simon Worthington
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-06 00:00:00.000000000 Z
+date: 2018-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: capybara-screenshot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,7 @@ files:
 - lib/baraviz.rb
 - lib/baraviz/cucumber_formatter.rb
 - lib/baraviz/observer.rb
+- lib/baraviz/screenshot_observer.rb
 - lib/baraviz/version.rb
 homepage: https://github.com/simonwo/baraviz
 licenses:
@@ -96,9 +111,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.13