cukehead 0.1.1

data/spec/feature_file_section_spec.rb

@@ -0,0 +1,93 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'cukehead/feature_file_section'
+
+module Cukehead
+  
+  describe "FeatureFileSection" do
+
+    it "should take a FreemindBuilder and a title as parameters when creating a new instance" do
+      builder = FreemindBuilder.new
+      title = "Feature: A test"
+      section = FeatureFileSection.new builder, title
+      section.should_not be_nil
+    end
+
+  #  it "should accept a line of text" do
+  #    section = FeatureFileSection.new FakeFreemindBuilder.new, "Feature: A test"
+  #    section.add "A line"
+  #    section.finish
+  #    section.lines.should have(1).line
+  #  end
+
+    it "should have 'add', 'set_tags', and 'finish' methods" do
+      section = FeatureFileSection.new FakeFreemindBuilder.new, "Feature: A test"
+      section.should respond_to "add", "set_tags", "finish"
+    end
+
+    it "is a base class and should raise an exception if the 'finish' method is called" do
+      section = FeatureFileSection.new FakeFreemindBuilder.new, "Feature: A test"
+      lambda{ section.finish }.should raise_exception
+    end
+
+  end
+
+  describe "FeatureSection" do
+
+    it "should take a FreemindBuilder, a title, and a filename as parameters when creating a new instance" do
+      builder = FreemindBuilder.new
+      title = "Feature: A test"
+      filename = "test.feature"
+      section = FeatureSection.new builder, title, filename
+      section.should_not be_nil
+    end
+
+    it "should be a FeatureFileSection" do
+      section = FeatureSection.new FakeFreemindBuilder.new, "Feature: A test", "test.feature"
+      section.should be_a FeatureFileSection
+    end
+
+    it "implements the 'finish' method" do
+      fakebuilder = FakeFreemindBuilder.new
+      section = FeatureSection.new fakebuilder, "Feature: A test", "test.feature"
+      section.add "A line"
+      section.finish
+      fakebuilder.lines.should have(1).line
+    end
+
+  end
+
+  describe "BackgroundSection" do
+
+    it "should be a FeatureFileSection" do
+      section = BackgroundSection.new FakeFreemindBuilder.new, "Feature: A test"
+      section.should be_a FeatureFileSection
+    end
+
+    it "implements the 'finish' method" do
+      fakebuilder = FakeFreemindBuilder.new
+      section = BackgroundSection.new fakebuilder, "Feature: A test"
+      section.add "A line"
+      section.finish
+      fakebuilder.lines.should have(1).line
+    end
+
+  end
+
+  describe "ScenarioSection" do
+
+    it "should be a FeatureFileSection" do
+      section = ScenarioSection.new FakeFreemindBuilder.new, "Feature: A test"
+      section.should be_a FeatureFileSection
+    end
+
+    it "implements the 'finish' method" do
+      fakebuilder = FakeFreemindBuilder.new
+      section = ScenarioSection.new fakebuilder, "Feature: A test"
+      section.add "A line"
+      section.finish
+      fakebuilder.lines.should have(1).line
+    end
+
+  end
+
+end

data/spec/feature_node_spec.rb

@@ -0,0 +1,115 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'rexml/document'
+require 'cukehead/feature_node'
+
+module Cukehead
+
+  describe "FeatureNodeTags" do
+
+    it "extracts tags from text" do
+      @fntags = FeatureNodeTags.new
+      text = "tags: @tag1 @tag2"
+      @fntags.from_text text
+      @fntags.should_not be_nil
+    end
+
+    it "returns tags as a string padded for output" do
+      @fntags = FeatureNodeTags.new
+      text = "tags: @tag1 @tag2"
+      @fntags.from_text text
+      @fntags.to_text('    ').should eql "    @tag1 @tag2\n"
+    end
+
+  end
+  
+
+  describe "FeatureNodeChild" do
+
+    before do
+      @xml = $testing_freemind_data
+    end
+
+    it "populates itself from a FreeMind XML document node that is a child of a feature node" do
+      doc = REXML::Document.new @xml
+      node = REXML::XPath.first doc, '//node[attribute::TEXT="Scenario: Sites List"]'
+      feature_node_child = FeatureNodeChild.new node
+      feature_node_child.should_not be_nil
+    end
+
+    it "returns a text representation of itself padded for output to a Cucumber feature file" do
+      doc = REXML::Document.new @xml
+      node = REXML::XPath.first doc, '//node[attribute::TEXT="Scenario: Sites List"]'
+      feature_node_child = FeatureNodeChild.new node
+      feature_node_child.to_text('  ').should match /^\ \ Scenario:.*/m
+    end
+
+  end
+
+
+  describe "FeatureNode" do
+
+    before do
+      @xml = <<xxx
+<map>
+  <node TEXT='Cucumber features:'>
+    <node TEXT='Feature: Test feature'>
+      <node TEXT='As a test'/>
+      <node TEXT='I want to pass'/>
+    </node>
+  </node>
+</map>
+xxx
+
+      @xml_with_filename = <<xxx
+<map>
+  <node TEXT='Cucumber features:'>
+    <node TEXT='Feature: Test feature'>
+      <node TEXT='[file: my_filename.feature]'/>
+    </node>
+  </node>
+</map>
+xxx
+
+      doc = REXML::Document.new @xml
+      node = REXML::XPath.first doc, '//node[attribute::TEXT="Feature: Test feature"]'
+      @feature_node = FeatureNode.new(node)
+    end
+
+    it "populates itself from a XML document node describing a Cucumber feature" do
+      doc = REXML::Document.new @xml
+      node = REXML::XPath.first doc, '//node[attribute::TEXT="Feature: Test feature"]'
+      feat = FeatureNode.new(node)
+      feat.should_not be_nil
+    end
+
+    it "returns the file name for the feature as specified in the document" do
+      doc = REXML::Document.new @xml_with_filename
+      node = REXML::XPath.first doc, '//node[attribute::TEXT="Feature: Test feature"]'
+      feat = FeatureNode.new(node)
+      feat.filename.should eql 'my_filename.feature'
+    end
+
+    it "creates a file name if none was specified based on the feature title" do
+      doc = REXML::Document.new @xml
+      node = REXML::XPath.first doc, '//node[attribute::TEXT="Feature: Test feature"]'
+      feat = FeatureNode.new(node)
+      feat.filename.should eql 'test_feature.feature'
+    end
+
+    it "has a method to return a file name from text in the mind map specifying the file name" do
+      @feature_node.filename_from('').should eql ''
+      @feature_node.filename_from('[file: filename.feature]').should eql 'filename.feature'
+      @feature_node.filename_from('[file: "filename.feature"]').should eql 'filename.feature'
+      @feature_node.filename_from('[file:filename.feature]').should eql 'filename.feature'
+      @feature_node.filename_from('[file:"filename.feature"]').should eql 'filename.feature'
+      @feature_node.filename_from('[ File:  "  filename.feature  " ] ').should eql 'filename.feature'
+    end
+
+
+    it "returns itself in Cucumber feature file format as a single string of text" do
+      @feature_node.to_text.should eql "Feature: Test feature\n  As a test\n  I want to pass\n\n"
+    end
+
+  end
+
+end

data/spec/feature_part_spec.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'cukehead/feature_part'
+
+module Cukehead
+
+  describe "FeaturePart" do
+    before do
+      @part = FeaturePart.new
+    end
+
+    it "should have a 'title' attribute" do
+      s = "Feature: Test feature"
+      @part.title = s
+      @part.title.should == s
+    end
+
+    it "should let you add lines and have a 'lines' attribute reader" do
+      a = ["In order describe a feature", "As a feature object", "I want to have lines of text"]
+      a.each {|line| @part.add_line(line)}
+      @part.lines.should == a
+    end
+
+    it "should have a 'tags' attribute" do
+      a = ["@test"]
+      @part.tags = a
+      @part.tags.should == a
+    end
+
+    it "should take the title as a parameter when creating a new instance" do
+      s = "A feature part"
+      part = FeaturePart.new s
+      part.title.should == s
+    end
+
+  end
+
+end

data/spec/feature_reader_spec.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'cukehead/feature_reader'
+
+module Cukehead
+
+  describe "FeatureReader" do
+
+    before do
+      #@filename1 = File.expand_path(File.join(File.dirname(__FILE__), "..", "tmp/test-1.feature"))
+      @filename1 = File.join($testing_tmp, "test-1.feature")
+      @filetext1 = "Feature: A test"
+      #$stderr.puts "DEBUG: @filename1='#{@filename1}'"
+      FileUtils.mkdir($testing_tmp) unless File.directory? $testing_tmp
+      File.open(@filename1, 'w') do |f|
+        f.write(@filetext1)
+      end
+    end
+
+    it "extracts feature sections from the text of a Cucumber feature file" do
+      reader = FeatureReader.new
+      reader.extract_features @filename1, @filetext1
+      xml = reader.freemind_xml
+      xml.should match /.*Cucumber features:.*Feature: A test.*/
+    end
+
+    it "Optionally takes a string containing XML to pass to the FreemindBuilder" do
+      xml = "<map><node TEXT='A Mind Map'/></map>"
+      reader = FeatureReader.new(xml)
+    end
+
+  end
+
+end

data/spec/feature_writer_spec.rb

@@ -0,0 +1,73 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'cukehead/feature_writer'
+
+module Cukehead
+
+  describe "FeatureWriter" do
+
+    before do
+      @features = {
+        "test1.feature" => "Feature: Test 1",
+        "test2.feature" => "Feature: Test 2"
+      }
+      @writer = FeatureWriter.new
+      @outdir = File.join($testing_tmp, 'feature_writer_test', 'features')
+      FileUtils.remove_dir(@outdir) if File.directory? @outdir
+    end
+
+
+    it "writes to a subdirectory named 'features' in the current directory by default" do
+      @writer.output_path.should eql File.join(Dir.getwd, 'features')
+    end
+
+
+    it "has an output directory attribute that can be set" do
+      @writer.output_path = @outdir
+      @writer.output_path.should eql @outdir
+    end
+
+
+    it "takes a hash of filename => featuretext and writes feature files" do
+      @writer.output_path = @outdir
+      @writer.write_features(@features)
+    end
+
+
+    it "does not overwrite existing files by default" do
+      fn = File.join(@outdir, 'test1.feature')
+      FileUtils.mkdir_p @outdir
+      File.open(fn, 'w') {|f| f.write('###')}
+      File.exists?(fn).should be_true
+      @writer.output_path = @outdir
+      @writer.write_features(@features)
+      @writer.errors.should have(1).items
+      File.open(fn, 'r') {|f|
+        s = f.readline
+        s.should eql "###"
+      }
+    end
+
+
+    it "has an overwrite attribute that can be set" do
+      @writer.overwrite = true
+    end
+
+
+    it "overwrites existing files if the overwrite attrubute is set to true" do
+      fn = File.join(@outdir, 'test1.feature')
+      FileUtils.mkdir_p @outdir
+      File.open(fn, 'w') {|f| f.write('###')}
+      File.exists?(fn).should be_true
+      @writer.output_path = @outdir
+      @writer.overwrite = true
+      @writer.write_features(@features)
+      @writer.errors.should have(0).items
+      File.open(fn, 'r') {|f|
+        s = f.readline
+        s.should eql "Feature: Test 1"
+      }
+    end
+
+  end
+
+end

data/spec/freemind_builder_spec.rb

@@ -0,0 +1,91 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'cukehead/feature_part'
+require 'cukehead/freemind_builder'
+
+module Cukehead
+  
+  describe "FreemindBuilder" do
+    before do
+      @builder = FreemindBuilder.new
+    end
+
+    it "should specify a XML node for Cucumber features" do
+      node = @builder.send :cucumber_features_node
+      node.should be_a REXML::Element
+      node.to_s.should match /.*Cucumber features:.*/
+    end
+
+    it "should use an existing node labelled 'Cucumber features:' if there is one" do
+      mm = "<map version='0.7.1'><node TEXT='mind map'><node TEXT='A child node'><node TEXT='Cucumber features:'></node></node></node></map>"
+      b = FreemindBuilder.new mm
+      node = b.send :cucumber_features_node
+      node.should be_a REXML::Element
+      xml = b.xml
+      doc = REXML::Document.new(xml)
+      doc.should_not be_nil
+      node = REXML::XPath.first(doc, '//node[attribute::TEXT="A child node"]')
+      node.should_not be_nil
+      child = node.elements.first
+      child.to_s.should match /.*Cucumber features:.*/
+    end
+
+    it "should save the path to the features directory" do
+      filename = '/tmp/features/some.feature'
+      @builder.send :add_features_path, filename
+      result = @builder.send :features_path_text
+      result.should eql "[path: /tmp/features]"
+    end
+
+    it "should create new XML node element with text, color, and folded attributes" do
+      text = "Test node"
+      color = "blue"
+      folded = true
+      node = @builder.send :new_node_element, text, color, folded
+      node.should be_a REXML::Element
+      node.to_s.should eql "<node FOLDED='true' TEXT='Test node' COLOR='blue'/>"
+    end
+
+    it "should add a feature and specify the name of the file it is from" do
+      feature = FeaturePart.new
+      feature.title = "Feature: Test feature"
+      filename = "test.feature"
+      @builder.add_feature feature, filename
+      @builder.xml.should match /.*Test feature.*/
+    end
+
+    it "should include lines and tags attributes in the XML output" do
+      feature = FeaturePart.new "Feature: Test feature"
+      feature.add_line "As a test"
+      feature.add_line "I want to add some lines of text"
+      feature.add_line "In order to make sure I can"
+      feature.tags << "@test"
+      @builder.add_feature feature, "test.feature"
+      @builder.xml.should match /.*Test feature.*\@test.*As a test.*/
+    end
+
+    it "should add a Background part to the current feature" do
+      feature = FeaturePart.new "Feature: Test feature"
+      @builder.add_feature feature, "test.feature"
+      bg = FeaturePart.new "Background:"
+      bg.add_line "Given this thingy"
+      bg.add_line "And that other thingy"
+      bg.tags << "@test"
+      @builder.add_background bg
+      @builder.xml.should match /.*Test feature.*Background:.*\@test.*thingy.*/
+    end
+
+    it "should add a Scenario section to the current feature" do
+      feature = FeaturePart.new "Feature: Test feature"
+      @builder.add_feature feature, "test.feature"
+      sc = FeaturePart.new "Scenario: Test a scenario"
+      sc.add_line "Given I am a scenario part"
+      sc.add_line "When I am added to a FreemindBuilder"
+      sc.add_line "Then I should see myself in the output."
+      sc.tags << "@test"
+      @builder.add_scenario sc
+      @builder.xml.should match /.*Test feature.*Scenario:.*\@test.*in the output.*/
+    end
+
+  end
+
+end