bigfiles 0.2.0 → 0.3.0

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

@@ -0,0 +1,31 @@
+# Development
+
+## fix.sh
+
+If you want to use rbenv/pyenv/etc to manage versions of tools,
+there's a `fix.sh` script which may be what you'd like to install
+dependencies.
+
+## Overcommit
+
+This project uses [overcommit](https://github.com/sds/overcommit) for
+quality checks.  `bundle exec overcommit --install` will install it.
+
+## direnv
+
+This project uses direnv to manage environment variables used during
+development.  See the `.envrc` file for detail.
+
+## Publishing
+
+To publish new version as a maintainer:
+
+```sh
+git checkout main && git pull
+git log "v$(bump current)..."
+# Set type_of_bump to patch, minor, or major
+bump --tag --tag-prefix=v ${type_of_bump:?}
+rake release
+git push
+git push --tags
+```

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bigfiles.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,133 @@
+PATH
+  remote: .
+  specs:
+    bigfiles (0.3.0)
+      high_water_mark
+      source_finder (>= 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    bump (0.10.0)
+    chef-utils (17.10.0)
+      concurrent-ruby
+    childprocess (4.1.0)
+    coderay (1.1.3)
+    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)
+    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.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry (0.14.1-java)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+      spoon (~> 0.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    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.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.31.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.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.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.12.1)
+      rubocop (~> 1.31)
+    ruby-progressbar (1.11.0)
+    rugged (1.2.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov-lcov (0.8.0)
+    simplecov_json_formatter (0.1.3)
+    source_finder (3.2.1)
+    spoon (0.0.6)
+      ffi
+    tomlrb (2.0.3)
+    undercover (0.4.4)
+      imagen (>= 0.1.8)
+      rainbow (>= 2.1, < 4.0)
+      rugged (>= 0.27, < 1.3)
+    unicode-display_width (2.2.0)
+
+PLATFORMS
+  java
+  ruby
+  x86_64-darwin-19
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  bigfiles!
+  bump
+  bundler
+  mdl
+  overcommit (>= 0.58.0)
+  pry
+  rake (~> 13.0)
+  rspec (>= 3.4)
+  rubocop
+  rubocop-rake
+  rubocop-rspec
+  simplecov (>= 0.18.0)
+  simplecov-lcov
+  undercover
+
+BUNDLED WITH
+   2.2.25

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+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
+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/Makefile

@@ -0,0 +1,75 @@
+.PHONY: clean test help quality localtest spec feature
+.DEFAULT_GOAL := default
+
+define PRINT_HELP_PYSCRIPT
+import re, sys
+
+for line in sys.stdin:
+	match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
+	if match:
+		target, help = match.groups()
+		print("%-20s %s" % (target, help))
+endef
+export PRINT_HELP_PYSCRIPT
+
+help:
+	@python -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
+
+default: localtest ## run default tests and quality
+
+requirements_dev.txt.installed: requirements_dev.txt
+	pip install -q --disable-pip-version-check -r requirements_dev.txt
+	touch requirements_dev.txt.installed
+
+pip_install: requirements_dev.txt.installed ## Install Python dependencies
+
+# bundle install doesn't get run here so that we can catch it below in
+# fresh-checkout and fresh-rbenv cases
+Gemfile.lock: Gemfile
+
+# Ensure any Gemfile.lock changes ensure a bundle is installed.
+Gemfile.lock.installed: Gemfile.lock
+	bundle install
+	touch Gemfile.lock.installed
+
+bundle_install: Gemfile.lock.installed ## Install Ruby dependencies
+
+clear_metrics: ## remove or reset result artifacts created by tests and quality tools
+	bundle exec rake clear_metrics
+
+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
+
+quality: overcommit ## run precommit quality checks
+
+spec: ## Run lower-level tests
+	@bundle exec rake spec
+
+feature: ## Run higher-level tests
+	@bundle exec rake feature
+
+localtest: ## run default local actions
+	@bundle exec rake localtest
+
+repl:  ## Load up bigfiles in pry
+	@bundle exec rake repl
+
+update_from_cookiecutter: ## Bring in changes from template project used to create this repo
+	bundle exec overcommit --uninstall
+	IN_COOKIECUTTER_PROJECT_UPGRADER=1 cookiecutter_project_upgrader || true
+	git checkout cookiecutter-template && git push && git checkout main
+	git checkout main && git pull && git checkout -b update-from-cookiecutter-$$(date +%Y-%m-%d-%H%M)
+	git merge cookiecutter-template || true
+	bundle exec overcommit --install
+	@echo
+	@echo "Please resolve any merge conflicts below and push up a PR with:"
+	@echo
+	@echo '   gh pr create --title "Update from cookiecutter" --body "Automated PR to update from cookiecutter boilerplate"'
+	@echo
+	@echo

data/README.md

@@ -1,6 +1,7 @@
 # BigFiles
 
-[![Build Status](https://travis-ci.org/apiology/bigfiles.svg?branch=master)](https://travis-ci.org/apiology/bigfiles)
+[![CircleCI](https://circleci.com/gh/apiology/bigfiles.svg?style=svg)](https://circleci.com/gh/apiology/bigfiles)
+
 
 Simple tool to find the largest source files in your project - maybe
 to target for refactoring!
@@ -39,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
@@ -56,4 +85,16 @@ 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/master/CODE_OF_CONDUCT.md).
+[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/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+# Add your own tasks in files placed in rakelib/ ending in .rake,
+# for example rakelib/capistrano.rake, and they will automatically be available to Rake.

data/bigfiles.gemspec

@@ -1,38 +1,50 @@
-# ; -*-Ruby-*-
+# coding: ascii
 # frozen_string_literal: true
 
-$LOAD_PATH.push File.join(File.dirname(__FILE__), 'lib')
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'bigfiles/version'
 
-Gem::Specification.new do |s|
-  s.name = 'bigfiles'
-  s.version = BigFiles::VERSION
+Gem::Specification.new do |spec|
+  spec.name          = 'bigfiles'
+  spec.version       = BigFiles::VERSION
+  spec.authors       = ['Vince Broz']
+  spec.email         = ['vince@broz.cc']
+  spec.summary       = 'Finds largest source files in a project'
+  spec.homepage      = 'https://github.com/apiology/bigfiles'
+  spec.license       = 'MIT license'
+  spec.required_ruby_version = '>= 2.6'
 
-  s.authors = ['Vince Broz']
-  s.description = 'bigfiles finds the largest source files in your project ' \
-                  'and reports on them'
-  s.email = ['vince@broz.cc']
-  s.executables = ['bigfiles']
-  # s.extra_rdoc_files = ["CHANGELOG", "License.txt"]
-  s.license = 'MIT'
-  s.files = Dir['CODE_OF_CONDUCT.md', 'License.txt', 'README.md',
-                '{lib}/bigfiles.rb',
-                '{lib}/bigfiles/**/*.rb',
-                'bigfiles.gemspec']
-  # s.rdoc_options = ["--main", "README.md"]
-  s.require_paths = ['lib']
-  s.homepage = 'http://github.com/apiology/bigfiles'
-  # s.rubyforge_project = %q{bigfiles}
-  s.rubygems_version = '1.3.6'
-  s.summary = 'Finds largest source files in a project'
+  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']
 
-  s.add_dependency('source_finder', ['>=2'])
-  s.add_development_dependency('bundler')
-  s.add_development_dependency('pronto')
-  s.add_development_dependency('pronto-punchlist')
-  s.add_development_dependency('pronto-rubocop')
-  s.add_development_dependency('quality', '~> 37')
-  s.add_development_dependency('rake')
-  s.add_development_dependency('rspec')
-  s.add_development_dependency('simplecov')
+  spec.add_dependency('high_water_mark')
+  spec.add_dependency('source_finder', ['>=2'])
+
+  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...
+  spec.add_development_dependency 'overcommit', ['>=0.58.0']
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '>=3.4'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
+  # ensure version with branch coverage
+  spec.add_development_dependency 'simplecov', ['>=0.18.0']
+  spec.add_development_dependency 'simplecov-lcov'
+  spec.add_development_dependency 'undercover'
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true',
+  }
 end

data/bin/bigfiles

@@ -1,6 +1,29 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative '../lib/bigfiles'
+#
+# This file was generated by Bundler.
+#
+# The application 'bigfiles' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
 
-BigFiles::BigFiles.new(ARGV).run
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("bigfiles", "bigfiles")

data/bin/bump

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'bump' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("bump", "bump")

data/bin/overcommit

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'overcommit' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("overcommit", "overcommit")

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/coverage/.last_run.json

@@ -0,0 +1,6 @@
+{
+  "result": {
+    "line": 100.0,
+    "branch": 100.0
+  }
+}

data/docs/cookiecutter_input.json

@@ -0,0 +1,13 @@
+{
+    "_template": "https://github.com/apiology/cookiecutter-gem",
+    "email": "vince@broz.cc",
+    "full_name": "Vince Broz",
+    "github_username": "apiology",
+    "module_name": "BigFiles",
+    "open_source_license": "MIT license",
+    "project_name": "BigFiles",
+    "project_short_description": "Simple tool to find the largest source files in your project.",
+    "project_slug": "bigfiles",
+    "type_of_github_repo": "public",
+    "version": "0.1.0"
+}

data/exe/bigfiles

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/bigfiles'
+
+BigFiles::BigFiles.new(ARGV).run