cuke_linter 0.11.1 → 0.12.0

data/testing/rspec/spec/unit/linters/element_with_duplicate_tags_linter_unit_spec.rb

@@ -0,0 +1,203 @@
+require_relative '../../../../../environments/rspec_env'
+
+
+RSpec.describe CukeLinter::ElementWithDuplicateTagsLinter do
+
+  let(:model_file_path) { 'some_file_path' }
+
+  it_should_behave_like 'a linter at the unit level'
+  it_should_behave_like 'a configurable linter at the unit level'
+
+
+  it 'has a name' do
+    expect(subject.name).to eq('ElementWithDuplicateTagsLinter')
+  end
+
+  describe 'linting' do
+
+    TAGGABLE_ELEMENTS.each do |model_type|
+
+      context "with a #{model_type} that has duplicate tags" do
+
+        let(:test_model) do
+          model      = CukeLinter::ModelFactory.send("generate_#{model_type}_model", parent_file_path: model_file_path)
+          model.tags = [CukeLinter::ModelFactory.generate_tag_model(source_text: '@same'),
+                        CukeLinter::ModelFactory.generate_tag_model(source_text: '@same')]
+
+          model
+        end
+
+        it_should_behave_like 'a linter linting a bad model'
+
+
+        it 'records a problem' do
+          result = subject.lint(test_model)
+
+          expect(result[:problem]).to match(/^#{model_type.capitalize} has duplicate tag '@\w+'\.$/)
+        end
+
+        it 'includes the name of the duplicate tag found in the problem record' do
+          duplicate_tag = test_model.tags.first.name
+          result        = subject.lint(test_model)
+          expect(result[:problem]).to eq("#{model_type.capitalize} has duplicate tag '#{duplicate_tag}'.")
+
+          test_model.tags = [CukeLinter::ModelFactory.generate_tag_model(source_text: '@still_same'),
+                             CukeLinter::ModelFactory.generate_tag_model(source_text: '@still_same')]
+
+          duplicate_tag = test_model.tags.first.name
+          result        = subject.lint(test_model)
+          expect(result[:problem]).to eq("#{model_type.capitalize} has duplicate tag '#{duplicate_tag}'.")
+        end
+
+      end
+
+      context "with a #{model_type} that does not have duplicate tags" do
+
+        context 'because none of it tags are duplicates' do
+
+          let(:test_model) do
+            model      = CukeLinter::ModelFactory.send("generate_#{model_type}_model")
+            model.tags = [CukeLinter::ModelFactory.generate_tag_model(source_text: '@foo'),
+                          CukeLinter::ModelFactory.generate_tag_model(source_text: '@bar')]
+
+            model
+          end
+
+          it_should_behave_like 'a linter linting a good model'
+
+        end
+
+        context 'because it has no tags' do
+
+          context 'because its tags are empty' do
+
+            let(:test_model) do
+              model      = CukeLinter::ModelFactory.send("generate_#{model_type}_model")
+              model.tags = []
+
+              model
+            end
+
+            it_should_behave_like 'a linter linting a good model'
+
+          end
+
+          context 'because its tags are nil' do
+
+            let(:test_model) do
+              model      = CukeLinter::ModelFactory.send("generate_#{model_type}_model")
+              model.tags = nil
+
+              model
+            end
+
+            it_should_behave_like 'a linter linting a good model'
+
+          end
+
+        end
+
+      end
+
+
+      describe 'configuration' do
+
+        describe 'tag inheritance configuration' do
+
+          let(:test_model_with_inherited_tags) do
+            test_model      = CukeLinter::ModelFactory.send("generate_#{model_type}_model")
+            test_model.tags = [CukeLinter::ModelFactory.generate_tag_model(source_text: '@same')]
+
+            distant_ancestor_model      = CukeLinter::ModelFactory.generate_lintable_model
+            distant_ancestor_model.tags = [CukeLinter::ModelFactory.generate_tag_model(source_text: '@same')]
+            ancestor_model              = CukeLinter::ModelFactory.generate_lintable_model
+
+            # Adding an extra ancestor in the chain in order to make sure that the linter isn't just checking the parent model
+            ancestor_model.parent_model = distant_ancestor_model
+            test_model.parent_model     = ancestor_model
+
+            test_model
+          end
+
+
+          context 'with no configuration' do
+
+            context 'because configuration never happened' do
+
+              it 'does not include inherited tags' do
+                result = subject.lint(test_model_with_inherited_tags)
+
+                expect(result).to eq(nil)
+              end
+
+            end
+
+            context 'because configuration did not set tag inheritance' do
+
+              let(:configuration) { {} }
+
+              before(:each) do
+                subject.configure(configuration)
+              end
+
+              it 'does not include inherited tags' do
+                result = subject.lint(test_model_with_inherited_tags)
+
+                expect(result).to eq(nil)
+              end
+
+            end
+
+          end
+
+          context 'with configuration' do
+
+            before(:each) do
+              subject.configure(configuration)
+            end
+
+            context 'enabling tag inheritance' do
+
+              let(:configuration) { { 'IncludeInheritedTags' => true } }
+
+              it 'does include inherited tags' do
+                result = subject.lint(test_model_with_inherited_tags)
+
+                expect(result).to_not be_nil
+                expect(result[:problem]).to match(/#{model_type.capitalize} has duplicate tag '@\w+'\./)
+              end
+
+            end
+
+            context 'disabling tag inheritance' do
+
+              let(:configuration) { { 'IncludeInheritedTags' => false } }
+
+              it 'does not include inherited tags' do
+                result = subject.lint(test_model_with_inherited_tags)
+
+                expect(result).to eq(nil)
+              end
+
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+
+    context 'a non-taggable model' do
+
+      let(:test_model) { CukeModeler::Model.new }
+
+      it_should_behave_like 'a linter linting a good model'
+
+    end
+
+  end
+
+end

data/testing/rspec/spec/unit/linters/element_with_too_many_tags_linter_unit_spec.rb

@@ -15,10 +15,7 @@ RSpec.describe CukeLinter::ElementWithTooManyTagsLinter do
 
   describe 'linting' do
 
-    # Descriptive variable name, just in case what kinds of elements are taggable ever changes
-    taggable_elements = ['feature', 'scenario', 'outline', 'example']
-
-    taggable_elements.each do |model_type|
+    TAGGABLE_ELEMENTS.each do |model_type|
 
       context "with a #{model_type} that has too many tags" do
 

data/testing/rspec/spec/unit/linters/feature_file_with_invalid_name_linter_unit_spec.rb

@@ -93,7 +93,7 @@ RSpec.describe CukeLinter::FeatureFileWithInvalidNameLinter do
 
     end
 
-    context 'a non-test model' do
+    context 'a non-feature-file model' do
 
       let(:test_model) { CukeModeler::Model.new }
 

data/testing/rspec/spec/unit/linters/feature_file_with_mismatched_name_linter_unit_spec.rb

@@ -0,0 +1,124 @@
+require_relative '../../../../../environments/rspec_env'
+
+
+RSpec.describe CukeLinter::FeatureFileWithMismatchedNameLinter do
+
+  let(:model_file_path) { 'some_file_path' }
+
+  it_should_behave_like 'a linter at the unit level'
+
+
+  it 'has a name' do
+    expect(subject.name).to eq('FeatureFileWithMismatchedNameLinter')
+  end
+
+  describe 'linting' do
+
+    let(:test_model) do
+      feature_model = CukeLinter::ModelFactory.generate_feature_model(parent_file_path: model_file_path,
+                                                                      source_text:      "Feature: #{model_feature_name}")
+
+      feature_model.parent_model
+    end
+
+
+    context "with a feature file model that has mismatched feature name" do
+
+      let(:model_file_path) { 'foo.feature' }
+      let(:model_feature_name) { 'Bar' }
+
+      it_should_behave_like 'a linter linting a bad model'
+
+      it 'records a problem' do
+        result = subject.lint(test_model)
+
+        expect(result[:problem]).to eq('Feature file name does not match feature name.')
+      end
+
+    end
+
+    context "with a feature file model that does not have a mismatched feature name" do
+
+      context 'with a file name that has caps' do
+        let(:model_file_path) { 'Name With Caps.feature' }
+        let(:model_feature_name) { 'name with caps' }
+
+        it_should_behave_like 'a linter linting a good model'
+      end
+
+      context 'with a feature name that has caps' do
+        let(:model_file_path) { 'name with caps.feature' }
+        let(:model_feature_name) { 'Name With Caps' }
+
+        it_should_behave_like 'a linter linting a good model'
+      end
+
+      context 'with a file name that has underscores' do
+        let(:model_file_path) { 'name_with_underscores.feature' }
+        let(:model_feature_name) { 'name with underscores' }
+
+        it_should_behave_like 'a linter linting a good model'
+      end
+
+      context 'with a feature name that has underscores' do
+        let(:model_file_path) { 'name with underscores.feature' }
+        let(:model_feature_name) { 'name_with_underscores' }
+
+        it_should_behave_like 'a linter linting a good model'
+      end
+
+      context 'with a file name that has spaces' do
+        let(:model_file_path) { 'name with spaces.feature' }
+        let(:model_feature_name) { 'namewithspaces' }
+
+        it_should_behave_like 'a linter linting a good model'
+      end
+
+      context 'with a feature name that has spaces' do
+        let(:model_file_path) { 'namewithspaces.feature' }
+        let(:model_feature_name) { 'name with spaces' }
+
+        it_should_behave_like 'a linter linting a good model'
+      end
+
+      context 'with a file name that has hyphens' do
+        let(:model_file_path) { 'name-with-hyphens.feature' }
+        let(:model_feature_name) { 'namewithhyphens' }
+
+        it_should_behave_like 'a linter linting a good model'
+      end
+
+      context 'with a feature name that has hyphens' do
+        let(:model_file_path) { 'namewithhyphens.feature' }
+        let(:model_feature_name) { 'name-with-hyphens' }
+
+        it_should_behave_like 'a linter linting a good model'
+      end
+
+      context 'with a file name that has mixed ignored characters' do
+        let(:model_file_path) { '_namewith lotsOf-stuff.feature' }
+        let(:model_feature_name) { 'namewithlotsofstuff' }
+
+        it_should_behave_like 'a linter linting a good model'
+      end
+
+      context 'with a feature name that has mixed ignored characters' do
+        let(:model_file_path) { 'namewithlotsofstuff.feature' }
+        let(:model_feature_name) { '_namewith lotsOf-stuff' }
+
+        it_should_behave_like 'a linter linting a good model'
+      end
+
+    end
+
+    context 'a non-feature-file model' do
+
+      let(:test_model) { CukeModeler::Model.new }
+
+      it_should_behave_like 'a linter linting a good model'
+
+    end
+
+  end
+
+end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: cuke_linter
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Eric Kessler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-07 00:00:00.000000000 Z
+date: 2020-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cuke_modeler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -178,9 +184,12 @@ files:
 - lib/cuke_linter.rb
 - lib/cuke_linter/formatters/pretty_formatter.rb
 - lib/cuke_linter/linters/background_does_more_than_setup_linter.rb
+- lib/cuke_linter/linters/element_with_common_tags_linter.rb
+- lib/cuke_linter/linters/element_with_duplicate_tags_linter.rb
 - lib/cuke_linter/linters/element_with_too_many_tags_linter.rb
 - lib/cuke_linter/linters/example_without_name_linter.rb
 - lib/cuke_linter/linters/feature_file_with_invalid_name_linter.rb
+- lib/cuke_linter/linters/feature_file_with_mismatched_name_linter.rb
 - lib/cuke_linter/linters/feature_with_too_many_different_tags_linter.rb
 - lib/cuke_linter/linters/feature_without_description_linter.rb
 - lib/cuke_linter/linters/feature_without_name_linter.rb
@@ -209,9 +218,12 @@ files:
 - testing/cucumber/features/default_linters.feature
 - testing/cucumber/features/formatters/pretty_formatter.feature
 - testing/cucumber/features/linters/background_does_more_than_setup.feature
+- testing/cucumber/features/linters/element_with_common_tags.feature
+- testing/cucumber/features/linters/element_with_duplicate_tags.feature
 - testing/cucumber/features/linters/element_with_too_many_tags.feature
 - testing/cucumber/features/linters/example_without_name.feature
 - testing/cucumber/features/linters/feature_file_with_invalid_name.feature
+- testing/cucumber/features/linters/feature_file_with_mismatched_name.feature
 - testing/cucumber/features/linters/feature_with_too_many_different_tags.feature
 - testing/cucumber/features/linters/feature_without_description.feature
 - testing/cucumber/features/linters/feature_without_name.feature
@@ -235,6 +247,8 @@ files:
 - testing/cucumber/step_definitions/verification_steps.rb
 - testing/file_helper.rb
 - testing/formatter_factory.rb
+- testing/gemfiles/cuke_modeler1.gemfile
+- testing/gemfiles/cuke_modeler2.gemfile
 - testing/linter_factory.rb
 - testing/model_factory.rb
 - testing/rspec/spec/integration/cli_integration_spec.rb
@@ -243,9 +257,12 @@ files:
 - testing/rspec/spec/integration/formatters/formatter_integration_specs.rb
 - testing/rspec/spec/integration/formatters/pretty_formatter_integration_spec.rb
 - testing/rspec/spec/integration/linters/background_does_more_than_setup_linter_integration_spec.rb
+- testing/rspec/spec/integration/linters/element_with_common_tags_linter_integration_spec.rb
+- testing/rspec/spec/integration/linters/element_with_duplicate_tags_linter_integration_spec.rb
 - testing/rspec/spec/integration/linters/element_with_too_many_tags_linter_integration_spec.rb
 - testing/rspec/spec/integration/linters/example_without_name_linter_integration_spec.rb
 - testing/rspec/spec/integration/linters/feature_file_with_invalid_name_integration_spec.rb
+- testing/rspec/spec/integration/linters/feature_file_with_mismatched_name_integration_spec.rb
 - testing/rspec/spec/integration/linters/feature_with_too_many_different_tags_linter_integration_spec.rb
 - testing/rspec/spec/integration/linters/feature_without_description_linter_integration_spec.rb
 - testing/rspec/spec/integration/linters/feature_without_name_linter_integration_spec.rb
@@ -271,9 +288,12 @@ files:
 - testing/rspec/spec/unit/formatters/pretty_formatter_unit_spec.rb
 - testing/rspec/spec/unit/linters/background_does_more_than_setup_linter_unit_spec.rb
 - testing/rspec/spec/unit/linters/configurable_linter_unit_specs.rb
+- testing/rspec/spec/unit/linters/element_with_common_tags_linter_unit_spec.rb
+- testing/rspec/spec/unit/linters/element_with_duplicate_tags_linter_unit_spec.rb
 - testing/rspec/spec/unit/linters/element_with_too_many_tags_linter_unit_spec.rb
 - testing/rspec/spec/unit/linters/example_without_name_linter_unit_spec.rb
 - testing/rspec/spec/unit/linters/feature_file_with_invalid_name_linter_unit_spec.rb
+- testing/rspec/spec/unit/linters/feature_file_with_mismatched_name_linter_unit_spec.rb
 - testing/rspec/spec/unit/linters/feature_with_too_many_different_tags_linter_unit_spec.rb
 - testing/rspec/spec/unit/linters/feature_without_description_linter_unit_spec.rb
 - testing/rspec/spec/unit/linters/feature_without_name_linter_unit_spec.rb