u3d 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d95e2013ede0bbc2672fbdac7ec3e4438dbb905
-  data.tar.gz: e3e5cf65083bb3c2ac16755603c2efa23203b766
+  metadata.gz: 5fa90ce7799123f17d7760705c0e678a9c24a057
+  data.tar.gz: 973b34ba000a634b8bcf544de1a4b6ede5bc7553
 SHA512:
-  metadata.gz: 3fa4705df6c50c805cef1e3dc01b92f18a071f4077118678df9880af59b51db767685545734f7948b21fe052918b6ae4fb82b1fad68fbd3e21d3b7bcc91806db
-  data.tar.gz: fdde9cf62e21bce06e5af03a72c5145f803cf006e1215d11b244401a9509d517d5dd9186ac9e5453c14a8b3f1f442008a207691aa72fa6cafe68872a99226235
+  metadata.gz: 5bd4042294072a4a90f70dfe7287e0eb5c0ef6a9151fcc42bf477873c8bc21e0118d3b1123013584f8f32dc3daaa2d415c3a2ede586665b469202adc75092ff4
+  data.tar.gz: 1ee8b5bdf89fa4ef179794516d9943fb64d5bd3b29cedaf11de91a81ace1b1dc133ca146cdf7bdd06fad13988aae8f4420220a298d0c21048cc1c553e9f144ca

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    u3d (0.9.1)
+    u3d (0.9.2)
       colored (>= 1.2, < 2.0.0)
       commander (>= 4.4.0, < 5.0.0)
       file-tail (>= 1.2.0)

data/LOG_RULES.md

@@ -27,7 +27,7 @@ Therefore, our log prettifier behaves in a phased fashion. It has an inner memor
 
 A phase is started when a given pattern is encountered in the logs, and ends in two different ways: either a terminating pattern is met, or another phase starts.
 
-Because there are rules that you may want to apply throughout the whole analysis, there is a peculiar phase: the 'GENERAL' one. It contains a generic set of rules which will be applied in parallel to the active phase's ruleset, and allows for not having to repeat rules in different phases. The main use which this phase was designed for is to catch exceptions, warnings and errors no matter the active phase, but it is obviously not limited to that.
+Because there are rules that you may want to apply throughout the whole analysis, there is a peculiar phase: the 'GENERAL' one. It contains a generic set of rules which will be applied in parallel to the active phase's ruleset, and allows for not having to repeat rules in different phases. The main use which this phase was designed for is exceptions catching, warnings and errors no matter the active phase, but it is obviously not limited to that.
 
 ### B - Phase syntax
 
@@ -53,15 +53,15 @@ The syntax of phases is as follows:
 * __[OPTIONAL]__ `phase_end_pattern`: this patterns specifies when the phase should end. It is optional because a phase will also end when another one begins, as stated in II A. This is used when you know exactly when the phase has finished.
 * `rules`: contains a set of rules. See III for further information on rule declaration.
 
-## Rules
+## III - Rules
 
 ### A - Rule declaration
 
 The information contained in Unity's log can be formatted differently: it can be contained in a single line, spread on several, the lines can contain exactly what you want or be way too verbose for your liking.
 
-In consequence, the rule syntax is pretty loose to cover as many cases as possible, and below is describe syntax for some of archetypal rules.
+In consequence, the rule syntax is pretty loose to cover as many cases as possible, and below is describe syntax for some archetypal rules.
 
-They contain nonetheless two mandatory sections and a recurring one:
+They contain nonetheless two mandatory sections:
 
 ```json
 "rule_name": {
@@ -86,6 +86,7 @@ This example rule extracts the line stating whether the asset database has succe
 ### C - One line parsing with data extraction
 
 When the line formatting does not suit your needs, you may want to process it rather than simply logging it. Here is an example which occurs at the beginning of the compile phase:
+
 ```json
 "target": {
   "active": true,
@@ -97,7 +98,8 @@ Simple rewording of the base log, by extracting the meaningful information and p
 
 ### D - Multi-line parsing and displaying
 
-The following rule illustrates when you want to log a chunk of lines as they appear in Unity at the same time. This structure is useful when you know exactly where the block begins and end. If not, please check section F.
+The following rule illustrates when you want to log a chunk of lines as they appear in Unity at the same time. This structure is useful when you know exactly where the block begins and ends. If not, please check section F.
+
 ```json
 "percentage": {
   "active": true,
@@ -106,11 +108,12 @@ The following rule illustrates when you want to log a chunk of lines as they app
   "store_lines": true
 }
 ```
-`start_pattern` and `end_pattern` are the limits in between which the lines will be parsed. `store_lines` indicates that we want these lines stored, and displayed later.
+`start_pattern` and `end_pattern` are the limits in between which the lines will be parsed. `store_lines` indicates that we want these lines stored, and displayed later on.
 
 ###  E - Multi-line parsing and displaying with line filtering and data extraction
 
 This example illustrates several additional functionalities in comparison to the previous sections.
+
 ```json
 "fail": {
   "active": true,
@@ -134,7 +137,8 @@ _Note_: this is a modified version of the actual rule, for example purposes.
 
 ### F - Multi-line with no clear entry point (memory fetching)
 
-This section illustrates how a rule will fetch lines from the previously logged lines. It is used when you want to log several lines, but the fixed point is not at the beginning of the block.
+This section illustrates how a rule will fetch lines from the previously logged lines. It is used when you want to log several lines, but the fixed 'entry point' is not at the beginning of the block.
+
 ```json
 "log": {
   "active": true,
@@ -157,6 +161,7 @@ This previous rule is used to keep tracks of the Debug.Log messages. Because the
 ### G - Logging color code
 
 You can specify the color of the message created by your rules by specifying a type:
+
 ```json
 "target": {
   "active": true,
@@ -164,7 +169,7 @@ You can specify the color of the message created by your rules by specifying a t
 }
 ```
 It will output it differently based on this type. Correct types are:
-* __[DEFAULT]__ `message`: normal logging
+* `message`: normal logging __[DEFAULT]__ 
 * `warning`: yellow
-* `error`: red
+* `error`  : red
 * `success`: green

data/README.md

@@ -24,9 +24,11 @@ U3d provides help for running and installing unity from CLI. Available commands
 
 ![u3d run](https://github.com/DragonBox/u3d/raw/master/docs/assets/u3d_run.png)
 
-* `u3d prettify`: Prettify a saved logfile
+The prettifyer is on by default but can be turned off to get Unity3d's raw output.
 
-  (see above :))
+* `u3d prettify`: Prettify a saved editor logfile
+
+  [Information on how `prettify` works](https://github.com/DragonBox/u3d/blob/master/LOG_RULES.md)
 
 ## Installation
 

data/TODO.md

@@ -5,10 +5,6 @@
 = post
 * patch commander to support argument descriptions
 
-* bug: installer shouldn't ask to rename directory of current Unity install if more packages are coming
-
-* feature to clear credentials
-
 * u3d specific keychain (u3d_credentials_store)
 
 * if failure to download a package, display available ones

data/examples/Example2/fastlane/Fastfile

@@ -2,3 +2,7 @@ desc "Run the EditorRun.Build task"
 lane :u3d_build do |options|
   u3d(raw_logs: options[:raw_logs], run_args: "-logFile './editor.log' -executeMethod U3d.EditorRun.Build -quit -batchmode")
 end
+
+lane :u3d_build2 do |options|
+  u3d(raw_logs: options[:raw_logs], run_args: "-logFile '/dev/stdout' -executeMethod U3d.EditorRun.Build -quit -batchmode")
+end

data/lib/u3d/commands.rb

@@ -26,6 +26,7 @@ require 'u3d/installer'
 require 'u3d/cache'
 require 'u3d/utils'
 require 'u3d/log_analyzer'
+require 'u3d/unity_runner'
 require 'u3d_core/command_executor'
 require 'u3d_core/credentials'
 require 'fileutils'
@@ -40,7 +41,14 @@ module U3d
           UI.important 'No Unity version installed'
           return
         end
-        list.each do |u|
+        # 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]
           UI.message "Version #{u.version}\t(#{u.path})"
           packages = u.packages
           next unless options[:packages] && packages && !packages.empty?
@@ -139,10 +147,7 @@ module U3d
         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
+        Installer.install_modules(files, version, installation_path: options[:installation_path])
       end
 
       def local_install(args: [], options: {})
@@ -182,10 +187,7 @@ module U3d
           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
+        Installer.install_modules(files, version, installation_path: options[:installation_path])
       end
 
       def run(options: {}, run_args: [])

data/lib/u3d/installer.rb

@@ -159,77 +159,6 @@ module U3d
     end
   end
 
-  class Runner
-    def run(installation, args, raw_logs: false)
-      require 'fileutils'
-
-      log_file = find_logFile_in_args(args)
-
-      if log_file # we wouldn't want to do that for the default log file.
-        File.delete(log_file) if File.exist?(log_file)
-      else
-        log_file = installation.default_log_file
-      end
-
-      FileUtils.touch(log_file)
-
-      tail_thread = Thread.new do
-        begin
-          if raw_logs
-            pipe(log_file) { |l| UI.message l.rstrip }
-          else
-            analyzer = LogAnalyzer.new
-            pipe(log_file) { |l| analyzer.parse_line l }
-          end
-        rescue => e
-          UI.error "Failure while trying to pipe #{log_file}: #{e.message}"
-          e.backtrace.each { |l| UI.error "  #{l}" }
-        end
-      end
-
-      begin
-        args.unshift(installation.exe_path)
-        if Helper.windows?
-          args.map! { |a| a =~ / / ? "\"#{a}\"" : a }
-        else
-          args.map!(&:shellescape)
-        end
-        U3dCore::CommandExecutor.execute(command: args)
-      ensure
-        sleep 0.5
-        Thread.kill(tail_thread)
-      end
-    end
-
-    def find_logFile_in_args(args)
-      find_arg_in_args('-logFile', args)
-    end
-
-    def find_projectpath_in_args(args)
-      find_arg_in_args('-projectpath', args)
-    end
-
-    def find_arg_in_args(arg_to_find, args)
-      raise 'Only arguments of type array supported right now' unless args.is_a?(Array)
-      args.each_with_index do |arg, index|
-        return args[index + 1] if arg == arg_to_find && index < args.count - 1
-      end
-      nil
-    end
-
-    private
-
-    def pipe(file)
-      File.open(file, 'r') do |f|
-        f.extend File::Tail
-        f.interval = 0.1
-        f.max_interval = 0.4
-        f.backward 100
-        f.tail { |l| yield l }
-      end
-    end
-  end
-
   class Installer
     def self.create
       installer = if Helper.mac?
@@ -249,30 +178,11 @@ module U3d
       installer
     end
 
-    def self.install_module(file_path, version, installation_path: nil, info: {})
-      extension = File.extname(file_path)
-      if extension == '.pkg'
-        path = installation_path || DEFAULT_MAC_INSTALL
-        MacInstaller.install_pkg(
-          file_path,
-          version: version,
-          target_path: path
-        )
-      elsif extension == '.exe'
-        path = installation_path || File.join(DEFAULT_WINDOWS_INSTALL, UNITY_DIR % version)
-        WindowsInstaller.install_exe(
-          file_path,
-          installation_path: path,
-          info: info
-        )
-      elsif extension == '.sh'
-        path = installation_path || File.join(DEFAULT_LINUX_INSTALL, UNITY_DIR % version)
-        LinuxInstaller.install_sh(
-          file_path,
-          installation_path: path
-        )
-      else
-        raise "File type #{extension} not yet supported"
+    def self.install_modules(files, version, installation_path: nil)
+      installer = Installer.create
+      files.each do |name, file, info|
+        UI.verbose "Installing #{name}#{info['mandatory'] ? ' (mandatory package)' : ''}, with file #{file}"
+        installer.install(file, version, installation_path: installation_path, info: info)
       end
     end
   end
@@ -310,10 +220,21 @@ module U3d
       versions.sort! { |x, y| x.version <=> y.version }
     end
 
-    def self.install_pkg(file_path, version: nil, target_path: nil)
+    def install(file_path, version, installation_path: nil, info: {})
+      extension = File.extname(file_path)
+      raise "Installation of #{extension} files is not supported on Mac" if extension != '.pkg'
+      path = installation_path || DEFAULT_MAC_INSTALL
+      install_pkg(
+        file_path,
+        version: version,
+        target_path: path
+      )
+    end
+
+    def install_pkg(file_path, version: nil, target_path: nil)
       target_path ||= DEFAULT_MAC_INSTALL
       command = "installer -pkg #{file_path.shellescape} -target #{target_path.shellescape}"
-      unity = Installer.create.installed.find { |u| u.version == version }
+      unity = installed.find { |u| u.version == version }
       if unity.nil?
         UI.verbose "No Unity install for version #{version} was found"
         U3dCore::CommandExecutor.execute(command: command, admin: true)
@@ -361,7 +282,17 @@ module U3d
       versions.sort! { |x, y| x.version <=> y.version }
     end
 
-    def self.install_sh(file, installation_path: nil)
+    def install(file_path, version, installation_path: nil, info: {})
+      extension = File.extname(file_path)
+      raise "Installation of #{extension} files is not supported on Linux" if extension != '.sh'
+      path = installation_path || File.join(DEFAULT_LINUX_INSTALL, UNITY_DIR % version)
+      install_sh(
+        file_path,
+        installation_path: path
+      )
+    end
+
+    def install_sh(file, installation_path: nil)
       cmd = file.shellescape
       if installation_path
         Utils.ensure_dir(installation_path)
@@ -401,7 +332,18 @@ module U3d
       versions.sort! { |x, y| x.version <=> y.version }
     end
 
-    def self.install_exe(file_path, installation_path: nil, info: {})
+    def install(file_path, version, installation_path: nil, info: {})
+      extension = File.extname(file_path)
+      raise "Installation of #{extension} files is not supported on Windows" if extension != '.exe'
+      path = installation_path || File.join(DEFAULT_WINDOWS_INSTALL, UNITY_DIR % version)
+      install_exe(
+        file_path,
+        installation_path: path,
+        info: info
+      )
+    end
+
+    def install_exe(file_path, installation_path: nil, info: {})
       installation_path ||= DEFAULT_WINDOWS_INSTALL
       final_path = installation_path.tr('/', '\\')
       Utils.ensure_dir(final_path)

data/lib/u3d/log_analyzer.rb

@@ -107,7 +107,7 @@ module U3d
               if rule['end_message']
                 match = line.match(pattern)
                 params = match.names.map(&:to_sym).zip(match.captures).to_h
-                message = rule['end_message'] % params.merge(@context)
+                message = inject(rule['end_message'], params: params)
               else
                 message = line.chomp
               end
@@ -165,7 +165,7 @@ module U3d
                 end
                 if r['fetched_line_message'] != false
                   message = if r['fetched_line_message']
-                              r['fetched_line_message'] % @context
+                              inject(r['fetched_line_message'])
                             else
                               fetched_line.chomp
                             end
@@ -176,7 +176,7 @@ module U3d
             end
             if r['start_message'] != false
               message = if r['start_message']
-                          r['start_message'] % @context
+                          inject(r['start_message'])
                         else
                           line.chomp
                         end
@@ -194,6 +194,16 @@ module U3d
 
     private
 
+    def inject(string, params: {})
+      message = "This is a default message."
+      begin
+        message = string % params.merge(@context)
+      rescue KeyError => e
+        UI.error("[U3D] Rule #{@active_rule} captures were incomplete: #{e.message}")
+      end
+      message
+    end
+
     def parse_rule(r)
       return false unless r['active']
       return false if r['start_pattern'].nil?

data/lib/u3d/unity_runner.rb

@@ -0,0 +1,103 @@
+## --- 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/utils'
+require 'fileutils'
+require 'file-tail'
+
+module U3d
+  # Launches Unity with given arguments
+  class Runner
+    def run(installation, args, raw_logs: false)
+      log_file = find_logFile_in_args(args)
+
+      if log_file # we wouldn't want to do that for the default log file.
+        File.delete(log_file) if File.file?(log_file) # We only delete real files
+      else
+        log_file = installation.default_log_file
+      end
+
+      FileUtils.touch(log_file) unless File.exist? log_file
+
+      tail_thread = Thread.new do
+        begin
+          if raw_logs
+            pipe(log_file) { |l| UI.message l.rstrip }
+          else
+            analyzer = LogAnalyzer.new
+            pipe(log_file) { |l| analyzer.parse_line l }
+          end
+        rescue => e
+          UI.error "Failure while trying to pipe #{log_file}: #{e.message}"
+          e.backtrace.each { |l| UI.error "  #{l}" }
+        end
+      end
+
+      # Wait for tail_thread setup to be complete
+      sleep 0.5 while tail_thread.status!='sleep'
+      tail_thread.run
+
+      begin
+        args.unshift(installation.exe_path)
+        if Helper.windows?
+          args.map! { |a| a =~ / / ? "\"#{a}\"" : a }
+        else
+          args.map!(&:shellescape)
+        end
+        # FIXME return value not handled
+        U3dCore::CommandExecutor.execute(command: args, print_all: true)
+      ensure
+        sleep 1
+        Thread.kill(tail_thread)
+      end
+    end
+
+    def find_logFile_in_args(args)
+      find_arg_in_args('-logFile', args)
+    end
+
+    def find_projectpath_in_args(args)
+      find_arg_in_args('-projectpath', args)
+    end
+
+    def find_arg_in_args(arg_to_find, args)
+      raise 'Only arguments of type array supported right now' unless args.is_a?(Array)
+      args.each_with_index do |arg, index|
+        return args[index + 1] if arg == arg_to_find && index < args.count - 1
+      end
+      nil
+    end
+
+    private
+
+    def pipe(file)
+      File.open(file, 'r') do |f|
+        f.extend File::Tail
+        f.interval = 0.1
+        f.max_interval = 0.4
+        f.backward 0
+        Thread.stop
+        f.tail { |l| yield l }
+      end
+    end
+  end
+end

data/lib/u3d/unity_versions.rb

@@ -47,7 +47,9 @@ module U3d
     # Captures a version and its base url
     MAC_DOWNLOAD = %r{"(https?://[\w/\.-]+/[0-9a-f]{12}/)MacEditorInstaller/[a-zA-Z0-9/\.]+-(\d+\.\d+\.\d+\w\d+)\.?\w+"}
     WIN_DOWNLOAD = %r{"(https?://[\w/\.-]+/[0-9a-f]{12}/)Windows..EditorInstaller/[a-zA-Z0-9/\.]+-(\d+\.\d+\.\d+\w\d+)\.?\w+"}
-    LINUX_DOWNLOAD = %r{"(https?://[\w/\._-]+/unity\-editor\-installer\-(\d+\.\d+\.\d+\w\d+).*\.sh)"}
+    LINUX_DOWNLOAD_DATED = %r{"(https?://[\w/\._-]+/unity\-editor\-installer\-(\d+\.\d+\.\d+\w\d+).*\.sh)"}
+    LINUX_DOWNLOAD_RECENT_PAGE = %r{"(http://beta\.unity3d\.com/download/[a-zA-Z0-9/\.]+/public_download\.html)"}
+    LINUX_DOWNLOAD_RECENT_FILE = %r{'(https?://beta\.unity3d\.com/download/[a-zA-Z0-9/\.]+/unity\-editor\-installer\-(\d+\.\d+\.\d+(?:x)?\w\d+).*\.sh)'}
     # Captures a beta version in html page
     UNITY_BETAVERSION_REGEX = %r{\/unity\/beta\/unity(\d+\.\d+\.\d+\w\d+)"}
     UNITY_EXTRA_DOWNLOAD_REGEX = %r{"(https?:\/\/[\w\/.-]+\.unity3d\.com\/(\w+))\/[a-zA-Z\/.-]+\/download.html"}
@@ -148,10 +150,30 @@ module U3d
           end
           data.gsub(/[ \t]+/, '').each_line { |l| puts l if /<a href=/ =~ l }
           versions = {}
-          results = data.scan(LINUX_DOWNLOAD)
+          results = data.scan(LINUX_DOWNLOAD_DATED)
           results.each do |capt|
             versions[capt[1]] = capt[0]
           end
+
+          results = data.scan(LINUX_DOWNLOAD_RECENT_PAGE)
+          results.each do |page|
+            url = page[0]
+            uri = URI(url)
+            Net::HTTP.start(uri.host, uri.port) do |http|
+              request = Net::HTTP::Get.new uri
+              response = http.request request
+            end
+            if response.kind_of? Net::HTTPSuccess
+              capt = response.body.match(LINUX_DOWNLOAD_RECENT_FILE)
+              if capt && capt[1] && capt[2]
+                versions[capt[2].gsub(/x/, '')] = capt[1]
+              else
+                UI.error("Could not retrieve a fitting file from #{url}")
+              end
+            else
+              UI.error("Could not access #{url}")
+            end
+          end
           if versions.count.zero?
             UI.important 'Found no releases'
           else

data/lib/u3d/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: u3d
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Jerome Lacoste
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-24 00:00:00.000000000 Z
+date: 2017-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -348,6 +348,7 @@ files:
 - lib/u3d/iniparser.rb
 - lib/u3d/installer.rb
 - lib/u3d/log_analyzer.rb
+- lib/u3d/unity_runner.rb
 - lib/u3d/unity_version_number.rb
 - lib/u3d/unity_versions.rb
 - lib/u3d/utils.rb