Icarus-Mod-Tools 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c66a2adaabe6da3d7ef43db063f7d2924e182e574b4d9d77c1786a15aea1c8b
-  data.tar.gz: d28b3240fbfc0670ab652ac131bfad396f1e6e09e30fbd7c5c3dace8c51e1784
+  metadata.gz: 86f364e215cfc35b2fd3f0dbee4b21cd6a4c5582f0a13157f8d0a439b4011db6
+  data.tar.gz: 9ef8581f16f9bb88281e5c5141b9736ffc144a3ffbe5c00b4b174201e8403e12
 SHA512:
-  metadata.gz: 35b823d39db613491f965a185a43bcf848629e84ca88fca358e2bc9412bbc42802c92a6fc6fe72870907e6d970415fe4d037035057a946bd19495b7bf9650a9c
-  data.tar.gz: 7e625e03b7d027a0d52f28d955b80abf3cab001f879a0169a7e500d0123775801580e9c7b8ef85438ba7eb7813b7ac02f37114ea37496e7b1beeec1e73bdd1d1
+  metadata.gz: 0ff3c9d47c79c3ec2d7cfb096b9e242fe5b662fb6f6c1f75f32cf2739628e5e8cb2685e863b83c0e664271685b4e641e5619e630a42cceb7ef209e2943e06b7c
+  data.tar.gz: 52b61a53f9eea61ad77163fb4ebd08a03258eb946086815089707dbe619c24dc88185a570855711f6854c7130164cb01c63bad9c9d7fcf19fd528f5a6b949b1f

data/.rubocop.yml

@@ -34,7 +34,7 @@ Metrics/PerceivedComplexity:
     - lib/icarus/mod/cli/*.rb # Thor command files
 
 Metrics/AbcSize:
-  Max: 25
+  Max: 35
   Exclude:
     - lib/icarus/mod/cli/*.rb # Thor command files
 

data/.ruby-version

@@ -0,0 +1 @@
+3.1.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    Icarus-Mod-Tools (2.0.3)
+    Icarus-Mod-Tools (2.1.0)
       google-cloud-firestore (~> 2.7)
       octokit (~> 6.0)
       paint (~> 2.3)
@@ -24,7 +24,7 @@ GEM
       faraday (~> 2.0)
     ffi (1.15.5)
     formatador (1.1.0)
-    gapic-common (0.16.0)
+    gapic-common (0.17.1)
       faraday (>= 1.9, < 3.a)
       faraday-retry (>= 1.0, < 3.a)
       google-protobuf (~> 3.14)
@@ -38,7 +38,7 @@ GEM
     google-cloud-env (1.6.0)
       faraday (>= 0.17.3, < 3.0)
     google-cloud-errors (1.3.0)
-    google-cloud-firestore (2.9.1)
+    google-cloud-firestore (2.10.0)
       concurrent-ruby (~> 1.0)
       google-cloud-core (~> 1.5)
       google-cloud-firestore-v1 (~> 0.0)
@@ -50,6 +50,7 @@ GEM
     google-cloud-location (0.3.0)
       gapic-common (>= 0.16.0, < 2.a)
       google-cloud-errors (~> 1.0)
+    google-protobuf (3.21.12-x86_64-darwin)
     google-protobuf (3.21.12-x86_64-linux)
     googleapis-common-protos (1.4.0)
       google-protobuf (~> 3.14)
@@ -64,7 +65,10 @@ GEM
       multi_json (~> 1.11)
       os (>= 0.9, < 2.0)
       signet (>= 0.16, < 2.a)
-    grpc (1.51.0-x86_64-linux)
+    grpc (1.52.0-x86_64-darwin)
+      google-protobuf (~> 3.21)
+      googleapis-common-protos-types (~> 1.0)
+    grpc (1.52.0-x86_64-linux)
       google-protobuf (~> 3.21)
       googleapis-common-protos-types (~> 1.0)
     guard (2.18.0)
@@ -100,7 +104,7 @@ GEM
     os (1.1.4)
     paint (2.3.0)
     parallel (1.22.1)
-    parser (3.2.0.0)
+    parser (3.2.1.0)
       ast (~> 2.4.1)
     pry (0.14.2)
       coderay (~> 1.1)
@@ -112,7 +116,7 @@ GEM
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rbtree (0.4.6)
-    regexp_parser (2.6.2)
+    regexp_parser (2.7.0)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -127,7 +131,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.44.1)
+    rubocop (1.45.1)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
@@ -137,8 +141,8 @@ GEM
       rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.24.1)
-      parser (>= 3.1.1.0)
+    rubocop-ast (1.26.0)
+      parser (>= 3.2.1.0)
     rubocop-capybara (2.17.0)
       rubocop (~> 1.41)
     rubocop-rspec (2.18.1)

data/imtconfig.sample.json

@@ -13,9 +13,12 @@
       "client_x509_cert_url": "YOUR-x509-CERT-URL"
     },
     "collections": {
-      "modinfo": "meta/modinfo",
-      "toolinfo": "meta/toolinfo",
-      "repositories": "meta/repos",
+      "meta": {
+        "modinfo": "meta/modinfo",
+        "repositories": "meta/repos",
+        "status": "meta/status",
+        "toolinfo": "meta/toolinfo"
+      },
       "mods": "mods",
       "tools": "tools"
     }

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

@@ -29,7 +29,7 @@ module Icarus
             validator.array.each do |info|
               print Paint[format("%s %-#{max_length}s", "Running validation steps on", info.uniq_name), :cyan, :bright] if verbose > 1
 
-              info.valid?
+              info.validate
 
               unless info.errors? || info.warnings?
                 puts Paint["SUCCESS", :green, :bright] if verbose > 1

data/lib/icarus/mod/firestore.rb

@@ -47,17 +47,17 @@ module Icarus
       def update(type, payload, merge: false)
         raise "You must specify a payload to update" if payload&.empty? || payload.nil?
 
-        case type.to_sym
-        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, :tool
-          response = update_or_create(pluralize(type), payload, merge:)
-        else
-          raise "Invalid type: #{type}"
-        end
+        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
 
         response.is_a?(Google::Cloud::Firestore::DocumentReference) || response.is_a?(Google::Cloud::Firestore::CommitResponse::WriteResult)
       end
@@ -78,7 +78,7 @@ module Icarus
       def list(type)
         case type.to_sym
         when :modinfo, :toolinfo, :repositories
-          @client.doc(collections.send(type)).get[:list]
+          @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
@@ -89,7 +89,7 @@ module Icarus
         end
       end
 
-      def update_or_create(type, payload, merge:)
+      def create_or_update(type, payload, merge:)
         doc_id = payload.id || find_by_type(type:, name: payload.name, author: payload.author)&.id
 
         return @client.doc("#{collections.send(type)}/#{doc_id}").set(payload.to_h, merge:) if doc_id

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

@@ -15,28 +15,44 @@ module Icarus
           @updated_at = updated
           @errors = []
           @warnings = []
+          @validated = false
 
           read(data)
         end
 
+        def author_id
+          author.downcase.gsub(/\s+/, "_")
+        end
+
         def read(data)
           @data = data.is_a?(String) ? JSON.parse(data, symbolize_names: true) : data
         end
 
         def errors
+          validate
           @errors.compact.uniq
         end
 
         def errors?
-          @errors.compact.any?
+          errors.any?
         end
 
         def warnings
+          validate
           @warnings.compact.uniq
         end
 
         def warnings?
-          @warnings.compact.any?
+          warnings.any?
+        end
+
+        def status
+          validate
+
+          {
+            errors:,
+            warnings:
+          }
         end
 
         def uniq_name
@@ -48,10 +64,16 @@ module Icarus
         end
 
         def to_h
-          HASHKEYS.each_with_object({}) { |key, hash| hash[key] = @data[key] }
+          db_hash = HASHKEYS.each_with_object({}) { |key, hash| hash[key] = @data[key] }
+
+          db_hash[:version] = "1.0" if version.nil?
+
+          db_hash
         end
 
-        def valid?
+        def validate
+          return true if @validated
+
           validate_version
           validate_files if @data.key?(:files)
           validate_filetype(fileType) if @data.key?(:fileType)
@@ -64,6 +86,12 @@ module Icarus
             @errors << "Invalid URL #{key.capitalize}: #{@data[key.to_sym] || "blank"}" unless validate_url(@data[key.to_sym])
           end
 
+          @validated = true
+        end
+
+        def valid?
+          validate
+
           !errors?
         end
 
@@ -100,6 +128,7 @@ module Icarus
         end
 
         def validate_files
+          @errors << "This mod uses deprecated fields (fileType and fileURL)" if @data.key?(:file_type) || @data.key?(:file_url)
           @errors << "files cannot be blank" if @data.key?(:files) && @data[:files].keys.empty?
 
           file_types.each { |file_type| validate_filetype(file_type) }
@@ -114,7 +143,11 @@ module Icarus
         end
 
         def validate_version
-          @warnings << "Version should be a version string" unless version =~ /^\d+[.\d+]*/
+          if version.nil?
+            @warnings << "Version was nil, it has been defaulted to 1.0"
+          else
+            @warnings << "Version should be a version string" unless version =~ /^\d+[.\d+]*/
+          end
         end
       end
     end

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

@@ -7,26 +7,12 @@ module Icarus
     module Tools
       # Sync methods
       class Modinfo < Baseinfo
-        HASHKEYS = %i[name author version compatibility description long_description files fileType fileURL imageURL readmeURL].freeze
-
-        # rubocop:disable Metrics/AbcSize
         def to_h
-          db_hash = HASHKEYS.each_with_object({}) do |key, hash|
-            # next if %i[fileType fileURL].include?(key.to_sym)
-            next if key == :long_description && @data[:long_description].nil?
-
-            hash[key] = @data[key]
-          end
-
-          db_hash[:files] = { @data[:fileType].downcase.to_sym => @data[:fileURL] } if db_hash[:files].nil? && !@data[:fileType].nil?
-
-          # Remove this once all mods have been updated
-          db_hash[:fileType] = db_hash[:files].keys.first.to_s if db_hash[:fileType].nil? && !db_hash[:files].nil?
-          db_hash[:fileURL] = db_hash[:files].values.first if db_hash[:fileURL].nil? && !db_hash[:files].nil?
+          db_hash = super
+          db_hash[:meta] = { status: } # Add metadata
 
           db_hash
         end
-        # rubocop:enable Metrics/AbcSize
 
         def file_types
           files&.keys || [@data[:fileType] || "pak"]

data/lib/icarus/mod/version.rb

@@ -2,6 +2,6 @@
 
 module Icarus
   module Mod
-    VERSION = "2.0.3"
+    VERSION = "2.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Icarus-Mod-Tools
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Donovan Young
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-04 00:00:00.000000000 Z
+date: 2023-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-firestore
@@ -76,6 +76,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -115,7 +116,7 @@ metadata:
   source_code_uri: https://github.com/DonovanMods/icarus-mod-tools
   changelog_uri: https://github.com/DonovanMods/icarus-mod-tools/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -132,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.26
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Various tools for Icarus Modding
 test_files: []