u3d 1.0.20 → 1.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab0e4249d0406f5fb52fdbec3de6d5da617e749d
-  data.tar.gz: bb2dca8350752bf2eea3ca212b838661fd8b4762
+  metadata.gz: 10b2431e2eb35059d86094081ce7c219c568f935
+  data.tar.gz: e826f09214bc27778063015107f8509473c58ee3
 SHA512:
-  metadata.gz: d2250d5b8c92617ac32e8108abff60d6dc93fbab21d5ce8007a0639e832444635f8c68c596c5cc7cefdfbfab2420aa269da4bd91ff3b1518630d8cf319533807
-  data.tar.gz: 04d154f9e8c7bdb6f7cac0f3a47711c5e2fe1b8cd4efa5a086fb6984e67fa7d9776498983cb3167e6c98ad302cd19fea4081a8afc0dec6b146f078fb733a10e3
+  metadata.gz: 193be5dd907f183a023cf64d6e88b0cd483b0bac27e37b0735c0cf560707467d765208a1c9643f2f0c9a80e6745d2232ce83d170a18cb464b791d375d6efcb9d
+  data.tar.gz: 064ef5072d1bd047109874b91662fc589125892e90e5c4fcb3c9fec759b5f375a28bdbe9b273f110f7ee30fd0179f7a9cb6c0787b1e02e1294f54d850411763c

data/.github_changelog_generator

@@ -1,4 +1,4 @@
-future-release=v1.0.20
+future-release=v1.0.21
 since-tag=v0.9
 exclude_tags_regex=v0\.[0-8]\..*
 exclude-labels=nochangelog,question

data/CHANGELOG.md

@@ -1,5 +1,46 @@
 # Change Log
 
+## [v1.0.21](https://github.com/DragonBox/u3d/tree/v1.0.21) (2018-04-27)
+[Full Changelog](https://github.com/DragonBox/u3d/compare/v1.0.20...v1.0.21)
+
+**Implemented enhancements:**
+
+- u3d/install: do not ask for password when user is root on Linux [\#303](https://github.com/DragonBox/u3d/issues/303)
+- u3d/prettify: report failures to parse logs automatically [\#146](https://github.com/DragonBox/u3d/issues/146)
+- u3d/install do not ask for root password [\#304](https://github.com/DragonBox/u3d/pull/304) ([lacostej](https://github.com/lacostej))
+- u3d/\* automatically retry admin privilege elevation \#236 [\#297](https://github.com/DragonBox/u3d/pull/297) ([lacostej](https://github.com/lacostej))
+- u3d/sanitize: support dot\_not\_move [\#293](https://github.com/DragonBox/u3d/pull/293) ([lacostej](https://github.com/lacostej))
+- u3d/ui: adjust a message that is use for more than just downloading unity [\#292](https://github.com/DragonBox/u3d/pull/292) ([lacostej](https://github.com/lacostej))
+- u3d/sanitize: ensure Installation instance's root\_path is updated post move [\#291](https://github.com/DragonBox/u3d/pull/291) ([lacostej](https://github.com/lacostej))
+- u3d/move command, renaming install dirs. Support long version names. Fixes \#274 [\#289](https://github.com/DragonBox/u3d/pull/289) ([lacostej](https://github.com/lacostej))
+- u3d/console: an interactive version of u3d \(Fixes \#265\) [\#283](https://github.com/DragonBox/u3d/pull/283) ([lacostej](https://github.com/lacostej))
+
+**Fixed bugs:**
+
+- Unity Installations fail on Windows with space in path [\#302](https://github.com/DragonBox/u3d/issues/302)
+- u3d/internals: grant\_admin wasn't using has\_admin\_privileges? to get the privileges on non windows platforms [\#301](https://github.com/DragonBox/u3d/pull/301) ([lacostej](https://github.com/lacostej))
+
+**Closed issues:**
+
+- Include build number when renaming hotfix releases of Unity [\#274](https://github.com/DragonBox/u3d/issues/274)
+- u3d should ask again for password if wrong password is given in interactive mode [\#236](https://github.com/DragonBox/u3d/issues/236)
+- u3d: non UTF-8 environments can cause issues. [\#147](https://github.com/DragonBox/u3d/issues/147)
+
+**Merged pull requests:**
+
+- u3d/console: remove require on pry [\#307](https://github.com/DragonBox/u3d/pull/307) ([lacostej](https://github.com/lacostej))
+- Allow spaces in installation paths on Windows \#302 [\#306](https://github.com/DragonBox/u3d/pull/306) ([lacostej](https://github.com/lacostej))
+- u3d/install: support full pkg for Linux [\#305](https://github.com/DragonBox/u3d/pull/305) ([lacostej](https://github.com/lacostej))
+- u3d/internals: fallback on admin move of creating u3d\_do\_not\_move if needed [\#300](https://github.com/DragonBox/u3d/pull/300) ([lacostej](https://github.com/lacostej))
+- u3d/list: identify versions that can't be moved with a ! [\#298](https://github.com/DragonBox/u3d/pull/298) ([lacostej](https://github.com/lacostej))
+- u3d/internals: move windows\_path from U3d::Utils to U3dCore::Helper and reuse it in AdminTools [\#296](https://github.com/DragonBox/u3d/pull/296) ([lacostej](https://github.com/lacostej))
+- u3d/internals: extract the move\_file into U3dCore::AdminTools [\#295](https://github.com/DragonBox/u3d/pull/295) ([lacostej](https://github.com/lacostej))
+- u3d/sanitize: sanitize on list only + cleanups and refactors [\#294](https://github.com/DragonBox/u3d/pull/294) ([lacostej](https://github.com/lacostej))
+- u3d/list: properly identify the build number [\#288](https://github.com/DragonBox/u3d/pull/288) ([lacostej](https://github.com/lacostej))
+- u3d/examples: support Unity 2017.3+, identified while investigating \#3 [\#286](https://github.com/DragonBox/u3d/pull/286) ([lacostej](https://github.com/lacostej))
+- u3d/\* Detect incorrect locale \(Fixes \#147\) [\#285](https://github.com/DragonBox/u3d/pull/285) ([lacostej](https://github.com/lacostej))
+- u3d/list: introduce format and make sure the list\_installed return an array of versions [\#284](https://github.com/DragonBox/u3d/pull/284) ([lacostej](https://github.com/lacostej))
+
 ## [v1.0.20](https://github.com/DragonBox/u3d/tree/v1.0.20) (2018-04-19)
 [Full Changelog](https://github.com/DragonBox/u3d/compare/v1.0.19...v1.0.20)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    u3d (1.0.20)
+    u3d (1.0.21)
       colored (>= 1.2, < 2.0.0)
       commander (>= 4.4.0, < 5.0.0)
       file-tail (>= 1.2.0)
@@ -22,7 +22,8 @@ GEM
       public_suffix (~> 2.0, >= 2.0.2)
     ast (2.3.0)
     builder (3.2.3)
-    coderay (1.1.1)
+    byebug (10.0.2)
+    coderay (1.1.2)
     colored (1.2)
     commander (4.4.4)
       highline (~> 1.7.2)
@@ -54,7 +55,7 @@ GEM
     i18n (0.8.6)
     inifile (3.0.0)
     json (2.1.0)
-    method_source (0.8.2)
+    method_source (0.9.0)
     minitest (5.10.3)
     multi_json (1.12.1)
     multipart-post (2.0.0)
@@ -65,10 +66,12 @@ GEM
       ast (~> 2.3)
     plist (3.4.0)
     powerpack (0.1.1)
-    pry (0.10.4)
+    pry (0.11.3)
       coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
     public_suffix (2.0.5)
     rainbow (3.0.0)
     rake (10.5.0)
@@ -105,7 +108,6 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.1)
-    slop (3.6.0)
     term-ansicolor (1.6.0)
       tins (~> 1.0)
     thor (0.19.4)
@@ -124,7 +126,7 @@ DEPENDENCIES
   bundler (~> 1.13)
   coveralls
   github_changelog_generator
-  pry
+  pry-byebug
   rake (~> 10.0)
   rspec (~> 3.1.0)
   rspec_junit_formatter (~> 0.2.3)

data/README.md

@@ -55,6 +55,10 @@ The prettifyer is on by default but can be turned off to get Unity's raw output.
 
 ![u3d list](https://github.com/DragonBox/u3d/raw/master/docs/assets/u3d_licenses.png)
 
+* `u3d console`: Run u3d in interactive mode, accessing its API
+
+![u3d console](https://github.com/DragonBox/u3d/raw/master/docs/assets/u3d_console.png)
+
 ## Installation
 
 ```shell
@@ -82,7 +86,7 @@ Unity uses the following version formatting: 0.0.0x0. The \'x\' can takes differ
 
 Some versions are known to have a different numbering, e.g. Linux 2017.1.0f3 is named 2017.1.0xf3Linux. Its `ProjectSettings/ProjectVersion.txt` will contain the Linux specific version.
 
-When referencing to a version on the CLI, u3d sanitizes these weird versions. For example, if you ask u3d to launch unity 2017.1.0f3 on Linux, you can use `u3d -u 2017.1.0f3` and it will find "2017.1.0xf3Linux".
+When referencing to a version on the CLI, u3d normalizes these weird versions. For example, if you ask u3d to launch unity 2017.1.0f3 on Linux, you can use `u3d -u 2017.1.0f3` and it will find "2017.1.0xf3Linux".
 
 ### Unity build numbers
 
@@ -114,10 +118,14 @@ Right now u3d has light support for build numbers. The build number can be found
 
 ## Sanitize / standardize Unity installation paths
 
-  If you have installed Unity in different locations, u3d might discover them and propose you to move them to its standard location. The procedure should be self described and easily revertible (manually). This sanitization operation is only proposed in interactive mode (i.e. if you are not using u3d unattended, e.g. in a build script on a CI server).
+  If you have installed Unity in different locations, u3d might discover them and propose you to move them to its standard location. The procedure should be self described and easily revertible (manually). This sanitization operation is only proposed in interactive mode (i.e. if you are not using u3d unattended, e.g. in a build script on a CI server) when running the `list` command.
 
 ![u3d sanitize](https://github.com/DragonBox/u3d/raw/master/docs/assets/u3d_sanitize.png)
 
+  If you wish a particular Unity installation to be ignored by the sanitization feature, create a `.u3d_do_not_move` file inside it.
+
+  If you wish to have your pre-installed unities directory name to automatically contain the full version (unity version + build number), you can call `u3d move --long <version>`.
+
 ## Security
 
 When you install Unity with this tool, you will have to grant it higher privileges so it can perform the installation. It means that under MacOS and Linux, you will be asked for your `sudo` password.

data/WIP

@@ -0,0 +1,5 @@
+* merge other PRs
+
+* note: matcher in sanitization is partial on full path and doesn't ask you to move things like Unity_Version_XXX as Version matches it
+* optim: only move with super admin rights if necessary
+

data/examples/Example2/Assets/Editor/EditorRun.cs

@@ -10,7 +10,14 @@ namespace U3d {
     static void Build() {
       Debug.Log("Building Example2");
 
-      BuildPlayer(EditorBuildSettings.scenes, "target/Example2.app", BuildTarget.StandaloneOSXIntel64, BuildOptions.None);
+      BuildTarget Target;
+#if UNITY_2017_3_OR_NEWER
+      Target = BuildTarget.StandaloneOSX;
+#else
+      Target = BuildTarget.StandaloneOSXIntel64;
+#endif      
+
+      BuildPlayer(EditorBuildSettings.scenes, "target/Example2.app", Target, BuildOptions.None);
     }
 
     private static void BuildPlayer(EditorBuildSettingsScene[] scenes, string target_dir, BuildTarget build_target, BuildOptions build_options) {

data/lib/assets/utf8.txt

@@ -0,0 +1,2 @@
+✓
+✓

data/lib/u3d/commands.rb

@@ -43,21 +43,18 @@ module U3d
 
     class << self
       def list_installed(options: {})
-        list = Installer.create.installed
+        installer = Installer.create
+        installer.sanitize_installs
+        list = installer.installed_sorted_by_versions
         if list.empty?
           UI.important 'No Unity version installed'
           return
         end
-        # version -> installations
-        arraym = list.map { |a| [a.version, a] }
-        map = Hash[*arraym.flatten]
-        # sorted versions
-        vcomparators = map.keys.map { |k| UnityVersionComparator.new(k) }
-        sorted_keys = vcomparators.sort.map { |v| v.version.to_s }
-        sorted_keys.each do |k|
-          u = map[k]
-          version = "#{u.version.ljust(13)} [#{u.build_number}]".ljust(30)
-          UI.message "Version #{version}(#{u.root_path})"
+        list.each do |u|
+          version_format = "Version %-15{version} [%<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:'
@@ -65,6 +62,47 @@ module U3d
         end
       end
 
+      # rubocop:disable Style/FormatStringToken
+      def console
+        require 'irb'
+        ARGV.clear
+        IRB.setup(nil)
+        @irb = IRB::Irb.new(nil)
+        IRB.conf[:MAIN_CONTEXT] = @irb.context
+        IRB.conf[:PROMPT][:U3D] = IRB.conf[:PROMPT][:SIMPLE].dup
+        IRB.conf[:PROMPT][:U3D][:RETURN] = "%s\n"
+        @irb.context.prompt_mode = :U3D
+        @irb.context.workspace = IRB::WorkSpace.new(binding)
+        trap 'INT' do
+          @irb.signal_handle
+        end
+
+        UI.message('Welcome to u3d interactive!')
+
+        catch(:IRB_EXIT) { @irb.eval_input }
+      end
+      # rubocop:enable Style/FormatStringToken
+
+      def move(args: {}, options: {})
+        long_name = options[:long]
+        UI.user_error! "move only supports long version name for now" unless long_name
+
+        version = args[0]
+        UI.user_error! "Please specify a Unity version" unless version
+        unity = check_unity_presence(version: version)
+        if unity.nil?
+          UI.message "Specified version '#{version}' not found."
+          return
+        end
+        if unity.do_not_move?
+          UI.error "Specified version is specicically marked as _do not move_."
+          return
+        end
+        Installer.create.sanitize_install(unity, long: true, dry_run: options[:dry_run])
+
+        unity.do_not_move!(dry_run: options[:dry_run]) # this may fail because of admin rights
+      end
+
       def list_available(options: {})
         ver = options[:unity_version]
         os = valid_os_or_current(options[:operating_system])
@@ -246,7 +284,7 @@ module U3d
           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
+        UI.user_error!('Please specify a Unity version') unless version
         version
       end
 

data/lib/u3d/commands_generator.rb

@@ -33,10 +33,20 @@ module U3d
     include Commander::Methods
     UI = U3dCore::UI
 
+    UNICODE_FILE = File.expand_path('../../assets/utf8.txt', __FILE__)
+
     def self.start
+      check_locale
       new.run
     end
 
+    def self.check_locale
+      File.read(UNICODE_FILE).split("\n")
+    rescue ArgumentError => _e
+      UI.important "WARNING! Your Locale system appears to be incompatible with Unicode. Set you LOCALE appropriately"
+      UI.important "See https://github.com/DragonBox/u3d#setup"
+    end
+
     def extract_run_args(args = ARGV)
       both_args = [[], []]
       idx = 0
@@ -212,6 +222,32 @@ More on that: https://forum.unity3d.com/threads/unity-on-linux-release-notes-and
         end
       end
 
+      command :console do |c|
+        c.syntax = 'u3d console'
+        c.summary = "Run an interactive console"
+        c.action do |_args, _options|
+          Commands.console
+        end
+      end
+
+      command :move do |c|
+        c.syntax = 'u3d move [--dry_run] --long <version>'
+        # c.option '-f', '--force', Array, 'Specifies which packages to download/install. Overriden by --all'
+        c.option '-l', '--long', "Rename the installation dir into its long name pattern, namely #{U3d::UNITY_DIR_LONG} on Windows/Mac and #{U3d::UNITY_DIR_LINUX_LONG} on Linux"
+        c.option '--dry_run', "show what would have happened"
+        c.summary = "Move an existing Unity install to an optionally specified new folder, marking it as non moveable later on"
+        c.description = %(
+          #{c.summary}
+          Sometimes you want to move Unity to a different folder/path and let u3d stop modifying trying to move it around.
+
+          The current command only supports 'long' installation dir names, containing not only the version but also the build number.
+          See https://github.com/DragonBox/u3d#unity-build-numbers for more information.
+                  )
+        c.action do |args, options|
+          Commands.move(args: args, options: convert_options(options))
+        end
+      end
+
       default_command :run
 
       run!

data/lib/u3d/iniparser.rb

@@ -48,7 +48,6 @@ module U3d
         end
         begin
           result = IniFile.load(ini_path).to_h
-          result = filter_broken_linux(result) if os == 'linux'
         rescue StandardError => e
           raise "Could not parse INI data (#{e})"
         end
@@ -98,10 +97,6 @@ url=#{url}
         end
       end
 
-      def filter_broken_linux(ini_hash)
-        ini_hash.select { |_k, v| v['url'] && !v['url'].end_with?('.pkg') }
-      end
-
       def default_ini_path
         File.join(U3dCore::Helper.data_path, 'ini_files')
       end

data/lib/u3d/installation.rb

@@ -21,13 +21,16 @@
 ## --- END LICENSE BLOCK ---
 
 require 'u3d/utils'
+require 'u3d_core/admin_tools'
+require 'fileutils'
 
 module U3d
   UNITY_DIR_CHECK = /Unity_\d+\.\d+\.\d+[a-z]\d+/
   UNITY_DIR_CHECK_LINUX = /unity-editor-\d+\.\d+\.\d+[a-z]\d+\z/
+  U3D_DO_NOT_MOVE = ".u3d_do_not_move".freeze
 
   class Installation
-    attr_reader :root_path
+    attr_accessor :root_path
 
     NOT_PLAYBACKENGINE_PACKAGES = %w[Documentation StandardAssets MonoDevelop].freeze
     PACKAGE_ALIASES =
@@ -67,6 +70,22 @@ module U3d
       false
     end
 
+    def do_not_move?
+      File.exist?(@root_path) && File.exist?(do_not_move_file_path)
+    end
+
+    def do_not_move!(dry_run: false)
+      if dry_run
+        UI.message "Would create '#{do_not_move_file_path}'"
+      else
+        begin
+          FileUtils.touch do_not_move_file_path
+        rescue Errno::EACCES => _e
+          U3dCore::AdminTools.create_file(Helper.operating_system, do_not_move_file_path)
+        end
+      end
+    end
+
     def package_installed?(package)
       return true if (packages || []).include?(package)
 
@@ -78,6 +97,12 @@ module U3d
 
       return !(aliases & packages).empty?
     end
+
+    private
+
+    def do_not_move_file_path
+      File.join(@root_path, U3D_DO_NOT_MOVE)
+    end
   end
 
   class PlaybackEngineUtils
@@ -152,7 +177,7 @@ module U3d
     end
 
     def clean_install?
-      !(root_path =~ UNITY_DIR_CHECK).nil?
+      do_not_move? || !(root_path =~ UNITY_DIR_CHECK).nil?
     end
 
     private
@@ -175,6 +200,7 @@ module U3d
         rev = find_build_number_in("#{root}#{p}")
         return rev if rev
       end
+      nil
     end
 
     private
@@ -257,7 +283,7 @@ module U3d
     end
 
     def clean_install?
-      !(root_path =~ UNITY_DIR_CHECK_LINUX).nil?
+      do_not_move? || !(root_path =~ UNITY_DIR_CHECK_LINUX).nil?
     end
   end
 
@@ -372,7 +398,7 @@ module U3d
     end
 
     def clean_install?
-      !(root_path =~ UNITY_DIR_CHECK).nil?
+      do_not_move? || !(root_path =~ UNITY_DIR_CHECK).nil?
     end
   end
 end

data/lib/u3d/installer.rb

@@ -21,6 +21,7 @@
 ## --- END LICENSE BLOCK ---
 
 require 'u3d/utils'
+require 'u3d_core/admin_tools'
 require 'u3d_core/core_ext/string'
 require 'u3d/installation'
 require 'fileutils'
@@ -32,32 +33,23 @@ module U3d
   DEFAULT_MAC_INSTALL = '/'.freeze
   DEFAULT_WINDOWS_INSTALL = 'C:/Program Files/'.freeze
   UNITY_DIR = "Unity_%<version>s".freeze
+  UNITY_DIR_LONG = "Unity_%<version>s_%<build_number>s".freeze
   UNITY_DIR_LINUX = "unity-editor-%<version>s".freeze
+  UNITY_DIR_LINUX_LONG = "unity-editor-%<version>s_%<build_number>s".freeze
 
   class Installer
     def self.create
-      installer = if Helper.mac?
-                    MacInstaller.new
-                  elsif Helper.linux?
-                    LinuxInstaller.new
-                  else
-                    WindowsInstaller.new
-                  end
-      sanitize_installs(installer)
-      installer
+      if Helper.mac?
+        MacInstaller.new
+      elsif Helper.linux?
+        LinuxInstaller.new
+      else
+        WindowsInstaller.new
+      end
     end
 
     def self.sanitize_installs(installer)
-      return unless UI.interactive? || Helper.test?
-      unclean = []
-      installer.installed.each { |unity| unclean << unity unless unity.clean_install? }
-      return if unclean.empty?
-      UI.important("u3d can optionally standardize the existing Unity installation names and locations.")
-      UI.important("Check the documentation for more information:")
-      UI.important("** https://github.com/DragonBox/u3d/blob/master/README.md#default-installation-paths **")
-      unclean.each { |unity| installer.sanitize_install(unity, dry_run: true) }
-      return unless UI.confirm("#{unclean.count} Unity installation(s) will be moved. Proceed??")
-      unclean.each { |unity| installer.sanitize_install(unity) }
+      installer.sanitize_installs
     end
 
     def self.install_modules(files, version, installation_path: nil)
@@ -75,34 +67,51 @@ module U3d
     end
   end
 
+  class BaseInstaller
+    def sanitize_installs
+      return unless UI.interactive? || Helper.test?
+      unclean = []
+      installed.each { |unity| unclean << unity unless unity.clean_install? }
+      return if unclean.empty?
+      UI.important("u3d can optionally standardize the existing Unity installation names and locations.")
+      UI.important("Check the documentation for more information:")
+      UI.important("** https://github.com/DragonBox/u3d/blob/master/README.md#default-installation-paths **")
+      unclean.each { |unity| sanitize_install(unity, dry_run: true) }
+      return unless UI.confirm("#{unclean.count} Unity installation(s) will be moved. Proceed??")
+      unclean.each { |unity| sanitize_install(unity) }
+    end
+
+    def installed_sorted_by_versions
+      list = installed
+      return [] if list.empty?
+      # version -> installations
+      arraym = list.map { |a| [a.version, a] }
+      map = Hash[*arraym.flatten]
+      # sorted versions
+      vcomparators = map.keys.map { |k| UnityVersionComparator.new(k) }
+      sorted_keys = vcomparators.sort.map { |v| v.version.to_s }
+      sorted_keys.map { |k| map[k] }
+    end
+  end
+
+  # deprecated
   class CommonInstaller
     def self.sanitize_install(source_path, new_path, command, dry_run: false)
-      if source_path == new_path
-        UI.important "sanitize_install does nothing if the path won't change (#{source_path})"
-        return
-      end
-
-      if dry_run
-        UI.message "'#{source_path}' would move to '#{new_path}'"
-      else
-        UI.important "Moving '#{source_path}' to '#{new_path}'..."
-        U3dCore::CommandExecutor.execute(command: command, admin: true)
-        UI.success "Successfully moved '#{source_path}' to '#{new_path}'"
-      end
-    rescue StandardError => e
-      UI.error "Unable to move '#{source_path}' to '#{new_path}': #{e}"
+      UI.deprecated("Use U3dCore::AdminTools.move_files")
+      U3dCore::AdminTools.move_file(source_path, new_path, command, dry_run: dry_run)
     end
   end
 
-  class MacInstaller
-    def sanitize_install(unity, dry_run: false)
+  class MacInstaller < BaseInstaller
+    def sanitize_install(unity, long: false, dry_run: false)
       source_path = unity.root_path
       parent = File.expand_path('..', source_path)
-      new_path = File.join(parent, format(UNITY_DIR, version: unity.version))
+      dir_name = format(long ? UNITY_DIR_LONG : UNITY_DIR,
+                        version: unity.version, build_number: unity.build_number)
+      new_path = File.join(parent, dir_name)
 
-      command = "mv #{source_path.shellescape} #{new_path.shellescape}"
-
-      CommonInstaller.sanitize_install(source_path, new_path, command, dry_run: dry_run)
+      moved = U3dCore::AdminTools.move_os_file(:mac, source_path, new_path, dry_run: dry_run)
+      unity.root_path = new_path if moved && !dry_run
     end
 
     def installed
@@ -192,15 +201,17 @@ module U3d
     end
   end
 
-  class LinuxInstaller
-    def sanitize_install(unity, dry_run: false)
+  # rubocop:disable ClassLength
+  class LinuxInstaller < BaseInstaller
+    def sanitize_install(unity, long: false, dry_run: false)
       source_path = File.expand_path(unity.root_path)
       parent = File.expand_path('..', source_path)
-      new_path = File.join(parent, format(UNITY_DIR_LINUX, version: unity.version))
-
-      command = "mv #{source_path.shellescape} #{new_path.shellescape}"
+      dir_name = format(long ? UNITY_DIR_LINUX_LONG : UNITY_DIR_LINUX,
+                        version: unity.version, build_number: unity.build_number)
+      new_path = File.join(parent, dir_name)
 
-      CommonInstaller.sanitize_install(source_path, new_path, command, dry_run: dry_run)
+      moved = U3dCore::AdminTools.move_os_file(:linux, source_path, new_path, dry_run: dry_run)
+      unity.root_path = new_path if moved && !dry_run
     end
 
     def installed
@@ -208,12 +219,12 @@ module U3d
       paths.map { |path| LinuxInstallation.new(root_path: path) }
     end
 
-    # rubocop:disable UnusedMethodArgument
+    # rubocop:disable UnusedMethodArgument, PerceivedComplexity
     def install(file_path, version, installation_path: nil, info: {})
-      # rubocop:enable UnusedMethodArgument
+      # rubocop:enable UnusedMethodArgument, PerceivedComplexity
       extension = File.extname(file_path)
 
-      raise "Installation of #{extension} files is not supported on Linux" unless ['.sh', '.xz'].include? extension
+      raise "Installation of #{extension} files is not supported on Linux" unless ['.sh', '.xz', '.pkg'].include? extension
       if extension == '.sh'
         path = installation_path || DEFAULT_LINUX_INSTALL
         install_sh(file_path, installation_path: path)
@@ -221,6 +232,10 @@ module U3d
         new_path = File.join(DEFAULT_LINUX_INSTALL, format(UNITY_DIR_LINUX, version: version))
         path = installation_path || new_path
         install_xz(file_path, installation_path: path)
+      elsif extension == '.pkg'
+        new_path = File.join(DEFAULT_LINUX_INSTALL, format(UNITY_DIR_LINUX, version: version))
+        path = installation_path || new_path
+        install_pkg(file_path, installation_path: path)
       end
 
       # Forces sanitation for installation of 'weird' versions eg 5.6.1xf1Linux
@@ -262,6 +277,33 @@ module U3d
       UI.success 'Installation successful'
     end
 
+    def install_pkg(file, installation_path: nil)
+      raise 'Missing installation_path' unless installation_path
+      raise 'Only able to install pkg on top of existing Unity installs' unless File.exist? installation_path
+      raise 'Missing 7z' if `which 7z`.empty?
+
+      Dir.mktmpdir do |tmp_dir|
+        UI.verbose "Working in tmp dir #{tmp_dir}"
+
+        command = "7z -aos -o#{tmp_dir.shellescape} e #{file.shellescape}"
+        U3dCore::CommandExecutor.execute(command: command)
+
+        target_location = pkg_install_path(installation_path, "#{tmp_dir}/PackageInfo")
+
+        # raise "Path for #{target_location} already exists" if path File.exist? target_location
+
+        command = "cd #{target_location.shellescape}; gzip -dc #{tmp_dir}/Payload | cpio -i '*' -"
+        command = "mkdir -p #{target_location.shellescape}; #{command}" # unless File.directory? installation_path
+
+        U3dCore::CommandExecutor.execute(command: command, admin: true)
+      end
+    rescue StandardError => e
+      UI.verbose(e.backtrace.join("\n"))
+      UI.error "Failed to install pkg file #{file} at #{installation_path}: #{e}"
+    else
+      UI.success 'Installation successful'
+    end
+
     def uninstall(unity: nil)
       UI.verbose("Uninstalling Unity at '#{unity.root_path}'...")
       command = "rm -r #{unity.root_path}"
@@ -274,6 +316,27 @@ module U3d
 
     private
 
+    def pkg_install_path(unity_root_path, pinfo_path)
+      raise "PackageInfo not found under #{pinfo_path}" unless File.exist? pinfo_path
+      pinfo = File.read(pinfo_path)
+      require 'rexml/document'
+      d = REXML::Document.new(pinfo)
+      identifier = d.root.attributes['identifier']
+
+      case identifier
+      when 'com.unity3d.Documentation'
+        "#{unity_root_path}/Editor/Data/"
+      when 'com.unity3d.StandardAssets'
+        "#{unity_root_path}/Editor/Standard Assets/"
+      when 'com.unity3d.ExampleProject'
+        unity_root_path
+      else
+        install_location = d.root.attributes['install-location']
+        raise "Not sure how to install this module with identifier #{identifier} install-location: #{install_location}" unless install_location.start_with? '/Applications/Unity/'
+        install_location.gsub(%(\/Applications\/Unity), "#{unity_root_path}/Editor/Data")
+      end
+    end
+
     def list_installed_paths
       find = File.join(DEFAULT_LINUX_INSTALL, 'unity-editor-*', 'Editor')
       paths = Dir[find]
@@ -290,19 +353,18 @@ module U3d
       paths
     end
   end
+  # rubocop:enable ClassLength
 
-  class WindowsInstaller
-    def sanitize_install(unity, dry_run: false)
+  class WindowsInstaller < BaseInstaller
+    def sanitize_install(unity, long: false, dry_run: false)
       source_path = File.expand_path(unity.root_path)
       parent = File.expand_path('..', source_path)
-      new_path = File.join(parent, format(UNITY_DIR, version: unity.version))
-
-      source_path.tr!('/', '\\')
-      new_path.tr!('/', '\\')
-
-      command = "move #{source_path.argescape} #{new_path.argescape}"
+      dir_name = format(long ? UNITY_DIR_LONG : UNITY_DIR,
+                        version: unity.version, build_number: unity.build_number)
+      new_path = File.join(parent, dir_name)
 
-      CommonInstaller.sanitize_install(source_path, new_path, command, dry_run: dry_run)
+      moved = U3dCore::AdminTools.move_os_file(:win, source_path, new_path, dry_run: dry_run)
+      unity.root_path = new_path if moved && !dry_run
     end
 
     def installed
@@ -323,23 +385,23 @@ module U3d
 
     def install_exe(file_path, installation_path: nil, info: {})
       installation_path ||= DEFAULT_WINDOWS_INSTALL
-      final_path = Utils.windows_path(installation_path)
+      final_path = U3dCore::Helper.windows_path(installation_path)
       Utils.ensure_dir(final_path)
       begin
         command = nil
         if info['cmd']
           command = info['cmd']
           if /msiexec/ =~ command
-            command.sub!(/{FILENAME}/, '"' + Utils.windows_path(file_path) + '"')
+            command.sub!(/{FILENAME}/, '"' + U3dCore::Helper.windows_path(file_path) + '"')
           else
-            command.sub!(/{FILENAME}/, file_path)
+            command.sub!(/{FILENAME}/, file_path.argescape)
           end
           command.sub!(/{INSTDIR}/, final_path)
           command.sub!(/{DOCDIR}/, final_path)
           command.sub!(/{MODULEDIR}/, final_path)
           command.sub!(%r{\/D=}, '/S /D=') unless %r{\/S} =~ command
         end
-        command ||= file_path.to_s
+        command ||= file_path.argescape
         U3dCore::CommandExecutor.execute(command: command, admin: true)
       rescue StandardError => e
         UI.error "Failed to install package at #{file_path}: #{e}"

data/lib/u3d/utils.rb

@@ -202,7 +202,8 @@ module U3d
       end
 
       def windows_path(path)
-        path.gsub(%r{\/(\d)}, '/\\\\\1').tr('/', '\\')
+        UI.deprecated("Use U3dCore::Helper.windows_path")
+        U3dCore::Helper.windows_path(path)
       end
 
       private

data/lib/u3d/version.rb

@@ -21,7 +21,7 @@
 ## --- END LICENSE BLOCK ---
 
 module U3d
-  VERSION = '1.0.20'.freeze
+  VERSION = '1.0.21'.freeze
   DESCRIPTION = 'Provides numerous tools for installing, managing and running the Unity game engine from command line.'.freeze
   UNITY_VERSIONS_NOTE = "Unity uses the following version formatting: 0.0.0x0. The \'x\' can takes different values:\n"\
   "\t. 'f' are the main release candidates for Unity\n"\

data/lib/u3d_core/admin_tools.rb

@@ -0,0 +1,72 @@
+## --- BEGIN LICENSE BLOCK ---
+# Original work Copyright (c) 2015-present the fastlane authors
+# Modified work Copyright 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 U3dCore
+  class AdminTools
+    def self.move_os_file(os, source_path, new_path, dry_run:)
+      if os == :win
+        source_path = U3dCore::Helper.windows_path(source_path)
+        new_path = U3dCore::Helper.windows_path(new_path)
+        command = "move #{source_path.argescape} #{new_path.argescape}"
+      else
+        command = "mv #{source_path.shellescape} #{new_path.shellescape}"
+      end
+      move_file(source_path, new_path, command, dry_run: dry_run)
+    end
+
+    def self.create_file(os, path, dry_run: false)
+      if dry_run
+        UI.message "'#{source_path}' would create file at '#{path}'"
+        return
+      end
+
+      if os == :win
+        path = U3dCore::Helper.windows_path(path)
+        command = "fsutil file createnew #{path.argescape} 0"
+      else
+        command = "touch #{path.shellescape}"
+      end
+      U3dCore::CommandExecutor.execute(command: command, admin: true)
+      true
+    end
+
+    # move one path to a new path
+    def self.move_file(source_path, new_path, command, dry_run: false)
+      if source_path == new_path
+        UI.verbose "move_file does nothing if the path won't change (#{source_path})"
+        return false
+      end
+
+      if dry_run
+        UI.message "'#{source_path}' would move to '#{new_path}'"
+      else
+        UI.important "Moving '#{source_path}' to '#{new_path}'..."
+        U3dCore::CommandExecutor.execute(command: command, admin: true)
+        UI.success "Successfully moved '#{source_path}' to '#{new_path}'"
+      end
+      true
+    rescue StandardError => e
+      UI.error "Unable to move '#{source_path}' to '#{new_path}': #{e}"
+      false
+    end
+  end
+end

data/lib/u3d_core/command_executor.rb

@@ -115,42 +115,55 @@ module U3dCore
         return output.join("\n")
       end
 
-      # rubocop:disable PredicateName
-      def has_admin_privileges?
-        # rubocop:enable PredicateName
+      # rubocop:disable PredicateName,PerceivedComplexity
+      def has_admin_privileges?(retry_count: 2)
+        # rubocop:enable PredicateName,PerceivedComplexity
         if Helper.windows?
           begin
-            result = system('reg query HKU\\S-1-5-19', out: File::NULL, err: File::NULL)
+            result = system_no_output('reg query HKU\\S-1-5-19')
           rescue StandardError
             result = false
           end
         else
-          credentials = U3dCore::Credentials.new(user: ENV['USER'])
-          begin
-            result = system("sudo -k && echo #{credentials.password.shellescape} | sudo -S /usr/bin/whoami",
-                            out: File::NULL,
-                            err: File::NULL)
-          rescue StandardError
-            result = false
+          env_username = ENV['USER']
+          if env_username == "root"
+            result = true
+          else
+            credentials = U3dCore::Credentials.new(user: env_username)
+            begin
+              result = system_no_output("sudo -k && echo #{credentials.password.shellescape} | sudo -S /usr/bin/whoami")
+            rescue StandardError
+              result = false
+            end
+            credentials.forget_credentials unless result # FIXME: why?
           end
-          credentials.forget_credentials unless result # FIXME: why?
         end
         # returns false if result is nil (command execution fail)
-        return (result ? true : false)
+        result = result ? true : false
+        result = has_admin_privileges?(retry_count: retry_count - 1) unless retry_count <= 0 || result
+        result
       end
 
       def grant_admin_privileges(command)
-        cred = U3dCore::Credentials.new(user: ENV['USER'])
         if Helper.windows?
           raise CredentialsError, "The command \'#{command}\' must be run in administrative shell" unless has_admin_privileges?
         else
-          command = "sudo -k && echo #{cred.password.shellescape} | sudo -S bash -c \"#{command}\""
+          env_username = ENV['USER']
+          unless env_username == "root"
+            cred = U3dCore::Credentials.new(user: env_username)
+            raise CredentialsError, "The command \'#{command}\' must be run with admin privileges" unless has_admin_privileges?
+            command = "sudo -k && echo #{cred.password.shellescape} | sudo -S bash -c \"#{command}\""
+          end
         end
         UI.verbose 'Admin privileges granted for command execution'
         command
       end
+
+      def system_no_output(command)
+        system(command, out: File::NULL, err: File::NULL)
+      end
     end
 
-    private_class_method :execute_command_low
+    private_class_method :execute_command_low, :system_no_output
   end
 end

data/lib/u3d_core/helper.rb

@@ -41,6 +41,10 @@ module U3dCore
       end
     end
 
+    def self.windows_path(path)
+      path.gsub(%r{\/(\d)}, '/\\\\\1').tr('/', '\\')
+    end
+
     # Runs a given command using backticks (`)
     # and prints them out using the UI.command method
     def self.backticks(command, print: true)

data/u3d.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "coveralls"
   spec.add_development_dependency "github_changelog_generator"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.1.0"
   spec.add_development_dependency 'rspec_junit_formatter', '~> 0.2.3'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: u3d
 version: !ruby/object:Gem::Version
-  version: 1.0.20
+  version: 1.0.21
 platform: ruby
 authors:
 - Jerome Lacoste
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-19 00:00:00.000000000 Z
+date: 2018-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -176,7 +176,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -271,6 +271,7 @@ files:
 - LOG_RULES.md
 - README.md
 - Rakefile
+- WIP
 - appveyor.yml
 - build.sh
 - config/log_rules.json
@@ -281,6 +282,7 @@ files:
 - docs/assets/ci_jenkins_version_node.png
 - docs/assets/ci_jenkins_version_param.png
 - docs/assets/u3d_available.png
+- docs/assets/u3d_console.png
 - docs/assets/u3d_install.png
 - docs/assets/u3d_licenses.png
 - docs/assets/u3d_list.png
@@ -372,6 +374,7 @@ files:
 - fastlane-plugin-u3d/lib/fastlane/plugin/u3d/helper/u3d_helper.rb
 - fastlane-plugin-u3d/lib/fastlane/plugin/u3d/version.rb
 - fastlane-plugin-u3d/spec/spec_helper.rb
+- lib/assets/utf8.txt
 - lib/u3d.rb
 - lib/u3d/cache.rb
 - lib/u3d/commands.rb
@@ -393,6 +396,7 @@ files:
 - lib/u3d/utils.rb
 - lib/u3d/version.rb
 - lib/u3d_core.rb
+- lib/u3d_core/admin_tools.rb
 - lib/u3d_core/command_executor.rb
 - lib/u3d_core/command_runner.rb
 - lib/u3d_core/core_ext/hash.rb