chutney 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 967bc92b45b3c91b5b2ed37a85ece49c49396cd8dcf3ff3c4c84de2f3a796ae9
-  data.tar.gz: 1e841bd73bde6d32fc437dc6663c499296c2eb1614441298117d74ab17f4ac05
+  metadata.gz: 9b678f90aea391f8707bda58ec5e2f6caf9b5d1f1bf5b1503c6862d4023d5f18
+  data.tar.gz: ecb2e762fa06c882869ff007e80261137816f431a78c07257d2f140e8f8f6f78
 SHA512:
-  metadata.gz: 2118af0253237df26adb959a9b293492dcc7a699937c291c5c38d0d39128531dc7f08a62a300ca6f3b7f697454eb8c7370d739fc0bb1a9aa6655ca55e964d79e
-  data.tar.gz: b0be880b1fdc7d833db386b713f8c0d98e038b3a6946faaa3b41e8bc32ebe31da16e1104b0d00a51d8ebab5c031b29c7c5367e67fe0c856a1e0b650c5f390533
+  metadata.gz: 5f1f5c793a5d0080320606d56471f8ebcb7b0c3ceedca3e5e492eb877d1f0582aef997cd686c9e4782afeff407fb0346a0acbee288bca7306b39f2d8dc951540
+  data.tar.gz: 362d6bf5c6a1cb8c14a005534259e0ad5592df046a6dc3f747562b0b1875ee22e19b2076ff60873ca54967e2bd2188513566c36d0433ccd1c886fbc73b5c71ab

data/.rufo

@@ -0,0 +1 @@
+quote_style :single

data/chutney.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.description = 'A linter for your Cucumber features. '  \
                       'It supports any spoken language Cucumber v3 supports.'
 
-  spec.homepage    = 'https://billyruffian.github.io/faker_maker/'
+  spec.homepage    = 'https://billyruffian.github.io/chutney/'
   spec.license     = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
@@ -51,10 +51,11 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'coveralls', '~> 0.8'
   spec.add_development_dependency 'cucumber', '~> 3.0'
+  spec.add_development_dependency 'pry-byebug', '~> 3.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rerun', '~> 0.13'
   spec.add_development_dependency 'rspec-expectations', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.79.0'
+  spec.add_development_dependency 'rubocop', '~> 0.85.1'
   spec.add_development_dependency 'rspec', '~> 3.8'
   
 end

data/config/chutney.yml

@@ -4,6 +4,8 @@ AvoidFullStop:
     Enabled: true
 AvoidScripting:
     Enabled: true
+AvoidTypographersQuotes:
+    Enabled: true
 BackgroundDoesMoreThanSetup:
     Enabled: true
 BackgroundRequiresMultipleScenarios:

data/docs/index.md

@@ -5,7 +5,7 @@ nav_order: 1
 permalink: /
 ---
 
-# Best practice for your Cucumber feature files
+# Best practice for Cucumber
 {: .fs-9 }
 
 
@@ -18,4 +18,4 @@ You're trying to follow TDD or ATDD principles, you're writing executable specif
 
 Cucumber itself is an awesome tool which bridges with gap between business language, software development language and the language of testers. With all these folks interested, it's easy to write problematic and hard to maintain features. Chutney tries to help with that by having a common set of quality rules for your feature files.
 
-Chutney is able to lint feature files in any spoken language supported by Cucumber 3.
+Chutney is able to lint feature files in any spoken language supported by Cucumber 3.

data/docs/installation.md

@@ -9,7 +9,7 @@ nav_order: 2
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'faker_maker', require: false
+gem 'chutney', require: false
 ```
 
 And then execute:
@@ -18,4 +18,4 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install chutney
+    $ gem install chutney

data/docs/usage/configuration.md

@@ -7,6 +7,6 @@ nav_order: 3
 
 # Configuration
 
-Chutney looks for a configuration file in the current directory called `config/chutney.yml`. This configuration mostly switches on individual linters globally, but a few have addition parameters which can be configured (e.g. the maximum characters in a step).
+Chutney looks for a configuration file in the current directory called `config/.chutney.yml`. This configuration mostly switches on individual linters globally, but a few have addition parameters which can be configured (e.g. the maximum characters in a step).
 
-A default configuration can be found [here](https://github.com/BillyRuffian/chutney/blob/master/config/default.yml).
+A default configuration can be found [here](https://github.com/BillyRuffian/chutney/blob/master/config/chutney.yml).

data/docs/usage/rules.md

@@ -9,92 +9,92 @@ nav_order: 2
 
 Chutney enforces its rules with the linters. These are:
 
-AvoidFullStop
+[AvoidFullStop](https://github.com/BillyRuffian/chutney/blob/master/features/avoid_full_stop.feature)
 : Don't have a full stop (period) at the end of step because it makes step reuse really hard.
 
-AvoidOutlineForSingleExample
+[AvoidOutlineForSingleExample](https://github.com/BillyRuffian/chutney/blob/master/features/avoid_outline_for_single_example.feature)
 : If you only have a single example in your example table, use a plain-old scenario instead.
 
-AvoidScripting
+[AvoidScripting](https://github.com/BillyRuffian/chutney/blob/master/features/avoid_scripting.feature)
 : You have a lot of steps, are you sure you're not scripting the scenario when you should be specifying the behaviour of the system?
 
-BackgroundDoesMoreThanSetup
+[BackgroundDoesMoreThanSetup](https://github.com/BillyRuffian/chutney/blob/master/features/background_does_more_than_setup.feature)
 : Background in feature files should only do setup activity and so they should only contain `Given` steps.
 
-BackgroundRequiresMultipleScenarios
+[BackgroundRequiresMultipleScenarios](https://github.com/BillyRuffian/chutney/blob/master/features/background_requires_multiple_scenarios.feature)
 : If you only have one scenario, don't bother having a Background section.
 
-BadScenarioName
+[BadScenarioName](https://github.com/BillyRuffian/chutney/blob/master/features/bad_scenario_name.feature)
 : You should avoid using words like 'test' or 'check' in your scenario names, instead you should define the behaviour of your system.
 
-FileNameDiffersFeatureName
+[FileNameDiffersFeatureName](https://github.com/BillyRuffian/chutney/blob/master/features/file_name_differs_feature_name.feature)
 : The feature should have a name that follows the file name.
 
-GivensAfterBackground
+[GivensAfterBackground](https://github.com/BillyRuffian/chutney/blob/master/features/givens_after_background.feature)
 : If you have a Background section and your scenario needs more preconditions then it should start immediately with an `And` step and not another `Given`.
 
-InvalidFileName
+[InvalidFileName](https://github.com/BillyRuffian/chutney/blob/master/features/invalid_file_name.feature)
 : Make sure your file name is in snake case, not mixed case or with spaces.
 
-InvalidStepFlow
+[InvalidStepFlow](https://github.com/BillyRuffian/chutney/blob/master/features/invalid_step_flow.feature)
 : Your scenarios should follow Given → When → Then, in that order.
 
-MissingExampleName
+[MissingExampleName](https://github.com/BillyRuffian/chutney/blob/master/features/missing_example_name.feature)
 : If you have more than one example table in your scenario, they should each be given unique names.
 
-MissingFeatureDescription
+[MissingFeatureDescription](https://github.com/BillyRuffian/chutney/blob/master/features/missing_feature_description.feature)
 : Your feature should have a value statement. These are usually in the form 'As a... I want.. So that...'.
 
-MissingFeatureName
+[MissingFeatureName](https://github.com/BillyRuffian/chutney/blob/master/features/missing_feature_name.feature)
 : You should give your features a descriptive name.
 
-MissingScenarioName
+[MissingScenarioName](https://github.com/BillyRuffian/chutney/blob/master/features/missing_scenario_name.feature)
 : You should name your scenarios and scenario outlines.
 
-MissingTestAction
+[MissingTestAction](https://github.com/BillyRuffian/chutney/blob/master/features/missing_test_action.feature)
 : You don't have an action (a `When` step) in your scenario.
 
-MissingVerification
+[MissingVerification](https://github.com/BillyRuffian/chutney/blob/master/features/missing_verification.feature)
 : You don't have a verification step (a `Then` step) in your scenario.
 
-RequiredTagsStartWith
+[RequiredTagsStartWith](https://github.com/BillyRuffian/chutney/blob/master/features/required_tags_starts_with.feature)
 : Chutney can enforce a configurable naming prefix for your tags.
 
-SameTagForAllScenarios
+[SameTagForAllScenarios](https://github.com/BillyRuffian/chutney/blob/master/features/same_tag_for_all_scenarios.feature)
 : You have the same tag for all you scenarios; move the tag to the feature level instead.
 
-ScenarioNamesMatch
+[ScenarioNamesMatch](https://github.com/BillyRuffian/chutney/blob/master/features/scenario_names_match.feature)
 : Chutney can enforce a naming convention for your scenario names.
 
-TagUsedMultipleTimes
+[TagUsedMultipleTimes](https://github.com/BillyRuffian/chutney/blob/master/features/tag_used_multiple_times.feature)
 : Chutney can warn if you have used a tag a lot with a feature.
 
-TooClumsy
+[TooClumsy](https://github.com/BillyRuffian/chutney/blob/master/features/too_clumsy.feature)
 : This is a very long scenario. Consider writing it more concisely.
 
-TooLongStep
+[TooLongStep](https://github.com/BillyRuffian/chutney/blob/master/features/too_long_step.feature)
 : This is a very long step. Consider writing it more concisely.
 
-TooManyDifferentTags
+[TooManyDifferentTags](https://github.com/BillyRuffian/chutney/blob/master/features/too_many_different_tags.feature)
 : This feature has a lot of differnt tags.
 
-TooManySteps
+[TooManySteps](https://github.com/BillyRuffian/chutney/blob/master/features/too_many_steps.feature)
 : This feature has a lot of steps. Consider writing it more concisely.
 
-TooManyTags
+[TooManyTags](https://github.com/BillyRuffian/chutney/blob/master/features/too_many_tags.feature)
 : There are a lot of tags in this feature.
 
-UniqueScenarioNames
+[UniqueScenarioNames](https://github.com/BillyRuffian/chutney/blob/master/features/unique_scenario_names.feature)
 : You have duplicated a scenario name when they should be unique.
 
-UnknownVariable
+[UnknownVariable](https://github.com/BillyRuffian/chutney/blob/master/features/unknown_variable.feature)
 : You are referencing a variable which doesn't appear to be defined. This is a source of subtle errors.
 
-UnusedVariable
+[UnusedVariable](https://github.com/BillyRuffian/chutney/blob/master/features/unused_variable.feature)
 : You have a variable which you are not using.
 
-UseBackground
+[UseBackground](https://github.com/BillyRuffian/chutney/blob/master/features/use_background.feature)
 : You have a setup setup used in all of your scenarios. Move it to a Background section.
 
-UseOutline
+[UseOutline](https://github.com/BillyRuffian/chutney/blob/master/features/use_outline.feature)
 : You have very similar scenarios. You should consider if they should be combined into a Scenario Outline.

data/examples/emoji.feature

@@ -0,0 +1,14 @@
+# language: em
+
+📚: 🤯
+
+  As a 👹
+  I want to 🏃‍♂️ 🥒
+  So that 👁 don't 👀 a 🍆
+  
+  📕:
+    😐 I am a 🐸
+    🎬 I am 😘 by a 👸
+    🎬 I am 😘 by a 👸
+    🙏 I will ⏎ into a 🤴
+    

data/lib/chutney.rb

@@ -4,6 +4,7 @@ require 'chutney/linter'
 require 'chutney/linter/avoid_full_stop'
 require 'chutney/linter/avoid_outline_for_single_example'
 require 'chutney/linter/avoid_scripting'
+require 'chutney/linter/avoid_typographers_quotes'
 require 'chutney/linter/background_does_more_than_setup'
 require 'chutney/linter/background_requires_multiple_scenarios'
 require 'chutney/linter/bad_scenario_name'

data/lib/chutney/formatter/pie_formatter.rb

@@ -21,7 +21,7 @@ module Chutney
     end
     
     def print_report(data)
-      return unless data.empty?
+      return if data.empty?
 
       print TTY::Pie.new(data: data, radius: 8, legend: { format: '%<label>s %<name>s %<value>i' })
       puts

data/lib/chutney/linter/avoid_typographers_quotes.rb

@@ -0,0 +1,37 @@
+module Chutney
+  # service class to lint for avoid scripting
+  class AvoidTypographersQuotes < Linter
+    TYPOGRAPHER_QUOTES = ["\u201c", "\u201d", "\u2018", "\u2019"].map(&:encode)
+
+    def lint
+      scenarios do |_feature, scenario|
+        lint_steps(scenario[:steps])
+
+        example_count = scenario[:examples]&.length || 0
+        next unless example_count.positive?
+
+        lint_examples(scenario[:examples])
+      end
+    end
+
+    def lint_steps(steps)
+      steps.each do |step|
+        issue(step) if TYPOGRAPHER_QUOTES.any? { |tq| step[:text].include? tq }
+      end
+    end
+
+    def lint_examples(examples)
+      examples.each do |example|
+        example[:tableBody].each do |body|
+          body[:cells].each do |cell|
+            issue(cell) if TYPOGRAPHER_QUOTES.any? { |tq| cell[:value].include? tq }
+          end
+        end
+      end
+    end
+
+    def issue(location)
+      add_issue(I18n.t('linters.avoid_typographers_quotes'), location)
+    end
+  end
+end

data/lib/chutney/version.rb

@@ -1,3 +1,3 @@
 module Chutney
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.1.0'.freeze
 end

data/lib/config/locales/en.yml

@@ -11,6 +11,10 @@ en:
     avoid_scripting: >-
       You have %{count} When steps when you should only have one.
       Be careful not to add And steps following a When.
+    avoid_typographers_quotes: >-
+      You are using typographers quotation marks (curly quotes).
+      Make sure you intend to use this character and not a neutral quote
+      (straight quote) instead.
     background_does_more_than_setup: >-
       The Background does more than setup. It should only contain Given steps.
     background_requires_multiple_scenarios: >-

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: chutney
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
 - Stefan Rohe
 - Nishtha Argawal
 - John Gluck
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-02-07 00:00:00.000000000 Z
+date: 2020-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amatch
@@ -111,6 +111,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -159,14 +173,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: 0.85.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.79.0
+        version: 0.85.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -195,6 +209,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".rufo"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -206,11 +221,13 @@ files:
 - docs/credits.md
 - docs/index.md
 - docs/installation.md
+- docs/logo.png
 - docs/usage/configuration.md
 - docs/usage/index.md
 - docs/usage/output.md
 - docs/usage/rules.md
 - docs/usage/selective_enablement.md
+- examples/emoji.feature
 - exe/chutney
 - img/chutney.svg
 - img/formatters.png
@@ -226,6 +243,7 @@ files:
 - lib/chutney/linter/avoid_full_stop.rb
 - lib/chutney/linter/avoid_outline_for_single_example.rb
 - lib/chutney/linter/avoid_scripting.rb
+- lib/chutney/linter/avoid_typographers_quotes.rb
 - lib/chutney/linter/background_does_more_than_setup.rb
 - lib/chutney/linter/background_requires_multiple_scenarios.rb
 - lib/chutney/linter/bad_scenario_name.rb
@@ -257,14 +275,14 @@ files:
 - lib/config/locales/en.yml
 - spec/chutney_spec.rb
 - spec/spec_helper.rb
-homepage: https://billyruffian.github.io/faker_maker/
+homepage: https://billyruffian.github.io/chutney/
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://billyruffian.github.io/faker_maker/
+  homepage_uri: https://billyruffian.github.io/chutney/
   source_code_uri: https://github.com/BillyRuffian/chutney
   changelog_uri: https://github.com/BillyRuffian/chutney/releases
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -280,7 +298,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A linter for English language Gherkin
 test_files: []