u3d 0.9

data/lib/u3d/commands.rb

@@ -0,0 +1,307 @@
+## --- 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 ---
+
+require 'u3d/unity_versions'
+require 'u3d/downloader'
+require 'u3d/installer'
+require 'u3d/cache'
+require 'u3d/utils'
+require 'u3d/log_analyzer'
+require 'u3d_core/command_executor'
+require 'u3d_core/credentials'
+require 'fileutils'
+
+module U3d
+  # API for U3d, redirecting calls to class they concern
+  class Commands
+    class << self
+      def list_installed(options: {})
+        list = Installer.create.installed
+        if list.empty?
+          UI.important 'No Unity version installed'
+          return
+        end
+        list.each do |u|
+          UI.message "Version #{u.version}\t(#{u.path})"
+          packages = u.packages
+          next unless options[:packages] && packages && !packages.empty?
+          UI.message 'Packages:'
+          packages.each { |pack| UI.message " - #{pack}" }
+        end
+      end
+
+      def list_available(options: {})
+        ver = options[:unity_version]
+        os = 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?
+
+        versions = if ver
+                     { ver => cache[os.id2name]['versions'][ver] }
+                   else
+                     cache[os.id2name]['versions']
+                   end
+
+        vcomparators = versions.keys.map { |k| UnityVersionComparator.new(k) }
+        if rl
+          letter = release_letter_mapping["latest_#{rl}".to_sym]
+          UI.message "Filtering available versions with release level '#{rl}' [letter '#{letter}']"
+          vcomparators.select! { |vc| vc.version.parts[3] == letter }
+        end
+        sorted_keys = vcomparators.sort.map { |v| v.version.to_s }
+
+        sorted_keys.each do |k|
+          v = versions[k]
+          UI.message "Version #{k}: " + v.to_s.cyan.underline
+          next unless options[:packages]
+          inif = nil
+          begin
+            inif = U3d::INIparser.load_ini(k, versions, os: os)
+          rescue => e
+            UI.error "Could not load packages for this version (#{e})"
+          else
+            UI.message 'Packages:'
+            inif.keys.each { |pack| UI.message " - #{pack}" }
+          end
+        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)
+
+        os = U3dCore::Helper.operating_system
+        cache = Cache.new(force_os: os)
+        versions = cache[os.id2name]['versions']
+        version = interpret_latest(version, versions)
+
+        unless packages.include?('Unity')
+          unity = check_unity_presence(version: version)
+          return unless unity
+          options[:installation_path] ||= unity.path if Helper.windows?
+        end
+
+        U3d::Globals.use_keychain = true if options[:keychain] && Helper.mac?
+
+        unless options[:no_install]
+          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
+
+        return if options[:no_install]
+        files.each do |name, file, info|
+          UI.verbose "Installing #{name}#{info['mandatory'] ? ' (mandatory package)' : ''}, with file #{file}"
+          Installer.install_module(file, version, installation_path: options[:installation_path], info: info)
+        end
+      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)
+
+        unless packages.include?('Unity')
+          unity = check_unity_presence(version: version)
+          return unless unity
+          options[:installation_path] ||= unity.path if Helper.windows?
+        end
+
+        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?
+
+        os = U3dCore::Helper.operating_system
+        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
+
+        files.each do |name, file, info|
+          UI.verbose "Installing #{name}#{info['mandatory'] ? ' (mandatory package)' : ''}, with file #{file}"
+          Installer.install_module(file, version, installation_path: options[:installation_path], info: info)
+        end
+      end
+
+      def run(options: {}, run_args: [])
+        version = options[:unity_version]
+
+        runner = Runner.new
+        pp = runner.find_projectpath_in_args(run_args)
+        pp = Dir.pwd unless pp
+        up = UnityProject.new(pp)
+
+        unless version # fall back in project default if we are on a Unity project
+          version = up.editor_version if up.exist?
+          unless version
+            UI.user_error!('Not sure which version of Unity to run. Are you in a project?')
+          end
+        end
+
+        run_args = ['-projectpath', up.path] if run_args.empty? && up.exist?
+
+        # 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)
+      end
+
+      def credentials(args: [], options: {})
+        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'
+          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'
+          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
+        end
+      end
+
+      def local_analyze(args: [])
+        raise ArgumentError, 'No files given' if args.empty?
+        raise ArgumentError, "File #{args[0]} does not exist" unless File.exist? args[0]
+
+        analyzer = LogAnalyzer.new
+        File.open(args[0], 'r') do |f|
+          f.readlines.each { |l| analyzer.parse_line l }
+        end
+      end
+
+      def release_levels
+        [:stable, :beta, :patch]
+      end
+
+      def release_letter_mapping
+        {
+          latest: 'f',
+          latest_stable: 'f',
+          latest_beta: 'b',
+          latest_patch: 'p'
+        }
+      end
+
+      private
+
+      def interpret_latest(version, versions)
+        return version unless release_letter_mapping.keys.include? version.to_sym
+
+        letter = release_letter_mapping[version.to_sym]
+
+        iversion = versions.keys.map { |k| UnityVersionComparator.new(k) }
+                           .sort
+                           .reverse
+                           .find { |c| c.version.parts[3] == letter }
+                           .version.to_s
+        UI.message "Version '#{version}' is #{iversion}."
+        iversion
+      end
+
+      def packages_with_unity_first(options)
+        temp = options[:packages] || ['Unity']
+        temp.insert(0, 'Unity') if temp.delete('Unity')
+        temp
+      end
+
+      def check_unity_presence(version: nil)
+        installed = Installer.create.installed
+        unity = installed.find { |u| u.version == version }
+        if unity.nil?
+          UI.error "Version #{version} of Unity is not installed yet. Please install it first before installing any other module"
+        else
+          UI.verbose "Unity #{version} is installed at #{unity.path}"
+          return unity
+        end
+        nil
+      end
+    end
+  end
+end

data/lib/u3d/commands_generator.rb

@@ -0,0 +1,163 @@
+## --- 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 ---
+
+require 'commander'
+require 'u3d_core'
+require 'u3d/commands'
+
+HighLine.track_eof = false
+
+module U3d
+  # CLI using commander gem for u3d
+  class CommandsGenerator
+    include Commander::Methods
+    UI = U3dCore::UI
+
+    def self.start
+      new.run
+    end
+
+    def extract_run_args(args = ARGV)
+      both_args = [[], []]
+      idx = 0
+      args.each do |arg|
+        if arg == '--'
+          idx = 1
+          next
+        end
+        both_args[idx] << arg
+      end
+      args.replace both_args[0]
+      both_args[1]
+    end
+
+    def convert_options(options)
+      o = options.__hash__.dup
+      o.delete(:verbose)
+      o
+    end
+
+    def run
+      program :version, U3d::VERSION
+      program :description, U3d::DESCRIPTION
+      program :help, 'Authors', 'Jerome Lacoste <jerome@wewanttoknow.com>, Paul Niezborala <p.niezborala@wewanttoknow.com>'
+      program :help, 'A word on Unity versions', U3d::UNITY_VERSIONS_NOTE
+
+      global_option('--verbose') { U3dCore::Globals.verbose = true }
+
+      command :run do |c|
+        # Intended for backward compatibilty purposes for run command
+        # Meant to fetch options after '--' unknown by CommandsGenerator
+        run_args = extract_run_args
+
+        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 '-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
+          U3dCore::Globals.log_timestamps = true
+          Commands.run(options: convert_options(options), run_args: run_args)
+        end
+      end
+
+      command :list do |c|
+        c.syntax = 'u3d list [-p | --packages]'
+        c.option '-p', '--packages', 'Lists installed packages as well'
+        c.example 'List currently installed Unity3d versions, as well as installed packages', 'u3d list -p'
+        c.description = 'List installed version of Unity3d'
+        c.action do |_args, options|
+          Commands.list_installed(options: convert_options(options))
+        end
+      end
+
+      command :available do |c|
+        oses = U3dCore::Helper.operating_systems
+        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 '-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'
+        c.example 'List all versions available, forcing a refresh of the available packages from Unity servers', 'u3d available -f'
+        c.example 'List stable versions available', 'u3d available -r stable -p'
+        c.example 'List all versions available for Linux platform', 'u3d available -o linux'
+        c.example 'List packages available for Unity version 5.6.0f3', 'u3d available -u 5.6.0f3 -p'
+        c.description = 'List download-ready versions of Unity3d'
+        c.action do |_args, options|
+          options.default packages: false
+          Commands.list_available(options: convert_options(options))
+        end
+      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.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.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 unity'
+        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))
+        end
+      end
+
+      command :credentials do |c|
+        c.syntax = "u3d credentials <#{Commands.credentials_actions.join(' | ')}>"
+        c.description = 'Manages keychain credentials so u3d remembers them. [OSX only]'
+        c.action do |args, options|
+          Commands.credentials(args: args, options: convert_options(options))
+        end
+      end
+
+      command :prettify do |c|
+        c.syntax = 'u3d prettify <logfile>'
+        c.description = 'Prettify a saved logfile'
+        c.action do |args, _options|
+          Commands.local_analyze(args: args)
+        end
+      end
+
+      default_command :run
+
+      run!
+    end
+  end
+end