u3d 0.9.3 → 0.9.4

data/Rakefile

@@ -22,7 +22,31 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'rubocop/rake_task'
+# doesn't yet support dot file
+# https://github.com/skywinder/github-changelog-generator/issues/473
+# require 'github_changelog_generator/task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task default: :spec
+task :changelog do
+  puts "Updating changelog #{ENV['CHANGELOG_GITHUB_TOKEN']}"
+  sh "github_changelog_generator" if ENV['CHANGELOG_GITHUB_TOKEN']
+end
+
+task :test_all do
+  formatter = "--format progress"
+  if ENV["CIRCLECI"]
+    Dir.mkdir("/tmp/rspec/")
+    formatter += " -r rspec_junit_formatter --format RspecJunitFormatter -o /tmp/rspec/rspec.xml"
+    TEST_FILES = `(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)`.tr!("\n", ' ')
+    rspec_args = "#{formatter} #{TEST_FILES}"
+  else
+    formatter += ' --pattern "./spec/**/*_spec.rb"'
+    rspec_args = formatter
+  end
+  sh "rspec #{rspec_args}"
+end
+
+task default: %i[rubocop test_all]

data/examples/Example1/Gemfile

@@ -5,4 +5,6 @@ REPO_ROOT = File.expand_path(File.join('..', '..'))
 gem 'u3d', path: REPO_ROOT
 
 plugins_path = File.join(File.dirname(__FILE__), 'fastlane', 'Pluginfile')
+# rubocop:disable Eval
 eval(File.read(plugins_path), binding) if File.exist?(plugins_path)
+# rubocop:enable Eval

data/examples/Example2/Gemfile

@@ -5,4 +5,6 @@ REPO_ROOT = File.expand_path(File.join('..', '..'))
 gem 'u3d', path: REPO_ROOT
 
 plugins_path = File.join(File.dirname(__FILE__), 'fastlane', 'Pluginfile')
+# rubocop:disable Eval
 eval(File.read(plugins_path), binding) if File.exist?(plugins_path)
+# rubocop:enable Eval

data/lib/u3d/commands.rb

@@ -21,8 +21,10 @@
 ## --- END LICENSE BLOCK ---
 
 require 'u3d/unity_versions'
+require 'u3d/unity_version_definition'
 require 'u3d/downloader'
 require 'u3d/installer'
+require 'u3d/unity_project'
 require 'u3d/cache'
 require 'u3d/utils'
 require 'u3d/log_analyzer'
@@ -33,6 +35,7 @@ require 'fileutils'
 
 module U3d
   # API for U3d, redirecting calls to class they concern
+  # rubocop:disable ClassLength
   class Commands
     class << self
       def list_installed(options: {})
@@ -49,7 +52,7 @@ module U3d
         sorted_keys = vcomparators.sort.map { |v| v.version.to_s }
         sorted_keys.each do |k|
           u = map[k]
-          UI.message "%-*s%s" % [30, "Version #{u.version}", " (#{u.path})"]
+          UI.message "Version #{u.version.ljust(30)}(#{u.path})"
           packages = u.packages
           next unless options[:packages] && packages && !packages.empty?
           UI.message 'Packages:'
@@ -59,17 +62,9 @@ module U3d
 
       def list_available(options: {})
         ver = options[:unity_version]
-        os = options[:operating_system]
+        os = valid_os_or_current(options[:operating_system])
         rl = options[:release_level]
-        if os
-          os = os.to_sym
-          oses = U3dCore::Helper.operating_systems
-          raise "Specified OS (#{os}) isn't valid [#{oses.join(', ')}]" unless oses.include?(os)
-        else
-          os = U3dCore::Helper.operating_system
-        end
         cache = Cache.new(force_os: os, force_refresh: options[:force])
-        versions = {}
 
         return UI.error "Version #{ver} is not in cache" if ver && cache[os.id2name]['versions'][ver].nil?
 
@@ -103,93 +98,43 @@ module U3d
         end
       end
 
-      def download(args: [], options: {})
-        version = args[0]
-        UI.user_error!('Please specify a Unity version to download') unless version
-
-        packages = packages_with_unity_first(options)
+      def install(args: [], options: {})
+        version = specified_or_current_project_version(args[0])
 
         os = U3dCore::Helper.operating_system
+
+        packages = packages_with_unity_first(os, options)
+
         cache = Cache.new(force_os: os)
-        versions = cache[os.id2name]['versions']
-        version = interpret_latest(version, versions)
+        cache_versions = cache[os.id2name]['versions']
+        version = interpret_latest(version, cache_versions)
+        unless cache_versions[version]
+          UI.error "No version '#{version}' was found in cache. Either it doesn't exist or u3d doesn't know about it yet. Try refreshing with 'u3d available -f'"
+          return
+        end
 
+        definition = UnityVersionDefinition.new(version, os, cache_versions)
         unity = check_unity_presence(version: version)
-        return unless enforce_setup_coherence(packages, options, unity)
-
-        U3d::Globals.use_keychain = true if options[:keychain] && Helper.mac?
+        return unless enforce_setup_coherence(packages, options, unity, definition)
 
-        unless options[:no_install]
+        if options[:install]
+          U3d::Globals.use_keychain = true if options[:keychain] && Helper.mac?
           UI.important 'Root privileges are required'
           raise 'Could not get administrative privileges' unless U3dCore::CommandExecutor.has_admin_privileges?
         end
 
-        files = []
-        if os == :linux
-          UI.important 'Option -a | --all not available for Linux' if options[:all]
-          UI.important 'Option -p | --packages not available for Linux' if options[:packages]
-          downloader = Downloader::LinuxDownloader
-          files << ["Unity #{version}", downloader.download(version, versions), {}]
-        else
-          downloader = Downloader::MacDownloader if os == :mac
-          downloader = Downloader::WindowsDownloader if os == :win
-          if options[:all]
-            files = downloader.download_all(version, versions)
-          else
-            packages.each do |package|
-              result = downloader.download_specific(package, version, versions)
-              files << [package, result[0], result[1]] unless result.nil?
-            end
-          end
-        end
+        files = Downloader.fetch_modules(definition, packages: packages, download: options[:download])
 
-        return if options[:no_install]
-        Installer.install_modules(files, version, installation_path: options[:installation_path])
-      end
-
-      def local_install(args: [], options: {})
-        UI.user_error!('Please specify a version') if args.empty?
-        version = args[0]
-
-        packages = packages_with_unity_first(options)
-
-        os = U3dCore::Helper.operating_system
-
-        unity = check_unity_presence(version: version)
-        return unless enforce_setup_coherence(packages, options, unity)
-
-        U3d::Globals.use_keychain = true if options[:keychain] && Helper.mac?
-
-        UI.important 'Root privileges are required'
-        raise 'Could not get administrative privileges' unless U3dCore::CommandExecutor.has_admin_privileges?
-
-        files = []
-        if os == :linux
-          UI.important 'Option -a | --all not available for Linux' if options[:all]
-          UI.important 'Option -p | --packages not available for Linux' if options[:packages]
-          downloader = Downloader::LinuxDownloader
-          files << ["Unity #{version}", downloader.local_file(version), {}]
-        else
-          downloader = Downloader::MacDownloader if os == :mac
-          downloader = Downloader::WindowsDownloader if os == :win
-          if options[:all]
-            files = downloader.all_local_files(version)
-          else
-            packages.each do |package|
-              result = downloader.local_file(package, version)
-              files << [package, result[0], result[1]] unless result.nil?
-            end
-          end
-        end
-
-        Installer.install_modules(files, version, installation_path: options[:installation_path])
+        return unless options[:install]
+        Installer.install_modules(files, definition.version, installation_path: options[:installation_path])
       end
 
       def run(options: {}, run_args: [])
         version = options[:unity_version]
 
         runner = Runner.new
-        pp = runner.find_projectpath_in_args(run_args)
+        args_pp = Runner.find_projectpath_in_args(run_args)
+        pp = args_pp
         pp = Dir.pwd unless pp
         up = UnityProject.new(pp)
 
@@ -200,17 +145,19 @@ module U3d
           end
         end
 
-        run_args = ['-projectpath', up.path] if run_args.empty? && up.exist?
+        if up.exist? && args_pp.nil?
+          extra_run_args = ['-projectpath', up.path]
+          run_args = [extra_run_args, run_args].flatten
+        end
 
-        # we could
-        # * support matching 5.3.6p3 if passed 5.3.6
+        # we could support matching 5.3.6p3 if passed 5.3.6
         unity = Installer.create.installed.find { |u| u.version == version }
         UI.user_error! "Unity version '#{version}' not found" unless unity
         runner.run(unity, run_args, raw_logs: options[:raw_logs])
       end
 
       def credentials_actions
-        %w(add remove check)
+        %w[add remove check]
       end
 
       def credentials(args: [], _options: {})
@@ -226,20 +173,7 @@ module U3d
           U3dCore::Globals.use_keychain = true
           U3dCore::Credentials.new(user: ENV['USER']).forget_credentials(force: true)
         else
-          U3dCore::Globals.use_keychain = true
-          credentials = U3dCore::Credentials.new(user: ENV['USER'])
-          U3dCore::Globals.with_do_not_login(true) do
-            if credentials.password.to_s.empty?
-              UI.message "No credentials stored"
-            else
-              if U3dCore::CommandExecutor.has_admin_privileges?
-                UI.success "Stored credentials are valid"
-              else
-                UI.error "Stored credentials are not valid"
-              end
-            end
-          end
-          # FIXME: return value
+          credentials_check
         end
       end
 
@@ -254,7 +188,7 @@ module U3d
       end
 
       def release_levels
-        [:stable, :beta, :patch]
+        %i[stable beta patch]
       end
 
       def release_letter_mapping
@@ -268,6 +202,45 @@ module U3d
 
       private
 
+      def specified_or_current_project_version(version)
+        unless version # no version specified, use the one from the current unity project if any
+          UI.message "No unity version specified. If the current directory is a Unity project, we try to install the one it requires"
+          up = UnityProject.new(Dir.pwd)
+          version = up.editor_version if up.exist?
+        end
+        UI.user_error!('Please specify a Unity version to download') unless version
+        version
+      end
+
+      def credentials_check
+        U3dCore::Globals.use_keychain = true
+        credentials = U3dCore::Credentials.new(user: ENV['USER'])
+        U3dCore::Globals.with_do_not_login(true) do
+          if credentials.password.to_s.empty?
+            UI.message "No credentials stored"
+          elsif U3dCore::CommandExecutor.has_admin_privileges?
+            UI.success "Stored credentials are valid"
+          else
+            UI.error "Stored credentials are not valid"
+          end
+        end
+        # FIXME: return value
+      end
+
+      # if the specified string representatio of `os` is non nil
+      # convert the it to a symbol and checks it against the valid ones
+      # or return the current OS
+      def valid_os_or_current(os)
+        if os
+          os = os.to_sym
+          oses = U3dCore::Helper.operating_systems
+          raise "Specified OS (#{os}) isn't valid [#{oses.join(', ')}]" unless oses.include?(os)
+        else
+          os = U3dCore::Helper.operating_system
+        end
+        os
+      end
+
       def interpret_latest(version, versions)
         return version unless release_letter_mapping.keys.include? version.to_sym
 
@@ -282,7 +255,11 @@ module U3d
         iversion
       end
 
-      def packages_with_unity_first(options)
+      def packages_with_unity_first(os, options)
+        if os == :linux
+          UI.important 'Option -a | --all not available for Linux' if options[:all]
+          UI.important 'Option -p | --packages not available for Linux' if options[:packages]
+        end
         temp = options[:packages] || ['Unity']
         temp.insert(0, 'Unity') if temp.delete('Unity')
         temp
@@ -300,23 +277,28 @@ module U3d
         nil
       end
 
-      def enforce_setup_coherence(packages, options, unity)
+      def enforce_setup_coherence(packages, options, unity, definition)
+        packages = definition.available_packages if options[:all]
         if unity
           UI.important "Unity #{unity.version} is already installed"
-          return false if Helper.linux?
+          # Not needed since Linux custom u3d files contain only one entry wich is Unity
+          # return false if definition.os == :linux
           if packages.include?('Unity')
             UI.important 'Ignoring Unity module, it is already installed'
             packages.delete('Unity')
-            options[:installation_path] ||= unity.path if Helper.windows?
+
+            # FIXME: Move me to the WindowsInstaller
+            options[:installation_path] ||= unity.path if definition.os == :win
           end
           if unity.packages
             unity.packages.each do |pack|
               UI.important "Ignoring #{pack} module, it is already installed" if packages.delete(pack)
             end
           end
+          return false if packages.empty?
         else
           unless packages.include?('Unity')
-            UI.error "Please install Unity #{unity.version} before any of its packages"
+            UI.error 'Please install Unity before any of its packages'
             return false
           end
         end
@@ -324,4 +306,5 @@ module U3d
       end
     end
   end
+  # rubocop:enable ClassLength
 end

data/lib/u3d/commands_generator.rb

@@ -28,6 +28,7 @@ HighLine.track_eof = false
 
 module U3d
   # CLI using commander gem for u3d
+  # rubocop:disable ClassLength
   class CommandsGenerator
     include Commander::Methods
     UI = U3dCore::UI
@@ -71,7 +72,7 @@ module U3d
 
         c.syntax = 'u3d run [-u | --unity_version <version>] [-r | --raw_logs] [ -- <run_args>]'
         c.description = 'Run unity, and parses its output through u3d\'s log prettifier'
-        c.option '-u', '--unity_version STRING', String, 'Version of Unity to run with'
+        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
@@ -95,7 +96,7 @@ module U3d
         c.syntax = 'u3d available [-r | --release_level <level>] [-o | --operating_system <OS>] [-u | --unity_version <version>] [-p | --packages] [-f | --force]'
         levels = Commands.release_levels
         c.option '-f', '--force', 'Force refresh list of available versions'
-        c.option '-r', '--release_level STRING', String, "Checks for availability on specific release level [#{levels.join(',')}]"
+        c.option '-r', '--release_level STRING', String, "Checks for availability on specific release level [#{levels.join(', ')}]"
         c.option '-o', '--operating_system STRING', String, "Checks for availability on specific OS [#{oses.join(', ')}]"
         c.option '-u', '--unity_version STRING', String, 'Checks if specified version is available'
         c.option '-p', '--packages', 'Lists available packages as well'
@@ -111,31 +112,29 @@ module U3d
       end
 
       command :install do |c|
-        c.syntax = 'u3d install <version> [ [-p | --packages <package> ...] | [-a | --all] ] [ [-n | --no_install] [-i | --installation_path <path>] ]'
-        c.description = "Download (and install) Unity3D packages."
-        c.option '-p', '--packages PACKAGES', Array, 'Specifies which packages to download. Overriden by --all'
-        c.option '-i', '--installation_path PATH', String, 'Specifies where package(s) will be installed. Overriden by --no_install'
-        c.option '-a', '--all', 'Download all available packages'
-        c.option '-n', '--no_install', 'No installation after download success'
+        c.syntax = 'u3d install [<version>] [ [-p | --packages <package> ...] | [-a | --all] ] [ [-n | --no_install] [-i | --installation_path <path>] ]'
+        c.summary = "Download (and/or) install Unity3D packages."
+        c.description = %(
+#{c.summary}
+
+This command allows you to either:
+* download and install packages
+* download packages but not install them
+* install already downloaded packages
+        )
+        c.option '--[no-]download', 'Perform or not downloading before installation. Downloads by default'
+        c.option '--[no-]install', 'Perform or not installation after downloading. Installs by default'
+        c.option '-p', '--packages PACKAGES', Array, 'Specifies which packages to download/install. Overriden by --all'
+        c.option '-a', '--all', 'Download all available packages. Overrides -p'
+        c.option '-X', '--installation_path PATH', String, 'Specifies where package(s) will be downloaded/installed. Conflicts with --no-install'
         c.option '-k', '--keychain', 'Gain privileges right through the keychain. [OSX only]'
         c.example 'Download and install Unity, its Documentation and the Android build support and install them for version 5.1.2f1', 'u3d install 5.1.2f1 -p Unity,Documentation,Android'
-        c.example "The 'version' argument can be a specific version number, such as 5.6.1f1, or an alias in [#{Commands.release_letter_mapping.keys.join(',')}]", 'u3d install latest'
+        c.example "The 'version' argument can be a specific version number, such as 5.6.1f1, or an alias in [#{Commands.release_letter_mapping.keys.join(', ')}]. If not specified, u3d will download the unity version for the current project", 'u3d install latest'
         c.action do |args, options|
           options.default all: false
-          options.default no_install: false
-          Commands.download(args: args, options: convert_options(options))
-        end
-      end
-
-      command :local_install do |c|
-        c.syntax = 'u3d local_install <version> [ [-p | --packages <package> ...] | [-a | --all] ] [-i | --installation_path <path>]'
-        c.description = 'Install downloaded version of Unity3d'
-        c.option '-p', '--packages PACKAGES', Array, 'Specifies which packages to install. Overriden by --all'
-        c.option '-i', '--installation_path PATH', String, 'Specifies where package(s) will be installed.'
-        c.option '-a', '--all', 'Install all downloaded packages'
-        c.option '-k', '--keychain', 'Gain privileges right through the keychain. [OSX only]'
-        c.action do |args, options|
-          Commands.local_install(args: args, options: convert_options(options))
+          options.default install: true
+          options.default download: true
+          Commands.install(args: args, options: convert_options(options))
         end
       end
 
@@ -160,4 +159,5 @@ module U3d
       run!
     end
   end
+  # rubocop:enable ClassLength
 end

data/lib/u3d/download_validator.rb

@@ -0,0 +1,74 @@
+## --- BEGIN LICENSE BLOCK ---
+# Copyright (c) 2016-present WeWantToKnow AS
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+## --- END LICENSE BLOCK ---
+
+module U3d
+  class DownloadValidator
+    def hash_validation(expected: nil, actual: nil)
+      if expected
+        if expected != actual
+          UI.verbose "Expected hash is #{expected}, file hash is #{actual}"
+          UI.important 'File looks corrupted (wrong hash)'
+          return false
+        end
+      else
+        UI.verbose 'No hash validation available. File is assumed correct but may not be.'
+      end
+      true
+    end
+
+    def size_validation(expected: nil, actual: nil)
+      if expected
+        if expected != actual
+          UI.verbose "Expected size is #{expected}, file size is #{actual}"
+          UI.important 'File looks corrupted (wrong size)'
+          return false
+        end
+      else
+        UI.verbose 'No size validation available. File is assumed correct but may not be.'
+      end
+      true
+    end
+  end
+
+  class LinuxValidator < DownloadValidator
+    def validate(package, file, definition)
+      return size_validation(expected: definition[package]['size'], actual: File.size(file)) if definition.ini && definition[package]['size']
+      UI.important "No file validation available, #{file} is assumed to be correct"
+      true
+    end
+  end
+
+  class MacValidator < DownloadValidator
+    def validate(package, file, definition)
+      size_validation(expected: definition[package]['size'], actual: File.size(file)) &&
+        hash_validation(expected: definition[package]['md5'], actual: Utils.hashfile(file))
+    end
+  end
+
+  class WindowsValidator < DownloadValidator
+    def validate(package, file, definition)
+      rounded_size = (File.size(file).to_f / 1024).floor
+      size_validation(expected: definition[package]['size'], actual: rounded_size) &&
+        hash_validation(expected: definition[package]['md5'], actual: Utils.hashfile(file))
+    end
+  end
+end