cornucopia 0.1.14 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2682bd2d0aef45b217d6232d738f47f3e263a84
-  data.tar.gz: 6421bfd30df02f3374930bbc9fde78e96503d8a2
+  metadata.gz: 3bbf7f8abccf3fce5d307ac06dd1215471b3b3a0
+  data.tar.gz: 32a60a2590a58d37617092b6fef5961f1cf05e14
 SHA512:
-  metadata.gz: 8b236913bc33aa3af05bddf15938f360e59032615891215d7e8a3f47045d50ed10a589580cfb6e9d92ba5b52cbe561326910123e116dfa46495a0c90f9aa83a7
-  data.tar.gz: 45552b891a827b6a5e8a7f73bbd0a172058c0121959374681167444d9ff8b86a90c6863c349eb1c52bedca07ff717c0750800a74c422b19e4b4bccef68e02ef2
+  metadata.gz: 16810c0c3b197e50db0bb2331492786af365d607fadd96d6f2ad91687304128b8577d938cfdb2857ac5c63c3ba074c4e5f8fd0eb6bb1175a9d0dd71a5c1a5c8f
+  data.tar.gz: db32c9f9023bec3fdf6cd404c0d43d0c7fa8e0ab6893dc5f2a49e7ef50ed0b98a7005b4bf34b9bf9c50295fc7b845f10e0913e38b115206b9ca1c3aaf7dc54ac

data/README.md

@@ -360,22 +360,12 @@ report files.
 
 ## Todos...
 
-ReportBuilder - delayed reports
-  @delayed_reports = { key: { report_name: "", report_table: ReportTable.new do || end} }
-  finder diagnostics - within sub-report.  delayed_report?
-ReportBuilder - reports by test with multiple sub-reports
-  Instead of delayed reports?
-ReportBuilder - reformat and styling of report?
-ReportBuilder - Each test in separate files so we can create a report with a list of failed tests in case there are a
-                lot of them.
-  Instead of delayed reports?
-Hooks to add stuff to reports
-  Add own section to report for test
-  Option/way to make new section a more-details section
 SitePrism override section, element, sections and elements command to allow parameters to be passed in as additional 
     options.
   functions to override:
     main function (name)
     has_
     ???
-Make configuration a singleton
+Make configuration a singleton
+SitePrism work with Capybara::Node::Simple
+ReportBuilder - reformat and styling of report?

data/lib/cornucopia/cucumber_hooks.rb

@@ -10,7 +10,9 @@ Around do |scenario, block|
 
   Cornucopia::Capybara::FinderDiagnostics::FindAction.start_test
 
-  block.call
+  Cornucopia::Util::ReportBuilder.current_report.within_test("#{scenario.feature.title} : #{scenario.title}") do
+    block.call
+  end
 
   if scenario.failed?
     seed_value = scenario.instance_variable_get(:@seed_value)

data/lib/cornucopia/rspec_hooks.rb

@@ -22,19 +22,22 @@ RSpec.configure do |config|
 
     Cornucopia::Capybara::FinderDiagnostics::FindAction.start_test
 
-    example.run
-
     test_example = example.example if example.respond_to?(:example)
     test_example ||= self.example if self.respond_to?(:example)
-    if (test_example.exception)
-      puts ("random seed for testing was: #{@seed_value}")
 
-      Cornucopia::Util::ReportBuilder.current_report.
-          within_section("Test Error: #{test_example.full_description}") do |report|
-        configured_report = Cornucopia::Util::Configuration.report_configuration :rspec
+    Cornucopia::Util::ReportBuilder.current_report.within_test(test_example.full_description) do
+      example.run
+
+      if (test_example.exception)
+        puts ("random seed for testing was: #{@seed_value}")
+
+        Cornucopia::Util::ReportBuilder.current_report.
+            within_section("Test Error: #{test_example.full_description}") do |report|
+          configured_report = Cornucopia::Util::Configuration.report_configuration :rspec
 
-        configured_report.add_report_objects example: test_example, rspec: RSpec
-        configured_report.generate_report(report)
+          configured_report.add_report_objects example: test_example, rspec: RSpec
+          configured_report.generate_report(report)
+        end
       end
     end
   end

data/lib/cornucopia/source_files/cornucopia.css

@@ -36,12 +36,14 @@
   display: table-row;
 }
 
-.cornucopia-section:nth-child(2n)
+/*.cornucopia-section:nth-child(2n),*/
+.cornucopia-section.cornucopia-even
 {
   background-color: steelblue;
 }
 
-.cornucopia-section:nth-child(2n +1)
+/*.cornucopia-section:nth-child(2n +1),*/
+.cornucopia-section.cornucopia-odd
 {
   background-color: powderblue;
 }
@@ -113,6 +115,11 @@
   position:       relative;
 }
 
+.cornucopia-end-section
+{
+  clear: left;
+}
+
 .cornucopia-section-image
 {
   margin-bottom: 10px;
@@ -149,6 +156,27 @@
   color:       red
 }
 
+.report-index-list li
+{
+  padding-bottom:      5px;
+  margin-bottom:       5px;
+  border-bottom-style: solid;
+  border-bottom-color: lightgrey;
+  border-bottom-width: thin;
+}
+
+.report-index-list li:last-child
+{
+  border-bottom-style: none;
+}
+
+.report-index-list
+{
+  list-style-type: none;
+  margin-bottom:   10px;
+  padding-left:    5px;
+}
+
 .index-list
 {
   list-style-type: none;
@@ -159,4 +187,47 @@
 .padded-frame
 {
   padding-right: 10px;
+}
+
+.coruncopia-report-holder-table
+{
+  display: table;
+  height:  100%;
+  width:   100%;
+}
+
+.coruncopia-report-holder-row
+{
+  display: table-row;
+  height:  100%;
+}
+
+.coruncopia-report-holder-list-cell
+{
+  display:        table-cell;
+  height:         100%;
+  vertical-align: top;
+  padding-right:  5px;
+}
+
+.coruncopia-report-holder-list-holder
+{
+  margin:     0px;
+  padding:    0px;
+  overflow-y: scroll;
+}
+
+.coruncopia-report-body-cell
+{
+  display: table-cell;
+  width:   100%;
+  height:  100%;
+}
+
+.coruncopia-report-body-frame
+{
+  float:        right;
+  width:        100%;
+  height:       100%;
+  border-style: none;
 }

data/lib/cornucopia/source_files/report.js

@@ -0,0 +1,17 @@
+last_scroll_top = null;
+
+function show_sub_report (event_obj)
+{
+  if (!(event_obj.shiftKey || event_obj.ctrlKey || event_obj.metaKey || event_obj.altKey))
+  {
+    link_item = $ (event_obj.target);
+    $("#report-display-document").attr("src", link_item.attr ("href"))
+    event_obj.preventDefault();
+  }
+}
+
+$ (document).ready (function ()
+    {
+      $ (document).on ("click", "a.coruncopia-report-link", {}, show_sub_report);
+    }
+);

data/lib/cornucopia/source_files/report_holder.html

@@ -0,0 +1,22 @@
+<html>
+<header><title>%{report_title}</title></header>
+<body>
+<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
+<link href="cornucopia.css" rel="stylesheet" type="text/css" />
+<div class="coruncopia-report-holder-table">
+  <div class="coruncopia-report-holder-row">
+    <div class="coruncopia-report-holder-list-cell">
+      <!--<div class=".coruncopia-report-holder-list-holder">-->
+        <ul class="report-index-list">
+          %{report_list}
+        </ul>
+      <!--</div>-->
+    </div>
+    <div class="coruncopia-report-body-cell">
+      <iframe class="coruncopia-report-body-frame" id="report-display-document" src=""></iframe>
+    </div>
+  </div>
+</div>
+<script src="report.js"></script>
+</body>
+</html>

data/lib/cornucopia/spinach_hooks.rb

@@ -2,6 +2,12 @@ require ::File.expand_path("../cornucopia", File.dirname(__FILE__))
 load ::File.expand_path("capybara/install_finder_extensions.rb", File.dirname(__FILE__))
 load ::File.expand_path("site_prism/install_element_extensions.rb", File.dirname(__FILE__))
 
+Spinach.hooks.around_scenario do |scenario_data, step_definitions, &block|
+  Cornucopia::Util::ReportBuilder.current_report.within_test("#{scenario_data.feature.name} : #{scenario_data.name}") do
+    block.call
+  end
+end
+
 Spinach.hooks.before_scenario do |scenario, step_definitions|
   @running_scenario = scenario
   seed_value        = Cornucopia::Util::Configuration.seed ||

data/lib/cornucopia/util/configured_report.rb

@@ -159,34 +159,20 @@ module Cornucopia
         options_report_table = options.delete(:report_table)
         [@min_fields, @more_info_fields].each do |export_field_list|
           if export_field_list
-            table_pre  = nil
-            table_post = nil
-
+            table_pre      = false
+            table_function = :within_table
             if @min_fields != export_field_list && !options_report_table
               options_report_table = nil
+              table_pre            = true
 
-              table_pre = "<div class=\"cornucopia-show-hide-section\">\n"
-              table_pre << "  <div class=\"cornucopia-table\">\n"
-              table_pre << "    <div class=\"cornucopia-row\">\n"
-              table_pre << "      <div class=\"cornucopia-cell-data\">\n"
-              table_pre << "        <a class =\"cornucopia-additional-details\" href=\"#\">More Details...</a>\n"
-              table_pre << "      </div>\n"
-              table_pre << "    </div>\n"
-              table_pre << "  </div>\n"
-              table_pre << "  <div class=\"cornucopia-additional-details hidden\">\n"
-              table_pre.html_safe
-              table_post = "  </div>\n"
-              table_post << "</div>\n"
-              table_post.html_safe
+              table_function = :within_hidden_table
             end
 
-            report.within_table(table_prefix:         table_pre,
-                                table_postfix:        table_post,
-                                report_table:         options_report_table,
-                                nested_table:         options.delete(:nested_table),
-                                nested_table_label:   options.delete(:nested_table_label),
-                                not_a_table:          table_pre,
-                                suppress_blank_table: table_pre) do |outer_report_table|
+            report.send(table_function,
+                        report_table:       options_report_table,
+                        nested_table:       options.delete(:nested_table),
+                        nested_table_label: options.delete(:nested_table_label)
+            ) do |outer_report_table|
               Cornucopia::Util::ReportTable.new(
                   report_table:         table_pre ? nil : outer_report_table,
                   nested_table:         outer_report_table,

data/lib/cornucopia/util/file_asset.rb

@@ -17,6 +17,14 @@ module Cornucopia
         @asset_body = asset_body
       end
 
+      def body
+        unless @asset_body
+          self.source_file = path
+        end
+
+        @asset_body
+      end
+
       def source_file=(source_file_name)
         # We read the file into memory in case the file moves or is temporary.
         @asset_body = File.read(source_file_name)

data/lib/cornucopia/util/report_builder.rb

@@ -152,7 +152,8 @@ module Cornucopia
           section << "</h4>\n".html_safe
           section << "  <ul class=\"index-list\">\n".html_safe
 
-          section_items.each do |section_item|
+          section << Cornucopia::Util::ReportBuilder.build_index_section_item(section_items.shift)
+          section_items.reverse.each do |section_item|
             section << Cornucopia::Util::ReportBuilder.build_index_section_item(section_item)
           end
 
@@ -193,6 +194,11 @@ module Cornucopia
       def initialize(folder_name = nil, parent_folder = nil)
         @parent_folder_name = parent_folder || Cornucopia::Util::Configuration.base_folder
         @base_folder_name   = folder_name || Cornucopia::Util::Configuration.base_folder
+        @report_title       = folder_name || Cornucopia::Util::Configuration.base_folder
+        @test_name          = "unknown_test"
+        @section_number     = 0
+        @test_number        = 0
+        @report_body        = "".html_safe
       end
 
       # This does nothing in a normal report because reports are built as you go.
@@ -211,14 +217,13 @@ module Cornucopia
           end
         end
 
-        if File.exists?(report_contents_page_name)
+        if File.exists?(report_base_page_name)
           if Cornucopia::Util::Configuration.open_report_after_generation(@base_folder_name)
             # `open #{report_base_page_name}` rescue nil
             system("open #{report_base_page_name}") rescue nil
           end
         else
-          initialize_report_files
-          File.open(report_contents_page_name, "a:UTF-8") do |write_file|
+          open_report_contents_file do |write_file|
             write_file.write %Q[<p class=\"cornucopia-no-errors\">No Errors to report</p>]
             write_file.write "\n"
           end
@@ -244,6 +249,15 @@ module Cornucopia
         @report_folder_name
       end
 
+      def report_test_folder_name
+        unless @report_test_folder_name
+          @test_number             += 1
+          @report_test_folder_name = File.join(report_folder_name, "test_#{@test_number}")
+        end
+
+        @report_test_folder_name
+      end
+
       def index_folder_name
         unless @index_folder_name
           @index_folder_name = File.join(Cornucopia::Util::ReportBuilder.root_folder, "#{@parent_folder_name}/")
@@ -342,6 +356,23 @@ module Cornucopia
         end
       end
 
+      def rebuild_report_holder_page
+        initialize_report_files
+
+        report_folder = report_folder_name
+
+        FileUtils.mkdir_p report_folder_name
+        FileUtils.rm_rf report_base_page_name
+
+        report_holder_body = FileAsset.asset("report_holder.html").body
+        FileAsset.asset("report.js").add_file(File.join(report_folder, "report.js"))
+        FileAsset.asset("cornucopia.css").add_file(File.join(report_folder, "cornucopia.css"))
+
+        File.open(File.join(report_folder, "index.html"), "w+") do |write_file|
+          write_file << report_holder_body % { report_list: @report_body, report_title: @report_title }
+        end
+      end
+
       def report_base_page_name
         File.join(report_folder_name, "index.html")
       end
@@ -350,6 +381,14 @@ module Cornucopia
         File.join(report_folder_name, "report_contents.html")
       end
 
+      def report_test_base_page_name
+        File.join(report_test_folder_name, "index.html")
+      end
+
+      def report_test_contents_page_name
+        File.join(report_test_folder_name, "report_contents.html")
+      end
+
       def index_base_page_name
         File.join(index_folder_name, "index.html")
       end
@@ -358,12 +397,28 @@ module Cornucopia
         File.join(index_folder_name, "report_contents.html")
       end
 
-      def initialize_report_files()
+      def initialize_report_files
+        support_folder_name = report_folder_name
+
+        FileUtils.mkdir_p @report_folder_name
+
+        unless File.exists?(report_base_page_name)
+          # use a different base index file.
+          FileAsset.asset("report_holder.html").add_file(File.join(support_folder_name, "index.html"))
+          rebuild_index_page
+        end
+
+        FileAsset.asset("report.js").add_file(File.join(support_folder_name, "report.js"))
+        FileAsset.asset("cornucopia.css").add_file(File.join(support_folder_name, "cornucopia.css"))
+      end
+
+      def initialize_basic_report_files
         support_folder_name = report_folder_name
 
         FileUtils.mkdir_p @report_folder_name
 
         unless File.exists?(report_base_page_name)
+          # use a different base index file.
           FileAsset.asset("report_base.html").add_file(File.join(support_folder_name, "index.html"))
           rebuild_index_page
         end
@@ -375,27 +430,117 @@ module Cornucopia
         FileAsset.asset("cornucopia.css").add_file(File.join(support_folder_name, "cornucopia.css"))
       end
 
+      def test_list_item
+        if @test_list_item
+          nil
+        else
+          folder_name = File.basename(report_test_folder_name)
+
+          @test_list_item = "<li>\n".html_safe
+          @test_list_item += "<a class=\"coruncopia-report-link\" href=\"#{folder_name}/index.html\" target=\"_blank\">".html_safe
+          @test_list_item += @test_name
+          @test_list_item += "</a>\n".html_safe
+          @test_list_item += "</li>\n".html_safe
+
+          @test_list_item
+        end
+      end
+
+      def initialize_report_test_files
+        @report_body += test_list_item
+
+        support_folder_name = report_test_folder_name
+
+        FileUtils.mkdir_p @report_test_folder_name
+
+        unless File.exists?(report_test_base_page_name)
+          FileAsset.asset("report_base.html").add_file(File.join(support_folder_name, "index.html"))
+          rebuild_report_holder_page
+        end
+
+        FileAsset.asset("report_contents.html").add_file(File.join(support_folder_name, "report_contents.html"))
+        FileAsset.asset("collapse.gif").add_file(File.join(support_folder_name, "collapse.gif"))
+        FileAsset.asset("expand.gif").add_file(File.join(support_folder_name, "expand.gif"))
+        FileAsset.asset("more_info.js").add_file(File.join(support_folder_name, "more_info.js"))
+        FileAsset.asset("cornucopia.css").add_file(File.join(support_folder_name, "cornucopia.css"))
+      end
+
       def open_report_contents_file(&block)
-        initialize_report_files
+        initialize_basic_report_files
 
         File.open(report_contents_page_name, "a:UTF-8", &block)
       end
 
+      def open_report_test_contents_file(&block)
+        initialize_report_test_files
+
+        File.open(report_test_contents_page_name, "a:UTF-8", &block)
+      end
+
+      def within_test(test_name, &block)
+        orig_test_name      = @test_name
+        orig_test_folder    = @report_test_folder_name
+        orig_test_list_item = @test_list_item
+        orig_section_number = @section_number
+
+        begin
+          @test_name               = test_name
+          @report_test_folder_name = nil
+          @test_list_item          = nil
+          @section_number          = 0
+
+          block.yield
+        ensure
+          @section_number          = orig_section_number
+          @test_name               = orig_test_name
+          @report_test_folder_name = orig_test_folder
+          @test_list_item          = orig_test_list_item
+        end
+      end
+
       def within_section(section_text, &block)
         begin
-          open_report_contents_file do |write_file|
-            write_file.write "<div class=\"cornucopia-section\">\n"
+          open_report_test_contents_file do |write_file|
+            write_file.write "<div class=\"cornucopia-section #{((@section_number += 1) % 2) == 1 ? "cornucopia-even" : "cornucopia-odd"}\">\n"
             write_file.write "<p class=\"cornucopia-section-label\">#{Cornucopia::Util::ReportBuilder.escape_string(section_text)}</p>\n".
                                  force_encoding("UTF-8")
           end
           block.yield self
         ensure
-          open_report_contents_file do |write_file|
+          open_report_test_contents_file do |write_file|
             write_file.write "</div>\n"
+            write_file.write "<div class=\"cornucopia-end-section\" />\n"
           end
         end
       end
 
+      def within_hidden_table(options={}, &block)
+        table_pre = "<div class=\"cornucopia-show-hide-section\">\n"
+        table_pre << "  <div class=\"cornucopia-table\">\n"
+        table_pre << "    <div class=\"cornucopia-row\">\n"
+        table_pre << "      <div class=\"cornucopia-cell-data\">\n"
+        table_pre << "        <a class =\"cornucopia-additional-details\" href=\"#\">More Details...</a>\n"
+        table_pre << "      </div>\n"
+        table_pre << "    </div>\n"
+        table_pre << "  </div>\n"
+        table_pre << "  <div class=\"cornucopia-additional-details hidden\">\n"
+        table_pre = table_pre.html_safe
+
+        table_post = "  </div>\n"
+        table_post << "</div>\n"
+        table_post = table_post.html_safe
+
+        within_table(table_prefix:         table_pre,
+                     table_postfix:        table_post,
+                     report_table:         nil,
+                     nested_table:         options.delete(:nested_table),
+                     nested_table_label:   options.delete(:nested_table_label),
+                     not_a_table:          table_pre,
+                     suppress_blank_table: table_pre) do |outer_report_table|
+          block.yield outer_report_table
+        end
+      end
+
       def within_table(options = {}, &block)
         report_table         = nil
         options_report_table = options[:report_table]
@@ -407,7 +552,7 @@ module Cornucopia
           end
         ensure
           if report_table && !options_report_table
-            open_report_contents_file do |write_file|
+            open_report_test_contents_file do |write_file|
               write_file.write report_table.full_table.force_encoding("UTF-8")
             end
           end