Icarus-Mod-Tools 1.8.2 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63aa634da9108a8b439681f4bce95519bd04ba0e2cc416c5c2632502e8aa3c35
-  data.tar.gz: dce88dc6da4c3c43199973de099c7a578641ce03082bbac2a8943fcd69e6aa40
+  metadata.gz: 9fba522a3f41d8d1c77402e95f59684594bb7be97a8227966e4b647777152f05
+  data.tar.gz: 933ee795c5f13f964e1a866c0ce06549912c6e99c06c78fd687e5c25886bf148
 SHA512:
-  metadata.gz: 030db22ed72e78fec9a03a6f5412d35143492cd19080095b59efcafb47feb3db78b4a5cafc04edc1880e626f30d6127d35a470a7998ffe4403873672bf4002d0
-  data.tar.gz: 025040c5268bc151ea186573fb21dc083c51d4e9a5b5666fad8c988642aabbe4fe515fb882fe4ba0c03500357a8ea37cd868cfe1f1b5dc25c1f4456066f8d4d2
+  metadata.gz: 0cd6a08a77be86801059b2b63a81fb662583ca404391afa2fd9544dbda8549e0652ce4c7db9a5ff64edb04afd07b50b742e1473861639ea190eddd22dda70f03
+  data.tar.gz: 1f28bff449d31ea47fa9166586dd10b996c466ed898ff53449a2cfd84fff98a5454418214fa479fa9976c0700ca88b12724c8b1f166b059093658d32862ee938

data/CHANGES.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 
 ## History (reverse chronological order)
 
+### v1.9 - 2023-01-28
+
+- Renamed `Progs` to `Tools`
+
 ### v1.8 - 2023-01-27
 
 - Added support for `proginfo.json` files

data/Gemfile.lock

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

data/README.md

@@ -71,7 +71,7 @@ Options:
 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 toolinfo        # Adds an entry to 'meta/toolinfo/list'
   imt add repos           # Adds an entry to 'meta/repos/list'
 
 Options:
@@ -89,8 +89,8 @@ 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 toolinfo        # Displays data from 'meta/toolinfo/list'
+  imt list tools           # Displays data from 'tools'
   imt list repos           # Displays data from 'meta/repos/list'
 
 Options:
@@ -109,8 +109,8 @@ Commands:
   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
+  imt sync toolinfo        # Reads from 'meta/repos/list' and Syncs any toolinfo files we find (github only for now)
+  imt sync tools           # Reads from 'meta/toolinfo/list' and updates the 'tools' database accordingly
 
 Options:
   -C, [--config=CONFIG]            # Path to the config file

data/imtconfig.sample.json

@@ -14,10 +14,10 @@
     },
     "collections": {
       "modinfo": "meta/modinfo",
-      "proginfo": "meta/proginfo",
+      "toolinfo": "meta/toolinfo",
       "repositories": "meta/repos",
       "mods": "mods",
-      "progs": "progs"
+      "tools": "tools"
     }
   },
   "github": {

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

@@ -15,12 +15,12 @@ module Icarus
           puts firestore.update(:modinfo, payload, merge: true) ? "Success" : "Failure"
         end
 
-        desc "proginfo", "Adds an entry to 'meta/proginfo/list'"
-        def proginfo(item)
+        desc "toolinfo", "Adds an entry to 'meta/toolinfo/list'"
+        def toolinfo(item)
           firestore = Firestore.new
-          payload = [firestore.list(:proginfo), item].flatten.compact
+          payload = [firestore.list(:toolinfo), item].flatten.compact
 
-          puts firestore.update(:proginfo, payload, merge: true) ? "Success" : "Failure"
+          puts firestore.update(:toolinfo, payload, merge: true) ? "Success" : "Failure"
         end
 
         desc "repos", "Adds an entry to 'meta/repos/list'"

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

@@ -15,11 +15,11 @@ module Icarus
           puts "Total: #{modinfo_array.count}" if verbose > 1
         end
 
-        desc "proginfo", "Displays data from 'meta/proginfo/list'"
-        def proginfo
-          proginfo_array = Firestore.new.list(:proginfo)
-          puts proginfo_array
-          puts "Total: #{proginfo_array.count}" if verbose > 1
+        desc "toolinfo", "Displays data from 'meta/toolinfo/list'"
+        def toolinfo
+          toolinfo_array = Firestore.new.list(:toolinfo)
+          puts toolinfo_array
+          puts "Total: #{toolinfo_array.count}" if verbose > 1
         end
 
         desc "repos", "Displays data from 'meta/repos/list'"
@@ -36,16 +36,16 @@ module Icarus
           list_for_type(:mods)
         end
 
-        desc "progs", "Displays data from 'progs'"
+        desc "tools", "Displays data from 'tools'"
         method_option :sort, type: :string, default: "name", desc: "Sort by field (name, author, etc.)"
         method_option :filter, type: :array, default: [], desc: "Filter by field (name, author, etc.)"
-        def progs
-          list_for_type(:progs)
+        def tools
+          list_for_type(:tools)
         end
 
         no_commands do
           def list_for_type(type)
-            klass = type == :mods ? Icarus::Mod::Tools::Modinfo : Icarus::Mod::Tools::Proginfo
+            klass = type == :mods ? Icarus::Mod::Tools::Modinfo : Icarus::Mod::Tools::Toolinfo
             valid_keys = klass::HASHKEYS + [:updated_at]
             sort_field = options[:sort]&.to_sym
             filter     = !options[:filter].empty?

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require "tools/sync/modinfo"
-require "tools/sync/proginfo"
+require "tools/sync/modinfo_list"
+require "tools/sync/toolinfo_list"
 require "tools/sync/mods"
-require "tools/sync/progs"
+require "tools/sync/tools"
 
 module Icarus
   module Mod
@@ -17,9 +17,16 @@ module Icarus
 
         desc "all", "Run all sync jobs"
         def all
-          invoke :proginfo
-          invoke :progs
+          puts "Running Toolinfo Sync..." if verbose?
+          invoke :toolinfo
+
+          puts "Running Tools Sync..." if verbose?
+          invoke :tools
+
+          puts "Running Modinfo Sync..." if verbose?
           invoke :modinfo
+
+          puts "Running Mods Sync..." if verbose?
           invoke :mods
         end
 
@@ -28,9 +35,9 @@ module Icarus
           sync_info(:modinfo)
         end
 
-        desc "proginfo", "Reads from 'meta/repos/list' and Syncs any proginfo files we find (github only for now)"
-        def proginfo
-          sync_info(:proginfo)
+        desc "toolinfo", "Reads from 'meta/repos/list' and Syncs any toolinfo files we find (github only for now)"
+        def toolinfo
+          sync_info(:toolinfo)
         end
 
         desc "mods", "Reads from 'meta/modinfo/list' and updates the 'mods' database accordingly"
@@ -39,10 +46,10 @@ module Icarus
           sync_list(:mods)
         end
 
-        desc "progs", "Reads from 'meta/proginfo/list' and updates the 'progs' database accordingly"
-        method_option :check, type: :boolean, default: false, desc: "Validate proginfo without applying changes"
-        def progs
-          sync_list(:progs)
+        desc "tools", "Reads from 'meta/toolinfo/list' and updates the 'tools' database accordingly"
+        method_option :check, type: :boolean, default: false, desc: "Validate toolinfo without applying changes"
+        def tools
+          sync_list(:tools)
         end
 
         no_commands do
@@ -51,7 +58,7 @@ module Icarus
           end
 
           def sync_info(type)
-            sync = (type == :modinfo ? Icarus::Mod::Tools::Sync::Modinfo : Icarus::Mod::Tools::Sync::Proginfo).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
@@ -76,7 +83,7 @@ module Icarus
           end
 
           def sync_list(type)
-            sync = (type == :mods ? Icarus::Mod::Tools::Sync::Mods : Icarus::Mod::Tools::Sync::Progs).new(client: firestore)
+            sync = (type == :mods ? Icarus::Mod::Tools::Sync::Mods : Icarus::Mod::Tools::Sync::Tools).new(client: firestore)
 
             puts "Retrieving Info Data..." if verbose?
             info_array = sync.info_array

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

@@ -12,9 +12,9 @@ module Icarus
           validate(:modinfo)
         end
 
-        desc "proginfo", "Reads proginfo data from 'meta/proginfo/list' and Validates syntax of progfiles"
-        def proginfo
-          validate(:proginfo)
+        desc "toolinfo", "Reads Toolinfo data from 'meta/toolinfo/list' and Validates syntax of toolfiles"
+        def toolinfo
+          validate(:toolinfo)
         end
 
         no_commands do

data/lib/icarus/mod/firestore.rb

@@ -2,7 +2,7 @@
 
 require "google/cloud/firestore"
 require "tools/modinfo"
-require "tools/proginfo"
+require "tools/toolinfo"
 
 module Icarus
   module Mod
@@ -23,16 +23,16 @@ module Icarus
         @modinfo ||= list(:modinfo)
       end
 
-      def proginfo
-        @proginfo ||= list(:proginfo)
+      def toolinfo
+        @toolinfo ||= list(:toolinfo)
       end
 
       def mods
         @mods ||= list(:mods)
       end
 
-      def progs
-        @progs ||= list(:progs)
+      def tools
+        @tools ||= list(:tools)
       end
 
       def find_by_type(type:, name:, author:)
@@ -47,11 +47,11 @@ module Icarus
 
       def list(type)
         case type.to_sym
-        when :modinfo, :proginfo, :repositories
+        when :modinfo, :toolinfo, :repositories
           get_list(type)
-        when :mods, :progs
+        when :mods, :tools
           @client.col(collections.send(type)).get.map do |doc|
-            klass = type == :mods ? Icarus::Mod::Tools::Modinfo : Icarus::Mod::Tools::Proginfo
+            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
@@ -71,12 +71,12 @@ module Icarus
         raise "You must specify a payload to update" if payload&.empty? || payload.nil?
 
         case type.to_sym
-        when :modinfo, :proginfo
+        when :modinfo, :toolinfo
           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:)
-        when :mod, :prog
+        when :mod, :tool
           response = update_or_create(pluralize(type), payload, merge:)
         else
           raise "Invalid type: #{type}"
@@ -87,7 +87,7 @@ module Icarus
 
       def delete(type, payload)
         case type.to_sym
-        when :mod, :prog
+        when :mod, :tool
           response = @client.doc("#{collections.send(pluralize(type))}/#{payload.id}").delete
         else
           raise "Invalid type: #{type}"

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

@@ -3,7 +3,7 @@
 module Icarus
   module Mod
     module Tools
-      # Base class for Modinfo and Proginfo
+      # Base class for Modinfo and Toolinfo
       class Baseinfo
         attr_reader :data, :id, :created_at, :updated_at
 

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

@@ -13,6 +13,8 @@ module Icarus
         # Sync helper methods
         module Helpers
           def retrieve_from_url(url)
+            raise RequestFailed, "Invalid URI: '#{url}'" unless url && url =~ URI::DEFAULT_PARSER.make_regexp
+
             res = Net::HTTP.get_response(URI(url))
 
             raise RequestFailed, "HTTP Request failed for #{url} (#{res.code}): #{res.message}" unless res&.code == "200"

data/lib/icarus/mod/tools/sync/{modinfo.rb → modinfo_list.rb}

@@ -9,7 +9,7 @@ module Icarus
     module Tools
       module Sync
         # Sync methods
-        class Modinfo
+        class ModinfoList
           include Helpers
 
           def initialize(client: nil)

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

@@ -21,7 +21,7 @@ module Icarus
 
           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 }
+              retrieve_from_url(url)[:mods].map { |mod| Icarus::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

data/lib/icarus/mod/tools/sync/{proginfo.rb → toolinfo_list.rb}

@@ -9,7 +9,7 @@ module Icarus
     module Tools
       module Sync
         # Sync methods
-        class Proginfo
+        class ToolinfoList
           include Helpers
 
           def initialize(client: nil)
@@ -22,11 +22,11 @@ module Icarus
             @firestore.repos
           end
 
-          def update(proginfo_array)
-            @firestore.update(:proginfo, proginfo_array)
+          def update(toolinfo_array)
+            @firestore.update(:toolinfo, toolinfo_array)
           end
 
-          def proginfo(url)
+          def toolinfo(url)
             retrieve_from_url(url)
           end
 
@@ -37,15 +37,15 @@ module Icarus
               case repo
               when /github/
                 @github.repository = repo
-                proginfo_url = @github.find("proginfo.json")
+                toolinfo_url = @github.find("toolinfo.json")
 
-                unless proginfo_url
-                  puts "Skipped...no proginfo.json" if verbose
+                unless toolinfo_url
+                  puts "Skipped...no toolinfo.json" if verbose
                   next
                 end
 
                 puts "Found!" if verbose
-                proginfo_url
+                toolinfo_url
               else
                 puts "Skipped...repository type not supported yet" if verbose
               end

data/lib/icarus/mod/tools/sync/{progs.rb → tools.rb}

@@ -8,20 +8,22 @@ module Icarus
     module Tools
       module Sync
         # Sync methods
-        class Progs
+        class Tools
           include Helpers
 
           def initialize(client: nil)
             @firestore = client || Firestore.new
           end
 
-          def progs
-            @firestore.progs
+          def tools
+            @firestore.tools
           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 }
+            @info_array ||= @firestore.toolinfo.map do |url|
+              next unless url
+
+              retrieve_from_url(url)[:tools].map { |tool| Icarus::Mod::Tools::Toolinfo.new(tool) if tool[:name] =~ /[a-z0-9]+/i }
             rescue Icarus::Mod::Tools::Sync::RequestFailed
               warn "Skipped; Failed to retrieve #{url}"
               next
@@ -31,20 +33,20 @@ module Icarus
             end.flatten.compact
           end
 
-          def find(proginfo)
-            @firestore.find_by_type(type: "progs", name: proginfo.name, author: proginfo.author)&.id
+          def find(toolinfo)
+            @firestore.find_by_type(type: "tools", name: toolinfo.name, author: toolinfo.author)&.id
           end
 
-          def find_info(proginfo)
-            @info_array.find { |prog| prog.name == proginfo.name }
+          def find_info(toolinfo)
+            @info_array.find { |tool| tool.name == toolinfo.name }
           end
 
-          def update(proginfo)
-            @firestore.update(:prog, proginfo, merge: false)
+          def update(toolinfo)
+            @firestore.update(:tool, toolinfo, merge: false)
           end
 
-          def delete(proginfo)
-            @firestore.delete(:prog, proginfo)
+          def delete(toolinfo)
+            @firestore.delete(:tool, toolinfo)
           end
         end
       end

data/lib/icarus/mod/tools/{proginfo.rb → toolinfo.rb}

@@ -6,7 +6,7 @@ module Icarus
   module Mod
     module Tools
       # Sync methods
-      class Proginfo < Baseinfo
+      class Toolinfo < Baseinfo
         # rubocop:disable Naming/MethodName
         def fileType
           @data[:fileType] || "zip"

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

@@ -11,8 +11,8 @@ module Icarus
           @array = case type
                    when :modinfo
                      Sync::Mods.new.info_array
-                   when :proginfo
-                     Sync::Progs.new.info_array
+                   when :toolinfo
+                     Sync::Tools.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.2"
+    VERSION = "1.9.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Icarus-Mod-Tools
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 1.9.0
 platform: ruby
 authors:
 - Donovan Young
@@ -99,12 +99,12 @@ files:
 - lib/icarus/mod/tools.rb
 - lib/icarus/mod/tools/baseinfo.rb
 - lib/icarus/mod/tools/modinfo.rb
-- lib/icarus/mod/tools/proginfo.rb
 - lib/icarus/mod/tools/sync/helpers.rb
-- lib/icarus/mod/tools/sync/modinfo.rb
+- lib/icarus/mod/tools/sync/modinfo_list.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/sync/toolinfo_list.rb
+- lib/icarus/mod/tools/sync/tools.rb
+- lib/icarus/mod/tools/toolinfo.rb
 - lib/icarus/mod/tools/validator.rb
 - lib/icarus/mod/version.rb
 - sig/database/sync/sync.rbs