gherkin_lint 0.6.3 → 1.0.0

data/lib/gherkin_lint/linter/too_many_different_tags.rb

@@ -1,8 +1,11 @@
 require 'gherkin_lint/linter'
+require 'gherkin_lint/linter/tag_collector'
 
 module GherkinLint
   # service class to lint for too many different tags
   class TooManyDifferentTags < Linter
+    include TagCollector
+
     def lint
       overall_tags = []
       overall_references = []

data/lib/gherkin_lint/linter/too_many_tags.rb

@@ -1,8 +1,11 @@
 require 'gherkin_lint/linter'
+require 'gherkin_lint/linter/tag_collector'
 
 module GherkinLint
   # service class to lint for too many tags
   class TooManyTags < Linter
+    include TagCollector
+
     def lint
       scenarios do |file, feature, scenario|
         tags = gather_tags(feature) + gather_tags(scenario)

data/spec/configuration_spec.rb

@@ -0,0 +1,58 @@
+require 'rspec'
+require 'gherkin_lint/configuration'
+require 'shared_contexts/file_exists'
+
+describe GherkinLint::Configuration do
+  subject { GherkinLint::Configuration.new file }
+  let(:file) { 'default.yml' }
+
+  it 'should do something' do
+    expect(subject.config).to eq('')
+  end
+
+  it 'should have a default config path' do
+    expect(subject.configuration_path).not_to be nil
+  end
+  context 'when a empty config file is present' do
+    include_context 'a file exists'
+    let(:file_content) { '---' }
+    it 'should load a file from the config path' do
+      expect(subject.config).to eq ''
+    end
+  end
+
+  context 'when a non-YAML config file is present' do
+    include_context 'a file exists'
+    let(:file_content) do
+      <<-content
+      foo: [
+        ‘bar’, {
+          baz: 42
+         }
+      ]'
+      content
+    end
+
+    it 'should load a file from the config path but fail to parse' do
+      expect { subject.load_configuration }.to raise_error
+      expect { subject.config }.to raise_error
+    end
+  end
+  context 'when a valid YAML file is present' do
+    include_context 'a file exists'
+    let(:file_content) do
+      <<-content
+---
+:parent_key: parent_value
+:child_key: child_value
+      content
+    end
+    before :each do
+      subject.load_configuration
+    end
+
+    it 'should load the values from the config file' do
+      expect(subject.config).to eq(parent_key: 'parent_value', child_key: 'child_value')
+    end
+  end
+end

data/spec/gherkin_lint_spec.rb

@@ -0,0 +1,68 @@
+require 'rspec'
+require 'gherkin_lint'
+require 'gherkin_lint/linter/tag_constraint'
+require 'shared_contexts/file_exists'
+
+describe GherkinLint::GherkinLint do
+  it 'should have the constant set' do
+    expect(GherkinLint::GherkinLint.const_defined?(:LINTER)).to be true
+  end
+
+  subject { GherkinLint::GherkinLint.new }
+
+  describe '#initialize' do
+    it 'sets the files instance variable to empty' do
+      expect(subject.instance_variable_get(:@files)).to eq({})
+    end
+
+    it 'sets the linter instance variable to empty' do
+      expect(subject.instance_variable_get(:@linter).size).to eq(0)
+    end
+  end
+
+  describe '#enable' do
+    it 'enables the linter passed in' do
+      subject.enable ['RequiredTagsStartsWith']
+      expect(subject.instance_variable_get(:@config).config).to include('RequiredTagsStartsWith' => { 'Enabled' => true })
+    end
+  end
+
+  context 'when user configuration is not present' do
+    let(:file) { 'config/default.yml' }
+    it 'should load the expected values from the config file' do
+      expect(subject.instance_variable_get(:@config).config).to include('AvoidOutlineForSingleExample' => { 'Enabled' => true })
+    end
+  end
+
+  context 'when user provided YAML is present' do
+    include_context 'a file exists'
+    let(:file) { '.gherkin_lint.yml' }
+    let(:file_content) do
+      <<-content
+---
+AvoidOutlineForSingleExample:
+    Enabled: false
+      content
+    end
+    it 'should load and merge the expected values from the user config file' do
+      expect(subject.instance_variable_get(:@config).config).to include('AvoidOutlineForSingleExample' => { 'Enabled' => false })
+    end
+  end
+
+  context 'when linter member value is passed by the user' do
+    include_context 'a file exists'
+    let(:file) { '.gherkin_lint.yml' }
+    let(:file_content) do
+      <<-content
+---
+RequiredTags:
+    Enabled: true
+    Member: Value
+      content
+    end
+
+    it 'updates the member in the config' do
+      expect(subject.instance_variable_get(:@config).config).to include('RequiredTags' => { 'Enabled' => true, 'Member' => 'Value' })
+    end
+  end
+end

data/spec/required_tags_starts_with_spec.rb

@@ -0,0 +1,74 @@
+require 'rspec'
+require 'gherkin_lint/linter/required_tags_starts_with'
+require 'gherkin_lint'
+require 'shared_contexts/gherkin_linter'
+
+describe GherkinLint::RequiredTagsStartsWith do
+  let(:linter) { GherkinLint::GherkinLint.new }
+  let(:file) { 'lint.feature' }
+  let(:pattern) { %w[MCC PB] }
+  describe '#matcher' do
+    it 'should raise an error when pattern is nil' do
+      expect { subject.matcher(nil) }.to raise_error('No Tags provided in the YAML')
+    end
+    it 'should raise an error when pattern is empty' do
+      expect { subject.matcher('') }.to output("Required Tags matcher has no value\n").to_stderr
+    end
+  end
+
+  describe '#issues' do
+    context 'before linting' do
+      it 'should have no issue' do
+        expect(subject.issues.size).to eq(0)
+      end
+    end
+
+    context 'after linting a feature file with valid PB tag at the feature level' do
+      include_context 'a gherkin linter'
+
+      let(:file_content) do
+        <<-content
+      @PB
+      Feature: Test
+        @scenario_tag
+        Scenario: A
+        content
+      end
+      it 'should have no issues' do
+        expect(subject.issues.size).to eq(0)
+      end
+    end
+
+    context 'after linting a file with a MCC tag at the scenario level' do
+      include_context 'a gherkin linter'
+      let(:file_content) do
+        <<-content
+      @feature_tag
+      Feature: Test
+        @MCC
+        Scenario: A
+        content
+      end
+
+      it 'should have no issues' do
+        expect(subject.issues.size).to eq(0)
+      end
+    end
+
+    context 'after linting a file with no required tags' do
+      include_context 'a gherkin linter'
+      let(:file_content) do
+        <<-content
+      @feature_tag
+      Feature: Test
+        @scenario_tag
+        Scenario: A
+        content
+      end
+
+      it 'should have issues after linting a file without PB or MCC tags' do
+        expect(subject.issues[0].name).to eq(subject.class.name.split('::').last)
+      end
+    end
+  end
+end

data/spec/shared_contexts/file_exists.rb

@@ -0,0 +1,12 @@
+# needs file and file_content defined
+shared_context 'a file exists' do
+  before :each do
+    File.open(file, 'w') do |f|
+      f.write file_content
+    end
+  end
+
+  after :each do
+    File.delete(file) if File.exist?(file)
+  end
+end

data/spec/shared_contexts/gherkin_linter.rb

@@ -0,0 +1,14 @@
+require 'rspec'
+require_relative 'file_exists'
+
+shared_context 'a gherkin linter' do
+  include_context 'a file exists'
+
+  let(:files) { linter.analyze file }
+  let(:disable_tags) { linter.disable_tags }
+
+  before :each do
+    subject.instance_variable_set(:@pattern, pattern)
+    subject.lint_files({ file: files }, disable_tags)
+  end
+end

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: gherkin_lint
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Stefan Rohe
+- Nishtha Argawal
+- John Gluck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-12 00:00:00.000000000 Z
+date: 2017-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin
@@ -101,6 +103,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
 - Dockerfile
@@ -110,6 +113,7 @@ files:
 - README.md
 - Rakefile
 - bin/gherkin_lint
+- config/default.yml
 - features/avoid_outline_for_single_example.feature
 - features/avoid_period.feature
 - features/avoid_scripting.feature
@@ -127,6 +131,8 @@ files:
 - features/missing_scenario_name.feature
 - features/missing_test_action.feature
 - features/missing_verification.feature
+- features/precedence.feature
+- features/required_tags_starts_with.feature
 - features/same_tag_for_all_scenarios.feature
 - features/support/env.rb
 - features/tag_used_multiple_times.feature
@@ -142,6 +148,7 @@ files:
 - features/use_outline.feature
 - gherkin_lint.gemspec
 - lib/gherkin_lint.rb
+- lib/gherkin_lint/configuration.rb
 - lib/gherkin_lint/issue.rb
 - lib/gherkin_lint/linter.rb
 - lib/gherkin_lint/linter/avoid_outline_for_single_example.rb
@@ -160,7 +167,10 @@ files:
 - lib/gherkin_lint/linter/missing_scenario_name.rb
 - lib/gherkin_lint/linter/missing_test_action.rb
 - lib/gherkin_lint/linter/missing_verification.rb
+- lib/gherkin_lint/linter/required_tags_starts_with.rb
 - lib/gherkin_lint/linter/same_tag_for_all_scenarios.rb
+- lib/gherkin_lint/linter/tag_collector.rb
+- lib/gherkin_lint/linter/tag_constraint.rb
 - lib/gherkin_lint/linter/tag_used_multiple_times.rb
 - lib/gherkin_lint/linter/too_clumsy.rb
 - lib/gherkin_lint/linter/too_long_step.rb
@@ -172,6 +182,11 @@ files:
 - lib/gherkin_lint/linter/unused_variable.rb
 - lib/gherkin_lint/linter/use_background.rb
 - lib/gherkin_lint/linter/use_outline.rb
+- spec/configuration_spec.rb
+- spec/gherkin_lint_spec.rb
+- spec/required_tags_starts_with_spec.rb
+- spec/shared_contexts/file_exists.rb
+- spec/shared_contexts/gherkin_linter.rb
 homepage: http://github.com/funkwerk/gherkin_lint/
 licenses: []
 metadata: {}
@@ -191,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Gherkin Lint