todo_marker 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1611c99217fb8bdc944629afe27af2b603314ff4164e1c71738a50928d2ef58e
-  data.tar.gz: 377b5b8dcaeae8400dc51ae5a66b62ed7a41f8770c7f4fcd8f7942db452a96c3
+  metadata.gz: bca81325f56048674c08b2159e78ffa15c8e2115f221d02c67fb6e267be6d496
+  data.tar.gz: d8d65957d51ff2b8c99ebd54cd86c5c159226b90a7abe04c435c623cf94adeb6
 SHA512:
-  metadata.gz: 31a68e4191f0bd55054ef1626e2e724562b7dfabee66c1c9a04605287f6850aa6cb282f697325bdc6c1d116638f5f933670a29317ec4cee8e4546ae3b3da876c
-  data.tar.gz: 10abd7e84f082bf4d134f871b45726995eb07632af18620cc553586fdd7010c96c9401781befe9a7de890c52b7dd891ead9bce262f91ec0af21d22c2ebf92d6e
+  metadata.gz: deeb78bec21739a40a24ed2cd21535de2927cb0e75324550219e9fed64a5565910fefb8b3aa95ffca6eed64928026d7c824172eaa7352688ba91bebab58c8300
+  data.tar.gz: ff9d4c5e0aca9893bbdff5e51218e249f8a0eb3c9cb898235cd1c042af7cd516568b4adf95147f2b67bcf5cdc86419395bfeee2d925ebdbd45a858df451187db

data/bin/todo_marker

@@ -4,6 +4,10 @@
 # !/usr/bin/env ruby
 
 require 'todo_marker'
+require 'date'
+
+DONATION_LINK = 'https://www.paypal.com/donate/?hosted_button_id=YF5XS7ZXQ6F8A'
+TIMESTAMP_FILE = File.join(Dir.home, '.todo_marker_last_donation_prompt')
 
 if ARGV.empty?
   puts 'Usage: todo_marker <directory>'
@@ -18,3 +22,22 @@ end
 
 TodoMarker.generate_todo_md(directory)
 puts "TODO.md has been generated in the #{directory} directory."
+
+def should_show_donation_message?
+  return true unless File.exist?(TIMESTAMP_FILE)
+
+  last_prompt = Date.parse(File.read(TIMESTAMP_FILE).strip)
+  (Date.today - last_prompt).to_i >= 7 # Show message once a week
+rescue ArgumentError
+  true
+end
+
+def update_timestamp
+  File.write(TIMESTAMP_FILE, Date.today.to_s)
+end
+
+if should_show_donation_message?
+  puts "\nEnjoying TodoMarker? Consider donating to support development:"
+  puts DONATION_LINK
+  update_timestamp
+end

data/lib/todo_marker/version.rb

@@ -2,5 +2,5 @@
 
 # lib/todo_marker/version.rb
 module TodoMarker
-  VERSION = '0.1.0'
+  VERSION = '0.2.2'
 end

data/lib/todo_marker.rb

@@ -5,7 +5,13 @@ require 'todo_marker/version'
 require 'find'
 
 module TodoMarker
-  TODO_REGEX = /# !!TODO!! "(.*?)"/
+  TODO_REGEX = /# !!TODO!!(?: style: (\w+))? "(.*?)"/
+  STYLES = {
+    'title1' => '# %s',
+    'title2' => '## %s',
+    'title3' => '### %s',
+    'sublist' => '  - %s'
+  }.freeze
 
   def self.generate_todo_md(directory)
     todos = []
@@ -16,8 +22,10 @@ module TodoMarker
       File.readlines(path).each_with_index do |line, index|
         next unless line.match(TODO_REGEX)
 
+        style, message = line.match(TODO_REGEX).captures
         todos << {
-          message: line.match(TODO_REGEX)[1],
+          style:,
+          message:,
           file: path,
           line: index + 1
         }
@@ -31,8 +39,22 @@ module TodoMarker
     File.open(File.join(directory, 'TODO.md'), 'w') do |file|
       file.puts "# TODO List\n\n"
       todos.each do |todo|
-        file.puts "- #{todo[:message]} (#{todo[:file]}:#{todo[:line]})"
+        formatted_message = format_message(todo[:style], todo[:message])
+        file.puts formatted_message
+        file.puts "  (#{todo[:file]}:#{todo[:line]})" if todo[:style].nil?
       end
     end
   end
+
+  def self.format_message(style, message)
+    if style
+      if style == 'sublist'
+        "  - #{message}"
+      else
+        STYLES[style] % message
+      end
+    else
+      "- #{message}"
+    end
+  end
 end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: todo_marker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - VetheonGames
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-15 00:00:00.000000000 Z
+date: 2024-06-22 00:00:00.000000000 Z
 dependencies: []
 description: |-
   This standalone gem takes in source code files written in Ruby, and generates a TODO.md file from
-                        them.
-                        mark things to add to the TODO.md with the `# !!TODO!!` magic comment
+                        them. Mark things to add to the TODO.md with the # !!TODO!! magic comment. Ensure to checkout the
+                        documentation to learn styles!
 email:
 - connor@pixelridgesoftworks.com
 executables:
@@ -26,12 +26,15 @@ files:
 - bin/todo_marker
 - lib/todo_marker.rb
 - lib/todo_marker/version.rb
-homepage: https://git.pixelridgesoftworks.com/PixelRidge-Softworks/Todo_Marker
+homepage: https://git.pixelridgesoftworks.com/PixelRidge-Softworks
 licenses:
-- MIT
+- GNU V3.0
 metadata:
-  homepage_uri: https://git.pixelridgesoftworks.com/PixelRidge-Softworks/Todo_Marker
+  homepage_uri: https://git.pixelridgesoftworks.com/PixelRidge-Softworks
   source_code_uri: https://git.pixelridgesoftworks.com/PixelRidge-Softworks/Todo_Marker
+  documentation_uri: https://git.pixelridgesoftworks.com/PixelRidge-Softworks/Todo_Marker/src/branch/main/README.md
+  changelog_uri: https://git.pixelridgesoftworks.com/PixelRidge-Softworks/Todo_Marker/src/branch/main/changelog.md
+  funding_uri: https://www.paypal.com/donate/?hosted_button_id=YF5XS7ZXQ6F8A
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -48,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.7
+rubygems_version: 3.5.14
 signing_key:
 specification_version: 4
 summary: Standalone gem for generating TODO.md files