glyptodont 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ad92f48b0fac0e3a90a61d375ccb01f187c79a79070bb801cac3d30f13585e3
-  data.tar.gz: eec6a97e7ab90f1bbd557f5e8fbfc4e6f5809f7aa21f030a1b1f5eae124f1288
+  metadata.gz: 3cfa9e6366161885c86dbe07e79c0c14d57a58bbdf8c7e69d3683b6d96838dfe
+  data.tar.gz: d71c6335cd02094e9bbabc72701c21e7cb6001617a2eddbb5884f68d496dff43
 SHA512:
-  metadata.gz: b1daa8bc22b0345c15c8c6f19b394f236e9169007f402b934c94a55b5076ac4ce0c21e9b1c5a49300a5276490b2366df4e68ebc731ece3a89d4b1e12f4eb7c2a
-  data.tar.gz: d1238f2ffbde7b028bc65405ffe0e9b1573f4f8fc86450a2fd1a5cd1ceece15ef4b3bd8e6d7662c0418c7861311d1084c39f0b5dd9931c35b99a3a81b9369e33
+  metadata.gz: 994f96b328e5beef3093bb344ec53f362c3fa2255da24338343069b9511fafd0be2999ecd8a5e60a43bb55966e8e155061ef43a1b0dca5acdf180b7f857bffa5
+  data.tar.gz: 1e8200f3b8cce054163ba12d9e31a87267f12ea3c0796cb47809c7abf5d66f7603cd0fefb59cc6cfca1e7ffd5b2a533a0e080be15012b9223a081af8517ca2f7

data/.github/workflows/main.yml

@@ -10,12 +10,15 @@ jobs:
         ruby: ['2.4', '2.5', '2.6', '2.7', '3.0']
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - name: Checkout
+      uses: actions/checkout@v2
+
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
-    - name: Run the default task
+
+    - name: Run The CI Build
       run: |
         gem install bundler
         sudo apt install cmake

data/.glyptodont.yaml

@@ -1,10 +1,14 @@
 ---
+threshold: 1
+max_age_in_days: 1
 ignore:
-  - README.md:10
-  - README.md:15
-  - lib/glyptodont/checkers/counter.rb:28
+  - README.md:11
+  - README.md:16
   - lib/glyptodont/checkers/counter.rb:30
-  - lib/glyptodont/todo_researcher.rb:32
+  - lib/glyptodont/checkers/counter.rb:32
   - lib/glyptodont/todo_researcher.rb:33
   - lib/glyptodont/todo_researcher.rb:34
   - lib/glyptodont/todo_researcher.rb:35
+  - lib/glyptodont/todo_researcher.rb:36
+  - spec/checkers/counter_spec.rb:20
+  - spec/checkers/counter_spec.rb:28

data/.rubocop.yml

@@ -13,3 +13,7 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*.rb"

data/CHANGELOG.md

@@ -1,5 +1,38 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
 ## [Unreleased]
 
+[Unreleased]: https://github.com/johnsyweb/glyptodont/compare/v0.2.0..main
+
+## [0.2.0] - 2021-03-28
+
+### Added
+
+- Configuration settings for `max_age_in_days` and `threshold`, to allow for
+  setting these per project. [[#3]]
+
+### Changed
+
+- Report all old TODOs, use age of the youngest in message [[#2]]
+
+### Fixed
+
+- Handle empty configuration file [[#1]]
+
+[#1]: https://github.com/johnsyweb/glyptodont/pull/1
+[#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.1.0] - 2021-03-13
 
 - Initial release
+
+[0.1.0]: https://github.com/johnsyweb/glyptodont/releases/tag/v0.1.0

data/Gemfile

@@ -8,5 +8,6 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
+gem "rspec-its", "~> 1.3.0"
 
 gem "rubocop", "~> 1.7"

data/README.md

@@ -59,17 +59,29 @@ Usage: glyptodont [options]
 ## Configuration
 
 glyptodont looks for an optional `.glyptodont.yaml` configuration file in the
-root of the directory being scanned, which contains an `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.
+root of the directory being scanned.
+
+### Sections
+
+- `threshold`: Maximum number of TODOs to allow. Can be overridden by
+  command-line options.
+- `max_age_in_days`: Maximum number of days to allow TODOs to stay. Can be
+  overridden by command-line options.
+- `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 :-)
 
 ### _Exempli gratiā_
 
 ```yaml
 ---
+threshold: 1
+max_age_in_days: 1
 ignore:
-  - lib/glyptodont/checkers/counter.rb:28
-  - lib/glyptodont/todo_researcher.rb:34
+  - README.md:11
+  - lib/glyptodont/checkers/counter.rb:30
+  - lib/glyptodont/todo_researcher.rb:33
+  - spec/checkers/counter_spec.rb:20
 ```
 
 ## Requirements
@@ -95,3 +107,8 @@ The gem is available as open source under the terms of the [MIT License](https:/
 Everyone interacting in the Glyptodont project's codebases, issue trackers, chat
 rooms and mailing lists is expected to follow the [code of
 conduct](https://github.com/johnsyweb/glyptodont/blob/master/CODE_OF_CONDUCT.md).
+
+## See also
+
+<https://github.com/johnsyweb/glyptodont-docker> to run this in a container,
+ideal for your CI pipeline.

data/lib/glyptodont.rb

@@ -1,38 +1,10 @@
 # frozen_string_literal: true
 
-require_relative "glyptodont/checkers/age"
-require_relative "glyptodont/checkers/counter"
-require_relative "glyptodont/configuration"
-require_relative "glyptodont/formatting"
-require_relative "glyptodont/options"
-require_relative "glyptodont/todo_researcher"
+require_relative "glyptodont/checker"
 
-require "forwardable"
-
-# This is where the magic happens
+# Entry point
 module Glyptodont
-  class << self
-    def check
-      @options = Options.new
-      @configuration = Configuration.new(directory)
-
-      todos = TodoResearcher.new(directory, ignore).research
-
-      checks = [
-        Checkers::Counter.new(todos: todos, threshold: threshold),
-        Checkers::Age.new(todos: todos, threshold: max_age_in_days)
-      ].freeze
-
-      checks.each { |check| puts check.check }
-
-      checks.all?(&:passed?)
-    end
-
-    attr_reader :configuration, :options
-
-    extend Forwardable
-
-    def_delegator :@configuration, :ignore
-    def_delegators :@options, :directory, :threshold, :max_age_in_days
+  def self.check
+    Checker.new(ARGV).check
   end
 end

data/lib/glyptodont/checker.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "checkers/age"
+require_relative "checkers/counter"
+require_relative "configuration"
+require_relative "formatting"
+require_relative "options"
+require_relative "todo_researcher"
+
+require "forwardable"
+
+module Glyptodont
+  # Main class where all the work happens
+  class Checker
+    DEFAULT_THRESHOLD = 10
+    DEFAULT_MAX_AGE_IN_DAYS = 14
+
+    def initialize(args)
+      @options = Options.new(args)
+      @configuration = Configuration.new(directory)
+    end
+
+    def check
+      todos = TodoResearcher.new(directory, ignore).research
+
+      checks = [
+        Checkers::Counter.new(todos: todos, threshold: threshold),
+        Checkers::Age.new(todos: todos, threshold: max_age_in_days)
+      ].freeze
+
+      checks.each { |check| puts check.check }
+
+      checks.all?(&:passed?)
+    end
+
+    attr_reader :configuration, :options
+
+    extend Forwardable
+
+    def_delegator :@configuration, :ignore
+    def_delegators :@options, :directory
+
+    def threshold
+      options.threshold || configuration.threshold || DEFAULT_THRESHOLD
+    end
+
+    def max_age_in_days
+      options.max_age_in_days || configuration.max_age_in_days || DEFAULT_MAX_AGE_IN_DAYS
+    end
+  end
+end

data/lib/glyptodont/checkers/age.rb

@@ -10,32 +10,40 @@ module Glyptodont
       end
 
       def check
-        @age, @reportable_todos = oldest_todos
         message
       end
 
       def passed?
-        todos.empty? || age <= threshold
+        stale_todos.empty?
       end
 
       private
 
-      attr_reader :todos, :threshold, :age, :reportable_todos
+      attr_reader :todos, :threshold
 
       def message
         if todos.empty?
           "Nothing left to do"
         elsif passed?
-          "At #{Glyptodont.pluralize(age, "day")}, TODOs are fresh enough for now"
+          "At #{Glyptodont.pluralize(oldest_age, "day")}, TODOs are fresh enough for now"
         else
-          "Some TODOs are too stale at #{Glyptodont.pluralize(age, "day")} old:\n" +
-            reportable_todos.map { |t| Glyptodont.format_todo(t) }.join("\n")
+          "Some TODOs are too stale at more than #{Glyptodont.pluralize(youngest_stale - 1, "day")} old:\n" +
+            stale_todos.map { |t| Glyptodont.format_todo(t) }.join("\n")
         end
       end
 
-      def oldest_todos
-        todos.group_by { |todo| todo[:age] }
-             .max_by { |age, _group| age }
+      def stale_todos
+        @stale_todos ||= todos.select { |todo| todo[:age] > threshold }
+                              .sort_by { |todo| todo[:age] }
+                              .reverse
+      end
+
+      def oldest_age
+        todos.max_by { |t| t[:age] }[:age]
+      end
+
+      def youngest_stale
+        stale_todos.last[:age]
       end
     end
   end

data/lib/glyptodont/checkers/counter.rb

@@ -10,8 +10,6 @@ module Glyptodont
       end
 
       def check
-        @count = todos.size
-        @reportable_todos = passed? ? todos : []
         message
       end
 
@@ -21,6 +19,10 @@ module Glyptodont
 
       private
 
+      def count
+        @count ||= todos.size
+      end
+
       def message
         if count.zero?
           "All done"
@@ -32,7 +34,7 @@ module Glyptodont
         end
       end
 
-      attr_reader :todos, :threshold, :count
+      attr_reader :todos, :threshold
     end
   end
 end

data/lib/glyptodont/configuration.rb

@@ -7,6 +7,7 @@ module Glyptodont
   # Allow for configuring the tool
   class Configuration
     FILENAME = ".glyptodont.yaml"
+
     def initialize(directory)
       @config_filename = File.join(directory, FILENAME)
     end
@@ -15,16 +16,24 @@ module Glyptodont
       @ignore ||= extract_ignore_set || []
     end
 
+    def threshold
+      @threshold ||= config.fetch("threshold", nil)
+    end
+
+    def max_age_in_days
+      @max_age_in_days ||= config.fetch("max_age_in_days", nil)
+    end
+
     private
 
     attr_reader :config_filename
 
     def config
-      @config ||= begin
-        YAML.load_file(config_filename)
-      rescue Errno::ENOENT
-        {}
-      end
+      @config ||= if File.exist?(config_filename)
+                    YAML.load_file(config_filename, fallback: {})
+                  else
+                    {}
+                  end
     end
 
     def extract_ignore_set

data/lib/glyptodont/options.rb

@@ -9,10 +9,9 @@ module Glyptodont
   class Options
     attr_reader :directory, :threshold, :max_age_in_days
 
-    def initialize
+    def initialize(args)
+      @args = args
       @directory = "."
-      @threshold = 10
-      @max_age_in_days = 14
       parse
     end
 
@@ -26,7 +25,7 @@ module Glyptodont
         threshold_option(opts)
         max_age_in_days_option(opts)
         version_option(opts)
-      end.parse!(ARGV)
+      end.parse!(@args)
     end
 
     def directory_option(opts)

data/lib/glyptodont/todo_researcher.rb

@@ -9,6 +9,7 @@ module Glyptodont
     def initialize(directory, ignore)
       @directory = directory
       @ignore = ignore
+      @annotator = {}
     end
 
     def research
@@ -65,7 +66,8 @@ module Glyptodont
     end
 
     def line_info(file_path:, line_number:)
-      Rugged::Blame.new(repository, file_path).for_line(line_number)
+      @annotator[file_path] ||= Rugged::Blame.new(repository, file_path)
+      @annotator[file_path].for_line(line_number)
     end
 
     def repository

data/lib/glyptodont/version.rb

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

data/script/test

@@ -10,6 +10,9 @@ cd "$(dirname "$0")/.."
 
 [ -z "$DEBUG" ] || set -x
 
+echo "==> Code quality…"
+bundle exec rubocop
+
 echo "==> Running tests…"
 
 if [ -n "$1" ]; then

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glyptodont
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Pete Johns
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-16 00:00:00.000000000 Z
+date: 2021-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -64,6 +64,7 @@ files:
 - exe/glyptodont
 - glyptodont.gemspec
 - lib/glyptodont.rb
+- lib/glyptodont/checker.rb
 - lib/glyptodont/checkers/age.rb
 - lib/glyptodont/checkers/counter.rb
 - lib/glyptodont/configuration.rb