cuporter 0.3.2 → 0.3.3

data/lib/cuporter/node/numbering.rb

@@ -0,0 +1,32 @@
+# Copyright 2011 ThoughtWorks, Inc. Licensed under the MIT License
+module Cuporter
+  module Node
+    module Numbering
+      class Numberer
+
+        attr_reader :total
+
+        def initialize
+          @total = 0
+        end
+
+        def number(node)
+          node.children.each do |child|
+            case child.node_name
+            when 'scenario', 'example'
+              child["number"] = (@total += 1).to_s
+            end
+            number(child)
+          end
+        end
+
+      end
+
+      def number_all_descendants
+        @numberer = Numberer.new
+        @numberer.number(self)
+      end
+
+    end
+  end
+end

data/lib/cuporter/node/sorting.rb

@@ -0,0 +1,27 @@
+# Copyright 2011 ThoughtWorks, Inc. Licensed under the MIT License
+module Cuporter
+  module Node
+
+    module Sorting
+      include Comparable
+
+      def sort_all_descendants!
+        sort!
+        children.each {|child| child.sort_all_descendants! }
+      end
+
+      # see #NodeSetExtensions in extensions/nokogiri.rb
+      def sort!
+        return unless has_children?
+        sorted_children = children.sort
+        self.children = sorted_children
+      end
+
+      def <=>(other)
+        (short_cuke_name || name) <=> (other.short_cuke_name || other.name)
+      end
+
+    end
+
+  end
+end

data/lib/cuporter/node/tagged_node.rb

@@ -0,0 +1,22 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+module Cuporter
+  module Node
+    # a node with a list of tags that can be applied to all children
+    module Tagged
+
+      attr_accessor :filter
+
+      def has_tags?
+        tags.size > 0
+      end
+      def tags
+        @tags ||= attributes["tags"].to_s.split(/,\s*/) || []
+      end
+      def filter_child(node, context_tags = [])
+        add_child(node) if @filter.pass?(context_tags | tags | node.tags)
+      end
+
+    end
+
+  end
+end

data/lib/cuporter/node/totalling.rb

@@ -0,0 +1,19 @@
+# Copyright 2011 ThoughtWorks, Inc. Licensed under the MIT License
+module Cuporter
+  module Node
+
+    module Totalling
+      def total
+        total!
+        children.each {|child| child.total }
+      end
+
+      def total!
+        t = search("scenario,example").size
+        self["total"] = t.to_s if t > 0
+        nil
+      end
+    end
+
+  end
+end

data/lib/cuporter/node/types.rb

@@ -0,0 +1,158 @@
+# Copyright 2011 ThoughtWorks, Inc. Licensed under the MIT License
+module Cuporter
+  module Node
+    module Types
+      class Report < NodeBase
+        def tag_node(tag)
+          at("tag[cuke_name='#{tag}']")
+        end
+
+        # remove leaf nodes, i.e., the scenario and scenario outline children
+        def defoliate!
+          leaves = search("feature > scenario, feature > scenario_outline")
+          leaves.remove
+        end
+
+        def remove_files!
+          search(:feature).each {|f| f.delete('file_path') }
+        end
+
+        def remove_tags!
+          search("*[@tags]").each {|e| e.delete('tags') }
+        end
+      end
+
+      class FilterSummary < NodeBase
+        def add(filter)
+          self << filter_node(:all, filter.all.join(' AND ')) unless filter.all.empty?
+          self << filter_node(:any, filter.any.join(' OR ')) unless filter.any.empty?
+          self << filter_node(:none, filter.none.join(', ')) unless filter.none.empty?
+        end
+
+        def filter_node(name, text)
+          fn = NodeBase.new(name.to_s, document)
+          fn['tags'] = text
+          fn
+        end
+
+      end
+
+      module FileSystemNode
+        def fs_name
+          @fs_name ||= self['fs_name']
+        end
+      end
+
+      class Dir < NodeBase
+        include FileSystemNode
+
+        def <=>(other)
+          return -1 if other.is_a? File  # ensure folders sort higher
+          fs_name <=> (other['fs_name'] || other['cuke_name'])
+        end
+
+      end
+
+      class File < NodeBase
+        include FileSystemNode
+
+        # just total self, don't let any children total themselves.  This is so
+        # the feature won't re-total itself when its containing file already has.
+        def total
+          total!
+        end
+
+        def <=>(other)
+          return 1 if other.is_a? Dir # ensure folders sort higher
+          fs_name <=> (other['fs_name'] || other['cuke_name'])
+        end
+      end
+
+      class Tag < NodeBase
+        def feature_node(feature)
+          at("feature[cuke_name='#{feature[:cuke_name]}'][file_path='#{feature[:file_path]}']")
+        end
+      end
+
+      class ScenarioOutline < NodeBase
+        include Tagged
+
+        def example_set_node(es)
+          at("examples[cuke_name='#{es[:cuke_name]}']")
+        end
+
+      end
+
+      class Feature < NodeBase
+        include Tagged
+
+        def scenario_outline_node(scenario_outline)
+          at("scenario_outline[cuke_name='#{scenario_outline[:cuke_name]}']")
+        end
+
+        def file_path
+          self["file_path"]
+        end
+
+        def file_name
+          file_path.split(/\//).last
+        end
+
+        # sort on: file path, name, substring of name after any ':'
+        def <=>(other)
+          if other.respond_to?(:file_path)
+            file_path <=> other.file_path
+          else
+            super(other)
+          end
+        end
+
+        def eql?(other)
+          if other.respond_to? :file_path
+            return false if file_path != other.file_path
+          end
+          super(other)
+        end
+      end
+
+      # The set of examples in a scenario outline
+      class Examples < NodeBase
+        include Tagged
+
+        # don't sort scenario outline examples
+        def sort!
+          # no op
+        end
+
+        # don't total at the example set level
+        def total
+          # no op
+        end
+
+        def add_child(other)
+          cn = other['cuke_name'].dup
+          cn.sub!(/^\|/, '')
+          cn.split('|').each do |cell_text|
+            cell = Nokogiri::XML::Node.new("span", document)
+            cell.content = cell_text.strip
+            other << cell
+          end
+          super(other)
+        end
+      end
+      Scenarios = Examples
+
+      # Leaf Nodes: won't have children
+      class Scenario < NodeBase
+        include Tagged
+      end
+
+      class Example < NodeBase
+      end
+
+      class ExampleHeader < NodeBase
+      end
+    end
+  end
+end
+

data/lib/cuporter/node_parser.rb

@@ -0,0 +1,62 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+
+module Cuporter
+  class NodeParser < FeatureParser
+
+    # ++sub_expression++ is the paren group in the regex, dereferenced with $1 in the caller
+    def new_feature_node(sub_expression, file)
+      f = Node.new_node(:Feature, @doc, :cuke_name => sub_expression, :tags => @current_tags, :file_path => file)
+      f.filter = @filter
+      f
+    end
+
+    def handle_scenario_line(sub_expression)
+      if @filter.pass?(@current_tags | @feature.tags)
+        @feature.add_child(Node.new_node(:Scenario, @doc, :cuke_name => sub_expression, :tags => @current_tags))
+      end
+    end
+
+    def new_scenario_outline_node(sub_expression)
+      so = Node.new_node(:ScenarioOutline, @doc, :cuke_name => sub_expression, :tags => @current_tags)
+      so.filter = @filter
+      so
+    end
+
+    def handle_example_set_line
+      if @filter.pass?(@feature.tags | @scenario_outline.tags | @example_set.tags)
+        @scenario_outline.add_child @example_set
+      end
+    end
+
+    def new_example_set_node(sub_expression)
+      es = Node.new_node(:Examples, @doc, :cuke_name => sub_expression, :tags => @current_tags)
+      es.filter = @filter
+      es
+    end
+
+    def new_example_line(sub_expression)
+      example_type = :ExampleHeader
+      # if the example set has a child already, then it must be the header
+      example_type = :Example if @example_set.has_children?
+      @example_set.add_child(Node.new_node(example_type, @doc, :cuke_name => sub_expression))
+    end
+
+    def close_scenario_outline
+      if @scenario_outline
+        if @example_set
+          handle_example_set_line
+          @example_set = nil
+        end
+        @feature.add_child(@scenario_outline) if @scenario_outline.has_children?
+        @scenario_outline = nil
+      end
+    end
+
+    def initialize(file, doc, filter)
+      super(file)
+      @filter = filter
+      @doc = doc
+    end
+
+  end
+end

data/lib/cuporter/report/feature_report.rb

@@ -0,0 +1,23 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+module Cuporter
+  class FeatureReport < ReportBase
+
+    def report_node
+      unless @report
+        @report = Cuporter::Node.new_node(:Report, @doc, :title => title, :view => view)
+        files.each do |file|
+          feature = FeatureParser.node(file, @doc, @filter, root_dir)
+          if feature && feature.has_children?
+            @report.add_child feature
+          end
+        end
+      end
+      @report
+    end
+
+    def title
+      @title || "Cucumber Features, List View"
+    end
+
+  end
+end

data/lib/cuporter/report/report_base.rb

@@ -0,0 +1,69 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+module Cuporter
+  class ReportBase
+
+    attr_reader :filter, :doc, :root_dir, :view
+
+    def initialize(options)
+      @input_file_pattern = options[:input_file_pattern]
+      @doc                = Cuporter::Document.new_xml
+      @view               = options[:report]
+      @root_dir           = options[:root_dir]
+      @filter             = Filter.new(options[:filter_args])
+      @title              = options[:title]
+      @sort               = options[:sort]
+      @total              = options[:total]
+      @number             = options[:number]
+      @leaves             = options[:leaves]
+      @show_files         = options[:show_files]
+      @show_tags          = options[:show_tags]
+    end
+
+    def no_leaves?
+      !@leaves
+    end
+
+    def sort?
+      @sort
+    end
+
+    def total?
+      @total
+    end
+
+    def number?
+      @number
+    end
+
+    def show_files?
+      @show_files
+    end
+
+    def show_tags?
+      @show_tags
+    end
+
+    def files
+      Dir[@input_file_pattern].collect {|f| File.expand_path f}
+    end
+
+    def self.create(options)
+      klass = Cuporter.const_get("#{options[:report].downcase}Report".to_class_name)
+      klass.new(options)
+    end
+
+    def build
+      report_node.sort_all_descendants!  if sort?
+      report_node.number_all_descendants if number?
+      report_node.total                  if total?
+      report_node.defoliate!             if no_leaves?
+      report_node.remove_files!          unless show_files?
+      report_node.remove_tags!           unless show_tags?
+
+      doc.add_filter_summary(@filter)
+      doc.add_report report_node
+      self
+    end
+
+  end
+end

data/lib/cuporter/report/tag_report.rb

@@ -1,15 +1,35 @@
 # Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
 module Cuporter
-  class TagReport < Report
+  class TagReport < ReportBase
 
-    def report_node
-      tags = TagListNode.new("report",[])
+    def build_report_node
       files.each do |file|
-        feature = FeatureParser.tag_list(file)
-        tags.merge_tag_nodes(feature) if feature
+        FeatureParser.tag_nodes(file, report, @filter, root_dir)
       end
-      tags.sort_all_descendants!
-      tags
+    end
+
+    def report
+      @report ||= begin
+                    r = Cuporter::Node.new_node(:Report, doc, :title => title, :view => view)
+                    doc.add_filter_summary(@filter)
+                    doc.add_report r
+                    r
+                  end
+    end
+
+    def title
+      @title || "Cucumber Tags"
+    end
+
+    def build
+      build_report_node
+      report.sort_all_descendants!                             if sort?
+      report.search(:tag).each {|f| f.number_all_descendants } if number?
+      report.total                                             if total?
+      report.defoliate!                                        if no_leaves?
+      report.remove_files!                                     unless show_files?
+      report.remove_tags!                                      unless show_tags?
+      self
     end
 
   end