todoloo 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e10a05abef8c425b5e2e9347d1bccc9e592f5e7a03a5608f84aa5495cfdf45e
-  data.tar.gz: 3e0febaa61ee4a872d045d8df00f9b49e17716ae3384b52a1aad8e0efbd4ec68
+  metadata.gz: 30e603e6f88a2ac0a52654b71d81714936db242648786c9bd1b0ac602cff03e6
+  data.tar.gz: 609ee891b2a8d01817c63725a4a4b4197c63e86cabeb5f44b32a8b4a470c224a
 SHA512:
-  metadata.gz: aefc739a86f6120a9383f3edec5b84433498cdcfe747fa40fd72654fc61ab4925137be92402c2303e37db9ead9b632837171a58d9c1142fdc80fa664deb43387
-  data.tar.gz: b0862355aa8fdb6bbfc4c405f8b0f83fd84a489f930c9aca3728bbae1b9888481bde8f34c1d3ed9632934068c685d84302e3f9df995dfea209b3573ddcef3033
+  metadata.gz: e6f09e526d68283bc2ce77bdf9a2439f4d4a03bcb6b9dc199cdcd41356625fd7968eba57e6f2dade51a61aee5b280041e0e9ec82a2db99a093ce279006135ffd
+  data.tar.gz: 7e37cf807c222e8320e0af0eebaab9bd390beb2bb523c6174237a5f40d6a699e8d905e239a0c2b6e0ba917468885fd685d718526bb485fffa29d96cba867f5b5

data/CHANGELOG

@@ -1,3 +1,17 @@
+Unreleased
+
+0.0.4 - 13 August 2024
+- Add more extensive CLI tests to catch some corner cases
+- Fix `--exclude` flag not being repeatable
+- Add `--pattern` flag for repeatable file matching pattern specification 
+- Add `--verbose` switch to opt-in for printing out scanned files
+- Add `--output [FILENAME]` flag for specifying where to write the todos/tasks 
+- Fix remove file repeatitions when using `--pattern` that matches repeatedly
+
+0.0.3 - 8 August 2024
+- Add sorting support to `TaskList` and now sort CLI output by default
+- Fix parsing for multiple tags, as in `TODO(a,b,c)`
+
 0.0.2 - 19 July 2024
 - Add regression for `Todoloo::TaskList` on writing tasks with blank topics
 

data/Rakefile

@@ -6,3 +6,7 @@ require "minitest/test_task"
 Minitest::TestTask.create
 
 task default: :test
+
+task "test:watch" do
+  system("rerun bundle exec rake")
+end

data/lib/todoloo/cli.rb

@@ -3,13 +3,28 @@ require "thor"
 class Todoloo::CLI < Thor
   package_name "Todoloo"
 
+  DEFAULT_PATTERN = [
+    "**/*.rb",
+    "*.rb"
+  ].freeze
+
   desc "scan", "Scans all files that match the given globs and outputs a tasks.yml"
-  method_option :exclude, type: :array, aliases: "-e", desc: "List of path globs to exclude"
+  method_option :pattern, type: :string, repeatable: true, aliases: "-p", desc: "Path globs to match; can be repeated"
+  method_option :exclude, type: :string, repeatable: true, aliases: "-e", desc: "List of path globs to exclude"
+  method_option :output, type: :string, aliases: "-o", default: "tasks.yml", desc: "Name of the output file"
+  method_option :verbose, type: :boolean, default: false
   def scan
+    patterns = options.fetch(:pattern, DEFAULT_PATTERN)
+
     Todoloo::FileScanner
-      .new("**/*.rb", excludes: options[:exclude] || [], trace: true)
+      .new(
+        patterns,
+        excludes: options.fetch(:exclude, []),
+        trace: options.fetch(:verbose)
+      )
       .scan
-      .write("tasks.yml")
+      .sort
+      .write(options.fetch(:output))
   end
 
   desc "io", "Reads input from stdio and writes to stdout"
@@ -18,7 +33,7 @@ class Todoloo::CLI < Thor
       Todoloo::Parser
         .new
         .parse_and_transform($stdin.read)
-    ).write($stdout)
+    ).sort.write($stdout)
   end
 
   def self.exit_on_failure?

data/lib/todoloo/helpers.rb

@@ -6,7 +6,9 @@ module Todoloo
     # TODO We need to optimize how we traverse the file-system so that we can short-circuit the excludes instead
     #      of only filtering after finding them.
     #
-    # @pattern [String]
+    # TODO Optimize the seen_path handling
+    #
+    # @pattern [String, Array<String>]
     #   The file paths to glob
     #
     # @excludes [Array<String>]
@@ -14,9 +16,15 @@ module Todoloo
     #
     # @return [Enumerator<String>]
     def glob_paths(pattern, excludes: [])
+      seen_paths = Set.new
+
       Enumerator.new do |y|
-        Dir[pattern].lazy.each do |path|
-          y << path unless excludes.any? { |e| File.fnmatch(e, path) }
+        Dir[*Array(pattern)].lazy.each do |path|
+          if !(seen_paths.include?(path) || excludes.any? { |e| File.fnmatch(e, path) })
+            y << path
+          end
+
+          seen_paths << path
         end
       end
     end

data/lib/todoloo/parser.rb

@@ -148,7 +148,7 @@ module Todoloo
 
     rule(:topic) { match(/[^),]/).repeat(1).as(:topic) }
 
-    rule(:topic_rest) { (str(",") >> spacing.maybe >> topic).repeat(0, 1) }
+    rule(:topic_rest) { (str(",") >> spacing.maybe >> topic).repeat(0) }
 
     # (topic1, topic2)
     rule(:topics) { lparen >> topic >> topic_rest >> rparen }

data/lib/todoloo/task.rb

@@ -10,5 +10,9 @@ module Todoloo
         hash.fetch(:column)
       )
     end
+
+    def location
+      "#{path}:#{line}:#{column}"
+    end
   end
 end

data/lib/todoloo/task_list.rb

@@ -2,6 +2,20 @@ require "yaml"
 
 module Todoloo
   class TaskList
+    include Enumerable
+
+    # Lower means higher priority
+    SEVERITY_INDEX = {
+      "FIXME" => 100,
+      "HACK" => 200,
+      "TODO" => 300,
+      "XXX" => 400,
+      "NOTE" => 500,
+      "HBD" => 600
+    }.freeze
+
+    UNKNOWN_INDEX = 1_000_000
+
     def initialize
       @tasks = []
     end
@@ -17,6 +31,20 @@ module Todoloo
       self
     end
 
+    def each
+      to_enum(:each) unless block_given?
+
+      @tasks.each { |task| yield task }
+    end
+
+    def sort
+      @tasks.sort_by! do |t|
+        [t.topics, task_severity(t), t.path, t.line, t.column]
+      end
+
+      self
+    end
+
     # Structure:
     #   TOPIC:
     #     TYPE:
@@ -38,6 +66,10 @@ module Todoloo
 
     private
 
+    def task_severity(task)
+      SEVERITY_INDEX.fetch(task.type, UNKNOWN_INDEX)
+    end
+
     def topics_for_task(task)
       if task.topics.empty?
         [""]

data/lib/todoloo/transformer.rb

@@ -19,7 +19,7 @@ module Todoloo
       {type: type, topics: topics, description: description.empty? ? "" : (raise "must be empty")}
     end
 
-    rule(topic: simple(:x)) { x }
+    rule(topic: simple(:x)) { x.to_s }
 
     rule(task: subtree(:task)) { task }
 

data/lib/todoloo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Todoloo
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: todoloo
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Chris Coetzee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-19 00:00:00.000000000 Z
+date: 2024-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby