report_builder 1.4 → 1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35b353893ae02902dd4b6c8d07a7f38d66ab57c6
-  data.tar.gz: fab6f1b0dad20645c4e8f7f68d43761da94521c6
+  metadata.gz: 4e040f4e0aab45099f7c665d0ff4ccf69f49f348
+  data.tar.gz: 95c2949aa0d294f0dbfe677243d0386f90d9414a
 SHA512:
-  metadata.gz: 4403905db936a5cd577738d24cfd7553f4fa9ab458226d4f0d56d5f4bf8bcbacf31ea14f0a962360a23f68e670c8df9ca548fa6aea124bca4d62fcbba212708c
-  data.tar.gz: 4bb0c1e121f3935bced443fb09903a6a2f6f61893e80497c02424ece1224569af13facb623e371c1f7bc1fdc5a1b654f39aa7fc784e541de9df3acf081b1ca55
+  metadata.gz: 2ac1cbd9679f7fb626c54a1932e8882d862cc0dddf2300a2ae87ae72b128a929a5e90122dc17ae774ca9d0bb848231d95b064ddfca6b4c0a43a5f59276a52073
+  data.tar.gz: b0e8ecb77d1d4af4608a1a26f2f0cf2fc42f3b2afee74929385ce372708631425b060551a88f3dc9b42f659bc3086d9feb3976be7fee2aeb13bbb933fa35e5c2

data/CHANGELOG.md

@@ -3,7 +3,15 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 
-## [Unreleased](https://github.com/rajatthareja/ReportBuilder/compare/v1.4...master)
+## [Unreleased](https://github.com/rajatthareja/ReportBuilder/compare/v1.5...master)
+
+## [1.5](https://github.com/rajatthareja/ReportBuilder/compare/v1.4...v1.5) - 2017-03-03
+### Added
+- Voice Commands
+- Tabs name
+- Color option
+### Fixed
+- js and  css cli option
 
 ## [1.4](https://github.com/rajatthareja/ReportBuilder/compare/v1.3...v1.4) - 2017-10-29
 ### Fixed

data/README.md

@@ -42,9 +42,11 @@ gem install report_builder
 | report_types         | [Array]                 | [:html]             | :json, :html, :retry (output file types)                                                 |
 | report_title         | [String]                | 'Test Results'      | report and html title                                                                    |
 | include_images       | [Boolean]               | true                | true / false (If false, the size of HTML report is reduced by excluding embedded images) |
+| voice_commands       | [Boolean]               | false               | true / false (Enable voice commands for easy navigation and search)                      |
 | additional_info      | [Hash]                  | {}                  | additional info for report summary                                                       |
 | additional_css       | [String]                | nil                 | additional CSS string or CSS file path or CSS file url for customizing html report       |
 | additional_js        | [String]                | nil                 | additional JS string or JS file path or JS file url for customizing html report          |
+| color                | [String]                | brown               | report color, Ex: indigo, cyan, purple, grey, lime etc.                                  |
 
 ### Code Examples:
 
@@ -83,7 +85,7 @@ gem install report_builder
 ```ruby
 
 ReportBuilder.configure do |config|
-  config.json_path = config.json_path = {
+     config.json_path = {
       'Group A' => ['path/of/json/files/dir1', 'path/of/json/files/dir2'],
       'Group B' => ['path/of/json/file1', 'path/of/json/file2'],
       'Group C' => 'path/of/json/files/dir'}
@@ -96,21 +98,23 @@ ReportBuilder.build_report
 
 ### CLI Options:
 
-| Option              | Values       | Explanation                                                                        |
-|---------------------|--------------|------------------------------------------------------------------------------------|
-| -s, --source        | x,y,z        | List of input json path or files                                                   |
-| -o, --out           | [PATH]NAME   | Reports path with name without extension                                           |
-| --json_out          | [PATH]NAME   | JSON report path with name without extension                                       |
-| --html_out          | [PATH]NAME   | HTML report path with name without extension                                       |
-| --retry_out         | [PATH]NAME   | Retry report path with name without extension                                      |
-| -f, --format        | x,y,z        | List of report format - html,json,retry                                            |
-| --[no-]images       |              | Reduce HTML report size by excluding embedded images                               |
-| -T, --title         | TITLE        | Report title                                                                       |
-| -I, --info          | a:x,b:y,c:z  | List of additional info about test - key:value                                     |
-| --css               | CSS/PATH/URL | Additional CSS string or CSS file path or CSS file url for customizing html report |
-| --js                | JS/PATH/URL  | Additional JS string or JS file path or JS file url for customizing html report    |
-| -h, --help          |              | Show available command line switches                                               |
-| -v, --version       |              | Show gem version                                                                   |
+| Option                | Values       | Explanation                                                                        |
+|-----------------------|--------------|------------------------------------------------------------------------------------|
+| -s, --source          | x,y,z        | List of input json path or files                                                   |
+| -o, --out             | [PATH]NAME   | Reports path with name without extension                                           |
+| --json_out            | [PATH]NAME   | JSON report path with name without extension                                       |
+| --html_out            | [PATH]NAME   | HTML report path with name without extension                                       |
+| --retry_out           | [PATH]NAME   | Retry report path with name without extension                                      |
+| -f, --format          | x,y,z        | List of report format - html,json,retry                                            |
+| --[no-]images         |              | Reduce HTML report size by excluding embedded images                               |
+| -T, --title           | TITLE        | Report title                                                                       |
+| -c, --color           | COLOR        | Report color                                                                       |
+| -I, --info            | a:x,b:y,c:z  | List of additional info about test - key:value                                     |
+| --css                 | CSS/PATH/URL | Additional CSS string or CSS file path or CSS file url for customizing html report |
+| --js                  | JS/PATH/URL  | Additional JS string or JS file path or JS file url for customizing html report    |
+| -vc, --voice_commands |              | Enable voice commands for easy navigation and search                               |
+| -h, --help            |              | Show available command line switches                                               |
+| -v, --version         |              | Show gem version                                                                   |
 
 ### CLI Example:
 
@@ -149,13 +153,18 @@ Then run rake task report_builder
 
 ```
 
+### Voice Commands:
+Use voice commands for easy navigation and search
+* show ( overview | features | summary | errors )
+* search { Keywords }
+
 ## Contributing
 
 We're open to any contribution. It has to be tested properly though.
 
 ## Collaborators
 
-* [Rajat Thareja](https://github.com/rajatthareja)
+* [Rajat Thareja](http://rajatthareja.com)
 * [Justin Commu](https://github.com/tk8817)
 * [Eric Kessler](https://github.com/enkessler)
 * [Jeff Morgan](https://github.com/cheezy)

data/bin/report_builder

@@ -9,6 +9,8 @@ options = {
     :report_types => [:html],
     :report_title => 'Test Results',
     :include_images => true,
+    :voice_commands => false,
+    :color => 'brown',
     :additional_info => {}
     }
 
@@ -16,7 +18,7 @@ opt_parser = OptionParser.new do |opts|
   opts.banner = "Usage: \n     report_builder [options]"
   opts.separator 'Configuration options:'
 
-  opts.on('-s','--source x,y,z', Array, 'List of json path or files') do |list|
+  opts.on('-s', '--source x,y,z', Array, 'List of json path or files') do |list|
     options[:json_path] = list
   end
 
@@ -36,7 +38,7 @@ opt_parser = OptionParser.new do |opts|
     options[:retry_report_path] = report_path
   end
 
-  opts.on('-f','--format x,y,z', Array, 'List of report format - html,json,retry') do |list|
+  opts.on('-f', '--format x,y,z', Array, 'List of report format - html,json,retry') do |list|
     options[:report_types] = list
   end
 
@@ -44,22 +46,30 @@ opt_parser = OptionParser.new do |opts|
     options[:include_images] = include_images
   end
 
+  opts.on('-vc', '--voice_commands', 'Enable voice commands for easy navigation and search') do |voice_commands|
+    options[:voice_commands] = voice_commands
+  end
+
+  opts.on('-c', '--color COLOR', String, 'Report color') do |color|
+    options[:color] = color
+  end
+
   opts.on('-T', '--title TITLE', String, 'Report title') do |report_title|
     options[:report_title] = report_title
   end
 
-  opts.on('-I','--info a:x,b:y,c:z', Array, 'List of additional info') do |list|
+  opts.on('-I', '--info a:x,b:y,c:z', Array, 'List of additional info') do |list|
     list.each do |i|
       key, value = i.split(':')
       options[:additional_info][key] = value
     end
   end
 
-  opts.on('--css', 'Additional CSS string or CSS file path or CSS file url for customizing html report') do |additional_css|
+  opts.on('--css CSS', String, 'Additional CSS string or CSS file path or CSS file url for customizing html report') do |additional_css|
     options[:additional_css] = additional_css
   end
 
-  opts.on('--js', 'Additional JS string or JS file path or JS file url for customizing html report') do |additional_js|
+  opts.on('--js JS', String, 'Additional JS string or JS file path or JS file url for customizing html report') do |additional_js|
     options[:additional_js] = additional_js
   end
 
@@ -70,7 +80,7 @@ opt_parser = OptionParser.new do |opts|
     exit
   end
 
-  opts.on_tail('-v','--version', 'Show version') do
+  opts.on_tail('-v', '--version', 'Show version') do
     puts 'ReportBuilder v' + Gem.loaded_specs['report_builder'].version.to_s rescue puts "Something want wrong. \nUse 'gem list report_builder'"
     exit
   end

data/lib/report_builder.rb

@@ -15,6 +15,7 @@ module ReportBuilder
   #       config.report_types = [:JSON, :HTML]
   #       config.report_title = 'My Test Results'
   #       config.include_images = true
+  #       config.voice_commands = true
   #       config.additional_info = {Browser: 'Chrome', Environment: 'Stage 5'}
   #     end
   #
@@ -52,6 +53,8 @@ module ReportBuilder
   #       report_types: ['json', 'html'],
   #       report_title: 'My Test Results',
   #       include_images: true,
+  #       voice_commands: true,
+  #       color: 'deep-purple',
   #       additional_info: {'browser' => 'Chrome', 'environment' => 'Stage 5'}
   #     }
   #

data/lib/report_builder/builder.rb

@@ -67,13 +67,15 @@ module ReportBuilder
                      report_types: [:html],
                      report_title: 'Test Results',
                      include_images: true,
+                     voice_commands: false,
                      additional_info: {},
                      report_path: 'test_report',
                      json_report_path: nil,
                      html_report_path: nil,
                      retry_report_path: nil,
                      additional_css: nil,
-                     additional_js: nil
+                     additional_js: nil,
+                     color: 'brown'
       )
     end
 

data/report_builder.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'report_builder'
-  s.version     = '1.4'
+  s.version     = '1.5'
   s.bindir      = 'bin'
   s.summary     = 'ReportBuilder'
   s.description = 'Ruby gem to merge Cucumber JSON reports and build mobile-friendly HTML Test Report, JSON report and retry file.'

data/template/error.erb

@@ -3,13 +3,13 @@
     <i class="material-icons">bug_report</i><%= error %>
   </div>
 
-  <div class="collapsible-body brown lighten-4">
+  <div class="collapsible-body <%= options[:color] %> lighten-4">
     <ul class="collection failedScenarioList">
       <% features.each_with_index do |feature, f| %>
           <% feature['elements'].each_with_index do |scenario, s| %>
               <% if scenario['error'] %>
                   <% if scenario['error'] == error %>
-                      <li class="collection-item failedScenario brown lighten-5 red-text">
+                      <li class="collection-item failedScenario <%= options[:color] %> lighten-5 red-text">
                         <i class="material-icons">highlight_off</i>&nbsp;<a class="modal-trigger red-text" href="#<%= "#{gid}f#{f}s#{s}" %>"><%= scenario['name'] %></a>
                       </li>
                   <% end %>

data/template/feature.erb

@@ -1,10 +1,10 @@
 <li class="feature <%= feature['status'] %>">
-  <div class="collapsible-header brown lighten-1 waves-effect waves-light">
+  <div class="collapsible-header <%= options[:color] %> lighten-1 waves-effect waves-light">
     <i class="material-icons">featured_play_list</i>
     <b><%= feature['keyword'] %></b>&nbsp;<%= feature['name'] %>&nbsp;(<%= duration(feature['duration']) %>)
   </div>
 
-  <div class="collapsible-body brown lighten-4">
+  <div class="collapsible-body <%= options[:color] %> lighten-4">
     <ul class="collection scenarioList">
       <% feature['elements'].each_with_index do |scenario, s| %>
           <li class="collection-item scenario <%= scenario['status'] %>">

data/template/footer.erb

@@ -1,5 +1,5 @@
-<footer class="page-footer brown lighten-4">
-  <div class="footer-copyright brown lighten-1">
+<footer class="page-footer <%= options[:color] %> lighten-4">
+  <div class="footer-copyright <%= options[:color] %> lighten-1">
     <div class="container">
       Happy Reporting!
       <a class="white-text text-lighten-4 right" href="http://reportbuilder.rajatthareja.com">Generated by Report Builder</a>
@@ -7,7 +7,33 @@
   </div>
 </footer>
 
-<script type="text/javascript" src="https://cdn.rawgit.com/rajatthareja/ReportBuilder/v1.4/js/report.builder.min.js"></script>
+<script type="text/javascript" src="https://cdn.rawgit.com/rajatthareja/ReportBuilder/v1.5/js/report.builder.min.js"></script>
+
+<% if options[:voice_commands] %>
+<script src="//cdnjs.cloudflare.com/ajax/libs/annyang/2.6.0/annyang.min.js"></script>
+<script>
+    var commands = {
+        'show :tab': function(tab) {
+            if (tab === "overview") {
+                $("a[data-tooltip='Results Overview']").click();
+            } else if (tab === "features" || tab === "feature") {
+                $("a[data-tooltip='Scenarios by Features']").click();
+            } else if (tab === "summary") {
+                $("a[data-tooltip='Scenarios Summary Table']").click();
+            } else if (tab === "errors" || tab === "error" || tab === "failed" || tab === "bugs") {
+                $("a[data-tooltip='Failed Scenarios']").click();
+            }
+        },
+        'search *search': function (search) {
+            $("a[data-tooltip='Scenarios Summary Table']").click();
+            $("input[type='search']").val(search);
+            $('table#summaryTable').DataTable().search(search).draw();
+        }
+    };
+    annyang.addCommands(commands);
+    annyang.start();
+</script>
+<% end %>
 
 <% if options[:additional_js] %>
     <% if options[:additional_js] =~ /^http(|s):\/\/.*\.js$/ %>

data/template/group_errors.erb

@@ -10,7 +10,7 @@
             <b><%= group['name'] %></b>
           </div>
 
-          <div class="collapsible-body brown lighten-4">
+          <div class="collapsible-body <%= options[:color] %> lighten-4">
             <%= get('errors').result(binding) %>
           </div>
       </li>

data/template/group_features.erb

@@ -5,12 +5,12 @@
       <% features = group['features'] %>
       <li class="group">
 
-        <div class="collapsible-header brown lighten-1 waves-effect waves-light">
+        <div class="collapsible-header <%= options[:color] %> lighten-1 waves-effect waves-light">
           <i class="material-icons">group_work</i>
           <b><%= group['name'] %></b>&nbsp;(<%= duration(total_time(features)) %>)
         </div>
 
-        <div class="collapsible-body brown lighten-4">
+        <div class="collapsible-body <%= options[:color] %> lighten-4">
           <%= get('features').result(binding) %>
         </div>
       </li>

data/template/group_report.erb

@@ -12,21 +12,21 @@
   <%= get('scenarios').result(binding) %>
 <% end %>
 
-<main class="brown lighten-5">
+<main class="<%= options[:color] %> lighten-5">
   <div class="row">
-    <div id="overview" class="col s12 brown lighten-5">
+    <div id="overview" class="col s12 <%= options[:color] %> lighten-5">
       <%= get('group_overview').result(binding) %>
     </div>
 
-    <div id="features" class="col s12 brown lighten-5 white-text">
+    <div id="features" class="col s12 <%= options[:color] %> lighten-5 white-text">
       <%= get('group_features').result(binding) %>
     </div>
 
-    <div id="summary" class="col s12 brown lighten-5">
+    <div id="summary" class="col s12 <%= options[:color] %> lighten-5">
       <%= get('group_summary').result(binding) %>
     </div>
 
-    <div id="errors" class="col s12 brown lighten-5">
+    <div id="errors" class="col s12 <%= options[:color] %> lighten-5">
       <%= get('group_errors').result(binding) %>
     </div>
   </div>

data/template/group_summary.erb

@@ -1,4 +1,4 @@
-<table id="summaryTable" class="bordered brown lighten-1 white-text" width="100%">
+<table id="summaryTable" class="bordered <%= options[:color] %> lighten-1 white-text" width="100%">
   <thead>
   <tr>
     <th class="hide-on-small-only">Group</th>

data/template/head.erb

@@ -8,7 +8,7 @@
   <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
   <link href="https://cdn.datatables.net/1.10.16/css/jquery.dataTables.min.css" rel="stylesheet">
   <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/materialize/0.100.2/css/materialize.min.css" media="screen,projection"/>
-  <link href="https://cdn.rawgit.com/rajatthareja/ReportBuilder/v1.4/css/report.builder.min.css" rel="stylesheet">
+  <link href="https://cdn.rawgit.com/rajatthareja/ReportBuilder/v1.5/css/report.builder.min.css" rel="stylesheet">
 
   <% if options[:additional_css] %>
       <% if options[:additional_css] =~ /^http(|s):\/\/.*\.css$/ %>

data/template/header.erb

@@ -3,25 +3,25 @@
 <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/Chart.js/2.7.0/Chart.min.js"></script>
 <script type="text/javascript" src="https://cdn.datatables.net/1.10.16/js/jquery.dataTables.min.js"></script>
 
-<header class="brown lighten-5">
-  <div class="row brown lighten-1">
-    <div class="col m8 hide-on-small-only">
+<header class="<%= options[:color] %> lighten-5">
+  <div class="row <%= options[:color] %> lighten-1">
+    <div class="col m6 hide-on-small-only">
       <h5 class="truncate white-text tooltipped" data-tooltip="<%= options[:report_title] %>"><%= options[:report_title] %></h5>
     </div>
 
-    <div class="col m4 s12 brown lighten-1">
-      <ul class="tabs brown lighten-1">
+    <div class="col m6 s12 <%= options[:color] %> lighten-1">
+      <ul class="tabs <%= options[:color] %> lighten-1 row" style="overflow-x: hidden">
         <li class="tab col s3">
-          <a class="btn brown lighten-3 active blue-text waves-effect waves-light tooltipped" data-tooltip="Overview" href="#overview"><i class="material-icons">public</i></a>
+          <a class="<%= options[:color] %> lighten-3 active blue-text waves-effect waves-light tooltipped" data-tooltip="Results Overview" href="#overview"><i class="material-icons">assessment</i> Overview</a>
         </li>
         <li class="tab col s3">
-          <a class="btn brown lighten-3 white-text waves-effect waves-light tooltipped" data-tooltip="Features" href="#features"><i class="material-icons">view_headline</i></a>
+          <a class="<%= options[:color] %> lighten-3 white-text waves-effect waves-light tooltipped" data-tooltip="Scenarios by Features" href="#features"><i class="material-icons">view_headline</i> Features</a>
         </li>
         <li class="tab col s3">
-          <a class="btn brown lighten-3 white-text waves-effect waves-light tooltipped" data-tooltip="Summary" href="#summary"><i class="material-icons">view_comfy</i></a>
+          <a class="<%= options[:color] %> lighten-3 white-text waves-effect waves-light tooltipped" data-tooltip="Scenarios Summary Table" href="#summary"><i class="material-icons">view_comfy</i> Summary</a>
         </li>
         <li class="tab col s3">
-          <a class="btn brown lighten-3 white-text waves-effect waves-light tooltipped" data-tooltip="Errors" href="#errors"><i class="material-icons">bug_report</i></a>
+          <a class="<%= options[:color] %> lighten-3 white-text waves-effect waves-light tooltipped" data-tooltip="Failed Scenarios" href="#errors"><i class="material-icons">bug_report</i> Errors</a>
         </li>
       </ul>
     </div>

data/template/hook.erb

@@ -21,8 +21,11 @@
             <% if embedding['data'].include?('|||') %>
                 <% title, link = embedding['data'].split('|||') %><a href="<%= link %>"><%= title %></a>
             <% else %>
-                <%= embedding['data'] %>
+                <a href="<%= embedding['data'] %>"><%= embedding['data'] %></a>
             <% end %>
+        <% elsif embedding['mime_type'] =~ /^text\/html/ %>
+            <%= embedding['data'] %>
         <% end %>
+        <br/>
     <% end %>
 <% end %>

data/template/report.erb

@@ -11,22 +11,22 @@
 
     <%= get('scenarios').result(binding) %>
 
-    <main class="brown lighten-5">
+    <main class="<%= options[:color] %> lighten-5">
       <div class="row">
 
-        <div id="overview" class="col s12 brown lighten-5">
+        <div id="overview" class="col s12 <%= options[:color] %> lighten-5">
           <%= get('overview').result(binding) %>
         </div>
 
-        <div id="features" class="col s12 brown lighten-5 white-text">
+        <div id="features" class="col s12 <%= options[:color] %> lighten-5 white-text">
           <%= get('features').result(binding) %>
         </div>
 
-        <div id="summary" class="col s12 brown lighten-5">
+        <div id="summary" class="col s12 <%= options[:color] %> lighten-5">
           <%= get('summary').result(binding) %>
         </div>
 
-        <div id="errors" class="col s12 brown lighten-5">
+        <div id="errors" class="col s12 <%= options[:color] %> lighten-5">
           <%= get('errors').result(binding) %>
         </div>
       </div>

data/template/summary.erb

@@ -1,4 +1,4 @@
-<table id="summaryTable" class="bordered brown lighten-1 white-text" width="100%">
+<table id="summaryTable" class="bordered <%= options[:color] %> lighten-1 white-text" width="100%">
   <thead>
   <tr>
     <th class="hide-on-small-only">Feature</th>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: report_builder
 version: !ruby/object:Gem::Version
-  version: '1.4'
+  version: '1.5'
 platform: ruby
 authors:
 - Rajat Thareja
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-29 00:00:00.000000000 Z
+date: 2018-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json