greener 0.0.1.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a4c2f033e269791bfbef80978c096695c6847f2
-  data.tar.gz: 7647963368a1e66d16664b7660c40979b5fb560e
+  metadata.gz: 82d715e2bc60c20c81addaf628e6261ce71fe7b3
+  data.tar.gz: 0a8b92e22438005651b5e3ac73106b784ea9f046
 SHA512:
-  metadata.gz: 41e90af06a1f0355c7499a833aaf30bc1c30c633659b769f0dc8c102707916c199e5a4ba117d99c3ddb47fce7e8d3602629fce1898992c9f1539ba7bc9a18792
-  data.tar.gz: 733319f7a35759b6017c23c7443dc9df85df46daafa862cc091bdaab7f3c3384f12696c286a28df33fccae7705d290b8d7622011635b85270f9357f23479412a
+  metadata.gz: 7fdfa149aa9569cd11b86f02529a2c420b2561d701454eaedc9a24c9a3dba26bba1df53053d086cb0daea573e88814d67a8596af9a636d86a1763a5f6f9c0ccf
+  data.tar.gz: cc534b77ef04bc747d542cc353fd22bcc9f54d5f9dac3c8d0cf95511d2b51f163b0875a82d56475b54dbb9db6e3d92bae3f32e06cdea36b1390611a9b2a4fc05

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.1.0 (June 29, 2015)
+
+Features:
+
+  - First minor version release
+  - 2 checkers are available, `Style/FeatureName` and `Style/IndentationWidth`
+  - By default, `greener` checks for .feature files recursively from the current working directory. This can be overridden via the `AllCheckers:` > `Include:` or `Exclude:` keys in the yml.

data/README.md

@@ -1,7 +1,7 @@
 greener
 ===
 
-[![Circle CI](https://circleci.com/gh/smoll/greener.svg?style=svg)](https://circleci.com/gh/smoll/greener) [![Code Climate](https://codeclimate.com/github/smoll/greener/badges/gpa.svg)](https://codeclimate.com/github/smoll/greener) [![Coverage Status](https://coveralls.io/repos/smoll/greener/badge.svg?branch=master)](https://coveralls.io/r/smoll/greener?branch=master)
+[![Circle CI](https://circleci.com/gh/smoll/greener.svg?style=svg)](https://circleci.com/gh/smoll/greener) [![Code Climate](https://codeclimate.com/github/smoll/greener/badges/gpa.svg)](https://codeclimate.com/github/smoll/greener) [![Coverage Status](https://coveralls.io/repos/smoll/greener/badge.svg?branch=master)](https://coveralls.io/r/smoll/greener?branch=master) [![Gem Version](https://badge.fury.io/rb/greener.svg)](http://badge.fury.io/rb/greener)
 
 A Gherkin .feature file linter
 
@@ -14,6 +14,17 @@ A Gherkin .feature file linter
 0. Create a RakeTask class for use in CI systems
 0. Add coloring for formatters
 
+## Usage
+
+Install the gem
+```
+gem install greener
+```
+
+The `greener` binary takes a single argument, `-c path/to/config/greener.yml`. See the [defaults](./config/defaults.yml) for an example of this file.
+
+View the [changelog](./CHANGELOG.md) for recent changes.
+
 ## Contributing
 
 Install dev dependencies locally
@@ -31,11 +42,6 @@ View code coverage
 rake && open coverage/index.html
 ```
 
-View code coverage from RSpec unit tests only
-```
-rm -rf coverage && rspec && open coverage/index.html
-```
-
 ## Testing
 
 To test the `greener` binary locally, `cd` to the repo root and run

data/config/defaults.yml

@@ -1,4 +1,4 @@
-# FileList:
+# AllCheckers:
 #   Include:
 #     - "**/*.feature"
 #   Exclude:
@@ -6,6 +6,9 @@
 
 Style/FeatureName:
   Enabled: true
+  # Allow non-alphanumeric characters, e.g. filename test_thing.feature with text "Feature: (test) thing"
+  AllowPunctuation: true
+  EnforceTitleCase: false
 
 Style/IndentationWidth:
   Enabled: true

data/config/dogfood.yml

@@ -1,4 +1,4 @@
 # Used by dogfood test, i.e. run greener against the .feature files in this repo!
-FileList:
+AllCheckers:
   Include:
     - "features/**/*.feature"

data/features/checker_feature_name.feature

@@ -0,0 +1,60 @@
+Feature: (checker) feature name
+
+  Scenario: feature text does not match filename
+    Given a file named "foo/mismatched_feature_title.feature" with:
+      """
+      Feature: mismatched feature title LOL
+      """
+    When I run `greener`
+    Then the output should contain:
+      """
+      foo/mismatched_feature_title.feature:1
+      Feature: mismatched feature title LOL
+      ^^^ feature title does not match file name
+
+      1 file(s) inspected, 1 offense(s) detected
+      """
+
+  Scenario: capitalization allowed
+    Given a file named "foo/valid_title.feature" with:
+      """
+      Feature: Valid Title
+      """
+    When I run `greener`
+    Then the output should contain exactly "1 file(s) inspected, no offenses detected\n"
+
+  Scenario: punctuation allowed
+    Given a file named "foo/some_punctuation.feature" with:
+      """
+      Feature: (some) punctuation
+      """
+    And a file named "config/punctuation_allowed.yml" with:
+      """
+      Style/FeatureName:
+        Enabled: true
+        AllowPunctuation: true
+      """
+    When I run `greener --config config/punctuation_allowed.yml`
+    Then the output should contain exactly "1 file(s) inspected, no offenses detected\n"
+
+  Scenario: title case enforced
+    Given a file named "foo/this_isnt_title_case_yo.feature" with:
+      """
+      Feature: this isn't Title Case, yo!
+      """
+    And a file named "config/enforce_title_case.yml" with:
+      """
+      Style/FeatureName:
+        Enabled: true
+        AllowPunctuation: true
+        EnforceTitleCase: true
+      """
+    When I run `greener --config config/enforce_title_case.yml`
+    Then the output should contain:
+      """
+      foo/this_isnt_title_case_yo.feature:1
+      Feature: this isn't Title Case, yo!
+      ^^^ feature title is not title case. expected: This Isn't Title Case, Yo!
+
+      1 file(s) inspected, 1 offense(s) detected
+      """

data/features/checker_indentation_width.feature

@@ -0,0 +1,21 @@
+Feature: (checker) indentation width
+
+  Scenario: inconsistent indentation
+    Given a file named "foo/indentation.feature" with:
+      """
+      Feature: indentation
+
+        Scenario: correctly indented
+
+         Scenario: poorly indented
+          Then nothing
+      """
+    When I run `greener`
+    Then the output should contain:
+      """
+      foo/indentation.feature:5
+         Scenario: poorly indented
+         ^^^ inconsistent indentation detected
+
+      1 file(s) inspected, 1 offense(s) detected
+      """

data/features/lint.feature

@@ -1,26 +1,9 @@
 Feature: lint
-  * TODO: eventually, move most, if not all, of these to unit tests
 
-  Scenario: feature text matches, with flexible capitalization
-    Given a file named "foo/valid_title.feature" with:
-      """
-      Feature: Valid Title
-      """
-    When I run `greener`
-    Then the output should contain exactly "1 file(s) inspected, no offenses detected\n"
-
-  Scenario: feature text does not match filename
-    Given a file named "foo/mismatched_feature_title.feature" with:
-      """
-      Feature: mismatched feature title LOL
-      """
-    When I run `greener`
-    Then the output should contain exactly "foo/mismatched_feature_title.feature:1\nFeature: mismatched feature title LOL\n^^^ feature title does not match file name\n\n1 file(s) inspected, 1 offense(s) detected\n"
-
-  Scenario: inconsistent indentation
-    Given a file named "foo/indentation.feature" with:
+  Scenario: multiple issues
+    Given a file named "foo/multiple_issues.feature" with:
       """
-      Feature: indentation
+       Feature: multiple issues
 
         Scenario: correctly indented
 
@@ -28,17 +11,15 @@ Feature: lint
           Then nothing
       """
     When I run `greener`
-    Then the output should contain exactly "foo/indentation.feature:5\n   Scenario: poorly indented\n   ^^^ inconsistent indentation detected\n\n1 file(s) inspected, 1 offense(s) detected\n"
-
-  Scenario: multiple issues
-    Given a file named "foo/multiple_issues.feature" with:
+    Then the output should contain:
       """
+      foo/multiple_issues.feature:1
        Feature: multiple issues
+       ^^^ inconsistent indentation detected
 
-        Scenario: correctly indented
-
+      foo/multiple_issues.feature:5
          Scenario: poorly indented
-          Then nothing
+         ^^^ inconsistent indentation detected
+
+      1 file(s) inspected, 2 offense(s) detected\n
       """
-    When I run `greener`
-    Then the output should contain "1 file(s) inspected, 2 offense(s) detected\n"

data/features/support/env.rb

@@ -3,5 +3,7 @@ require "aruba/cucumber"
 require "aruba/in_process"
 require "greener/runner"
 
+SimpleCov.command_name "features"
+
 Aruba::InProcess.main_class = Greener::Runner
 Aruba.process = Aruba::InProcess

data/greener.gemspec

@@ -31,9 +31,10 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "thor", "~> 0.19.1"
   # TODO: rip this out when gherkin3 has a release
   spec.add_dependency "gherkin3-pre-alpha", "~> 3.0.0.alpha.1"
+  spec.add_dependency "thor", "~> 0.19.1"
+  spec.add_dependency "titleize", "~> 1.3.0"
 
   spec.add_development_dependency "aruba", "~> 0.6.2"
   spec.add_development_dependency "bundler", ">= 1.9.5"

data/lib/greener/checker/base.rb

@@ -22,7 +22,7 @@ module Greener
       end
 
       # Adds violation data to the @violations array
-      def log_violation(line, col, raw_txt = nil, msg = nil)
+      def log_violation(line, col, msg = nil, raw_txt = nil)
         # Set defaults for last 2 params if not overridden
         raw_txt ||= raw_line(line)
         msg ||= message

data/lib/greener/checker/style/feature_name.rb

@@ -1,24 +1,47 @@
 require "greener/checker/base"
+require "titleize"
 
 module Greener
   module Checker
     module Style
       # Ensure .feature filename matches feature name in the Gherkin
       # e.g. filename_of_feature.feature => "Feature: filename of feature"
-      # TODO: add config option for toggling flexible capitalization
       class FeatureName < Base
         MSG = "feature title does not match file name"
 
-        # Returns nil if no violation, or if there is one:
-        # { line: 1, column: 1, text_of_line: "Feature: thing", message: "feature title does not match file name" }
         def run
           return unless @config["Enabled"]
 
-          filename_without_extension = File.basename(@path, ".*")
-          return if feature[:name].downcase.gsub(" ", "_") == filename_without_extension
+          run_against_filename
+          run_against_titlecase
+        end
 
+        def run_against_filename
+          filename_without_extension = File.basename(@path, ".*")
+          expected = feature[:name]
+          expected = expected.gsub(/[^0-9a-z ]/i, "") if allow_punctuation?
+          expected = expected.downcase.gsub(" ", "_")
+          return if filename_without_extension == expected
           log_violation(feature[:location][:line], feature[:location][:column])
         end
+
+        def run_against_titlecase
+          return unless enforce_title_case?
+          return if feature[:name].titlecase == feature[:name]
+          log_violation(
+            feature[:location][:line],
+            feature[:location][:column],
+            "feature title is not title case. expected: #{feature[:name].titlecase}"
+          )
+        end
+
+        def allow_punctuation?
+          @config["AllowPunctuation"]
+        end
+
+        def enforce_title_case?
+          @config["EnforceTitleCase"]
+        end
       end
     end
   end

data/lib/greener/config_store.rb

@@ -66,13 +66,13 @@ module Greener
     end
 
     def set_files
-      if @all["FileList"].nil?
+      if @all["AllCheckers"].nil?
         # Default to all .feature files recursively
         return @files = files_matching_glob("**/*.feature")
       end
 
       @all.each do |k, v|
-        next unless k == "FileList"
+        next unless k == "AllCheckers"
         discover_files(v)
         @all.delete(k)
       end

data/lib/greener/version.rb

@@ -1,4 +1,4 @@
 # Gem version
 module Greener
-  VERSION = "0.0.1.2"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: greener
 version: !ruby/object:Gem::Version
-  version: 0.0.1.2
+  version: 0.1.0
 platform: ruby
 authors:
 - smoll
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-26 00:00:00.000000000 Z
+date: 2015-06-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: gherkin3-pre-alpha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.alpha.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.alpha.1
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -25,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.19.1
 - !ruby/object:Gem::Dependency
-  name: gherkin3-pre-alpha
+  name: titleize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.alpha.1
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.alpha.1
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
@@ -158,11 +172,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - bin/greener
 - config/defaults.yml
 - config/dogfood.yml
+- features/checker_feature_name.feature
+- features/checker_indentation_width.feature
 - features/configuration.feature
 - features/lint.feature
 - features/support/env.rb
@@ -198,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A Gherkin .feature file linter