cuporter 0.2.7 → 0.2.8

data/README.textile

@@ -1,13 +1,24 @@
 h1. Cuporter
 
-Scrapes your feature files and shows scenarios per tag, with their context.  Formats HTML, CSV, and Pretty Text.
+Scrapes your feature files and shows 2 possible reports:
 
-Consider this a stop-gap until we get this functionality in a proper cucumber formatter.
+# scenarios and examples per tag
+** in Feature and Scenario Outline context, as appropriate
+** sorted alphbetically
+** optionally numbered, counting scenarios and outline examples per tag
+# feature, scenario and example names
+** may be filtered by tags, using same CLI syntax as Cucumber
+** sorted alphbetically
+** optionally numbered, using 1 count of all scenarios and outline examples for the report
+
+Either report may be formatted in HTML, CSV, or Pretty Text.
 
-In version 0.2.0 and later you can number the Scenarios and Example rows with the @-n@ or @--numbers@ option.
+* HTML reports do jQuery expand-collapse, with acklowedgment due to the Cucumber HTML formatter.
+
+Consider this a stop-gap until we get this functionality in a proper cucumber formatter.
 
 ---------
-h3. Example Output: numbered pretty text
+h3. Example Tag Report Output: numbered pretty text
 
 <pre>
 @failing
@@ -63,28 +74,44 @@ h4. help
   $ ./bin/cuporter -h
 
   Usage: cuporter [options]
-  
+
       -i, --in DIR                     directory of *.feature files
-  					Default: features/**/*.feature
-  
-          --input-file FILE            full file name with extension: 'path/to/file.feature'
-  
+    					Default: features/**/*.feature
+
+      -I, --input-file FILE            full file name with extension: 'path/to/file.feature'
+
       -o, --out FILE                   Output file path
-  
+
       -f, --format [pretty|html|csv]   Output format
-  					Default: pretty text
+					Default: pretty text
 
       -n, --numbers                    number scenarios and examples
+
+      -t, --tags TAG_EXPRESSION        Filter on tags for name report.
+  					TAG_EXPRESSION rules: see '$ cucumber --help' and http://github.com/aslakhellesoy/cucumber/wiki/Tags
+
+      -r, --report [tag|name]          type of report
+					Default: tag
+
+      -T, --title STRING               title of name report
+					Default: 'Cucumber Scenario Inventory'
+
 </pre>
 
 h4. run script directly
 
 <pre>
-  $ ./bin/cuporter -i fixtures/self_text                         # pretty-print demo report to stdout
+  #  pretty-print demo report to stdout
+  $ ./bin/cuporter -i fixtures/self_text
+
+  #  default input features/**/*.feature to named output file
+  $ ./bin/cuporter -f html -o feature_tag_report.html
 
-  $ ./bin/cuporter -f html -o feature_tag_report.html            # default input features/**/*.feature to named output file
+  #  same, but number the scenarios and example rows
+  $ ./bin/cuporter -f html --numbers -o feature_tag_report.html
 
-  $ ./bin/cuporter -f html --numbers -o feature_tag_report.html  # same, but number the scenarios and example rows
+  #  filtered html name report, with non-default title
+  $ ./bin/cuporter -f html -o active_customer.html -r name -n -T "Active Customer Test Inventory" -t ~@wip -t @customer,@client
 </pre>
 
 h4. run via rake

data/Rakefile

@@ -56,14 +56,14 @@ namespace :cuporter do
 
   spec = Gem::Specification.new do |s|
     s.name = 'cuporter'
-    s.version = '0.2.7'
+    s.version = '0.2.8'
     s.rubyforge_project = s.name
 
     s.platform = Gem::Platform::RUBY
     s.has_rdoc = true
     s.extra_rdoc_files = XTRA_RDOC
     s.rdoc_options += RDOC_OPTS
-    s.summary = "Scrapes Cucumber *.feature files to build report on tag usage"
+    s.summary = "Scrapes Cucumber *.feature files to build reports on tag usage and test inventory"
     s.description = s.summary
     s.author = "Tim Camper"
     s.email = 'twcamper@thoughtworks.com'

data/bin/cuporter

@@ -3,9 +3,15 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'cuporter'
 
-tag_report = Cuporter::TagReport.new(Cuporter::Options[:input_file] || Cuporter::Options[:input_dir])
+filter_args = Cuporter::CLI::FilterArgsBuilder.new(Cuporter::CLI::Options[:tags]).args
 
-formatter = Cuporter::Formatters.const_get(Cuporter::Options[:format])
-formatter.new(tag_report.scenarios_per_tag,
-              Cuporter::Options[:output],
-              Cuporter::Options[:numbers]).write
+report = Cuporter::Report.create(Cuporter::CLI::Options[:report], 
+                                 Cuporter::CLI::Options[:input_file] || Cuporter::CLI::Options[:input_dir],
+                                 Cuporter::CLI::Options[:numbers],
+                                 filter_args,
+                                 Cuporter::CLI::Options[:title])
+
+formatter = Cuporter::Formatter::Writer.create(Cuporter::CLI::Options[:format],
+                                               report,
+                                               Cuporter::CLI::Options[:output])
+formatter.write

data/lib/cuporter/cli/filter_args_builder.rb

@@ -0,0 +1,37 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+
+module Cuporter
+  module CLI
+    class FilterArgsBuilder
+      def initialize(cli_tags = [])
+        @cli_tags = cli_tags
+        @all  = []
+        @any  = []
+        @none = []
+        @args = {}
+        filter_args
+      end
+
+      def filter_args
+        @cli_tags.each do |expression|
+          case expression
+          when /^~@/
+            @none << expression.sub(/~/,'')
+          when /,/
+            @any |= expression.split(',')
+          else
+            @all << expression
+          end
+        end
+      end
+
+      def args
+        @args[:any]  = @any unless @any.empty?
+        @args[:all]  = @all unless @all.empty?
+        @args[:none] = @none unless @none.empty?
+        @args
+      end
+
+    end
+  end
+end

data/lib/cuporter/cli/options.rb

@@ -3,47 +3,67 @@ require 'optparse'
 require 'fileutils'
 
 module Cuporter
-  class Options
+  module CLI
+    class Options
 
-    def self.[](key)
-      self.options[key]
-    end
+      def self.[](key)
+        self.options[key]
+      end
 
-    def self.options
-      self.parse unless @options
-      @options
-    end
+      def self.options
+        self.parse unless @options
+        @options
+      end
+
+      def self.parse
+        @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"
+          end
+
+          opts.on("-I", "--input-file FILE", "full file name with extension: 'path/to/file.feature'\n\n") do |file|
+            @options[:input_file] = file
+          end
+          opts.on("-o", "--out FILE", "Output file path\n\n") 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] = full_path
+          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
+          end
+
+          opts.on("-n", "--numbers", "number scenarios and examples\n\n") do |n|
+            @options[:numbers] = 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
+          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
+          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
+          end
 
-    def self.parse
-      @options = {}
-      OptionParser.new(ARGV.dup) do |opts|
-        opts.banner = "Usage: cuporter [options]\n\n"
-
-        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"
-        end
-        opts.on("--input-file FILE", "full file name with extension: 'path/to/file.feature'\n\n") do |file|
-          @options[:input_file] = file
-        end
-        opts.on("-o", "--out FILE", "Output file path\n\n") 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] = full_path
-        end
-        opts.on("-f", "--format [pretty|html|csv]", "Output format\n\t\t\t\t\tDefault: pretty text\n\n") do |f|
-          @options[:format] = f.downcase.to_class_name
-        end
-        @options[:format] ||= :Text
-        
-        opts.on("-n", "--numbers", "number scenarios and examples") do |n|
-          @options[:numbers] = n
-        end
-      end.parse!
+        end.parse!
 
 
+      end
     end
   end
 end

data/lib/cuporter/feature_parser.rb

@@ -1,7 +1,7 @@
 # Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
 
 module Cuporter
-  class FeatureParser
+  module FeatureParser
     FEATURE_LINE          = /^\s*(Feature:[^#]+)/
     TAG_LINE              = /^\s*(@\w.+)/
     SCENARIO_LINE         = /^\s*(Scenario:[^#]+)$/
@@ -10,65 +10,13 @@ module Cuporter
     EXAMPLE_SET_LINE      = /^\s*(Examples:[^#]*)$/
     EXAMPLE_LINE          = /^\s*(\|.*\|)\s*$/
 
-    def initialize(file)
-      @file = file
-      @current_tags = []
+    def self.tag_list(file)
+      TagList.new(file).parse_feature
     end
 
-    def self.parse(file)
-      self.new(file).parse
+    def self.name_list(file, filter)
+      NameList.new(file, filter).parse_feature
     end
 
-    def parse
-      lines = File.read(@file).split(/\n/)
-
-      lines.each_with_index do |line, i|
-        case line
-        when TAG_LINE
-          # may be more than one tag line
-          @current_tags |= $1.strip.split(/\s+/)
-        when FEATURE_LINE
-          @feature = TagListNode.new($1, @current_tags)
-          @feature.file = @file.sub(/^.*features\//,"features/")
-          @current_tags = []
-        when SCENARIO_LINE
-          # How do we know when we have read all the lines from a "Scenario Outline:"?
-          # One way is when we encounter a "Scenario:"
-          close_scenario_outline
-
-          @feature.add_to_tag_nodes(TagListNode.new($1, @current_tags))
-          @current_tags = []
-        when SCENARIO_OUTLINE_LINE
-          # ... another is when we hit a subsequent "Scenario Outline:"
-          close_scenario_outline
-
-          @scenario_outline  = TagListNode.new($1, @current_tags)
-          @current_tags = []
-        when EXAMPLE_SET_LINE, SCENARIO_SET_LINE
-          @scenario_outline.add_to_tag_nodes(@example_set) if @example_set
-
-          @example_set = ExampleSetNode.new($1, @feature.tags | @current_tags)
-          @current_tags = []
-        when @example_set && EXAMPLE_LINE
-          @example_set.add_child(Node.new($1))
-        end
-      end
-
-      # EOF is the final way that we know we are finished with a "Scenario Outline"
-      close_scenario_outline
-      return @feature
-    end
-
-    def close_scenario_outline
-      if @scenario_outline
-        if @example_set
-          @scenario_outline.add_to_tag_nodes(@example_set) if @example_set
-          @example_set = nil
-        end
-        @feature.merge(@scenario_outline)
-        @scenario_outline = nil
-      end
-    end
   end
-
 end

data/lib/cuporter/filter.rb

@@ -0,0 +1,52 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+module Cuporter
+  class Filter
+
+    attr_reader :all, :any, :none
+
+    def initialize(args = {})
+      @all  = to_tag_array(args[:all]) # logical AND
+      @any  = to_tag_array(args[:any]) # logical OR
+      @none = to_tag_array(args[:none])# logical NOT
+    end
+
+    def pass?(other_tags)
+      pass = true
+
+      # Logical AND: are all of the tags in :all in the tests' tags?
+      unless all.empty?
+        pass = false unless (other_tags & all).size == all.size
+      end
+
+      # Logical OR: are any of the tests' tags in :any?
+      unless any.empty?
+        pass = false if (other_tags & any).empty?
+      end
+
+      unless none.empty?
+        pass = false if !(other_tags & none).empty?
+      end
+      pass
+    end
+
+    def empty?
+      all.empty? && any.empty? && none.empty?
+    end
+
+    private
+
+    def to_tag_array(tag_input)
+      case tag_input
+      when Array
+        tag_input
+      when String
+        tag_input.split(" ")
+      when Numeric, Symbol
+        [tag_input.to_s]
+      else
+        []
+      end
+    end
+
+  end
+end

data/lib/cuporter/{formatters → formatter}/csv.rb

@@ -1,6 +1,6 @@
 # Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
 module Cuporter
-  module Formatters
+  module Formatter
     class Csv < Writer
       include TextMethods
       

data/lib/cuporter/{formatters → formatter}/cuporter.css

@@ -7,14 +7,35 @@ body {
   padding-left: 2em; 
   padding-bottom: 0.3em; 
   padding-top: 0.05em; 
-  height: 6em;
   background-color: #24A6C1;
   color: white;
+  height: 7em;
+}
+.cuporter_header #label {
+  padding-right: 2em;
+  float: left;
+}
+#filter_summary {
+  width: 60em;
+  float: right;
+  padding-top: 1.2em;
 }
 
-#expand-collapse {
+#summary {
   position: absolute;
   right: 1em;
+  text-align: right;
+  top: 1.2em;
+}
+
+#summary p, #filter_summary p {
+  margin: 0px 0px 0px 2px;
+}
+
+.tag_report #expand-collapse {
+  position: absolute;
+  right: 1em;
+  text-align: right;
   top:   0.5em;
 }
 ul {
@@ -78,6 +99,10 @@ ul {
   left: 4.5em;
   font-weight: bold;
 }
+
+.name_report .number {
+  left: 4em;
+}
 .file {
   float: right;
   padding-right: 0.5em;

data/lib/cuporter/{formatters/html.rb → formatter/html_methods.rb}

@@ -3,8 +3,8 @@ require 'rubygems'
 require 'erb'
 
 module Cuporter
-  module Formatters
-    class Html < Writer
+  module Formatter
+    module HtmlMethods
 
       def inline_style
         File.read(File.dirname(__FILE__) + "/cuporter.css")
@@ -15,7 +15,7 @@ module Cuporter
       end
 
       def rhtml
-        ERB.new(RHTML)
+        ERB.new(self.class::RHTML)
       end
 
       def write
@@ -61,45 +61,23 @@ module Cuporter
       $(FEATURES).siblings().show();
     });
 
+    $("#expand_features").css('cursor', 'pointer');
+    $("#expand_features").click(function() {
+      $(FEATURES).siblings().show();
+    });
+
+    $("#collapse_features").css('cursor', 'pointer');
+    $("#collapse_features").click(function() {
+      $(FEATURES).siblings().hide();
+    });
+
     // load page with features collapsed
-    $("#expand_tags").click();
+    $("#expand_tags, #collapse_features").click();
   })
   
         EOF
       end
 
-      RHTML = %{
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-    <title>Cucumber Tags</title>
-    <style type="text/css">
-      <%= inline_style%>
-    </style>
-    <script type="text/javascript">
-      <%= inline_jquery%>
-      <%= inline_js_content%>
-    </script>
-</head>
-<body>
-    <div class="cuporter_header">
-      <div id="label">
-          <h1>Cucumber Tags</h1>
-      </div>
-          <div id="expand-collapse">
-             <p id="expand_tags">Expand Tags</p>
-             <p id="expand_all">Expand All</p>
-             <p id="collapser">Collapse All</p>
-          </div>
-    </div>
-    <ul class="tag_list">
-      <%= HtmlNodeWriter.new.write_nodes(@report, @number_scenarios)%>
-    </ul>
-</body>
-</html>
-      }
-
-
     end
   end
 end

data/lib/cuporter/{formatters → formatter}/html_node_writer.rb

@@ -3,7 +3,7 @@ require 'rubygems'
 require 'builder'
 
 module Cuporter
-  module Formatters
+  module Formatter
     class HtmlNodeWriter
 
       attr_reader :builder
@@ -13,8 +13,7 @@ module Cuporter
       end
 
       def write_nodes(report, number_scenarios)
-        report.children.each do |tag_node|
-          tag_node.number_all_descendants if number_scenarios
+        report.report_node.children.each do |tag_node|
           write_node(tag_node)
         end
         builder

data/lib/cuporter/formatter/name_report_html.rb

@@ -0,0 +1,62 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+require 'rubygems'
+require 'erb'
+
+module Cuporter
+  module Formatter
+    class NameReportHtml < Writer
+      include HtmlMethods
+
+      def title
+        @report.title
+      end
+
+      def filter_summary
+        return if @report.filter.empty?
+        builder = Builder::XmlMarkup.new
+        builder.div(:id => :filter_summary) do |div|
+          div.p("Filtering:")
+          div.p("Include: #{@report.filter.all.join(' AND ')}") unless @report.filter.all.empty?
+          div.p("Include: #{@report.filter.any.join(' OR ')}") unless @report.filter.any.empty?
+          div.p("Exclude: #{@report.filter.none.join(', ')}") unless @report.filter.none.empty?
+        end
+      end
+
+      RHTML = %{
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+    <title><%= title %></title>
+    <style type="text/css">
+      <%= inline_style%>
+    </style>
+    <script type="text/javascript">
+      <%= inline_jquery%>
+      <%= inline_js_content%>
+    </script>
+</head>
+<body class="name_report">
+    <div class="cuporter_header">
+      <div id="label">
+          <h1><%= title %></h1>
+      </div>
+      <%= filter_summary %>
+      <div id="summary">
+          <p id="total"><%= @report.report_node.total%> Scenarios </p>
+          <div id="expand-collapse">
+              <p id="expand_features">Expand All</p>
+              <p id="collapse_features">Collapse All</p>
+           </div>
+      </div>
+    </div>
+    <ul class="tag_list, name_report">
+      <%= HtmlNodeWriter.new.write_nodes(@report, @number_scenarios)%>
+    </ul>
+</body>
+</html>
+      }
+
+
+    end
+  end
+end

data/lib/cuporter/formatter/tag_report_html.rb

@@ -0,0 +1,48 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+require 'rubygems'
+require 'erb'
+
+module Cuporter
+  module Formatter
+    class TagReportHtml < Writer
+      include HtmlMethods
+
+      def title
+        "Cucumber Tags"
+      end
+
+      RHTML = %{
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+    <title><%= title %></title>
+    <style type="text/css">
+      <%= inline_style%>
+    </style>
+    <script type="text/javascript">
+      <%= inline_jquery%>
+      <%= inline_js_content%>
+    </script>
+</head>
+<body class="tag_report">
+    <div class="cuporter_header">
+      <div id="label">
+          <h1><%= title %></h1>
+      </div>
+          <div id="expand-collapse">
+             <p id="expand_tags">Expand Tags</p>
+             <p id="expand_all">Expand All</p>
+             <p id="collapser">Collapse All</p>
+          </div>
+    </div>
+    <ul class="tag_list">
+      <%= HtmlNodeWriter.new.write_nodes(@report, @number_scenarios)%>
+    </ul>
+</body>
+</html>
+      }
+
+
+    end
+  end
+end

data/lib/cuporter/{formatters → formatter}/text.rb

@@ -1,6 +1,6 @@
 # Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
 module Cuporter
-  module Formatters
+  module Formatter
     class Text < Writer
       include TextMethods
 

data/lib/cuporter/{formatters → formatter}/text_methods.rb

@@ -1,10 +1,10 @@
 # Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
 module Cuporter
-  module Formatters
+  module Formatter
     module TextMethods
     
       def write
-        @report.children.each do |tag_node|
+        @report.report_node.children.each do |tag_node|
           tag_node.number_all_descendants if @number_scenarios
           write_node(tag_node, 0)
         end

data/lib/cuporter/formatter/writer.rb

@@ -0,0 +1,29 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+
+module Cuporter
+  module Formatter
+    class Writer
+
+      def initialize(report, output)
+        @report = report
+        @output = output ? File.open(output, "w") : STDOUT
+      end
+
+      def self.create(format, report, output)
+        klass = writer_class(format, report.class.name.split(/::/).last)
+        klass.new(report, output)
+      end
+
+      def self.writer_class(format, report_class)
+        case format
+        when /text|pretty/i
+          Cuporter::Formatter::Text
+        when /csv/i
+          Cuporter::Formatter::Csv
+        when /html/i
+          Cuporter::Formatter.const_get("#{report_class}Html")
+        end
+      end
+    end
+  end
+end

data/lib/cuporter/name_list.rb

@@ -0,0 +1,65 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+
+module Cuporter
+  class NameList
+
+    def initialize(file, filter)
+      @file = file
+      @current_tags = []
+      @filter = filter
+    end
+
+    def parse_feature
+      lines = File.read(@file).split(/\n/)
+
+      lines.each do |line|
+        case line
+        when FeatureParser::TAG_LINE
+          # may be more than one tag line
+          @current_tags |= $1.strip.split(/\s+/)
+        when FeatureParser::FEATURE_LINE
+          @feature = TagListNode.new($1, @current_tags, @filter)
+          @feature.file = @file.sub(/^.*features\//,"features/")
+          @current_tags = []
+        when FeatureParser::SCENARIO_LINE
+          # How do we know when we have read all the lines from a "Scenario Outline:"?
+          # One way is when we encounter a "Scenario:"
+          close_scenario_outline
+
+          @feature.filter_child(Node.new($1), @current_tags)
+          @current_tags = []
+        when FeatureParser::SCENARIO_OUTLINE_LINE
+          # ... another is when we hit a subsequent "Scenario Outline:"
+          close_scenario_outline
+
+          @scenario_outline  = TagListNode.new($1, @current_tags, @filter)
+          @current_tags = []
+        when FeatureParser::EXAMPLE_SET_LINE, FeatureParser::SCENARIO_SET_LINE
+          @scenario_outline.filter_child(@example_set, @example_set.tags) if @example_set
+
+          @example_set = ExampleSetNode.new($1, @feature.tags | @current_tags, @filter)
+          @current_tags = []
+        when @example_set && FeatureParser::EXAMPLE_LINE
+          @example_set.add_child(Node.new($1))
+        end
+      end
+
+      # EOF is the final way that we know we are finished with a "Scenario Outline"
+      close_scenario_outline
+      return @feature
+    end
+
+    def close_scenario_outline
+      if @scenario_outline
+        if @example_set
+          @scenario_outline.filter_child(@example_set, @example_set.tags) if @example_set
+          @example_set = nil
+        end
+        @feature.add_child(@scenario_outline) if @scenario_outline.has_children?
+        @scenario_outline = nil
+      end
+    end
+
+  end
+
+end

data/lib/cuporter/report/name_report.rb

@@ -0,0 +1,19 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+module Cuporter
+  class NameReport < Report
+
+    def report_node
+      names = TagListNode.new("report", @filter)
+      files.each do |file|
+        feature = FeatureParser.name_list(file, @filter)
+        if feature && feature.has_children?
+          names.add_child(feature)
+        end
+      end
+      names.sort_all_descendants!
+      names.number_all_descendants if number_scenarios
+      names
+    end
+
+  end
+end

data/lib/cuporter/report/report.rb

@@ -0,0 +1,23 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+module Cuporter
+  class Report
+
+    attr_reader :number_scenarios, :filter, :title
+
+    def initialize(input_file_pattern, number_scenarios, filter_args = nil, title = nil)
+      @input_file_pattern = input_file_pattern
+      @number_scenarios = number_scenarios
+      @filter = Filter.new(filter_args || {})
+      @title = title
+    end
+
+    def files
+      Dir[@input_file_pattern].collect {|f| File.expand_path f}
+    end
+
+    def self.create(type, input_file_pattern, number_scenarios, filter_args = nil, title = nil)
+      klass = Cuporter.const_get("#{type.downcase}Report".to_class_name)
+      klass.new(input_file_pattern, number_scenarios, filter_args, title)
+    end
+  end
+end

data/lib/cuporter/report/tag_report.rb

@@ -0,0 +1,17 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+module Cuporter
+  class TagReport < Report
+
+    def report_node
+      tags = TagListNode.new("report",[])
+      files.each do |file|
+        feature = FeatureParser.tag_list(file)
+        tags.merge_tag_nodes(feature) if feature
+      end
+      tags.sort_all_descendants!
+      tags.children.each { |child| child.number_all_descendants } if number_scenarios
+      tags
+    end
+
+  end
+end

data/lib/cuporter/tag_list.rb

@@ -0,0 +1,64 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+
+module Cuporter
+  class TagList
+
+    def initialize(file)
+      @file = file
+      @current_tags = []
+    end
+
+    def parse_feature
+      lines = File.read(@file).split(/\n/)
+
+      lines.each do |line|
+        case line
+        when FeatureParser::TAG_LINE
+          # may be more than one tag line
+          @current_tags |= $1.strip.split(/\s+/)
+        when FeatureParser::FEATURE_LINE
+          @feature = TagListNode.new($1, @current_tags)
+          @feature.file = @file.sub(/^.*features\//,"features/")
+          @current_tags = []
+        when FeatureParser::SCENARIO_LINE
+          # How do we know when we have read all the lines from a "Scenario Outline:"?
+          # One way is when we encounter a "Scenario:"
+          close_scenario_outline
+
+          @feature.add_to_tag_nodes(TagListNode.new($1, @current_tags))
+          @current_tags = []
+        when FeatureParser::SCENARIO_OUTLINE_LINE
+          # ... another is when we hit a subsequent "Scenario Outline:"
+          close_scenario_outline
+
+          @scenario_outline  = TagListNode.new($1, @current_tags)
+          @current_tags = []
+        when FeatureParser::EXAMPLE_SET_LINE, FeatureParser::SCENARIO_SET_LINE
+          @scenario_outline.add_to_tag_nodes(@example_set) if @example_set
+
+          @example_set = ExampleSetNode.new($1, @feature.tags | @current_tags)
+          @current_tags = []
+        when @example_set && FeatureParser::EXAMPLE_LINE
+          @example_set.add_child(Node.new($1))
+        end
+      end
+
+      # EOF is the final way that we know we are finished with a "Scenario Outline"
+      close_scenario_outline
+      return @feature
+    end
+
+    def close_scenario_outline
+      if @scenario_outline
+        if @example_set
+          @scenario_outline.add_to_tag_nodes(@example_set) if @example_set
+          @example_set = nil
+        end
+        @feature.merge_tag_nodes(@scenario_outline)
+        @scenario_outline = nil
+      end
+    end
+
+  end
+
+end

data/lib/cuporter/tag_list_node.rb

@@ -5,15 +5,20 @@ module Cuporter
 
     attr_reader :tags
 
-    def initialize(name, tags)
+    def initialize(name, tags, filter = {})
       super(name)
       @tags = tags
+      @filter = filter
     end
 
     def has_tags?
       @tags.size > 0
     end
 
+    def filter_child(node, node_tags)
+      add_child(node) if @filter.pass?(tags | node_tags)
+    end
+
     def add_to_tag_nodes(node)
       (tags | node.tags).each do |tag|
         tag_node = find_or_create_child(tag)
@@ -25,14 +30,14 @@ module Cuporter
     #
     # Copy children of other node's top-level, direct descendants to this 
     # node's direct descendants of the same name.
-    def merge(other)
-      other.children.each do |other_child|
-        direct_child               = find_or_create_child(other_child.name)
-        new_grandchild             = Node.new(other.name)
-        new_grandchild.children    = other_child.children
-        new_grandchild.file        = other.file
-
-        direct_child.add_child(new_grandchild)
+    def merge_tag_nodes(other)
+      other.children.each do |other_tag_node|
+        tag_node                = find_or_create_child(other_tag_node.name)
+        new_grandchild          = Node.new(other.name)
+        new_grandchild.children = other_tag_node.children
+        new_grandchild.file     = other.file
+
+        tag_node.add_child(new_grandchild)
       end
     end
 

data/lib/cuporter.rb

@@ -1,15 +1,23 @@
 # Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
 require 'cuporter/node'
+require 'cuporter/filter'
+require 'cuporter/tag_list'
+require 'cuporter/name_list'
 require 'cuporter/tag_list_node'
 require 'cuporter/example_set_node'
 require 'cuporter/node_numberer'
 require 'cuporter/feature_parser'
 require 'cuporter/extensions/string'
 require 'cuporter/cli/options'
-require 'cuporter/tag_report'
-require 'cuporter/formatters/writer'
-require 'cuporter/formatters/text_methods'
-require 'cuporter/formatters/text'
-require 'cuporter/formatters/csv'
-require 'cuporter/formatters/html_node_writer'
-require 'cuporter/formatters/html'
+require 'cuporter/cli/filter_args_builder'
+require 'cuporter/report/report'
+require 'cuporter/report/tag_report'
+require 'cuporter/report/name_report'
+require 'cuporter/formatter/writer'
+require 'cuporter/formatter/text_methods'
+require 'cuporter/formatter/text'
+require 'cuporter/formatter/csv'
+require 'cuporter/formatter/html_node_writer'
+require 'cuporter/formatter/html_methods'
+require 'cuporter/formatter/tag_report_html'
+require 'cuporter/formatter/name_report_html'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cuporter
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 7
   prerelease: false
   segments: 
   - 0
   - 2
-  - 7
-  version: 0.2.7
+  - 8
+  version: 0.2.8
 platform: ruby
 authors: 
 - Tim Camper
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-24 00:00:00 -04:00
+date: 2010-09-27 00:00:00 -04:00
 default_executable: cuporter
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,7 +34,7 @@ dependencies:
         version: 2.1.2
   type: :runtime
   version_requirements: *id001
-description: Scrapes Cucumber *.feature files to build report on tag usage
+description: Scrapes Cucumber *.feature files to build reports on tag usage and test inventory
 email: twcamper@thoughtworks.com
 executables: 
 - cuporter
@@ -47,23 +47,31 @@ files:
 - LICENSE
 - README.textile
 - Rakefile
+- lib/cuporter/name_list.rb
 - lib/cuporter/example_set_node.rb
-- lib/cuporter/formatters/csv.rb
-- lib/cuporter/formatters/text.rb
-- lib/cuporter/formatters/html_node_writer.rb
-- lib/cuporter/formatters/html.rb
-- lib/cuporter/formatters/writer.rb
-- lib/cuporter/formatters/text_methods.rb
+- lib/cuporter/formatter/csv.rb
+- lib/cuporter/formatter/text.rb
+- lib/cuporter/formatter/html_node_writer.rb
+- lib/cuporter/formatter/html_methods.rb
+- lib/cuporter/formatter/tag_report_html.rb
+- lib/cuporter/formatter/name_report_html.rb
+- lib/cuporter/formatter/writer.rb
+- lib/cuporter/formatter/text_methods.rb
+- lib/cuporter/tag_list.rb
+- lib/cuporter/report/report.rb
+- lib/cuporter/report/name_report.rb
+- lib/cuporter/report/tag_report.rb
+- lib/cuporter/cli/filter_args_builder.rb
 - lib/cuporter/cli/options.rb
 - lib/cuporter/tag_list_node.rb
 - lib/cuporter/extensions/string.rb
 - lib/cuporter/feature_parser.rb
 - lib/cuporter/node.rb
+- lib/cuporter/filter.rb
 - lib/cuporter/node_numberer.rb
-- lib/cuporter/tag_report.rb
 - lib/cuporter.rb
-- lib/cuporter/formatters/cuporter.css
-- lib/cuporter/formatters/jquery-min.js
+- lib/cuporter/formatter/cuporter.css
+- lib/cuporter/formatter/jquery-min.js
 - bin/cuporter
 has_rdoc: true
 homepage: http://github.com/twcamper/cuporter
@@ -107,6 +115,6 @@ rubyforge_project: cuporter
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Scrapes Cucumber *.feature files to build report on tag usage
+summary: Scrapes Cucumber *.feature files to build reports on tag usage and test inventory
 test_files: []
 

data/lib/cuporter/formatters/writer.rb

@@ -1,14 +0,0 @@
-# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
-
-module Cuporter
-  module Formatters
-    class Writer
-
-      def initialize(report, output, number_scenarios)
-        @report = report
-        @output = output ? File.open(output, "w") : STDOUT
-        @number_scenarios = number_scenarios
-      end
-    end
-  end
-end

data/lib/cuporter/tag_report.rb

@@ -1,24 +0,0 @@
-# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
-module Cuporter
-  class TagReport
-
-    def initialize(input_file_pattern)
-      @input_file_pattern = input_file_pattern || "features/**/*.feature"
-    end
-
-    def files
-      Dir[@input_file_pattern].collect {|f| File.expand_path f}
-    end
-
-    def scenarios_per_tag
-      tags = TagListNode.new("report",[])
-      files.each do |file|
-        feature = FeatureParser.parse(file)
-        tags.merge(feature) if feature
-      end
-      tags.sort_all_descendants!
-      tags
-    end
-
-  end
-end