report_builder 1.3 → 1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 315748504568c9c1ab74986ef3b436cbe62c836e
-  data.tar.gz: 577abdb1da309254a44f60e629d2c1839b675075
+  metadata.gz: 35b353893ae02902dd4b6c8d07a7f38d66ab57c6
+  data.tar.gz: fab6f1b0dad20645c4e8f7f68d43761da94521c6
 SHA512:
-  metadata.gz: 5b7d081033b5e69b62ed4d811e62d853ef5d8ec1f75ad73707c6715507c2ba618bed13ba15f3067742934103758502ddd08248682a5ced053cd8b8b94997829a
-  data.tar.gz: 70a64740b7df9ba6ee7ca2b373cf25abecab23fc7b645e167dde87bd644ad04d724c95ec276c56e5058dcd98e2da699f87183785aa0198d3f700bcf8a249831d
+  metadata.gz: 4403905db936a5cd577738d24cfd7553f4fa9ab458226d4f0d56d5f4bf8bcbacf31ea14f0a962360a23f68e670c8df9ca548fa6aea124bca4d62fcbba212708c
+  data.tar.gz: 4bb0c1e121f3935bced443fb09903a6a2f6f61893e80497c02424ece1224569af13facb623e371c1f7bc1fdc5a1b654f39aa7fc784e541de9df3acf081b1ca55

data/CHANGELOG.md

@@ -3,7 +3,19 @@ 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.3...master)
+## [Unreleased](https://github.com/rajatthareja/ReportBuilder/compare/v1.4...master)
+
+## [1.4](https://github.com/rajatthareja/ReportBuilder/compare/v1.3...v1.4) - 2017-10-29
+### Fixed
+- Config options Fixed
+- Document Fixed
+
+### Added
+- Grouped Features Report
+- Method to set single option
+
+### Removed
+- Sample Rake Task 
 
 ## [1.3](https://github.com/rajatthareja/ReportBuilder/compare/v1.2...v1.3) - 2017-10-22
 ### Changed

data/README.md

@@ -1,12 +1,17 @@
 # ReportBuilder
 
 [![Gem Version](https://badge.fury.io/rb/report_builder.svg)](https://badge.fury.io/rb/report_builder) 
-[![Build status](https://travis-ci.org/rajatthareja/ReportBuilder.svg?branch=master)](https://travis-ci.org/rajatthareja/ReportBuilder) 
+[![Build status](https://travis-ci.org/rajatthareja/ReportBuilder.svg?branch=master)](https://travis-ci.org/rajatthareja/ReportBuilder)
+[![Windows Build status](https://ci.appveyor.com/api/projects/status/s5jx2ji3wdg294u6/branch/master?svg=true)](https://ci.appveyor.com/project/rajatthareja/reportbuilder)
 [![Join the chat at https://gitter.im/rajatthareja/ReportBuilder](https://badges.gitter.im/rajatthareja/ReportBuilder.svg)](https://gitter.im/rajatthareja/ReportBuilder?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-Ruby gem to merge Cucumber JSON reports and build mobile friendly HTML Test Report, JSON report and retry file.
+Ruby gem to merge Cucumber JSON reports and build mobile-friendly HTML Test Report, JSON report and retry file.
 
-**[View sample report](http://reportbuilder.rajatthareja.com)**
+## Sample Reports
+
+**[Features Report](http://reportbuilder.rajatthareja.com/sample/report.html)**
+
+**[Grouped Features Report](http://reportbuilder.rajatthareja.com/sample/group_report.html)**
 
 ## Installation
 
@@ -27,18 +32,19 @@ gem install report_builder
 
 ### Config Options:
 
-| Option                  | Type               | Default             | Values                                                                                   |
-|-------------------------|--------------------|---------------------|------------------------------------------------------------------------------------------|
-| json_path / input_path  | [String] / [Array] | (current directory) | input json files path / array of json files or path                                      |
-| report_path             | [String]           | 'test_report'       | reports output file path with file name without extension                                |
-| json_report_path        | [String]           | (report_path)       | json report output file path with file name without extension                            |
-| html_report_path        | [String]           | (report_path)       | html report output file path with file name without extension                            |
-| retry_report_path       | [String]           | (report_path)       | retry report output file path with file name without extension                           |
-| 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) |
-| 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       |
+| Option               | Type                    | Default             | Values                                                                                   |
+|----------------------|-------------------------|---------------------|------------------------------------------------------------------------------------------|
+| json_path/input_path | [String]/[Array]/[Hash] | (current directory) | input json files path / array of json files or path / hash of json files or path         |
+| report_path          | [String]                | 'test_report'       | reports output file path with file name without extension                                |
+| json_report_path     | [String]                | (report_path)       | json report output file path with file name without extension                            |
+| html_report_path     | [String]                | (report_path)       | html report output file path with file name without extension                            |
+| retry_report_path    | [String]                | (report_path)       | retry report output file path with file name without extension                           |
+| 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) |
+| 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          |
 
 ### Code Examples:
 
@@ -72,22 +78,39 @@ gem install report_builder
         
 ```
 
+### Grouped Features Report Example:
+
+```ruby
+
+ReportBuilder.configure do |config|
+  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'}
+  end
+
+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               | STRING|PATH|URL | Additional CSS string or CSS file path or CSS 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                                                                       |
+| -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                                                                   |
 
 ### CLI Example:
 
@@ -106,7 +129,13 @@ Add in Rakefile
 ```ruby
 
     require 'report_builder'
-    load 'report_builder.rake'
+    
+    desc 'Sample rake task to build report'
+    task :report_builder, [:json_path, :report_path] do |t, args|
+      args.with_defaults(:json_path => nil, :report_path => 'test_report')
+      options = {:json_path => args.json_path, :report_path => args.report_path}
+      ReportBuilder.build_report options
+    end
 
 ```
 

data/lib/report_builder.rb

@@ -1,8 +1,9 @@
 require_relative 'report_builder/builder'
 
-
+##
+# ReportBuilder Main module
+#
 module ReportBuilder
-  
   ##
   # Configure ReportBuilder
   #
@@ -23,6 +24,21 @@ module ReportBuilder
     builder.options = defaults.marshal_dump
   end
 
+  ##
+  # Set single option
+  #
+  # @param [String] option
+  # @param [Object] value
+  #
+  # Example:
+  #
+  #     ReportBuilder.set_option('include_images', false)
+  #
+  def self.set_option(option, value)
+    builder.options ||= builder.default_options.marshal_dump
+    builder.options[option] = value
+  end
+
   ##
   # Build Report
   #
@@ -48,5 +64,4 @@ module ReportBuilder
   def self.builder
     @builder ||= Builder.new
   end
-
 end

data/lib/report_builder/builder.rb

@@ -2,31 +2,34 @@ require 'json'
 require 'erb'
 require 'pathname'
 require 'base64'
+require 'ostruct'
 
 require 'report_builder/core-ext/hash'
 
 module ReportBuilder
+  ##
+  # ReportBuilder Main class
+  #
   class Builder
 
     attr_accessor :options
 
+    ##
+    # ReportBuilder Main method
+    #
     def build_report(opts = nil)
       options = self.options || default_options.marshal_dump
       options.merge! opts if opts.is_a? Hash
 
-      raise 'Error:: Invalid report_types. Use: [:json, :html]' unless options[:report_types].is_a? Array
-
+      fail 'Error:: Invalid report_types. Use: [:json, :html]' unless options[:report_types].is_a? Array
       options[:report_types].map!(&:to_s).map!(&:upcase)
 
-      options[:json_path] ||= options[:input_path]
-      files = get_files options[:json_path]
-      raise "Error:: No file(s) found at #{options[:json_path]}" if files.empty?
-
-      features = get_features(files) rescue raise('Error:: Invalid Input File(s). Please provide valid cucumber JSON output file(s)')
+      options[:input_path] ||= options[:json_path] || Dir.pwd
+      groups = get_groups options[:input_path]
 
       json_report_path = options[:json_report_path] || options[:report_path]
       File.open(json_report_path + '.json', 'w') do |file|
-        file.write JSON.pretty_generate features
+        file.write JSON.pretty_generate(groups.size > 1 ? groups : groups.first['features'])
       end if options[:report_types].include? 'JSON'
 
       if options[:additional_css] and Pathname.new(options[:additional_css]).file?
@@ -39,33 +42,65 @@ module ReportBuilder
 
       html_report_path = options[:html_report_path] || options[:report_path]
       File.open(html_report_path + '.html', 'w') do |file|
-        file.write ERB.new(File.read(File.dirname(__FILE__) + '/../../template/html_report.erb')).result(binding).gsub('  ', '').gsub("\n\n", '')
+        file.write get(groups.size > 1 ? 'group_report' : 'report').result(binding).gsub('  ', '').gsub("\n\n", '')
       end if options[:report_types].include? 'HTML'
 
       retry_report_path = options[:retry_report_path] || options[:report_path]
       File.open(retry_report_path + '.retry', 'w') do |file|
-        features.each do |feature|
-          if feature['status'] == 'broken'
-            feature['elements'].each {|scenario| file.puts "#{feature['uri']}:#{scenario['line']}" if scenario['status'] == 'failed'}
+        groups.each do |group|
+          group['features'].each do |feature|
+            if feature['status'] == 'broken'
+              feature['elements'].each {|scenario| file.puts "#{feature['uri']}:#{scenario['line']}" if scenario['status'] == 'failed'}
+            end
           end
         end
       end if options[:report_types].include? 'RETRY'
       [json_report_path, html_report_path, retry_report_path]
     end
 
+    ##
+    # ReportBuilder default configuration
+    #
     def default_options
-      OpenStruct.new(
-          json_path: Dir.pwd, # [String] / [Array] Input json file, array of json files/path or json files path, (Default current directory)
-          report_path: 'test_report', # [String] Output file path with name
-          report_types: [:html], # [Array] Output file types to build, [:json, :html] or ['html', 'json']
-          report_title: 'Test Results', # [String] Report and html title
-          include_images: true, # [Boolean] Set false to reducing the size of HTML report, by excluding embedded images
-          additional_info: {} # [Hash] Additional info for report
+      OpenStruct.new(json_path: nil,
+                     input_path: nil,
+                     report_types: [:html],
+                     report_title: 'Test Results',
+                     include_images: true,
+                     additional_info: {},
+                     report_path: 'test_report',
+                     json_report_path: nil,
+                     html_report_path: nil,
+                     retry_report_path: nil,
+                     additional_css: nil,
+                     additional_js: nil
       )
     end
 
     private
 
+    def get(template)
+      @erb ||= {}
+      @erb[template] ||= ERB.new(File.read(File.dirname(__FILE__) + '/../../template/' + template + '.erb'), nil, nil, '_' + template)
+    end
+
+    def get_groups(input_path)
+      groups = []
+      if input_path.is_a? Hash
+        input_path.each do |group_name, group_path|
+          files = get_files group_path
+          puts "Error:: No file(s) found at #{group_path}" if files.empty?
+          groups << {'name' => group_name, 'features' => get_features(files)} rescue next
+        end
+        fail 'Error:: Invalid Input File(s). Please provide valid cucumber JSON output file(s)' if groups.empty?
+      else
+        files = get_files input_path
+        fail "Error:: No file(s) found at #{input_path}" if files.empty?
+        groups << {'features' => get_features(files)} rescue fail('Error:: Invalid Input File(s). Please provide valid cucumber JSON output file(s)')
+      end
+      groups
+    end
+
     def get_files(path)
       if path.is_a?(String) and Pathname.new(path).exist?
         if Pathname.new(path).directory?

data/report_builder.gemspec

@@ -1,18 +1,18 @@
 Gem::Specification.new do |s|
   s.name        = 'report_builder'
-  s.version     = '1.3'
+  s.version     = '1.4'
   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.'
+  s.description = 'Ruby gem to merge Cucumber JSON reports and build mobile-friendly HTML Test Report, JSON report and retry file.'
   s.post_install_message = 'Happy reporting!'
   s.authors     = ['Rajat Thareja']
   s.email       = 'rajat.thareja.1990@gmail.com'
-  s.homepage    = 'https://github.com/rajatthareja/ReportBuilder'
+  s.homepage    = 'http://reportbuilder.rajatthareja.com'
   s.license     = 'MIT'
   s.required_ruby_version = '>= 1.9.1'
   s.requirements << 'Cucumber >= 2.1.0 test results in JSON format'
 
-  s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(docs|css|js|pkg|testing|coverage)/}) }
+  s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(sample/|css/|js/|pkg/|testing/|coverage/|CNAME|.gitignore|appveyor.yml|.travis.yml|_config.yml|Gemfile|Rakefile|rb.ico)}) }
   s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files  = s.files.grep(%r{^(testing)/})
 

data/template/error.erb

@@ -0,0 +1,21 @@
+<li class="error">
+  <div class="collapsible-header red lighten-2 white-text waves-effect waves-light">
+    <i class="material-icons">bug_report</i><%= error %>
+  </div>
+
+  <div class="collapsible-body brown 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">
+                        <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 %>
+              <% end %>
+          <% end %>
+      <% end %>
+    </ul>
+  </div>
+</li>

data/template/errors.erb

@@ -0,0 +1,5 @@
+<ul class="errorList collapsible popout" data-collapsible="expandable">
+  <% errors.uniq.each do |error| %>
+      <%= get('error').result(binding) %>
+  <% end %>
+</ul>

data/template/feature.erb

@@ -0,0 +1,18 @@
+<li class="feature <%= feature['status'] %>">
+  <div class="collapsible-header brown 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">
+    <ul class="collection scenarioList">
+      <% feature['elements'].each_with_index do |scenario, s| %>
+          <li class="collection-item scenario <%= scenario['status'] %>">
+            <a class="waves-effect waves-light modal-trigger white-text" href="#<%= "#{fid}s#{s}" %>">
+              <b><%= scenario['keyword'] %></b> <%= scenario['name'] %>&nbsp;(<%= duration(scenario['duration']) %>)
+            </a>
+          </li>
+      <% end %>
+    </ul>
+  </div>
+</li>

data/template/features.erb

@@ -0,0 +1,6 @@
+<ul class="featureList collapsible popout" data-collapsible="expandable">
+  <% features.each_with_index do |feature, f| %>
+      <% fid = "#{gid}f#{f}" %>
+      <%= get('feature').result(binding) %>
+  <% end %>
+</ul>

data/template/footer.erb

@@ -0,0 +1,20 @@
+<footer class="page-footer brown lighten-4">
+  <div class="footer-copyright brown 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>
+    </div>
+  </div>
+</footer>
+
+<script type="text/javascript" src="https://cdn.rawgit.com/rajatthareja/ReportBuilder/v1.4/js/report.builder.min.js"></script>
+
+<% if options[:additional_js] %>
+    <% if options[:additional_js] =~ /^http(|s):\/\/.*\.js$/ %>
+        <script src="<%= options[:additional_js] %>"></script>
+    <% else %>
+        <script type="text/javascript">
+            <%= options[:additional_js]%>
+        </script>
+    <% end %>
+<% end %>

data/template/group_errors.erb

@@ -0,0 +1,18 @@
+<ul class="groupErrorList collapsible popout" data-collapsible="expandable">
+  <% groups.each_with_index do |group, g| %>
+
+      <% gid = "g#{g}" %>
+      <% features = group['features'] %>
+      <li class="groupError">
+
+          <div class="collapsible-header red lighten-2 white-text waves-effect waves-light">
+            <i class="material-icons">group_work</i>
+            <b><%= group['name'] %></b>
+          </div>
+
+          <div class="collapsible-body brown lighten-4">
+            <%= get('errors').result(binding) %>
+          </div>
+      </li>
+  <% end %>
+</ul>

data/template/group_features.erb

@@ -0,0 +1,18 @@
+<ul class="groupList collapsible popout" data-collapsible="expandable">
+  <% groups.each_with_index do |group, g| %>
+
+      <% gid = "g#{g}" %>
+      <% features = group['features'] %>
+      <li class="group">
+
+        <div class="collapsible-header brown 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">
+          <%= get('features').result(binding) %>
+        </div>
+      </li>
+  <% end %>
+</ul>