cucumber_analytics 1.4.2 → 1.5.0

data/lib/cucumber_analytics/scenario.rb

@@ -20,6 +20,19 @@ module CucumberAnalytics
       build_scenario(parsed_scenario) if parsed_scenario
     end
 
+    # Returns gherkin representation of the scenario.
+    def to_s
+      text = ''
+
+      text << tag_output_string + "\n" unless tags.empty?
+      text << "Scenario:#{name_output_string}"
+      text << "\n" + description_output_string unless description_text.empty?
+      text << "\n" unless steps.empty? || description_text.empty?
+      text << "\n" + steps_output_string unless steps.empty?
+
+      text
+    end
+
 
     private
 

data/lib/cucumber_analytics/step.rb

@@ -131,6 +131,14 @@ module CucumberAnalytics
       @arguments = @base.scan(pattern).flatten
     end
 
+    # Returns a gherkin representation of the step.
+    def to_s
+      text = "#{keyword} #{base}"
+      text << "\n" + block.to_s.split("\n").collect { |line| "  #{line}" }.join("\n") if block
+
+      text
+    end
+
 
     private
 

data/lib/cucumber_analytics/table.rb

@@ -10,6 +10,8 @@ module CucumberAnalytics
 
 
     # The contents of the table
+    #
+    # Deprecated
     attr_accessor :contents
 
     # The row elements that make up the table
@@ -27,6 +29,11 @@ module CucumberAnalytics
       build_table(parsed_table) if parsed_table
     end
 
+    # Returns a gherkin representation of the table.
+    def to_s
+      row_elements.empty? ? '' : row_elements.collect { |row| row_output_string(row) }.join("\n")
+    end
+
 
     private
 
@@ -65,5 +72,19 @@ module CucumberAnalytics
       end
     end
 
+    def row_output_string(row)
+      row_text = '|'
+
+      row.cells.count.times do |count|
+        row_text << " #{row.cells[count].ljust(determine_buffer_size(count))} |"
+      end
+
+      row_text
+    end
+
+    def determine_buffer_size(index)
+      row_elements.collect { |row| row.cells[index].length }.max || 0
+    end
+
   end
 end

data/lib/cucumber_analytics/table_row.rb

@@ -23,6 +23,11 @@ module CucumberAnalytics
       build_row(parsed_row) if parsed_row
     end
 
+    # Returns a gherkin representation of the table row.
+    def to_s
+      "| #{cells.join(' | ')} |"
+    end
+
 
     private
 

data/lib/cucumber_analytics/tag.rb

@@ -21,6 +21,11 @@ module CucumberAnalytics
       build_tag(parsed_tag) if parsed_tag
     end
 
+    # Returns gherkin representation of the tag.
+    def to_s
+      name || ''
+    end
+
 
     private
 

data/lib/cucumber_analytics/taggable.rb

@@ -46,5 +46,9 @@ module CucumberAnalytics
       end
     end
 
+    def tag_output_string
+      tag_elements.collect { |tag| tag.name }.join(' ')
+    end
+
   end
 end

data/lib/cucumber_analytics/test_element.rb

@@ -65,5 +65,13 @@ module CucumberAnalytics
       end
     end
 
+    def steps_output_string
+      steps.collect { |step| indented_step_text(step) }.join("\n")
+    end
+
+    def indented_step_text(step)
+      step.to_s.split("\n").collect { |line| "  #{line}" }.join("\n")
+    end
+
   end
 end

data/lib/cucumber_analytics/version.rb

@@ -1,3 +1,3 @@
 module CucumberAnalytics
-  VERSION = '1.4.2'
+  VERSION = '1.5.0'
 end

data/spec/integration/background_integration_spec.rb

@@ -57,4 +57,16 @@ describe 'Background, Integration' do
     end
 
   end
+
+  context 'background output edge cases' do
+
+    it 'can output a background that has only steps' do
+      background = CucumberAnalytics::Background.new
+      background.steps = [CucumberAnalytics::Step.new]
+
+      expect { background.to_s }.to_not raise_error
+    end
+
+  end
+
 end

data/spec/integration/example_integration_spec.rb

@@ -70,4 +70,25 @@ describe 'Example, Integration' do
     end
 
   end
+
+  context 'example output edge cases' do
+
+    before(:each) do
+      @example = CucumberAnalytics::Example.new
+    end
+
+    it 'can output an example that has only a tag elements' do
+      @example.tag_elements = [CucumberAnalytics::Tag.new]
+
+      expect { @example.to_s }.to_not raise_error
+    end
+
+    #todo - remove once Hash rows are no longer supported
+    it 'can output an example that has only row elements' do
+      @example.row_elements = [CucumberAnalytics::Row.new]
+
+      expect { @example.to_s }.to_not raise_error
+    end
+
+  end
 end

data/spec/integration/feature_integration_spec.rb

@@ -120,4 +120,33 @@ describe 'Feature, Integration' do
     end
 
   end
+
+  context 'feature output edge cases' do
+
+    it 'can output a feature that has only a tag elements' do
+      @feature.tag_elements = [CucumberAnalytics::Tag.new]
+
+      expect { @feature.to_s }.to_not raise_error
+    end
+
+    it 'can output a feature that has only a background' do
+      @feature.background = [CucumberAnalytics::Background.new]
+
+      expect { @feature.to_s }.to_not raise_error
+    end
+
+    it 'can output a feature that has only scenarios' do
+      @feature.tests = [CucumberAnalytics::Scenario.new]
+
+      expect { @feature.to_s }.to_not raise_error
+    end
+
+    it 'can output a feature that has only outlines' do
+      @feature.tests = [CucumberAnalytics::Outline.new]
+
+      expect { @feature.to_s }.to_not raise_error
+    end
+
+  end
+
 end

data/spec/integration/outline_integration_spec.rb

@@ -66,5 +66,27 @@ describe 'Outline, Integration' do
       test.should be_nil
     end
 
+    context 'outline output edge cases' do
+
+      it 'can output an outline that has only a tag elements' do
+        @outline.tag_elements = [CucumberAnalytics::Tag.new]
+
+        expect { @outline.to_s }.to_not raise_error
+      end
+
+      it 'can output an outline that has only steps' do
+        @outline.steps = [CucumberAnalytics::Step.new]
+
+        expect { @outline.to_s }.to_not raise_error
+      end
+
+      it 'can output an outline that has only examples' do
+        @outline.examples = [CucumberAnalytics::Example.new]
+
+        expect { @outline.to_s }.to_not raise_error
+      end
+
+    end
+
   end
 end

data/spec/integration/scenario_integration_spec.rb

@@ -60,5 +60,21 @@ describe 'Scenario, Integration' do
       test.should be_nil
     end
 
+    context 'scenario output edge cases' do
+
+      it 'can output a scenario that has only a tag elements' do
+        @scenario.tag_elements = [CucumberAnalytics::Tag.new]
+
+        expect { @scenario.to_s }.to_not raise_error
+      end
+
+      it 'can output a scenario that has only steps' do
+        @scenario.steps = [CucumberAnalytics::Step.new]
+
+        expect { @scenario.to_s }.to_not raise_error
+      end
+
+    end
+
   end
 end

data/spec/integration/step_integration_spec.rb

@@ -161,4 +161,24 @@ describe 'Step, Integration' do
     end
 
   end
+
+  context 'step output edge cases' do
+
+    before(:each) do
+      @step = CucumberAnalytics::Step.new
+    end
+
+    it 'can output a step that has only a table' do
+      @step.block = CucumberAnalytics::Table.new
+
+      expect { @step.to_s }.to_not raise_error
+    end
+
+    it 'can output a step that has only a doc string' do
+      @step.block = CucumberAnalytics::DocString.new
+
+      expect { @step.to_s }.to_not raise_error
+    end
+
+  end
 end

data/spec/integration/table_integration_spec.rb

@@ -72,4 +72,15 @@ describe 'Table, Integration' do
     end
 
   end
+
+  context 'table output edge cases' do
+    # todo - remove once #contents is no longer supported
+    it 'can output a table that only has row elements' do
+      table = CucumberAnalytics::Table.new
+      table.row_elements = [CucumberAnalytics::TableRow.new]
+
+      expect { table.to_s }.to_not raise_error
+    end
+
+  end
 end

data/spec/unit/background_unit_spec.rb

@@ -24,4 +24,32 @@ describe 'Background, Unit' do
     @element.name.should == 'test background'
   end
 
+  context 'background output edge cases' do
+
+    before(:each) do
+      @background = clazz.new
+    end
+
+    it 'is a String' do
+      @background.to_s.should be_a(String)
+    end
+
+    it 'can output an empty background' do
+      expect { @background.to_s }.to_not raise_error
+    end
+
+    it 'can output a background that has only a name' do
+      @background.name = 'a name'
+
+      expect { @background.to_s }.to_not raise_error
+    end
+
+    it 'can output a background that has only a description' do
+      @background.description_text = 'a description'
+
+      expect { @background.to_s }.to_not raise_error
+    end
+
+  end
+
 end

data/spec/unit/directory_unit_spec.rb

@@ -87,5 +87,17 @@ describe 'Directory, Unit' do
     @directory.contains.should =~ everything
   end
 
+  context 'directory output edge cases' do
+
+    it 'is a String' do
+      @directory.to_s.should be_a(String)
+    end
+
+    it 'can output an empty directory' do
+      expect { @directory.to_s }.to_not raise_error
+    end
+
+  end
+
 end
 

data/spec/unit/doc_string_unit_spec.rb

@@ -17,6 +17,8 @@ describe 'DocString, Unit' do
     expect { @element = clazz.new(source) }.to_not raise_error
 
     # Sanity check in case instantiation failed in a non-explosive manner
+    @element.contents_text.should == "some doc string"
+    #todo Remove once Array contents is no longer supported
     @element.contents.should == ["some doc string"]
   end
 
@@ -39,22 +41,33 @@ describe 'DocString, Unit' do
     @doc_string.content_type.should == nil
   end
 
-  it 'has contents - #contents' do
+  it 'has contents' do
+    #todo Remove once Array contents is no longer supported
     @doc_string.should respond_to(:contents)
+    @doc_string.should respond_to(:contents_text)
   end
 
-  it 'can get and set its contents - #contents, #contents=' do
+  it 'can get and set its contents' do
+    #todo Remove once Array contents is no longer supported
     @doc_string.contents = :some_contents
     @doc_string.contents.should == :some_contents
     @doc_string.contents = :some_other_contents
     @doc_string.contents.should == :some_other_contents
+
+    @doc_string.contents_text = :some_contents
+    @doc_string.contents_text.should == :some_contents
+    @doc_string.contents_text = :some_other_contents
+    @doc_string.contents_text.should == :some_other_contents
   end
 
   it 'starts with no contents' do
+    #todo Remove once Array contents is no longer supported
     @doc_string.contents.should == []
+    @doc_string.contents_text.should == ''
   end
 
-  it 'stores its contents as an array of strings' do
+  #todo Remove once Array contents is no longer supported
+  it 'stores its contents as an array of strings - deprecated' do
     source = "\"\"\"\nsome text\nsome more text\n\"\"\""
     doc_string = CucumberAnalytics::DocString.new(source)
 
@@ -66,4 +79,31 @@ describe 'DocString, Unit' do
     end
   end
 
+  it 'stores its contents as a String' do
+    source = "\"\"\"\nsome text\nsome more text\n\"\"\""
+    doc_string = clazz.new(source)
+
+    contents = doc_string.contents_text
+
+    contents.is_a?(String).should be_true
+  end
+
+  context 'doc string output edge cases' do
+
+    it 'is a String' do
+      @doc_string.to_s.should be_a(String)
+    end
+
+    it 'can output an empty doc string' do
+      expect { @doc_string.to_s }.to_not raise_error
+    end
+
+    it 'can output a doc string that has only a content type' do
+      @doc_string.content_type = 'some type'
+
+      expect { @doc_string.to_s }.to_not raise_error
+    end
+
+  end
+
 end

data/spec/unit/example_unit_spec.rb

@@ -53,6 +53,7 @@ describe 'Example, Unit' do
     @example.should respond_to(:rows)
   end
 
+  #todo - remove once Hash rows are no longer supported
   it 'can get and set its rows - #rows, #rows=' do
     @example.rows = :some_rows
     @example.rows.should == :some_rows
@@ -60,10 +61,12 @@ describe 'Example, Unit' do
     @example.rows.should == :some_other_rows
   end
 
+  #todo - remove once Hash rows are no longer supported
   it 'starts with no rows' do
     @example.rows.should == []
   end
 
+  #todo - remove once Hash rows are no longer supported
   it 'stores its rows as an nested array of hashes' do
     source = "Examples:\n|param1|param2|\n|value1|value2|"
     example = CucumberAnalytics::Example.new(source)
@@ -112,6 +115,7 @@ describe 'Example, Unit' do
       new_row = {'param1' => 'value3', 'param2' => 'value4'}
       example.add_row(new_row)
 
+      #todo - remove once Hash rows are no longer supported
       example.rows.should == [{'param1' => 'value1', 'param2' => 'value2'}, {'param1' => 'value3', 'param2' => 'value4'}]
       example.row_elements.collect { |row| row.cells }[1..example.row_elements.count].should == [['value1', 'value2'], ['value3', 'value4']]
     end
@@ -123,6 +127,7 @@ describe 'Example, Unit' do
       new_row = ['value3', 'value4']
       example.add_row(new_row)
 
+      #todo - remove once Hash rows are no longer supported
       example.rows.should == [{'param1' => 'value1', 'param2' => 'value2'}, {'param1' => 'value3', 'param2' => 'value4'}]
       example.row_elements.collect { |row| row.cells }[1..example.row_elements.count].should == [['value1', 'value2'], ['value3', 'value4']]
     end
@@ -142,6 +147,7 @@ describe 'Example, Unit' do
       example.add_row(hash_row)
       example.add_row(array_row)
 
+      #todo - remove once Hash rows are no longer supported
       example.rows.should == [{'param1' => 'value1', 'param2' => 'value2'}, {'param1' => 'value3', 'param2' => 'value4'}, {'param1' => 'value5', 'param2' => 'value6'}]
       example.row_elements.collect { |row| row.cells }[1..example.row_elements.count].should == [['value1', 'value2'], ['value3', 'value4'], ['value5', 'value6']]
     end
@@ -160,6 +166,7 @@ describe 'Example, Unit' do
       old_row = {'param1' => 'value3', 'param2' => 'value4'}
       example.remove_row(old_row)
 
+      #todo - remove once Hash rows are no longer supported
       example.rows.should == [{'param1' => 'value1', 'param2' => 'value2'}]
       example.row_elements.collect { |row| row.cells }[1..example.row_elements.count].should == [['value1', 'value2']]
     end
@@ -171,6 +178,7 @@ describe 'Example, Unit' do
       old_row = ['value3', 'value4']
       example.remove_row(old_row)
 
+      #todo - remove once Hash rows are no longer supported
       example.rows.should == [{'param1' => 'value1', 'param2' => 'value2'}]
       example.row_elements.collect { |row| row.cells }[1..example.row_elements.count].should == [['value1', 'value2']]
     end
@@ -190,9 +198,54 @@ describe 'Example, Unit' do
       example.remove_row(hash_row)
       example.remove_row(array_row)
 
+      #todo - remove once Hash rows are no longer supported
       example.rows.should == [{'param1' => 'value1', 'param2' => 'value2'}]
       example.row_elements.collect { |row| row.cells }[1..example.row_elements.count].should == [['value1', 'value2']]
     end
   end
 
+  context 'example output edge cases' do
+
+    it 'is a String' do
+      @example.to_s.should be_a(String)
+    end
+
+    it 'can output an empty example' do
+      expect { @example.to_s }.to_not raise_error
+    end
+
+    it 'can output an example that has only a name' do
+      @example.name = 'a name'
+
+      expect { @example.to_s }.to_not raise_error
+    end
+
+    it 'can output an example that has only a description' do
+      @example.description_text = 'a description'
+
+      expect { @example.to_s }.to_not raise_error
+    end
+
+    it 'can output an example that has only a tags' do
+      @example.tags = ['a tag']
+
+      expect { @example.to_s }.to_not raise_error
+    end
+
+    #todo - remove once Hash rows are no longer supported
+    it 'can output an example that only has parameters' do
+      @example.parameters = ['param1']
+
+      expect { @example.to_s }.to_not raise_error
+    end
+
+    #todo - remove once Hash rows are no longer supported
+    it 'can output an example that only has rows' do
+      @example.rows = [{:param1 => 'row1'}]
+
+      expect { @example.to_s }.to_not raise_error
+    end
+
+  end
+
 end