todo_marker 0.1.0

checksums.yaml

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

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'todo_marker'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/todo_marker

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# bin/todo_marker
+# !/usr/bin/env ruby
+
+require 'todo_marker'
+
+if ARGV.empty?
+  puts 'Usage: todo_marker <directory>'
+  exit 1
+end
+
+directory = ARGV[0]
+unless Dir.exist?(directory)
+  puts "Directory #{directory} does not exist"
+  exit 1
+end
+
+TodoMarker.generate_todo_md(directory)
+puts "TODO.md has been generated in the #{directory} directory."

data/lib/todo_marker/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# lib/todo_marker/version.rb
+module TodoMarker
+  VERSION = '0.1.0'
+end

data/lib/todo_marker.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# lib/todo_marker.rb
+require 'todo_marker/version'
+require 'find'
+
+module TodoMarker
+  TODO_REGEX = /# !!TODO!! "(.*?)"/
+
+  def self.generate_todo_md(directory)
+    todos = []
+
+    Find.find(directory) do |path|
+      next unless path.end_with?('.rb')
+
+      File.readlines(path).each_with_index do |line, index|
+        next unless line.match(TODO_REGEX)
+
+        todos << {
+          message: line.match(TODO_REGEX)[1],
+          file: path,
+          line: index + 1
+        }
+      end
+    end
+
+    create_todo_file(directory, todos)
+  end
+
+  def self.create_todo_file(directory, todos)
+    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]})"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: todo_marker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- VetheonGames
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-06-15 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
+email:
+- connor@pixelridgesoftworks.com
+executables:
+- todo_marker
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/console
+- bin/setup
+- bin/todo_marker
+- lib/todo_marker.rb
+- lib/todo_marker/version.rb
+homepage: https://git.pixelridgesoftworks.com/PixelRidge-Softworks/Todo_Marker
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://git.pixelridgesoftworks.com/PixelRidge-Softworks/Todo_Marker
+  source_code_uri: https://git.pixelridgesoftworks.com/PixelRidge-Softworks/Todo_Marker
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.7
+signing_key:
+specification_version: 4
+summary: Standalone gem for generating TODO.md files
+test_files: []