rspec-html-formatter 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA512: 
-  data.tar.gz: 0dd65d1010a89ba0f5ebb54f14b40099310af6bf3be752aaa93173675f5e32988c698be05af7e0d49c38140649a44c0d35b07e20295b5ceb1c24c3318fa61f21
-  metadata.gz: d5060bf391258f7f076e66fe1a115904591ce627b10982b5dfe264fe0ebb48d4aa71a517c774630d7975a48a39cd6eaa674da0ce0e4a798dfe7004d5cb59fe5b
-SHA1: 
-  data.tar.gz: ff4abded4f4c8a74dfac637847b09f7b270ef9ae
-  metadata.gz: 8c3d3802576d723af7fb84ab36f96388aec5435c
+---
+SHA1:
+  metadata.gz: 982bf172aa7aeaa7696664ed17e1704f81cbf94b
+  data.tar.gz: 01e2b555f5676e2840a0d2377c2eccd12857efd2
+SHA512:
+  metadata.gz: 2a0cfa23f39c68fb356004edc056581750b29ba67e3c6161174fa13185959702445acef2f75213f765588d69f3806b4cfaf8f52e165bd6995331335f02b28db4
+  data.tar.gz: 18e1c7acbfe7ca13f34cdad6cf2e4d01574f8d956f70f55147f36f3ca3197a9d490b151bca4a25aa4ffe353c7ec547c6a54ef0836ea29291522ea4c78a6f6575

data/README.md

@@ -4,11 +4,18 @@ rspec-html-formator
 Extended html formator for rspec. It create seperate html file for each rspec test script.
 It is useful when you have large number of rspec testcases with different owners.
 
+### install
+`gem install rspec-html-formatter`
+
 ### how to use
 ```
-gem install rspec-html-formatter
-rspec spec/sample_spec.rb -f SplithtmlFormatter -r splithtml_formatter -r splithtml_printer
+export HTML_REPORTS=/tmp/reports
+rspec -f SplithtmlFormatter -r splithtml_formatter -r splithtml_printer spec/sample_spec.rb 
 ```
+The log files will be created into $HTML_REPORTS  
+If it is not set, use "`pwd`/spec/reports"
 
 ### Dependence
-rspec 2.14
+rspec 3 since version 0.0.1
+
+for rspec 2.14, `gem install rspec-html-formatter -v 0.0.0`

data/lib/splithtml_formatter.rb

@@ -1,4 +1,4 @@
-require 'rspec/core/formatters/base_text_formatter'
+require 'rspec/core/formatters/base_formatter'
 
 PREFIX = "spec"
 
@@ -18,10 +18,16 @@ class FileOutput
 
 end
 
-class SplithtmlFormatter < RSpec::Core::Formatters::BaseTextFormatter
-
+class SplithtmlFormatter < RSpec::Core::Formatters::BaseFormatter
+  
+  RSpec::Core::Formatters.register self, :start, :example_group_started, :start_dump,
+                            :example_started, :example_passed, :example_failed,
+                            :example_pending, :dump_summary
+    
+    
     def initialize(output)
         super(output)
+        @failed_examples = []
         @example_group_number = 0
         @example_number = 0
         @failure_number = 0
@@ -70,8 +76,8 @@ public
         super(example_count)
     end
 
-    def example_group_started(example_group)
-        super(example_group)
+    def example_group_started(notification)
+        super
         @start_time = Time.now().to_f()
         @example_number = 0
         @failure_number = 0
@@ -80,40 +86,38 @@ public
         @run_time = 0.0
         @example_group_red = false
         @example_group_number += 1
-        test_file_name = File.basename(example_group.metadata[:example_group][:file_path])
-        @printer = new_html(example_group.description.to_s)
+        test_file_name = File.basename(notification.group.file_path)
+        @printer = new_html(notification.group.description.to_s)
         @printer.print_html_start(test_file_name)
-        @printer.print_example_group_start(example_group.description)
+        @printer.print_example_group_start(notification.group.description)
         @printer.flush()
         debug_print("start:" + @printer.object_id.to_s)
     end
     
-    def example_group_finished(example_group)
-        super(example_group)
+    def example_group_finished(notification)
+        super
         @printer.print_example_group_end()
-        test_file_path = File.expand_path(example_group.metadata[:example_group][:file_path])
+        test_file_path = File.expand_path(notification.group.file_path)
         @end_time = Time.now().to_f()
         @printer.print_summary(false, @run_time, @example_number, @failure_number, @pending_number, test_file_path, @start_time, @end_time)
         @printer.flush()
         debug_print("finished:" + @printer.object_id.to_s)
     end
 
-    def example_started(example)
-        super(example)
+    def example_started(notification)
         @example_number += 1
         @printer.print_example_start()
     end
 
-    def example_passed(example)
+    def example_passed(passed)
         @printer.move_progress(100)
-        @printer.print_example_passed( example.description, example.execution_result[:run_time] )
+        @printer.print_example_passed( passed.example.description, passed.example.execution_result.run_time )
         @printer.flush()
-        @run_time += example.execution_result[:run_time]
+        @run_time += passed.example.execution_result.run_time
     end
     
-    def example_failed(example)
-        super(example)
-
+    def example_failed(failure)
+        @failed_examples << failure.example
         unless @header_red
             @header_red = true
             @printer.make_header_red
@@ -126,43 +130,44 @@ public
 
         @printer.move_progress(100)
 
-        exception = example.metadata[:execution_result][:exception]
+        example = failure.example
+        exception = failure.exception
         exception_details = if exception
         {
           :message => exception.message,
-          :backtrace => format_backtrace(exception.backtrace, example).join("\n")
+          :backtrace => failure.formatted_backtrace.join("\n")
         }
         else
             false
         end
-        
         extra = extra_failure_content(exception)
-
-        @printer.print_example_failed(
-            example.execution_result[:pending_fixed],
-            example.description,
-            example.execution_result[:run_time],
-            @failed_examples.size,
-            exception_details,
-            (extra == "") ? false : extra,
-            true
-        )
-
+        debug_print("extra: #{extra}")
+       @printer.print_example_failed(
+          example.execution_result.pending_fixed,
+          example.description,
+          example.execution_result.run_time,
+          @failed_examples.size,
+          exception_details,
+          (extra == "") ? false : extra,
+          true
+          )
         @printer.flush()
         @failure_number += 1
-        @run_time += example.execution_result[:run_time]
+        @run_time += example.execution_result.run_time
     end
     
-    def example_pending(example)
+    def example_pending(pending)
+       example = pending.example
         @printer.make_header_yellow unless @header_red
         @printer.make_example_group_header_yellow(example_group_number) unless @example_group_red
         @printer.move_progress(100)
-        @printer.print_example_pending( example.description, example.metadata[:execution_result][:pending_message] )
+        @printer.print_example_pending( example.description, example.execution_result.pending_message)
         @printer.flush()
         @pending_number += 1
-        @run_time += example.execution_result[:run_time]
+        @run_time += example.execution_result.run_time
     end
     
+    # support for https://github.com/railsware/rspec-example_steps
     def example_step_started(example, type, message, options)
         example_started(example)
     end
@@ -187,7 +192,7 @@ public
 
         @printer.move_progress(100)
 
-        exception = example.metadata[:execution_result][:exception]
+        exception = example.exception
         exception_details = if exception
         {
           :message => exception.message,
@@ -198,7 +203,7 @@ public
         end
 
         @printer.print_example_failed(
-            example.execution_result[:pending_fixed],
+            example.execution_result.pending_fixed,
             type.to_s().upcase() + ' ' + message,
             0,
             @failed_examples.size,
@@ -220,24 +225,24 @@ public
         @pending_number += 1
     end
    
-    def extra_failure_content(exception)
-        require 'rspec/core/formatters/snippet_extractor'
-        backtrace = exception.backtrace.map {|line| backtrace_line(line)}
-        backtrace.compact!
-        @snippet_extractor ||= RSpec::Core::Formatters::SnippetExtractor.new
-        "    <pre class=\"ruby\"><code>#{@snippet_extractor.snippet(backtrace)}</code></pre>"
+    def extra_failure_content(failure)
+      RSpec::Support.require_rspec_core "formatters/snippet_extractor"
+      backtrace = failure.exception.backtrace.map {|line| RSpec.configuration.backtrace_formatter.backtrace_line(line)}
+      backtrace.compact!
+      @snippet_extractor ||= RSpec::Core::Formatters::SnippetExtractor.new
+      "    <pre class=\"ruby\"><code>#{@snippet_extractor.snippet(backtrace)}</code></pre>"
     end
 
-    def start_dump
-    end
+    #def start_dump
+    #end
     
-    def dump_failures
-    end
+    #def dump_failures
+    #end
 
-    def dump_pending
-    end
+    #def dump_pending
+    #end
 
-    def dump_summary(duration, example_count, failure_count, pending_count)
-    end
+    #def dump_summary(duration, example_count, failure_count, pending_count)
+    #end
     
 end

data/spec/sample_spec.rb

@@ -18,10 +18,12 @@ describe "Two failed cases test" do
 
     it "failed test1" do
         puts "this line from failed test1"
+        0/0
     end
     
     it "failed test2" do
         puts "this line from failed test2"
+        0/0
     end
     
     it "passed test2" do
@@ -72,6 +74,8 @@ describe "Logger test" do
         puts "this line from passed test7"
     end
     
+    it "pending test1"
+    
 end
 
   

metadata

@@ -1,58 +1,51 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rspec-html-formatter
-version: !ruby/object:Gem::Version 
-  version: 0.0.0
+version: !ruby/object:Gem::Version
+  version: 0.0.1
 platform: ruby
-authors: 
+authors:
 - chenhaiq
 - Zhang Yuan
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-09-16 00:00:00 Z
+date: 2014-09-16 00:00:00.000000000 Z
 dependencies: []
-
-description: Extended html formator for rspec. It create seperate html file for each rspec test script.
+description: Extended html formator for rspec. It create seperate html file for each
+  rspec test script.
 email: chocean@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
+files:
+- ".gitignore"
 - LICENSE
 - README.md
 - lib/splithtml_formatter.rb
 - lib/splithtml_printer.rb
 - spec/sample_spec.rb
 homepage: https://github.com/chenhaiq/rspec-html-formatter
-licenses: 
+licenses:
 - MIT
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - &id001 
-    - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id001
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: create seperate html file for each rspec script
 test_files: []
-