Icarus-Mod-Tools 1.5.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f68f524c29cc673a82735bffc97c0fb93fc4170466e774879f39935aa08729f
-  data.tar.gz: d4e336be0968b54baade6752f66b5e56ad0139fe371eec58dc72d74decd4e2ab
+  metadata.gz: ce305187a0a91ed7a8574f418d6c2afc50380323b3d5fe4d4fa215b61bc1e59c
+  data.tar.gz: 28b19fe811f5eec20f5c79d2b9e567a2703cd266a7f1cf122df328f1018c04fb
 SHA512:
-  metadata.gz: 3cd31a2d76b7ab415242cf8755c59139c50bcd8e07d6ab011efb21a2f146147583c461ae19b7fa3378f919c7405bb55248be8c38c89a66708fd25614a8d1167a
-  data.tar.gz: 2121ab82950054dd62990c4d41f2d5c7c13bb62ea909d8e9959b2c44040de1dafa2d6878e38e28644caf390a8a6ec4b51b83a68dd4c420235a6606a5360115c1
+  metadata.gz: 49adc06788394d6015d23d33312a63058fcfb57bd0585c60325383501ee8950e5ba31fc90be13c765d45d397eb099aa494c9723a1bdaef379a4a62c8842f3ee8
+  data.tar.gz: a233c109a0f8addcbba424b460ca2cca4100de71e5c771ae79487f13504f1b31ea195c07aa93108df4bc0de5e6fc2a75c09cd4dbf84acafe267c1333da8df3ad

data/CHANGES.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 
 ## History (reverse chronological order)
 
+### v1.6 - 2023-15
+
+- Added `--check` to `sync mods` to check for updates without downloading
+- Added support for `readmeURL` in `modinfo.json`
+
 ### v1.5 - 2023-08
 
 - Moved source into the DonovanMods Github organization

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    Icarus-Mod-Tools (1.5.1)
+    Icarus-Mod-Tools (1.7.0)
       google-cloud-firestore (~> 2.7)
       octokit (~> 6.0)
+      paint (~> 2.3)
       thor (~> 1.2)
 
 GEM
@@ -15,7 +16,7 @@ GEM
     coderay (1.1.3)
     concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
-    faraday (2.7.2)
+    faraday (2.7.3)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
@@ -46,10 +47,10 @@ GEM
       gapic-common (>= 0.10, < 2.a)
       google-cloud-errors (~> 1.0)
       google-cloud-location (>= 0.0, < 2.a)
-    google-cloud-location (0.2.0)
-      gapic-common (>= 0.10, < 2.a)
+    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-linux)
+    google-protobuf (3.21.12-x86_64-darwin)
     googleapis-common-protos (1.4.0)
       google-protobuf (~> 3.14)
       googleapis-common-protos-types (~> 1.2)
@@ -63,7 +64,7 @@ GEM
       multi_json (~> 1.11)
       os (>= 0.9, < 2.0)
       signet (>= 0.16, < 2.a)
-    grpc (1.50.0-x86_64-linux)
+    grpc (1.50.0-x86_64-darwin)
       google-protobuf (~> 3.21)
       googleapis-common-protos-types (~> 1.0)
     guard (2.18.0)
@@ -97,6 +98,7 @@ GEM
       faraday (>= 1, < 3)
       sawyer (~> 0.9)
     os (1.1.4)
+    paint (2.3.0)
     parallel (1.22.1)
     parser (3.2.0.0)
       ast (~> 2.4.1)
@@ -137,7 +139,7 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.24.1)
       parser (>= 3.1.1.0)
-    rubocop-rspec (2.16.0)
+    rubocop-rspec (2.17.0)
       rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
@@ -154,6 +156,7 @@ GEM
     unicode-display_width (2.4.2)
 
 PLATFORMS
+  x86_64-darwin-22
   x86_64-linux
 
 DEPENDENCIES

data/icarus-mod-tools.gemspec

@@ -33,8 +33,8 @@ Gem::Specification.new do |spec|
   # spec.add_dependency "example-gem", "~> 1.0"
   spec.add_dependency "google-cloud-firestore", "~> 2.7"
   spec.add_dependency "octokit", "~> 6.0"
+  spec.add_dependency "paint", "~> 2.3"
   spec.add_dependency "thor", "~> 1.2"
-
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html
 end

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

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
-require "version"
-require "tools"
+require "paint"
 require "thor"
+require "tools"
+require "version"
 
 module Icarus
   module Mod

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/validate"
 
 module Icarus
   module Mod
@@ -35,6 +36,9 @@ module Icarus
 
         desc "add", "Adds entries to the databases"
         subcommand "add", Add
+
+        desc "validate", "Validates various entries"
+        subcommand "validate", Validate
       end
     end
   end

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

@@ -28,6 +28,7 @@ module Icarus
         end
 
         desc "mods", "Reads from 'meta/modinfo/list' and updates the 'mods' database accordingly"
+        method_option :check, type: :boolean, default: false, desc: "Validate modinfo without applying changes"
         def mods
           modsync = Icarus::Mod::Tools::ModSync.new
 
@@ -37,11 +38,16 @@ module Icarus
           puts "Retrieving mod Data..." if verbose?
           mod_array = modsync.mods
 
+          return if options[:check]
+
           puts "Updating mod Data..." if verbose?
           modinfo_array.each do |mod|
             verb = "Creating"
-            doc_id = modsync.find_mod(mod)
 
+            puts "Validating modinfo Data for #{mod.uniq_name}..." if verbose > 2
+            warn "Skipping mod #{mod.uniq_name} due to validation errors" && next unless mod.validate
+
+            doc_id = modsync.find_mod(mod)
             if doc_id
               puts "Found existing mod #{mod.name} at #{doc_id}" if verbose > 2
               mod.id = doc_id

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "tools/modinfo_validate"
+
+module Icarus
+  module Mod
+    module CLI
+      # Sync CLI command definitions
+      class Validate < SubcommandBase
+        desc "modinfo", "Reads modinfo data from 'meta/modinfo/list' and Validates syntax of modfiles"
+        def modinfo
+          exit_code = 0
+          modinfo_validate = Icarus::Mod::Tools::ModinfoValidate.new
+
+          puts "Validating Entries..." if verbose?
+          max_length = modinfo_validate.modinfo_array.map { |modinfo| modinfo.uniq_name.length }.max
+
+          modinfo_validate.modinfo_array.each do |modinfo|
+            print Paint[format("%s %-#{max_length}s", "Running validation steps on", modinfo.uniq_name), :cyan, :bright] if verbose > 1
+
+            modinfo.validate
+
+            if modinfo.errors.empty? && modinfo.warnings.empty?
+              puts Paint["SUCCESS", :green, :bright] if verbose > 1
+              next
+            end
+
+            if modinfo.errors.any?
+              exit_code = 1
+              puts Paint["ERROR", :red, :bright] if verbose? && verbose > 1
+              warn modinfo.errors.map { |error| Paint[error, :red] }.join("\n")
+              puts "\n" if verbose > 1
+            end
+
+            puts Paint["WARNING", :yellow, :bright] if modinfo.warnings.any? && verbose > 1
+            puts modinfo.warnings.map { |warning| Paint["#{warning} in #{modinfo.uniq_name}", :yellow] }.join("\n")
+            puts "\n" if verbose > 1
+          end
+
+          exit exit_code
+        end
+      end
+    end
+  end
+end

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

@@ -5,14 +5,17 @@ module Icarus
     module Tools
       # Sync methods
       class Modinfo
-        attr_reader :data, :id, :created_at, :updated_at
+        attr_reader :data, :errors, :id, :created_at, :updated_at, :warnings
 
-        HASHKEYS = %i[name author version compatibility description long_description fileType fileURL imageURL].freeze
+        HASHKEYS = %i[name author version compatibility description long_description fileType fileURL imageURL readmeURL].freeze
 
         def initialize(data, id: nil, created: nil, updated: nil)
           @id = id
           @created_at = created
           @updated_at = updated
+          @errors = []
+          @warnings = []
+
           read(data)
         end
 
@@ -20,6 +23,10 @@ module Icarus
           @data = data.is_a?(String) ? JSON.parse(data, symbolize_names: true) : data
         end
 
+        def uniq_name
+          "#{author}/#{name}"
+        end
+
         # rubocop:disable Naming/MethodName
         def fileType
           @data[:fileType] || "pak"
@@ -40,10 +47,27 @@ module Icarus
             long_description:,
             fileType:,
             fileURL:,
-            imageURL:
+            imageURL:,
+            readmeURL:
           }
         end
 
+        def validate
+          @warnings << "Version should not be blank" unless validate_string(version)
+
+          %w[name author description].each do |key|
+            @errors << "#{key.capitalize} cannot be blank" unless validate_string(@data[key.to_sym])
+          end
+
+          @errors << "Invalid FileType: #{fileType || "blank"}" unless validate_filetype(fileType)
+
+          %w[fileURL imageURL readmeURL].each do |key|
+            @errors << "Invalid URL #{key.capitalize}: #{@data[key.to_sym] || "blank"}" unless validate_url(@data[key.to_sym])
+          end
+
+          @errors.empty?
+        end
+
         def method_missing(method_name, *_args, &)
           @data[method_name.to_sym]&.strip
         end
@@ -51,6 +75,22 @@ module Icarus
         def respond_to_missing?(method_name, include_private = false)
           HASHKEYS.include?(method_name.to_sym) || super
         end
+
+        private
+
+        def validate_url(url)
+          return true if url.nil? || url.empty?
+
+          url =~ URI::DEFAULT_PARSER.make_regexp
+        end
+
+        def validate_filetype(filetype)
+          %w[pak zip exmod].include?(filetype.downcase)
+        end
+
+        def validate_string(string)
+          !(string.nil? || string.empty?)
+        end
       end
     end
   end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Icarus
+  module Mod
+    module Tools
+      # Validate Methods
+      class ModinfoValidate
+        attr_reader :modinfo_array
+
+        def initialize
+          @modinfo_array = ModSync.new.modinfo_array
+        end
+      end
+    end
+  end
+end

data/lib/icarus/mod/version.rb

@@ -2,6 +2,6 @@
 
 module Icarus
   module Mod
-    VERSION = "1.5.1"
+    VERSION = "1.7.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Icarus-Mod-Tools
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Donovan Young
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-14 00:00:00.000000000 Z
+date: 2023-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-firestore
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +92,7 @@ files:
 - lib/icarus/mod/cli/list.rb
 - lib/icarus/mod/cli/subcommand_base.rb
 - lib/icarus/mod/cli/sync.rb
+- lib/icarus/mod/cli/validate.rb
 - lib/icarus/mod/config.rb
 - lib/icarus/mod/firestore.rb
 - lib/icarus/mod/github.rb
@@ -85,6 +100,7 @@ files:
 - lib/icarus/mod/tools/mod_sync.rb
 - lib/icarus/mod/tools/modinfo.rb
 - lib/icarus/mod/tools/modinfo_sync.rb
+- lib/icarus/mod/tools/modinfo_validate.rb
 - lib/icarus/mod/tools/sync_helpers.rb
 - lib/icarus/mod/version.rb
 - sig/database/sync/sync.rbs