cucumber_analytics 1.4.2 → 1.5.0

data/features/step_definitions/step_steps.rb

@@ -148,4 +148,12 @@ Then /^(?:the )?(?:feature "([^"]*)" )?(?:test(?: "([^"]*)")? )?step(?: "([^"]*)
   actual = @parsed_files[file - 1].feature.tests[test - 1].steps[step - 1].block.row_elements[row - 1].cells
 
   assert(actual == expected, "Expected: #{expected}\n but was: #{actual}")
-end
+end
+
+Given(/^a step element based on the following gherkin:$/) do |step_text|
+  @element = CucumberAnalytics::Step.new(step_text)
+end
+
+Then(/^the step has convenient output$/) do
+  @parsed_files.first.feature.tests.first.steps.first.method(:to_s).owner.should == CucumberAnalytics::Step
+end

data/features/step_definitions/table_steps.rb

@@ -4,9 +4,10 @@ Then /^(?:the )?(?:feature "([^"]*)" )?(?:test(?: "([^"]*)")? )?(?:step(?: "([^"
   step ||= 1
 
   expected = contents.raw
-  actual = @parsed_files[file - 1].feature.tests[test - 1].steps[step - 1].block.row_elements.collect{|row| row.cells}
 
-  assert(actual == expected, "Expected: #{expected}\n but was: #{actual}")
+  @parsed_files[file - 1].feature.tests[test - 1].steps[step - 1].block.row_elements.collect { |row| row.cells }.should == expected
+  # todo - remove once #contents is no longer supported
+  @parsed_files[file - 1].feature.tests[test - 1].steps[step - 1].block.contents.should == expected
 end
 
 Then /^(?:the )?(?:feature "([^"]*)" )?(?:test(?: "([^"]*)")? )?(?:step(?: "([^"]*)") )?table correctly stores its underlying implementation$/ do |file, test, step|
@@ -19,3 +20,35 @@ Then /^(?:the )?(?:feature "([^"]*)" )?(?:test(?: "([^"]*)")? )?(?:step(?: "([^"
   raw_element.is_a?(Array).should be_true
   raw_element.each { |row| row.has_key?('cells').should be_true }
 end
+
+Given(/^a table row element$/) do
+  @element = CucumberAnalytics::TableRow.new
+end
+
+When(/^the table row element has no cells$/) do
+  @element.cells = []
+end
+
+Given(/^a table row element based on the following gherkin:$/) do |row_text|
+  @element = CucumberAnalytics::TableRow.new(row_text)
+end
+
+Then(/^the table row has convenient output$/) do
+  @parsed_files.first.feature.tests.first.steps.first.block.row_elements.first.method(:to_s).owner.should == CucumberAnalytics::TableRow
+end
+
+Given(/^a table element$/) do
+  @element = CucumberAnalytics::Table.new
+end
+
+When(/^the table element has no rows$/) do
+  @element.row_elements = []
+end
+
+Then(/^the table has convenient output$/) do
+  @parsed_files.first.feature.tests.first.steps.first.block.method(:to_s).owner.should == CucumberAnalytics::Table
+end
+
+Given(/^a table element based on the following gherkin:$/) do |table_text|
+  @element = CucumberAnalytics::Table.new(table_text)
+end

data/features/step_definitions/tag_steps.rb

@@ -51,3 +51,11 @@ When(/^the example tag source line "([^"]*)"$/) do |line|
 
   tag.source_line.should == line
 end
+
+Then(/^the tag has convenient output$/) do
+  @parsed_files.first.feature.tag_elements.first.method(:to_s).owner.should == CucumberAnalytics::Tag
+end
+
+Given(/^a tag element based on the following gherkin:$/) do |tag_text|
+  @element = CucumberAnalytics::Tag.new(tag_text)
+end

data/features/step_definitions/test_steps.rb

@@ -9,12 +9,15 @@ Then /^(?:the )?(?:feature "([^"]*)" )?test(?: "([^"]*)")? is found to have the
   end
 end
 
-Then /^(?:the )?(?:feature "([^"]*)" )?test(?: "([^"]*)")? descriptive lines are as follows:$/ do |file, test, lines|
+Then /^(?:the )?(?:feature "([^"]*)" )?test(?: "([^"]*)")? has the following description:$/ do |file, test, text|
   file ||= 1
   test ||= 1
-  lines = lines.raw.flatten
 
-  assert @parsed_files[file - 1].feature.tests[test - 1].description == lines
+  new_description = @parsed_files[file - 1].feature.tests[test - 1].description_text
+  old_description = @parsed_files[file - 1].feature.tests[test - 1].description
+
+  new_description.should == text
+  old_description.should == remove_whitespace(text)
 end
 
 Then /^(?:the )?(?:feature "([^"]*)" )?test(?: "([^"]*)")? steps are as follows:$/ do |file, test, steps|
@@ -101,3 +104,11 @@ Then /^(?:the )?(?:feature "([^"]*)" )?test(?: "([^"]*)")? correctly stores its
 
   expected.include?(actual).should be_true
 end
+
+Then(/^the scenario has convenient output$/) do
+  @parsed_files.first.feature.tests.first.method(:to_s).owner.should == CucumberAnalytics::Scenario
+end
+
+Given(/^a scenario element based on the following gherkin:$/) do |scenario_text|
+  @element = CucumberAnalytics::Scenario.new(scenario_text)
+end

data/features/step_definitions/verification_steps.rb

@@ -0,0 +1,9 @@
+Then(/^the following text is provided:$/) do |expected_text|
+  expected_text.sub!('path_to', @default_file_directory)
+
+  @output.should == expected_text
+end
+
+Then(/^the text provided is "(.*)"$/) do |text_string|
+  @output.should == text_string.gsub('\n', "\n")
+end

data/features/support/env.rb

@@ -3,6 +3,7 @@ unless RUBY_VERSION.to_s < '1.9.0'
   SimpleCov.command_name('cucumber_tests')
 end
 
+require 'test/unit/assertions'
 include Test::Unit::Assertions
 
 require File.dirname(__FILE__) + '/../../lib/cucumber_analytics'

data/lib/cucumber_analytics/background.rb

@@ -14,6 +14,18 @@ module CucumberAnalytics
       build_background(parsed_background) if parsed_background
     end
 
+    # Returns gherkin representation of the background.
+    def to_s
+      text = ''
+
+      text << "Background:#{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/directory.rb

@@ -55,6 +55,11 @@ module CucumberAnalytics
       @feature_files + @directories
     end
 
+    # Returns the path of the directory.
+    def to_s
+      path.to_s
+    end
+
 
     private
 

data/lib/cucumber_analytics/doc_string.rb

@@ -11,20 +11,33 @@ module CucumberAnalytics
     # The content type associated with the doc string
     attr_accessor :content_type
 
+    # Deprecated
+    #
     # The contents of the doc string
     attr_accessor :contents
 
+    # The contents of the doc string
+    attr_accessor :contents_text
+
 
     # Creates a new DocString object and, if *source* is provided, populates
     # the object.
     def initialize(source = nil)
       @contents = []
+      @contents_text = ''
 
       parsed_doc_string = process_source(source)
 
       build_doc_string(parsed_doc_string) if parsed_doc_string
     end
 
+    # Returns a gherkin representation of the doc string.
+    def to_s
+      text = "\"\"\"#{content_type_output_string}\n"
+      text << contents_output_string
+      text << '"""'
+    end
+
 
     private
 
@@ -59,6 +72,15 @@ module CucumberAnalytics
 
     def populate_contents(doc_string)
       @contents = doc_string['value'].split($/, -1)
+      @contents_text = doc_string['value']
+    end
+
+    def content_type_output_string
+      content_type ? " #{content_type}" : ''
+    end
+
+    def contents_output_string
+      contents_text.empty? ? '' : contents_text.gsub('"""', '\"\"\"') + "\n"
     end
 
   end

data/lib/cucumber_analytics/example.rb

@@ -9,6 +9,9 @@ module CucumberAnalytics
 
 
     # The argument rows in the example table
+    #
+    # todo - Make this a read only method that derives the rows from
+    # the row elements
     attr_accessor :rows
 
     # The parameters for the example table
@@ -66,6 +69,7 @@ module CucumberAnalytics
           raise(ArgumentError, "Can only remove row from a Hash or an Array but received #{row.class}")
       end
 
+      #todo - remove once Hash rows are no longer supported
       @rows.delete_at(location) if location
       @row_elements.delete_at(location + 1) if location
     end
@@ -75,6 +79,20 @@ module CucumberAnalytics
       @row_elements
     end
 
+    # Returns a gherkin representation of the example.
+    def to_s
+      text = ''
+
+      text << tag_output_string + "\n" unless tags.empty?
+      text << "Examples:#{name_output_string}"
+      text << "\n" + description_output_string unless description_text.empty?
+      text << "\n" unless description_text.empty?
+      text << "\n" + parameters_output_string
+      text << "\n" + rows_output_string unless rows.empty?
+
+      text
+    end
+
 
     private
 
@@ -122,8 +140,45 @@ module CucumberAnalytics
       end
     end
 
+    def determine_buffer_size(index)
+      row_elements.collect { |row| row.cells[index].length }.max || 0
+    end
+
+    def parameters_output_string
+      text = ''
+
+      unless parameters.empty?
+        text << "  |"
+        parameters.count.times { |index| text << " #{string_for(parameters, index)} |" }
+      end
+
+      text
+    end
+
+    def rows_output_string
+      text = ''
+
+      unless rows.empty?
+
+        rows.each do |row|
+          text << "  |"
+          row.values.count.times { |index| text << " #{string_for(ordered_row_values(row), index)} |" }
+          text << "\n"
+        end
+
+        text.chomp!
+      end
+
+      text
+    end
+
+    def string_for(cells, index)
+      cells[index] ? cells[index].ljust(determine_buffer_size(index)) : ''
+    end
+
     def ordered_row_values(row_hash)
       @parameters.collect { |parameter| row_hash[parameter] }
     end
+
   end
 end

data/lib/cucumber_analytics/feature.rb

@@ -75,6 +75,20 @@ module CucumberAnalytics
     end
 
 
+    # Returns gherkin representation of the feature.
+    def to_s
+      text = ''
+
+      text << tag_output_string + "\n" unless tags.empty?
+      text << "Feature:#{name_output_string}"
+      text << "\n" + description_output_string unless description_text.empty?
+      text << "\n\n" + background_output_string if background
+      text << "\n\n" + tests_output_string unless tests.empty?
+
+      text
+    end
+
+
     private
 
 
@@ -117,5 +131,17 @@ module CucumberAnalytics
       end
     end
 
+    def background_output_string
+      test_element_output_string(background)
+    end
+
+    def tests_output_string
+      tests.collect { |test| test_element_output_string(test) }.join("\n\n")
+    end
+
+    def test_element_output_string(test_element)
+      test_element.to_s.split("\n").collect { |line| line.empty? ? '' : "  #{line}" }.join("\n")
+    end
+
   end
 end

data/lib/cucumber_analytics/feature_element.rb

@@ -12,15 +12,21 @@ module CucumberAnalytics
     # The name of the FeatureElement
     attr_accessor :name
 
+    # Deprecated
+    #
     # The description of the FeatureElement
     attr_accessor :description
 
+    # The description of the FeatureElement
+    attr_accessor :description_text
+
 
     # Creates a new FeatureElement object and, if *parsed_element* is provided,
     # populates the object.
     def initialize(parsed_element = nil)
       @name = ''
-      @description =[]
+      @description = []
+      @description_text = ''
 
       build_feature_element(parsed_element) if parsed_element
     end
@@ -41,9 +47,27 @@ module CucumberAnalytics
     end
 
     def populate_feature_element_description(parsed_element)
+      @description_text = parsed_element['description']
       @description = parsed_element['description'].split("\n").collect { |line| line.strip }
       @description.delete('')
     end
 
+    def name_output_string
+      name.empty? ? '' : " #{name}"
+    end
+
+    def description_output_string
+      text = ''
+
+      unless description_text.empty?
+        description_lines = description_text.split("\n")
+
+        text << "  \n" if description_lines.first =~ /\S/
+        text << description_lines.collect { |line| "  #{line}" }.join("\n")
+      end
+
+      text
+    end
+
   end
 end

data/lib/cucumber_analytics/feature_file.rb

@@ -52,6 +52,11 @@ module CucumberAnalytics
       @features.first
     end
 
+    # Returns the path of the feature file.
+    def to_s
+      path.to_s
+    end
+
 
     private
 

data/lib/cucumber_analytics/outline.rb

@@ -31,6 +31,20 @@ module CucumberAnalytics
       @examples + @steps
     end
 
+    # Returns a gherkin representation of the outline.
+    def to_s
+      text = ''
+
+      text << tag_output_string + "\n" unless tags.empty?
+      text << "Scenario Outline:#{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 << "\n\n" + examples_output_string unless examples.empty?
+
+      text
+    end
+
 
     private
 
@@ -46,5 +60,9 @@ module CucumberAnalytics
       end
     end
 
+    def examples_output_string
+      examples.empty? ? '' : examples.collect { |example| example.to_s }.join("\n\n")
+    end
+
   end
 end

data/lib/cucumber_analytics/parsing.rb

@@ -1,6 +1,8 @@
 require 'stringio'
 require 'gherkin/formatter/json_formatter'
 require 'gherkin'
+require 'json'
+require 'multi_json'
 
 module CucumberAnalytics
 
@@ -21,7 +23,7 @@ module CucumberAnalytics
         parser.parse(source_text, 'fake_file.txt', 0)
         formatter.done
 
-        JSON.parse(io.string)
+        MultiJson.load(io.string)
       end
 
     end

data/lib/cucumber_analytics/row.rb

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