chutney 2.0.0.rc1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84fb5182152246f5cc0466c3a9ceb75ad60d9221782da7803bb60760bc57aebd
-  data.tar.gz: b508f42ba4474faf52af5f818539ccc00647eedc494ceb8ba73124c615817a6f
+  metadata.gz: 967bc92b45b3c91b5b2ed37a85ece49c49396cd8dcf3ff3c4c84de2f3a796ae9
+  data.tar.gz: 1e841bd73bde6d32fc437dc6663c499296c2eb1614441298117d74ab17f4ac05
 SHA512:
-  metadata.gz: 4115a8fac2e1cb6d66b99a13e5d93647a380d9ba776c08d8fcb8f6563b36f710c9e063c8c3a1a94a77ecd948589605168c57b1e41670b9ea101db6505b7c25e7
-  data.tar.gz: 6d742e60654dfcc17fdcc97ec07d5012aa0e1cfc1e6f078b99152d9d7f89d29c2ae0318270ccc1afd59dd012d8518d71d1ca5564f35e4ba74d965840342d076a
+  metadata.gz: 2118af0253237df26adb959a9b293492dcc7a699937c291c5c38d0d39128531dc7f08a62a300ca6f3b7f697454eb8c7370d739fc0bb1a9aa6655ca55e964d79e
+  data.tar.gz: b0be880b1fdc7d833db386b713f8c0d98e038b3a6946faaa3b41e8bc32ebe31da16e1104b0d00a51d8ebab5c031b29c7c5367e67fe0c856a1e0b650c5f390533

data/README.md

@@ -18,84 +18,4 @@
 
 </div>
 
-
-## Background
-
-This gem will sniff the Gherkin in your feature files and let you know how fresh it is.
-
-Getting started with Cucumber is really easy but that also makes it easy to fall into some bad habits. Chutney inspects your features and let's you know if it spots anything bad.
-
-Under the covers, Chutney uses Cucumber v3 and supports any spoken language that Cucumber does. If anyone wants to help internationalising Chutney's output, that'd be awesome.
-
-## Usage
-
-run `chutney` on a list of files
-
-```
-chutney '<wild_card_path>' #default is `features/**/*.feature`
-```
-
-Checks could be disabled using tags within Feature Files and the Feature or Scenario level. To do so, add `@disableCHECK`, e.g. `@disableTooManyTags`.
-
-## Formatters
-
-The output is rendered by formatters. Currently there are:
-
-- RainbowFormatter (default)
-- PieFormatter
-- JSONFormatter
-
-You can specify which with the `-f` flag
-
-```
-chutney f PieFormatter -f RainbowFormatter
-```
-
-![screenshot](/img/formatters.png?raw=true)
-
-
-## Checks
-
- - [avoid outline for single example](https://github.com/BillyRuffian/chutney/blob/master/features/avoid_outline_for_single_example.feature)
- - [avoid period](https://github.com/BillyRuffian/chutney/blob/master/features/avoid_period.feature)
- - [avoid scripting](https://github.com/BillyRuffian/chutney/blob/master/features/avoid_scripting.feature)
- - [background does more than setup](https://github.com/BillyRuffian/chutney/blob/master/features/background_does_more_than_setup.feature)
- - [background requires scenario](https://github.com/BillyRuffian/chutney/blob/master/features/background_requires_scenario.feature)
- - [bad scenario name](https://github.com/BillyRuffian/chutney/blob/master/features/bad_scenario_name.feature)
- - [file name differs feature name](https://github.com/BillyRuffian/chutney/blob/master/features/file_name_differs_feature_name.feature)
- - [givens after background](https://github.com/BillyRuffian/chutney/blob/master/features/givens_after_background.feature)
- - [invalid file name](https://github.com/BillyRuffian/chutney/blob/master/features/invalid_file_name.feature)
- - [invalid step flow](https://github.com/BillyRuffian/chutney/blob/master/features/invalid_step_flow.feature)
- - [missing example name](https://github.com/BillyRuffian/chutney/blob/master/features/missing_example_name.feature)
- - [missing feature description](https://github.com/BillyRuffian/chutney/blob/master/features/missing_feature_description.feature)
- - [missing feature name](https://github.com/BillyRuffian/chutney/blob/master/features/missing_feature_name.feature)
- - [missing scenario name](https://github.com/BillyRuffian/chutney/blob/master/features/missing_scenario_name.feature)
- - [missing test action](https://github.com/BillyRuffian/chutney/blob/master/features/missing_test_action.feature)
- - [missing verification](https://github.com/BillyRuffian/chutney/blob/master/features/missing_verification.feature)
- - [same tag for all scenarios](https://github.com/BillyRuffian/chutney/blob/master/features/same_tag_for_all_scenarios.feature)
- - [scenario name must match pattern](https://github.com/BillyRuffian/chutney/blob/master/features/scenario_names_match.feature)
- - [tag used multiple times](https://github.com/BillyRuffian/chutney/blob/master/features/tag_used_multiple_times.feature)
- - [too clumsy](https://github.com/BillyRuffian/chutney/blob/master/features/too_clumsy.feature)
- - [too long step](https://github.com/BillyRuffian/chutney/blob/master/features/too_long_step.feature)
- - [too many different tags](https://github.com/BillyRuffian/chutney/blob/master/features/too_many_different_tags.feature)
- - [too many steps](https://github.com/BillyRuffian/chutney/blob/master/features/too_many_steps.feature)
- - [too many tags](https://github.com/BillyRuffian/chutney/blob/master/features/too_many_tags.feature)
- - [unique scenario names](https://github.com/BillyRuffian/chutney/blob/master/features/unique_scenario_names.feature)
- - [unknown variable](https://github.com/BillyRuffian/chutney/blob/master/features/unknown_variable.feature)
- - [use background](https://github.com/BillyRuffian/chutney/blob/master/features/use_background.feature)
- - [use outline](https://github.com/BillyRuffian/chutney/blob/master/features/use_outline.feature)
-
-## Installation
-
-Install it with:
-
-`sudo gem install chutney`
-
-After that `chutney` executable is available.
-
-## Configuration
-If you have a custom configuration you'd like to run on a regular basis instead of passing enable and disable flags through the CLI on every run, you can configure a ```.chutney.yml``` file that will be loaded on execution.  The format and available linters are in [```config/chutney.yml```](config/chutney.yml)
-
-## Extra credit
-
-Pickle jar image by <a href="https://pixabay.com/users/OpenClipart-Vectors-30363/?utm_source=link-attribution&amp;utm_medium=referral&amp;utm_campaign=image&amp;utm_content=576536">OpenClipart-Vectors</a> from <a href="https://pixabay.com/?utm_source=link-attribution&amp;utm_medium=referral&amp;utm_campaign=image&amp;utm_content=576536">Pixabay</a>
+Read the documentation [here](https://billyruffian.github.io/chutney/).

data/chutney.gemspec

@@ -13,11 +13,10 @@ Gem::Specification.new do |spec|
   spec.email       = ['nigel@brookes-thomas.co.uk']
 
   spec.summary     = 'A linter for English language Gherkin'
-  spec.description = 'A fork of gherkin_lint (https://github.com/funkwerk/gherkin_lint) '  \
-                      '(which is no-longer being actively maintained), brought up to date '\
-                      'with the Cucumber 3 monogem.'
+  spec.description = 'A linter for your Cucumber features. '  \
+                      'It supports any spoken language Cucumber v3 supports.'
 
-  spec.homepage    = 'https://github.com/BillyRuffian/chutney'
+  spec.homepage    = 'https://billyruffian.github.io/faker_maker/'
   spec.license     = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
@@ -25,9 +24,9 @@ Gem::Specification.new do |spec|
   if spec.respond_to?(:metadata)
     # spec.metadata['allowed_push_host'] = 'TODO: Set to 'http://mygemserver.com''
 
-    # spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['homepage_uri'] = spec.homepage
     spec.metadata['source_code_uri'] = 'https://github.com/BillyRuffian/chutney'
-    # spec.metadata['changelog_uri'] = 'TODO: Put your gem's CHANGELOG.md URL here.'
+    spec.metadata['changelog_uri'] = 'https://github.com/BillyRuffian/chutney/releases'
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
       'public gem pushes.'

data/docs/_config.yml

@@ -0,0 +1,8 @@
+remote_theme: pmarsceill/just-the-docs
+logo: "https://raw.githubusercontent.com/BillyRuffian/chutney/master/docs/logo.png"
+title: Chutney
+description: A linter for Gherkin
+aux_links:
+  "Chutney on GitHub":
+    - "https://github.com/BillyRuffian/chutney"
+footer_content: "Copyright &copy; 2019-2020 Nigel Brookes-Thomas. Distributed by an <a href=\"https://github.com/BillyRuffian/chutney/blob/master/LICENSE.txt\">MIT license.</a>"

data/docs/credits.md

@@ -0,0 +1,15 @@
+---
+layout: default
+title: Credits
+nav_order: 4
+---
+
+# Credits
+
+This linter started life as a fork of the abandoned [gherkin_lint](https://github.com/funkwerk/gherkin_lint) and very great deal of credit for the linting rules goes to the original author(s) of that project.
+
+I've dusted it off and brought it up to date with Cucumber 3 and improved the internals.
+
+# Logo
+
+Pickle jar image by [OpenClipart-Vectors](https://pixabay.com/users/OpenClipart-Vectors-30363/?utm_source=link-attribution&utm_medium=referral&utm_campaign=image&utm_content=576536) from [Pixabay](https://pixabay.com/?utm_source=link-attribution&utm_medium=referral&utm_campaign=image&utm_content=576536).

data/docs/index.md

@@ -0,0 +1,21 @@
+---
+layout: default
+title: Home
+nav_order: 1
+permalink: /
+---
+
+# Best practice for your Cucumber feature files
+{: .fs-9 }
+
+
+Chutney tastes your Cumber feature files and lets you know if they're tasty or nasty.
+{: .fs-6 .fw-300 }
+
+---
+
+You're trying to follow TDD or ATDD principles, you're writing executable specifications in gherkin using Cucumber, you're trying to do *the right thing* but are you doing *the thing right*?
+
+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.

data/docs/installation.md

@@ -0,0 +1,21 @@
+---
+layout: default
+title: Installing
+nav_order: 2
+---
+
+# Installing
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faker_maker', require: false
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chutney

data/docs/usage/configuration.md

@@ -0,0 +1,12 @@
+---
+layout: default
+title: Configuration
+parent: Usage
+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).
+
+A default configuration can be found [here](https://github.com/BillyRuffian/chutney/blob/master/config/default.yml).

data/docs/usage/index.md

@@ -0,0 +1,16 @@
+---
+layout: default
+title: Usage
+nav_order: 3
+has_children: true
+---
+
+# Usage
+
+Chutney expects to be able to find your Cucumber `.feature` files. By default, it will look for a folder called `features` in the current directory and will dig through all subfolders to find features.
+
+You can give Chutney a path (using Ruby's globbing rules) or a single file if you want.
+
+```
+chutney '<wild_card_path>' #default is `features/**/*.feature`
+```

data/docs/usage/output.md

@@ -0,0 +1,26 @@
+---
+layout: default
+title: Output & Exit Codes
+parent: Usage
+nav_order: 1
+---
+
+# Output
+
+Chutney ships with a few formatters, the default being the Rainbow Formatter (it has coloured terminal output). Others included are the Pie Formatter which presents a textual pie chart of all the violations, and a JSON Formatter which, as is sounds, dumps the result as a JSON string.
+
+You can specify one or formatters with the `-f` flag. For instance...
+
+```
+chutney -f RainbowFormatter -f PieFormatter -f JSONFormatter
+```
+
+## Building Your Own Formatters
+
+Chutney expects formatters to be namespaced to the `Chutney` module and respond to `results=(results_hash)` and `format`. There is a parent class `Chutney::Formatter` which provides a few utility methods you might find useful.
+
+Take a look a the JSONFormatter as the most minimal implementation -- it just calls `to_json` on the hash it is given.
+
+## Exit Codes
+
+Using the command line, Chutney returns 0 if no violations are found, 1 if one or more are found.

data/docs/usage/rules.md

@@ -0,0 +1,100 @@
+---
+layout: default
+title: Rules
+parent: Usage
+nav_order: 2
+---
+
+# Linting Rules
+
+Chutney enforces its rules with the linters. These are:
+
+AvoidFullStop
+: Don't have a full stop (period) at the end of step because it makes step reuse really hard.
+
+AvoidOutlineForSingleExample
+: If you only have a single example in your example table, use a plain-old scenario instead.
+
+AvoidScripting
+: 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
+: Background in feature files should only do setup activity and so they should only contain `Given` steps.
+
+BackgroundRequiresMultipleScenarios
+: If you only have one scenario, don't bother having a Background section.
+
+BadScenarioName
+: You should avoid using words like 'test' or 'check' in your scenario names, instead you should define the behaviour of your system.
+
+FileNameDiffersFeatureName
+: The feature should have a name that follows the file name.
+
+GivensAfterBackground
+: 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
+: Make sure your file name is in snake case, not mixed case or with spaces.
+
+InvalidStepFlow
+: Your scenarios should follow Given → When → Then, in that order.
+
+MissingExampleName
+: If you have more than one example table in your scenario, they should each be given unique names.
+
+MissingFeatureDescription
+: Your feature should have a value statement. These are usually in the form 'As a... I want.. So that...'.
+
+MissingFeatureName
+: You should give your features a descriptive name.
+
+MissingScenarioName
+: You should name your scenarios and scenario outlines.
+
+MissingTestAction
+: You don't have an action (a `When` step) in your scenario.
+
+MissingVerification
+: You don't have a verification step (a `Then` step) in your scenario.
+
+RequiredTagsStartWith
+: Chutney can enforce a configurable naming prefix for your tags.
+
+SameTagForAllScenarios
+: You have the same tag for all you scenarios; move the tag to the feature level instead.
+
+ScenarioNamesMatch
+: Chutney can enforce a naming convention for your scenario names.
+
+TagUsedMultipleTimes
+: Chutney can warn if you have used a tag a lot with a feature.
+
+TooClumsy
+: This is a very long scenario. Consider writing it more concisely.
+
+TooLongStep
+: This is a very long step. Consider writing it more concisely.
+
+TooManyDifferentTags
+: This feature has a lot of differnt tags.
+
+TooManySteps
+: This feature has a lot of steps. Consider writing it more concisely.
+
+TooManyTags
+: There are a lot of tags in this feature.
+
+UniqueScenarioNames
+: You have duplicated a scenario name when they should be unique.
+
+UnknownVariable
+: You are referencing a variable which doesn't appear to be defined. This is a source of subtle errors.
+
+UnusedVariable
+: You have a variable which you are not using.
+
+UseBackground
+: You have a setup setup used in all of your scenarios. Move it to a Background section.
+
+UseOutline
+: You have very similar scenarios. You should consider if they should be combined into a Scenario Outline.

data/docs/usage/selective_enablement.md

@@ -0,0 +1,14 @@
+---
+layout: default
+title: Selectively Disabling Rules
+parent: Usage
+nav_order: 4
+---
+
+# Selectively Disabling Rules
+
+Sometimes you want to be able to disable linting rules for just one specific file or one specific scenario.
+
+To do this, use the tag format `@disable<Linter Name>`. For example `@disableTooLongStep`. 
+
+If used at the feature level, the linter will be deactivated for the whole file, used at the scenario level, only that one scenario will be excused.

data/exe/chutney

@@ -10,7 +10,9 @@ formatters = Set.new
 
 OptionParser.new do |opts|
   opts.banner = 'Usage: chutney [files]'
-  opts.on('-f', '--format [formatter]', 'Formatter for presenting the results. One of JSONFormatter, PieFormatter or RainbowFormatter (default). Can be specified more than once') do |formatter|
+  opts.on('-f', 
+          '--format [formatter]', 
+          'One of JSONFormatter, PieFormatter or RainbowFormatter (default).') do |formatter|
     raise 'No Such Formatter' unless %w[JSONFormatter PieFormatter RainbowFormatter].include? formatter
 
     formatters << formatter

data/lib/chutney/formatter.rb

@@ -6,9 +6,7 @@ module Chutney
     def initialize
       @results = {}
     end  
-    
-    def format(results); end
-    
+        
     def files
       results.map { |k, _v| k }
     end

data/lib/chutney/formatter/pie_formatter.rb

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

data/lib/chutney/version.rb

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

data/lib/config/locales/en.yml

@@ -37,7 +37,7 @@ en:
         This scenario is missing an action step -- it does not have a 'When'.
     missing_example_name: >-
       You have a scenerio with more than one example table, at least one of which is
-      unnamed or has a duplicate name. 
+      unnamed or has a duplicate name.
       You should give your example tables clear and meaningful names when you have more than one.
     missing_feature_description: >-
       Features should have a description / value statement so that the importance of the feature
@@ -55,7 +55,7 @@ en:
     required_tags_starts_with: >-
       You have tags which do not match the required format. Allowed prefixes are '%{allowed}'.
     scenario_names_match: >-
-      You have scenario name which do not match the required format. 
+      You have a scenario name which does not match the required format.
       Allowed patterns are '%{pattern}'.
     same_tag_for_all_scenarios:
       feature_level: >-
@@ -71,7 +71,7 @@ en:
       This scenario is too clumsy at %{length} characters. Scenarios should be no more than
       400 characters long.
     too_long_step: >-
-      This step is too long at %{length} characters. It should be no longer than %{max} 
+      This step is too long at %{length} characters. It should be no longer than %{max}
       characters.
     too_many_different_tags: >-
       There are too many tags in this feature. There are %{count} and the maximum is %{max}.
@@ -89,5 +89,5 @@ en:
       The step '%{step}' is used in all the scenarios of this feature. It should be moved
       to the background steps.
     use_outline: >-
-      Scenarios are similar by %{pct}%, you should use scenario outlines to simplify. 
-      %{lhs_name} (%{lhs_line}) vs %{rhs_name} (%{rhs_line})
+      Scenarios are similar by %{pct}%, you should use scenario outlines to simplify.
+      %{lhs_name} (%{lhs_line}) vs %{rhs_name} (%{rhs_line})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chutney
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc1
+  version: 2.0.0
 platform: ruby
 authors:
 - Nigel Brookes-Thomas
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-03 00:00:00.000000000 Z
+date: 2020-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amatch
@@ -181,9 +181,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
-description: A fork of gherkin_lint (https://github.com/funkwerk/gherkin_lint) (which
-  is no-longer being actively maintained), brought up to date with the Cucumber 3
-  monogem.
+description: A linter for your Cucumber features. It supports any spoken language
+  Cucumber v3 supports.
 email:
 - nigel@brookes-thomas.co.uk
 executables:
@@ -197,12 +196,21 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - Gemfile
-- LICENSE
+- LICENSE.txt
 - README.md
 - Rakefile
 - chutney.gemspec
 - config/chutney.yml
 - docs/.keep
+- docs/_config.yml
+- docs/credits.md
+- docs/index.md
+- docs/installation.md
+- docs/usage/configuration.md
+- docs/usage/index.md
+- docs/usage/output.md
+- docs/usage/rules.md
+- docs/usage/selective_enablement.md
 - exe/chutney
 - img/chutney.svg
 - img/formatters.png
@@ -249,11 +257,13 @@ files:
 - lib/config/locales/en.yml
 - spec/chutney_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/BillyRuffian/chutney
+homepage: https://billyruffian.github.io/faker_maker/
 licenses:
 - MIT
 metadata:
+  homepage_uri: https://billyruffian.github.io/faker_maker/
   source_code_uri: https://github.com/BillyRuffian/chutney
+  changelog_uri: https://github.com/BillyRuffian/chutney/releases
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -265,9 +275,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.2
 signing_key: