bigfiles 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0caad8f9e5834f2cc41fb3cae5173e95b1b90fc9195cc131fd5f133ee3656bb
-  data.tar.gz: 3702722ad9c05ffe9700eafc0d6625f50b60a78138b035ce0efb2c7f19e0b94d
+  metadata.gz: c625f268823284a5c9058cd51515ef8127f8ef58c61ad1e4c6c01f79bc89d9a9
+  data.tar.gz: 4938c301bb8d5c9064e797b4a92495a422a90a5c58c32bc2fc03103703e3a694
 SHA512:
-  metadata.gz: ee1c3c9f1b3a203673d0866e3c540d9161f05f4f11158d7c18705265666eb82229cecf06fb2f7f0c91dc03de96d643a384ba95fcbdbe5b7f3b69b7e1ebfebecf
-  data.tar.gz: 7543754c3642a29ee01c7e692624295d1e6eedf67ec275ba73042c0f97ece8c5fe41e407bc653289dc3dc387fe03ae2516105f3672b44063c6da91252b350429
+  metadata.gz: '08cc96dc7153ffbc18623d2deea513d39ff0df1c67d16fddaa62c81406bafd68c9e05bf9f416a54c87580d865fa3f3214088afb83106edf92e410b7a27ba525d'
+  data.tar.gz: b9415c5f66f9e8120425aea6a730c8e89b529e9bd3eebbc7e6a77ebfaff06f003e867ad9866c4fff5d700595c6dcde51abf2bee63230e977f81baa35e2308bb0

data/.markdownlint_style.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+rule 'MD029', style: 'ordered'

data/.mdlrc

@@ -0,0 +1 @@
+style ".markdownlint_style.rb"

data/CONTRIBUTING.rst

@@ -0,0 +1,75 @@
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/apiology/bigfiles/issues
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug"
+and "help wanted" is open to whoever wants to implement a fix for it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+If you have a new feature in mind, please start it by filing an issue
+so we can discuss the need and approach before you invest time into
+coding it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+BigFiles could always use more documentation, whether as part of
+the official BigFiles docs, in docstrings, or even on the web in blog posts, articles,
+and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at
+https://github.com/apiology/bigfiles/issues.
+
+If you are proposing a new feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute?  See DEVELOPMENT.md in this directory for details
+on how to set yourself up for local development.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+
+2. If the pull request adds functionality, the docs should be updated. Put your
+   new functionality into a function with a docstring, and add the feature to
+   the list in README.md.

data/DEVELOPMENT.md

@@ -27,4 +27,5 @@ git log "v$(bump current)..."
 bump --tag --tag-prefix=v ${type_of_bump:?}
 rake release
 git push
+git push --tags
 ```

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bigfiles (0.2.2)
+    bigfiles (0.3.0)
       high_water_mark
       source_finder (>= 2)
 
@@ -10,22 +10,42 @@ GEM
   specs:
     ast (2.4.2)
     bump (0.10.0)
+    chef-utils (17.10.0)
+      concurrent-ruby
     childprocess (4.1.0)
     coderay (1.1.3)
-    diff-lcs (1.4.4)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
     docile (1.4.0)
     ffi (1.15.4-java)
     high_water_mark (0.1.0)
     imagen (0.1.8)
       parser (>= 2.5, != 2.5.1.1)
     iniparse (1.5.0)
+    json (2.6.2)
+    json (2.6.2-java)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    mdl (0.11.0)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      mixlib-cli (~> 2.1, >= 2.1.1)
+      mixlib-config (>= 2.2.1, < 4)
+      mixlib-shellout
     method_source (1.0.0)
-    overcommit (0.58.0)
+    mixlib-cli (2.1.8)
+    mixlib-config (3.0.27)
+      tomlrb
+    mixlib-shellout (3.2.7)
+      chef-utils
+    overcommit (0.59.1)
       childprocess (>= 0.6.3, < 5)
       iniparse (~> 1.4)
       rexml (~> 3.2)
-    parallel (1.21.0)
-    parser (3.0.2.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
@@ -34,40 +54,41 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
       spoon (~> 0.0)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.1.1)
+    regexp_parser (2.5.0)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rubocop (1.23.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.31.2)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.13.0)
-      parser (>= 3.0.1.1)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.6.0)
-      rubocop (~> 1.19)
+    rubocop-rspec (2.12.1)
+      rubocop (~> 1.31)
     ruby-progressbar (1.11.0)
-    rugged (1.1.1)
+    rugged (1.2.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -78,11 +99,12 @@ GEM
     source_finder (3.2.1)
     spoon (0.0.6)
       ffi
-    undercover (0.4.3)
+    tomlrb (2.0.3)
+    undercover (0.4.4)
       imagen (>= 0.1.8)
       rainbow (>= 2.1, < 4.0)
-      rugged (>= 0.27, < 1.2)
-    unicode-display_width (2.1.0)
+      rugged (>= 0.27, < 1.3)
+    unicode-display_width (2.2.0)
 
 PLATFORMS
   java
@@ -95,6 +117,7 @@ DEPENDENCIES
   bigfiles!
   bump
   bundler
+  mdl
   overcommit (>= 0.58.0)
   pry
   rake (~> 13.0)

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2013-2021, Vince Broz
+Copyright (c) 2013-2022, Vince 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

data/Makefile

@@ -41,6 +41,8 @@ clean: clear_metrics ## remove all built artifacts
 
 test: spec ## run tests quickly
 
+typecheck: ## validate types in code and configuration
+
 overcommit: ## run precommit quality checks
 	bundle exec overcommit --run
 

data/README.md

@@ -40,6 +40,34 @@ $ bigfiles
 $
 ```
 
+## Options
+
+You can control what files are included and excluded, and how many files are reported:
+
+```sh
+$ bigfiles --help
+Usage: bigfiles [options]
+    -g, --glob glob here             Which files to parse - default is {Dockerfile,Rakefile,{*,.*}.{c,clj,cljs,cpp,gemspec,groovy,html,java,js,json,py,rake,rb,scala,sh,swift,yml},{app,config,db,feature,lib,spec,src,test,tests,vars,www}/**/{*,.*}.{c,clj,cljs,cpp,gemspec,groovy,html,java,js,json,py,rake,rb,scala,sh,swift,yml}}
+    -e, --exclude-glob glob here     Files to exclude - default is none
+    -h, --help                       This message
+    -n, --num-files number-here      Top number of files to show--default 3
+$
+```
+
+## Configuration
+
+You can set different defaults for the above in a `.bigfiles.yml` in the current directory:
+
+```yaml
+---
+bigfiles:
+  num_files: 8
+  include:
+    glob: '**/*.my-favorite-extension'
+  exclude:
+    glob: fix.sh
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on
@@ -58,3 +86,15 @@ The gem is available as open source under the terms of the
 Everyone interacting in the Pronto::Punchlist project’s codebases,
 issue trackers, chat rooms and mailing lists is expected to follow the
 [code of conduct](https://github.com/apiology/bigfiles/blob/main/CODE_OF_CONDUCT.md).
+
+## Contributions
+
+This project, as with all others, rests on the shoulders of a broad
+ecosystem supported by many volunteers doing thankless work, along
+with specific contributors.
+
+In particular I'd like to call out:
+
+* [Audrey Roy Greenfeld](https://github.com/audreyfeldroy) for the
+  cookiecutter tool and associated examples, which keep my many
+  projects building with shared boilerplate with a minimum of fuss.

data/bigfiles.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bump'
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'mdl'
   # 0.58.0 and 0.57.0 don't seem super compatible with signatures, and
   # magit doesn't seem to want to use the bundled version at the moment,
   # so let's favor the more recent version...

data/fix.sh

@@ -284,12 +284,7 @@ ensure_python_versions() {
       }
 
       major_minor="$(cut -d. -f1-2 <<<"${ver}")"
-      if [ "${major_minor}" == 3.6 ]
-      then
-        pyenv_install --patch "${ver}" < <(curl -sSL https://github.com/python/cpython/commit/8ea6353.patch\?full_index=1)
-      else
-        pyenv_install "${ver}"
-      fi
+      pyenv_install "${ver}"
     else
       pyenv install -s "${ver}"
     fi
@@ -307,12 +302,12 @@ ensure_pyenv_virtualenvs() {
 }
 
 ensure_pip_and_wheel() {
-  # Make sure we have a pip with the 20.3 resolver, and after the
-  # initial bugfix release
+  # pip 22 seems to be better at finding pandas pre-compiled wheels
+  # for macOS, so let's make sure we're using at least that version
   major_pip_version=$(pip --version | cut -d' ' -f2 | cut -d '.' -f 1)
   if [[ major_pip_version -lt 21 ]]
   then
-    pip install 'pip>=20.3.1'
+    pip install 'pip>=22'
   fi
   # wheel is helpful for being able to cache long package builds
   pip show wheel >/dev/null 2>&1 || pip install wheel

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/option_parser.rb

@@ -42,8 +42,7 @@ 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

data/lib/bigfiles/version.rb

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

data/lib/bigfiles.rb

@@ -3,7 +3,9 @@
 require 'optparse'
 
 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'
@@ -21,6 +23,7 @@ module BigFiles
                    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,
@@ -28,7 +31,11 @@ module BigFiles
                             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,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bigfiles
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Vince Broz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-17 00:00:00.000000000 Z
+date: 2022-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: high_water_mark
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mdl
+  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: overcommit
   requirement: !ruby/object:Gem::Requirement
@@ -219,11 +233,14 @@ files:
 - ".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
+- CONTRIBUTING.rst
 - DEVELOPMENT.md
 - Gemfile
 - Gemfile.lock
@@ -269,6 +286,7 @@ files:
 - 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