greener2 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21659a58c5605652857c5e13e450b645e5be355e
+  data.tar.gz: fb62aaca67ca27327e2dd2cb8ccf34dc65063540
+SHA512:
+  metadata.gz: 75c81d38126470eae8e0dd52ca3577c3e42c4a01f67d414d948577b074b269855dc61b4b1645792e45f624c7cfa8f7ce01fa94b84269208a516d5c16ca9ed24a
+  data.tar.gz: 270a125694816a97cd10549d7b034d29abe763fbe605c84a65676174065adcbb9784b9b406f45bb672d1b808a49fe5325e752fc454db5c271314458b9c96b336

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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 smoll
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+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)
+
+Keep your Cucumber and Spinach feature files greener :four_leaf_clover: with this configurable linter
+
+**NOTE: This project is still under early-stage development**
+
+## TODOs
+
+0. Move "results printing" logic to configurable formatters
+0. Implement some kind of hooks system for use by formatters, similar to [this](https://github.com/bbatsov/rubocop/blob/master/lib/rubocop/formatter/base_formatter.rb#L30-L41)
+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
+```
+bundle install
+```
+
+Run tests
+```
+bundle exec rake test
+```
+
+View code coverage
+```
+rake && open coverage/index.html
+```
+
+## Testing
+
+To test the `greener` binary locally, `cd` to the repo root and run
+```
+RUBYLIB=lib bundle exec ruby bin/greener
+```
+Based on [this answer](http://stackoverflow.com/a/23367196/3456726).
+
+## References
+
+#### CLI related
+
+0. http://guides.rubygems.org/make-your-own-gem/
+0. http://whatisthor.com/
+0. https://github.com/erikhuda/thor/wiki/Integrating-with-Aruba-In-Process-Runs
+
+#### Testing related
+0. http://stackoverflow.com/questions/12673485/how-to-test-stdin-for-a-cli-using-rspec
+0. https://github.com/livinginthepast/aruba-rspec
+
+#### Lint related
+
+0. https://github.com/bbatsov/rubocop/tree/master/lib/rubocop

data/bin/greener

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "greener/runner"
+
+Greener::Runner.new(ARGV.dup).execute!

data/config/defaults.yml

@@ -0,0 +1,20 @@
+AllCheckers:
+  Formatters:
+    # Summary does not need to be added here explicitly
+    - Progress
+    - SimpleText
+  Include:
+    - "**/*.feature"
+  # Exclude:
+  #   - "some/excluded/path/*.feature"
+
+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
+  # Number of spaces for each indentation level.
+  Width: 2

data/config/dogfood.yml

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

data/features/checker_feature_name.feature

@@ -0,0 +1,74 @@
+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:
+      """
+      F
+
+      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:
+    """
+    .
+
+    1 file(s) inspected, no offenses detected
+    """
+
+  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:
+    """
+    .
+
+    1 file(s) inspected, no offenses detected
+    """
+
+  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:
+      """
+      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!
+
+      1 file(s) inspected, 1 offense(s) detected
+      """

data/features/checker_indentation_width.feature

@@ -0,0 +1,23 @@
+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:
+      """
+      F
+
+      foo/indentation.feature:5
+         Scenario: poorly indented
+         ^^^ inconsistent indentation detected
+
+      1 file(s) inspected, 1 offense(s) detected
+      """

data/features/configuration.feature

@@ -0,0 +1,59 @@
+Feature: configuration
+
+  Scenario: disable checker via config file
+    Given a file named "foo/mismatched_feature_title.feature" with:
+      """
+      Feature: mismatched feature title LOL
+      """
+    And a file named "config/disabled.yml" with:
+      """
+      Style/FeatureName:
+        Enabled: false
+      """
+    When I run `greener --config config/disabled.yml`
+    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:
+      """
+      Feature: something
+      """
+    And a file named "config/invalid.yml" with:
+      """
+      Style/NotEvenReal:
+        Enabled: false
+      """
+    When I run `greener --config config/invalid.yml`
+    Then the output should contain exactly "Unknown checker specified: Style/NotEvenReal\n"
+
+  Scenario: complex configuration
+    Given a file named "foo/indentation_too.feature" with:
+      """
+      Feature: BAD NAME LOL
+
+          Scenario: correctly indented
+
+          Scenario: correctly indented
+              Then boom
+      """
+    And a file named "config/complex.yml" with:
+      """
+      Style/FeatureName:
+        Enabled: false
+
+      Style/IndentationWidth:
+        Enabled: true
+        Width: 4
+      """
+    When I run `greener --config config/complex.yml`
+    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

@@ -0,0 +1,27 @@
+Feature: lint
+
+  Scenario: multiple issues
+    Given a file named "foo/multiple_issues.feature" with:
+      """
+       Feature: multiple issues
+
+        Scenario: correctly indented
+
+         Scenario: poorly indented
+          Then nothing
+      """
+    When I run `greener`
+    Then the output should contain:
+      """
+      F
+
+      foo/multiple_issues.feature:1
+       Feature: multiple issues
+       ^^^ inconsistent indentation detected
+
+      foo/multiple_issues.feature:5
+         Scenario: poorly indented
+         ^^^ inconsistent indentation detected
+
+      1 file(s) inspected, 2 offense(s) detected\n
+      """

data/features/support/env.rb

@@ -0,0 +1,9 @@
+require "simplecov"
+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

@@ -0,0 +1,46 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "greener/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "greener2"
+  spec.version       = Greener::VERSION
+  spec.authors       = ["ikozakov"]
+  spec.email         = ["ivankozakov0@gmail.com"]
+
+  spec.summary       = "A Gherkin .feature file linter"
+  spec.description   = "Keep your Gherkin readable with the greener linter..."
+  spec.homepage      = "https://github.com/ikozakov/greener"
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files`.split($RS).reject do |file|
+    file =~ %r{^(?:
+    spec/.*
+    |\.gitignore
+    |\.rspec
+    |\.rubocop.yml
+    |\.rubocop_todo.yml
+    |\.simplecov
+    |circle.yml
+    |cucumber.yml
+    |Gemfile
+    |Rakefile
+    )$}x
+  end
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "gherkin3", "~> 3.1.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"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4.6"
+  spec.add_development_dependency "coveralls", "~> 0.7.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3.0"
+  spec.add_development_dependency "rubocop", "~> 0.32.0"
+  spec.add_development_dependency "simplecov", "~> 0.9.1"
+end

data/lib/greener/checker/base.rb

@@ -0,0 +1,51 @@
+module Greener
+  module Checker
+    # Base checker class
+    class Base
+      attr_reader :violations
+
+      def initialize(ast, path, config)
+        @ast = ast
+        @path = path
+        @config = config
+
+        @violations = []
+      end
+
+      # Method invoked when a checker is applied to a file
+      def run
+      end
+
+      # Read the violation message text set in the checker subclass
+      def message
+        self.class::MSG
+      end
+
+      # Adds violation data to the @violations array
+      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
+
+        violation = {}
+        violation[:file] = @path
+        violation[:line] = line
+        violation[:column] = col
+        violation[:text_of_line] = raw_txt
+        violation[:message] = msg
+
+        @violations << violation
+      end
+
+      # For readability in checker subclasses
+      def feature
+        @ast
+      end
+
+      # Given a num, returns the full text corresponding to that line number in the file
+      def raw_line(num)
+        open(@path).each_line.take(num).last
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+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"
+      class FeatureName < Base
+        MSG = "feature title does not match file name"
+
+        def run
+          return unless @config["Enabled"]
+
+          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
+end

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

@@ -0,0 +1,44 @@
+require "greener/checker/base"
+
+module Greener
+  module Checker
+    module Style
+      # Ensure keywords are indented correctly
+      # Ref: https://github.com/bbatsov/rubocop/commit/44c1cdd5d9bc1c3588ea7841fc6e9543126306e8
+      class IndentationWidth < Base
+        MSG = "inconsistent indentation detected"
+
+        def run
+          return unless @config["Enabled"]
+
+          check_feature_line
+          check_every_scenario
+        end
+
+        def check_feature_line
+          return if feature[:location][:column] == 1
+          log_violation(feature[:location][:line], feature[:location][:column])
+        end
+
+        def check_every_scenario
+          feature[:scenarioDefinitions].each do |scenario|
+            scenario[:steps].each { |step| check_a_step(step) }
+
+            next if scenario[:location][:column] == (1 + configured_indentation_width)
+            log_violation(scenario[:location][:line], scenario[:location][:column])
+          end
+        end
+
+        def check_a_step(step) # nil if a scenario has no steps, or
+          # {:type=>:Step, :location=>{:line=>6, :column=>5}, :keyword=>"Then ", :text=>"nothing"}
+          return if step[:location][:column] == (1 + configured_indentation_width * 2)
+          log_violation(step[:location][:line], step[:location][:column])
+        end
+
+        def configured_indentation_width
+          @config["Width"]
+        end
+      end
+    end
+  end
+end

data/lib/greener/cli.rb

@@ -0,0 +1,19 @@
+require "thor"
+
+require "greener/linter"
+
+module Greener
+  # Main Thor application
+  # Subcommands map directly to instance methods in this class.
+  # e.g. entering `greener whatever` in your terminal should invoke the App#whatever method
+  class CLI < Thor
+    desc "lint", "The default task to run when no command is given"
+    method_options %w( config -c ) => :string
+    def lint
+      linter = Linter.new(options[:config])
+      linter.lint
+    end
+
+    default_task :lint
+  end
+end

data/lib/greener/config_store.rb

@@ -0,0 +1,124 @@
+require "yaml"
+
+require "greener/utils"
+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, :formatters
+
+    def initialize(path, default_path = nil)
+      @path = path
+      default_path ||= default_absolute_path
+      @default_path = default_path
+
+      @checkers = {}
+      @files = []
+      @formatters = []
+    end
+
+    def resolve
+      if @path
+        fail Error::Standard, "No config file found at specified path: #{@path}" unless File.exist? @path
+        config = load_yml_file @path
+      end
+
+      config ||= {}
+      defaults = load_yml_file @default_path
+      @all = merge_hashes(defaults, config)
+
+      validate
+      self
+    end
+
+    # Stub-able methods
+    def load_yml_file(path)
+      YAML.load_file(path)
+    end
+
+    def files_matching_glob(glob)
+      Dir.glob(glob).select { |e| File.file? e }
+    end
+
+    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 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) }
+        checker_klass = checker_from_string(k)
+        @checkers[checker_klass] = v
+        @all.delete(k)
+      end
+    end
+
+    def set_files
+      includes = []
+      excludes = []
+
+      @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
+      File.expand_path("../../../config/defaults.yml", __FILE__)
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+require "greener/config_store"
+require "greener/formatter_set"
+require "greener/parser"
+
+module Greener
+  # Parse then lint a collection of .feature files for violations
+  class Linter
+    def initialize(config_path)
+      @config = ConfigStore.new(config_path).resolve
+      @results = []
+      @formatter_set = FormatterSet.new @config.formatters
+    end
+
+    def lint
+      @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
+
+      @formatter_set.finished @results
+    end
+
+    private
+
+    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
+
+      @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,18 @@
+require "gherkin3/parser"
+require "gherkin3/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 = Gherkin3::Parser.new
+      scanner = Gherkin3::TokenScanner.new(@feature)
+      parser.parse(scanner)
+    end
+  end
+end

data/lib/greener/runner.rb

@@ -0,0 +1,63 @@
+require "greener/cli"
+
+begin # require any dev dependencies here
+  require "byebug"
+rescue LoadError # rubocop:disable Lint/HandleExceptions
+end
+
+module Greener
+  # Aruba In Process + Thor integration
+  # Based on https://github.com/erikhuda/thor/wiki/Integrating-with-Aruba-In-Process-Runs
+  class Runner
+    # Allow everything fun to be injected from the outside while defaulting to normal implementations.
+    def initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = Kernel)
+      @argv = argv
+      @stdin = stdin
+      @stdout = stdout
+      @stderr = stderr
+      @kernel = kernel
+    end
+
+    def execute!
+      exit_code = begin
+        # Thor accesses these streams directly rather than letting them be injected, so we replace them...
+        $stderr = @stderr
+        $stdin = @stdin
+        $stdout = @stdout
+
+        # Run our normal Thor app the way we know and love.
+        Greener::CLI.start(@argv)
+
+        # Thor::Base#start does not have a return value, assume success if no exception is raised.
+        0
+      rescue Greener::Error::Standard => e
+        @stderr.puts e.message
+        1
+      rescue StandardError => e
+        # The ruby interpreter would pipe this to STDERR and exit 1 in the case of an unhandled exception
+        b = e.backtrace
+        @stderr.puts("#{b.shift}: #{e.message} (#{e.class})")
+        @stderr.puts(b.map { |s| "\tfrom #{s}" }.join("\n"))
+        1
+      rescue SystemExit => e
+        e.status
+      ensure
+        # TODO: reset your app here, free up resources, etc.
+        # Examples:
+        # MyApp.logger.flush
+        # MyApp.logger.close
+        # MyApp.logger = nil
+        #
+        # MyApp.reset_singleton_instance_variables
+
+        # ...then we put the streams back.
+        $stderr = STDERR
+        $stdin = STDIN
+        $stdout = STDOUT
+      end
+
+      # Proxy our exit code back to the injected kernel.
+      @kernel.exit(exit_code)
+    end
+  end
+end

data/lib/greener/utils.rb

@@ -0,0 +1,31 @@
+module Greener
+  # Useful shared utils
+  module Utils
+    def checker_from_string(str)
+      namespaced = str.gsub("/", "::")
+      constantize "Greener::Checker::#{namespaced}"
+    rescue NameError
+      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
+
+    # Borrowed from Rails
+    def constantize(camel_cased_word)
+      names = camel_cased_word.split("::")
+      names.shift if names.empty? || names.first.empty?
+
+      constant = Object
+      names.each do |name|
+        constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+      end
+      constant
+    end
+  end
+end

data/lib/greener/version.rb

@@ -0,0 +1,4 @@
+# Gem version
+module Greener
+  VERSION = "0.0.1"
+end

data/lib/greener.rb

@@ -0,0 +1 @@
+require "greener/runner"

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification
+name: greener2
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ikozakov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gherkin3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: titleize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.5
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.6
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.9
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.32.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.32.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description: Keep your Gherkin readable with the greener linter...
+email:
+- ivankozakov0@gmail.com
+executables:
+- greener
+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/formatter_progress.feature
+- features/lint.feature
+- features/support/env.rb
+- greener.gemspec
+- lib/greener.rb
+- lib/greener/checker/base.rb
+- lib/greener/checker/style/feature_name.rb
+- lib/greener/checker/style/indentation_width.rb
+- lib/greener/cli.rb
+- lib/greener/config_store.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
+homepage: https://github.com/ikozakov/greener
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A Gherkin .feature file linter
+test_files: []