Icarus-Mod-Tools 1.6.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0a960947869f1869c8fd0cfb500817169d4bdff4a725898d3d97459220e0843
-  data.tar.gz: 9bfa76062cdb5441198a176b273f49a915fa3c960f723268dc9395532b780ab5
+  metadata.gz: fd3e0ae69c6ef23c28a6f91e0ea2bef191fb23cb497624c4a6861542f0d55529
+  data.tar.gz: 74f1b174266c581ab857fd8079bc08345e055c12de0df175a24b84d5cf943c0b
 SHA512:
-  metadata.gz: 2266c6ffd007d98c9cd0269889634204f10e1a04bf217b68c915c194aec584851e84e11b0b2c8c55204420e302d92a6df638e24e9dc15aa64b3db3ebb1b21597
-  data.tar.gz: db7ee61fafa8279e1604de8fea770936548c6abeb4ade7d36a2b187c7514f2f1ef093238c8409aa3af1df477136bb2339c647982b1db64350a934cca19030a2d
+  metadata.gz: 3e2065dcd3968f5e692db72955f6c898e16c442c47cca55681586fb6c9b07c1ba7ed19c48b402b73b02004f70fb6c25def55d4f9daa4a46b1316ec5a2489e019
+  data.tar.gz: e56b480e1bd28fe040e0cd7a561f848596a654bb492457c92244902dbc046fe8a5ce8634f49455322ef03587c2762dc4003eb38e2b9c1fea5a7681562572a700

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    Icarus-Mod-Tools (1.6.0)
+    Icarus-Mod-Tools (1.7.1)
       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,8 +47,8 @@ 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-darwin)
     googleapis-common-protos (1.4.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)

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

@@ -43,8 +43,11 @@ module Icarus
           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,7 +5,7 @@ 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 readmeURL].freeze
 
@@ -13,6 +13,9 @@ module Icarus
           @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"
@@ -45,6 +52,22 @@ module Icarus
           }
         end
 
+        def validate
+          @warnings << "Version should be a version string" unless validate_version(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
@@ -52,6 +75,26 @@ 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
+
+        def validate_version(version)
+          version =~ /\d+\.\d+[.\d+]?/
+        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.6.0"
+    VERSION = "1.7.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Icarus-Mod-Tools
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.1
 platform: ruby
 authors:
 - Donovan Young
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-15 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