bigfiles 0.2.0 → 0.3.0

data/lib/bigfiles/config_file_parser.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module BigFiles
+  # Load configuration from files
+  class ConfigFileParser
+    attr_reader :project_config_filename
+
+    def initialize(project_config_filename = '.bigfiles.yml',
+                   yaml_class: YAML,
+                   file_class: File)
+      @project_config_filename = project_config_filename
+      @yaml_class = yaml_class
+      @file_class = file_class
+    end
+
+    def parse_config_files
+      config = {}
+      project_config = parse_project_config
+      config.merge(project_config)
+    end
+
+    private
+
+    def item(raw_project_config, section, key)
+      raw_project_config.fetch('bigfiles', {}).fetch(section, {}).fetch(key, nil)
+    end
+
+    def top_item(raw_project_config, key)
+      raw_project_config.fetch('bigfiles', {}).fetch(key, nil)
+    end
+
+    def parse_project_config
+      return {} unless @file_class.file? project_config_filename
+
+      project_config = {}
+      raw_project_config = @yaml_class.load_file(project_config_filename)
+      exclude = item(raw_project_config, 'exclude', 'glob')
+      project_config[:exclude] = exclude unless exclude.nil?
+      glob = item(raw_project_config, 'include', 'glob')
+      project_config[:glob] = glob unless glob.nil?
+      num_files = top_item(raw_project_config, 'num_files')
+      project_config[:num_files] = num_files unless num_files.nil?
+      project_config
+    end
+  end
+end

data/lib/bigfiles/inspector.rb

@@ -10,11 +10,11 @@ module BigFiles
     def initialize(config: Config.new,
                    source_file_globber: SourceFinder::SourceFileGlobber.new,
                    file_with_lines: FileWithLines,
-                   io: Kernel)
+                   io_class: Kernel)
       @config = config
       @source_file_globber = source_file_globber
       @file_with_lines = file_with_lines
-      @io = io
+      @io_class = io_class
     end
 
     def find_and_analyze
@@ -28,7 +28,7 @@ module BigFiles
 
     def find_analyze_and_report_on_files
       find_and_analyze.each do |file|
-        @io.puts "#{file.num_lines}: #{file.filename}"
+        @io_class.puts "#{file.num_lines}: #{file.filename}"
       end
     end
   end

data/lib/bigfiles/option_parser.rb

@@ -5,12 +5,11 @@ require_relative 'config'
 module BigFiles
   # Parse options passed to bigfiles command
   class OptionParser
-    def initialize(option_parser_class: ::OptionParser,
-                   io: Kernel,
-                   exiter: Kernel,
-                   source_finder_option_parser:)
+    def initialize(source_finder_option_parser:, option_parser_class: ::OptionParser,
+                   io_class: Kernel,
+                   exiter: Kernel)
       @option_parser_class = option_parser_class
-      @io = io
+      @io_class = io_class
       @exiter = exiter
       @source_finder_option_parser = source_finder_option_parser
     end
@@ -43,12 +42,11 @@ module BigFiles
         options = setup_options(opts)
         @option_parser = opts
       end.parse!(args)
-      Config.new(**options,
-                 source_finder_option_parser: @source_finder_option_parser)
+      options
     end
 
     def usage
-      @io.puts @option_parser
+      @io_class.puts @option_parser
       @exiter.exit(1)
     end
   end

data/lib/bigfiles/version.rb

@@ -2,5 +2,5 @@
 
 # Tool to find the largest source files in your project
 module BigFiles
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/bigfiles.rb

@@ -2,9 +2,12 @@
 
 require 'optparse'
 
-require_relative 'bigfiles/file_with_lines'
-require_relative 'bigfiles/option_parser'
-require_relative 'bigfiles/inspector'
+require 'bigfiles/file_with_lines'
+require 'bigfiles/config_file_parser'
+require 'bigfiles/option_parser'
+require 'bigfiles/config'
+require 'bigfiles/inspector'
+require 'bigfiles/version'
 require 'source_finder/source_file_globber'
 require 'source_finder/option_parser'
 
@@ -13,27 +16,32 @@ module BigFiles
   # Simple tool to find the largest source files in your project.
   class BigFiles
     def initialize(args,
-                   io: Kernel,
+                   io_class: Kernel,
                    exiter: Kernel,
                    file_with_lines: FileWithLines,
                    source_file_globber: SourceFinder::SourceFileGlobber.new,
                    inspector_class: Inspector,
                    option_parser_class: ::OptionParser,
                    source_finder_option_parser: SourceFinder::OptionParser.new,
+                   yaml_class: YAML,
                    bigfiles_option_parser:
                      ::BigFiles::OptionParser
                        .new(option_parser_class: option_parser_class,
-                            io: io,
+                            io_class: io_class,
                             exiter: exiter,
                             source_finder_option_parser:
                               source_finder_option_parser),
-                   config: bigfiles_option_parser.parse_options(args))
+                   config_file_parser: ::BigFiles::ConfigFileParser.new(yaml_class: yaml_class),
+                   raw_config: config_file_parser.parse_config_files
+                     .merge(bigfiles_option_parser.parse_options(args)),
+                   config: Config.new(**raw_config))
+
       @bigfiles_option_parser = bigfiles_option_parser
       @config = config
       @inspector = inspector_class.new(source_file_globber: source_file_globber,
                                        config: config,
                                        file_with_lines: file_with_lines,
-                                       io: io)
+                                       io_class: io_class)
     end
 
     def run

data/rakelib/citest.rake

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+desc 'Run tasks to be done during a continuous integration (CI) build'
+task citest: %i[clear_metrics spec feature undercover]

data/rakelib/clear_metrics.rake

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+desc 'Ensure that any locally ratcheted coverage metrics are cleared back ' \
+     'to git baseline'
+task :clear_metrics do |_t|
+  ret =
+    system('git checkout coverage/.last_run.json')
+  raise unless ret
+
+  # Without this old lines which are removed are still counted,
+  # leading to inconsistent coverage percentages between runs.
+  #
+  # need to save coverage/.last_run.json
+  ret =
+    system('rm -fr coverage/assets coverage/.*.json.lock coverage/lcov/* coverage/index.html coverage/.resultset.json')
+  raise unless ret
+end

data/rakelib/console.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+desc 'Load up bigfiles in pry'
+task :console do |_t|
+  exec 'pry -I lib -r bigfiles'
+end

data/rakelib/default.rake

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+desc 'Standard build'
+task default: :localtest

data/rakelib/feature.rake

@@ -0,0 +1,10 @@
+# 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 ' \
+                    '--require feature_helper'
+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 undercover quality]

data/rakelib/overcommit.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+desc 'Run overcommit on current code'
+task :overcommit do
+  sh 'overcommit --run'
+end

data/rakelib/quality.rake

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+desc 'Run quality checks'
+task quality: :overcommit

data/rakelib/repl.rake

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+desc 'Load up bigfiles in pry'
+task repl: [:console]

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 --require spec_helper'
+end

data/rakelib/undercover.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+desc 'Ensure PR changes are fully covered by tests'
+task :undercover do |_t|
+  ret =
+    system('undercover --compare origin/main')
+  raise unless ret
+end

data/requirements_dev.txt

@@ -0,0 +1,2 @@
+pip==21.1
+yamllint==1.26.0

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: bigfiles
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Vince Broz
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2020-01-03 00:00:00.000000000 Z
+date: 2022-07-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: high_water_mark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: source_finder
   requirement: !ruby/object:Gem::Requirement
@@ -25,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pronto
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pronto-punchlist
+  name: mdl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +81,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pronto-rubocop
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.58.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.58.0
+- !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,21 +109,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: quality
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '37'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '37'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +151,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -124,6 +180,20 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -136,8 +206,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: bigfiles finds the largest source files in your project and reports on
-  them
+- !ruby/object:Gem::Dependency
+  name: undercover
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
 email:
 - vince@broz.cc
 executables:
@@ -145,22 +228,88 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
+- ".envrc"
+- ".git-hooks/pre_commit/circle_ci.rb"
+- ".gitattributes"
+- ".gitignore"
+- ".markdownlint_style.rb"
+- ".mdlrc"
+- ".overcommit.yml"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".yamllint.yml"
 - CODE_OF_CONDUCT.md
-- License.txt
+- CONTRIBUTING.rst
+- DEVELOPMENT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Makefile
 - README.md
+- Rakefile
 - bigfiles.gemspec
 - bin/bigfiles
+- bin/bump
+- bin/overcommit
+- bin/rake
+- coverage/.last_run.json
+- docs/cookiecutter_input.json
+- exe/bigfiles
+- feature/big_files_cli_spec.rb
+- feature/expected/four_files_results.txt
+- feature/expected/no_files_results.txt
+- feature/expected/swift_and_ruby_files_results.txt
+- feature/expected/swift_zorb_and_ruby_files_excluded_results.txt
+- feature/expected/swift_zorb_and_ruby_files_results.txt
+- feature/expected/three_files_results.txt
+- feature/feature_helper.rb
+- feature/pronto_big_files_use_spec.rb
+- feature/samples/four_files/five_lines.rb
+- feature/samples/four_files/four_lines.rb
+- feature/samples/four_files/three_lines.rb
+- feature/samples/four_files/two_lines.rb
+- feature/samples/no_files/.keepme
+- feature/samples/swift_and_ruby_files/five_lines.swift
+- feature/samples/swift_and_ruby_files/four_lines.rb
+- feature/samples/swift_and_ruby_files/three_lines.rb
+- feature/samples/swift_zorb_and_ruby_files/five_lines.swift
+- feature/samples/swift_zorb_and_ruby_files/four_lines.zorb
+- feature/samples/swift_zorb_and_ruby_files/three_lines.rb
+- feature/samples/swift_zorb_and_ruby_files_excluded/excluded.rb
+- feature/samples/swift_zorb_and_ruby_files_excluded/five_lines.swift
+- feature/samples/swift_zorb_and_ruby_files_excluded/four_lines.zorb
+- feature/samples/swift_zorb_and_ruby_files_excluded/three_lines.rb
+- feature/samples/three_files/five_lines.rb
+- feature/samples/three_files/four_lines.rb
+- feature/samples/three_files/three_lines.rb
+- fix.sh
 - lib/bigfiles.rb
 - lib/bigfiles/config.rb
+- lib/bigfiles/config_file_parser.rb
 - lib/bigfiles/file_with_lines.rb
 - lib/bigfiles/inspector.rb
 - lib/bigfiles/option_parser.rb
 - lib/bigfiles/version.rb
-homepage: http://github.com/apiology/bigfiles
+- rakelib/citest.rake
+- rakelib/clear_metrics.rake
+- rakelib/console.rake
+- rakelib/default.rake
+- rakelib/feature.rake
+- rakelib/gem_tasks.rake
+- rakelib/localtest.rake
+- rakelib/overcommit.rake
+- rakelib/quality.rake
+- rakelib/repl.rake
+- rakelib/spec.rake
+- rakelib/undercover.rake
+- requirements_dev.txt
+homepage: https://github.com/apiology/bigfiles
 licenses:
-- MIT
-metadata: {}
-post_install_message: 
+- MIT license
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -168,16 +317,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.4
-signing_key: 
+rubygems_version: 3.0.3.1
+signing_key:
 specification_version: 4
 summary: Finds largest source files in a project
 test_files: []

data/License.txt

@@ -1,20 +0,0 @@
-Copyright (c) 2013 Vincent Broz
-
-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.