cuke_modeler 0.1.0 → 0.2.0

data/History.rdoc

@@ -1,3 +1,8 @@
+=== Version 0.1.0 / 2016-02-21
+
+* Better error feedback when parsing errors are encountered.
+
+
 === Version 0.1.0 / 2016-02-10
 
 * Support for version 3.0 of the 'gherkin' gem added.

data/lib/cuke_modeler/background.rb

@@ -7,7 +7,7 @@ module CukeModeler
     # Creates a new Background object and, if *source* is provided, populates
     # the object.
     def initialize(source = nil)
-      parsed_background = process_source(source)
+      parsed_background = process_source(source, 'cuke_modeler_stand_alone_background.feature')
 
       super(parsed_background)
 

data/lib/cuke_modeler/doc_string.rb

@@ -55,7 +55,7 @@ module CukeModeler
       base_file_string = "Feature:\nScenario:\n* step\n"
       source_text = base_file_string + source_text
 
-      parsed_file = Parsing::parse_text(source_text)
+      parsed_file = Parsing::parse_text(source_text, 'cuke_modeler_stand_alone_doc_string.feature')
 
       parsed_file.first['elements'].first['steps'].first['doc_string']
     end

data/lib/cuke_modeler/example.rb

@@ -110,7 +110,7 @@ module CukeModeler
       base_file_string = "Feature: Fake feature to parse\nScenario Outline:\n* fake step\n"
       source_text = base_file_string + source_text
 
-      parsed_file = Parsing::parse_text(source_text)
+      parsed_file = Parsing::parse_text(source_text, 'cuke_modeler_stand_alone_example.feature')
 
       parsed_file.first['elements'].first['examples'].first
     end

data/lib/cuke_modeler/feature.rb

@@ -102,7 +102,7 @@ module CukeModeler
     end
 
     def parse_feature(source_text)
-      parsed_file = Parsing::parse_text(source_text)
+      parsed_file = Parsing::parse_text(source_text, 'cuke_modeler_stand_alone_feature.feature')
 
       parsed_file.first
     end

data/lib/cuke_modeler/feature_file.rb

@@ -64,7 +64,7 @@ module CukeModeler
     def parse_file(file_to_parse)
       source_text = IO.read(file_to_parse)
 
-      Parsing::parse_text(source_text)
+      Parsing::parse_text(source_text, file_to_parse)
     end
 
     def build_file(parsed_file)

data/lib/cuke_modeler/outline.rb

@@ -14,7 +14,7 @@ module CukeModeler
     # Creates a new Outline object and, if *source* is provided, populates the
     # object.
     def initialize(source = nil)
-      parsed_outline = process_source(source)
+      parsed_outline = process_source(source, 'cuke_modeler_stand_alone_outline.feature')
 
       super(parsed_outline)
 

data/lib/cuke_modeler/parsing.rb

@@ -17,10 +17,15 @@ if Gem.loaded_specs['gherkin'].version.version[/^3/]
     module Parsing
       class << self
 
-        def parse_text(source_text)
+        def parse_text(source_text, filename = 'cuke_modeler_fake_file.feature')
           raise(ArgumentError, "Cannot parse #{source_text.class} objects. Strings only.") unless source_text.is_a?(String)
 
-          parsed_result = Gherkin::Parser.new.parse(source_text)
+          begin
+            parsed_result = Gherkin::Parser.new.parse(source_text)
+          rescue => e
+            raise(ArgumentError, "Error encountered while parsing '#{filename}'\n#{e.class} - #{e.message}")
+          end
+
           adapted_result = CukeModeler::Gherkin3Adapter.new.adapt(parsed_result)
 
           adapted_result
@@ -49,13 +54,19 @@ else
 
         # Parses the Cucumber feature given in *source_text* and returns an array
         # containing the hash representation of its logical structure.
-        def parse_text(source_text)
+        def parse_text(source_text, filename = 'cuke_modeler_fake_file.feature')
           raise(ArgumentError, "Cannot parse #{source_text.class} objects. Strings only.") unless source_text.is_a?(String)
 
           io = StringIO.new
           formatter = Gherkin::Formatter::JSONFormatter.new(io)
           parser = Gherkin::Parser::Parser.new(formatter)
-          parser.parse(source_text, 'fake_file.txt', 0)
+
+          begin
+            parser.parse(source_text, filename, 0)
+          rescue => e
+            raise(ArgumentError, "Error encountered while parsing '#{filename}'\n#{e.class} - #{e.message}")
+          end
+
           formatter.done
 
 

data/lib/cuke_modeler/row.rb

@@ -45,7 +45,7 @@ module CukeModeler
       base_file_string = "Feature: Fake feature to parse\nScenario Outline:\n* fake step\nExamples: fake examples\n#{source_text}\n"
       source_text = base_file_string + source_text
 
-      parsed_file = Parsing::parse_text(source_text)
+      parsed_file = Parsing::parse_text(source_text, 'cuke_modeler_stand_alone_row.feature')
 
       parsed_file.first['elements'].first['examples'].first['rows'].last
     end

data/lib/cuke_modeler/scenario.rb

@@ -10,7 +10,7 @@ module CukeModeler
     # Creates a new Scenario object and, if *source* is provided, populates the
     # object.
     def initialize(source = nil)
-      parsed_scenario = process_source(source)
+      parsed_scenario = process_source(source, 'cuke_modeler_stand_alone_scenario.feature')
 
       super(parsed_scenario)
 

data/lib/cuke_modeler/step.rb

@@ -158,7 +158,7 @@ module CukeModeler
       base_file_string = "Feature: Fake feature to parse\nScenario:\n"
       source_text = base_file_string + source_text
 
-      parsed_file = Parsing::parse_text(source_text)
+      parsed_file = Parsing::parse_text(source_text, 'cuke_modeler_stand_alone_step.feature')
 
       parsed_file.first['elements'].first['steps'].first
     end

data/lib/cuke_modeler/table.rb

@@ -51,7 +51,7 @@ module CukeModeler
       base_file_string = "Feature:\nScenario:\n* step\n"
       source_text = base_file_string + source_text
 
-      parsed_file = Parsing::parse_text(source_text)
+      parsed_file = Parsing::parse_text(source_text, 'cuke_modeler_stand_alone_table.feature')
 
       parsed_file.first['elements'].first['steps'].first['rows']
     end

data/lib/cuke_modeler/table_row.rb

@@ -45,7 +45,7 @@ module CukeModeler
       base_file_string = "Feature: Fake feature to parse\nScenario:\n* fake step\n"
       source_text = base_file_string + source_text
 
-      parsed_file = Parsing::parse_text(source_text)
+      parsed_file = Parsing::parse_text(source_text, 'cuke_modeler_stand_alone_table_row.feature')
 
       parsed_file.first['elements'].first['steps'].first['rows']['rows'].first
     end

data/lib/cuke_modeler/tag.rb

@@ -43,7 +43,7 @@ module CukeModeler
       base_file_string = "\nFeature: Fake feature to parse"
       source_text = source_text + base_file_string
 
-      parsed_file = Parsing::parse_text(source_text)
+      parsed_file = Parsing::parse_text(source_text, 'cuke_modeler_stand_alone_tag.feature')
 
       parsed_file.first['tags'].first
     end

data/lib/cuke_modeler/test_element.rb

@@ -37,20 +37,20 @@ module CukeModeler
     private
 
 
-    def process_source(source)
+    def process_source(source, file_name = nil)
       case
         when source.is_a?(String)
-          parse_test_element(source)
+          parse_test_element(source, file_name)
         else
           source
       end
     end
 
-    def parse_test_element(source_text)
+    def parse_test_element(source_text, file_name = nil)
       base_file_string = "Feature: Fake feature to parse\n"
       source_text = base_file_string + source_text
 
-      parsed_file = Parsing::parse_text(source_text)
+      parsed_file = Parsing::parse_text(source_text, file_name)
 
       parsed_file.first['elements'].first
     end

data/lib/cuke_modeler/version.rb

@@ -1,3 +1,3 @@
 module CukeModeler
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/spec_helper.rb

@@ -26,6 +26,8 @@ RSpec.configure do |config|
   end
 
   config.before(:each) do
+    FileUtils.remove_dir(@default_file_directory, true) if File.exists?(@default_file_directory)
+
     FileUtils.mkdir(@default_file_directory)
   end
 

data/spec/unit/background_unit_spec.rb

@@ -24,6 +24,12 @@ describe 'Background, Unit' do
     @element.name.should == 'test background'
   end
 
+  it 'provides a descriptive filename when being parsed from stand alone text' do
+    source = "bad background text \n Background:\n And a step\n @foo "
+
+    expect { clazz.new(source) }.to raise_error(/'cuke_modeler_stand_alone_background\.feature'/)
+  end
+
   it 'stores the original data generated by the parsing adapter', :gherkin3 => true do
     background = clazz.new('Background: test background')
     raw_data = background.raw_element

data/spec/unit/doc_string_unit_spec.rb

@@ -22,6 +22,12 @@ describe 'DocString, Unit' do
     @element.contents.should == ["some doc string"]
   end
 
+  it 'provides a descriptive filename when being parsed from stand alone text' do
+    source = 'bad doc string text'
+
+    expect { clazz.new(source) }.to raise_error(/'cuke_modeler_stand_alone_doc_string\.feature'/)
+  end
+
   it 'stores the original data generated by the parsing adapter', :gherkin3 => true do
     doc_string = clazz.new("\"\"\"\nsome doc string\n\"\"\"")
     raw_data = doc_string.raw_element

data/spec/unit/example_unit_spec.rb

@@ -29,6 +29,12 @@ describe 'Example, Unit' do
     @element.name.should == 'test example'
   end
 
+  it 'provides a descriptive filename when being parsed from stand alone text' do
+    source = 'bad example text'
+
+    expect { clazz.new(source) }.to raise_error(/'cuke_modeler_stand_alone_example\.feature'/)
+  end
+
   it 'stores the original data generated by the parsing adapter', :gherkin3 => true do
     example = clazz.new("Examples: test example\n|param|\n|value|")
     raw_data = example.raw_element

data/spec/unit/feature_file_unit_spec.rb

@@ -16,12 +16,19 @@ describe 'FeatureFile, Unit' do
     @feature_file = clazz.new
   end
 
-  it 'cannot model a non-existent directory' do
+  it 'cannot model a non-existent file' do
     path = "#{@default_file_directory}/missing_file.txt"
 
     expect { CukeModeler::FeatureFile.new(path) }.to raise_error(ArgumentError)
   end
 
+  it 'provides its own filename when being parsed' do
+    path = "#{@default_file_directory}/#{@default_feature_file_name}"
+    File.open(path, "w") { |file| file.puts 'bad feature text' }
+
+    expect { clazz.new(path) }.to raise_error(/'#{path}'/)
+  end
+
   it 'knows the name of the file that it is modeling' do
     path = "#{@default_file_directory}/#{@default_feature_file_name}"
     File.open(path, "w") { |file| file.puts "Feature:" }
@@ -35,9 +42,9 @@ describe 'FeatureFile, Unit' do
     path = "#{@default_file_directory}/#{@default_feature_file_name}"
     File.open(path, "w") { |file| file.puts "Feature:" }
 
-    directory = CukeModeler::FeatureFile.new(path)
+    file = CukeModeler::FeatureFile.new(path)
 
-    directory.path.should == path
+    file.path.should == path
   end
 
   it 'has features - #features' do

data/spec/unit/feature_unit_spec.rb

@@ -28,6 +28,12 @@ describe 'Feature, Unit' do
     @element.name.should == 'test feature'
   end
 
+  it 'provides a descriptive filename when being parsed from stand alone text' do
+    source = 'bad feature text'
+
+    expect { clazz.new(source) }.to raise_error(/'cuke_modeler_stand_alone_feature\.feature'/)
+  end
+
   it 'stores the original data generated by the parsing adapter', :gherkin3 => true do
     feature = clazz.new('Feature: test feature')
     raw_data = feature.raw_element

data/spec/unit/outline_unit_spec.rb

@@ -29,6 +29,12 @@ describe 'Outline, Unit' do
     @element.name.should == 'test outline'
   end
 
+  it 'provides a descriptive filename when being parsed from stand alone text' do
+    source = "bad outline text \n Scenario Outline:\n And a step\n @foo "
+
+    expect { clazz.new(source) }.to raise_error(/'cuke_modeler_stand_alone_outline\.feature'/)
+  end
+
   it 'stores the original data generated by the parsing adapter', :gherkin3 => true do
     outline = clazz.new("Scenario Outline: test outline\nExamples:\n|param|\n|value|")
     raw_data = outline.raw_element

data/spec/unit/parsing_unit_spec.rb

@@ -4,18 +4,82 @@ SimpleCov.command_name('Parsing') unless RUBY_VERSION.to_s < '1.9.0'
 
 describe 'Parsing, Unit' do
 
+  let(:nodule) { CukeModeler::Parsing }
+
+
   it 'can parse text - #parse_text' do
-    CukeModeler::Parsing.should respond_to(:parse_text)
+    nodule.should respond_to(:parse_text)
   end
 
   it 'can only parse strings' do
-    expect{CukeModeler::Parsing.parse_text(5)}.to raise_error(ArgumentError)
-    expect{CukeModeler::Parsing.parse_text('Feature:')}.to_not raise_error
+    expect { nodule.parse_text(5) }.to raise_error(ArgumentError)
+    expect { nodule.parse_text('Feature:') }.to_not raise_error
   end
 
   it 'returns an Array' do
-    result = CukeModeler::Parsing.parse_text('Feature:')
+    result = nodule.parse_text('Feature:')
     result.is_a?(Array).should be_true
   end
 
+  it 'takes the text that is to be parsed and an optional file name' do
+    expect(nodule.method(:parse_text).arity).to eq(-2)
+  end
+
+  it 'raises and error if an error is encountered while parsing text' do
+    expect { nodule.parse_text('bad file') }.to raise_error(ArgumentError, /Error encountered while parsing '.*'/)
+  end
+
+  it 'includes the file parsed in the error that it raises' do
+    expect { nodule.parse_text('bad file', 'file foo.txt') }.to raise_error(/'file foo\.txt'/)
+  end
+
+  it 'includes the underlying error message in the error that it raises' do
+    begin
+      # Custom error type in order to ensure that we are throwing the correct thing
+      module CukeModeler
+        class TestError < StandardError
+        end
+      end
+
+      # Monkey patch Gherkin to throw the error that we need for testing
+      if Gem.loaded_specs['gherkin'].version.version[/^3/]
+        old_method = Gherkin::Parser.instance_method(:parse)
+
+        module Gherkin
+          class Parser
+            def parse(*args)
+              raise(CukeModeler::TestError, 'something went wrong')
+            end
+          end
+        end
+      else
+        old_method = Gherkin::Parser::Parser.instance_method(:parse)
+
+        module Gherkin
+          module Parser
+            class Parser
+              def parse(*args)
+                raise(CukeModeler::TestError, 'something went wrong')
+              end
+            end
+          end
+        end
+      end
+
+      expect { nodule.parse_text('bad file') }.to raise_error(/CukeModeler::TestError.*something went wrong/)
+    ensure
+      # Making sure that our changes don't escape a test and ruin the rest of the suite
+      if Gem.loaded_specs['gherkin'].version.version[/^3/]
+        Gherkin::Parser.send(:define_method, :parse, old_method)
+      else
+        Gherkin::Parser::Parser.send(:define_method, :parse, old_method)
+      end
+    end
+
+  end
+
+  it 'has a default file name if one is not provided' do
+    expect { nodule.parse_text('bad file') }.to raise_error(ArgumentError, /'cuke_modeler_fake_file\.feature'/)
+  end
+
 end

data/spec/unit/row_unit_spec.rb

@@ -21,6 +21,12 @@ describe 'Row, Unit' do
     @element.cells.should == ['a', 'row']
   end
 
+  it 'provides a descriptive filename when being parsed from stand alone text' do
+    source = " |bad |row| text| \n @foo "
+
+    expect { clazz.new(source) }.to raise_error(/'cuke_modeler_stand_alone_row\.feature'/)
+  end
+
   it 'stores the original data generated by the parsing adapter', :gherkin3 => true do
     example_row = clazz.new("| a | row |")
     raw_data = example_row.raw_element

data/spec/unit/scenario_unit_spec.rb

@@ -25,6 +25,12 @@ describe 'Scenario, Unit' do
     @element.name.should == 'test scenario'
   end
 
+  it 'provides a descriptive filename when being parsed from stand alone text' do
+    source = "bad scenario text \n Scenario:\n And a step\n @foo "
+
+    expect { clazz.new(source) }.to raise_error(/'cuke_modeler_stand_alone_scenario\.feature'/)
+  end
+
   it 'stores the original data generated by the parsing adapter', :gherkin3 => true do
     scenario = clazz.new("Scenario: test scenario")
     raw_data = scenario.raw_element

data/spec/unit/step_unit_spec.rb

@@ -187,6 +187,12 @@ describe 'Step, Unit' do
     @element.base.should == 'test step'
   end
 
+  it 'provides a descriptive filename when being parsed from stand alone text' do
+    source = "bad step text\n And a step\n @foo"
+
+    expect { clazz.new(source) }.to raise_error(/'cuke_modeler_stand_alone_step\.feature'/)
+  end
+
   it 'stores the original data generated by the parsing adapter', :gherkin3 => true do
     step = clazz.new("* test step")
     raw_data = step.raw_element

data/spec/unit/table_row_unit_spec.rb

@@ -21,6 +21,12 @@ describe 'TableRow, Unit' do
     @element.cells.should == ['a', 'row']
   end
 
+  it 'provides a descriptive filename when being parsed from stand alone text' do
+    source = 'bad table row text'
+
+    expect { clazz.new(source) }.to raise_error(/'cuke_modeler_stand_alone_table_row\.feature'/)
+  end
+
   it 'stores the original data generated by the parsing adapter', :gherkin3 => true do
     table_row = clazz.new("| a | row |")
     raw_data = table_row.raw_element

data/spec/unit/table_unit_spec.rb

@@ -22,6 +22,12 @@ describe 'Table, Unit' do
     @element.contents.should == [['a table']]
   end
 
+  it 'provides a descriptive filename when being parsed from stand alone text' do
+    source = 'bad table text'
+
+    expect { clazz.new(source) }.to raise_error(/'cuke_modeler_stand_alone_table\.feature'/)
+  end
+
   it 'stores the original data generated by the parsing adapter', :gherkin3 => true do
     table = clazz.new("| a table |")
     raw_data = table.raw_element

data/spec/unit/tag_unit_spec.rb

@@ -20,6 +20,12 @@ describe 'Tag, Unit' do
     @element.name.should == '@a_tag'
   end
 
+  it 'provides a descriptive filename when being parsed from stand alone text' do
+    source = 'bad tag text'
+
+    expect { clazz.new(source) }.to raise_error(/'cuke_modeler_stand_alone_tag\.feature'/)
+  end
+
   it 'stores the original data generated by the parsing adapter', :gherkin3 => true do
     tag = clazz.new('@a_tag')
     raw_data = tag.raw_element

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cuke_modeler
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-10 00:00:00.000000000 Z
+date: 2016-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin