glyptodont 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cfa9e6366161885c86dbe07e79c0c14d57a58bbdf8c7e69d3683b6d96838dfe
-  data.tar.gz: d71c6335cd02094e9bbabc72701c21e7cb6001617a2eddbb5884f68d496dff43
+  metadata.gz: 2da8dbfba96ec9503e38905a40127830fd2418ed24f047547c67d86dd11f3b56
+  data.tar.gz: cf21cce8ec2f2ba666217176318d6eda32598228a8d6cd5bf68106dfc411de2f
 SHA512:
-  metadata.gz: 994f96b328e5beef3093bb344ec53f362c3fa2255da24338343069b9511fafd0be2999ecd8a5e60a43bb55966e8e155061ef43a1b0dca5acdf180b7f857bffa5
-  data.tar.gz: 1e8200f3b8cce054163ba12d9e31a87267f12ea3c0796cb47809c7abf5d66f7603cd0fefb59cc6cfca1e7ffd5b2a533a0e080be15012b9223a081af8517ca2f7
+  metadata.gz: 05764bd33fd94ed756d475f4273e1369290e0513a222ae1b63a55ed962283bd3ceab321320dedaeb5bdccfa430953f299bdedc02edcf9fc3fe4c4858ef340bdc
+  data.tar.gz: 2efb6f3cf24915b5ad04b1d3450695e7818badb093eda713587e9a938f64ce2899a331334c2b528afa817234806f93eefe3e7253a13a72dfca2e944af5c5aee9

data/.github/workflows/main.yml

@@ -7,7 +7,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.4', '2.5', '2.6', '2.7', '3.0']
+        ruby: ['2.5', '2.6', '2.7', '3.0', '3.1']
     runs-on: ubuntu-latest
     steps:
     - name: Checkout

data/.rubocop.yml

@@ -1,7 +1,6 @@
 AllCops:
   NewCops: enable
-  SuggestExtensions: false
-  TargetRubyVersion: 2.4.0
+  TargetRubyVersion: 2.5
 
 Style/StringLiterals:
   Enabled: true

data/CHANGELOG.md

@@ -8,7 +8,21 @@ and this project adheres to
 
 ## [Unreleased]
 
-[Unreleased]: https://github.com/johnsyweb/glyptodont/compare/v0.2.0..main
+[Unreleased]: https://github.com/johnsyweb/glyptodont/compare/v0.3.0..main
+
+## [0.3.0] - 2022-03-23
+
+### Added
+
+- `keywords` option and configuration for TODO synonyms [[#5]]
+
+### Changed
+
+- Dropped support for Ruby version older than 2.5 [[#4]]
+
+[#4]: https://github.com/johnsyweb/glyptodont/pull/4
+[#5]: https://github.com/johnsyweb/glyptodont/pull/5
+[Unreleased]: https://github.com/johnsyweb/glyptodont/compare/v0.2.0..v0.3.0
 
 ## [0.2.0] - 2021-03-28
 
@@ -29,7 +43,7 @@ and this project adheres to
 [#2]: https://github.com/johnsyweb/glyptodont/pull/2
 [#3]: https://github.com/johnsyweb/glyptodont/pull/3
 
-[Unreleased]: https://github.com/johnsyweb/glyptodont/compare/v0.1.0..v0.2.0
+[0.2.0]: https://github.com/johnsyweb/glyptodont/compare/v0.1.0..v0.2.0
 
 ## [0.1.0] - 2021-03-13
 

data/Gemfile

@@ -2,12 +2,13 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in glyptodont.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
-gem "rspec-its", "~> 1.3.0"
-
-gem "rubocop", "~> 1.7"
+group :developement, :test do
+  gem "rake"
+  gem "rspec"
+  gem "rspec-its"
+  gem "rubocop"
+  gem "rubocop-rake"
+  gem "rubocop-rspec"
+end

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Pete Johns
+Copyright (c) 2021-2022 Pete Johns
 
 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/README.md

@@ -1,7 +1,7 @@
 # Glyptodont
 
-Use this gem if you have ever deployed code to production without doing all of
-your to-dos.
+Use this gem if you want to avoid deploying code to production without doing all
+of your to-dos.
 
 ## Introduction
 
@@ -9,7 +9,7 @@ All of the glyptodonts have fossilised. This is a tool to ensure that your TODOs
 are eradicated before this can happen to them.
 
 If you've ever been caught out because a TODO in production code has not been
-don, this gem is for ***you***!
+_done_, this gem is for ***you***!
 
 ## Development status [![Ruby](https://github.com/johnsyweb/glyptodont/actions/workflows/main.yml/badge.svg)](https://github.com/johnsyweb/glyptodont/actions/workflows/main.yml)
 
@@ -53,6 +53,7 @@ Usage: glyptodont [options]
     -d, --directory DIRECTORY        Git repository to search for TODOs (default '.')
     -t, --threshold TODOS            Maximum number of TODOs to allow (default 10)
     -m, --max-age DAYS               Maximum number of days to allow TODOs to stay (default 14)
+    -k, --keywords TODO,WORDS        Keywords to treat as 'TODO' (default FIXME,HACK,TODO,XXX)
         --version                    Show version
 ```
 
@@ -70,6 +71,8 @@ root of the directory being scanned.
 - `ignore`: List of `file_name:line_number` pairs to ignore when researching
   TODOs. This may be useful if you have, for example, Spanish language text in
   your project or you talk about TODOs a lot :-)
+- `keywords`: List of synonyms for TODO in your project. I've seen some
+  interesting alternatives over the years.
 
 ### _Exempli gratiā_
 
@@ -86,7 +89,7 @@ ignore:
 
 ## Requirements
 
-- Ruby (tested against v2.4 and above)
+- Ruby (tested against v2.5 and above)
 - Git
 - CMake
 

data/glyptodont.gemspec

@@ -11,14 +11,15 @@ Gem::Specification.new do |spec|
   spec.email         = ["paj+github@johnsy.com"]
 
   spec.summary       = "A bit like `git grep 'T0D0'`, but better."  # .tr("0", "O")
-  spec.description   = "Use this gem if you have ever deployed code to production without doing all of your to-dos"
+  spec.description   = "Use this gem if you want to avoid deploying code to production without doing all of your to-dos"
   spec.homepage      = GITHUB_URL
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = GITHUB_URL
   spec.metadata["changelog_uri"] = "#{GITHUB_URL}blob/HEAD/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }

data/lib/glyptodont/checker.rb

@@ -14,6 +14,12 @@ module Glyptodont
   class Checker
     DEFAULT_THRESHOLD = 10
     DEFAULT_MAX_AGE_IN_DAYS = 14
+    DEFAULT_KEYWORDS = %w[
+      FIXME
+      HACK
+      TODO
+      XXX
+    ].freeze
 
     def initialize(args)
       @options = Options.new(args)
@@ -21,7 +27,7 @@ module Glyptodont
     end
 
     def check
-      todos = TodoResearcher.new(directory, ignore).research
+      todos = TodoResearcher.new(directory, ignore, keywords).research
 
       checks = [
         Checkers::Counter.new(todos: todos, threshold: threshold),
@@ -47,5 +53,9 @@ module Glyptodont
     def max_age_in_days
       options.max_age_in_days || configuration.max_age_in_days || DEFAULT_MAX_AGE_IN_DAYS
     end
+
+    def keywords
+      options.keywords || configuration.keywords || DEFAULT_KEYWORDS
+    end
   end
 end

data/lib/glyptodont/configuration.rb

@@ -24,6 +24,10 @@ module Glyptodont
       @max_age_in_days ||= config.fetch("max_age_in_days", nil)
     end
 
+    def keywords
+      @keywords ||= config.fetch("keywords", nil)
+    end
+
     private
 
     attr_reader :config_filename

data/lib/glyptodont/options.rb

@@ -7,7 +7,7 @@ require "optparse"
 module Glyptodont
   # Command-line options for the tool
   class Options
-    attr_reader :directory, :threshold, :max_age_in_days
+    attr_reader :directory, :threshold, :max_age_in_days, :keywords
 
     def initialize(args)
       @args = args
@@ -24,6 +24,7 @@ module Glyptodont
         directory_option(opts)
         threshold_option(opts)
         max_age_in_days_option(opts)
+        keywords_option(opts)
         version_option(opts)
       end.parse!(@args)
     end
@@ -46,6 +47,15 @@ module Glyptodont
       end
     end
 
+    def keywords_option(opts)
+      opts.on("-k",
+              "--keywords TODO,WORDS",
+              Array,
+              "Keywords to treat as 'TODO' (default FIXME,HACK,TODO,XXX)") do |k|
+        @keywords = k
+      end
+    end
+
     def version_option(opts)
       opts.on_tail("--version", "Show version") do
         puts VERSION

data/lib/glyptodont/todo_researcher.rb

@@ -6,9 +6,10 @@ require "rugged"
 module Glyptodont
   # Finds all the TODOs in a directory managed by Git, who last touched them and when.
   class TodoResearcher
-    def initialize(directory, ignore)
+    def initialize(directory, ignore, keywords)
       @directory = directory
       @ignore = ignore
+      @keywords = Array(keywords)
       @annotator = {}
     end
 
@@ -18,7 +19,7 @@ module Glyptodont
 
     private
 
-    attr_reader :directory, :ignore
+    attr_reader :directory, :ignore, :keywords
 
     def git
       Git.open(directory)
@@ -28,15 +29,6 @@ module Glyptodont
       "\\b\\(#{keywords.join('\|')}\\)\\b"
     end
 
-    def keywords
-      %w[
-        FIXME
-        HACK
-        TODO
-        XXX
-      ]
-    end
-
     def extract_details(todos)
       todos.flat_map do |sha, matches|
         file = sha.split(":", 2).last

data/lib/glyptodont/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Glyptodont
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glyptodont
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Pete Johns
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-28 00:00:00.000000000 Z
+date: 2022-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -38,8 +38,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Use this gem if you have ever deployed code to production without doing
-  all of your to-dos
+description: Use this gem if you want to avoid deploying code to production without
+  doing all of your to-dos
 email:
 - paj+github@johnsy.com
 executables:
@@ -85,6 +85,7 @@ metadata:
   homepage_uri: https://github.com/johnsyweb/glyptodont/
   source_code_uri: https://github.com/johnsyweb/glyptodont/
   changelog_uri: https://github.com/johnsyweb/glyptodont/blob/HEAD/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -93,14 +94,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.11
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: A bit like `git grep 'T0D0'`, but better.