cuporter 0.3.2 → 0.3.3

data/lib/cuporter/document.rb

@@ -0,0 +1,23 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+module Cuporter
+  module Document
+
+    def self.new_xml
+      doc =  Nokogiri::XML::Document.new
+      doc << Nokogiri::XML::Node.new('xml', doc)
+      doc.root << Nokogiri::XML::Node.new('body', doc)
+      doc
+    end
+
+    def self.new_html(view)
+      Nokogiri::XML::Document.send(:include, Cuporter::Document::Html)
+      doc =  Nokogiri::XML::Document.new
+      doc.view = view
+      root = Nokogiri::XML::Node.new('html', doc)
+      root.create_internal_subset( 'html', "-//W3C//DTD XHTML 1.0 Strict//EN", "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd")
+      doc << root
+      doc
+    end
+
+  end
+end

data/lib/cuporter/document/html_document.rb

@@ -0,0 +1,82 @@
+# Copyright 2011 ThoughtWorks, Inc. Licensed under the MIT License
+module Cuporter
+  module Document
+    module Html
+      attr_accessor :view
+
+      def add_report(node)
+        root << head(node['title'])
+        body = new_node('body')
+        body << node
+        root << body
+      end
+
+      # remove CDATA tags so CSS works
+      def to_html(options = {})
+        to_xhtml(options).gsub(/(<!\[CDATA\[|\]\]>)/,'')
+      end
+
+      private
+
+      def head(title_text)
+        h = new_node(:head)
+        title = new_node(:title)
+        title.content = title_text
+        h << title
+
+        case view
+        when "tree"
+          h << link_js("jquery-min.js")
+          h << link_js("jquery.treeview.js")
+          h << link_css("jquery.treeview.css")
+          h << link_js("treeview-loader.js")
+          h << link_css("cuporter.css")
+          h << link_css("#{view}_style.css")
+        else
+          h << script_js("jquery-min.js")
+          h << style_css("cuporter.css")
+          h << style_css("#{view}_style.css")
+          h << script_js("expand-collapse.js")
+        end
+        h
+      end
+
+      def assets_dir
+        @assets_dir ||= File.expand_path('public', File.dirname(__FILE__) + "/../../../")
+      end
+
+      def style_css(file)
+        style = new_node('style', 'type' => 'text/css')
+        style << file_contents("#{assets_dir}/stylesheets/#{file}")
+        style
+      end
+
+      def script_js(file)
+        script = new_node('script', 'type' => 'text/javascript')
+        script << file_contents("#{assets_dir}/javascripts/#{file}")
+        script
+      end
+
+      def link_css(file)
+        new_node('link', 'type' => 'text/css', 'rel' => 'stylesheet', 'href' => "#{assets_dir}/stylesheets/#{file}")
+      end
+
+      def link_js(file)
+        new_node('script', 'type' => 'text/javascript', 'src' => "#{assets_dir}/javascripts/#{file}")
+      end
+
+      def file_contents(file_name)
+        create_cdata("\n#{File.read(file_name)}")
+      end
+
+      def new_node(name, attributes = {})
+        n = Nokogiri::XML::Node.new(name.to_s, self)
+        attributes.each do | attr, value |
+          n[attr.to_s] = value.to_s
+        end
+        n
+      end
+    end
+  end
+end
+

data/lib/cuporter/extensions/nokogiri.rb

@@ -0,0 +1,46 @@
+# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
+require 'rubygems'
+require 'nokogiri'
+Nokogiri::XML::Node.class_eval do
+  # undefine the spaceship (comparison operator used by sort)
+  # so our mixed-in versions get used.
+  remove_method :<=>
+end
+
+module NodeSetExtensions
+  def sort
+    return self if empty?
+    sorted = to_a.sort
+    self.class.new(document, sorted)
+  end
+
+  # value equivalence
+  def eql?(other)
+    return false unless other.is_a?(Nokogiri::XML::NodeSet)
+    return false unless length == other.length
+    each_with_index do |node, i|
+      return false unless node.eql?(other[i])
+    end
+    true
+  end
+end
+Nokogiri::XML::NodeSet.send(:include, NodeSetExtensions)
+
+module DocumentExtensions
+
+  def to_html(options = {})
+    to_xml(options)
+  end
+
+  def add_report(report_node)
+    root.at(:body) << report_node
+  end
+
+  def add_filter_summary(filter)
+    return if filter.empty?
+    s = Cuporter::Node.new_node(:FilterSummary, self)
+    s.add(filter)
+    root.at(:body) << s
+  end
+end
+Nokogiri::XML::Document.send(:include, DocumentExtensions)

data/lib/cuporter/feature_parser.rb

@@ -2,21 +2,30 @@
 
 module Cuporter
   class FeatureParser
-    FEATURE_LINE          = /^\s*(Feature:[^#]+)/
+    FEATURE_LINE          = /^\s*(Feature:[^#]*)/
     TAG_LINE              = /^\s*(@\w.+)/
-    SCENARIO_LINE         = /^\s*(Scenario:[^#]+)$/
-    SCENARIO_OUTLINE_LINE = /^\s*(Scenario Outline:[^#]+)$/
+    SCENARIO_LINE         = /^\s*(Scenario:[^#]*)$/
+    SCENARIO_OUTLINE_LINE = /^\s*(Scenario Outline:[^#]*)$/
     SCENARIO_SET_LINE     = /^\s*(Scenarios:[^#]*)$/
     EXAMPLE_SET_LINE      = /^\s*(Examples:[^#]*)$/
     EXAMPLE_LINE          = /^\s*(\|.*\|)\s*$/
+    PY_STRING_LINE        = /^\s*"""\s*$/
 
-    def self.tag_list(file)
-      TagListParser.new(file).parse_feature
+    # adds a node to the doc for each cucumber '@' tag, populated with features and
+    # scenarios
+    def self.tag_nodes(file, report, filter, root_dir)
+      parser = TagNodesParser.new(file, report, filter)
+      parser.root = root_dir
+      parser.parse_feature
     end
 
-    def self.name_list(file, filter)
-      NameListParser.new(file, filter).parse_feature
+    # returns a feature node populated with scenarios
+    def self.node(file, doc, filter, root_dir)
+      parser = NodeParser.new(file, doc, filter)
+      parser.root = root_dir
+      parser.parse_feature
     end
+    attr_writer :root
 
     def initialize(file)
       @file = file
@@ -24,36 +33,46 @@ module Cuporter
       @lines = File.read(@file).split(/\n/)
     end
 
+    def file_relative_path
+      @file_relative_path ||= @file.sub(/^.*#{@root}\//,"#{@root}/")
+    end
+
     def parse_feature
+      @open_comment_block = false
+
       @lines.each do |line|
+        next if @open_comment_block && line !~ PY_STRING_LINE
+
         case line
-        when FeatureParser::TAG_LINE
+        when PY_STRING_LINE
+          # toggle, to declare the multiline comment 'heredoc' open or closed
+          @open_comment_block = !@open_comment_block
+        when TAG_LINE
           # may be more than one tag line
           @current_tags |= $1.strip.split(/\s+/)
-        when FeatureParser::FEATURE_LINE
-          @feature = new_feature_node($1)
-          @feature.file = @file.sub(/^.*features\//,"features/")
+        when FEATURE_LINE
+          @feature = new_feature_node($1.strip, file_relative_path)
           @current_tags = []
-        when FeatureParser::SCENARIO_LINE
+        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
 
-          handle_scenario_line($1)
+          handle_scenario_line($1.strip)
           @current_tags = []
-        when FeatureParser::SCENARIO_OUTLINE_LINE
+        when SCENARIO_OUTLINE_LINE
           # ... another is when we hit a subsequent "Scenario Outline:"
           close_scenario_outline
 
-          @scenario_outline  = new_scenario_outline_node($1)
+          @scenario_outline  = new_scenario_outline_node($1.strip)
           @current_tags = []
-        when FeatureParser::EXAMPLE_SET_LINE, FeatureParser::SCENARIO_SET_LINE
+        when EXAMPLE_SET_LINE, SCENARIO_SET_LINE
           handle_example_set_line if @example_set
 
-          @example_set = new_example_set_node($1)
+          @example_set = new_example_set_node($1.strip)
           @current_tags = []
-        when @example_set && FeatureParser::EXAMPLE_LINE
-          @example_set.add_child(Node.new($1))
+        when @example_set && EXAMPLE_LINE
+          new_example_line($1.strip)
         end
       end
 

data/lib/cuporter/filter.rb

@@ -26,6 +26,7 @@ module Cuporter
       unless none.empty?
         pass = false if !(other_tags & none).empty?
       end
+
       pass
     end
 

data/lib/cuporter/formatters/csv.rb

@@ -0,0 +1,69 @@
+# Copyright 2011 ThoughtWorks, Inc. Licensed under the MIT License
+module Cuporter
+  module Formatters
+
+    module Csv
+      extend Util
+      extend NodeFormatters
+
+      COMMA  = ","
+      
+      def tab_stop
+        @@tab_stop ||= COMMA
+      end
+
+      def total_column_spacer
+        @@total_column_spacer ||= Cuporter.options[:total] ? tab_stop : ""
+      end
+
+      def total_column
+        @@total_column ||= total_column_spacer
+      end
+
+      def total(node)
+        t = node['total'] ? "[#{node['total']}]," : COMMA
+        "#{tab_stop * depth(node)}#{t}"
+      end
+
+      def number(node)
+        n = node['number'] ? "#{node['number']})," : COMMA
+        "#{tab_stop * depth(node)}#{n}"
+      end
+
+      def blank_for_number(node)
+        "#{tab_stop * depth(node)},"
+      end
+
+      def cuke_name(value)
+        "#{value},"
+      end
+
+      def fs_name(value)
+        "#{value.upcase},"
+      end
+
+      def tags(value)
+        return "" unless value
+        "#{value},"
+      end
+
+      def file_path(value, length = nil)
+        return "" unless value
+        "#{value},"
+      end
+
+      def title(value)
+        return "" unless value
+        "#{value},"
+      end
+
+      def example_name(name)
+        name.sub!(/^\s*\|/, '')
+        name.sub!(/\|\s*$/, '')
+        name.gsub(/\|/,";")
+      end
+
+      extend(Cuporter::Formatters::Csv)
+    end
+  end
+end

data/lib/cuporter/formatters/text.rb

@@ -0,0 +1,166 @@
+# Copyright 2011 ThoughtWorks, Inc. Licensed under the MIT License
+module Cuporter
+  module Formatters
+
+    module Util
+      def terminal_width
+        @@terminal_width ||= (`tput cols` || 120).to_i
+      end
+
+      def depth(node)
+        node.parent.path.sub(/^.*\/report/, 'report').split('/').size#- 2
+      end
+
+    end
+
+    module NodeFormatters
+      def report(l, node)
+        return l unless Cuporter.options[:text_summary]
+        l += total(node)
+        l += cuke_name(node['cuke_name'])
+        l += title(node['title'])
+        l
+      end
+      def dir(l, node)
+        l += total(node)
+        l += fs_name(node['fs_name'])
+        l
+      end
+      def file(l, node)
+        l += total(node)
+        l += fs_name(node['fs_name'])
+        l
+      end
+      def tag(l, node)
+        l += total(node)
+        l += cuke_name(node['cuke_name'])
+        l
+      end
+      def feature(l, node)
+        l += total(node)
+        l += cuke_name(node['cuke_name'])
+        l += tags(node['tags'])
+        l += file_path(node['file_path'], l.size)
+        l
+      end
+      def scenario(l, node)
+        l += total_column_spacer
+        l += number(node)
+        l += cuke_name(node['cuke_name'])
+        l += tags(node['tags'])
+        l
+      end
+      def scenario_outline(l, node)
+        l += total(node)
+        l += cuke_name(node['cuke_name'])
+        l += tags(node['tags'])
+        l
+      end
+      def examples(l, node)
+        l += total_column_spacer
+        l += normal_indent(node)
+        l += cuke_name(node['cuke_name'])
+        l += tags(node['tags'])
+        l
+      end
+      def example_header(l, node)
+        l += total_column_spacer
+        l += blank_for_number(node)
+        l += example_name(node['cuke_name'])
+        l += tags(node['tags'])
+        l
+      end
+      def example(l, node)
+        l += total_column_spacer
+        l += number(node)
+        l += example_name(node['cuke_name'])
+        l += tags(node['tags'])
+        l
+      end
+
+      def build_line(node)
+        l = send(node.name.to_sym, "", node)
+        l += "\n" unless l.empty?
+        l
+      rescue NoMethodError
+        ""
+      end
+    end
+    module Text
+      extend Util
+      extend NodeFormatters
+      
+
+      SPACER  = " "
+      def tab_stop
+        @@tab_stop ||= SPACER * 2
+      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: ""
+      end
+
+      def total(node)
+        format_number(node, 'total') do |indent_length, value|
+          "[#{value}]".ljust(total_column.size, SPACER)
+        end
+      end
+
+      def number(node)
+        format_number(node, 'number') do |indent_length, value|
+          "%#{tab_stop}#{indent_length}s " % "#{value}."
+        end
+      end
+
+      def format_number(node, attr)
+        d = depth(node)
+        indent_length = d * tab_stop.size
+        if ( value = node[attr])
+          yield(indent_length, value)
+        else
+          tab_stop * d
+        end
+      end
+      def blank_for_number(node)
+        l = tab_stop * depth(node)
+        l += SPACER if node.document.at("[@number]")
+        l
+      end
+      def cuke_name(value)
+        value || ""
+      end
+      def fs_name(value)
+        return "" unless value
+        value.upcase
+      end
+
+      def tags(value)
+        return "" unless value
+        "#{tab_stop * 2}#{value}"
+      end
+
+      def file_path(value, line_size)
+        return "" unless value
+        "#{tab_stop}##{value}#{tab_stop * 2}".rjust(terminal_width - line_size)
+      end
+
+      def title(value)
+        value || ""
+      end
+
+      def normal_indent(node)
+        tab_stop * depth(node)
+      end
+      
+      def example_name(value)
+        cuke_name value
+      end
+      extend(Cuporter::Formatters::Text)
+    end
+
+  end
+end