punchlist 1.2.0 → 1.3.1

data/metrics/scalastyle_high_water_mark

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

data/metrics/shellcheck_high_water_mark

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

data/package.json

@@ -0,0 +1,9 @@
+{
+  "remarkConfig": {
+    "settings": {
+      "bullet": "*",
+      "listItemIndent": "one"
+    },
+    "plugins": []
+  }
+}

data/punchlist.gemspec

@@ -1,36 +1,33 @@
-# ; -*-Ruby-*-
-# -*- encoding: utf-8 -*-
-$LOAD_PATH.push File.join(File.dirname(__FILE__), 'lib')
+# coding: ascii
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'punchlist/version'
 
-Gem::Specification.new do |s|
-  s.name = 'punchlist'
-  s.version = Punchlist::VERSION
+Gem::Specification.new do |spec|
+  spec.name          = 'punchlist'
+  spec.version       = Punchlist::VERSION
+  spec.authors       = ["Vince Broz"]
+  spec.email         = ['vince@broz.cc']
+  spec.summary       = "Counts the number of 'todo' comments in your code"
+  spec.homepage      = 'https://github.com/apiology/punchlist'
+  spec.license       = 'MIT license'
+  spec.required_ruby_version = '>= 3.0'
 
-  s.authors = ['Vince Broz']
-  s.description =
-    "punchlist lists your annotation comments--things like 'LATER/HACK/FIXIT'"
-  s.email = ['vince@broz.cc']
-  s.executables = ['punchlist']
-  # s.extra_rdoc_files = ["CHANGELOG", "License.txt"]
-  s.license = 'MIT'
-  s.files = Dir['License.txt', 'README.md',
-                'Rakefile',
-                'bin/punchlist',
-                '{lib}/**/*',
-                'punchlist.gemspec'] & `git ls-files -z`.split("\0")
-  # s.rdoc_options = ["--main", "README.md"]
-  s.require_paths = ['lib']
-  s.homepage = 'http://github.com/apiology/punchlist'
-  # s.rubyforge_project = %q{punchlist}
-  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'])
+  spec.add_dependency('source_finder', ['>=2'])
+  # spec.add_runtime_dependency 'activesupport'
 
-  s.add_development_dependency('bundler')
-  s.add_development_dependency('rake')
-  s.add_development_dependency('quality', ['>=16'])
-  s.add_development_dependency('rspec')
-  s.add_development_dependency('simplecov')
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true',
+  }
 end

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,9 @@
+# frozen_string_literal: true
+
+desc 'Ensure that any locally ratcheted coverage metrics are cleared back ' \
+     'to git baseline'
+task :clear_metrics do |_t|
+  # Without this old lines which are removed are still counted,
+  # leading to inconsistent coverage percentages between runs.
+  raise unless system('rm -fr coverage/')
+end

data/rakelib/console.rake

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

data/rakelib/default.rake

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

data/rakelib/doc.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+desc 'Push documentation updates to Dropbox'
+task :doc do
+  sh 'yard -p yard_templates -o docs/ --no-private'
+end

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 punchlist 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('if git branch -r | grep origin/main; then undercover --compare origin/main; fi')
+  raise unless ret
+end

data/requirements_dev.txt

@@ -0,0 +1,2 @@
+pip==23.3.1
+yamllint==1.35.1

metadata

@@ -1,136 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: punchlist
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Vince Broz
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2015-09-13 00:00:00.000000000 Z
+date: 2024-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: source_finder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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: 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: quality
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '16'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  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: simplecov
-  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: punchlist lists your annotation comments--things like 'LATER/HACK/FIXIT'
+description:
 email:
 - vince@broz.cc
-executables:
-- punchlist
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- License.txt
+- ".circleci/config.yml"
+- ".envrc"
+- ".git-hooks/pre_commit/circle_ci.rb"
+- ".git-hooks/pre_commit/punchlist.rb"
+- ".git-hooks/pre_commit/solargraph_typecheck.rb"
+- ".gitattributes"
+- ".gitignore"
+- ".markdownlint_style.rb"
+- ".mdlrc"
+- ".overcommit.yml"
+- ".pronto.yml"
+- ".rubocop.yml"
+- ".solargraph.yml"
+- ".yamllint.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.rst
+- ChangeLog.md
+- DEVELOPMENT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Makefile
+- README.md
 - Rakefile
+- bin/bump
+- bin/overcommit
 - bin/punchlist
+- bin/rake
+- bin/rubocop
+- bin/solargraph
+- bin/yard
+- config/env.1p
+- docs/.gitignore
+- docs/cookiecutter_input.json
+- feature/expected/mixed_types_of_source_files_results.txt
+- feature/expected/no_files_results.txt
+- feature/expected/non_source_file_with_pis_results.txt
+- feature/expected/one_source_file_with_cis_results.txt
+- feature/expected/scala_file_to_be_ignored_results.txt
+- feature/expected/source_file_with_no_items_results.txt
+- feature/feature_helper.rb
+- feature/pronto_punchlist_use_spec.rb
+- feature/punchlist_cli_spec.rb
+- feature/samples/mixed_types_of_source_files/lib/bar.scala
+- feature/samples/mixed_types_of_source_files/lib/foo.rb
+- feature/samples/no_files/.ignore
+- feature/samples/non_source_file_with_pis/foo.doc
+- feature/samples/one_source_file_with_cis/app/foo.rb
+- feature/samples/scala_file_to_be_ignored/lib/bar.scala
+- feature/samples/scala_file_to_be_ignored/lib/foo.rb
+- feature/samples/source_file_with_no_items/foo.rb
+- fix.sh
 - lib/punchlist.rb
-- lib/punchlist/options.rb
+- lib/punchlist/config.rb
+- lib/punchlist/inspector.rb
+- lib/punchlist/offense.rb
+- lib/punchlist/option_parser.rb
+- lib/punchlist/renderer.rb
 - lib/punchlist/version.rb
+- metrics/brakeman_high_water_mark
+- metrics/flake8_high_water_mark
+- metrics/jscs_high_water_mark
+- metrics/punchlist_high_water_mark
+- metrics/pycodestyle_high_water_mark
+- metrics/rails_best_practices_high_water_mark
+- metrics/scalastyle_high_water_mark
+- metrics/shellcheck_high_water_mark
+- package.json
 - punchlist.gemspec
-homepage: http://github.com/apiology/punchlist
+- rakelib/citest.rake
+- rakelib/clear_metrics.rake
+- rakelib/console.rake
+- rakelib/default.rake
+- rakelib/doc.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/punchlist
 licenses:
-- MIT
-metadata: {}
-post_install_message: 
+- MIT license
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
-summary: Finds largest source files in a project
+summary: Counts the number of 'todo' comments in your code
 test_files: []

data/License.txt

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