todoloo 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 652fcb62bf1d496280e48cd4d10a1616f4626fdb44c69d3a59976962ae9ab141
-  data.tar.gz: 1dc37022a98ba6c1bd50b3eb790c740cec79f10681e5bafd6f04ed918364f35c
+  metadata.gz: 9391333b3186bf9acd092a3d2477768f4f47ae4ef929667e71ae7b3011567a37
+  data.tar.gz: 3b85f78433162892ceade94dfebdddff29d9662be2ad6f923ec33b4e24731a6d
 SHA512:
-  metadata.gz: b8433b47e15248d606b6c52ede9a9d42096136bd3faac4fb4f24b2698e92c0d6d6003605bfb7972aae479bd7758a24e398c78f39c8141fc4e1b8ea849fc45b35
-  data.tar.gz: 5d34072524e668e5acfaa679a040c271721b824246db544c6e4c45a23225261e0681ffcd73ecae419109d1fd4f02399c42b7cf6b9f13518f383e91ff1a046ad1
+  metadata.gz: c79bf5aee911bf8d3a262e0489f72c28bf67b52ad249a702dee70cde08c59eafb8c477c0d9d42e38e26fc824cd5e6f8a953eb85a92ec91235f5a4f203936f897
+  data.tar.gz: e3fcbd9542607dcbb603224232f94d0e90c4a7639d6c45f23e8fb3242afaf1a693d3cee3f4299c85640d2d9211d0e6d9f0e13ee6c47b31691449d948902b2e33

data/.direnv

@@ -0,0 +1 @@
+PATH_add bin

data/CHANGELOG

@@ -0,0 +1,9 @@
+Unreleased
+
+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/lib/todoloo/cli.rb

@@ -9,6 +9,7 @@ class Todoloo::CLI < Thor
     Todoloo::FileScanner
       .new("**/*.rb", excludes: options[:exclude] || [], trace: true)
       .scan
+      .sort
       .write("tasks.yml")
   end
 
@@ -18,7 +19,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/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,19 @@ 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,8 +65,20 @@ module Todoloo
 
     private
 
+    def task_severity(task)
+      SEVERITY_INDEX.fetch(task.type, UNKNOWN_INDEX)
+    end
+
+    def topics_for_task(task)
+      if task.topics.empty?
+        [""]
+      else
+        task.topics
+      end
+    end
+
     def converted_tasks(error_handler)
-      output = {"" => {}}
+      output = {}
 
       @tasks.each do |task|
         output_task = {
@@ -47,7 +86,7 @@ module Todoloo
           "path" => "#{task.path}:#{task.line}:#{task.column}"
         }
 
-        task.topics.each do |topic|
+        topics_for_task(task).each do |topic|
           by_type = output[topic.to_s] ||= {}
           tasks = by_type[task.type.to_s.downcase] ||= []
           tasks << output_task.dup

data/lib/todoloo/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: todoloo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Chris Coetzee
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-18 00:00:00.000000000 Z
+date: 2024-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -102,6 +102,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".direnv"
+- CHANGELOG
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md