cuke_modeler 2.1.0 → 3.0.0

data/testing/rspec/spec/integration/models/comment_integration_spec.rb

@@ -1,180 +0,0 @@
-require "#{File.dirname(__FILE__)}/../../spec_helper"
-
-
-describe 'Comment, Integration' do
-
-  let(:clazz) { CukeModeler::Comment }
-
-
-  describe 'common behavior' do
-
-    it_should_behave_like 'a model, integration'
-
-  end
-
-
-  describe 'unique behavior' do
-
-    it 'can be instantiated with the minimum viable Gherkin' do
-      source = '# a comment'
-
-      expect { clazz.new(source) }.to_not raise_error
-    end
-
-    it 'can parse text that uses a non-default dialect' do
-      original_dialect = CukeModeler::Parsing.dialect
-      CukeModeler::Parsing.dialect = 'en-au'
-
-      begin
-        source_text = '# a comment'
-
-        expect { @model = clazz.new(source_text) }.to_not raise_error
-
-        # Sanity check in case modeling failed in a non-explosive manner
-        expect(@model.text).to eq('# a comment')
-      ensure
-        # Making sure that our changes don't escape a test and ruin the rest of the suite
-        CukeModeler::Parsing.dialect = original_dialect
-      end
-    end
-
-    it 'provides a descriptive filename when being parsed from stand alone text' do
-      source = 'bad comment text'
-
-      expect { clazz.new(source) }.to raise_error(/'cuke_modeler_stand_alone_comment\.feature'/)
-    end
-
-    describe 'parsing data' do
-
-      it 'stores the original data generated by the parsing adapter', :if => gherkin?(6, 7, 8, 9) do
-        comment = clazz.new('# a comment')
-        data = comment.parsing_data
-
-        expect(data.keys).to match_array([:location, :text])
-        expect(data[:text]).to eq('# a comment')
-      end
-
-      it 'stores the original data generated by the parsing adapter', :if => gherkin?(4, 5) do
-        comment = clazz.new('# a comment')
-        data = comment.parsing_data
-
-        expect(data.keys).to match_array([:type, :location, :text])
-        expect(data[:type]).to eq(:Comment)
-      end
-
-      it 'stores the original data generated by the parsing adapter', :if => gherkin?(3) do
-        comment = clazz.new('# a comment')
-        data = comment.parsing_data
-
-        expect(data.keys).to match_array([:type, :location, :text])
-        expect(data[:type]).to eq('Comment')
-      end
-
-      it 'stores the original data generated by the parsing adapter', :if => gherkin?(2) do
-        comment = clazz.new('# a comment')
-        data = comment.parsing_data
-
-        expect(data.keys).to match_array(['value', 'line'])
-      end
-
-    end
-
-    describe 'getting ancestors' do
-
-      before(:each) do
-        CukeModeler::FileHelper.create_feature_file(:text => source_gherkin, :name => 'comment_test_file', :directory => test_directory)
-      end
-
-
-      let(:test_directory) { CukeModeler::FileHelper.create_directory }
-      let(:source_gherkin) { "# feature comment
-                              #{FEATURE_KEYWORD}: Test feature"
-      }
-
-      let(:directory_model) { CukeModeler::Directory.new(test_directory) }
-      let(:comment_model) { directory_model.feature_files.first.comments.first }
-
-
-      it 'can get its directory' do
-        ancestor = comment_model.get_ancestor(:directory)
-
-        expect(ancestor).to equal(directory_model)
-      end
-
-      it 'can get its feature file' do
-        ancestor = comment_model.get_ancestor(:feature_file)
-
-        expect(ancestor).to equal(directory_model.feature_files.first)
-      end
-
-      it 'returns nil if it does not have the requested type of ancestor' do
-        ancestor = comment_model.get_ancestor(:example)
-
-        expect(ancestor).to be_nil
-      end
-
-    end
-
-
-    describe 'model population' do
-
-      context 'from source text' do
-
-        let(:source_text) { '# a comment' }
-        let(:comment) { clazz.new(source_text) }
-
-
-        it "models the comment's text" do
-          expect(comment.text).to eq('# a comment')
-        end
-
-        it "models the comment's source line" do
-          source_text = "# a comment
-                         #{FEATURE_KEYWORD}:"
-
-          test_file_path = CukeModeler::FileHelper.create_feature_file(:text => source_text, :name => 'comment_test_file')
-          comment = CukeModeler::FeatureFile.new(test_file_path).comments.first
-
-          expect(comment.source_line).to eq(1)
-        end
-
-        it 'removes surrounding whitespace' do
-          comment = clazz.new('           # a comment             ')
-
-          expect(comment.text).to eq('# a comment')
-        end
-
-      end
-
-    end
-
-
-    describe 'comment output' do
-
-      it 'can be remade from its own output' do
-        source = '# a comment'
-        comment = clazz.new(source)
-
-        comment_output = comment.to_s
-        remade_comment_output = clazz.new(comment_output).to_s
-
-        expect(remade_comment_output).to eq(comment_output)
-      end
-
-
-      context 'from source text' do
-
-        it 'can output a comment' do
-          source = '# a comment'
-          comment = clazz.new(source)
-
-          expect(comment.to_s).to eq('# a comment')
-        end
-
-      end
-
-    end
-
-  end
-
-end

data/testing/rspec/spec/integration/models/directory_integration_spec.rb

@@ -1,218 +0,0 @@
-require "#{File.dirname(__FILE__)}/../../spec_helper"
-
-
-describe 'Directory, Integration' do
-
-  let(:clazz) { CukeModeler::Directory }
-
-
-  describe 'common behavior' do
-
-    it_should_behave_like 'a model, integration'
-
-  end
-
-
-  describe 'unique behavior' do
-
-
-    describe 'modeling directories' do
-
-
-      context 'with an existing directory' do
-
-        let(:root_test_path) { CukeModeler::FileHelper.create_directory }
-
-        let(:directory_path) { CukeModeler::FileHelper.create_directory(:name => 'nested_directory', :directory => root_test_path) }
-        let(:directory_model) { clazz.new(directory_path) }
-
-
-        it 'models the path of the directory' do
-          expect(directory_model.path).to eq(directory_path)
-        end
-
-        it 'models the name of the directory' do
-          name = File.basename(directory_path)
-
-          expect(directory_model.name).to eq(name)
-        end
-
-
-        context 'with both files and feature files' do
-
-          let(:feature_files) { ['test_file_1', 'test_file_2'] }
-          let(:non_feature_files) { ['test_file_3'] }
-
-          before(:each) do
-            feature_files.each do |file_name|
-              # Some versions of Gherkin require feature content to be present in feature files
-              CukeModeler::FileHelper.create_feature_file(:text => "#{FEATURE_KEYWORD}: Test feature", :name => file_name, :directory => directory_path)
-            end
-
-            non_feature_files.each do |file_name|
-              CukeModeler::FileHelper.create_file(:text => '', :name => file_name, :extension => '.file', :directory => directory_path)
-            end
-          end
-
-
-          it 'models the feature files contained in the directory' do
-            modeled_files = directory_model.feature_files.collect { |file| file.name[/test_file_\d/] }
-
-            expect(modeled_files).to match_array(feature_files)
-          end
-
-          it 'does not model non-feature files contained in the directory' do
-            modeled_files = directory_model.feature_files.collect { |file| file.name[/test_file_\d/] }
-
-            non_feature_files.all? do |file|
-              expect(modeled_files).to_not include(file)
-            end
-          end
-
-        end
-
-
-        context 'with no feature files' do
-
-          let(:directory_path) { CukeModeler::FileHelper.create_directory(:name => 'empty_directory', :directory => root_test_path) }
-          let(:directory_model) { clazz.new(directory_path) }
-
-
-          it 'models the feature files contained in the directory' do
-            modeled_files = directory_model.feature_files.collect { |file| file.name }
-
-            expect(modeled_files).to eq([])
-          end
-
-        end
-
-
-        context 'with a nested directory' do
-
-          let(:directory_path) { CukeModeler::FileHelper.create_directory(:name => 'test_directory', :directory => root_test_path) }
-          let(:directory_model) { clazz.new(directory_path) }
-
-          let(:nested_directories) { ['nested_directory_1', 'nested_directory_2'] }
-
-          before(:each) do
-            nested_directories.each do |nested_directory|
-              CukeModeler::FileHelper.create_directory(:name => nested_directory, :directory => directory_path)
-            end
-          end
-
-
-          it 'models the directories in the directory' do
-            modeled_directories = directory_model.directories.collect { |nested_directory| nested_directory.name[/nested_directory_\d/] }
-
-            expect(modeled_directories).to match_array(nested_directories)
-          end
-
-        end
-
-
-        context 'with no directories' do
-
-          let(:directory_path) { CukeModeler::FileHelper.create_directory(:name => 'empty_directory', :directory => root_test_path) }
-          let(:directory_model) { clazz.new(directory_path) }
-
-
-          it 'models the directories contained in the directory' do
-            modeled_directories = directory_model.directories.collect { |nested_directory| nested_directory.name }
-
-            expect(modeled_directories).to eq([])
-          end
-
-        end
-
-      end
-
-
-      context 'with a non-existing directory' do
-
-        let(:root_test_path) { CukeModeler::FileHelper.create_directory }
-        let(:directory_path) { "#{root_test_path}/this_directory_should_not_exist" }
-
-
-        it 'cannot model a non-existent directory' do
-          expect { clazz.new(directory_path) }.to raise_error(ArgumentError)
-        end
-
-      end
-
-    end
-
-
-    it 'properly sets its child models' do
-      directory_path = CukeModeler::FileHelper.create_directory
-      _nested_directory_path = CukeModeler::FileHelper.create_directory(:name => 'nested_directory', :directory => directory_path)
-
-      CukeModeler::FileHelper.create_feature_file(:text => "#{FEATURE_KEYWORD}: Test feature", :name => 'test_file', :directory => directory_path)
-
-
-      directory_model = clazz.new(directory_path)
-      nested_directory_model = directory_model.directories.first
-      file_model = directory_model.feature_files.first
-
-      expect(nested_directory_model.parent_model).to equal(directory_model)
-      expect(file_model.parent_model).to equal(directory_model)
-    end
-
-
-    describe 'getting ancestors' do
-
-      before(:each) do
-        CukeModeler::FileHelper.create_directory(:name => 'nested_directory', :directory => test_directory)
-      end
-
-      let(:test_directory) { CukeModeler::FileHelper.create_directory }
-
-      let(:directory_model) { clazz.new(test_directory) }
-      let(:nested_directory_model) { directory_model.directories.first }
-
-
-      it 'can get its directory' do
-        ancestor = nested_directory_model.get_ancestor(:directory)
-
-        expect(ancestor).to equal(directory_model)
-      end
-
-      it 'returns nil if it does not have the requested type of ancestor' do
-        ancestor = nested_directory_model.get_ancestor(:example)
-
-        expect(ancestor).to be_nil
-      end
-
-    end
-
-
-    describe 'directory output' do
-
-      context 'from source text' do
-
-        let(:directory_path) { CukeModeler::FileHelper.create_directory }
-        let(:directory_model) { clazz.new(directory_path) }
-
-
-        it 'can output a directory' do
-          directory_output = directory_model.to_s
-
-          expect(directory_output).to eq(directory_path)
-        end
-
-      end
-
-      it 'can be remade from its own output' do
-        source = CukeModeler::FileHelper.create_directory
-        directory = clazz.new(source)
-
-        directory_output = directory.to_s
-        remade_directory_output = clazz.new(directory_output).to_s
-
-        expect(remade_directory_output).to eq(directory_output)
-      end
-
-    end
-
-  end
-
-end

data/testing/rspec/spec/integration/models/doc_string_integration_spec.rb

@@ -1,398 +0,0 @@
-require "#{File.dirname(__FILE__)}/../../spec_helper"
-
-
-describe 'DocString, Integration' do
-
-  let(:clazz) { CukeModeler::DocString }
-
-
-  describe 'common behavior' do
-
-    it_should_behave_like 'a model, integration'
-
-  end
-
-  describe 'unique behavior' do
-
-    it 'can be instantiated with the minimum viable Gherkin' do
-      source = "\"\"\"\n\"\"\""
-
-      expect { clazz.new(source) }.to_not raise_error
-    end
-
-    it 'can parse text that uses a non-default dialect' do
-      original_dialect = CukeModeler::Parsing.dialect
-      CukeModeler::Parsing.dialect = 'en-au'
-
-      begin
-        source_text = "\"\"\"\ntext foo\n\"\"\""
-
-        expect { @model = clazz.new(source_text) }.to_not raise_error
-
-        # Sanity check in case modeling failed in a non-explosive manner
-        expect(@model.content).to eq('text foo')
-      ensure
-        # Making sure that our changes don't escape a test and ruin the rest of the suite
-        CukeModeler::Parsing.dialect = original_dialect
-      end
-    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
-
-    describe 'parsing data' do
-
-      it 'stores the original data generated by the parsing adapter', :if => gherkin?(6, 7, 8, 9) do
-        doc_string = clazz.new("\"\"\" content type\nsome doc string\n\"\"\"")
-        data = doc_string.parsing_data
-
-        expect(data.keys).to match_array([:location, :content, :content_type, :delimiter])
-        expect(data[:content]).to eq('some doc string')
-      end
-
-      it 'stores the original data generated by the parsing adapter', :if => gherkin?(3, 4, 5) do
-        doc_string = clazz.new("\"\"\" content type\nsome doc string\n\"\"\"")
-        data = doc_string.parsing_data
-
-        expect(data.keys).to match_array([:type, :location, :content, :contentType])
-        expect(data[:type]).to eq(:DocString)
-      end
-
-      it 'stores the original data generated by the parsing adapter', :if => gherkin?(2) do
-        doc_string = clazz.new("\"\"\" content type\nsome doc string\n\"\"\"")
-        data = doc_string.parsing_data
-
-        expect(data.keys).to match_array(['value', 'content_type', 'line'])
-        expect(data['value']).to eq('some doc string')
-      end
-
-    end
-
-    it 'stores its content as a String' do
-      source = "\"\"\"\nsome text\nsome more text\n\"\"\""
-      doc_string = clazz.new(source)
-
-      content = doc_string.content
-
-      expect(content).to be_a(String)
-    end
-
-
-    describe 'getting ancestors' do
-
-      before(:each) do
-        CukeModeler::FileHelper.create_feature_file(:text => source_gherkin, :name => 'doc_string_test_file', :directory => test_directory)
-      end
-
-
-      let(:test_directory) { CukeModeler::FileHelper.create_directory }
-      let(:source_gherkin) { "#{FEATURE_KEYWORD}: Test feature
-
-                                #{SCENARIO_KEYWORD}: Test test
-                                  #{STEP_KEYWORD} a big step:
-                                \"\"\"
-                                a
-                                doc
-                                string
-                                \"\"\""
-      }
-
-      let(:directory_model) { CukeModeler::Directory.new(test_directory) }
-      let(:doc_string_model) { directory_model.feature_files.first.feature.tests.first.steps.first.block }
-
-
-      it 'can get its directory' do
-        ancestor = doc_string_model.get_ancestor(:directory)
-
-        expect(ancestor).to equal(directory_model)
-      end
-
-      it 'can get its feature file' do
-        ancestor = doc_string_model.get_ancestor(:feature_file)
-
-        expect(ancestor).to equal(directory_model.feature_files.first)
-      end
-
-      it 'can get its feature' do
-        ancestor = doc_string_model.get_ancestor(:feature)
-
-        expect(ancestor).to equal(directory_model.feature_files.first.feature)
-      end
-
-      context 'a doc string that is part of a scenario' do
-
-        let(:test_directory) { CukeModeler::FileHelper.create_directory }
-        let(:source_gherkin) { "#{FEATURE_KEYWORD}: Test feature
-
-                                  #{SCENARIO_KEYWORD}: Test test
-                                    #{STEP_KEYWORD} a big step:
-                                      \"\"\"
-                                      a
-                                      doc
-                                      string
-                                      \"\"\""
-        }
-
-        let(:directory_model) { CukeModeler::Directory.new(test_directory) }
-        let(:doc_string_model) { directory_model.feature_files.first.feature.tests.first.steps.first.block }
-
-
-        it 'can get its scenario' do
-          ancestor = doc_string_model.get_ancestor(:scenario)
-
-          expect(ancestor).to equal(directory_model.feature_files.first.feature.tests.first)
-        end
-
-      end
-
-      context 'a doc string that is part of an outline' do
-
-        let(:test_directory) { CukeModeler::FileHelper.create_directory }
-        let(:source_gherkin) { "#{FEATURE_KEYWORD}: Test feature
-
-                                  #{OUTLINE_KEYWORD}: Test outline
-                                    #{STEP_KEYWORD} a big step:
-                                      \"\"\"
-                                      a
-                                      doc
-                                      string
-                                      \"\"\"
-        #{EXAMPLE_KEYWORD}:
-                                    | param |
-                                    | value |"
-        }
-
-        let(:directory_model) { CukeModeler::Directory.new(test_directory) }
-        let(:doc_string_model) { directory_model.feature_files.first.feature.tests.first.steps.first.block }
-
-
-        it 'can get its outline' do
-          ancestor = doc_string_model.get_ancestor(:outline)
-
-          expect(ancestor).to equal(directory_model.feature_files.first.feature.tests.first)
-        end
-
-      end
-
-      context 'a doc string that is part of a background' do
-
-        let(:test_directory) { CukeModeler::FileHelper.create_directory }
-        let(:source_gherkin) { "#{FEATURE_KEYWORD}: Test feature
-
-                                  #{BACKGROUND_KEYWORD}: Test background
-                                    #{STEP_KEYWORD} a big step:
-                                      \"\"\"
-                                      a
-                                      doc
-                                      string
-                                      \"\"\""
-        }
-
-        let(:directory_model) { CukeModeler::Directory.new(test_directory) }
-        let(:doc_string_model) { directory_model.feature_files.first.feature.background.steps.first.block }
-
-
-        it 'can get its background' do
-          ancestor = doc_string_model.get_ancestor(:background)
-
-          expect(ancestor).to equal(directory_model.feature_files.first.feature.background)
-        end
-
-      end
-
-      it 'can get its step' do
-        ancestor = doc_string_model.get_ancestor(:step)
-
-        expect(ancestor).to equal(directory_model.feature_files.first.feature.tests.first.steps.first)
-      end
-
-      it 'returns nil if it does not have the requested type of ancestor' do
-        ancestor = doc_string_model.get_ancestor(:example)
-
-        expect(ancestor).to be_nil
-      end
-
-    end
-
-
-    describe 'model population' do
-
-      context 'from source text' do
-
-        context 'a filled doc string' do
-
-          let(:source_text) { ['""" type foo',
-                               'bar',
-                               '"""'].join("\n") }
-          let(:doc_string) { clazz.new(source_text) }
-
-
-          it "models the doc string's content type" do
-            expect(doc_string.content_type).to eq('type foo')
-          end
-
-          it "models the doc_string's content" do
-            expect(doc_string.content).to eq('bar')
-          end
-
-        end
-
-        context 'an empty doc_string' do
-
-          let(:source_text) { '"""
-                               """' }
-          let(:doc_string) { clazz.new(source_text) }
-
-          it "models the doc_string's content type" do
-            expect(doc_string.content_type).to be_nil
-          end
-
-          it "models the doc_string's content" do
-            expect(doc_string.content).to eq('')
-          end
-
-        end
-
-        it "models the doc string's source line" do
-          source_text = "#{FEATURE_KEYWORD}:
-
-                           #{SCENARIO_KEYWORD}:
-                             #{STEP_KEYWORD} step
-                               \"\"\"
-                               foo
-                               \"\"\""
-          doc_string = CukeModeler::Feature.new(source_text).tests.first.steps.first.block
-
-          expect(doc_string.source_line).to eq(5)
-        end
-
-      end
-
-    end
-
-
-    describe 'doc string output' do
-
-      it 'can be remade from its own output' do
-        source = ['"""" the type',
-                  "#{STEP_KEYWORD} a step",
-                  '  \"\"\"',
-                  '  that also has a doc string',
-                  '  \"\"\"',
-                  '"""']
-        source = source.join("\n")
-        doc_string = clazz.new(source)
-
-        doc_string_output = doc_string.to_s
-        remade_doc_string_output = clazz.new(doc_string_output).to_s
-
-        expect(remade_doc_string_output).to eq(doc_string_output)
-      end
-
-
-      context 'from source text' do
-
-        it 'can output an empty doc string' do
-          source = ['"""',
-                    '"""']
-          source = source.join("\n")
-          doc_string = clazz.new(source)
-
-          doc_string_output = doc_string.to_s.split("\n", -1)
-
-          expect(doc_string_output).to eq(['"""', '"""'])
-        end
-
-        it 'can output a doc string that has a content type' do
-          source = ['""" foo',
-                    '"""']
-          source = source.join("\n")
-          doc_string = clazz.new(source)
-
-          doc_string_output = doc_string.to_s.split("\n", -1)
-
-          expect(doc_string_output).to eq(['""" foo',
-                                           '"""'])
-        end
-
-        it 'can output a doc_string that has contents' do
-          source = ['"""',
-                    'foo',
-                    '"""']
-          source = source.join("\n")
-          doc_string = clazz.new(source)
-
-          doc_string_output = doc_string.to_s.split("\n", -1)
-
-          expect(doc_string_output).to eq(['"""',
-                                           'foo',
-                                           '"""'])
-        end
-
-        #  Since triple double quotes mark the beginning and end of a doc string, any triple
-        #  double quotes inside of the doc string (which would have had to have been escaped
-        #  to get inside in the first place) will be escaped when outputted so as to
-        #  retain the quality of being able to use the output directly as gherkin.
-
-        it 'can output a doc_string that has triple double quotes in the contents' do
-          source = ['"""',
-                    'a \"\"\"',
-                    '\"\"\" again',
-                    '"""']
-          source = source.join("\n")
-          doc_string = clazz.new(source)
-
-          doc_string_output = doc_string.to_s.split("\n", -1)
-
-          expect(doc_string_output).to eq(['"""',
-                                           'a \"\"\"',
-                                           '\"\"\" again',
-                                           '"""'])
-        end
-
-        # Double quotes that are not three (or more) in a row do not seem to need and special escaping when
-        # used in Gherkin. Therefore they should be left alone.
-        it 'only escapes triple double quotes' do
-          source = ['"""',
-                    'change these \"\"\"\"\"\"',
-                    'but leave " and "" alone',
-                    '"""']
-          source = source.join("\n")
-          doc_string = clazz.new(source)
-
-          doc_string_output = doc_string.to_s.split("\n", -1)
-
-          expect(doc_string_output).to eq(['"""',
-                                           'change these \"\"\"\"\"\"',
-                                           'but leave " and "" alone',
-                                           '"""'])
-        end
-
-        it 'can output a doc string that has everything' do
-          source = ['""" type foo',
-                    '\"\"\"',
-                    'bar',
-                    '\"\"\"',
-                    '"""']
-          source = source.join("\n")
-          doc_string = clazz.new(source)
-
-          doc_string_output = doc_string.to_s.split("\n", -1)
-
-          expect(doc_string_output).to eq(['""" type foo',
-                                           '\"\"\"',
-                                           'bar',
-                                           '\"\"\"',
-                                           '"""'])
-        end
-
-      end
-
-    end
-
-  end
-
-end