eat_your_vegetables 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f8738ad0032c17b980daedaf010e6efcc474e2916123cc09d3259af219f9829
-  data.tar.gz: 5432ad196459817c96e02752657823d93198ea958b5af6b9ddc1b3eef38acdf1
+  metadata.gz: c7866981bdf47ceca5aceebd1333e265b27f63ee59a7d7dddf4d0b3c317326f2
+  data.tar.gz: 965d18fe6d1b29f07378761b8beca7c713adb63450f3cb7083c0e9e71493cb93
 SHA512:
-  metadata.gz: 6f3b84923f31277bb37c2e4918bdb259f144e7f9ebacd7db293b1c5414771890cb693a65143918404971532d65e928193a6dda3aef4427ed3007689dcffc39b0
-  data.tar.gz: 4195f71b37d18ec5a4542d4b8a6413c4281ba1da13155144e08a5ad30631d43b915910b128dee57170385710ffcdef8fc104b16196950b6e81aeabc9a66f9097
+  metadata.gz: 374cecbb22296387508a0f2c088d9727adb95a4d065a5ec62383cbebdf0d2de46adf16027d9d5561b023d14be323162a8c36820929aec639fdddb2f0cadd0a36
+  data.tar.gz: 999905d875acec18e496d611baea5951c60038719e33072f40623d0dd23261ab4f9a35544af1e420e7aa01604fd7eede9c7e645026df0441457363a958b8a618

data/Dockerfile

@@ -0,0 +1,9 @@
+FROM ruby:2.6-alpine
+
+RUN apk add git alpine-sdk
+RUN bundle config --global frozen 1
+
+WORKDIR /data
+RUN gem install eat_your_vegetables
+
+CMD eat_your_vegetables

data/Gemfile

@@ -5,3 +5,7 @@ gemspec
 group :development do
   gem 'kramdown'
 end
+
+group :development, :test do
+  gem 'pry'
+end

data/README.md

@@ -2,7 +2,7 @@
 
 * [Email](mailto:cfeckardt@gmail.com)
 
-_NOTE THIS IS A WORK IN PROGRESS. DOCUMENTATION AND SOFTWARE IS INCOMPLETE_
+_NOTE THIS IS A WORK IN PROGRESS. DOCUMENTATION AND SOFTWARE IS INCOMPLETE AND IS PROVIDED ON AS IS. PLEASE HELP MY CONTRIBUTING_
 
 ## Description
 Eat Your Vegetables is a tool that aims to help you improve your codebase over
@@ -18,10 +18,10 @@ that number hasn't decreased.
 
 ## Features
 Support for linters, coverage and test tools. For a full list of support tools
-see SUPPORTED_TOOLS.md
+see [SUPPORTED_TOOLS.md](docs/SUPPORTED_TOOLS.md)
 
 This project is still in early days so _please_ add support for your framework
-if it is missing. There is a simple guide here: ADDING_FRAMEWORKS.md
+if it is missing. There is a simple guide here: [ADDING_ADAPTERS.md](docs/ADDING_ADAPTERS.md)
 
 ## Requirements
 
@@ -37,9 +37,12 @@ be executing your environment with git available.
 Eat Your Vegetables is intended to be run with
 
 ### With docker
+
 For all you hip kids out there, there's a Dockerfile!
 
-`docker run eat_your_vegetables:latest`
+```bash
+$ docker run --mount type=bind,source=`pwd`,target=/data cfeckardt/eat_your_vegetables:latest
+```
 
 ## Configuration
 
@@ -56,12 +59,27 @@ simplecov
 
 ### Setting up CI
 
-#### Gitlab
+#### Travis
+
+```yaml
+---
+language: ruby
+before_script:
+  - gem install eat_your_vegetables
+script:
+  - bundle exec eat_your_vegetables
 
-#### Circle CI
+```
 
 #### Other
 
+In order to run _eyv_ in your CI suite you need to:
+
+1. Ensure git is installed
+2. Ensure ruby is installed
+3. Run `gem intall eat_your_vegetables`
+4. Run `bundle exec eat_your_vegetables` or just `eat_your_vegetables`
+
 Please contribute by adding set up instructions for other CIs.
 
 ## Contributing

data/bin/eat_your_vegetables

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
-require 'eat_your_vegetables'
+$LOAD_PATH.unshift(File.expand_path('../lib'))
+
+require_relative '../lib/eat_your_vegetables.rb'
 
 EatYourVegetables::Runner.new.run

data/docs/ADDING_ADAPTERS.md

@@ -0,0 +1,31 @@
+# Adding support for more adapters
+
+Currently there is only support for a small number of tools, in ruby, but adding support for _any_ language is easy, and will only take a couple of minutes.
+
+You may use the example below to implement your own adapter:
+
+```ruby
+require_relative 'base'
+
+module EatYourVegetables
+  module Tools # Create your tool in this namespace
+    class MyTool < Base # Inherit from the base tool
+      attr_writer :config_file # Add attr_writers for configurable values
+      protected
+      # Will get called when running the tool to determine
+      # the location of the config file (across branches)
+      def config_file # You need to implement this method
+        @config_file || '.mytoolignore.yml' # Default value
+      end
+
+      # Will get called with the contents of the config_file, for the valid branches.
+      # Should return an array of files excluded by the content
+      def excluded_files(content) # You need to implement this method
+        content.split("\n")
+      end
+    end
+  end
+end
+
+```
+

data/docs/SUPPORTED_TOOLS.md

@@ -0,0 +1,46 @@
+# Supported Tools
+
+Currently there is only support for a small number of tools, in ruby, but adding support for _any_ language is easy, and will only take a couple of minutes. See [ADDING_ADAPTERS.md](ADDING_ADAPTERS.md) for instructions.
+
+## Ruby
+
+### Rubocop
+
+The rubocop adapter supports the following options:
+
+```ruby
+rubocop do
+  config_file ".rubocop.yml" # relative path to the config file, defaults to .rubocop.yml
+end
+```
+
+Any and all files matched under an `Exclude:` key are considered excluded by this adapter. This means that both `file1.rb` and `file2.rb` are matched.
+
+```yaml
+AllCops:
+  Exclude:
+    - file1.rb
+Style/Indentation:
+  Exclude:
+    - file2.rb
+```
+
+### Simplecov
+
+The simplecov adapter supports the following options:
+
+```ruby
+simplecov do
+  config_file 'spec/spec_helper.rb' # relative path of config file, defaults to spec/spec_helper.rb
+end
+```
+
+The simplecov adapter will look for _any_ lines in the provided file that includes the line `add_filter "some_file.rb"` and match on `some_file.rb`
+
+Typically you will have something like:
+
+```ruby
+Simplecov.start do
+  add_filter "file1.rb"
+end
+```

data/eat_your_vegetables.gemspec

@@ -28,10 +28,11 @@ Force your team to incrementally improve your code base with every commit to mas
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'rake', '~> 12.3.2'
+  gem.add_dependency 'colorize', '~> 0.8'
 
   gem.add_development_dependency 'bundler', '~> 1.10'
   gem.add_development_dependency 'pry', '~> 0.12'
+  gem.add_development_dependency 'rake', '~> 12.3.2'
   gem.add_development_dependency 'rspec', '~> 3.0'
   gem.add_development_dependency 'rubocop', '~> 0.63'
   gem.add_development_dependency 'rubygems-tasks', '~> 0.2'

data/lib/eat_your_vegetables.rb

@@ -1,6 +1,8 @@
 require 'eat_your_vegetables/version'
 require 'eat_your_vegetables/tools/rubocop'
 
+require 'colorize'
+
 module EatYourVegetables
   class Runner
     def initialize
@@ -17,14 +19,21 @@ module EatYourVegetables
 
       if @tools.any? &:is_configed?
         if step_difference == 0
-          puts "Sorry, I can't let you do that"
+          puts "Sorry, I can't let you do that".yellow
+          puts "Please, fix one of the ignored files and try again!".yellow
+          puts "For example:".yellow
+
+          @tools.flat_map(&:current_exclusions).flatten.sort.sample(10).each do |excluded_file|
+            puts excluded_file.red
+          end
+
           exit 1
         else
-          puts "Thanks, for eating your veggies."
+          puts "Thanks, for eating your veggies.".green
           exit 0
         end
       else
-        puts 'It appears there are no vegetables to eat'
+        puts 'It appears there are no vegetables to eat'.blue
         exit 0
       end
     end

data/lib/eat_your_vegetables/tools/base.rb

@@ -6,30 +6,24 @@ module EatYourVegetables
     class Base
       def initialize(parent_branch:)
         @parent_branch = parent_branch
-        @ambition_filter = []
-      end
-
-      def filter(file)
-        if file.is_a? Array
-          file.each do |f|
-            filter f
-          end
-        end
-
-        @ambition_filter << file
       end
 
       def step_difference
         return 0 unless is_configed?
 
-        parent_exclusions = excluded_files(parent_file_contents)
-        current_exclusions = excluded_files(current_file_contents)
-
         (parent_exclusions - current_exclusions).count
       end
 
+      def parent_exclusions
+        @parent_exclusions ||= excluded_files(parent_file_contents)
+      end
+
+      def current_exclusions
+        @current_exclusions ||= excluded_files(current_file_contents)
+      end
+
       def parent_file_contents
-        cmdstr = "git show origin/master:#{config_file}"
+        cmdstr = "git show origin/#{@parent_branch}:#{config_file}"
         stdout, stderr, status = Open3.capture3(cmdstr)
 
         stdout

data/lib/eat_your_vegetables/tools/rubocop.rb

@@ -4,16 +4,20 @@ require_relative 'base'
 module EatYourVegetables
   module Tools
     class Rubocop < Base
+      attr_writer :config_file
+
       protected
 
       def config_file
-        '.rubocop.yml'
+        @config_file || '.rubocop.yml'
       end
 
       def excluded_files(content)
         yaml = YAML.load(content)
 
-        yaml['AllCops']['Exclude']
+        yaml.values.reduce([]) do |acc, hash|
+          acc << hash['Exclude']
+        end.compact.sort.uniq
       end
     end
   end

data/lib/eat_your_vegetables/tools/simplecov.rb

@@ -0,0 +1,24 @@
+module EatYourVegetables
+  module Tools
+    # Simplecov provides integration with the Simplecov coverage framework
+    class Simplecov < Base
+      attr_writer :config_file
+
+      protected
+
+      def config_file
+        @config_file || 'spec/spec_helper.rb'
+      end
+
+      def excluded_files(content)
+        # Matches all add_filter in the file.
+        # It's imperfect but works for now.
+        content.split("\n").select do |line|
+          line.include? 'add_filter'
+        end.map do |line|
+          /[\"'](\S+)[\"']/.match(line.strip).to_s
+        end
+      end
+    end
+  end
+end

data/lib/eat_your_vegetables/version.rb

@@ -1,4 +1,4 @@
 module EatYourVegetables
   # eat_your_vegetables version
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: eat_your_vegetables
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Fredrik Eckardt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-05 00:00:00.000000000 Z
+date: 2019-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.2
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.2
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -124,17 +138,21 @@ files:
 - ".travis.yml"
 - ".yardopts"
 - ChangeLog.md
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - Veggiefile
 - bin/eat_your_vegetables
+- docs/ADDING_ADAPTERS.md
+- docs/SUPPORTED_TOOLS.md
 - eat_your_vegetables.gemspec
 - lib/eat_your_vegetables.rb
 - lib/eat_your_vegetables/ambition.rb
 - lib/eat_your_vegetables/tools/base.rb
 - lib/eat_your_vegetables/tools/rubocop.rb
+- lib/eat_your_vegetables/tools/simplecov.rb
 - lib/eat_your_vegetables/version.rb
 - spec/eat_your_vegetables_spec.rb
 - spec/spec_helper.rb