report_builder 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 439b62180acf73c92267c2a1a5e809bfd61c87dd
-  data.tar.gz: 155460bace35f871495b0c706c24aa3958e1b7d2
+  metadata.gz: 7462223d91a07ad530b28508a61e2ba209c57941
+  data.tar.gz: 3cbc4727d0ebd816d1317796f5982bf11dcf2abc
 SHA512:
-  metadata.gz: 13c615c0e3f1bf53c782509709719c5fe49abd62f40d9f7d2bee2ea626933f7d17a6349137877fe7d54623128e9082f559a68182347cc91f9a02b1aff0d3001b
-  data.tar.gz: ea4684e09984b4e91bd954e2fac867902b67d5b752b59e706644687dac12565cf454aca84e13f0cbed88deaa9a6e08759ceb7b1f29394c133c657440ffc80a73
+  metadata.gz: 041ab958382106fb7376ff0b935004f3c6de93b36363c437d0daf7bf46aeeac19720f60a21542674705d3bb8996e5c8107f7ce846b734f4edca1fb6caca3b0a5
+  data.tar.gz: d68885802c905240b93527115ddec3b8ad448a485b5e9d21c3fea6aa0dce9943c0763333b4eb3b4e085dc57429138e7c97b5366a02b04b868b3e5af961bdecd6

data/README.md

@@ -19,6 +19,16 @@ gem install report_builder
 
 **Note:** Works with cucumber(>= 2.1.0) test results in JSON format.
 
+### Config Options:
+
+| Option | Type | Default | Values |
+|--------|------|---------|--------|
+| json_path | [String] / [Array] | (current directory) | json files path / array of json files or path |
+| report_path | [String] | 'test_report' | output file path with file name without extension |
+| report_types | [Array] | [:html] | :json, :html (output file types) |
+| report_tabs | [Array] | [:overview, :features] | :overview, :features, :scenarios, :errors (tabs to build) |
+| compress_images | [Boolean] | false | true / false (If true, the size of HTML report is reduced but takes more time to build report) |
+
 ### Code Examples:
 
 ```ruby
@@ -49,46 +59,24 @@ gem install report_builder
         
 ```
 
-### Config Options:
-
-* json_path:
-
-    Default: nil (current directory)
-    
-    [String] / [Array] Input json file, array of json files/path or json files path
-
-* report_path:     
-  
-  Default: 'test_report'
-
-  [String] Output file path with name
-
-* report_types:    
-    
-    Default: [:html]
-
-    [Array] Output file types to build, [:json, :html] or ['html', 'json']
-
-* report_tabs:     
-
-    Default: [:overview, :features, :errors]
-
-    [Array] Tabs to build, [:overview, :features, :scenarios, :errors] or ['overview', 'features', 'scenarios', 'errors']
-    
-* compress_images 
-
-   Default: false
-   
-   [Boolean] Set true to reducing the size of HTML report, Note: If true, takes more time to build report
-    
+### CLI Options:
 
+| Option         | Values     | Explanation                                              |
+|----------------|------------|----------------------------------------------------------|
+| -s, --source   | x,y,z      | List of json path or files                               |
+| -o, --out      | [PATH]NAME | Report path with name without extension                  |
+| -f, --format   | x,y,z      | List of report format - html,json                        |
+| -t, --tabs     | x,y,z      | List of report tabs - overview,features,scenarios,errors |
+| -c, --compress |            | Reduce report size if embedding images                   |
+| -h, --help     |            | Show available command line switches                     |
+| -v, --version  |            | Show gem version                                         |
 
-### Command Example:
+### CLI Example:
 
 ```bash
      report_builder
-     report_builder 'path/of/json/files/dir'
-     report_builder 'path/of/json/files/dir' 'report_file'
+     report_builder -s 'path/of/json/files/dir'
+     report_builder -s 'path/of/json/files/dir' -o 'report_file'
 ```
 
 ### Rake Example:
@@ -102,17 +90,18 @@ Then run rake task report_builder
 
 ```bash
    rake report_builder
-   rake report_builder ['path/of/json/files/dir']
-   rake report_builder ['path/of/json/files/dir','report_file']
+   rake report_builder['path/of/json/files/dir']
+   rake report_builder['path/of/json/files/dir','report_file']
 ```
 
 ## Contributing
 
- We're open to any contribution. It has to be tested properly though.
+We're open to any contribution. It has to be tested properly though.
 
 ## Maintainer
 
-[Rajat Thareja](http://www.rajatthareja.com)
+* [Rajat Thareja](http://www.rajatthareja.com)
+* [Justin Commu](https://github.com/tk8817)
 
 ## License
 

data/bin/report_builder

@@ -1,12 +1,47 @@
 #!/usr/bin/env ruby
 
+require 'optparse'
 require 'report_builder'
 
-ARGV[1] ||= 'test_report'
-ARGV[2] ||= [:html]
-ARGV[3] ||= [:overview, :features, :errors]
-ARGV[4] ||= false
+options = {:json_path => nil, :report_path => 'test_report', :report_types => [:html], :report_tabs => [:overview, :features], :compress_images => false}
 
-options = {:json_path => ARGV[0], :report_path => ARGV[1], :report_types => ARGV[2], :report_tabs => ARGV[3], :compress_images => ARGV[4]}
+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|
+    options[:json_path] = list
+  end
+
+  opts.on('-o', '--out [PATH]NAME', String, 'Report path with name without extension') do |report_path|
+    options[:report_path] = report_path
+  end
+
+  opts.on('-f','--format x,y,z', Array, 'List of report format - html,json') do |list|
+    options[:report_types] = list
+  end
+
+  opts.on('-t','--tabs x,y,z', Array, 'List of report tabs - overview,features,scenarios,errors') do |list|
+    options[:report_tabs] = list
+  end
+
+  opts.on('-c', '--compress', 'Reduce report size if embedding images') do |compress|
+    options[:compress_images] = compress
+  end
+
+  opts.separator 'Common options:'
+
+  opts.on_tail('-h', '--help', 'Show help') do
+    puts opts
+    exit
+  end
+
+  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
+end
+
+opt_parser.parse!(ARGV)
 
 ReportBuilder.build_report options

data/lib/report_builder.rake

@@ -1,6 +1,6 @@
 desc 'Rake task to build report'
 task :report_builder, [:json_path, :report_path, :report_types, :report_tabs, :compress_images] do |t, args|
-  args.with_defaults(:json_path => nil, :report_path => 'test_report', :report_types => [:html], :report_tabs => [:overview, :features, :errors], :compress_images => false)
+  args.with_defaults(:json_path => nil, :report_path => 'test_report', :report_types => [:html], :report_tabs => [:overview, :features], :compress_images => false)
   options = {:json_path => args.json_path, :report_path => args.report_path, :report_types => args.report_types, :report_tabs => args.report_tabs, :compress_images => args.compress_images}
   ReportBuilder.build_report options
 end

data/lib/report_builder.rb

@@ -54,14 +54,14 @@ class ReportBuilder
   #
   def self.configure
     default_options = OpenStruct.new(
-        json_path:       nil,                             # [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_tabs:     [:overview, :features, :errors], # [Array] Tabs to build, [:overview, :features, :scenarios, :errors] or ['overview', 'features', 'scenarios', 'errors']
-        compress_images: false                            # [Boolean] Set true to reducing the size of HTML report, Note: If true, takes more time to build report
+        json_path:       nil,                    # [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_tabs:     [:overview, :features], # [Array] Tabs to build, [:overview, :features, :scenarios, :errors] or ['overview', 'features', 'scenarios', 'errors']
+        compress_images: false                   # [Boolean] Set true to reducing the size of HTML report, Note: If true, takes more time to build report
     )
     yield default_options if block_given?
-    @options = default_options.to_h
+    @options = default_options.marshal_dump
   end
 
   #
@@ -161,9 +161,9 @@ class ReportBuilder
         build_menu @options[:report_tabs]
 
         @builder.div(:id => 'overviewTab') do
-          @builder << "<div id='featurePieChart'></div>"
-          @builder << "<div id='scenarioPieChart'></div>"
-          @builder << "<div id='stepPieChart'></div>"
+          @builder << "<div id='featurePieChart' style=\"float:left;width:33%\"></div>"
+          @builder << "<div id='scenarioPieChart' style=\"display:inline-block;width:33%\"></div>"
+          @builder << "<div id='stepPieChart' style=\"float:right;width:33%\"></div>"
         end if @options[:report_tabs].include? 'overview'
 
         @builder.div(:id => 'featuresTab') do
@@ -483,6 +483,14 @@ class ReportBuilder
     }.values.each_with_object([]) { |group, features|
       features << group.first.except('elements').merge('elements' => group.map{|feature| feature['elements']}.flatten)
     }.each{|feature|
+      if feature['elements'][0]['type'] == 'background'
+        (0..feature['elements'].size-1).step(2) do |i|
+          feature['elements'][i]['steps'].each{|step| step['name']+=(' ('+feature['elements'][i]['keyword']+')')}
+          feature['elements'][i+1]['steps'] = feature['elements'][i]['steps'] + feature['elements'][i+1]['steps']
+          feature['elements'][i+1]['before'] = feature['elements'][i]['before'] if feature['elements'][i]['before']
+        end
+        feature['elements'].reject!{|element| element['type'] == 'background'}
+      end
       feature['elements'].each { |scenario|
         scenario['before'] ||= []
         scenario['before'].each { |before|
@@ -622,4 +630,4 @@ class ReportBuilder
                        :build_error_list, :build_step_error,
                        :build_hook_error, :build_step_hook_error,
                        :build_unique_image, :build_image
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: report_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Rajat Thareja
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-23 00:00:00.000000000 Z
+date: 2016-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -70,7 +70,7 @@ homepage: https://github.com/rajatthareja/ReportBuilder
 licenses:
 - MIT
 metadata: {}
-post_install_message: 'Thanks for installing! Note: Refactored please refer Documentation.'
+post_install_message: Thanks for installing!
 rdoc_options: []
 require_paths:
 - lib
@@ -78,7 +78,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -87,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Cucumber >= 2.1.0 test results in JSON format
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: ReportBuilder