greener 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82d715e2bc60c20c81addaf628e6261ce71fe7b3
-  data.tar.gz: 0a8b92e22438005651b5e3ac73106b784ea9f046
+  metadata.gz: 1d98afd17cecb377e1bdc8e8298db1bec22e8376
+  data.tar.gz: f60f7de29eb95eee30d8ca8c8553cc789baabd1a
 SHA512:
-  metadata.gz: 7fdfa149aa9569cd11b86f02529a2c420b2561d701454eaedc9a24c9a3dba26bba1df53053d086cb0daea573e88814d67a8596af9a636d86a1763a5f6f9c0ccf
-  data.tar.gz: cc534b77ef04bc747d542cc353fd22bcc9f54d5f9dac3c8d0cf95511d2b51f163b0875a82d56475b54dbb9db6e3d92bae3f32e06cdea36b1390611a9b2a4fc05
+  metadata.gz: 96a060c2754ad72b3a6c6e76f05630923f494d94420731f755e22502dafdaa1cf7c0c432e57b94a74033af7b64a92411772c3799c9b0d379d83f3bec6dd924da
+  data.tar.gz: 879d811ead5670aa08989db2de52487dfee7dff422fe3c93d7d8a14f7abd8222b1a0676b468e8ec12fd1ddbea0c690b77129cf3274642445b6f25e400b5d6388

data/README.md

@@ -1,9 +1,9 @@
-greener
+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) [![Gem Version](https://badge.fury.io/rb/greener.svg)](http://badge.fury.io/rb/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) [![Gem Version](https://badge.fury.io/rb/greener.svg)](http://badge.fury.io/rb/greener) [![Inline docs](http://inch-ci.org/github/smoll/greener.svg?branch=master)](http://inch-ci.org/github/smoll/greener)
 
-A Gherkin .feature file linter
+Keep your Cucumber and Spinach feature files greener :four_leaf_clover: with this configurable linter
 
 **NOTE: This project is still under early-stage development**
 

data/config/defaults.yml

@@ -1,8 +1,12 @@
-# AllCheckers:
-#   Include:
-#     - "**/*.feature"
-#   Exclude:
-#     - "**/*_exclusionary_special.feature"
+AllCheckers:
+  Formatters:
+    # Summary does not need to be added here explicitly
+    - Progress
+    - SimpleText
+  Include:
+    - "**/*.feature"
+  # Exclude:
+  #   - "some/excluded/path/*.feature"
 
 Style/FeatureName:
   Enabled: true

data/features/checker_feature_name.feature

@@ -8,6 +8,8 @@ Feature: (checker) feature name
     When I run `greener`
     Then the output should contain:
       """
+      F
+
       foo/mismatched_feature_title.feature:1
       Feature: mismatched feature title LOL
       ^^^ feature title does not match file name
@@ -21,7 +23,12 @@ Feature: (checker) feature name
       Feature: Valid Title
       """
     When I run `greener`
-    Then the output should contain exactly "1 file(s) inspected, no offenses detected\n"
+    Then the output should contain:
+    """
+    .
+
+    1 file(s) inspected, no offenses detected
+    """
 
   Scenario: punctuation allowed
     Given a file named "foo/some_punctuation.feature" with:
@@ -35,7 +42,12 @@ Feature: (checker) feature name
         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"
+    Then the output should contain:
+    """
+    .
+
+    1 file(s) inspected, no offenses detected
+    """
 
   Scenario: title case enforced
     Given a file named "foo/this_isnt_title_case_yo.feature" with:
@@ -52,6 +64,8 @@ Feature: (checker) feature name
     When I run `greener --config config/enforce_title_case.yml`
     Then the output should contain:
       """
+      F
+
       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!

data/features/checker_indentation_width.feature

@@ -13,6 +13,8 @@ Feature: (checker) indentation width
     When I run `greener`
     Then the output should contain:
       """
+      F
+
       foo/indentation.feature:5
          Scenario: poorly indented
          ^^^ inconsistent indentation detected

data/features/configuration.feature

@@ -11,7 +11,12 @@ Feature: configuration
         Enabled: false
       """
     When I run `greener --config config/disabled.yml`
-    Then the output should contain exactly "1 file(s) inspected, no offenses detected\n"
+    Then the output should contain:
+    """
+    .
+
+    1 file(s) inspected, no offenses detected
+    """
 
   Scenario: invalid checker specified in config
     Given a file named "foo/something.feature" with:
@@ -46,4 +51,9 @@ Feature: configuration
         Width: 4
       """
     When I run `greener --config config/complex.yml`
-    Then the output should contain exactly "1 file(s) inspected, no offenses detected\n"
+    Then the output should contain:
+    """
+    .
+
+    1 file(s) inspected, no offenses detected
+    """

data/features/formatter_progress.feature

@@ -0,0 +1,34 @@
+Feature: (formatter) progress
+
+  Scenario: happy path
+    Given a file named "foo/good.feature" with:
+      """
+      Feature: good
+
+        Scenario: correctly indented
+
+        Scenario: correctly indented
+          Then boom
+      """
+    Given a file named "foo/good_too.feature" with:
+      """
+      Feature: good too
+
+        Scenario: correctly indented
+
+        Scenario: correctly indented
+          Then boom
+      """
+    And a file named "config/good.yml" with:
+      """
+      AllCheckers:
+        Formatters:
+          - Progress
+      """
+    When I run `greener --config config/good.yml`
+    Then the output should contain:
+    """
+    ..
+
+    2 file(s) inspected, no offenses detected
+    """

data/features/lint.feature

@@ -13,6 +13,8 @@ Feature: lint
     When I run `greener`
     Then the output should contain:
       """
+      F
+
       foo/multiple_issues.feature:1
        Feature: multiple issues
        ^^^ inconsistent indentation detected

data/greener.gemspec

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

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

@@ -21,7 +21,8 @@ module Greener
         end
 
         def check_every_scenario
-          feature[:scenarioDefinitions].each do |scenario|
+          scenarios = feature[:scenarioDefinitions] || feature[:children]
+          scenarios.each do |scenario|
             scenario[:steps].each { |step| check_a_step(step) }
 
             next if scenario[:location][:column] == (1 + configured_indentation_width)

data/lib/greener/cli.rb

@@ -12,7 +12,6 @@ module Greener
     def lint
       linter = Linter.new(options[:config])
       linter.lint
-      linter.print_results
     end
 
     default_task :lint

data/lib/greener/config_store.rb

@@ -1,18 +1,23 @@
 require "yaml"
 
 require "greener/utils"
-require "greener/custom_error"
+require "greener/error"
 
 # Require all checker files here
 require "greener/checker/style/feature_name"
 require "greener/checker/style/indentation_width"
 
+# And formatters
+require "greener/formatter/progress"
+require "greener/formatter/simple_text"
+require "greener/formatter/summary"
+
 module Greener
   # Read configs from a user-specified greener.yml or fallback to defaults
   class ConfigStore
     include Utils
 
-    attr_reader :checkers, :files
+    attr_reader :checkers, :files, :formatters
 
     def initialize(path, default_path = nil)
       @path = path
@@ -21,16 +26,18 @@ module Greener
 
       @checkers = {}
       @files = []
+      @formatters = []
     end
 
     def resolve
       if @path
-        fail CustomError, "No config file found at specified path: #{@path}" unless File.exist? @path
+        fail Error::Standard, "No config file found at specified path: #{@path}" unless File.exist? @path
         config = load_yml_file @path
       end
-      defaults = load_yml_file @default_path
 
-      @all = @path ? defaults.merge(config) : defaults
+      config ||= {}
+      defaults = load_yml_file @default_path
+      @all = merge_hashes(defaults, config)
 
       validate
       self
@@ -47,15 +54,47 @@ module Greener
 
     private
 
+    # Deep merge, with a few post-merge checks
+    def merge_hashes(default, opt)
+      result = deep_merge(default, opt)
+      # Change nils to empty hashes/arrays so this class isn't littered with #nil? checks
+      result["AllCheckers"]["Exclude"] = [] if result["AllCheckers"]["Exclude"].nil?
+
+      result
+    end
+
+    def deep_merge(first, second)
+      merger = proc { |_key, v1, v2| v1.is_a?(Hash) && v2.is_a?(Hash) ? v1.merge(v2, &merger) : v2 }
+      first.merge(second, &merger)
+    end
+
     def validate
+      set_formatters
       set_checkers
       set_files
 
+      @all.delete("AllCheckers") if @all["AllCheckers"] && @all["AllCheckers"].empty?
+
       @all.each do |k, _v|
-        fail CustomError, "Unknown option in config file: #{k}" # TODO: print warning instead of fail
+        fail Error::Standard, "Unknown option in config file: #{k}" # TODO: print warning instead of fail
       end
     end
 
+    def set_formatters
+      formatters = @all["AllCheckers"]["Formatters"].uniq.compact
+      # Ensure "Summary" formatter is in last position
+      if formatters.include?("Summary")
+        formatters << formatters.delete("Summary")
+      else
+        formatters << "Summary"
+      end
+      formatters.each do |f_string|
+        @formatters << formatter_from_string(f_string)
+      end
+
+      @all["AllCheckers"].delete "Formatters"
+    end
+
     def set_checkers
       @all.each do |k, v|
         next unless %w( Style/ Lint/ ).any? { |prefix| k.start_with?(prefix) }
@@ -66,25 +105,16 @@ module Greener
     end
 
     def set_files
-      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 == "AllCheckers"
-        discover_files(v)
-        @all.delete(k)
-      end
-    end
-
-    def discover_files(hash)
       includes = []
       excludes = []
 
-      hash["Include"].each { |glob| includes += files_matching_glob(glob) } if hash["Include"]
-      hash["Exclude"].each { |glob| excludes += files_matching_glob(glob) } if hash["Exclude"]
-      @files = (includes - excludes).uniq
+      @all["AllCheckers"]["Include"].each { |glob| includes += files_matching_glob(glob) }
+      @all["AllCheckers"].delete "Include"
+
+      @all["AllCheckers"]["Exclude"].each { |glob| excludes += files_matching_glob(glob) }
+      @all["AllCheckers"].delete "Exclude"
+
+      @files = includes.uniq - excludes.uniq
     end
 
     def default_absolute_path

data/lib/greener/error.rb

@@ -0,0 +1,7 @@
+module Greener
+  module Error
+    class Standard < StandardError; end
+
+    class LintFailed < Standard; end
+  end
+end

data/lib/greener/formatter/base_formatter.rb

@@ -0,0 +1,35 @@
+module Greener
+  module Formatter
+    # Abstract base class for formatter, implements all public API methods.
+    #
+    # ## Method Invocation Order
+    #
+    # For example, when Greener inspects 2 files,
+    # the invocation order should be like this:
+    #
+    # * `#initialize`
+    # * `#started`
+    # * `#file_started`
+    # * `#file_finished`
+    # * `#file_started`
+    # * `#file_finished`
+    # * `#finished`
+    class BaseFormatter
+      def initialize(files)
+        @files = files
+      end
+
+      def started
+      end
+
+      def file_started
+      end
+
+      def file_finished(_violations)
+      end
+
+      def finished(_violations)
+      end
+    end
+  end
+end

data/lib/greener/formatter/progress.rb

@@ -0,0 +1,21 @@
+require "greener/formatter/base_formatter"
+
+module Greener
+  module Formatter
+    # Print progress in real-time
+    class Progress < BaseFormatter
+      def file_finished(violations)
+        if violations.empty?
+          print "."
+        else
+          print "F"
+        end
+      end
+
+      def finished(_violations)
+        puts ""
+        puts ""
+      end
+    end
+  end
+end

data/lib/greener/formatter/simple_text.rb

@@ -0,0 +1,17 @@
+require "greener/formatter/base_formatter"
+
+module Greener
+  module Formatter
+    # Prints violation info that includes file, line number, text of the line, and message
+    class SimpleText < BaseFormatter
+      def finished(violations)
+        violations.each do |violation|
+          puts "#{violation[:file]}:#{violation[:line]}"
+          puts "#{violation[:text_of_line]}"
+          puts "#{' ' * (violation[:column] - 1)}^^^ #{violation[:message]}"
+          puts ""
+        end
+      end
+    end
+  end
+end

data/lib/greener/formatter/summary.rb

@@ -0,0 +1,16 @@
+require "greener/formatter/base_formatter"
+
+module Greener
+  module Formatter
+    # Prints summary line, e.g. "10 file(s) inspected, no offenses detected"
+    class Summary < BaseFormatter
+      def finished(violations)
+        conclusion = violations.empty? ? "no offenses detected" : "#{violations.count} offense(s) detected"
+
+        res = "#{@files.count} file(s) inspected, #{conclusion}"
+        return puts(res) if violations.empty?
+        fail Greener::Error::LintFailed, res
+      end
+    end
+  end
+end

data/lib/greener/formatter_set.rb

@@ -0,0 +1,20 @@
+module Greener
+  # A set of Greener::Formatter::SomeFormatter objects
+  class FormatterSet
+    def initialize(formatters)
+      @formatters = formatters
+    end
+
+    # Note the "d"
+    def initialized(*args)
+      @formatters = @formatters.map { |formatter| formatter.new(*args) }
+    end
+
+    # All these instance methods have the same method signature as those of the Formatter classes
+    [:started, :file_started, :file_finished, :finished].each do |method_name|
+      define_method method_name do |*args|
+        @formatters.each { |formatter| formatter.send(method_name, *args) }
+      end
+    end
+  end
+end

data/lib/greener/linter.rb

@@ -1,9 +1,6 @@
-require "gherkin3/parser"
-require "gherkin3/token_scanner"
-require "gherkin3/ast_builder"
-require "gherkin3/token_matcher"
-
 require "greener/config_store"
+require "greener/formatter_set"
+require "greener/parser"
 
 module Greener
   # Parse then lint a collection of .feature files for violations
@@ -11,49 +8,42 @@ module Greener
     def initialize(config_path)
       @config = ConfigStore.new(config_path).resolve
       @results = []
+      @formatter_set = FormatterSet.new @config.formatters
     end
 
-    # Here we iterate through a list of files, then iterate through the list of
-    # desired checkers, passing each one the filename & parsed AST.
-    # This is fine for now, but to speed this up we could refactor this to do a
-    # single pass through the file, line-by-line, and flagging violations as
-    # they are encountered.
     def lint
-      @config.files.each { |f| parse_single_file(f) }
-    end
-
-    def print_results
-      @results.each do |violation|
-        puts "#{violation[:file]}:#{violation[:line]}"
-        puts "#{violation[:text_of_line]}"
-        puts "#{' ' * (violation[:column] - 1)}^^^ #{violation[:message]}"
-        puts ""
+      @formatter_set.initialized(@config.files)
+      @formatter_set.started
+
+      # Here we iterate through a list of files, then iterate through the list of
+      # desired checkers, passing each one the filename & parsed AST.
+      # This is fine for now, but to speed this up we could refactor this to do a
+      # single pass through the file, line-by-line, and flagging violations as
+      # they are encountered.
+      @config.files.each do |f|
+        process_file(f) # TODO: move this to its own class
       end
 
-      print_final_line
+      @formatter_set.finished @results
     end
 
     private
 
-    def parse_single_file(fname)
-      parser = Gherkin3::Parser.new
-      scanner = Gherkin3::TokenScanner.new(fname)
-      builder = Gherkin3::AstBuilder.new
-      ast = parser.parse(scanner, builder, Gherkin3::TokenMatcher.new)
+    def process_file(fname)
+      @formatter_set.file_started
+
+      ast = Parser.new(fname).ast
+
+      violations_in_file = []
 
       @config.checkers.each do |sc_klass, sc_opts|
         checker = sc_klass.new(ast, fname, sc_opts)
         checker.run
+        violations_in_file += checker.violations
         @results += checker.violations
       end
-    end
-
-    def print_final_line
-      conclusion = @results.empty? ? "no offenses detected" : "#{@results.count} offense(s) detected"
 
-      res = "#{@config.files.count} file(s) inspected, #{conclusion}"
-      return puts(res) if @results.empty?
-      fail Greener::Error::LintFailed, res
+      @formatter_set.file_finished(violations_in_file)
     end
   end
 end

data/lib/greener/output_buffer.rb

@@ -0,0 +1,35 @@
+require "stringio"
+
+module Greener
+  # Initialize this class to delay output, https://gist.github.com/macek/596007
+  class OutputBuffer
+    def initialize
+      @buffer = StringIO.new
+      activate
+    end
+
+    def activate
+      return if @activated
+      self.class.original_stdout = $stdout
+      $stdout = @buffer
+      @activated = true
+    end
+
+    def to_s
+      @buffer.rewind
+      @buffer.read
+    end
+
+    def stop
+      self.class.restore_default
+    end
+
+    class << self
+      attr_accessor :original_stdout
+
+      def restore_default
+        $stdout = original_stdout
+      end
+    end
+  end
+end

data/lib/greener/parser.rb

@@ -0,0 +1,21 @@
+require "gherkin/parser"
+require "gherkin/token_scanner"
+
+module Greener
+  # Wrapper around Gherkin3's Parser
+  class Parser
+    def initialize(feature)
+      @feature = feature # filepath or String
+    end
+
+    # Return an Abstract Syntax Tree from a feature file
+    def ast
+      parser = Gherkin::Parser.new
+      if @feature.include?("Feature:")
+        parser.parse(Gherkin::TokenScanner.new(@feature))
+      else
+        parser.parse(Gherkin::TokenScanner.new(File.read(@feature)))[:feature]
+      end
+    end
+  end
+end

data/lib/greener/runner.rb

@@ -30,7 +30,7 @@ module Greener
 
         # Thor::Base#start does not have a return value, assume success if no exception is raised.
         0
-      rescue Greener::CustomError => e
+      rescue Greener::Error::Standard => e
         @stderr.puts e.message
         1
       rescue StandardError => e

data/lib/greener/utils.rb

@@ -5,7 +5,13 @@ module Greener
       namespaced = str.gsub("/", "::")
       constantize "Greener::Checker::#{namespaced}"
     rescue NameError
-      raise CustomError, "Unknown checker specified: #{str}" # TODO: print warning instead of failing
+      raise Error::Standard, "Unknown checker specified: #{str}" # TODO: print warning instead of failing
+    end
+
+    def formatter_from_string(str)
+      constantize "Greener::Formatter::#{str}"
+    rescue NameError
+      raise Error::Standard, "Unknown formatter specified: #{str}" # TODO: print warning instead of failing
     end
 
     private

data/lib/greener/version.rb

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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: greener
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - smoll
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2018-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: gherkin3-pre-alpha
+  name: gherkin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.alpha.1
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.alpha.1
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -181,6 +181,7 @@ files:
 - features/checker_feature_name.feature
 - features/checker_indentation_width.feature
 - features/configuration.feature
+- features/formatter_progress.feature
 - features/lint.feature
 - features/support/env.rb
 - greener.gemspec
@@ -190,8 +191,15 @@ files:
 - lib/greener/checker/style/indentation_width.rb
 - lib/greener/cli.rb
 - lib/greener/config_store.rb
-- lib/greener/custom_error.rb
+- lib/greener/error.rb
+- lib/greener/formatter/base_formatter.rb
+- lib/greener/formatter/progress.rb
+- lib/greener/formatter/simple_text.rb
+- lib/greener/formatter/summary.rb
+- lib/greener/formatter_set.rb
 - lib/greener/linter.rb
+- lib/greener/output_buffer.rb
+- lib/greener/parser.rb
 - lib/greener/runner.rb
 - lib/greener/utils.rb
 - lib/greener/version.rb
@@ -215,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A Gherkin .feature file linter

data/lib/greener/custom_error.rb

@@ -1,7 +0,0 @@
-module Greener
-  class CustomError < StandardError; end
-
-  module Error
-    class LintFailed < Greener::CustomError; end
-  end
-end