cuporter 0.3.9 → 0.3.10

data/README.textile

@@ -25,9 +25,25 @@ h3. 4 Output Formats
 # pretty-print text
 # csv
 
+Splitting the output among multiple formats is supported, so you could run a single report and write it 
+to an html file, a csv file, and show the xml or text on @stdout@ in the terminal.
+
 h3. A bunch of configuration options
 
-See the help output below.
+See the help output below for all of the options, which can be supplied in to ways:
+
+# Command Line
+# Yaml File
+** use it to add to or override the program defaults
+** *Batch mode:* run multiple reports at once simply by specifying an option set for each in @cuporter.yml@
+** the file name itself is a configurable option
+** See the samples.
+
+h4. option override precedence
+
+# Highest Precedence (overrides all): command line
+# Middle Precedence: yaml file
+# Lowest Precedence: @Cuporter::Config::OptionSet::DEFAULTS@
 
 ---------
 
@@ -113,73 +129,77 @@ h4. help
 
 <pre>
   $ 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 '[--input-dir]/**/*.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.
-          
-CSS and Javascript asset options:
-
-    -l, --link-assets                Do not inline CSS and js in <style/> and <script/> tags, but link to external files instead.
-                                           Default:  'false' for the tag and feature views, not optional for the
-                                                     tree view, which requires external gifs.
-          
-    -c, --copy-public-assets         If --output-file is supplied, and you're linking to external 
-                                           CSS and JavaScript assets, copy them from 'public/' to 'cuporter_public'
-                                           in the same dir as the output file.
-                                           Sets --use-copied-public-assets to 'true', and
-                                           the html report will link to these files by relative path.
-
-                                           Default: 'false'
-          
-    -u, --use-copied-public-assets   When running batches of reports, and the assets folder has already been
-                                           created by another call to cuporter with '--copy-public-assets'.
-                                           Set to 'true' automatically along with --copy-public-assets.
-
-                                           Default: 'false'
-          
-        --config-file PATH           Specify any of these options in a yml file.
-                                           Order of precedence:
-                                              1 - command line
-                                              2 - yaml file
-                                              3 - these defaults
-
-                                           Default: 'cuporter.yml'
-          
-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.
-
+  
+  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 '[--input-dir]/**/*.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.
+              
+          --config-file PATH           Specify any of these options in a yml file.
+                                             Order of precedence:
+                                                1 - command line
+                                                2 - yaml file
+                                                3 - these defaults
+  
+                                             Default: 'cuporter.yml'
+              
+      -d, --dry-run                    Print the configuration without running any reports.
+              
+          --text-summary               Add a summary to the text format.
+              
+  CSS and Javascript asset options:
+  
+      -l, --link-assets                Do not inline CSS and js in <style/> and <script/> tags, but link to external files instead.
+                                             Default:  'false' for the tag and feature views, not optional for the
+                                                       tree view, which requires external gifs.
+              
+      -c, --copy-public-assets         If --output-file is supplied, and you're linking to external 
+                                             CSS and JavaScript assets, copy them from 'public/' to 'cuporter_public'
+                                             in the same dir as the output file.
+                                             Sets --use-copied-public-assets to 'true', and
+                                             the html report will link to these files by relative path.
+  
+                                             Default: 'false'
+              
+      -u, --use-copied-public-assets   When running batches of reports, and the assets folder has already been
+                                             created by another call to cuporter with '--copy-public-assets'.
+                                             Set to 'true' automatically along with --copy-public-assets.
+  
+                                             Default: 'false'
+              
+  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.
+  
 </pre>
 
 h4. Examples

data/Rakefile

@@ -54,7 +54,7 @@ namespace :cuporter do
   RDOC_OPTS = ["--all" , "--quiet" , "--line-numbers" , "--inline-source", 
     "--main", "README.textile", 
     "--title", "Cuporter: cucumber tag reporting"]
-  XTRA_RDOC = %w{README.textile LICENSE }
+  XTRA_RDOC = %w{bin/cuporter README.textile LICENSE }
 
   Rake::RDocTask.new do |rd|
     rd.rdoc_dir = "doc/rdoc"
@@ -65,7 +65,7 @@ namespace :cuporter do
 
   spec = Gem::Specification.new do |s|
     s.name = 'cuporter'
-    s.version = '0.3.9'
+    s.version = '0.3.10'
     s.rubyforge_project = s.name
 
     s.platform = Gem::Platform::RUBY

data/bin/cuporter

@@ -5,28 +5,76 @@ $LOAD_PATH.unshift File.expand_path('../lib', File.dirname(__FILE__))
 require 'configuration'
 require 'cuporter'
 
+module Cuporter
 
-report = Cuporter::ReportBase.create(Cuporter.options).build
-
-(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'
-  if Cuporter.options[:copy_public_assets]
-    Cuporter::Document::Assets.copy(Cuporter.options[:output_file])
+  #=Default:
+  # 
+  # Single tag report of everything under "features/", formatted as
+  # indented text, showing feature names, scenario names, tags, file names, as well as scenario totals and sequence numbers.
+  #
+  # Configuration:
+  # 
+  # Use the command line options and/or yaml file to turn off everything but
+  # the feature names, and also to supply filtering tags (cucumber
+  # syntax and logical rules).
+  #
+  #
+  # Split output:
+  # 
+  # Note that a given report can be sent to multiple output targets.  For
+  # example, html to a file and pretty text or xml to <tt>stdout</tt>.  Specify
+  # multiple output files, and Cuporter will associate each of their names with the correct
+  # format/output stream, but if you get the file extension wrong it will fall
+  # back on <tt>stdout</tt>.  The possible extensions are <tt>.txt</tt>,
+  # <tt>.xml</tt>, <tt>.html</tt>, and <tt>.csv</tt>.
+  #
+  #
+  # Batch reporting:
+  #
+  # Use the yaml file to specify options for as many reports or views as you
+  # like to produce at once.
+  def self.run
+    Cuporter.option_sets.each do |options|
+
+      if options.dry_run?
+        options.dump
+        puts
+        next
+      end
+
+      report = Cuporter::ReportBase.create(options).build
+
+      options[:format].each do |format|
+        (options.output_file(format) || STDOUT).puts(
+          case format
+          when 'xml'
+            report.doc.to_xml(:indent => 2, :encoding => 'UTF-8')
+          when 'csv'
+            Cuporter::Formatters::NodeFormatters.total = options[:total]
+            report.doc.to_csv
+          when 'text', 'pretty'
+            Cuporter::Formatters::NodeFormatters.total = options[:total]
+            Cuporter::Formatters::NodeFormatters.text_summary = options[:text_summary]
+            report.doc.to_text
+          when 'html'
+            if options[:copy_public_assets]
+              Cuporter::Document::Assets.copy(options[:output_file].first)
+            end
+            html = Cuporter::Document.new_html(options[:report],
+                                               options[:link_assets], 
+                                               options[:use_copied_public_assets])
+            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
+    end
   end
-  html = Cuporter::Document.new_html(Cuporter.options[:report],
-                                     Cuporter.options[:link_assets], 
-                                     Cuporter.options[:use_copied_public_assets])
-  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
 
+Cuporter.run
+
 __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/config/cli/options.rb

@@ -37,7 +37,8 @@ module Cuporter
             opts.on("-f", "--format [xml|html|csv|text]", %Q{Output format.
                                          Default: text (it's pretty, though!)
             }) do |f|
-              @options[:format] = f
+              @options[:format] = [] unless @options[:format]
+              @options[:format] << f
             end
 
             opts.on("-i", "--input-dir DIR", %Q{Root directory of *.feature files.
@@ -59,15 +60,16 @@ module Cuporter
 
             opts.on("-o", "--output-file FILE", %Q{Output file path, like 'tmp/cucumber/tag_report.html'.
             }) do |o|
-              @options[:output_file] = o
+              @options[:output_file] = [] unless @options[:output_file]
+              @options[:output_file] << o
             end
 
-            @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] = [] unless @options[:tags]
               @options[:tags] << t
             end
 
@@ -77,6 +79,27 @@ module Cuporter
               @options[:title] = title
             end
 
+            opts.on("--config-file PATH", %Q{Specify any of these options in a yml file.
+                                           Order of precedence:
+                                              1 - command line
+                                              2 - yaml file
+                                              3 - these defaults
+
+                                           Default: 'cuporter.yml'
+            }) do |path|
+              @options[:config_file] = path
+            end
+
+            opts.on("-d", "--dry-run", %Q{Print the configuration without running any reports.
+            }) do |d|
+              @options[:dry_run] = d
+            end
+
+            opts.on("--text-summary", %Q{Add a summary to the text format.
+            }) do |ts|
+              @options[:text_summary] = ts
+            end
+
             opts.separator "CSS and Javascript asset options:\n\n"
 
             opts.on("-l", "--link-assets", %Q{Do not inline CSS and js in <style/> and <script/> tags, but link to external files instead.
@@ -107,17 +130,6 @@ module Cuporter
               @options[:use_copied_public_assets] = u
             end
 
-            opts.on("--config-file PATH", %Q{Specify any of these options in a yml file.
-                                           Order of precedence:
-                                              1 - command line
-                                              2 - yaml file
-                                              3 - these defaults
-
-                                           Default: 'cuporter.yml'
-            }) do |path|
-              @options[:config_file] = path
-            end
-
             opts.separator "Reporting options: on by default but can be turned off:\n\n"
             opts.on("--no-sort", "Do not sort tags, features, scenarios, or outlines\n") do |n|
               @options[:sort] = n

data/config/configuration.rb

@@ -7,67 +7,110 @@ require 'cli/filter_args_builder'
 module Cuporter
   module Config
 
-    module Options
+    class OptionSetCollection
 
-      DEFAULTS = { :report => "tag",
-                   :format => "text",
-                   :input_dir => "features",
-                   :tags => [],
-                   :copy_public_assets => false,
+      def self.path
+        Cuporter::Config::CLI::Options[:config_file] || "cuporter.yml"
+      end
+
+      def self.config_file
+        return [] unless File.exists?(path)
+
+        require 'yaml'
+        yaml = YAML.load_file(path)
+        if yaml["option_sets"]
+          yaml["option_sets"].map do |option_set|
+            cast(option_set["options"])
+          end
+        else
+          yaml["defaults"].empty? ? [] : [cast(yaml["defaults"])]
+        end
+      end
+
+      def self.cast(option_set)
+        pairs = {}
+        option_set.each do |key, value|
+          pairs[key.to_sym] = case key
+                              when /^(tags|output_file|format)$/i
+                                value.is_a?(Array) ? value : [value]
+                              else
+                                value
+                              end
+        end
+ 
+        return pairs
+      end
+    end
+
+    class OptionSet
+
+      DEFAULTS = { :report                   => "tag",
+                   :format                   => ["text"],
+                   :input_dir                => "features",
+                   :output_file              => [],
+                   :tags                     => [],
+                   :link_assets              => false,
+                   :copy_public_assets       => false,
                    :use_copied_public_assets => false,
-                   :sort => true,
-                   :number => true,
-                   :total => true,
-                   :show_tags => true,
-                   :show_files => true,
-                   :leaves => true
+                   :dry_run                  => false,
+                   :sort                     => true,
+                   :number                   => true,
+                   :total                    => true,
+                   :show_tags                => true,
+                   :show_files               => true,
+                   :leaves                   => true
       }
 
-      def self.options
-        unless @options
-          # empty hash if no file
-          file_config = config_file(Cuporter::Config::CLI::Options[:config_file] || "cuporter.yml")
+      attr_reader :options
+
+      def initialize(file_config = {})
+        # CLI options replace any found in the file
+        cli_options_over_file_options = file_config.merge(Cuporter::Config::CLI::Options.options)
 
-          # CLI options replace any found in the file
-          cli_options_over_file_options = file_config.merge(Cuporter::Config::CLI::Options.options)
+        # defaults will be used for anything not so far specified in the file
+        # or CLI
+        @options = post_process(DEFAULTS.merge(cli_options_over_file_options))
+      end
+
+      def [](key)
+        @options[key]
+      end
 
-          # defaults will be used for anything not so far specified in the file
-          # or CLI
-          @options = post_process(DEFAULTS.merge(cli_options_over_file_options))
+      def output_file(format)
+        if (file = @options[:output_file].find {|f| f =~ ext_for(format) })
+          File.open(file, "w")
         end
-        @options
       end
 
-      def self.post_process(options)
+      def dump
+        col_1_max = @options.keys.max_by {|i| i.to_s.length }.to_s.size
+        @options.each do |key, value|
+          puts ":#{key.to_s.ljust(col_1_max, ' ')} => #{value.inspect}"
+        end
+      end
+
+      def dry_run?
+        @options[:dry_run]
+      end
+
+      private
+
+      def post_process(options)
         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::Config::CLI::FilterArgsBuilder.new(options.delete(:tags)).args
-        if options[:output_file]
-          options[:output_file] = full_path(options[:output_file].dup)
-        else
-          options[:copy_public_assets] = false
-          options[:use_copied_public_assets] = false
+        options[:output_file].each_with_index do |file_path, i|
+          options[:output_file][i] = full_path(file_path.dup)
         end
-        options
-      end
-
-      def self.config_file(path)
-        return {} unless File.exists?(path)
 
-        require 'yaml'
-        pairs = {}
-        YAML.load_file(path).each do |key, value|
-          pairs[key.to_sym] = case value
-                              when /^true$/i
-                                true
-                              when /^false$/i
-                                false
-                              end || value
+        unless options[:output_file].find {|f| f =~ /\.html$/ }
+          options[:copy_public_assets] = options[:use_copied_public_assets] = false
         end
-        pairs
+
+        options
       end
 
-      def self.full_path(path)
+      def full_path(path)
         expanded_path = File.expand_path(path)
         path_nodes = expanded_path.split(File::SEPARATOR)
         file = path_nodes.pop
@@ -75,20 +118,24 @@ module Cuporter
         expanded_path
       end
 
+      def ext_for(format)
+        case format
+        when 'text', 'pretty'
+          /\.txt$/
+        else
+          /\.#{format}$/
+        end
+      end
     end
   end
 
-  def self.html?
-    Config::Options[:format] == 'html'
+  def self.option_sets
+    if (yaml_hashes = Config::OptionSetCollection.config_file).any?
+      yaml_hashes.map {|set| Config::OptionSet.new(set) }
+    else
+      [Config::OptionSet.new]
+    end
   end
 
-  def self.options
-    Config::Options.options
-  end
 
-  def self.output_file
-    if options[:output_file]
-      File.open(options[:output_file], "w")
-    end
-  end
 end

data/lib/cuporter/document.rb

@@ -11,8 +11,7 @@ module Cuporter
     end
 
     def self.new_html(view, link_assets, use_copied_public_assets)
-      Nokogiri::XML::Document.send(:include, Cuporter::Document::Html)
-      doc =  Nokogiri::XML::Document.new
+      doc =  Cuporter::Document::Html.new
       doc.view = view
       doc.link_assets = link_assets
       doc.assets_src = Assets::PUBLIC_SOURCE_PATH

data/lib/cuporter/document/html_document.rb

@@ -1,7 +1,7 @@
 # Copyright 2011 ThoughtWorks, Inc. Licensed under the MIT License
 module Cuporter
   module Document
-    module Html
+    class Html < Nokogiri::XML::Document
       attr_accessor :view, :link_assets, :assets_src, :assets_base_path
       
       def assets_base_path

data/lib/cuporter/formatters/csv.rb

@@ -13,11 +13,7 @@ module Cuporter
       end
 
       def total_column_spacer
-        @@total_column_spacer ||= Cuporter.options[:total] ? tab_stop : ""
-      end
-
-      def total_column
-        @@total_column ||= total_column_spacer
+        @@total_column_spacer ||= NodeFormatters.total ? tab_stop : ""
       end
 
       def total(node)

data/lib/cuporter/formatters/text.rb

@@ -14,8 +14,12 @@ module Cuporter
     end
 
     module NodeFormatters
+      class << self
+        attr_accessor :total, :text_summary
+      end
+
       def report(l, node)
-        return l unless Cuporter.options[:text_summary]
+        return l unless NodeFormatters.text_summary
         l += total(node)
         l += cuke_name(node['cuke_name'])
         l += title(node['title'])
@@ -89,7 +93,6 @@ module Cuporter
     module Text
       extend Util
       extend NodeFormatters
-      
 
       SPACER  = " "
       def tab_stop
@@ -97,16 +100,12 @@ module Cuporter
       end
 
       def total_column_spacer
-        @@total_column_spacer ||= Cuporter.options[:total] ? tab_stop : ""
-      end
-
-      def total_column
-        @@total_column ||= Cuporter.options[:total] ? tab_stop * 2: ""
+        @@total_column_spacer ||= NodeFormatters.total ? tab_stop : ""
       end
 
       def total(node)
         format_number(node, 'total') do |indent_length, value|
-          "[#{value}]".ljust(total_column.size, SPACER)
+          "[#{value}]".ljust(indent_length, SPACER)
         end
       end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cuporter
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 7
   prerelease: 
   segments: 
   - 0
   - 3
-  - 9
-  version: 0.3.9
+  - 10
+  version: 0.3.10
 platform: ruby
 authors: 
 - Tim Camper
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-14 00:00:00 -04:00
+date: 2011-06-28 00:00:00 -04:00
 default_executable: cuporter
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,6 +41,7 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
+- bin/cuporter
 - README.textile
 - LICENSE
 files: