cuporter 0.2.8 → 0.2.9

data/README.textile

@@ -5,11 +5,13 @@ Scrapes your feature files and shows 2 possible reports:
 # scenarios and examples per tag
 ** in Feature and Scenario Outline context, as appropriate
 ** sorted alphbetically
-** optionally numbered, counting scenarios and outline examples per tag
+** 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
+** optionally numbered*, using 1 count of all scenarios and outline examples for the report
+
+<notextile>*</notextile> _HTML reports are always numbered._
 
 Either report may be formatted in HTML, CSV, or Pretty Text.
 

data/Rakefile

@@ -56,7 +56,7 @@ namespace :cuporter do
 
   spec = Gem::Specification.new do |s|
     s.name = 'cuporter'
-    s.version = '0.2.8'
+    s.version = '0.2.9'
     s.rubyforge_project = s.name
 
     s.platform = Gem::Platform::RUBY

data/bin/cuporter

@@ -7,11 +7,11 @@ filter_args = Cuporter::CLI::FilterArgsBuilder.new(Cuporter::CLI::Options[:tags]
 
 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])
+                                               Cuporter::CLI::Options[:output],
+                                               Cuporter::CLI::Options[:numbers])
 formatter.write

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

@@ -1,8 +1,7 @@
 # Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
 module Cuporter
   module Formatter
-    class Csv < Writer
-      include TextMethods
+    module CsvTextMethods
       
       def tab
         ","

data/lib/cuporter/formatter/html_node_writer.rb

@@ -12,13 +12,13 @@ module Cuporter
         @builder = Builder::XmlMarkup.new
       end
 
-      def write_nodes(report, number_scenarios)
-        report.report_node.children.each do |tag_node|
-          write_node(tag_node)
+        def write_nodes(report, number_scenarios)
+          report.report_node.number_all_descendants if number_scenarios
+          report.report_node.children.each do |child_node|
+            write_node(child_node)
+          end
+          builder
         end
-        builder
-      end
-
       def write_node(node)
         builder.li(:class => node_class(node.name)) do
           write_node_name(node)

data/lib/cuporter/formatter/name_report/csv.rb

@@ -0,0 +1,12 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+module Cuporter
+  module Formatter
+    module NameReport
+      class Csv < Writer
+        include TextMethods
+        include CsvTextMethods
+        include Cuporter::Formatter::NameReport::TextNodeWriter
+      end
+    end
+  end
+end

data/lib/cuporter/formatter/{name_report_html.rb → name_report/html.rb}

@@ -4,25 +4,26 @@ require 'erb'
 
 module Cuporter
   module Formatter
-    class NameReportHtml < Writer
-      include HtmlMethods
+    module NameReport
+      class Html < Writer
+        include HtmlMethods
 
-      def title
-        @report.title
-      end
+        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?
+        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
-      end
 
-      RHTML = %{
+        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>
@@ -50,13 +51,14 @@ module Cuporter
       </div>
     </div>
     <ul class="tag_list, name_report">
-      <%= HtmlNodeWriter.new.write_nodes(@report, @number_scenarios)%>
+      <%= Cuporter::Formatter::NameReport::HtmlNodeWriter.new.write_nodes(@report)%>
     </ul>
 </body>
 </html>
       }
 
 
+      end
     end
   end
 end

data/lib/cuporter/formatter/name_report/html_node_writer.rb

@@ -0,0 +1,18 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+
+module Cuporter
+  module Formatter
+    module NameReport
+      class HtmlNodeWriter < Cuporter::Formatter::HtmlNodeWriter
+
+        def write_nodes(report)
+          report.report_node.children.each do |child_node|
+            write_node(child_node)
+          end
+          builder
+        end
+
+      end
+    end
+  end
+end

data/lib/cuporter/formatter/name_report/text.rb

@@ -0,0 +1,16 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+module Cuporter
+  module Formatter
+    module NameReport
+      class Text < Writer
+        
+        COL_WIDTH = 6
+        MARGIN    = 4
+        include TextMethods
+        include PrettyTextMethods
+        include Cuporter::Formatter::NameReport::TextNodeWriter
+
+      end
+    end
+  end
+end

data/lib/cuporter/formatter/name_report/text_node_writer.rb

@@ -0,0 +1,16 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+module Cuporter
+  module Formatter
+    module NameReport
+      module TextNodeWriter
+
+        def write
+          @report.report_node.children.each do |child_node|
+            write_node(child_node, 0)
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,19 +1,17 @@
 # Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
 module Cuporter
   module Formatter
-    class Text < Writer
-      include TextMethods
+    module PrettyTextMethods
 
       def tab
         @tab ||= @number_scenarios ? "   " : "  "
       end
 
-      COL_WIDTH = 5
       def line(number, line)
         if @number_scenarios
           number_string = number ? "#{number}." : ""
-          number_field = number_string.rjust(COL_WIDTH, " ")
-          line.sub!(/^\s{#{COL_WIDTH}}/, number_field)
+          number_field = number_string.rjust(self.class::COL_WIDTH, " ")
+          line.insert(0, " " * self.class::MARGIN).sub!(/^\s{#{self.class::COL_WIDTH}}/, number_field)
         end
         line
       end

data/lib/cuporter/formatter/tag_report/csv.rb

@@ -0,0 +1,12 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+module Cuporter
+  module Formatter
+    module TagReport
+      class Csv < Writer
+        include TextMethods
+        include CsvTextMethods
+        include Cuporter::Formatter::TagReport::TextNodeWriter
+      end
+    end
+  end
+end

data/lib/cuporter/formatter/{tag_report_html.rb → tag_report/html.rb}

@@ -4,14 +4,15 @@ require 'erb'
 
 module Cuporter
   module Formatter
-    class TagReportHtml < Writer
-      include HtmlMethods
+    module TagReport
+      class Html < Writer
+        include HtmlMethods
 
-      def title
-        "Cucumber Tags"
-      end
+        def title
+          "Cucumber Tags"
+        end
 
-      RHTML = %{
+        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>
@@ -36,13 +37,14 @@ module Cuporter
           </div>
     </div>
     <ul class="tag_list">
-      <%= HtmlNodeWriter.new.write_nodes(@report, @number_scenarios)%>
+      <%= Cuporter::Formatter::TagReport::HtmlNodeWriter.new.write_nodes(@report)%>
     </ul>
 </body>
 </html>
       }
 
 
+      end
     end
   end
 end

data/lib/cuporter/formatter/tag_report/html_node_writer.rb

@@ -0,0 +1,19 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+
+module Cuporter
+  module Formatter
+    module TagReport
+      class HtmlNodeWriter < Cuporter::Formatter::HtmlNodeWriter
+
+        def write_nodes(report)
+          report.report_node.children.each do |tag_node|
+            tag_node.number_all_descendants
+            write_node(tag_node)
+          end
+          builder
+        end
+
+      end
+    end
+  end
+end

data/lib/cuporter/formatter/tag_report/text.rb

@@ -0,0 +1,14 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+module Cuporter
+  module Formatter
+    module TagReport
+      class Text < Writer
+        COL_WIDTH = 5
+        MARGIN    = 0
+        include TextMethods
+        include PrettyTextMethods
+        include Cuporter::Formatter::TagReport::TextNodeWriter
+      end
+    end
+  end
+end

data/lib/cuporter/formatter/tag_report/text_node_writer.rb

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

data/lib/cuporter/formatter/text_methods.rb

@@ -3,13 +3,6 @@ module Cuporter
   module Formatter
     module TextMethods
     
-      def write
-        @report.report_node.children.each do |tag_node|
-          tag_node.number_all_descendants if @number_scenarios
-          write_node(tag_node, 0)
-        end
-      end
-
       def write_node(node, tab_stops)
         @output.puts line(node.number, "#{tab * tab_stops}#{node.name}")
         node.children.each do |child|

data/lib/cuporter/formatter/writer.rb

@@ -4,25 +4,29 @@ module Cuporter
   module Formatter
     class Writer
 
-      def initialize(report, output)
+      attr_reader :number_scenarios
+
+      def initialize(report, output, number_scenarios)
         @report = report
         @output = output ? File.open(output, "w") : STDOUT
+        @number_scenarios = number_scenarios
       end
 
-      def self.create(format, report, output)
+      def self.create(format, report, output, number_scenarios)
         klass = writer_class(format, report.class.name.split(/::/).last)
-        klass.new(report, output)
+        klass.new(report, output, number_scenarios)
       end
 
       def self.writer_class(format, report_class)
-        case format
-        when /text|pretty/i
-          Cuporter::Formatter::Text
+        fmt = case format
+        when /text|pretty/i 
+          "Text"
         when /csv/i
-          Cuporter::Formatter::Csv
+          "Csv"
         when /html/i
-          Cuporter::Formatter.const_get("#{report_class}Html")
+          "Html"
         end
+        Cuporter::Formatter.const_get(report_class).const_get(fmt)
       end
     end
   end

data/lib/cuporter/node.rb

@@ -25,15 +25,6 @@ module Cuporter
       children.collect {|c| c.name }
     end
 
-    def find_or_create_child(name)
-      child_node = self[name]
-      unless child_node
-        children << Node.new(name)
-        child_node = children.last
-      end
-      child_node
-    end
-
     def find_by_name(name)
       children.find {|c| c.name == name.to_s}
     end

data/lib/cuporter/report/name_report.rb

@@ -11,7 +11,7 @@ module Cuporter
         end
       end
       names.sort_all_descendants!
-      names.number_all_descendants if number_scenarios
+      names.number_all_descendants
       names
     end
 

data/lib/cuporter/report/report.rb

@@ -2,11 +2,10 @@
 module Cuporter
   class Report
 
-    attr_reader :number_scenarios, :filter, :title
+    attr_reader :filter, :title
 
-    def initialize(input_file_pattern, number_scenarios, filter_args = nil, title = nil)
+    def initialize(input_file_pattern, filter_args = nil, title = nil)
       @input_file_pattern = input_file_pattern
-      @number_scenarios = number_scenarios
       @filter = Filter.new(filter_args || {})
       @title = title
     end
@@ -15,9 +14,9 @@ module Cuporter
       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)
+    def self.create(type, input_file_pattern, 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)
+      klass.new(input_file_pattern, filter_args, title)
     end
   end
 end

data/lib/cuporter/report/tag_report.rb

@@ -9,7 +9,6 @@ module Cuporter
         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
 

data/lib/cuporter/tag_list_node.rb

@@ -41,5 +41,14 @@ module Cuporter
       end
     end
 
+    def find_or_create_child(name)
+      child_node = self[name]
+      unless child_node
+        children << Node.new(name)
+        child_node = children.last
+      end
+      child_node
+    end
+
   end
 end

data/lib/cuporter.rb

@@ -15,9 +15,17 @@ 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/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/name_report_html'
+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'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cuporter
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: false
   segments: 
   - 0
   - 2
-  - 8
-  version: 0.2.8
+  - 9
+  version: 0.2.9
 platform: ruby
 authors: 
 - Tim Camper
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-27 00:00:00 -04:00
+date: 2010-09-28 00:00:00 -04:00
 default_executable: cuporter
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,14 +49,22 @@ files:
 - Rakefile
 - lib/cuporter/name_list.rb
 - lib/cuporter/example_set_node.rb
-- lib/cuporter/formatter/csv.rb
-- lib/cuporter/formatter/text.rb
+- lib/cuporter/formatter/tag_report/csv.rb
+- lib/cuporter/formatter/tag_report/text_node_writer.rb
+- lib/cuporter/formatter/tag_report/text.rb
+- lib/cuporter/formatter/tag_report/html_node_writer.rb
+- lib/cuporter/formatter/tag_report/html.rb
+- lib/cuporter/formatter/pretty_text_methods.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/csv_text_methods.rb
 - lib/cuporter/formatter/writer.rb
 - lib/cuporter/formatter/text_methods.rb
+- lib/cuporter/formatter/name_report/csv.rb
+- lib/cuporter/formatter/name_report/text_node_writer.rb
+- lib/cuporter/formatter/name_report/text.rb
+- lib/cuporter/formatter/name_report/html_node_writer.rb
+- lib/cuporter/formatter/name_report/html.rb
 - lib/cuporter/tag_list.rb
 - lib/cuporter/report/report.rb
 - lib/cuporter/report/name_report.rb