cuporter 0.3.2 → 0.3.3

data/lib/cuporter/formatters/xml_to_html.xslt

@@ -0,0 +1,315 @@
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
+  <xsl:output method="xml" indent="yes" />
+
+  <xsl:template match="/">
+    <xsl:apply-templates select="//report"/>
+  </xsl:template>
+
+  <xsl:template match="report">
+    <xsl:element name="div">
+      <xsl:attribute name="class">report</xsl:attribute>
+      <xsl:attribute name="title"><xsl:value-of select="@title"/></xsl:attribute>
+      <xsl:call-template name="cuporter_header"/> 
+      <xsl:element name="ul">
+        <xsl:attribute name="class">children</xsl:attribute>
+        <xsl:apply-templates select="./tag | ./dir | ./feature"/>
+      </xsl:element>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template name="cuporter_header">
+    <xsl:element name="div">
+      <xsl:attribute name="class">cuporter_header</xsl:attribute>
+
+      <xsl:apply-templates select="../filter_summary"/>
+
+      <xsl:element name="div">
+        <xsl:attribute name="id">summary</xsl:attribute>
+        <xsl:choose>
+          <xsl:when test="@view='tag'">
+            <xsl:element name="div">
+              <xsl:attribute name="id">expand-collapse</xsl:attribute>
+              <xsl:element name="p">
+                <xsl:attribute name="id">expand_tags</xsl:attribute>
+                <xsl:text>Expand Tags</xsl:text> 
+              </xsl:element>
+              <xsl:element name="p">
+                <xsl:attribute name="id">expand_all</xsl:attribute>
+                <xsl:text>Expand Features</xsl:text> 
+              </xsl:element>
+              <xsl:element name="p">
+                <xsl:attribute name="id">collapser</xsl:attribute>
+                <xsl:text>Collapse All</xsl:text> 
+              </xsl:element>
+            </xsl:element>
+          </xsl:when>
+          <xsl:when test="@view='tree'">
+            <xsl:element name="p">
+              <xsl:attribute name="id">total</xsl:attribute>
+              <xsl:value-of select="@total"/>
+              <xsl:text> Scenarios</xsl:text> 
+            </xsl:element>
+            <xsl:element name="div">
+              <xsl:attribute name="id">expand-collapse</xsl:attribute>
+              <xsl:element name="a">
+                <xsl:attribute name="href">?#</xsl:attribute>
+                <xsl:attribute name="id">collapse_features</xsl:attribute>
+                <xsl:text>Collapse All</xsl:text> 
+              </xsl:element>
+              <xsl:element name="a">
+                <xsl:attribute name="href">?#</xsl:attribute>
+                <xsl:attribute name="id">expand_features</xsl:attribute>
+                <xsl:text>Expand All</xsl:text> 
+              </xsl:element>
+            </xsl:element>
+          </xsl:when>
+          <xsl:otherwise>
+            <xsl:element name="p">
+              <xsl:attribute name="id">total</xsl:attribute>
+              <xsl:value-of select="@total"/>
+              <xsl:text> Scenarios</xsl:text> 
+            </xsl:element>
+            <xsl:element name="div">
+              <xsl:attribute name="id">expand-collapse</xsl:attribute>
+              <xsl:element name="p">
+                <xsl:attribute name="id">collapse_features</xsl:attribute>
+                <xsl:text>Collapse All</xsl:text> 
+              </xsl:element>
+              <xsl:element name="p">
+                <xsl:attribute name="id">expand_features</xsl:attribute>
+                <xsl:text>Expand All</xsl:text> 
+              </xsl:element>
+            </xsl:element>
+          </xsl:otherwise>
+        </xsl:choose>
+      </xsl:element>
+
+      <xsl:element name="div">
+        <xsl:attribute name="id">label</xsl:attribute>
+        <xsl:element name="h1">
+          <xsl:value-of select="@title"/>
+        </xsl:element>
+      </xsl:element>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template match="filter_summary">
+    <xsl:element name="div">
+      <xsl:attribute name="id">filter_summary</xsl:attribute>
+      <xsl:element name="span">Filtering:</xsl:element>
+      <xsl:apply-templates select="all | any | none"/>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template match="all">
+    <xsl:element name="p">
+      <xsl:attribute name="class">all</xsl:attribute>
+      <xsl:text>Include: </xsl:text>
+      <xsl:value-of select="@tags"/>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template match="any">
+    <xsl:element name="p">
+      <xsl:attribute name="class">any</xsl:attribute>
+      <xsl:text>Include: </xsl:text>
+      <xsl:value-of select="@tags"/>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template match="none">
+    <xsl:element name="p">
+      <xsl:attribute name="class">none</xsl:attribute>
+      <xsl:text>Exclude: </xsl:text>
+      <xsl:value-of select="@tags"/>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template match="tag">
+    <xsl:element name="li">
+      <xsl:attribute name="class">tag</xsl:attribute>
+      <xsl:element name="div">
+        <xsl:attribute name="class">properties</xsl:attribute>
+        <xsl:apply-templates select="@cuke_name"/>
+        <xsl:apply-templates select="@total"/>
+      </xsl:element>
+
+      <xsl:element name="ul">
+        <xsl:attribute name="class">children</xsl:attribute>
+        <xsl:apply-templates select="feature"/>
+      </xsl:element>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template match="dir">
+    <xsl:element name="li">
+      <xsl:attribute name="class">dir</xsl:attribute>
+      <xsl:element name="span">
+        <xsl:attribute name="class">properties</xsl:attribute>
+        <xsl:apply-templates select="@total"/>
+        <xsl:apply-templates select="@fs_name"/>
+      </xsl:element>
+
+      <xsl:element name="ul">
+        <xsl:attribute name="class">children</xsl:attribute>
+        <xsl:apply-templates select="./dir | ./file | ./feature"/>
+      </xsl:element>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template match="file">
+    <xsl:element name="li">
+      <xsl:attribute name="class">file</xsl:attribute>
+      <xsl:element name="span">
+        <xsl:attribute name="class">properties</xsl:attribute>
+        <xsl:apply-templates select="@total"/>
+        <xsl:apply-templates select="@fs_name"/>
+      </xsl:element>
+
+      <xsl:element name="ul">
+        <xsl:apply-templates select="./feature"/>
+      </xsl:element>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template match="feature">
+    <xsl:element name="li">
+      <xsl:attribute name="class">feature</xsl:attribute>
+      <xsl:element name="div">
+        <xsl:attribute name="class">properties</xsl:attribute>
+        <xsl:apply-templates select="@cuke_name"/>
+        <xsl:apply-templates select="@tags"/>
+        <xsl:apply-templates select="@file_path"/>
+        <xsl:apply-templates select="@total"/>
+      </xsl:element>
+
+      <xsl:if test="scenario | scenario_outline"> <!-- TODO:  remove this test if possible. seems redundant since we'll always have at least 1 child -->
+        <xsl:element name="ul">
+          <xsl:attribute name="class">children</xsl:attribute>
+          <xsl:apply-templates select="scenario | scenario_outline"/>
+        </xsl:element>
+      </xsl:if>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template match="scenario">
+    <xsl:element name="li">
+      <xsl:attribute name="class">scenario</xsl:attribute>
+      <xsl:element name="div">
+        <xsl:attribute name="class">properties</xsl:attribute>
+        <xsl:apply-templates select="@number"/>
+        <xsl:apply-templates select="@cuke_name"/>
+        <xsl:apply-templates select="@tags"/>
+      </xsl:element>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template match="scenario_outline">
+    <xsl:element name="li">
+      <xsl:attribute name="class">scenario_outline</xsl:attribute>
+      <xsl:element name="div">
+        <xsl:attribute name="class">properties</xsl:attribute>
+        <xsl:apply-templates select="@cuke_name"/>
+        <xsl:apply-templates select="@tags"/>
+      </xsl:element>
+      <xsl:element name="ul">
+        <xsl:attribute name="class">children</xsl:attribute>
+        <xsl:apply-templates select="examples"/>
+      </xsl:element>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template match="examples">
+    <xsl:element name="li">
+      <xsl:attribute name="class">examples</xsl:attribute>
+      <xsl:element name="div">
+        <xsl:attribute name="class">properties</xsl:attribute>
+        <xsl:apply-templates select="@cuke_name"/>
+        <xsl:apply-templates select="@tags"/>
+      </xsl:element>
+      <xsl:element name="table">
+        <xsl:attribute name="class">children</xsl:attribute>
+        <xsl:element name="thead">
+          <xsl:apply-templates select="example_header"/>
+        </xsl:element>
+        <xsl:element name="tbody">
+          <xsl:apply-templates select="example"/>
+        </xsl:element>
+      </xsl:element>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template match="@cuke_name">
+    <xsl:element name="span">
+      <xsl:attribute name="class">cuke_name</xsl:attribute>
+      <xsl:value-of select="."/>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template match="@fs_name">
+    <xsl:element name="span">
+      <xsl:attribute name="class">fs_name</xsl:attribute>
+      <xsl:value-of select="."/>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template match="@tags">
+    <xsl:element name="span">
+      <xsl:attribute name="class">tags</xsl:attribute>
+      <xsl:value-of select="."/>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template match="@file_path">
+    <xsl:element name="span">
+      <xsl:attribute name="class">file_path</xsl:attribute>
+      <xsl:value-of select="."/>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template match="@total">
+    <xsl:element name="span">
+      <xsl:attribute name="class">total</xsl:attribute>
+      <xsl:text>[</xsl:text>
+      <xsl:value-of select="format-number(.,'00')"/>
+      <xsl:text>]</xsl:text>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template match="@number">
+    <xsl:element name="span">
+      <xsl:attribute name="class">number</xsl:attribute>
+      <xsl:value-of select="."/>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template match="example_header">
+    <xsl:element name="tr">
+      <xsl:attribute name="class">example</xsl:attribute>
+      <xsl:element name="th"> <xsl:attribute name="class">number</xsl:attribute> </xsl:element>
+      <xsl:apply-templates select="span"/>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template match="example">
+    <xsl:element name="tr">
+      <xsl:attribute name="class">example</xsl:attribute>
+      <xsl:element name="td"> <xsl:attribute name="class">number</xsl:attribute> <xsl:value-of select="@number"/> </xsl:element>
+      <xsl:apply-templates select="span"/>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template match="example_header/span">
+    <xsl:element name="th">
+      <xsl:value-of select="."/>
+    </xsl:element>
+  </xsl:template>
+
+  <xsl:template match="example/span">
+    <xsl:element name="td">
+      <xsl:value-of select="."/>
+    </xsl:element>
+  </xsl:template>
+
+</xsl:stylesheet>
+

data/lib/cuporter/node.rb

@@ -1,83 +1,7 @@
-# Copyright 2010 ThoughtWorks, Inc. Licensed under the MIT License
-module Cuporter
-  class Node
-    include Comparable
-
-    attr_reader :name
-    attr_accessor :children, :number, :file
-
-
-    def initialize(name)
-      @name = name.to_s.strip
-      @children = []
-    end
-
-    def has_children?
-      @children.size > 0
-    end
-
-    # will not add duplicate
-    def add_child(node)
-      @children << node unless has_child?(node)
-    end
-
-    def names
-      children.collect {|c| c.name }
-    end
-
-    def find_by_name(name)
-      children.find {|c| c.name == name.to_s}
-    end
-    alias :[] :find_by_name
-
-    def find(node)
-      children.find {|c| c == node}
-    end
-    alias :has_child? :find
-    
-    def name_without_title
-      @name_without_title ||= name.split(/:\s+/).last
-    end
-
-    def sort_all_descendants!
-      sort!
-      children.each {|child| child.sort_all_descendants! }
-    end
-
-    def sort!
-      children.sort!
-    end
-
-    # sort on: file path, name, substring of name after any ':'
-    def <=>(other)
-      if file
-        file <=> other.file
-      else
-        name_without_title <=> other.name_without_title
-      end
-    end
-    
-    # value equivalence
-    def eql?(other)
-      name == other.name && children == other.children
-    end
-    alias :== :eql?
-
-
-    def total
-      number_all_descendants unless @numberer
-      @numberer.total
-    end
-
-    def number_all_descendants
-      @numberer = NodeNumberer.new
-      @numberer.number(self)
-    end
-
-    def numerable?
-      @numerable.nil? ? !has_children? : @numerable
-    end
-    attr_writer :numerable
-
-  end
-end
+# Copyright 2011 ThoughtWorks, Inc. Licensed under the MIT License
+require 'lib/cuporter/node/sorting'
+require 'lib/cuporter/node/totalling'
+require 'lib/cuporter/node/numbering'
+require 'lib/cuporter/node/node_base'
+require 'lib/cuporter/node/tagged_node'
+require 'lib/cuporter/node/types'

data/lib/cuporter/node/node_base.rb

@@ -0,0 +1,114 @@
+# Copyright 2011 ThoughtWorks, Inc. Licensed under the MIT License
+module Cuporter
+  module Node
+
+    module BaseMethods
+      include Sorting
+      include Totalling
+      include Numbering
+
+      def has_children?
+        children.size > 0
+      end
+
+      def names
+        children.collect {|c| c.name }
+      end
+
+      def cuke_names
+        children.collect {|c| c.cuke_name }
+      end
+
+      def cuke_name
+        @cuke_name ||= self['cuke_name'].to_s
+      end
+
+      def find(node)
+        children.find {|c| c.eql? node}
+      end
+      alias :has_child? :find
+
+      def add_leaf(node, *path)
+        file_node = Node.new_node("file", document, "fs_name" => path.pop)
+        file_node << node
+        parent = node_at(*path)
+        parent.add_child(file_node) 
+      end
+      alias :add_to_end :add_leaf
+
+      # *path is a list of nodes forming a path to the last one.
+      def node_at(*path)
+        return self if path.empty?
+
+        # recursive loop ends when last path_node is shifted off the array
+        attributes = {'fs_name' => path.shift}
+
+        # create and add the child node if it's not found among the immediate
+        # children of self
+        child = children.find do |c|
+          c.node_name == 'dir' && c.fs_name == attributes['fs_name']
+        end
+        unless child
+          child = Node.new_node('dir', document, attributes)
+          add_child(child)
+        end
+
+        child.node_at(*path)
+      end
+
+      def short_cuke_name
+        @short_cuke_name ||= (cn = cuke_name) ? cn.split(/:\s*/).last : ""
+      end
+
+      # value equivalence
+      def eql?(other)
+        node_name == other.node_name && cuke_name == other.cuke_name && children.eql?(other.children)
+      end
+
+      def to_text
+        s = Cuporter::Formatters::Text.build_line(self)
+        s += children.map {|n| n.to_text}.to_s
+        s
+      end
+      alias :to_pretty :to_text
+
+      def to_csv
+        s = Cuporter::Formatters::Csv.build_line(self)
+        s += children.map {|n| n.to_csv}.to_s
+        s
+      end
+
+    end
+    # this will vary when json comes
+    NodeBase = Nokogiri::XML::Node
+
+    # common methods for building either html or xml nodes
+    module InitializeNode
+
+      def format_name(name)
+        node_name = name.to_s.gsub(/([a-z])([A-Z])/,'\1_\2').downcase
+        class_name = name.to_s.to_class_name.to_sym
+        return node_name, class_name
+      end
+
+      def copy_attrs(node, attributes)
+        attributes.each do |attr, value|
+          next if attr.to_s.downcase == 'type'
+          value = value.is_a?(Array) ?  value.join(", ") : value.to_s.strip
+          node[attr.to_s] = value unless value.empty?
+        end
+        node
+      end
+
+      def new_node(name, doc, attributes = {})
+        node_name, class_name = format_name(name)
+        n = Cuporter::Node::Types.const_get(class_name).new(node_name, doc)
+        copy_attrs(n, attributes)
+      end
+    end
+
+  end
+end
+
+Cuporter::Node.send(:extend, Cuporter::Node::InitializeNode)
+Cuporter::Node::NodeBase.send(:include, Cuporter::Node::BaseMethods)