cuporter 0.3.2 → 0.3.3

data/README.textile

@@ -1,40 +1,73 @@
 h1. Cuporter
 
-Scrapes your feature files and shows 2 possible reports:
+h3. A Cucumber Reporter
 
-# Tag Report: scenarios and examples per tag
-** in Feature and Scenario Outline context, as appropriate
-** sorted alphbetically by file path, scenario name, scenario outline name, example name
-** optionally numbered*, counting scenarios and outline examples per tag
-# Inventory Report: feature, scenario and example names
-** may be filtered by tags, using same CLI syntax as Cucumber
-** sorted alphbetically by file path, scenario name, scenario outline name, example name
-** optionally numbered*, using 1 count of all scenarios and outline examples for the report
+Scrapes your feature files to show test counts and tag relationships.
 
-<notextile>*</notextile> _HTML reports are always numbered._
+h3. 3 Views
 
-Either report may be formatted in HTML, CSV, or Pretty Text.
+# Tag Report
+** Tags listed with all features and scenarios associated with them
+** Each scenario shows all of its tags, for simple cross referencing
+# Feature Report
+** Simple list of all Cucumber features, sorted by name and file name.
+** Collapsable scenario and scenario outline breakdowns
+** Totals, subtotals, scenario numbering
+# Tree Report
+** Expandy-collapsy jquery.treeview of your @features/**@ dir
+** Same feature data as above
+** Subtotals on folders
 
-* HTML reports do jQuery expand-collapse, with acklowedgment due to the Cucumber HTML formatter.
+h3. 4 Output Formats
 
-Consider this a stop-gap until we get this functionality in a proper cucumber formatter.
+# html
+# xml
+# pretty-print text
+# csv
+
+h3. A bunch of configuration options
+
+See the help output below.
 
 ---------
-h3. Example Tag Report Output: numbered pretty text
+
+h3. Example Tag Report Ouput
+
+
+h4. xml of single test
+
+<notextile>
+<pre>
+&lt;?xml version="1.0" encoding="UTF-8"?&gt;
+&lt;xml&gt;
+  &lt;body&gt;
+    &lt;report view="tag" title="Cucumber Tags" total="1"&gt;
+      &lt;tag cuke_name="@just_me" total="1"&gt;
+        &lt;feature cuke_name="Feature: Pretty print report on 3 features" file_path="features/pretty_print.feature" total="1"&gt;
+          &lt;scenario cuke_name="Scenario: Tag report on everything in fixtures/self_test" tags="@just_me" number="1"/&gt;
+        &lt;/feature&gt;
+      &lt;/tag&gt;
+    &lt;/report&gt;
+  &lt;/body&gt;
+&lt;/xml&gt;
+</pre>
+</notextile>
+
+h4. numbered pretty text
 
 <pre>
 @failing
-   Feature: Abominable Aardvark
+   Feature: Abominable Aardvark            @failing, @zoology
    1. Scenario: An Aardvark eats ants
    2. Scenario: Zee Zebra eats zee aardvark
-   Feature: Wired
-   3. Scenario: Everybody's Wired
+   Feature: Wired                          
+   3. Scenario: Everybody's Wired          @failing
       Scenario Outline: Why is everybody so wired?
          Examples: loosely wired
             | arg1 | arg2 |
    4.       | foo  | bar  |
    5.       | shif | fish |
-         Examples: tightly wired
+         Examples: tightly wired           @ignore
             | arg1  | arg2  |
    6.       | foo   | bar   |
    7.       | frotz | knurl |
@@ -66,6 +99,9 @@ h3. Install
   $ gem install cuporter
 </pre>
 
+Once installed, you can run @$ cuporter@ anywhere on your system.  In any project dir, it will read your @features/**@ by default.
+If you clone the repo, you can run @$ ./bin/cuporter@ from within it.
+
 ---------
 
 h3. Command Lines
@@ -73,45 +109,88 @@ h3. Command Lines
 h4. help
 
 <pre>
-  $ ./bin/cuporter -h
+  $ cuporter -h
 
   Usage: cuporter [options]
+  
+      -r, --report [tag|feature|tree]  View, or type of report.
+                                           Default: "tag"
+            
+      -f, --format [xml|html|csv|text] Output format.
+                                           Default: text (it's pretty, though!)
+            
+      -i, --input-dir DIR              Root directory of *.feature files.
+                                           Default: "features"
+       
+                                           Used to build the glob pattern '[--in]/**/*.feature', which is really most likely
+                                           "features/**/*.features" and finds all feature files anywhere under "features" or
+                                           your custom root supplied with this option.
+                                           Overridden by "--file-input'.
+            
+      -I, --file-input FILE            Single *.feature file.  Full name with extension, like 'path/to/file.feature.'
+                                           Overrides "--input-dir" and used mostly for testing.
+            
+      -o, --output-file FILE           Output file path, like 'tmp/cucumber/tag_report.html'.
+            
+      -t, --tags TAG_EXPRESSION        Filter on tags for name report.
+                                           TAG_EXPRESSION rules:
+                                               1. $ cucumber --help
+                                               2. http://github.com/aslakhellesoy/cucumber/wiki/Tags
+            
+      -T, --title STRING               Override report default title, which is different for each view/report.
+                                           This affects the xml 'report' node title and the html head > title attributes.
+            
+  Reporting options: on by default but can be turned off:
+  
+          --no-sort                    Do not sort tags, features, scenarios, or outlines
+          --no-number                  Do not get or show scenario or example numbers, (i.e., do not number the leaf nodes).
+          --no-total                   Do not get or show totals
+          --no-show-tags               Do not show cucumber tags at the feature, scenario, or outline level.
+          --no-show-files              Do not show feature file paths.
+          --no-leaves                  Show features only, with no scenarios or outlines.
+  
 
-      -i, --in DIR                     directory of *.feature files
-    					Default: features/**/*.feature
+</pre>
 
-      -I, --input-file FILE            full file name with extension: 'path/to/file.feature'
+h4. Examples
 
-      -o, --out FILE                   Output file path
+<pre>
+  #  pretty-print demo report to stdout
+  $ ./bin/cuporter -i fixtures/self_test
 
-      -f, --format [pretty|html|csv]   Output format
-					Default: pretty text
+  #  same, XML to console
+  $ ./bin/cuporter -i fixtures/self_test -f xml
 
-      -n, --numbers                    number scenarios and examples
+  #  List View: html without totals, xml without leaves (scenarios and examples)
+  $ cuporter -i fixtures/ -r feature -f html --no-total  > redirecting_is_ok_too.html
+  $ cuporter -i fixtures/ -r feature -f xml -o fixtures_demo.xml --no-leaves
 
-      -t, --tags TAG_EXPRESSION        Filter on tags for name report.
-  					TAG_EXPRESSION rules: see '$ cucumber --help' and http://github.com/aslakhellesoy/cucumber/wiki/Tags
+  #  Tree View of default input features/**/*.feature to 
+  $ cuporter -f html -r tree -o feature_tree_view.html
 
-      -r, --report [tag|name]          type of report
-					Default: tag
+  #  filtered html feature report, with non-default title
+  $ cuporter -f html -o active_customer.html -r feature -T "Active Customer Test Inventory" -t ~@wip -t @customer,@client
+</pre>
 
-      -T, --title STRING               title of name report
-					Default: 'Cucumber Scenario Inventory'
+----
 
-</pre>
+h3. Dependencies
 
-h4. run script directly
+# Nokogiri 1.4.4 or above
+** For all things Nodular: XML document building and XSL transformation into HTML
+** Not tested on earlier versions yet but I'd guess you'll be fine with anything recent.
+** @libxml2@ and @libxslt@ are required by this gem, which *should* handle them smoothly.  However, @libxml@ and cousins
+can at times present installation difficulties in the form of clashes with already-installed C resources.  It has to do with very specific
+lib versioning and installation order issues.  It's not always the same problem,
+so there's no prescription for it but Google, unfortunately.
+# jQuery and jQueryTreeview
+** packaged with the gem
+** jquery.treeview relies on image files, so our tree view requires the HTML to link to its resources rather than copying them to the &lt;head&gt;.
 
-<pre>
-  #  pretty-print demo report to stdout
-  $ ./bin/cuporter -i fixtures/self_text
+h3. Acknowledgements
 
-  #  same, but number the scenarios and example rows
-  $ ./bin/cuporter -i fixtures/self_text -n
+* Acknowledgements remain due to the Cucumber HTML formatter, and to the human one, too!.
+* Thanks to everyone involved in Nokogiri, jQuery and the Treeview plugin.
 
-  #  default input features/**/*.feature to named html output file
-  $ ./bin/cuporter -f html -o feature_tag_report.html
+  I used to _"Consider this a stop-gap until we get this functionality in a proper cucumber formatter"_, but now I'm not so sure.  Megalomania?
 
-  #  filtered html name report, with non-default title
-  $ ./bin/cuporter -f html -o active_customer.html -r name -T "Active Customer Test Inventory" -t ~@wip -t @customer,@client
-</pre>

data/Rakefile

@@ -27,13 +27,13 @@ namespace :cuporter do
     desc "unit specs"
     RSpec::Core::RakeTask.new(:unit) do |t|
       t.pattern = "spec/cuporter/*_spec.rb"
-      t.spec_opts = ["--color" , "--format" , "doc" ]
+      t.rspec_opts = ["--color" , "--format" , "doc" ]
     end
 
     desc "functional specs against feature fixtures"
     RSpec::Core::RakeTask.new(:functional) do |t|
       t.pattern = "spec/cuporter/functional/**/*_spec.rb"
-      t.spec_opts = ["--color" , "--format" , "doc" ]
+      t.rspec_opts = ["--color" , "--format" , "doc" ]
     end
 
     desc "cucumber features"
@@ -56,7 +56,7 @@ namespace :cuporter do
 
   spec = Gem::Specification.new do |s|
     s.name = 'cuporter'
-    s.version = '0.3.2'
+    s.version = '0.3.3'
     s.rubyforge_project = s.name
 
     s.platform = Gem::Platform::RUBY
@@ -69,12 +69,12 @@ namespace :cuporter do
     s.email = 'twcamper@thoughtworks.com'
     s.homepage = 'http://github.com/twcamper/cuporter'
     s.required_ruby_version = '>= 1.8.7'
-    s.add_dependency('builder', '>= 2.1.2')
+    s.add_dependency('nokogiri', '>= 1.4.4')
     s.default_executable = "cuporter"
     s.executables = [s.default_executable]
 
     s.files =  %w(LICENSE README.textile Rakefile) + 
-      FileList["lib/**/*.{rb,css,js}", "bin/*"].to_a
+      FileList["lib/**/*.{rb,xslt}", "bin/*", "public/**/*.{css,js,gif}"].to_a
 
     s.require_path = "lib"
   end

data/bin/cuporter

@@ -1,17 +1,25 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../lib', File.dirname(__FILE__))
 require 'cuporter'
 
-filter_args = Cuporter::CLI::FilterArgsBuilder.new(Cuporter::CLI::Options[:tags]).args
 
-report = Cuporter::Report.create(Cuporter::CLI::Options[:report], 
-                                 Cuporter::CLI::Options[:input_file] || Cuporter::CLI::Options[:input_dir],
-                                 filter_args,
-                                 Cuporter::CLI::Options[:title])
+report = Cuporter::ReportBase.create(Cuporter.options).build
 
-formatter = Cuporter::Formatter::Writer.create(Cuporter::CLI::Options[:format],
-                                               report,
-                                               Cuporter::CLI::Options[:output],
-                                               Cuporter::CLI::Options[:numbers])
-formatter.write
+(Cuporter.output_file || STDOUT).puts case Cuporter.options[:format]
+when 'xml'
+  report.doc.to_xml(:indent => 2, :encoding => 'UTF-8')
+when 'csv'
+  report.doc.to_csv
+when 'text', 'pretty'
+  report.doc.to_text
+when 'html'
+  html = Cuporter::Document.new_html(Cuporter.options[:report])
+  formatters = File.expand_path("../lib/cuporter/formatters", File.dirname(__FILE__))
+  xslt = Nokogiri::XSLT(File.read("#{formatters}/xml_to_html.xslt"))
+  html.add_report(xslt.transform(report.doc).at('.report'))
+  html.to_html
+end
+
+__END__
+xsltproc --stringparam view feature lib/cuporter/formatters/xml_to_html.xslt new_feature.xml | ruby -e "f = STDIN.read; puts f.gsub(/\<\!--[\*\/]{2}--\>/, '')" | tee xslt_feature.html

data/lib/cuporter.rb

@@ -1,31 +1,20 @@
 # Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
-require 'cuporter/node'
-require 'cuporter/filter'
-require 'cuporter/tag_list_node'
-require 'cuporter/example_set_node'
-require 'cuporter/node_numberer'
-require 'cuporter/feature_parser'
-require 'cuporter/tag_list_parser'
-require 'cuporter/name_list_parser'
+$LOAD_PATH.unshift( File.expand_path("#{File.dirname(__FILE__)}"))
+$LOAD_PATH.unshift( File.expand_path("#{File.dirname(__FILE__)}/.."))
+require 'cuporter/extensions/nokogiri'
 require 'cuporter/extensions/string'
 require 'cuporter/cli/options'
 require 'cuporter/cli/filter_args_builder'
-require 'cuporter/report/report'
+require 'cuporter/node'
+require 'cuporter/formatters/text'
+require 'cuporter/formatters/csv'
+require 'cuporter/filter'
+require 'cuporter/feature_parser'
+require 'cuporter/tag_nodes_parser'
+require 'cuporter/node_parser'
+require 'cuporter/document'
+require 'cuporter/document/html_document'
+require 'cuporter/report/report_base'
 require 'cuporter/report/tag_report'
-require 'cuporter/report/name_report'
-require 'cuporter/formatter/writer'
-require 'cuporter/formatter/text_methods'
-require 'cuporter/formatter/pretty_text_methods'
-require 'cuporter/formatter/csv_text_methods'
-require 'cuporter/formatter/html_node_writer'
-require 'cuporter/formatter/html_methods'
-require 'cuporter/formatter/tag_report/html'
-require 'cuporter/formatter/tag_report/html_node_writer'
-require 'cuporter/formatter/tag_report/text_node_writer'
-require 'cuporter/formatter/tag_report/text'
-require 'cuporter/formatter/tag_report/csv'
-require 'cuporter/formatter/name_report/html'
-require 'cuporter/formatter/name_report/html_node_writer'
-require 'cuporter/formatter/name_report/text_node_writer'
-require 'cuporter/formatter/name_report/text'
-require 'cuporter/formatter/name_report/csv'
+require 'cuporter/report/tree_report'
+require 'cuporter/report/feature_report'

data/lib/cuporter/cli/options.rb

@@ -4,6 +4,7 @@ require 'fileutils'
 
 module Cuporter
   module CLI
+
     class Options
 
       def self.[](key)
@@ -11,59 +12,131 @@ module Cuporter
       end
 
       def self.options
-        self.parse unless @options
+        unless @options
+          self.parse 
+          @options[:input_file_pattern] = @options.delete(:input_file) || "#{@options.delete(:input_dir)}/**/*.feature"
+          @options[:root_dir] = @options[:input_file_pattern].split(File::SEPARATOR).first
+          @options[:filter_args] = Cuporter::CLI::FilterArgsBuilder.new(@options.delete(:tags)).args
+        end
         @options
       end
 
+      def self.args
+        @@args
+      end
+
       def self.parse
+        @@args = ARGV.dup
         @options = {}
         OptionParser.new(ARGV.dup) do |opts|
           opts.banner = "Usage: cuporter [options]\n\n"
 
-          @options[:input_dir] = "features/**/*.feature"
-          opts.on("-i", "--in DIR", "directory of *.feature files\n\t\t\t\t\tDefault: features/**/*.feature\n\n") do |i|
-            @options[:input_dir] = "#{i}/**/*.feature"
+          @options[:report] = "tag"
+          opts.on("-r", "--report [tag|feature|tree]", %Q{View, or type of report.
+                                         Default: "tag"
+          }) do |r|
+            @options[:report] = (r == 'name' ? 'feature' : r) 
           end
 
-          opts.on("-I", "--input-file FILE", "full file name with extension: 'path/to/file.feature'\n\n") do |file|
+          @options[:format] = "text"
+          opts.on("-f", "--format [xml|html|csv|text]", %Q{Output format.
+                                         Default: text (it's pretty, though!)
+          }) do |f|
+            @options[:format] = f
+          end
+
+          @options[:input_dir] = "features"
+          opts.on("-i", "--input-dir DIR", %Q{Root directory of *.feature files.
+                                         Default: "features"
+     
+                                         Used to build the glob pattern '[--in]/**/*.feature', which is really most likely
+                                         "features/**/*.features" and finds all feature files anywhere under "features" or
+                                         your custom root supplied with this option.
+                                         Overridden by "--file-input'.
+          }) do |i|
+            @options[:input_dir] = i.sub(/#{File::SEPARATOR}$/,'')
+          end
+
+          opts.on("-I", "--file-input FILE", %Q{Single *.feature file.  Full name with extension, like 'path/to/file.feature.'
+                                         Overrides "--input-dir" and used mostly for testing.
+          }) do |file|
             @options[:input_file] = file
           end
-          opts.on("-o", "--out FILE", "Output file path\n\n") do |o|
+          
+          @options[:output_file]
+          opts.on("-o", "--output-file FILE", %Q{Output file path, like 'tmp/cucumber/tag_report.html'.
+          }) do |o|
             full_path = File.expand_path(o)
             path = full_path.split(File::SEPARATOR)
             file = path.pop
             FileUtils.makedirs(path.join(File::SEPARATOR))
+            
+            @options[:output_file] = full_path
+          end
 
-            @options[:output] = full_path
+          @options[:tags] = []
+          opts.on("-t", "--tags TAG_EXPRESSION", %Q{Filter on tags for name report.
+                                         TAG_EXPRESSION rules:
+                                             1. $ cucumber --help
+                                             2. http://github.com/aslakhellesoy/cucumber/wiki/Tags
+          }) do |t|
+            @options[:tags] << t
           end
-          @options[:format] = "text"
-          opts.on("-f", "--format [pretty|html|csv]", "Output format\n\t\t\t\t\tDefault: pretty text\n\n") do |f|
-            @options[:format] = f
+
+          opts.on("-T", "--title STRING", %Q{Override report default title, which is different for each view/report.
+                                         This affects the xml 'report' node title and the html head > title attributes.
+          }) do |title|
+            @options[:title] = title
           end
 
-          opts.on("-n", "--numbers", "number scenarios and examples\n\n") do |n|
-            @options[:numbers] = n
+          opts.separator "Reporting options: on by default but can be turned off:\n\n"
+          @options[:sort] = true
+          opts.on("--no-sort", "Do not sort tags, features, scenarios, or outlines\n") do |n|
+            @options[:sort] = n
           end
 
-          @options[:tags] = []
-          opts.on("-t", "--tags TAG_EXPRESSION", "Filter on tags for name report.\n\t\t\t\t\tTAG_EXPRESSION rules: see '$ cucumber --help' and http://github.com/aslakhellesoy/cucumber/wiki/Tags\n\n") do |t|
-            @options[:tags] << t
+          @options[:number] = true
+          opts.on("--no-number", "Do not get or show scenario or example numbers, (i.e., do not number the leaf nodes).\n") do |n|
+            @options[:number] = n
           end
 
-          @options[:report] = "tag"
-          opts.on("-r", "--report [tag|name]", "type of report\n\t\t\t\t\tDefault: tag\n\n") do |r|
-            @options[:report] = r
+          @options[:total] = true
+          opts.on("--no-total", "Do not get or show totals\n") do |n|
+            @options[:total] = n
           end
 
-          @options[:title] = "Cucumber Scenario Inventory"
-          opts.on("-T", "--title STRING", "title of name report\n\t\t\t\t\tDefault: 'Cucumber Scenario Inventory'\n\n") do |title|
-            @options[:title] = title
+          @options[:show_tags] = true
+          opts.on("--no-show-tags", "Do not show cucumber tags at the feature, scenario, or outline level.\n") do |show_tags|
+            @options[:show_tags] = show_tags
           end
 
-        end.parse!
+          @options[:show_files] = true
+          opts.on("--no-show-files", "Do not show feature file paths.\n") do |show_files|
+            @options[:show_files] = show_files
+          end
+
+          @options[:leaves] = true
+          opts.on("--no-leaves", "Show features only, with no scenarios or outlines.\n\n\n") do |l|
+            @options[:leaves] = l
+          end
 
+        end.parse!
 
       end
     end
   end
+
+  def self.html?
+    CLI::Options[:format] == 'html'
+  end
+
+  def self.options
+    CLI::Options.options
+  end
+
+  def self.output_file
+    if options[:output_file]
+      File.open(options[:output_file], "w")
+    end
+  end
 end