cukehead 0.1.1

data/lib/cukehead/feature_node.rb

@@ -0,0 +1,111 @@
+require 'rexml/document'
+require 'cukehead/feature_node_tags'
+require 'cukehead/feature_node_child'
+
+module Cukehead
+
+  # Responsible for extracting the attributes of a feature from a XML node
+  # (REXML::Element) and providing those attributes as text in Cucumber
+  # feature file format.
+  #
+  class FeatureNode
+
+    # Extracts the attributes of a feature from a mind map node.
+    # ===Parameters
+    # <tt>node</tt> - REXML::Element
+    #
+    def initialize(node)
+      @feature_filename = ""
+      @description = []
+      @backgrounds = []
+      @scenarios = []
+      @tags = FeatureNodeTags.new
+      @title = node.attributes["TEXT"]
+      from_mm_node node
+    end
+
+    
+    # Returns the feature title as a string suitable for use as a file name.
+    #
+    def title_as_filename
+      result = ''
+      t = @title.strip.gsub(/^feature:/i, ' ').strip
+      t.downcase.gsub(/\ /, '_').scan(/[_0-9a-z]/) {|c| result << c }
+      result + '.feature'
+    end
+
+
+    # Returns a string that is either the file name  given explititly in the
+    # mind map or a file name constructed from the feature title.
+    #
+    def filename
+      if @feature_filename.empty?
+        title_as_filename
+      else
+        @feature_filename
+      end
+    end
+
+    
+    # Returns the file name extracted from the given text where the format
+    # is '<i>[file: filename.feature]</i>' or '<i>[file: "filename.feature"]</i>'.
+    #
+    def filename_from(text)
+      a = text.index ':'
+      if a.nil? then return "" end
+      b = text.index ']'
+      if b.nil? then return "" end
+      a += 1
+      if a > 5 and b > a
+        text.slice(a, b-a).delete('"').strip
+      else
+        ""
+      end
+    end
+
+
+    # Returns a string containing the attributes of this feature as text
+    # formatted for output to a Cucumber feature file.
+    #
+    def to_text
+      text = @tags.to_text('') + @title + "\n"
+      pad = "  "
+      @description.each {|line| text += pad + line + "\n"}
+      text += "\n"
+      @backgrounds.each {|background| text += background.to_text(pad) + "\n"}
+      @scenarios.each {|scenario| text += scenario.to_text(pad) + "\n"}
+      text
+    end
+
+
+    private
+
+
+    # ===Parameters
+    # <tt>node</tt> - REXML::Element
+    #
+    def from_mm_node(node)
+      if node.has_elements?
+        node.elements.each do |e|
+        text = e.attributes["TEXT"]
+          if !text.nil?
+            case text
+              when /^Background:*/i
+                @backgrounds << FeatureNodeChild.new(e)
+              when /^Scenario:*/i
+                @scenarios << FeatureNodeChild.new(e)
+              when /^\[file:.*/i
+                @feature_filename = filename_from text
+              when /^Tags:*/i
+                @tags.from_text text
+            else
+              @description << text
+            end
+          end
+        end
+      end
+    end
+
+  end
+
+end

data/lib/cukehead/feature_node_child.rb

@@ -0,0 +1,58 @@
+require 'rexml/document'
+require 'cukehead/feature_node_tags'
+
+module Cukehead
+
+  # Responsible for extracting the contents of a mind map node representing
+  # a sub-section of a feature (such as a Background or Scenario) and
+  # providing it as text for a feature file.
+  #
+  class FeatureNodeChild
+
+    # Extracts the feature section described in the given node.
+    # ===Parameters
+    # <tt>node</tt> - REXML::Element
+    #
+    def initialize(node)
+      @description = []
+      @tags = FeatureNodeTags.new
+      @title = node.attributes["TEXT"]
+      from_mm_node node
+    end
+
+    
+    # Returns the title, tags, and descriptive text extracted from the
+    # mind map as a string of text formatted for output to a feature file.
+    # ===Parameters
+    # <tt>pad</tt> - String of whitespace to use to indent the section.
+    #
+    def to_text(pad)
+      s = "\n"
+      @description.each {|d| s += pad + "  " + d + "\n"}
+      pad + @tags.to_text(pad) + @title + s
+    end
+    
+    private
+    
+    # Extracts tags and descriptive text from child nodes of the given node.
+    # ===Parameters
+    # <tt>node</tt> - REXML::Element
+    #
+    def from_mm_node(node)
+      if node.has_elements?
+        node.elements.each do |e|
+          text = e.attributes["TEXT"]
+          unless text.nil?
+            if text =~ /^Tags:*/i
+              @tags.from_text text
+            else
+              @description << text
+            end
+          end
+        end
+      end
+    end
+    
+  end
+
+end

data/lib/cukehead/feature_node_tags.rb

@@ -0,0 +1,41 @@
+module Cukehead
+
+  # Responsible for holding a string of tags extracted from a mind map
+  # node and providing it in the format used in a Cucumber feature file.
+  #
+  class FeatureNodeTags
+
+    def initialize
+      @tagstr = ''
+    end
+
+    
+    # Extracts the substring containing the tags from a string in the format
+    # <i>Tags: tag1 tag2</i>
+    # ===Parameters
+    # <tt>text</tt> - String containing tags from mind map node text.
+    #
+    def from_text(text)
+      a = text.split(':')
+      if a.length == 2
+        @tagstr = a[1].strip
+      end
+    end
+
+    
+    # Returns the string of tags extracted by from_text in the format
+    # needed for output to a feature file.
+    # ===Parameters
+    # <tt>pad</tt> - String of whitespace to use to indent the tags.
+    #
+    def to_text(pad)
+      if @tagstr.length == 0
+        ''
+      else
+        pad + @tagstr + "\n"
+      end
+    end
+
+  end
+
+end

data/lib/cukehead/feature_part.rb

@@ -0,0 +1,25 @@
+module Cukehead
+
+  # Container for text from part of a feature file (feature description, 
+  # background, scenario).
+  #
+  class FeaturePart
+    attr_accessor :title
+    attr_reader :lines
+    attr_accessor :tags
+
+
+    def initialize(title = '')
+      @title = title
+      @lines = []
+      @tags = []
+    end
+
+    
+    def add_line(line)
+      @lines << line if line.strip.length > 0
+    end
+  end
+
+end
+

data/lib/cukehead/feature_reader.rb

@@ -0,0 +1,78 @@
+require 'cukehead/freemind_builder'
+require 'cukehead/feature_file_section'
+
+module Cukehead
+
+  class FeatureReader
+
+    # ===Parameters
+    # <tt>mm_xml</tt> - Optional string containing XML representation of a
+    # FreeMind mind map into which a Cucumber Features node will be inserted.
+    #
+    def initialize(mm_xml = nil)
+      @builder = FreemindBuilder.new(mm_xml)
+    end
+
+
+    # ===Parameters
+    # <tt>filename</tt> - The name of the file from which text was read.
+    #
+    #<tt>text</tt> - String containing the text of a Cucumber feature file.
+    #
+    def extract_features(filename, text)
+      @section = nil
+      in_literal_text = false
+      literal_text = ''
+      tags = []
+      text.each do |line|
+        s = line.strip
+        #$stderr.puts "DEBUG: LINE='#{s}'"
+        if s == '"""'
+          if in_literal_text
+            @section.add(literal_text + "\n\"\"\"") unless @section == nil
+            in_literal_text = false
+          else
+            literal_text = "\"\"\"\n"
+            in_literal_text = true
+          end
+        else
+          if in_literal_text
+            literal_text << line
+          else
+            case s
+              when /^\@.*/i
+                tags = s.split(' ')
+              when /^Feature:.*/i
+                @section.finish unless @section == nil
+                @section = FeatureSection.new(@builder, line, filename)
+                @section.set_tags tags
+                tags.clear
+              when /^Background:.*/i
+                @section.finish unless @section == nil
+                @section = BackgroundSection.new(@builder, line)
+                @section.set_tags tags
+                tags.clear
+              when /^(Scenario|Scenario Outline):.*/i
+                @section.finish unless @section == nil
+                @section = ScenarioSection.new(@builder, line)
+                @section.set_tags tags
+                tags.clear
+              else
+                @section.add(line) unless @section == nil
+            end
+          end
+        end
+      end
+      @section.finish unless @section == nil
+    end
+
+
+    # Returns a string that is the FreeMind mind map XML.
+    #
+    def freemind_xml
+      @builder.xml
+    end
+
+  end
+
+end

data/lib/cukehead/feature_writer.rb

@@ -0,0 +1,42 @@
+module Cukehead
+
+  class FeatureWriter
+    attr_accessor :output_path
+    attr_accessor :overwrite
+    attr_reader :errors
+
+    
+    def initialize
+      @output_path = File.join(Dir.getwd, 'features')
+      @overwrite = false
+      @errors = []
+    end
+
+
+    # Writes feature files to the location specified by :output_path.
+    # ===Parameters
+    # <tt>features</tt> - Hash of filename => featuretext.
+    #
+    def write_features(features)
+      FileUtils.mkdir_p(@output_path) unless File.directory? @output_path
+      ok = true
+      unless @overwrite
+        features.each {|fn, text|
+          filename = File.join(@output_path, fn)
+          if File.exists? filename
+            @errors << "Exists: #{filename}"
+            ok = false
+          end
+        }
+      end
+      if ok
+        features.each {|fn, text|
+          filename = File.join(@output_path, fn)
+          File.open(filename, 'w') {|f| f.write(text)}
+        }
+      end
+    end
+
+  end
+
+end

data/lib/cukehead/freemind_builder.rb

@@ -0,0 +1,184 @@
+require 'rexml/document'
+
+module Cukehead
+
+  class FreemindBuilder
+
+    DEFAULT_XML = "<map version='0.7.1'><node TEXT='New mind map'></node></map>"
+    COLOR_FEATURE = '#0000ff'
+    COLOR_BACKGROUND = '#ff0000'
+    COLOR_SCENARIO_1 = '#3d9140'
+    COLOR_SCENARIO_2 = '#cd8500'
+    COLOR_TAGS = '#B452CD'
+    COLOR_SYSTEM = '#a1a1a1'
+    FOLD_FEATURE = true
+    FOLD_BACKGROUND = true
+    FOLD_SCENARIO = true
+
+
+    # ===Parameters
+    # <tt>mm_xml</tt> - String, optional.
+    #
+    def initialize(mm_xml = nil)
+      if mm_xml.nil?
+        @mmdoc = REXML::Document.new(DEFAULT_XML)
+      else
+        @mmdoc = REXML::Document.new(mm_xml)
+      end
+      @features_path = nil
+      @features_node = cucumber_features_node
+      @scenario_count = 0
+      @current_feature = nil
+    end
+
+
+    # ===Parameters
+    # <tt>part</tt> - Cukehead::FeaturePart containing feature description.
+    #
+    # <tt>filename</tt> - String containing name of the source file for this feature.
+    #
+    def add_feature(part, filename)
+      add_features_path(filename) if @features_path.nil?
+      new_node = new_feature_node part.title
+      e = new_node_element feature_filename_text(filename), COLOR_SYSTEM
+      e.add_attribute 'LINK', filename
+      new_node.add_element e
+      unless part.tags.empty?
+        new_node.add_element(new_node_element('Tags: ' + part.tags.join(' '), COLOR_TAGS))
+      end
+      part.lines.each do |line|
+        el = new_node_element line.strip, COLOR_FEATURE
+        if line =~ /^\ *(As\ |In\ |I\ ).*$/
+          el.add_element new_bold_font_element
+        else
+          el.add_element new_italic_font_element
+        end
+        new_node.add_element el
+      end
+      @current_feature = new_node
+    end
+
+
+    # ===Parameters
+    # <tt>part</tt> - Cukehead::FeaturePart containing background description.
+    #
+    def add_background(part)
+      raise "No feature defined. Cannot add background section." if @current_feature.nil?
+      new_node = @current_feature.add_element(new_node_element(part.title.strip, COLOR_BACKGROUND, FOLD_BACKGROUND))
+      unless part.tags.empty?
+        new_node.add_element(new_node_element('Tags: ' + part.tags.join(' '), COLOR_TAGS))
+      end
+      part.lines.each do |line|
+        el = new_node_element line.strip, COLOR_BACKGROUND
+        if line =~ /^\ *(Given\ |When\ |Then\ |And\ |But\ ).*$/
+          el.add_element new_bold_font_element
+        else
+          el.add_element new_italic_font_element
+        end
+        new_node.add_element el
+      end
+    end
+
+
+    # ===Parameters
+    # <tt>part</tt> - Cukehead::FeaturePart containing scenario description.
+    #
+    def add_scenario(part)
+      raise "No feature defined. Cannot add scenario section." if @current_feature.nil?
+      @scenario_count += 1
+      @scenario_count.odd? ? color = COLOR_SCENARIO_1 : color = COLOR_SCENARIO_2
+      new_node = @current_feature.add_element(new_node_element(part.title.strip, color, FOLD_SCENARIO))
+      unless part.tags.empty?
+        new_node.add_element(new_node_element('Tags: ' + part.tags.join(' '), COLOR_TAGS))
+      end
+      part.lines.each do |line|
+        el = new_node_element line.strip, color
+        if line =~ /^\ *(Given\ |When\ |Then\ |And\ |But\ ).*$/
+          el.add_element new_bold_font_element
+        else
+          el.add_element new_italic_font_element
+        end
+        new_node.add_element el
+      end
+    end
+
+
+    def xml
+      @mmdoc.to_s
+    end
+
+  private
+
+    def new_node_element(text, color = "", folded = false)
+      e = REXML::Element.new "node"
+      e.add_attribute 'TEXT', text
+      e.add_attribute 'COLOR', color if color.length > 0
+      e.add_attribute 'FOLDED', 'true' if folded
+      e
+    end
+
+
+    def new_italic_font_element
+      e = REXML::Element.new "font"
+      e.add_attribute 'ITALIC', "true"
+      e.add_attribute 'NAME', "SansSerif"
+      e.add_attribute 'SIZE', "12"
+      e
+    end
+
+
+    def new_bold_font_element
+      e = REXML::Element.new "font"
+      e.add_attribute 'BOLD', "true"
+      e.add_attribute 'NAME', "SansSerif"
+      e.add_attribute 'SIZE', "12"
+      e
+    end
+
+
+    def add_cucumber_features_node
+      node = @mmdoc.root.elements[1]
+      e = new_node_element "Cucumber features:"
+      node.add_element e
+      return e
+    end
+
+
+    def cucumber_features_node
+      node = REXML::XPath.first(@mmdoc, '//node[attribute::TEXT="Cucumber features:"]')
+      if node == nil
+        add_cucumber_features_node
+      else
+        node
+      end
+    end
+
+
+    def features_path_text
+      '[path: ' + @features_path + ']'
+    end
+
+
+    def feature_filename_text(filename)
+      '[file: ' + File.basename(filename) + ']'
+    end
+
+
+    def add_features_path(filename)
+      @features_path = File.dirname(File.expand_path(filename))
+      e = new_node_element features_path_text, COLOR_SYSTEM
+      e.add_attribute 'LINK', @features_path
+      @features_node.add_element e
+    end
+
+
+    def new_feature_node(title)
+      e = new_node_element title.strip, COLOR_FEATURE, FOLD_FEATURE
+      e.add_element new_bold_font_element
+      @features_node.add_element e
+    end
+
+
+  end
+
+end