Icarus-Mod-Tools 1.9.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fba522a3f41d8d1c77402e95f59684594bb7be97a8227966e4b647777152f05
-  data.tar.gz: 933ee795c5f13f964e1a866c0ce06549912c6e99c06c78fd687e5c25886bf148
+  metadata.gz: bc9f1796a92ebce3c0cdac2b87012e3c411f2f04e2308dc725872daf08846416
+  data.tar.gz: 707de57a940c21f20f2c47853f8083a121fceed70b6a5d8bbc358038c608a805
 SHA512:
-  metadata.gz: 0cd6a08a77be86801059b2b63a81fb662583ca404391afa2fd9544dbda8549e0652ce4c7db9a5ff64edb04afd07b50b742e1473861639ea190eddd22dda70f03
-  data.tar.gz: 1f28bff449d31ea47fa9166586dd10b996c466ed898ff53449a2cfd84fff98a5454418214fa479fa9976c0700ca88b12724c8b1f166b059093658d32862ee938
+  metadata.gz: 11179ce087f3c5b1d6dc8d6a76758410513bba8d53a1a02a2b0fd44e3b3ab58c5a0f14c81667edfaffbdf129ea917bcb256b71a75a0b8bc2220ef3863ecfcb98
+  data.tar.gz: 45d746e5bd59b6342ec9cec813d72e520fbbc8d1cc55d41e8c725b745c377f3aaba135b56b746281a80f5a1588e66a9426a80026cf423c49a80c85f029f1d586

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    Icarus-Mod-Tools (1.9.0)
+    Icarus-Mod-Tools (2.0.1)
       google-cloud-firestore (~> 2.7)
       octokit (~> 6.0)
       paint (~> 2.3)
@@ -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.0)
+    google-cloud-firestore (2.9.1)
       concurrent-ruby (~> 1.0)
       google-cloud-core (~> 1.5)
       google-cloud-firestore-v1 (~> 0.0)
@@ -86,7 +86,7 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     json (2.6.3)
-    jwt (2.6.0)
+    jwt (2.7.0)
     listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
@@ -122,7 +122,7 @@ GEM
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
+    rspec-core (3.12.1)
       rspec-support (~> 3.12.0)
     rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "firestore"
+require "tools/modinfo"
 
 module Icarus
   module Mod
@@ -10,7 +11,7 @@ module Icarus
         desc "modinfo", "Adds an entry to 'meta/modinfo/list'"
         def modinfo(item)
           firestore = Firestore.new
-          payload = [firestore.list(:modinfo), item].flatten.compact
+          payload = [firestore.modinfo, item].flatten.compact
 
           puts firestore.update(:modinfo, payload, merge: true) ? "Success" : "Failure"
         end
@@ -18,7 +19,7 @@ module Icarus
         desc "toolinfo", "Adds an entry to 'meta/toolinfo/list'"
         def toolinfo(item)
           firestore = Firestore.new
-          payload = [firestore.list(:toolinfo), item].flatten.compact
+          payload = [firestore.toolinfo, item].flatten.compact
 
           puts firestore.update(:toolinfo, payload, merge: true) ? "Success" : "Failure"
         end
@@ -26,10 +27,33 @@ module Icarus
         desc "repos", "Adds an entry to 'meta/repos/list'"
         def repos(item)
           firestore = Firestore.new
-          payload = [firestore.list(:repositories), item].flatten.compact
+          payload = [firestore.repositories, item].flatten.compact
 
           puts firestore.update(:repositories, payload, merge: true) ? "Success" : "Failure"
         end
+
+        desc "mod", "Adds an entry to 'mods'"
+        method_option :modinfo, type: :string, required: true, default: "modinfo.json", desc: "Path to the modinfo.json file"
+        def mod
+          firestore = Firestore.new
+          data = options[:modinfo]
+
+          if data.nil? || !File.exist?(data)
+            warn "Invalid data file: #{data}"
+            exit 1
+          end
+
+          JSON.parse(File.read(data), symbolize_names: true)[:mods].each do |mod|
+            modinfo = Icarus::Mod::Tools::Modinfo.new(mod)
+
+            unless modinfo.valid?
+              warn "Invalid modinfo: #{modinfo.errors}"
+              exit 1
+            end
+
+            puts firestore.update(:mod, modinfo, merge: true) ? "Success" : "Failure"
+          end
+        end
       end
     end
   end

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

@@ -10,21 +10,21 @@ module Icarus
       class List < SubcommandBase
         desc "modinfo", "Displays data from 'meta/modinfo/list'"
         def modinfo
-          modinfo_array = Firestore.new.list(:modinfo)
+          modinfo_array = Firestore.new.send(:modinfo)
           puts modinfo_array
           puts "Total: #{modinfo_array.count}" if verbose > 1
         end
 
         desc "toolinfo", "Displays data from 'meta/toolinfo/list'"
         def toolinfo
-          toolinfo_array = Firestore.new.list(:toolinfo)
+          toolinfo_array = Firestore.new.send(:toolinfo)
           puts toolinfo_array
           puts "Total: #{toolinfo_array.count}" if verbose > 1
         end
 
         desc "repos", "Displays data from 'meta/repos/list'"
         def repos
-          repos = Firestore.new.list(:repositories)
+          repos = Firestore.new.send(:repositories)
           puts repos
           puts "Total: #{repos.count}" if verbose > 1
         end
@@ -64,7 +64,7 @@ module Icarus
             puts "Sorted by #{sort_field}" if sort_field && verbose > 2
             puts "Filtered by #{filter_field} = #{filter_value}" if filter_field && verbose > 2
 
-            items = Firestore.new.list(type)
+            items = Firestore.new.send(type)
 
             # Filter by field
             items.select! { |item| item.send(filter_field).downcase =~ /#{filter_value&.downcase}/ } if filter_field

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

@@ -85,6 +85,8 @@ module Icarus
           def sync_list(type)
             sync = (type == :mods ? Icarus::Mod::Tools::Sync::Mods : Icarus::Mod::Tools::Sync::Tools).new(client: firestore)
 
+            puts "Syncing #{type} to #{Config.firebase.collections.send(type)}" if verbose > 1
+
             puts "Retrieving Info Data..." if verbose?
             info_array = sync.info_array
 

data/lib/icarus/mod/firestore.rb

@@ -13,10 +13,15 @@ module Icarus
       def initialize
         @client = Google::Cloud::Firestore.new(credentials: Config.firebase.credentials.to_h)
         @collections = Config.firebase.collections
+        @repositories = repositories
+        @modinfo = modinfo
+        @toolinfo = toolinfo
+        @mods = mods
+        @tools = tools
       end
 
-      def repos
-        @repos ||= list(:repositories)
+      def repositories
+        @repositories ||= list(:repositories)
       end
 
       def modinfo
@@ -36,35 +41,7 @@ module Icarus
       end
 
       def find_by_type(type:, name:, author:)
-        list(type).find { |obj| obj.name == name && obj.author == author }
-      end
-
-      def get_list(type)
-        raise "Invalid type: #{type} - unknown collection" unless collections.respond_to?(type)
-
-        @client.doc(collections.send(type)).get[:list]
-      end
-
-      def list(type)
-        case type.to_sym
-        when :modinfo, :toolinfo, :repositories
-          get_list(type)
-        when :mods, :tools
-          @client.col(collections.send(type)).get.map do |doc|
-            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
-          raise "Invalid type: #{type}"
-        end
-      end
-
-      def update_or_create(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
-
-        @client.col(collections.send(type)).add(payload.to_h)
+        instance_variable_get("@#{type}").find { |obj| obj.name == name && obj.author == author }
       end
 
       def update(type, payload, merge: false)
@@ -98,6 +75,28 @@ module Icarus
 
       private
 
+      def list(type)
+        case type.to_sym
+        when :modinfo, :toolinfo, :repositories
+          @client.doc(collections.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
+            klass.new(doc.data, id: doc.document_id, created: doc.create_time, updated: doc.update_time)
+          end
+        else
+          raise "Invalid type: #{type}"
+        end
+      end
+
+      def update_or_create(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
+
+        @client.col(collections.send(type)).add(payload.to_h)
+      end
+
       def pluralize(type)
         type.to_s.end_with?("s") ? type.to_s : "#{type}s"
       end

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

@@ -7,7 +7,7 @@ module Icarus
       class Baseinfo
         attr_reader :data, :id, :created_at, :updated_at
 
-        HASHKEYS = %i[name author version compatibility description fileType fileURL imageURL readmeURL].freeze
+        HASHKEYS = %i[name author version compatibility description files imageURL readmeURL].freeze
 
         def initialize(data, id: nil, created: nil, updated: nil)
           @id = id
@@ -52,14 +52,14 @@ module Icarus
         end
 
         def valid?
-          @warnings << "Version should be a version string" unless validate_version(version)
+          validate_version
+          validate_files if @data.key?(:files)
+          validate_filetype(fileType) if @data.key?(:fileType)
 
           %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
@@ -67,12 +67,20 @@ module Icarus
           !errors?
         end
 
+        def file_types
+          files&.keys || []
+        end
+
+        def file_urls
+          files&.values || []
+        end
+
         def method_missing(method_name, *_args, &_block)
-          @data[method_name.to_sym]&.strip
+          @data[method_name.to_sym] if @data.keys.include?(method_name.to_sym)
         end
 
         def respond_to_missing?(method_name, include_private = false)
-          HASHKEYS.include?(method_name.to_sym) || super
+          @data.keys.include?(method_name.to_sym) || super
         end
 
         private
@@ -81,22 +89,32 @@ module Icarus
           /(zip|pak|exmodz?)/i
         end
 
+        def validate_string(string)
+          !(string.nil? || string.empty?)
+        end
+
         def validate_url(url)
           return true if url.nil? || url.empty?
 
           url =~ URI::DEFAULT_PARSER.make_regexp
         end
 
-        def validate_filetype(filetype)
-          filetype.match?(filetype_pattern)
+        def validate_files
+          @errors << "files cannot be blank" if @data.key?(:files) && @data[:files].keys.empty?
+
+          file_types.each { |file_type| validate_filetype(file_type) }
+
+          file_urls.each do |file_url|
+            @errors << "Invalid URL: #{file_url}" unless validate_url(file_url)
+          end
         end
 
-        def validate_string(string)
-          !(string.nil? || string.empty?)
+        def validate_filetype(file_type)
+          @errors << "Invalid fileType: #{file_type.upcase}" unless file_type&.match?(filetype_pattern)
         end
 
-        def validate_version(version)
-          version =~ /\d+\.\d+[.\d+]?/
+        def validate_version
+          @warnings << "Version should be a version string" unless version =~ /^\d+[.\d+]*/
         end
       end
     end

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

@@ -7,7 +7,25 @@ module Icarus
     module Tools
       # Sync methods
       class Modinfo < Baseinfo
-        HASHKEYS = %i[name author version compatibility description long_description fileType fileURL imageURL readmeURL].freeze
+        HASHKEYS = %i[name author version compatibility description long_description files fileType fileURL imageURL readmeURL].freeze
+
+        def to_h
+          HASHKEYS.each_with_object({}) do |key, hash|
+            next if key == :files && @data[:files].nil?
+            next if %i[fileType fileURL].include?(key.to_sym) && !@data[:files].nil?
+            next if key == :long_description && @data[:long_description].nil?
+
+            hash[key] = @data[key]
+          end
+        end
+
+        def file_types
+          files&.keys || [@data[:fileType] || "pak"]
+        end
+
+        def file_urls
+          files&.values || [@data[:fileURL]].compact
+        end
 
         # rubocop:disable Naming/MethodName
         def fileType

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

@@ -19,7 +19,7 @@ module Icarus
           end
 
           def repositories
-            @firestore.repos
+            @firestore.repositories
           end
 
           def update(modinfo_array)

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

@@ -19,7 +19,7 @@ module Icarus
           end
 
           def repositories
-            @firestore.repos
+            @firestore.repositories
           end
 
           def update(toolinfo_array)

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

@@ -7,6 +7,8 @@ module Icarus
     module Tools
       # Sync methods
       class Toolinfo < Baseinfo
+        HASHKEYS = %i[name author version compatibility description fileType fileURL imageURL readmeURL].freeze
+
         # rubocop:disable Naming/MethodName
         def fileType
           @data[:fileType] || "zip"

data/lib/icarus/mod/version.rb

@@ -2,6 +2,6 @@
 
 module Icarus
   module Mod
-    VERSION = "1.9.0"
+    VERSION = "2.0.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Icarus-Mod-Tools
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Donovan Young
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-28 00:00:00.000000000 Z
+date: 2023-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-firestore