gherkin_lint 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02a51af014c3217570afcb623301a99b27308f46
-  data.tar.gz: d3553032dd6ffa4dfaabed5fea306d1e7b8d0986
+  metadata.gz: 55bcc404f41403702960d9d2947515739567023f
+  data.tar.gz: a26de407f1adb5dfd372da3f4e32a395ff85d20a
 SHA512:
-  metadata.gz: f8348eaf5ef2256d0c98d5648210f582aa29d99b3d601841472dd2b5d11b44fcbbbd45eb6c46e2a99b8df6da9ff6ba8e646d52a2ab0ff8bbd6705a48a95651ff
-  data.tar.gz: e631d0f584509c85e2a64c94834c7fc0093d53d7fd93c24d83fac31d190c34818a89ce62701f46eb066bd4bd374e0fc723451f9509cec4de661bdd5076f80bf0
+  metadata.gz: 15112d1f645e2c06b58d9022d44e5004ac38c75c87caf8ba5d2c9776eb1eeabe62f61b05908ca058fe8f7a64736758d2d7e029d1fd673eaae321bf2db073bee4
+  data.tar.gz: 4c93f4a4e9e479d2f9764ec71e4064d9aa6f50a43a26c7ce511f976c11a0fe5f4b45a4224f1575412c999de9633a2df0934fb4caa587ddecef37f46947b790a8

data/.rubocop.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-02-28 13:48:49 +0100 using RuboCop version 0.36.0.
+# on 2016-02-28 15:30:26 +0100 using RuboCop version 0.37.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -11,8 +11,14 @@
 Metrics/ClassLength:
   Max: 116
 
-# Offense count: 3
+# Offense count: 28
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
 # URISchemes: http, https
 Metrics/LineLength:
   Max: 118
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Performance/Casecmp:
+  Exclude:
+    - 'lib/gherkin_lint/linter/invalid_file_name.rb'

data/Rakefile

@@ -11,7 +11,7 @@ end
 
 desc 'Publishes the Gem'
 task :push do
-  sh 'gem push gherkin_lint-0.1.1.gem'
+  sh 'gem push gherkin_lint-0.1.2.gem'
 end
 
 desc 'Checks ruby style'

data/features/avoid_scripting.feature

@@ -0,0 +1,67 @@
+Feature: Avoid Scripting
+  As a Business Analyst
+  I want to be warned about scripted tests
+  so that all my tests follow the guideline of single action per scenario.
+
+  Background: Prepare Testee
+    Given a file named "lint.rb" with:
+      """
+      $LOAD_PATH << '../../lib'
+      require 'gherkin_lint'
+
+      linter = GherkinLint::GherkinLint.new
+      linter.enable %w(AvoidScripting)
+      linter.analyze 'lint.feature'
+      exit linter.report
+
+      """
+
+  Scenario: Multiple Actions
+    Given a file named "lint.feature" with:
+      """
+      Feature: Test
+        Scenario: A
+          Given setup
+          When action
+          And something else
+          Then verify
+      """
+    When I run `ruby lint.rb`
+    Then it should fail with exactly:
+      """
+      AvoidScripting - Multiple Actions
+        lint.feature (2): Test.A
+      """
+
+  Scenario: Repeat Action-Verfication Steps
+    Given a file named "lint.feature" with:
+      """
+      Feature: Test
+        Scenario: A
+          Given setup
+          When test
+          Then verify
+          When test
+          Then verify
+      """
+    When I run `ruby lint.rb`
+    Then it should fail with exactly:
+      """
+      AvoidScripting - Multiple Actions
+        lint.feature (2): Test.A
+      """
+
+  Scenario: Valid Example
+    Given a file named "lint.feature" with:
+      """
+      Feature: Test
+        Scenario: A
+          Given setup
+          When test
+          Then verification
+      """
+    When I run `ruby lint.rb`
+    Then it should pass with exactly:
+      """
+
+      """

data/features/invalid_file_name.feature

@@ -9,7 +9,6 @@ Feature: Invalid File Name
       $LOAD_PATH << '../../lib'
       require 'gherkin_lint'
       require 'optparse'
-      options = {}
       OptionParser.new { |opts| }.parse!
 
       linter = GherkinLint::GherkinLint.new

data/gherkin_lint.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'gherkin_lint'
-  s.version     = '0.1.1'
-  s.date        = '2016-02-28'
+  s.version     = '0.1.2'
+  s.date        = '2016-04-17'
   s.summary     = 'Gherkin Lint'
   s.description = 'Lint Gherkin Files'
   s.authors     = ['Stefan Rohe']

data/lib/gherkin_lint.rb

@@ -4,6 +4,7 @@ require 'gherkin/formatter/json_formatter'
 require 'gherkin/parser/parser'
 require 'gherkin_lint/linter/avoid_outline_for_single_example'
 require 'gherkin_lint/linter/avoid_period'
+require 'gherkin_lint/linter/avoid_scripting'
 require 'gherkin_lint/linter/background_does_more_than_setup'
 require 'gherkin_lint/linter/background_requires_multiple_scenarios'
 require 'gherkin_lint/linter/bad_scenario_name'
@@ -36,6 +37,7 @@ module GherkinLint
   class GherkinLint
     LINTER = [
       AvoidPeriod,
+      AvoidScripting,
       AvoidOutlineForSingleExample,
       BackgroundDoesMoreThanSetup,
       BackgroundRequiresMultipleScenarios,

data/lib/gherkin_lint/linter.rb

@@ -106,7 +106,7 @@ module GherkinLint
     end
 
     def lint
-      fail 'not implemented'
+      raise 'not implemented'
     end
 
     def reference(file, feature = nil, scenario = nil, step = nil)

data/lib/gherkin_lint/linter/avoid_scripting.rb

@@ -0,0 +1,22 @@
+require 'gherkin_lint/linter'
+
+module GherkinLint
+  # service class to lint for avoid scripting
+  class AvoidScripting < Linter
+    def lint
+      filled_scenarios do |file, feature, scenario|
+        steps = filter_when_steps scenario['steps']
+
+        next if steps.length <= 1
+        references = [reference(file, feature, scenario)]
+        add_issue(references, 'Multiple Actions')
+      end
+    end
+
+    def filter_when_steps(steps)
+      steps = steps.drop_while { |step| step['keyword'] != 'When ' }
+      steps = steps.reverse.drop_while { |step| step['keyword'] != 'Then ' }.reverse
+      steps.select { |step| step['keyword'] != 'Then ' }
+    end
+  end
+end

data/lib/gherkin_lint/linter/file_name_differs_feature_name.rb

@@ -7,7 +7,7 @@ module GherkinLint
       features do |file, feature|
         next unless feature.include? 'name'
         expected_feature_name = title_case file
-        next unless feature['name'].downcase != expected_feature_name.downcase
+        next if feature['name'].casecmp(expected_feature_name) == 0
         references = [reference(file, feature)]
         add_issue(references, "Feature name should be '#{expected_feature_name}'")
       end

data/lib/gherkin_lint/linter/missing_test_action.rb

@@ -6,7 +6,7 @@ module GherkinLint
     def lint
       filled_scenarios do |file, feature, scenario|
         when_steps = scenario['steps'].select { |step| step['keyword'] == 'When ' }
-        next if when_steps.length > 0
+        next unless when_steps.empty?
         references = [reference(file, feature, scenario)]
         add_issue(references, 'No \'When\'-Step')
       end

data/lib/gherkin_lint/linter/missing_verification.rb

@@ -6,7 +6,7 @@ module GherkinLint
     def lint
       filled_scenarios do |file, feature, scenario|
         then_steps = scenario['steps'].select { |step| step['keyword'] == 'Then ' }
-        next if then_steps.length > 0
+        next unless then_steps.empty?
         references = [reference(file, feature, scenario)]
         add_issue(references, 'No verification step')
       end

data/lib/gherkin_lint/linter/same_tag_for_all_scenarios.rb

@@ -7,7 +7,7 @@ module GherkinLint
       features do |file, feature|
         tags = gather_same_tags feature
         next if tags.nil?
-        next if tags.length < 1
+        next if tags.empty?
         next unless feature['elements'].length > 1
         references = [reference(file, feature)]
         tags.each do |tag|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gherkin_lint
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Stefan Rohe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-28 00:00:00.000000000 Z
+date: 2016-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin
@@ -84,6 +84,7 @@ files:
 - bin/gherkin_lint
 - features/avoid_outline_for_single_example.feature
 - features/avoid_period.feature
+- features/avoid_scripting.feature
 - features/background_does_more_than_setup.feature
 - features/background_requires_scenario.feature
 - features/bad_scenario_name.feature
@@ -115,6 +116,7 @@ files:
 - lib/gherkin_lint/linter.rb
 - lib/gherkin_lint/linter/avoid_outline_for_single_example.rb
 - lib/gherkin_lint/linter/avoid_period.rb
+- lib/gherkin_lint/linter/avoid_scripting.rb
 - lib/gherkin_lint/linter/background_does_more_than_setup.rb
 - lib/gherkin_lint/linter/background_requires_multiple_scenarios.rb
 - lib/gherkin_lint/linter/bad_scenario_name.rb