u3d 1.2.1 → 1.3.0

data/lib/u3d/asset.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ## --- BEGIN LICENSE BLOCK ---
 # Copyright (c) 2016-present WeWantToKnow AS
 #
@@ -36,8 +38,9 @@ module U3d
 
     def initialize(path, unity_project = nil)
       raise ArgumentError, "No file at #{path}" unless File.exist?(path)
+
       @path = path
-      @meta_path = path + ".meta"
+      @meta_path = "#{path}.meta"
       @meta = YAML.safe_load(File.read(@meta_path))
       @guid = @meta['guid']
       @unity_project = unity_project
@@ -63,6 +66,7 @@ module U3d
 
     def eql?(other)
       return false unless other.is_a? Asset
+
       other.guid == @guid
     end
 
@@ -81,7 +85,7 @@ module U3d
     private
 
     def grep_reference_root
-      @unity_project && @unity_project.exist? ? 'Assets/' : '.'
+      @unity_project&.exist? ? 'Assets/' : '.'
     end
   end
 end

data/lib/u3d/cache.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ## --- BEGIN LICENSE BLOCK ---
 # Copyright (c) 2016-present WeWantToKnow AS
 #
@@ -32,12 +34,12 @@ module U3d
     using ::CoreExtensions::OperatingSystem
 
     # Name of the cache file
-    DEFAULT_NAME = 'cache.json'.freeze
+    DEFAULT_NAME = 'cache.json'
     # Maximum duration after which the cache is considered outdated
     # Currently set to 24h
     CACHE_LIFE = 60 * 60 * 24
 
-    GLOBAL_CACHE_URL = 'https://dragonbox.github.io/unities/v1/versions.json'.freeze
+    GLOBAL_CACHE_URL = 'https://dragonbox.github.io/unities/v1/versions.json'
 
     private
 
@@ -49,11 +51,13 @@ module U3d
 
     def [](key)
       return nil if @cache[key].nil?
+
       @cache[key]
     end
 
     def initialize(path: nil, force_os: nil, force_refresh: false, offline: false, central_cache: false)
       raise "Cache: cannot specify both offline and force_refresh" if offline && force_refresh
+
       @path = path || Cache.default_os_path
       @cache = {}
       os = force_os || U3dCore::Helper.operating_system
@@ -78,23 +82,23 @@ module U3d
     def check_for_update(file_path, os)
       need_update = false
       data = {}
-      if !File.file?(file_path)
-        need_update = true
-      else
+      if File.file?(file_path)
         begin
           File.open(file_path, 'r') do |f|
             data = JSON.parse(f.read)
           end
-        rescue JSON::ParserError => json_error
-          UI.error 'Failed to parse cache.json: ' + json_error.to_s
+        rescue JSON::ParserError => e
+          UI.error "Failed to parse cache.json: #{e}"
           need_update = true
-        rescue SystemCallError => file_error
-          UI.error 'Failed to open cache.json: ' + file_error.to_s
+        rescue SystemCallError => e
+          UI.error "Failed to open cache.json: #{e}"
           need_update = true
         else
           need_update = os_data_need_update?(data, os)
           data[os.id2name] = nil if need_update
         end
+      else
+        need_update = true
       end
       return need_update, data
     end
@@ -111,7 +115,7 @@ module U3d
       update_cache(os) unless central_cache && fetch_central_cache(os)
 
       File.delete(file_path) if File.file?(file_path)
-      File.open(file_path, 'w') { |f| f.write(@cache.to_json) }
+      File.write(file_path, @cache.to_json)
     end
 
     # Fetches central versions.json. Ignore it if it is too old

data/lib/u3d/commands.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ## --- BEGIN LICENSE BLOCK ---
 # Copyright (c) 2016-present WeWantToKnow AS
 #
@@ -37,7 +39,7 @@ require 'fileutils'
 
 module U3d
   # API for U3d, redirecting calls to class they concern
-  # rubocop:disable ClassLength
+  # rubocop:disable Metrics/ClassLength
   class Commands
     using ::CoreExtensions::Extractable
 
@@ -51,18 +53,18 @@ module U3d
           return
         end
         list.each do |u|
-          version_format = "Version %-15{version} [%<build_number>s] %<do_not_move>s(%<root_path>s)"
+          version_format = "Version %-15<version>s [%<build_number>s] %<do_not_move>s(%<root_path>s)"
           do_not_move = u.do_not_move? ? '!'.red.bold : ' '
           h = { version: u.version, build_number: u.build_number, root_path: u.root_path, do_not_move: do_not_move }
           UI.message version_format % h
           packages = u.packages
           next unless options[:packages] && packages && !packages.empty?
+
           UI.message 'Packages:'
           packages.each { |pack| UI.message " - #{pack}" }
         end
       end
 
-      # rubocop:disable Style/FormatStringToken
       def console
         require 'irb'
         ARGV.clear
@@ -81,7 +83,6 @@ module U3d
 
         catch(:IRB_EXIT) { @irb.eval_input }
       end
-      # rubocop:enable Style/FormatStringToken
 
       def move(args: {}, options: {})
         long_name = options[:long]
@@ -131,6 +132,7 @@ module U3d
           v = cache_versions[k]
           UI.message "Version #{k}: " + v.to_s.cyan.underline
           next unless show_packages
+
           version_packages = packages[k]
           UI.message 'Packages:'
           version_packages.each { |package| UI.message " - #{package.id.capitalize}" }
@@ -152,7 +154,8 @@ module U3d
 
         definition = UnityVersionDefinition.new(version, os, cache_versions)
         unity = check_unity_presence(version: version)
-        packages = options[:packages] || ['Unity']
+
+        packages = verify_package_names(options[:packages], definition) || ['Unity']
 
         begin
           packages = enforce_setup_coherence(packages, options, unity, definition)
@@ -160,13 +163,12 @@ module U3d
           return
         end
 
-        verify_package_names(definition, packages)
-
         get_administrative_privileges(options) if options[:install]
 
         files = Downloader.fetch_modules(definition, packages: packages, download: options[:download])
 
         return unless options[:install]
+
         Installer.install_modules(files, definition.version, installation_path: options[:installation_path])
       end
 
@@ -223,12 +225,14 @@ module U3d
         action = args[0]
         raise "Please specify an action to perform, one of #{credentials_actions.join(',')}" unless action
         raise "Unknown action '#{action}'. Use one of #{credentials_actions.join(',')}" unless credentials_actions.include? action
-        if action == 'add'
+
+        case action
+        when 'add'
           U3dCore::Globals.use_keychain = true
           # credentials = U3dCore::Credentials.new(user: ENV['USER'])
           # credentials.login # ask password
           UI.error 'Invalid credentials' unless U3dCore::CommandExecutor.has_admin_privileges?
-        elsif action == 'remove'
+        when 'remove'
           U3dCore::Globals.use_keychain = true
           U3dCore::Credentials.new(user: ENV['USER']).forget_credentials(force: true)
         else
@@ -270,14 +274,15 @@ module U3d
       def cache_versions(os, offline: false, force_refresh: false, central_cache: true)
         cache = Cache.new(force_os: os, offline: offline, force_refresh: force_refresh, central_cache: central_cache)
         cache_os = cache[os.id2name] || {}
-        cache_versions = cache_os['versions'] || {}
-        cache_versions
+        cache_os['versions'] || {}
       end
 
-      def verify_package_names(definition, packages)
-        packages.each do |package|
-          UI.user_error! "package '#{package}' doesn't exist" unless definition.available_package? package
+      def verify_package_names(packages, definition)
+        unless packages.nil?
+          invalid_packages = packages.reject { |package| definition.available_package? package }
+          raise ArgumentError, "Package(s) '#{invalid_packages.join(',')}' are not known. Use #{definition.available_packages.join(',')}" unless invalid_packages.empty?
         end
+        packages
       end
 
       def specified_or_current_project_version(version)
@@ -341,9 +346,8 @@ module U3d
           UI.verbose "Version #{version} of Unity is not installed yet"
         else
           UI.verbose "Unity #{version} is installed at #{unity.root_path}"
-          return unity
         end
-        nil
+        unity
       end
 
       # rubocop:disable Metrics/BlockNesting
@@ -418,6 +422,7 @@ module U3d
         package = definition[package_name]
         return true unless package.depends_on
         return true if unity.package_installed?(package.depends_on)
+
         installing.map { |other| definition[other] }.any? do |other|
           other.id == package.depends_on || other.name == package.depends_on
         end
@@ -430,7 +435,7 @@ module U3d
       end
     end
   end
-  # rubocop:enable ClassLength
+  # rubocop:enable Metrics/ClassLength
 end
 
 class InstallationSetupError < StandardError

data/lib/u3d/commands_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ## --- BEGIN LICENSE BLOCK ---
 # Copyright (c) 2016-present WeWantToKnow AS
 #
@@ -28,16 +30,19 @@ HighLine.track_eof = false
 
 module U3d
   # CLI using commander gem for u3d
-  # rubocop:disable ClassLength
+  # rubocop:disable Metrics/ClassLength
   class CommandsGenerator
     include Commander::Methods
     UI = U3dCore::UI
 
-    UNICODE_FILE = File.expand_path('../../assets/utf8.txt', __FILE__)
+    UNICODE_FILE = File.expand_path('../assets/utf8.txt', __dir__)
 
     def self.start
+      U3dCore::UpdateChecker.start_looking_for_update('u3d')
       check_locale
       new.run
+    ensure
+      U3dCore::UpdateChecker.show_update_status('u3d', U3d::VERSION)
     end
 
     def self.check_locale
@@ -94,7 +99,7 @@ Fore more information about how the rules work, see https://github.com/DragonBox
         c.option '-u', '--unity_version STRING', String, 'Version of Unity to run with. If not specified, it runs with the version of the project (either specified as -projectPath or current)'
         c.option '-r', '--raw_logs', 'Raw Unity output, not filtered by u3d\'s log prettifier'
         c.action do |args, options|
-          UI.user_error! "Run doesn't take arguments. Did you forget '--' or did you mistake your command? (#{args})" if args.count > 0
+          UI.user_error! "Run doesn't take arguments. Did you forget '--' or did you mistake your command? (#{args})" if args.count.positive?
           U3dCore::Globals.log_timestamps = true
           Commands.run(options: convert_options(options), run_args: run_args)
         end
@@ -260,5 +265,5 @@ More on that: https://forum.unity3d.com/threads/unity-on-linux-release-notes-and
       run!
     end
   end
-  # rubocop:enable ClassLength
+  # rubocop:enable Metrics/ClassLength
 end

data/lib/u3d/compatibility.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ## --- BEGIN LICENSE BLOCK ---
 # Copyright (c) 2016-present WeWantToKnow AS
 #

data/lib/u3d/download_validator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ## --- BEGIN LICENSE BLOCK ---
 # Copyright (c) 2016-present WeWantToKnow AS
 #
@@ -51,7 +53,8 @@ module U3d
 
   class LinuxValidator < DownloadValidator
     def validate(package, file, definition)
-      return size_validation(expected: definition[package].download_size, actual: File.size(file)) if definition[package] && definition[package].download_size
+      return size_validation(expected: definition[package].download_size, actual: File.size(file)) if definition[package]&.download_size
+
       UI.important "No file validation available, #{file} is assumed to be correct"
       true
     end
@@ -59,7 +62,7 @@ module U3d
 
   class MacValidator < DownloadValidator
     def validate(package, file, definition)
-      if definition[package].download_size % 1000 && definition[package].checksum.nil?
+      if (definition[package].download_size % 1000) && definition[package].checksum.nil?
         UI.verbose "File '#{definition[package].name}' seems external. Validation skipped"
         return true
       end
@@ -71,7 +74,7 @@ module U3d
   class WindowsValidator < DownloadValidator
     def validate(package, file, definition)
       # External packages have no md5 and a false size value
-      if definition[package].download_size % 1000 && definition[package].checksum.nil?
+      if (definition[package].download_size % 1000) && definition[package].checksum.nil?
         UI.verbose "File '#{definition[package].name}' seems external. Validation skipped"
         return true
       end

data/lib/u3d/downloader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ## --- BEGIN LICENSE BLOCK ---
 # Copyright (c) 2016-present WeWantToKnow AS
 #
@@ -27,13 +29,13 @@ module U3d
   # Take care of downloading files and packages
   module Downloader
     # Name of the directory for the package downloading
-    DOWNLOAD_DIRECTORY = 'Unity_Packages'.freeze
+    DOWNLOAD_DIRECTORY = 'Unity_Packages'
     # Path to the directory for the package downloading
-    DOWNLOAD_PATH = "#{ENV['HOME']}/Downloads".freeze
+    DOWNLOAD_PATH = "#{ENV['HOME']}/Downloads"
     # Regex to get the name of a localization asset
-    UNITY_LANGUAGE_FILE_REGEX = %r{\/\d+/[0-9\.]+\/([\w-]+)$}
+    UNITY_LANGUAGE_FILE_REGEX = %r{/\d+/[0-9.]+/([\w-]+)$}.freeze
     # Regex to get the name of a package out of its file name
-    UNITY_MODULE_FILE_REGEX = %r{\/([\w\-_\.\+]+\.(?:pkg|exe|zip|sh|deb|msi|xz))[^\/]*$}
+    UNITY_MODULE_FILE_REGEX = %r{/([\w\-_.+]+\.(?:pkg|dmg|exe|zip|sh|deb|msi|xz))[^/]*$}.freeze
 
     class << self
       def download_directory
@@ -112,15 +114,15 @@ module U3d
             return
           else
             extension = File.extname(path)
-            new_path = File.join(File.dirname(path), File.basename(path, extension) + '_CORRUPTED' + extension)
+            new_path = File.join(File.dirname(path), "#{File.basename(path, extension)}_CORRUPTED#{extension}")
             UI.important "File present at #{path} is not correct, it has been renamed to #{new_path}"
             File.rename(path, new_path)
           end
         end
 
         UI.header "Downloading #{package_info.name} version #{definition.version}"
-        UI.message 'Downloading from ' + url.to_s.cyan.underline
-        UI.message 'Download will be found at ' + path
+        UI.message "Downloading from #{url.to_s.cyan.underline}"
+        UI.message "Download will be found at #{path}"
         download_package(path, url, size: package_info.download_size)
 
         if validator.validate(package, path, definition)
@@ -153,7 +155,7 @@ module U3d
         Utils.ensure_dir(dir)
 
         file_name = if (language_match = UNITY_LANGUAGE_FILE_REGEX.match(final_url))
-                      language_match[1] + '.po' # Unity uses PO (Portable object files) for localization
+                      "#{language_match[1]}.po" # Unity uses PO (Portable object files) for localization
                     elsif (module_match = UNITY_MODULE_FILE_REGEX.match(final_url))
                       module_match[1]
                     else
@@ -182,8 +184,10 @@ module U3d
     # for backward compatibility
     class MacDownloader < StandardPackageDownloader
     end
+
     class LinuxDownloader < StandardPackageDownloader
     end
+
     class WindowsDownloader < StandardPackageDownloader
     end
   end

data/lib/u3d/failure_reporter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'date'
 require 'fileutils'
 require 'json'
@@ -9,6 +11,7 @@ module U3d
     class << self
       def report(failure_type: "DEFAULT", failure_message: "", data: {})
         return unless ENV['U3D_REPORT_FAILURES']
+
         report = {
           type: failure_type,
           message: failure_message,
@@ -21,9 +24,7 @@ module U3d
           "#{failure_type}.#{Date.now.strftime('%Y%m%dT%H%M')}.failure.json"
         )
 
-        File.open(report_file, 'w') do |file|
-          file.write JSON.pretty_generate(report)
-        end
+        File.write(report_file, JSON.pretty_generate(report))
       rescue StandardError => e
         UI.important "Unable to report a #{failure_type} failure. Please use --verbose to get more information about the failure"
         UI.verbose "Unable to report failure: #{e}"

data/lib/u3d/hub_modules_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ## --- BEGIN LICENSE BLOCK ---
 # Copyright (c) 2016-present WeWantToKnow AS
 #
@@ -28,19 +30,34 @@ require 'u3d_core/helper'
 module U3d
   module HubModulesParser
     class << self
-      HUB_MODULES_NAME = '%<version>s-%<os>s-modules.json'.freeze
+      HUB_MODULES_NAME = '%<version>s-%<os>s-modules.json'
 
       def load_modules(version, os: U3dCore::Helper.operating_system, offline: false)
         path = modules_path(version, os)
 
-        unless File.file?(path) && File.size(path) > 0
-          return [] if offline # Should not raise, not all versions have hub modules
-          versions = download_modules(os: os)
+        # force download if no hub file present
+        download_modules(os: os) if !File.file?(path) && File.size(path).positive? && !offline
+
+        unless File.file?(path) && File.size(path).positive?
+          UI.verbose "No modules registered for UnityHub for version #{version}"
+          # cached_versions.keys.map{|s| UnityVersionNumber.new(s)}
+          # searching for closest version
+          files = Dir.glob("#{default_modules_path}/*-#{os}-modules.json")
+
+          vn = UnityVersionNumber.new(version)
+
+          versions_and_paths = files.map do |p|
+            v = File.basename(p).split('-')[0]
+            [UnityVersionNumber.new(v), p]
+          end
+          # filtered by version major.minor.patch (same major & minor and patch higher or equal)
+          versions_and_paths = versions_and_paths.select { |a| a[0].parts[0] == vn.parts[0] && a[0].parts[1] == vn.parts[1] && a[0].parts[2] >= vn.parts[2] }
 
-          unless versions.include? version
-            UI.verbose "No modules registered for UnityHub for version #{version}"
+          if versions_and_paths.empty?
+            UI.info "No closest version from UnityHub found for version #{version}"
             return []
           end
+          path = versions_and_paths.first[1]
         end
 
         return JSON.parse(File.read(path))
@@ -81,7 +98,7 @@ module U3d
         path = modules_path(build['version'], os)
         Utils.ensure_dir(File.dirname(path))
 
-        File.open(path, 'w') { |file| file.write build['modules'].to_json }
+        File.write(path, build['modules'].to_json)
       end
     end
   end

data/lib/u3d/ini_modules_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ## --- BEGIN LICENSE BLOCK ---
 # Copyright (c) 2016-present WeWantToKnow AS
 #
@@ -25,36 +27,12 @@ require 'u3d/utils'
 require 'u3d_core/helper'
 
 module U3d
-  # Backwards compatibility
-  module INIParser
-    class << self
-      def method_missing(method_name, *arguments, &block)
-        UI.deprecated 'INIParser is obsolete, Use INIModulesParser instead'
-        if INIModulesParser.respond_to?(method_name)
-          INIModulesParser.send(method_name, *arguments, &block)
-        else
-          super
-        end
-      end
-
-      def respond_to?(method_name, include_private = false)
-        UI.deprecated 'INIParser is obsolete, Use INIModulesParser instead'
-        INIModulesParser.respond_to?(method_name, include_private)
-      end
-
-      def respond_to_missing?(method_name, include_private = false)
-        UI.deprecated 'INIParser is obsolete, Use INIModulesParser instead'
-        INIModulesParser.respond_to_missing?(method_name, include_private)
-      end
-    end
-  end
-
   # Load and parse INI files
   module INIModulesParser
     #####################################################
     # @!group INI parameters to load and save ini files
     #####################################################
-    INI_NAME = 'unity-%<version>s-%<os>s.ini'.freeze
+    INI_NAME = 'unity-%<version>s-%<os>s.ini'
 
     class << self
       def load_ini(version, cached_versions, os: U3dCore::Helper.operating_system, offline: false)
@@ -66,8 +44,9 @@ module U3d
         ini_name = format(INI_NAME, version: version, os: os)
         Utils.ensure_dir(default_ini_path)
         ini_path = File.expand_path(ini_name, default_ini_path)
-        unless File.file?(ini_path) && File.size(ini_path) > 0
+        unless File.file?(ini_path) && File.size(ini_path).positive?
           raise "INI file does not exist at #{ini_path}" if offline
+
           download_ini(version, cached_versions, os, ini_name, ini_path)
         end
         begin
@@ -82,7 +61,8 @@ module U3d
         ini_name = format(INI_NAME, version: version, os: 'linux')
         Utils.ensure_dir(default_ini_path)
         ini_path = File.expand_path(ini_name, default_ini_path)
-        return if File.file?(ini_path) && File.size(ini_path) > 0
+        return if File.file?(ini_path) && File.size(ini_path).positive?
+
         data = %([Unity]
 ; -- NOTE --
 ; This is not an official Unity file
@@ -114,16 +94,14 @@ url=#{url}
         UI.verbose("Searching for ini file at #{uri}")
 
         data = Net::HTTP.get(uri)
-        data.tr!("\"", '')
-        data.gsub!(/Note:.+\n/, '')
+        data = data.tr("\"", '')
+        data = data.gsub(/Note:.+\n/, '')
 
         write_ini_file(ini_path, data)
       end
 
       def write_ini_file(ini_path, data)
-        File.open(ini_path, 'wb') do |f|
-          f.write(data)
-        end
+        File.binwrite(ini_path, data)
       end
 
       def default_ini_path