Icarus-Mod-Tools 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e65ad8b4c6c5bd0cd903b9f2d9b8d0e09fb1382a776c7177a3aae0e74c60cfaa
-  data.tar.gz: aa19523d4e5cd01aa6439e4cf83e020728a870c439c75552927940314979ddf6
+  metadata.gz: f629740e09031cd9f71c655aa8872e1f9ca80db5e9ca0aaab9e2894d64190c61
+  data.tar.gz: '08d27ce72493df462e3d028bdced86a23f5ddc78e1da7f37d0b9f637b2b720c7'
 SHA512:
-  metadata.gz: dbf4a04fcd7c8035f22c6833f2beac93ded7a24ea9c73668ac29bdbc6aa41b0798376621b0a2965671fe715712d9f88f91c9270aec90267fe53293137ed0052c
-  data.tar.gz: 95602d38541559babf423d486bd85a3a803e46eb131363391ec8d8904a326f1d84ebde775735c6783cc1ddf05b820e60696d3670541792ca611b4425c37224de
+  metadata.gz: af55744f78e88d220f83578cd1f85ac341f4b1421b1ef44c580737effc249a053a5798b8dc040385f4e08c16e2bd3c8e5a9e038d143f6a36ed14daf68e64816d
+  data.tar.gz: a3b2c2f18203a5472236cead6506b060010254828d8a05412863f9979b1c1c2bb4f2d0f19e250e5e320ab72ae496fc5d8c66e29779c86a86db851338b702218b

data/.claude/settings.local.json

@@ -0,0 +1,9 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(bundle exec rspec:*)"
+    ],
+    "deny": [],
+    "ask": []
+  }
+}

data/CLAUDE.md

@@ -0,0 +1,152 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+Icarus Mod Tools (`imt`) is a Ruby CLI gem that manages a bidirectional sync between GitHub repositories and Google Firestore for the Icarus game mods database. The tool discovers `modinfo.json` and `toolinfo.json` files across repositories and maintains a centralized Firestore database.
+
+## Development Commands
+
+### Setup & Installation
+
+```bash
+bin/setup                    # Install dependencies
+bundle install               # Install gems
+bundle exec rake install     # Install gem locally
+```
+
+### Testing
+
+```bash
+bundle exec rake             # Run tests (default task)
+bundle exec rspec            # Run tests only (with Fuubar formatter)
+bundle exec rspec spec/path/to/file_spec.rb  # Run single test file
+bundle exec rspec spec/path/to/file_spec.rb:42  # Run single test at line 42
+guard                        # Auto-run tests on file changes
+```
+
+### Console & Debugging
+
+```bash
+bin/console                  # Interactive IRB console with project loaded
+```
+
+### Running the CLI
+
+```bash
+bundle exec exe/imt [command]  # Run CLI during development
+imt [command]                  # Run installed gem
+```
+
+## Architecture
+
+### Data Flow Pipeline
+
+The tool implements a two-stage sync pipeline:
+
+1. **GitHub → Meta Collections**: Scan repositories for metadata files and sync to `meta/modinfo`, `meta/toolinfo`, `meta/repos`
+2. **Meta → Entity Collections**: Process meta lists to populate/update `mods` and `tools` collections
+
+All operations support `--dry-run` for safe testing.
+
+### Core Components
+
+**CLI Layer** (`lib/icarus/mod/cli/`)
+
+- `Command`: Main entry point, defines subcommands (sync, list, add, remove, validate)
+- `Base`: Inherited by all commands, provides `--config` and `--version` options
+- `SubcommandBase`: Base for subcommands, adds `--verbose` option
+- Subcommands: `Sync`, `List`, `Add`, `Remove`, `Validate` (all Thor-based)
+
+**Data Models** (`lib/icarus/mod/tools/`)
+
+- `Baseinfo`: Shared validation/transformation logic for mod and tool data
+- `Modinfo`: Validates and processes mod metadata
+- `Toolinfo`: Validates and processes tool metadata
+- `Validator`: Standalone validation utilities
+
+**Sync Operations** (`lib/icarus/mod/tools/sync/`)
+
+- `ModinfoList`: GitHub → meta/modinfo sync
+- `ToolinfoList`: GitHub → meta/toolinfo sync
+- `Mods`: meta/modinfo → mods sync
+- `Tools`: meta/toolinfo → tools sync
+- `Helpers`: HTTP utilities with custom SSL verification for Ruby 3.4+ CRL issues
+
+**External Services** (`lib/icarus/mod/`)
+
+- `Firestore`: Google Cloud Firestore client with collection management
+- `Github`: Octokit wrapper with recursive file discovery
+- `Config`: JSON config reader for `.imtconfig.json`
+
+### Global State
+
+The CLI uses a global `$firestore` variable in sync commands to share the Firestore instance across operations. This is set in `CLI::Sync` and used by sync modules.
+
+### Configuration
+
+The tool reads from `~/.imtconfig.json` (configurable via `--config`):
+
+- Firebase credentials (full JSON object, not path)
+- GitHub OAuth token
+- Collection paths (configurable)
+
+See README.md for configuration structure.
+
+## Development Patterns
+
+### CLI Command Structure
+
+All commands inherit from `CLI::Base` or `CLI::SubcommandBase`:
+
+```ruby
+class MyCommand < CLI::SubcommandBase
+  desc "mycommand ARGS", "Description"
+  method_option :my_option, aliases: "-m", type: :string, desc: "Option description"
+  def mycommand(args)
+    # Config is already loaded by CLI::Command#initialize
+    # Access via Icarus::Mod::Config.config
+  end
+end
+```
+
+### Error Handling
+
+Domain errors use `Icarus::Mod::Tools::Error`. Validation errors/warnings are stored in `@errors` and `@warnings` arrays on data model instances.
+
+```ruby
+rescue Icarus::Mod::Tools::Error => e
+  warn "Error: #{e.message}"
+  exit 1
+end
+```
+
+### Validation Rules
+
+All mod/tool data inherits from `Baseinfo`:
+
+- Required fields: `name`, `author`, `description`
+- URL validation for `imageURL`, `readmeURL`, file URLs
+- File types must match `/\.(zip|pak|exmodz?)/i`
+- Version strings should match `/^\d+[.\d+]*/`
+
+### SSL Certificate Handling
+
+Ruby 3.4+ with newer OpenSSL may fail CRL checking. The codebase handles this in `Sync::Helpers#retrieve_from_url` with a custom `verify_callback` that allows `V_ERR_UNABLE_TO_GET_CRL` errors.
+
+### Testing Patterns
+
+- Fixtures in `spec/fixtures/`
+- Tests run in random order (`config.order = :random`)
+- Use `:focus` metadata to run specific tests
+- Fuubar formatter provides progress bar display
+
+## Key Gotchas
+
+- **Firestore credentials**: Must be the full JSON object in config, not a file path
+- **GitHub repo format**: `owner/repo` format (URL prefixes are stripped automatically)
+- **Ruby version**: 3.1+ required for pattern matching and modern features
+- **Platform**: WSL2/Linux recommended; not tested on Windows
+- **Require paths**: The gemspec sets `require_paths` to both `lib` and `lib/icarus/mod`, so files use relative requires like `require "cli/base"` instead of `require_relative`
+- **Verbosity**: `-v` and `-vv` flags control output detail in subcommands

data/Gemfile

@@ -15,5 +15,4 @@ group :develop do
   gem "rspec", "~> 3.12"
   gem "rubocop", "~> 1.41"
   gem "rubocop-rspec", "~> 2.16", require: false
-  gem "standard", ">= 1.35.1"
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    Icarus-Mod-Tools (2.2.1)
+    Icarus-Mod-Tools (2.3.0)
       google-cloud-firestore (~> 2.7)
       octokit (~> 6.0)
       paint (~> 2.3)
@@ -199,7 +199,7 @@ GEM
       ffi (~> 1.0)
     rbtree (0.4.6)
     regexp_parser (2.11.3)
-    reline (0.6.2)
+    reline (0.6.3)
       io-console (~> 0.5)
     rspec (3.13.2)
       rspec-core (~> 3.13.0)
@@ -214,7 +214,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.6)
-    rubocop (1.80.2)
+    rubocop (1.81.7)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -222,7 +222,7 @@ GEM
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.46.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
     rubocop-ast (1.48.0)
@@ -234,10 +234,6 @@ GEM
     rubocop-factory_bot (2.27.1)
       lint_roller (~> 1.1)
       rubocop (~> 1.72, >= 1.72.1)
-    rubocop-performance (1.25.0)
-      lint_roller (~> 1.1)
-      rubocop (>= 1.75.0, < 2.0)
-      rubocop-ast (>= 1.38.0, < 2.0)
     rubocop-rspec (2.31.0)
       rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
@@ -255,18 +251,6 @@ GEM
       faraday (>= 0.17.5, < 3.a)
       jwt (>= 1.5, < 4.0)
       multi_json (~> 1.10)
-    standard (1.51.1)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.80.2)
-      standard-custom (~> 1.0.0)
-      standard-performance (~> 1.8)
-    standard-custom (1.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.50)
-    standard-performance (1.8.0)
-      lint_roller (~> 1.1)
-      rubocop-performance (~> 1.25.0)
     thor (1.4.0)
     unicode-display_width (3.2.0)
       unicode-emoji (~> 4.1)
@@ -296,7 +280,6 @@ DEPENDENCIES
   rspec (~> 3.12)
   rubocop (~> 1.41)
   rubocop-rspec (~> 2.16)
-  standard (>= 1.35.1)
 
 BUNDLED WITH
    2.6.9

data/README.md

@@ -58,6 +58,7 @@ Commands:
   imt add             # Adds entries to the databases
   imt help [COMMAND]  # Describe available commands or one specific command
   imt list            # Lists the databases
+  imt remove          # Removes entries from the databases
   imt sync            # Syncs the databases
   imt validate        # Validates various entries
 
@@ -104,6 +105,23 @@ Options:
                                    # Default: [true]
 ```
 
+#### `imt remove`
+
+```sh
+Commands:
+  imt remove help [COMMAND]  # Describe subcommands or one specific subcommand
+  imt remove modinfo ITEM    # Removes an entry from 'meta/modinfo/list'
+  imt remove toolinfo ITEM    # Removes an entry from 'meta/toolinfo/list'
+  imt remove repos REPO      # Removes an entry from 'meta/repos/list'
+
+Options:
+  -C, [--config=CONFIG]            # Path to the config file
+                                   # Default: /Users/dyoung/.imtconfig.json
+  -V, [--version], [--no-version]  # Print the version and exit
+  -v, [--verbose], [--no-verbose]  # Increase verbosity. May be repeated for even more verbosity.
+                                   # Default: [true]
+```
+
 #### `imt sync`
 
 ```sh
@@ -132,4 +150,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/DonovanMods/icarus-mod-tools.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/DonovanMods/icarus-mod-tools>.

data/Rakefile

@@ -3,10 +3,9 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 require "rspec/core/rake_task"
-require "standard/rake"
 
 RSpec::Core::RakeTask.new(:spec) do |task|
   task.rspec_opts = ["--color", "--format", "Fuubar"]
 end
 
-task default: %i[spec standard]
+task default: %i[spec]

data/lib/icarus/mod/cli/command.rb

@@ -5,6 +5,7 @@ require "cli/subcommand_base"
 require "cli/sync"
 require "cli/list"
 require "cli/add"
+require "cli/remove"
 require "cli/validate"
 
 module Icarus
@@ -37,6 +38,9 @@ module Icarus
         desc "add", "Adds entries to the databases"
         subcommand "add", Add
 
+        desc "remove", "Removes entries from the databases"
+        subcommand "remove", Remove
+
         desc "validate", "Validates various entries"
         subcommand "validate", Validate
       end

data/lib/icarus/mod/cli/remove.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "firestore"
+require "cli/subcommand_base"
+
+module Icarus
+  module Mod
+    module CLI
+      # Remove CLI command definitions
+      # rubocop:disable Style/GlobalVars
+      class Remove < SubcommandBase
+        class_option :dry_run, type: :boolean, default: false, desc: "Dry run (no changes will be made)"
+
+        desc "repos REPO", "Removes an entry from 'meta/repos/list'"
+        def repos(repo)
+          repo_name = repo.gsub(%r{https?://.*github\.com/}, "")
+          remove_item(
+            :repositories,
+            repo_name,
+            "Repository",
+            "Repository not found: #{repo_name}",
+            "Successfully removed repository: #{repo_name}",
+            "Failed to remove repository: #{repo_name}"
+          )
+        end
+
+        desc "modinfo ITEM", "Removes an entry from 'meta/modinfo/list'"
+        def modinfo(item)
+          remove_item(
+            :modinfo,
+            item,
+            "Modinfo entry",
+            "Modinfo entry not found: #{item}",
+            "Successfully removed modinfo entry: #{item}",
+            "Failed to remove modinfo entry: #{item}"
+          )
+        end
+
+        desc "toolinfo ITEM", "Removes an entry from 'meta/toolinfo/list'"
+        def toolinfo(item)
+          remove_item(
+            :toolinfo,
+            item,
+            "Toolinfo entry",
+            "Toolinfo entry not found: #{item}",
+            "Successfully removed toolinfo entry: #{item}",
+            "Failed to remove toolinfo entry: #{item}"
+          )
+        end
+
+        private
+
+        def remove_item(type, item, display_name, not_found_msg, success_msg, failure_msg)
+          # Check existence
+          collection = case type
+                       when :repositories then firestore.repositories
+                       when :modinfo     then firestore.modinfo
+                       when :toolinfo    then firestore.toolinfo
+                       else []
+                       end
+          unless collection.include?(item)
+            warn not_found_msg
+            exit 1
+          end
+
+          puts Paint["Removing #{display_name.downcase}: #{item}", :black] if verbose?
+
+          if options[:dry_run]
+            puts Paint["Dry run; no changes will be made", :yellow]
+            return
+          end
+
+          if firestore.delete(type, item)
+            puts Paint[success_msg, :green]
+          else
+            warn Paint[failure_msg, :red]
+            exit 1
+          end
+        end
+
+        def firestore
+          $firestore ||= Firestore.new
+        end
+      end
+      # rubocop:enable Style/GlobalVars
+    end
+  end
+end

data/lib/icarus/mod/cli/sync.rb

@@ -62,7 +62,7 @@ module Icarus
           end
 
           def sync_info(type)
-            sync = ((type == :modinfo) ? Icarus::Mod::Tools::Sync::ModinfoList : Icarus::Mod::Tools::Sync::ToolinfoList).new(client: firestore)
+            sync = (type == :modinfo ? Icarus::Mod::Tools::Sync::ModinfoList : Icarus::Mod::Tools::Sync::ToolinfoList).new(client: firestore)
 
             puts "Retrieving repository Data..." if verbose?
             repositories = sync.repositories
@@ -75,19 +75,21 @@ module Icarus
             raise Icarus::Mod::Tools::Error, "no .json files found for #{type}" unless info_array&.any?
 
             if options[:dry_run]
-              puts Paint["Dry run; no changes will be made", :orange, :bright]
+              puts Paint["Dry run; no changes will be made", :yellow]
               return
             end
 
             puts Paint["Saving to Firestore...", :black] if verbose?
             response = sync.update(info_array)
-            puts response ? Paint["Success", :green, :bright] : Paint["Failure (may be no changes)", :red, :bright] if verbose?
+            if verbose?
+              puts response ? Paint["Success", :green, :bright] : Paint["Failure (may be no changes)", :red, :bright]
+            end
           rescue Icarus::Mod::Tools::Error => e
             warn e.message
           end
 
           def sync_list(type)
-            sync = ((type == :mods) ? Icarus::Mod::Tools::Sync::Mods : Icarus::Mod::Tools::Sync::Tools).new(client: firestore)
+            sync = (type == :mods ? Icarus::Mod::Tools::Sync::Mods : Icarus::Mod::Tools::Sync::Tools).new(client: firestore)
 
             puts "Syncing #{type} to #{Config.firebase.collections.send(type)}" if verbose > 1
 
@@ -106,9 +108,7 @@ module Icarus
               puts "Validating Info Data for #{list.uniq_name}..." if verbose > 2
               unless list.valid?
                 warn Paint["Skipping List #{list.uniq_name} due to validation errors", :yellow, :bright]
-                if verbose > 1
-                  warn list.errors.map { |error| Paint[error, :red] }.join("\n")
-                end
+                warn list.errors.map { |error| Paint[error, :red] }.join("\n") if verbose > 1
 
                 next
               end
@@ -120,7 +120,10 @@ module Icarus
                 verb = "Updating"
               end
 
-              print format("#{verb} %-<name>60s", name: "'#{list.author || "NoOne"}/#{list.name || "Unnamed"}'") if verbose > 1
+              if verbose > 1
+                print format("#{verb} %-<name>60s",
+                             name: "'#{list.author || 'NoOne'}/#{list.name || 'Unnamed'}'")
+              end
 
               if options[:dry_run]
                 puts Paint["Dry run; no changes will be made", :yellow] if verbose > 1
@@ -144,7 +147,7 @@ module Icarus
 
             puts "Deleting outdated items..." if verbose?
             delete_array.each do |list|
-              print "Deleting '#{list.author || "NoOne"}/#{list.name || "Unnamed'"}'#{" " * 20}" if verbose > 1
+              print "Deleting '#{list.author || 'NoOne'}/#{list.name || 'Unnamed'}'#{' ' * 20}" if verbose > 1
               response = sync.delete(list)
               puts success_or_failure(status: response) if verbose > 1
             end

data/lib/icarus/mod/firestore.rb

@@ -48,16 +48,16 @@ module Icarus
         raise "You must specify a payload to update" if payload&.empty? || payload.nil?
 
         response = case type.to_sym
-        when :modinfo, :toolinfo
-          update_array = (send(type) + [payload]).flatten.uniq
-          @client.doc(collections.meta.send(type)).set({list: update_array}, merge:) if update_array.any?
-        when :repositories
-          @client.doc(collections.meta.repositories).set({list: payload}, merge:)
-        when :mod, :tool
-          create_or_update(pluralize(type), payload, merge:)
-        else
-          raise "Invalid type: #{type}"
-        end
+                   when :modinfo, :toolinfo
+                     update_array = (send(type) + [payload]).flatten.uniq
+                     @client.doc(collections.meta.send(type)).set({ list: update_array }, merge:) if update_array.any?
+                   when :repositories
+                     @client.doc(collections.meta.repositories).set({ list: payload }, merge:)
+                   when :mod, :tool
+                     create_or_update(pluralize(type), payload, merge:)
+                   else
+                     raise "Invalid type: #{type}"
+                   end
 
         response.is_a?(Google::Cloud::Firestore::DocumentReference) || response.is_a?(Google::Cloud::Firestore::CommitResponse::WriteResult)
       end
@@ -66,6 +66,12 @@ module Icarus
         case type.to_sym
         when :mod, :tool
           response = @client.doc("#{collections.send(pluralize(type))}/#{payload.id}").delete
+        when :modinfo, :toolinfo, :repositories
+          update_array = (send(type) - [payload]).flatten.uniq
+
+          response = @client.doc(collections.meta.send(type)).set({ list: update_array })
+          # Invalidate cache if Firestore update was successful
+          instance_variable_set(:"@#{type}", update_array) if response.is_a?(Google::Cloud::Firestore::CommitResponse::WriteResult)
         else
           raise "Invalid type: #{type}"
         end
@@ -81,7 +87,7 @@ module Icarus
           @client.doc(collections.meta.send(type)).get[:list]
         when :mods, :tools
           @client.col(collections.send(type)).get.map do |doc|
-            klass = (type == :mods) ? Icarus::Mod::Tools::Modinfo : Icarus::Mod::Tools::Toolinfo
+            klass = type == :mods ? Icarus::Mod::Tools::Modinfo : Icarus::Mod::Tools::Toolinfo
             klass.new(doc.data, id: doc.document_id, created: doc.create_time, updated: doc.update_time)
           end
         else

data/lib/icarus/mod/version.rb

@@ -2,6 +2,6 @@
 
 module Icarus
   module Mod
-    VERSION = "2.2.1"
+    VERSION = "2.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Icarus-Mod-Tools
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Donovan Young
@@ -73,11 +73,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".claude/settings.local.json"
 - ".rspec"
 - ".ruby-version"
-- ".standard.yml"
-- ".standard_rubocop_extensions.yml"
 - CHANGELOG.md
+- CLAUDE.md
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -91,6 +91,7 @@ files:
 - lib/icarus/mod/cli/base.rb
 - lib/icarus/mod/cli/command.rb
 - lib/icarus/mod/cli/list.rb
+- lib/icarus/mod/cli/remove.rb
 - lib/icarus/mod/cli/subcommand_base.rb
 - lib/icarus/mod/cli/sync.rb
 - lib/icarus/mod/cli/validate.rb

data/.standard.yml

@@ -1,2 +0,0 @@
-extend_config:
-  - .standard_rubocop_extensions.yml

data/.standard_rubocop_extensions.yml

@@ -1,10 +0,0 @@
-require:
-  - rubocop-rspec
-
-AllCops:
-  TargetRubyVersion: 3.1
-  NewCops: enable
-  SuggestExtensions: false
-
-RSpec/MultipleMemoizedHelpers:
-  Max: 10