cuporter 0.3.10 → 0.3.12

data/README.textile

@@ -1,6 +1,6 @@
 h1. Cuporter
 
-h3. A Cucumber Reporter
+h3. A "Cucumber":http://github.com/cucumber/cucumber Reporter
 
 Scrapes your feature files to show test counts and tag relationships.
 
@@ -28,9 +28,13 @@ h3. 4 Output Formats
 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
+h3. i18n: Dozens of Languages
 
-See the help output below for all of the options, which can be supplied in to ways:
+Internationalization through the "gherkin":http://github.com/cucumber/gherkin lanugage file (@i18n.yml@).  Following "cucumber's":http://github.com/cucumber/cucumber/wiki/Spoken-languages rules, non-English keywords will be used for any feature file with a '@# language: <iso-code>@' header on line 1,
+
+h3. A Bunch of Configuration Options
+
+See the help output below for all of the options, which can be supplied in two ways:
 
 # Command Line
 # Yaml File
@@ -131,75 +135,85 @@ h4. help
   $ 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.
-              
-          --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.
-              
+
+    -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 to be read.
+                                         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.
+            
+    -H, --output-home PATH           Root directory for the output files, like 'tmp/cucumber'.
+                                         Optional, because the path can also be specified along with the 
+                                         file name in "--output-file"
+
+                                         Default: ""
+
+        --log-dir PATH               Home directory for the error log 'cuporter_errors.log'.
+
+                                         Default: "." if no report output file is specified, else same as output file dir.
+
+            
+    -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: 'config/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'
-              
+
+    -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.
-  
+
+        --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
@@ -233,6 +247,8 @@ h3. Dependencies
 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.
+# Gherkin 1.0.0 or above
+** For looking up keywords @Feature@, @Scenario@, @Scenario Outline@, and @Examples@ by ISO language code.
 # 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;.

data/Rakefile

@@ -6,9 +6,9 @@ require 'rake/gempackagetask'
 
 task :default do
   Rake::Task["cuporter:load_test:safe_nokogiri"].invoke  # MUST RUN THIS FIRST
-  Rake.application.tasks_in_scope(["cuporter:test"]).each do |t|
-    t.invoke
-  end
+  Rake::Task["cuporter:test:unit"].invoke
+  Rake::Task["cuporter:test:functional"].invoke
+  Rake::Task["cuporter:test:cucumber"].invoke
 end
 
 namespace :cuporter do
@@ -47,7 +47,7 @@ namespace :cuporter do
 
     desc "cucumber features"
     task :cucumber do
-      sh "cucumber"
+      sh "cucumber --quiet"
     end
   end
 
@@ -65,7 +65,7 @@ namespace :cuporter do
 
   spec = Gem::Specification.new do |s|
     s.name = 'cuporter'
-    s.version = '0.3.10'
+    s.version = '0.3.12'
     s.rubyforge_project = s.name
 
     s.platform = Gem::Platform::RUBY
@@ -79,6 +79,7 @@ namespace :cuporter do
     s.homepage = 'http://github.com/twcamper/cuporter'
     s.required_ruby_version = '>= 1.8.6'
     s.add_dependency('nokogiri', '>= 1.4.1')
+    s.add_dependency('gherkin', '>= 1.0.0')
     s.default_executable = "cuporter"
     s.executables = [s.default_executable]
 

data/bin/cuporter

@@ -42,6 +42,8 @@ module Cuporter
         next
       end
 
+      Cuporter::Logging.output_home = options[:log_dir]
+
       report = Cuporter::ReportBase.create(options).build
 
       options[:format].each do |format|

data/config/batch_mode.example.yml

@@ -0,0 +1,47 @@
+# use this file to run mulitple reports/views at once.
+---
+# 'defaults' to be inherited by 'option sets'
+defaults:  &base
+  report: tree
+  format: html
+  link_assets: true
+  use_copied_public_assets: true
+  output_home: tmp
+
+option_sets:
+  - options:  &tag_report
+      <<: *base
+      report: tag
+      output_file: cucumber_tags.html
+      copy_public_assets: true
+
+  # 'split' the output stream to more than one formatter
+  # with no file name for the text format, we print to stdout, most likely on the console.
+  - options: &tree_split
+      <<: *base
+      format: [html, text]
+      output_file: active_tests.html
+      tags: [~@wip, ~@blocked]
+      number: false
+      title:  Active Scenarios
+
+  
+  - options: &inactive_split
+      <<: *base
+      format: [html, csv]
+      output_file: [inactive_tests.html, inactive_tests.csv]
+      tags: [@wip, @blocked]
+      input_dir: fixtures
+      title: Inactive Scenarios
+
+  # this demo won't produce anything because the tags don't exist
+  - options: &tag_syntax_demo
+      <<: *base
+      format: text
+      tags:
+        - @all                # AND
+        - @of                 # AND
+        - @these              # AND
+        - "@one, @the_other"  # ( OR )
+  #   one line version: "@all AND @of AND @these AND (@one OR @the_other)"
+  #   tags: [@all, @of, @these, "@one, @or_the_other"]

data/config/cli/options.rb

@@ -41,13 +41,13 @@ module Cuporter
               @options[:format] << f
             end
 
-            opts.on("-i", "--input-dir DIR", %Q{Root directory of *.feature files.
+            opts.on("-i", "--input-dir DIR", %Q{Root directory of *.feature files to be read.
                                          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'.
+                                         Overridden by "--file-input".
             }) do |i|
               @options[:input_dir] = i.sub(/#{File::SEPARATOR}$/,'')
             end
@@ -58,6 +58,22 @@ module Cuporter
               @options[:input_file] = file
             end
 
+            opts.on("-H", "--output-home PATH", %Q{Root directory for the output files, like 'tmp/cucumber'.
+                                         Optional, because the path can also be specified along with the 
+                                         file name in "--output-file"
+
+                                         Default: ""
+            }) do |h|
+              @options[:output_home] = h
+            end
+
+            opts.on("--log-dir PATH", %Q{Root directory for the error log 'cuporter_errors.log'.
+
+                                         Default: "." if no report output file is specified, else same as output file dir.
+            }) do |d|
+              @options[:log_dir] = d
+            end
+
             opts.on("-o", "--output-file FILE", %Q{Output file path, like 'tmp/cucumber/tag_report.html'.
             }) do |o|
               @options[:output_file] = [] unless @options[:output_file]
@@ -85,7 +101,7 @@ module Cuporter
                                               2 - yaml file
                                               3 - these defaults
 
-                                           Default: 'cuporter.yml'
+                                           Default: 'config/cuporter.yml'
             }) do |path|
               @options[:config_file] = path
             end

data/config/configuration.rb

@@ -3,139 +3,36 @@ $LOAD_PATH.unshift( File.expand_path("#{File.dirname(__FILE__)}"))
 require 'fileutils'
 require 'cli/options'
 require 'cli/filter_args_builder'
+require 'yaml_file/option_set_collection'
+require 'option_set'
 
 module Cuporter
-  module Config
-
-    class OptionSetCollection
-
-      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,
-                   :dry_run                  => false,
-                   :sort                     => true,
-                   :number                   => true,
-                   :total                    => true,
-                   :show_tags                => true,
-                   :show_files               => true,
-                   :leaves                   => true
-      }
-
-      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)
-
-        # 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
-
-      def output_file(format)
-        if (file = @options[:output_file].find {|f| f =~ ext_for(format) })
-          File.open(file, "w")
-        end
-      end
-
-      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
-        options[:output_file].each_with_index do |file_path, i|
-          options[:output_file][i] = full_path(file_path.dup)
-        end
-
-        unless options[:output_file].find {|f| f =~ /\.html$/ }
-          options[:copy_public_assets] = options[:use_copied_public_assets] = false
-        end
-
-        options
-      end
-
-      def full_path(path)
-        expanded_path = File.expand_path(path)
-        path_nodes = expanded_path.split(File::SEPARATOR)
-        file = path_nodes.pop
-        FileUtils.makedirs(path_nodes.join(File::SEPARATOR))
-        expanded_path
-      end
-
-      def ext_for(format)
-        case format
-        when 'text', 'pretty'
-          /\.txt$/
-        else
-          /\.#{format}$/
-        end
-      end
-    end
-  end
-
   def self.option_sets
-    if (yaml_hashes = Config::OptionSetCollection.config_file).any?
-      yaml_hashes.map {|set| Config::OptionSet.new(set) }
+    if (yaml_hashes = Config::YamlFile::OptionSetCollection.config_file).any?
+      yaml_hashes.map {|yaml_hash| Config::OptionSet.new(yaml_hash) }
     else
       [Config::OptionSet.new]
     end
   end
 
+  module Config
+    DEFAULTS = { :report                   => "tag",
+                 :format                   => ["text"],
+                 :input_dir                => "features",
+                 :output_file              => [],
+                 :output_home              => "",
+                 :log_dir                  => ".",
+                 :tags                     => [],
+                 :link_assets              => false,
+                 :copy_public_assets       => false,
+                 :use_copied_public_assets => false,
+                 :dry_run                  => false,
+                 :sort                     => true,
+                 :number                   => true,
+                 :total                    => true,
+                 :show_tags                => true,
+                 :show_files               => true,
+                 :leaves                   => true }
 
+  end
 end