captureful_formatter 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30f3679548cc23945e25fe8752233c60bd2af5fe
-  data.tar.gz: 9a7369666c42c652ca0311d87bbf10d5430af47c
+  metadata.gz: ad0d60a1d2e31c32f13ef5818453e0b1f6132339
+  data.tar.gz: 7101c556ec29a301315d734f2386a2416eb71129
 SHA512:
-  metadata.gz: e4cf41d025eacb2900a37fd594f70448195d77ad672234307f69b24cc7094d6f2f90f927b77490f8eca32db7f76b1cb3c8faa5389b889c733c60828bb498ec38
-  data.tar.gz: 5e2d0bf8c276f76f634c8c31f6e53bd262559203f968856141f44a82bbea4023c94fcd4854e775fc1437d361f2dfadba4e2f8f160868350c15c664f3db5742ef
+  metadata.gz: 825b0041593dce90b6a20eea8da9a9471dadd904a658ea0c8183e3a3faf11b2f8301355ba290f3c1aaa94165c7b343ec226c0517f26f798e526290c0b92c27fd
+  data.tar.gz: 49f2d534da1914cd3ef48e1798d5a63ca6d296548a834798e0436379799b23acd64d58383fc2ba54a6f15051ee2e3c119897592d3d938bdd7fbff4c6421c69de

data/README.md

@@ -29,10 +29,15 @@ Run this command.
 
     $ rspec
 
+## Sample
+
+![output sample](https://github.com/crowdworks/captureful_formatter/blob/master/sample.png)
+
 ## Configuration
 
 ```ruby
 CapturefulFormatter.configure do |config|
+  c.project_name = "Your Project" # Title of test report
   c.output_directory = "./.captureful_formatter" # The path to where the test report is saved.
   c.template_path = "path/to/template" # your custom template file path.
 end

data/lib/captureful_formatter.rb

@@ -1,6 +1,7 @@
 require 'captureful_formatter/formatter'
 require 'captureful_formatter/notifications'
 require 'captureful_formatter/printer'
+require 'captureful_formatter/structures'
 require 'captureful_formatter/version'
 require 'logger'
 
@@ -20,6 +21,8 @@ module CapturefulFormatter
   end
 
   class Configuration
+    attr_accessor :project_name
+
     attr_accessor :output_directory
 
     # what types to take screenshot
@@ -45,6 +48,7 @@ module CapturefulFormatter
 end
 
 CapturefulFormatter.configure do |c|
+  c.project_name     = "Your Project"
   c.output_directory = "./.captureful_formatter"
   c.target_type      = [:feature]
   c.template_path    = File.join(File.dirname(__FILE__), "/../templates/test_report.html.erb")

data/lib/captureful_formatter/formatter.rb

@@ -1,5 +1,4 @@
 require 'capybara'
-require 'digest/md5'
 require 'fileutils'
 require 'rspec/core'
 require "rspec/core/formatters/base_formatter"
@@ -9,52 +8,54 @@ module CapturefulFormatter
     ::RSpec::Core::Formatters.register self, :start, :example_group_started, :example_group_finished,
                                              :example_started, :step_started, :example_passed, :example_pending, :example_failed, :stop
 
-    Example = Struct.new("Example", :groups, :steps, :status, :fail_info)
-    FailInfo = Struct.new("FailInfo", :exception, :backtraces)
-
     def start notification
       @should_capture = false
-      @examples = {}
-      @group_level = 0
-      @group_examples = []
+      @features = []
     end
 
     def example_group_started notification
-      @should_capture = CapturefulFormatter.configuration.target_type.include? notification.group.metadata[:type]
-      @group_level += 1
-      @group_examples.push notification.group.description
+      if notification.group.metadata[:parent_example_group].nil?
+        @should_capture = CapturefulFormatter.configuration.target_type.include? notification.group.metadata[:type]
+        @current_feature = CapturefulFormatter::Structures::Feature.new(notification)
+      else
+        @current_scenario = CapturefulFormatter::Structures::Scenario.new(notification)
+      end
     end
 
     def example_group_finished(notification)
-      @should_capture = false
-      @group_level -= 1
-      @group_examples.pop
+      if notification.group.metadata[:parent_example_group].nil?
+        @features.push @current_feature
+        @should_capture = false
+      else
+        @current_feature.scenarios.push @current_scenario
+      end
     end
 
     def example_started notification
       return unless @should_capture
-      @current_example_hash = Digest::MD5.hexdigest(@group_examples.join())
-      @examples[@current_example_hash] = Example.new(@group_examples.dup, [] , nil, nil)
     end
 
     def step_started notification
-      save_step_sessions notification.description
+      return unless @should_capture
+      @current_scenario.steps.push CapturefulFormatter::Structures::Step.new(notification)
+      save_step_sessions
     end
 
     def example_passed notification
       return unless @should_capture
-      @examples[@current_example_hash].status = :passed
+
+      @current_scenario.status = :passed
     end
 
     def example_pending notification
       return unless @should_capture
-      @examples[@current_example_hash].status = :pending
+      @current_scenario.status = :pending
     end
 
     def example_failed notification
       return unless @should_capture
-      @examples[@current_example_hash].status = :failed
-      @examples[@current_example_hash].fail_info = FailInfo.new(notification.exception.to_s, notification.formatted_backtrace.dup)
+      @current_scenario.status = :failed
+      @current_scenario.exception = notification.exception
     end
 
     def stop notification
@@ -71,18 +72,16 @@ module CapturefulFormatter
       @dir ||= Pathname.new(Dir.mktmpdir ["d", self.object_id.to_s ])
     end
 
-    def save_step_sessions step_description
+    def save_step_sessions
       return unless @should_capture
-      current_count = @examples[@current_example_hash].steps.size
-      @examples[@current_example_hash].steps << step_description
-      filename_base = report_save_dir.join("#{@current_example_hash}-#{current_count.to_s}")
+      filename_base = report_save_dir.join("#{@current_scenario.hash}-#{@current_scenario.step_count.to_s}")
       Capybara.current_session.save_page       filename_base.sub_ext(".html")
       Capybara.current_session.save_screenshot filename_base.sub_ext(".png")
     end
 
     def publish_reports
       FileUtils.copy_entry report_save_dir, CapturefulFormatter.configuration.output_directory
-      CapturefulFormatter::Printer.print @examples
+      CapturefulFormatter::Printer.print @features
     end
 
     def cleanup_reports

data/lib/captureful_formatter/printer.rb

@@ -23,11 +23,11 @@ module CapturefulFormatter
     class << self
       attr_accessor :title
 
-      def print examples
+      def print(features)
         path = template_path
         params = {
-          title: "test report",
-          examples: examples
+          title: CapturefulFormatter.configuration.project_name,
+          features: features
         }
         template = Template.new(params)
         filename = File.join(CapturefulFormatter.configuration.output_directory, "/index.html")

data/lib/captureful_formatter/structures.rb

@@ -0,0 +1,71 @@
+require 'digest/md5'
+
+module CapturefulFormatter
+
+  # Data Structures for template files.
+  module Structures
+    class Feature
+      attr_accessor :scenarios
+      attr_accessor :description
+
+      # [notification]
+      #   GroupNotification
+      def initialize(notification)
+        @description = notification.group.description
+        @scenarios = []
+      end
+
+      def all_passed
+        @scenarios.count == num_passed
+      end
+
+      def num_passed
+        @scenarios.count {|scenario| scenario.status == :passed }
+      end
+
+      def num_pending
+        @scenarios.count {|scenario| scenario.status == :pending }
+      end
+
+      def num_failed
+        @scenarios.count {|scenario| scenario.status == :failed }
+      end
+    end
+
+    class Scenario
+      attr_accessor :steps
+      attr_accessor :description
+      attr_accessor :status
+      attr_accessor :exception
+
+      # [notification]
+      #   ExampleNotification
+      def initialize(notification)
+        @steps = []
+        @status = nil
+        @description = notification.group.description
+        @exception = nil
+        feature_description = notification.group.metadata[:parent_example_group][:description]
+        @hash = Digest::MD5.hexdigest("#{feature_description}#{notification.group.description}")
+      end
+
+      def hash
+        @hash
+      end
+
+      def step_count
+        @steps.size
+      end
+    end
+
+    class Step
+      attr_accessor :description
+
+      # [notification]
+      #   StepNotification
+      def initialize(notification)
+        @description = notification.description
+      end
+    end
+  end
+end

data/lib/captureful_formatter/version.rb

@@ -1,3 +1,3 @@
 module CapturefulFormatter
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/captureful_formatter/formatter_spec.rb

@@ -44,6 +44,8 @@ describe CapturefulFormatter::Formatter do
     before do
       allow(RSpec::Core::ExampleGroup).to receive(:metadata).and_return({type: :feature})
       formatter.example_group_started group_notification
+      allow(RSpec::Core::ExampleGroup).to receive(:metadata).and_return({type: :feature, parent_example_group: {description: "test feature"}})
+      formatter.example_group_started group_notification
     end
 
     describe "at step by steps" do

data/templates/test_report.html.erb

@@ -3,7 +3,10 @@
   <head>
     <meta charset="UTF-8">
     <title><%= title %></title>
-    <link href="http://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css" rel="stylesheet">
+    <link href="http://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css" rel="stylesheet" media="screen">
+    <style type="text/css">
+      body { background-color: #ececec; }
+    </style>
   </head>
   <body>
     <nav class="navbar navbar-inverse navbar-static-top">
@@ -16,48 +19,77 @@
 
     <div class="container">
       <div class="row">
-        <h2 id="index">index</h2>
-        <ul>
-          <% examples.each do |example_hash, example| %>
-            <li class="<%= background_by_status example.status %>"><a href="#<%= example_hash %>"><%= example.groups.join(" - ") %></a></li>
-          <% end %>
-        </ul>
-      </div>
-    </div>
-
-    <div class="container">
-      <div class="row">
-        <h2>examples</h2>
-        <% examples.each do |example_hash, example| %>
-          <h3 id=<%= example_hash %>><%= example.groups.join(" - ") %></h3>
-          <% example.steps.each_with_index do |step, index| %>
-            <div class="row <%= (example.steps.size - 1 == index)? background_by_status(example.status) : "" %>">
-              <div class="col-md-5">
-                <a href="./<%= example_hash %>-<%= index %>.png">
-                  <img class="img-rounded" height="256" wedth="320" src="./<%= example_hash %>-<%= index %>.png">
-                </a>
-              </div>
-              <div class="col-md-6">
-                <p><%= step %><p>
-                <% if example.steps.size - 1 == index %>
-                  <% unless example.fail_info.nil? %>
-                    <p><%= example.fail_info.exception %></p>
-                    <ul>
-                      <% example.fail_info.backtraces.each do |backtrace| %>
-                        <li><%= backtrace %></li>
-                      <% end %>
-                    </ul>
-                  <% end %>
+        <div class="col-md-3">
+          <ul class="nav nav-list affix">
+            <% features.each do |feature| %>
+              <li>
+              <a href="#<%= feature.description %>">
+                <%= feature.description %>
+                <% if feature.all_passed %>
+                  <span class="label label-success">all passed</span>
                 <% end %>
-              </div>
-            </div><!-- row -->
+                <% if feature.num_failed > 0 %>
+                  <span class="badge alert-danger"><%= feature.num_failed %></span>
+                <% end %>
+                <% if feature.num_pending > 0 %>
+                  <span class="badge alert-warning"><%= feature.num_pending %></span>
+                <% end %>
+              </a>
+              </li>
+            <% end %>
+          </ul>
+        </div>
+        <div class="col-md-9">
+          <!-- Test Report -->
+          <div class="page-header">
+            <h1><%= title %> <small>test report</small></h1>
+          </div>
+          <% features.each do |feature| %>
+            <section id="<%= feature.description %>">
+              <h2><%= feature.description %></h2>
+              <ol>
+                <% feature.scenarios.each do |scenario| %>
+                  <li>
+                  <a href="#<%= scenario.hash %>">
+                    <%= scenario.description %>
+                    <% if scenario.status == :passed %>
+                      <span class="label label-success">passed</span>
+                    <% elsif scenario.status == :pending %>
+                      <span class="label label-warning">pending</span>
+                    <% else %>
+                      <span class="label label-danger">failed</span>
+                    <% end %>
+                  </a>
+                  </li>
+                <% end %>
+              </ol>
+              <% feature.scenarios.each do |scenario| %>
+                <section id="<%= scenario.hash %>">
+                  <h3><%= scenario.description %></h3>
+                  <% scenario.steps.each_with_index do |step, index| %>
+                    <div class="row <%= (scenario.step_count - 1 == index)? background_by_status(scenario.status) : "" %>">
+                      <div class="col-md-6">
+                        <a href="./<%= scenario.hash %>-<%= index + 1 %>.png">
+                          <img class="img-thumbnail" height="256" wedth="320" src="./<%= scenario.hash %>-<%= index + 1 %>.png">
+                        </a>
+                      </div>
+                      <div class="col-md-6">
+                        <p><%= step.description %><p>
+                        <% if ((scenario.step_count - 1) == index) && scenario.status == :failed && !scenario.exception.nil? %>
+                            <p><%= scenario.exception.to_s %></p>
+                        <% end %>
+                      </div>
+                    </div><!-- row -->
+                    <hr />
+                  <% end %>
+                </section>
+              <% end %>
+            </section>
           <% end %>
-          <hr />
-        <% end %>
+          <!-- Test Report -->
+        </div>
       </div>
     </div>
-
-
     <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
     <script src="http://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script>
   </body>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: captureful_formatter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Atsushi Yasuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-21 00:00:00.000000000 Z
+date: 2014-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -100,8 +100,10 @@ files:
 - lib/captureful_formatter/notifications.rb
 - lib/captureful_formatter/printer.rb
 - lib/captureful_formatter/rspec_ext/rspec_core_reporter.rb
+- lib/captureful_formatter/structures.rb
 - lib/captureful_formatter/turnip_ext/turnip_rspec_execute.rb
 - lib/captureful_formatter/version.rb
+- sample.png
 - spec/captureful_formatter/formatter_spec.rb
 - spec/captureful_formatter/printer_spec.rb
 - spec/captureful_formatter_spec.rb