pronto-bigfiles 0.1.0

data/feature/pronto/big_files_cli_spec.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'pronto/bigfiles'
+require 'tmpdir'
+require 'open3'
+
+describe Pronto::BigFiles do
+  let(:env) do
+    {
+      # Avoid spurious deprecation warnings in things which are out of
+      # our control
+      'RUBYOPT' => '-W0',
+    }
+  end
+
+  describe 'bundle exec pronto list' do
+    it 'lists this as a runner' do
+      out, exit_code = Open3.capture2e(env, 'bundle exec pronto list')
+      expect(out).to include("bigfiles\n")
+      expect(exit_code).to eq(0)
+    end
+  end
+
+  describe 'bundle exec pronto run --staged -r bigfiles -f text' do
+    let(:pronto_command) do
+      'bundle exec pronto run --staged -r bigfiles -f text'
+    end
+
+    let(:results) { Open3.capture2e(env, pronto_command) }
+    let(:out) { results[0] }
+    let(:exit_code) { results[1] }
+
+    around do |example|
+      Dir.mktmpdir do |dir|
+        Dir.chdir(dir) do
+          system('git init')
+          system('git config user.email "you@example.com"')
+          system('git config user.name "Fake User"')
+          example_files_committed.each do |filename, contents|
+            File.write(filename, contents)
+          end
+          system('git add .')
+          system('git commit -m "First commit"')
+          example_files_staged.each do |filename, contents|
+            File.write(filename, contents)
+          end
+          system('git add .')
+          example.run
+        end
+      end
+    end
+
+    # Policy: We complain iff:
+    #
+    # a file is added to
+    # that is in the three complained about
+    # and the total ends up above 300
+    #
+    # ...and we only complain once per file
+    context 'when single file net added to ' \
+            'that is one of the three complained about, ' \
+            'and is above limit' do
+      let(:expected_output) do
+        "one_line_added_above_limit.rb:302 W: This file, one of the " \
+        "3 largest in the project, increased in size to 302 lines.  " \
+        "The total size of those files is now 502 lines (target: 300).  " \
+        "Is this file complex enough to refactor?\n"
+      end
+
+      let(:example_files_committed) do
+        {
+          'one_line_added_above_limit.rb' => ("\n" * 301),
+          'some_other_file_1.rb' => ("\n" * 100),
+          'some_other_file_2.rb' => ("\n" * 100),
+        }
+      end
+
+      let(:example_files_staged) do
+        { 'one_line_added_above_limit.rb' => ("\n" * 302) }
+      end
+
+      it 'complains on line of first change' do
+        expect(out).to eq(expected_output)
+        expect(exit_code).to eq(0)
+      end
+    end
+  end
+end

data/lib/pronto/bigfiles/message_creator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'pronto'
+
+module Pronto
+  # Performs incremental quality reporting for the bigfiles gem
+  class BigFiles < Runner
+    # Creates Pronto warning message objects
+    class MessageCreator
+      attr_reader :num_files, :total_lines, :target_num_lines
+
+      def initialize(num_files, total_lines, target_num_lines)
+        @num_files = num_files
+        @total_lines = total_lines
+        @target_num_lines = target_num_lines
+      end
+
+      def create_message(patch_wrapper, num_lines)
+        path = patch_wrapper.path
+        line = patch_wrapper.first_added_line
+        level = :warning
+        msg = "This file, one of the #{num_files} largest in the project, " \
+              "increased in size to #{num_lines} lines.  The total size " \
+              "of those files is now #{total_lines} lines " \
+              "(target: #{target_num_lines}).  Is this file complex " \
+              "enough to refactor?"
+        Message.new(path, line, level, msg)
+      end
+    end
+  end
+end

data/lib/pronto/bigfiles/patch_inspector.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'pronto'
+require_relative 'message_creator'
+
+module Pronto
+  # Performs incremental quality reporting for the bigfiles gem
+  class BigFiles < Runner
+    # Inspects patches and returns a Pronto::Message class when appropriate
+    class PatchInspector
+      def initialize(bigfiles_result,
+                     message_creator_class: MessageCreator,
+                     bigfiles_config:)
+        @message_creator_class = message_creator_class
+        @bigfiles_result = bigfiles_result
+        @bigfiles_config = bigfiles_config
+        @message_creator =
+          @message_creator_class.new(@bigfiles_config.num_files,
+                                     total_lines,
+                                     @bigfiles_config.high_water_mark)
+      end
+
+      def under_limit?
+        @bigfiles_config.under_limit?(total_lines)
+      end
+
+      def total_lines
+        @bigfiles_result.map(&:num_lines).reduce(:+)
+      end
+
+      def inspect_patch(patch_wrapper)
+        path = patch_wrapper.path
+        file_with_line = @bigfiles_result.find { |f| f.filename == path }
+
+        return if file_with_line.nil?
+
+        return unless patch_wrapper.added_to?
+
+        return if under_limit?
+
+        @message_creator.create_message(patch_wrapper, file_with_line.num_lines)
+      end
+    end
+  end
+end

data/lib/pronto/bigfiles/patch_wrapper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'pronto'
+
+module Pronto
+  class BigFiles < Runner
+    # Add convenience methods on top of Pronto::Git::Patch
+    class PatchWrapper
+      attr_reader :patch
+
+      def initialize(patch)
+        @patch = patch
+      end
+
+      def added_to?
+        (patch.additions - patch.deletions).positive?
+      end
+
+      def path
+        patch.delta.new_file[:path]
+      end
+
+      def first_added_line
+        patch.added_lines.first
+      end
+    end
+  end
+end

data/lib/pronto/bigfiles/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Pronto
+  module BigFilesVersion
+    VERSION = '0.1.0'
+  end
+end

data/lib/pronto/bigfiles.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'pronto/bigfiles/version'
+require 'pronto/bigfiles/patch_inspector'
+require 'pronto/bigfiles/patch_wrapper'
+require 'bigfiles/inspector'
+require 'bigfiles/config'
+require 'pronto'
+
+module Pronto
+  # Performs incremental quality reporting for the bigfiles gem
+  class BigFiles < Runner
+    def initialize(patches, commit = nil,
+                   bigfiles_config: ::BigFiles::Config.new,
+                   bigfiles_inspector: ::BigFiles::Inspector.new,
+                   bigfiles_results: bigfiles_inspector.find_and_analyze,
+                   patch_wrapper_class: PatchWrapper,
+                   patch_inspector: PatchInspector.new(bigfiles_results,
+                                                       bigfiles_config:
+                                                         bigfiles_config))
+      super(patches, commit)
+      @patch_inspector = patch_inspector
+      @patch_wrapper_class = patch_wrapper_class
+    end
+
+    class Error < StandardError; end
+    def run
+      @patches.flat_map { |patch| inspect_patch(patch) }
+    end
+
+    def inspect_patch(patch)
+      @patch_inspector.inspect_patch(@patch_wrapper_class.new(patch))
+    end
+  end
+end

data/metrics/bigfiles_high_water_mark

@@ -0,0 +1 @@
+300

data/metrics/brakeman_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/bundle-audit_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/cane_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/eslint_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/flake8_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/flay_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/flog_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/jscs_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/mdl_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/punchlist_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/pycodestyle_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/rails_best_practices_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/rubocop_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/scalastyle_high_water_mark

@@ -0,0 +1 @@
+0

data/metrics/shellcheck_high_water_mark

@@ -0,0 +1 @@
+0

data/pronto-bigfiles.gemspec

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative 'lib/pronto/bigfiles/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pronto-bigfiles'
+  spec.version       = Pronto::BigFilesVersion::VERSION
+  spec.authors       = ['Vince Broz']
+  spec.email         = ['vince@broz.cc']
+
+  spec.summary       = 'Pronto plugin for the bigfiles gem'
+  spec.description   = <<~DESCRIPTION
+    Performs incremental quality reporting for the bigfiles gem.
+    BigFiles is a simple tool to find the largest source files in your
+    project; this gem plugs in with the 'pronto' gem, which does
+    incremental reporting using a variety of quality tools.
+  DESCRIPTION
+  spec.homepage      = 'https://github.com/apiology/pronto-bigfiles'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] =
+    'https://github.com/apiology/pronto-bigfiles'
+
+  # Specify which files should be added to the gem when it is
+  # released.  The `git ls-files -z` loads the files in the RubyGem
+  # that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'bigfiles', '>=0.2.0'
+  spec.add_dependency 'pronto'
+  spec.add_dependency 'quality', '>= 37'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'pronto-punchlist'
+  spec.add_development_dependency 'pronto-rubocop'
+  spec.add_development_dependency 'quality', '~> 37'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+end

data/rakelib/ci.rake

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+desc 'Run tasks to be done during a continuous integration (CI) build'
+task ci: :localtest

data/rakelib/clear_metrics.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+desc 'Rebaseline quality thresholds to last commit'
+task :clear_metrics do |_t|
+  ret =
+    system('git checkout coverage/.last_run.json metrics/*_high_water_mark')
+  raise unless ret
+end

data/rakelib/default.rake

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+task default: :localtest

data/rakelib/feature.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'rspec/core/rake_task'
+
+desc 'Run features'
+RSpec::Core::RakeTask.new(:feature) do |task|
+  task.pattern = 'feature/**/*_spec.rb'
+  task.rspec_opts = '--format doc --default-path feature'
+end

data/rakelib/gem_tasks.rake

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

data/rakelib/localtest.rake

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+desc 'Standard build when running on a workstation'
+task localtest: %i[clear_metrics spec feature quality]

data/rakelib/pronto.rake

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+desc 'Look for incremental quality issues'
+task :pronto do
+  formatter = '-f github_pr' if ENV.key? 'PRONTO_GITHUB_ACCESS_TOKEN'
+  if ENV.key? 'TRAVIS_PULL_REQUEST'
+    ENV['PRONTO_PULL_REQUEST_ID'] = ENV['TRAVIS_PULL_REQUEST']
+  elsif ENV.key? 'CIRCLE_PULL_REQUEST'
+    ENV['PRONTO_PULL_REQUEST_ID'] = ENV['CIRCLE_PULL_REQUEST'].split('/').last
+  end
+  sh "pronto run #{formatter} -c origin/master --no-exit-code --unstaged "\
+     "|| true"
+  sh "pronto run #{formatter} -c origin/master --no-exit-code --staged || true"
+  sh "pronto run #{formatter} -c origin/master --no-exit-code || true"
+end

data/rakelib/quality.rake

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'quality/rake/task'
+
+Quality::Rake::Task.new do |task|
+  task.exclude_files = ['Gemfile.lock']
+  # cane deprecated in favor of rubocop, reek rarely actionable
+  task.skip_tools = %w[reek cane eslint jscs flake8]
+  task.output_dir = 'metrics'
+  task.punchlist_regexp = 'XX' \
+                          'X|TOD' \
+                          'O|FIXM' \
+                          'E|OPTIMIZ' \
+                          'E|HAC' \
+                          'K|REVIE' \
+                          'W|LATE' \
+                          'R|FIXI' \
+                          'T|xi' \
+                          't '
+end
+
+desc 'Static analysis and metrics enforcement'
+task quality: %i[pronto update_bundle_audit]

data/rakelib/spec.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'rspec/core/rake_task'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = 'spec/**/*_spec.rb'
+  task.rspec_opts = '--format doc'
+end

data/rakelib/update_bundle_audit.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+desc 'Update definitions used in bundle-audit'
+task :update_bundle_audit do
+  sh 'bundle-audit update'
+end