eat_your_vegetables 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f8738ad0032c17b980daedaf010e6efcc474e2916123cc09d3259af219f9829
+  data.tar.gz: 5432ad196459817c96e02752657823d93198ea958b5af6b9ddc1b3eef38acdf1
+SHA512:
+  metadata.gz: 6f3b84923f31277bb37c2e4918bdb259f144e7f9ebacd7db293b1c5414771890cb693a65143918404971532d65e928193a6dda3aef4427ed3007689dcffc39b0
+  data.tar.gz: 4195f71b37d18ec5a4542d4b8a6413c4281ba1da13155144e08a5ad30631d43b915910b128dee57170385710ffcdef8fc104b16196950b6e81aeabc9a66f9097

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.md
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,6 @@
+/.bundle
+/.yardoc/
+/Gemfile.lock
+/doc/
+/pkg/
+/vendor/cache/*.gem

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.rubocop.yml

@@ -0,0 +1,95 @@
+AllCops:
+  Exclude:
+    - 'Gemfile'
+    - 'vendor/**/*'
+    - eat_your_vegetables.gemspec
+    - spec/spec_helper.rb
+    - lib/eat_your_vegetables/tools/base.rb
+    - lib/eat_your_vegetables/tools/rubocop.rb
+    - lib/eat_your_vegetables/ambition.rb
+    - lib/eat_your_vegetables.rb
+
+Style/Documentation:
+  Enabled: true
+  Exclude:
+
+Style/DocumentationMethod:
+  Enabled: true
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 75
+
+Metrics/ClassLength:
+  Max: 1000
+
+Metrics/AbcSize:
+  Max: 100
+
+Metrics/CyclomaticComplexity:
+  Max: 30
+
+Metrics/PerceivedComplexity:
+  Max: 30
+
+Metrics/ParameterLists:
+  Max: 10
+
+StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/NegatedWhile:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/Next:
+  Enabled: false
+
+Style/ClassVars:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "**/*_spec.rb"
+    - "**/*_factory.rb"
+    - "config/initializers/*.rb"
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Style/MultilineBlockChain:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "eat_your_vegetables Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2019-01-31
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'kramdown'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2019 Fredrik Eckardt
+
+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,75 @@
+# Eat Your Vegetables
+
+* [Email](mailto:cfeckardt@gmail.com)
+
+_NOTE THIS IS A WORK IN PROGRESS. DOCUMENTATION AND SOFTWARE IS INCOMPLETE_
+
+## Description
+Eat Your Vegetables is a tool that aims to help you improve your codebase over
+time. You configure the ambition that you want to set, that is, which files do
+you want to be covered by your test tools in an ideal world. Then, every time a
+commit is made into your code base, Eat Your Vegetables will ensure that your
+are one incremental step closer to that goal.
+
+Run Eat Your Vegetables in your CI server, as part of your test suite. On every
+test run it will then look at the previous state, count up the number of
+excluded files from your linter/test framework/coverage and _fail_ your tests if
+that number hasn't decreased.
+
+## Features
+Support for linters, coverage and test tools. For a full list of support tools
+see 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
+
+## Requirements
+
+A newish version of git must be installed on the CI server. Your CI server must
+be executing your environment with git available.
+
+## Install
+
+    $ gem install eat_your_vegetables
+
+## Running it
+
+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`
+
+## Configuration
+
+In the root of your project create a file named `Veggiefile`
+
+```ruby
+ambition do
+  include '/'
+end
+
+rubocop
+simplecov
+```
+
+### Setting up CI
+
+#### Gitlab
+
+#### Circle CI
+
+#### Other
+
+Please contribute by adding set up instructions for other CIs.
+
+## Contributing
+
+Nothing special here! Contributions are welcome!
+
+## Copyright
+
+Copyright (c) 2019 Fredrik Eckardt
+
+See {file:LICENSE.txt} for details.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rubygems'
+
+begin
+  require 'bundler/setup'
+rescue LoadError => e
+  abort e.message
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task test: :spec
+task default: :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new
+task doc: :yard

data/Veggiefile

@@ -0,0 +1,3 @@
+rubocop
+
+simplecov

data/bin/eat_your_vegetables

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'eat_your_vegetables'
+
+EatYourVegetables::Runner.new.run

data/eat_your_vegetables.gemspec

@@ -0,0 +1,39 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eat_your_vegetables/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'eat_your_vegetables'
+  gem.version       = EatYourVegetables::VERSION
+  gem.summary       = 'Eat Your Vegetables lets you incrementally improve code quality over time'
+  gem.description   = 'Use EYV to incrementally improve code quality in your project.
+Force your team to incrementally improve your code base with every commit to master.'
+  gem.license       = 'MIT'
+  gem.authors       = ['Fredrik Eckardt']
+  gem.email         = 'cfeckardt@gmail.com'
+  gem.homepage      = 'https://github.com/cfeckardt/eat_your_vegetables'
+
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+
+  `git submodule --quiet foreach --recursive pwd`.split($INPUT_RECORD_SEPARATOR).each do |submodule|
+    submodule.sub!("#{Dir.pwd}/", '')
+
+    Dir.chdir(submodule) do
+      `git ls-files`.split($INPUT_RECORD_SEPARATOR).map do |subpath|
+        gem.files << File.join(submodule, subpath)
+      end
+    end
+  end
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'rake', '~> 12.3.2'
+
+  gem.add_development_dependency 'bundler', '~> 1.10'
+  gem.add_development_dependency 'pry', '~> 0.12'
+  gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'rubocop', '~> 0.63'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+  gem.add_development_dependency 'yard', '~> 0.9.11'
+end

data/lib/eat_your_vegetables/ambition.rb

@@ -0,0 +1,11 @@
+module EatYourVegetables
+  class Ambition
+    def initialize
+      yield if block_given?
+    end
+
+    def include; end
+
+    def exclude; end
+  end
+end

data/lib/eat_your_vegetables/tools/base.rb

@@ -0,0 +1,59 @@
+require 'rake/file_list'
+require 'open3'
+
+module EatYourVegetables
+  module Tools
+    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_file_contents
+        cmdstr = "git show origin/master:#{config_file}"
+        stdout, stderr, status = Open3.capture3(cmdstr)
+
+        stdout
+      end
+
+      def current_file_contents
+        File.read(config_file)
+      end
+
+      def is_configed?
+        File.file?(config_file) && !parent_file_contents.empty?
+      rescue Errno::ENOENT
+        false
+      end
+
+      protected
+
+      def config_file
+        raise NotImplementedError
+      end
+
+      def excluded_files(_content)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/eat_your_vegetables/tools/rubocop.rb

@@ -0,0 +1,20 @@
+require 'yaml'
+require_relative 'base'
+
+module EatYourVegetables
+  module Tools
+    class Rubocop < Base
+      protected
+
+      def config_file
+        '.rubocop.yml'
+      end
+
+      def excluded_files(content)
+        yaml = YAML.load(content)
+
+        yaml['AllCops']['Exclude']
+      end
+    end
+  end
+end

data/lib/eat_your_vegetables/version.rb

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

data/lib/eat_your_vegetables.rb

@@ -0,0 +1,46 @@
+require 'eat_your_vegetables/version'
+require 'eat_your_vegetables/tools/rubocop'
+
+module EatYourVegetables
+  class Runner
+    def initialize
+      @tools = []
+    end
+
+    def run
+      veggies = File.read('Veggiefile')
+      instance_eval(veggies)
+
+      step_difference = @tools.reduce(0) do |acc, tool|
+        (acc + tool.step_difference)
+      end
+
+      if @tools.any? &:is_configed?
+        if step_difference == 0
+          puts "Sorry, I can't let you do that"
+          exit 1
+        else
+          puts "Thanks, for eating your veggies."
+          exit 0
+        end
+      else
+        puts 'It appears there are no vegetables to eat'
+        exit 0
+      end
+    end
+
+    def ambition
+      yield if block_given?
+    end
+
+    def rubocop
+      @tools << EatYourVegetables::Tools::Rubocop.new(parent_branch: 'master')
+    end
+
+    def simplecov; end
+
+    private
+
+    def step_difference; end
+  end
+end

data/spec/eat_your_vegetables_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'eat_your_vegetables'
+
+describe EatYourVegetables do
+  it 'should have a VERSION constant' do
+    expect(subject.const_get('VERSION')).to_not be_empty
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+require 'eat_your_vegetables/version'
+
+include EatYourVegetables

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: eat_your_vegetables
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Fredrik Eckardt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.63'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.63'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+description: |-
+  Use EYV to incrementally improve code quality in your project.
+  Force your team to incrementally improve your code base with every commit to master.
+email: cfeckardt@gmail.com
+executables:
+- eat_your_vegetables
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- Veggiefile
+- bin/eat_your_vegetables
+- 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/version.rb
+- spec/eat_your_vegetables_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/cfeckardt/eat_your_vegetables
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Eat Your Vegetables lets you incrementally improve code quality over time
+test_files:
+- spec/eat_your_vegetables_spec.rb
+- spec/spec_helper.rb