Icarus-Mod-Tools 1.8.1 → 1.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d70aff1f7ed368044b414fdca605fa438e0fbfe68c2af436d534a233fc6bff17
-  data.tar.gz: e4467d443894344c50a2c3c663e262afd7e54cc806da308ecd16d732bcd2c844
+  metadata.gz: 63aa634da9108a8b439681f4bce95519bd04ba0e2cc416c5c2632502e8aa3c35
+  data.tar.gz: dce88dc6da4c3c43199973de099c7a578641ce03082bbac2a8943fcd69e6aa40
 SHA512:
-  metadata.gz: 26c83360237ab149e6738e60966df113f8ede55460f85b0b2de29dd690cea238cdfda8af0ffc70f288ca58765b535d18b2cfcb21e0619b0a8226bfe099e7fecc
-  data.tar.gz: 278435526ede69d45383920bee07fc3fc094924d022ed55c54141d00e9b53ef003d7688fb26bc4f251e3b13705b743013875583d553ca8c22198a7daeb590238
+  metadata.gz: 030db22ed72e78fec9a03a6f5412d35143492cd19080095b59efcafb47feb3db78b4a5cafc04edc1880e626f30d6127d35a470a7998ffe4403873672bf4002d0
+  data.tar.gz: 025040c5268bc151ea186573fb21dc083c51d4e9a5b5666fad8c988642aabbe4fe515fb882fe4ba0c03500357a8ea37cd868cfe1f1b5dc25c1f4456066f8d4d2

data/CHANGES.md

@@ -4,19 +4,29 @@ All notable changes to this project will be documented in this file.
 
 ## History (reverse chronological order)
 
-### v1.6 - 2023-15
+### v1.8 - 2023-01-27
+
+- Added support for `proginfo.json` files
+- Refactored to better utilize caching
+
+### v1.7 - 2023-01-20
+
+- Added `validation` command
+- Added `--dry-run` to `sync` commands
+
+### v1.6 - 2023-01-15
 
 - Added `--check` to `sync mods` to check for updates without downloading
 - Added support for `readmeURL` in `modinfo.json`
 
-### v1.5 - 2023-08
+### v1.5 - 2023-01-08
 
 - Moved source into the DonovanMods Github organization
 - Added `long_description` to `modinfo.json`
 - Added `imageURL` to `modinfo.json`
 - bugfixes
 
-### v1.4 - 2023-03
+### v1.4 - 2023-01-03
 
 **BREAKING CHANGES!**
 
@@ -25,7 +35,7 @@ You'll need to move your ENV variables to a config file. See the README for more
 - Read configuration from `~/.imtconfig.json`
 - bugfixes
 
-### v1.3 - 2023-02
+### v1.3 - 2023-01-02
 
 - First public release
 - Added sorting and filtering to the `list mods` command

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    Icarus-Mod-Tools (1.8.1)
+    Icarus-Mod-Tools (1.8.2)
       google-cloud-firestore (~> 2.7)
       octokit (~> 6.0)
       paint (~> 2.3)

data/README.md

@@ -52,9 +52,17 @@ imt [options] [command]
 ### Commands
 
 ```sh
+Commands:
   imt add             # Adds entries to the databases
+  imt help [COMMAND]  # Describe available commands or one specific command
   imt list            # Lists the databases
   imt sync            # Syncs the databases
+  imt validate        # Validates various entries
+
+Options:
+  -C, [--config=CONFIG]            # Path to the config file
+                                   # Default: /Users/dyoung/.imtconfig.json
+  -V, [--version], [--no-version]  # Print the version and exit
 ```
 
 #### `imt add`
@@ -63,9 +71,13 @@ imt [options] [command]
 Commands:
   imt add help [COMMAND]  # Describe subcommands or one specific subcommand
   imt add modinfo         # Adds an entry to 'meta/modinfo/list'
+  imt add proginfo        # Adds an entry to 'meta/proginfo/list'
   imt add repos           # Adds an entry to '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]
 ```
@@ -77,9 +89,14 @@ Commands:
   imt list help [COMMAND]  # Describe subcommands or one specific subcommand
   imt list modinfo         # Displays data from 'meta/modinfo/list'
   imt list mods            # Displays data from 'mods'
+  imt list proginfo        # Displays data from 'meta/proginfo/list'
+  imt list progs           # Displays data from 'progs'
   imt list repos           # Displays data 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]
 ```
@@ -88,13 +105,20 @@ Options:
 
 ```sh
 Commands:
+  imt sync all             # Run all sync jobs
   imt sync help [COMMAND]  # Describe subcommands or one specific subcommand
   imt sync modinfo         # Reads from 'meta/repos/list' and Syncs any modinfo files we find (github only for now)
   imt sync mods            # Reads from 'meta/modinfo/list' and updates the 'mods' database accordingly
+  imt sync proginfo        # Reads from 'meta/repos/list' and Syncs any proginfo files we find (github only for now)
+  imt sync progs           # Reads from 'meta/proginfo/list' and updates the 'progs' database accordingly
 
 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]
+      [--dry-run], [--no-dry-run]  # Dry run (no changes will be made)
 ```
 
 ## Development

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

@@ -1,15 +1,18 @@
 # frozen_string_literal: true
 
-require "tools/modinfo_sync"
-require "tools/proginfo_sync"
-require "tools/mod_sync"
-require "tools/prog_sync"
+require "tools/sync/modinfo"
+require "tools/sync/proginfo"
+require "tools/sync/mods"
+require "tools/sync/progs"
 
 module Icarus
   module Mod
     module CLI
       # Sync CLI command definitions
+      # rubocop:disable Style/GlobalVars
       class Sync < SubcommandBase
+        $firestore = nil
+
         class_option :dry_run, type: :boolean, default: false, desc: "Dry run (no changes will be made)"
 
         desc "all", "Run all sync jobs"
@@ -43,8 +46,12 @@ module Icarus
         end
 
         no_commands do
+          def firestore
+            $firestore ||= Firestore.new
+          end
+
           def sync_info(type)
-            sync = (type == :modinfo ? Icarus::Mod::Tools::ModinfoSync : Icarus::Mod::Tools::ProginfoSync).new
+            sync = (type == :modinfo ? Icarus::Mod::Tools::Sync::Modinfo : Icarus::Mod::Tools::Sync::Proginfo).new(client: firestore)
 
             puts "Retrieving repository Data..." if verbose?
             repositories = sync.repositories
@@ -69,7 +76,7 @@ module Icarus
           end
 
           def sync_list(type)
-            sync = (type == :mods ? Icarus::Mod::Tools::ModSync : Icarus::Mod::Tools::ProgSync).new
+            sync = (type == :mods ? Icarus::Mod::Tools::Sync::Mods : Icarus::Mod::Tools::Sync::Progs).new(client: firestore)
 
             puts "Retrieving Info Data..." if verbose?
             info_array = sync.info_array
@@ -128,6 +135,7 @@ module Icarus
           end
         end
       end
+      # rubocop:enable Style/GlobalVars
     end
   end
 end

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

@@ -25,6 +25,7 @@ module Icarus
             puts "Validating Entries..." if verbose?
             max_length = validator.array.map { |info| info.uniq_name.length }.max + 1
 
+            # rubocop:disable Lint/FormatParameterMismatch
             validator.array.each do |info|
               print Paint[format("%s %-#{max_length}s", "Running validation steps on", info.uniq_name), :cyan, :bright] if verbose > 1
 
@@ -46,6 +47,7 @@ module Icarus
               puts info.warnings.map { |warning| Paint["#{warning} in #{info.uniq_name}", :yellow] }.join("\n")
               puts "\n" if verbose > 1
             end
+            # rubocop:enable Lint/FormatParameterMismatch
 
             exit exit_code
           end

data/lib/icarus/mod/firestore.rb

@@ -19,12 +19,12 @@ module Icarus
         @repos ||= list(:repositories)
       end
 
-      def modinfo_list
-        @modinfo_list ||= list(:modinfo)
+      def modinfo
+        @modinfo ||= list(:modinfo)
       end
 
-      def proginfo_list
-        @proginfo_list ||= list(:proginfo)
+      def proginfo
+        @proginfo ||= list(:proginfo)
       end
 
       def mods
@@ -72,7 +72,7 @@ module Icarus
 
         case type.to_sym
         when :modinfo, :proginfo
-          update_array = (send("#{type}_list") + [payload]).flatten.uniq
+          update_array = (send(type) + [payload]).flatten.uniq
           response = @client.doc(collections.send(type)).set({ list: update_array }, merge:) if update_array.any?
         when :repositories
           response = @client.doc(collections.repositories).set({ list: payload }, merge:)

data/lib/icarus/mod/tools/sync/helpers.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "uri"
+require "net/http"
+require "json"
+
+module Icarus
+  module Mod
+    module Tools
+      module Sync
+        class RequestFailed < StandardError; end
+
+        # Sync helper methods
+        module Helpers
+          def retrieve_from_url(url)
+            res = Net::HTTP.get_response(URI(url))
+
+            raise RequestFailed, "HTTP Request failed for #{url} (#{res.code}): #{res.message}" unless res&.code == "200"
+
+            JSON.parse(res.body, symbolize_names: true)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/icarus/mod/tools/sync/modinfo.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "firestore"
+require "github"
+require "tools/sync/helpers"
+
+module Icarus
+  module Mod
+    module Tools
+      module Sync
+        # Sync methods
+        class Modinfo
+          include Helpers
+
+          def initialize(client: nil)
+            @firestore = client || Firestore.new
+            @github = Github.new
+            @repositories = []
+          end
+
+          def repositories
+            @firestore.repos
+          end
+
+          def update(modinfo_array)
+            @firestore.update(:modinfo, modinfo_array)
+          end
+
+          def modinfo(url)
+            retrieve_from_url(url)
+          end
+
+          def data(repositories, verbose: false)
+            repositories.map do |repo|
+              print "searching #{repo}..." if verbose
+
+              case repo
+              when /github/
+                @github.repository = repo
+                modinfo_url = @github.find("modinfo.json")
+
+                unless modinfo_url
+                  puts "Skipped...no modinfo.json" if verbose
+                  next
+                end
+
+                puts "Found!" if verbose
+                modinfo_url
+              else
+                puts "Skipped...repository type not supported yet" if verbose
+              end
+            end.compact
+          end
+        end
+      end
+    end
+  end
+end

data/lib/icarus/mod/tools/sync/mods.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "firestore"
+require "tools/sync/helpers"
+
+module Icarus
+  module Mod
+    module Tools
+      module Sync
+        # Sync methods
+        class Mods
+          include Helpers
+
+          def initialize(client: nil)
+            @firestore = client || Firestore.new
+          end
+
+          def mods
+            @firestore.mods
+          end
+
+          def info_array
+            @info_array ||= @firestore.modinfo.map do |url|
+              retrieve_from_url(url)[:mods].map { |mod| Tools::Modinfo.new(mod) if mod[:name] =~ /[a-z0-9]+/i }
+            rescue Icarus::Mod::Tools::Sync::RequestFailed
+              warn "Skipped; Failed to retrieve #{url}"
+              next
+            rescue JSON::ParserError => e
+              warn "Skipped; Invalid JSON: #{e.full_message}"
+              next
+            end.flatten.compact
+          end
+
+          def find(modinfo)
+            @firestore.find_by_type(type: "mods", name: modinfo.name, author: modinfo.author)&.id
+          end
+
+          def find_info(modinfo)
+            @info_array.find { |mod| mod.name == modinfo.name }
+          end
+
+          def update(modinfo)
+            @firestore.update(:mod, modinfo, merge: false)
+          end
+
+          def delete(modinfo)
+            @firestore.delete(:mod, modinfo)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/icarus/mod/tools/sync/proginfo.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "firestore"
+require "github"
+require "tools/sync/helpers"
+
+module Icarus
+  module Mod
+    module Tools
+      module Sync
+        # Sync methods
+        class Proginfo
+          include Helpers
+
+          def initialize(client: nil)
+            @firestore = client || Firestore.new
+            @github = Github.new
+            @repositories = []
+          end
+
+          def repositories
+            @firestore.repos
+          end
+
+          def update(proginfo_array)
+            @firestore.update(:proginfo, proginfo_array)
+          end
+
+          def proginfo(url)
+            retrieve_from_url(url)
+          end
+
+          def data(repositories, verbose: false)
+            repositories.map do |repo|
+              print "searching #{repo}..." if verbose
+
+              case repo
+              when /github/
+                @github.repository = repo
+                proginfo_url = @github.find("proginfo.json")
+
+                unless proginfo_url
+                  puts "Skipped...no proginfo.json" if verbose
+                  next
+                end
+
+                puts "Found!" if verbose
+                proginfo_url
+              else
+                puts "Skipped...repository type not supported yet" if verbose
+              end
+            end.compact
+          end
+        end
+      end
+    end
+  end
+end

data/lib/icarus/mod/tools/sync/progs.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "firestore"
+require "tools/sync/helpers"
+
+module Icarus
+  module Mod
+    module Tools
+      module Sync
+        # Sync methods
+        class Progs
+          include Helpers
+
+          def initialize(client: nil)
+            @firestore = client || Firestore.new
+          end
+
+          def progs
+            @firestore.progs
+          end
+
+          def info_array
+            @info_array ||= @firestore.proginfo.map do |url|
+              retrieve_from_url(url)[:programs].map { |prog| Tools::Proginfo.new(prog) if prog[:name] =~ /[a-z0-9]+/i }
+            rescue Icarus::Mod::Tools::Sync::RequestFailed
+              warn "Skipped; Failed to retrieve #{url}"
+              next
+            rescue JSON::ParserError => e
+              warn "Skipped; Invalid JSON: #{e.full_message}"
+              next
+            end.flatten.compact
+          end
+
+          def find(proginfo)
+            @firestore.find_by_type(type: "progs", name: proginfo.name, author: proginfo.author)&.id
+          end
+
+          def find_info(proginfo)
+            @info_array.find { |prog| prog.name == proginfo.name }
+          end
+
+          def update(proginfo)
+            @firestore.update(:prog, proginfo, merge: false)
+          end
+
+          def delete(proginfo)
+            @firestore.delete(:prog, proginfo)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/icarus/mod/tools/validator.rb

@@ -10,9 +10,9 @@ module Icarus
         def initialize(type)
           @array = case type
                    when :modinfo
-                     ModSync.new.info_array
+                     Sync::Mods.new.info_array
                    when :proginfo
-                     ProgSync.new.info_array
+                     Sync::Progs.new.info_array
                    else
                      raise ArgumentError, "Invalid type: #{type}"
                    end

data/lib/icarus/mod/version.rb

@@ -2,6 +2,6 @@
 
 module Icarus
   module Mod
-    VERSION = "1.8.1"
+    VERSION = "1.8.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Icarus-Mod-Tools
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.8.2
 platform: ruby
 authors:
 - Donovan Young
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-27 00:00:00.000000000 Z
+date: 2023-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-firestore
@@ -98,13 +98,13 @@ files:
 - lib/icarus/mod/github.rb
 - lib/icarus/mod/tools.rb
 - lib/icarus/mod/tools/baseinfo.rb
-- lib/icarus/mod/tools/mod_sync.rb
 - lib/icarus/mod/tools/modinfo.rb
-- lib/icarus/mod/tools/modinfo_sync.rb
-- lib/icarus/mod/tools/prog_sync.rb
 - lib/icarus/mod/tools/proginfo.rb
-- lib/icarus/mod/tools/proginfo_sync.rb
-- lib/icarus/mod/tools/sync_helpers.rb
+- lib/icarus/mod/tools/sync/helpers.rb
+- lib/icarus/mod/tools/sync/modinfo.rb
+- lib/icarus/mod/tools/sync/mods.rb
+- lib/icarus/mod/tools/sync/proginfo.rb
+- lib/icarus/mod/tools/sync/progs.rb
 - lib/icarus/mod/tools/validator.rb
 - lib/icarus/mod/version.rb
 - sig/database/sync/sync.rbs

data/lib/icarus/mod/tools/mod_sync.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require "firestore"
-require "tools/sync_helpers"
-
-module Icarus
-  module Mod
-    module Tools
-      # Sync methods
-      class ModSync
-        include SyncHelpers
-
-        def initialize
-          @firestore = Firestore.new
-        end
-
-        def mods
-          @firestore.mods
-        end
-
-        def info_array
-          @info_array ||= @firestore.modinfo_list.map do |url|
-            retrieve_from_url(url)[:mods].map { |mod| Modinfo.new(mod) if mod[:name] =~ /[a-z0-9]+/i }
-          rescue Icarus::Mod::Tools::RequestFailed
-            warn "Skipped; Failed to retrieve #{url}"
-            next
-          rescue JSON::ParserError => e
-            warn "Skipped; Invalid JSON: #{e.full_message}"
-            next
-          end.flatten.compact
-        end
-
-        def find(modinfo)
-          @firestore.find_by_type(type: "mods", name: modinfo.name, author: modinfo.author)&.id
-        end
-
-        def find_info(modinfo)
-          @info_array.find { |mod| mod.name == modinfo.name }
-        end
-
-        def update(modinfo)
-          @firestore.update(:mod, modinfo, merge: false)
-        end
-
-        def delete(modinfo)
-          @firestore.delete(:mod, modinfo)
-        end
-      end
-    end
-  end
-end

data/lib/icarus/mod/tools/modinfo_sync.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-require "firestore"
-require "github"
-require "tools/sync_helpers"
-
-module Icarus
-  module Mod
-    module Tools
-      # Sync methods
-      class ModinfoSync
-        include SyncHelpers
-
-        def initialize
-          @firestore = Firestore.new
-          @github = Github.new
-          @repositories = []
-        end
-
-        def repositories
-          @firestore.repos
-        end
-
-        def update(modinfo_array)
-          @firestore.update(:modinfo, modinfo_array)
-        end
-
-        def modinfo(url)
-          retrieve_from_url(url)
-        end
-
-        def data(repositories, verbose: false)
-          repositories.map do |repo|
-            print "searching #{repo}..." if verbose
-
-            case repo
-            when /github/
-              @github.repository = repo
-              modinfo_url = @github.find("modinfo.json")
-
-              unless modinfo_url
-                puts "Skipped...no modinfo.json" if verbose
-                next
-              end
-
-              puts "Found!" if verbose
-              modinfo_url
-            else
-              puts "Skipped...repository type not supported yet" if verbose
-            end
-          end.compact
-        end
-      end
-    end
-  end
-end

data/lib/icarus/mod/tools/prog_sync.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require "firestore"
-require "tools/sync_helpers"
-
-module Icarus
-  module Mod
-    module Tools
-      # Sync methods
-      class ProgSync
-        include SyncHelpers
-
-        def initialize
-          @firestore = Firestore.new
-        end
-
-        def progs
-          @firestore.progs
-        end
-
-        def info_array
-          @info_array ||= @firestore.proginfo_list.map do |url|
-            retrieve_from_url(url)[:programs].map { |prog| Proginfo.new(prog) if prog[:name] =~ /[a-z0-9]+/i }
-          rescue Icarus::Mod::Tools::RequestFailed
-            warn "Skipped; Failed to retrieve #{url}"
-            next
-          rescue JSON::ParserError => e
-            warn "Skipped; Invalid JSON: #{e.full_message}"
-            next
-          end.flatten.compact
-        end
-
-        def find(proginfo)
-          @firestore.find_by_type(type: "progs", name: proginfo.name, author: proginfo.author)&.id
-        end
-
-        def find_info(proginfo)
-          @info_array.find { |prog| prog.name == proginfo.name }
-        end
-
-        def update(proginfo)
-          @firestore.update(:prog, proginfo, merge: false)
-        end
-
-        def delete(proginfo)
-          @firestore.delete(:prog, proginfo)
-        end
-      end
-    end
-  end
-end

data/lib/icarus/mod/tools/proginfo_sync.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-require "firestore"
-require "github"
-require "tools/sync_helpers"
-
-module Icarus
-  module Mod
-    module Tools
-      # Sync methods
-      class ProginfoSync
-        include SyncHelpers
-
-        def initialize
-          @firestore = Firestore.new
-          @github = Github.new
-          @repositories = []
-        end
-
-        def repositories
-          @firestore.repos
-        end
-
-        def update(proginfo_array)
-          @firestore.update(:proginfo, proginfo_array)
-        end
-
-        def proginfo(url)
-          retrieve_from_url(url)
-        end
-
-        def data(repositories, verbose: false)
-          repositories.map do |repo|
-            print "searching #{repo}..." if verbose
-
-            case repo
-            when /github/
-              @github.repository = repo
-              proginfo_url = @github.find("proginfo.json")
-
-              unless proginfo_url
-                puts "Skipped...no proginfo.json" if verbose
-                next
-              end
-
-              puts "Found!" if verbose
-              proginfo_url
-            else
-              puts "Skipped...repository type not supported yet" if verbose
-            end
-          end.compact
-        end
-      end
-    end
-  end
-end

data/lib/icarus/mod/tools/sync_helpers.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require "uri"
-require "net/http"
-require "json"
-
-module Icarus
-  module Mod
-    module Tools
-      class RequestFailed < StandardError; end
-
-      # Sync helper methods
-      module SyncHelpers
-        def retrieve_from_url(url)
-          res = Net::HTTP.get_response(URI(url))
-
-          raise Icarus::Mod::Tools::RequestFailed, "HTTP Request failed for #{url} (#{res.code}): #{res.message}" unless res&.code == "200"
-
-          JSON.parse(res.body, symbolize_names: true)
-        end
-      end
-    end
-  end
-end