u3d 1.2.1 → 1.3.0

data/lib/u3d_core/credentials.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ## --- BEGIN LICENSE BLOCK ---
 # Original work Copyright (c) 2015-present the fastlane authors
 # Modified work Copyright 2016-present WeWantToKnow AS
@@ -26,7 +28,7 @@ require 'security'
 
 module U3dCore
   class Credentials
-    MAC_U3D_SERVER = 'u3d'.freeze
+    MAC_U3D_SERVER = 'u3d'
     def initialize(user: nil, password: nil)
       @user = user
       @password = password
@@ -39,6 +41,7 @@ module U3dCore
       while @user.to_s.empty?
         UI.verbose 'Username does not exist or is empty'
         raise CredentialsError, 'Username missing and context is not interactive. Please check that the environment variable is correct' unless UI.interactive?
+
         @user = UI.input 'Username for u3d:'
       end
 
@@ -48,12 +51,10 @@ module U3dCore
     def password
       @password ||= ENV['U3D_PASSWORD']
 
-      if Helper.mac? && @use_keychain
-        unless @password
-          UI.message 'Fetching password from keychain'
-          password_holder = Security::InternetPassword.find(server: server_name)
-          @password = password_holder.password unless password_holder.nil?
-        end
+      if Helper.mac? && @use_keychain && !@password
+        UI.message 'Fetching password from keychain'
+        password_holder = Security::InternetPassword.find(server: server_name)
+        @password = password_holder.password unless password_holder.nil?
       end
 
       if @password.nil?
@@ -76,6 +77,7 @@ module U3dCore
       while @password.nil?
         UI.verbose 'Password does not exist'
         raise CredentialsError, 'Password missing and context is not interactive. Please make sure it is correct' unless UI.interactive?
+
         @password = UI.password "Password for #{user}:"
       end
 

data/lib/u3d_core/env.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+## --- BEGIN LICENSE BLOCK ---
+# Original work Copyright (c) 2015-present the fastlane authors
+# Modified work Copyright 2019-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 Env
+    def self.truthy?(env)
+      return false unless ENV[env]
+      return false if %w[no false off 0].include?(ENV[env].to_s)
+
+      return true
+    end
+  end
+end

data/lib/u3d_core/globals.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ## --- BEGIN LICENSE BLOCK ---
 # Original work Copyright (c) 2015-present the fastlane authors
 # Modified work Copyright 2016-present WeWantToKnow AS
@@ -52,13 +54,14 @@ module U3dCore
       end
 
       def method_missing(method_sym, *arguments, &block)
-        if method_sym.to_s =~ /^with_(.*)$/
+        case method_sym.to_s
+        when /^with_(.*)$/
           if attributes.include? Regexp.last_match(1)
             with(Regexp.last_match(1).to_sym, arguments.first, &block)
           else
             super
           end
-        elsif method_sym.to_s =~ /^(.*)\?$/
+        when /^(.*)\?$/
           if attributes.include? Regexp.last_match(1)
             is?(Regexp.last_match(1).to_sym)
           else
@@ -70,15 +73,12 @@ module U3dCore
       end
 
       def respond_to_missing?(method_sym, include_private = false)
-        # rubocop:disable GuardClause
-        if method_sym.to_s =~ /^with_(.*)$/
-          return attributes.include? Regexp.last_match(1)
-        elsif method_sym.to_s =~ /^(.*)\?$/
+        case method_sym.to_s
+        when /^with_(.*)$/ || /^(.*)\?$/
           return attributes.include? Regexp.last_match(1)
         else
           super
         end
-        # rubocop:enable GuardClause
       end
     end
     private_class_method :is?, :with, :attributes

data/lib/u3d_core/helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ## --- BEGIN LICENSE BLOCK ---
 # Original work Copyright (c) 2015-present the fastlane authors
 # Modified work Copyright 2016-present WeWantToKnow AS
@@ -42,7 +44,7 @@ module U3dCore
     end
 
     def self.windows_path(path)
-      path.gsub(%r{\/(\d)}, '/\\\\\1').tr('/', '\\')
+      path.gsub(%r{/(\d)}, '/\\\\\1').tr('/', '\\')
     end
 
     # Runs a given command using backticks (`)
@@ -95,6 +97,7 @@ module U3dCore
       # taken from: https://github.com/Microsoft/BashOnWindows/issues/423#issuecomment-221627364
       proc_version = '/proc/version'
       return false unless File.exist? proc_version
+
       File.open(proc_version, 'r') do |f|
         return !(/Microsof|WSL/ =~ f.read).nil?
       end
@@ -112,7 +115,7 @@ module U3dCore
 
     # the current operating system
     def self.operating_system
-      # rubocop:disable GuardClause
+      # rubocop:disable Style/GuardClause
       if linux?
         return :linux
       elsif mac?
@@ -122,7 +125,7 @@ module U3dCore
       else
         raise 'Could not assume what OS you\'re running, please specify it as much as possible'
       end
-      # rubocop:enable GuardClause
+      # rubocop:enable Style/GuardClause
     end
 
     def self.win_64?
@@ -153,5 +156,4 @@ module U3dCore
     #  return ENV["FL_BUILDLOG_PATH"] || "~/Library/Logs"
     # end
   end
-  # rubocop:enable Metrics/ModuleLength
 end

data/lib/u3d_core/ui/disable_colors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ## --- BEGIN LICENSE BLOCK ---
 # Original work Copyright (c) 2015-present the fastlane authors
 # Modified work Copyright 2016-present WeWantToKnow AS

data/lib/u3d_core/ui/implementations/shell.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ## --- BEGIN LICENSE BLOCK ---
 # Original work Copyright (c) 2015-present the fastlane authors
 # Modified work Copyright 2016-present WeWantToKnow AS
@@ -27,6 +29,7 @@ module U3dCore
   class Shell < Interface
     # test_log_buffer: by default, don't show any logs when running tests
     def initialize(test_log_buffer: nil)
+      super()
       @test_log_buffer = test_log_buffer
     end
 
@@ -52,16 +55,15 @@ module U3dCore
 
     class EPipeIgnorerLogDevice < Logger::LogDevice
       def initialize(logdev)
+        super
         @logdev = logdev
       end
 
-      # rubocop:disable HandleExceptions
       def write(message)
         @logdev.write(message)
       rescue Errno::EPIPE
         # ignored
       end
-      # rubocop:enable HandleExceptions
     end
 
     def format_string(datetime = Time.now, severity = "")
@@ -79,7 +81,7 @@ module U3dCore
       s = []
       s << "#{severity} " if U3dCore::Globals.verbose? && severity && !severity.empty?
       s << "[#{datetime.strftime(timestamp)}] " if timestamp
-      s.join('')
+      s.join
     end
 
     #####################################################
@@ -114,7 +116,7 @@ module U3dCore
       actual = (message.split("\r").last || "") # as clearing the line will remove the `>` and the time stamp
       actual.split("\n").each do |msg|
         prefix = msg.include?("▸") ? "" : "▸ "
-        log.info(prefix + "" + msg.magenta)
+        log.info("#{prefix}#{msg.magenta}")
       end
     end
 
@@ -125,7 +127,7 @@ module U3dCore
     def header(message)
       i = message.length + 8
       success("-" * i)
-      success("--- " + message + " ---")
+      success("--- #{message} ---")
       success("-" * i)
     end
 
@@ -167,6 +169,7 @@ module U3dCore
 
     def verify_interactive!(message)
       return if interactive?
+
       important(message)
       crash!("Could not retrieve response as u3d runs in non-interactive mode")
     end

data/lib/u3d_core/ui/interface.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ## --- BEGIN LICENSE BLOCK ---
 # Original work Copyright (c) 2015-present the fastlane authors
 # Modified work Copyright 2016-present WeWantToKnow AS
@@ -143,6 +145,7 @@ module U3dCore
       attr_reader :show_github_issues
 
       def initialize(show_github_issues: false)
+        super
         @show_github_issues = show_github_issues
       end
     end

data/lib/u3d_core/ui/ui.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ## --- BEGIN LICENSE BLOCK ---
 # Original work Copyright (c) 2015-present the fastlane authors
 # Modified work Copyright 2016-present WeWantToKnow AS
@@ -30,22 +32,21 @@ module U3dCore
 
       attr_writer :current
     end
-
-    # rubocop:disable Style/MethodMissing
+    # rubocop:disable Style/MissingRespondToMissing
     def self.method_missing(method_sym, *args, &_block)
+      # rubocop:enable Style/MissingRespondToMissing
       # not using `responds` because we don't care about methods like .to_s and so on
       interface_methods = Interface.instance_methods - Object.instance_methods
       UI.user_error!("Unknown method '#{method_sym}', supported #{interface_methods}") unless interface_methods.include?(method_sym)
 
       current.send(method_sym, *args)
     end
-    # rubocop:enable Style/MethodMissing
   end
 end
 
 require 'u3d_core/ui/interface'
 
 # Import all available implementations
-Dir[File.expand_path('implementations/*.rb', File.dirname(__FILE__))].each do |file|
+Dir[File.expand_path('implementations/*.rb', File.dirname(__FILE__))].sort.each do |file|
   require file
 end

data/lib/u3d_core/update_checker/changelog.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+## --- BEGIN LICENSE BLOCK ---
+# Original work Copyright (c) 2015-present the fastlane authors
+# Modified work Copyright 2019-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_relative '../../u3d/utils'
+
+module U3dCore
+  class Changelog
+    class << self
+      def show_changes(gem_name, current_version, update_gem_command: "bundle update")
+        did_show_changelog = false
+
+        releases(gem_name).each_with_index do |release, index|
+          next unless Gem::Version.new(to_version(release['tag_name'])) > Gem::Version.new(current_version)
+
+          puts("")
+          puts(release['name'].green)
+          puts(release['body'])
+          did_show_changelog = true
+
+          next unless index == 2
+
+          puts("")
+          puts("To see all new releases, open https://github.com/DragonBox/#{gem_name}/releases".green)
+          break
+        end
+
+        puts("")
+        puts("Please update using `#{update_gem_command}`".green) if did_show_changelog
+      rescue StandardError => e
+        # Something went wrong, we don't care so much about this
+        UI.error("Unable to show_changes: #{e}")
+      end
+
+      def to_version(tag_name)
+        tag_name = tag_name[1..-1] if tag_name[0] == 'v'
+        tag_name
+      end
+
+      def releases(gem_name)
+        url = "https://api.github.com/repos/DragonBox/#{gem_name}/releases"
+        JSON.parse(U3d::Utils.page_content(url))
+      end
+    end
+  end
+end

data/lib/u3d_core/update_checker/update_checker.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+## --- BEGIN LICENSE BLOCK ---
+# Original work Copyright (c) 2015-present the fastlane authors
+# Modified work Copyright 2019-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_relative 'changelog'
+require_relative '../ui/ui'
+require_relative '../../u3d/utils'
+
+module U3dCore
+  # Verifies the user runs the latest version of this gem
+  class UpdateChecker
+    def self.start_looking_for_update(gem_name)
+      return if Helper.test?
+      return if U3dCore::Env.truthy?("U3D_SKIP_UPDATE_CHECK")
+
+      @start_time = Time.now
+
+      Thread.new do
+        server_results[gem_name] = fetch_latest(gem_name)
+      rescue StandardError
+        # we don't want to show a stack trace if something goes wrong
+      end
+    end
+
+    def self.server_results
+      @server_results ||= {}
+    end
+
+    class << self
+      attr_reader :start_time
+    end
+
+    def self.update_available?(gem_name, current_version)
+      latest = server_results[gem_name]
+      return (latest && (Gem::Version.new(latest) > Gem::Version.new(current_version)))
+    end
+
+    # wait a abit for results when commands run real quick
+    def self.wait_for_results
+      sleep([0, 0.4 - (Time.now - @start_time)].max) if @start_time
+    end
+
+    def self.show_update_status(gem_name, current_version)
+      wait_for_results unless update_available?(gem_name, current_version)
+      show_update_message(gem_name, current_version) if update_available?(gem_name, current_version)
+    end
+
+    # Show a message to the user to update to a new version of u3d
+    # Use this method, as this will detect the current Ruby environment and show an
+    # appropriate message to the user
+    def self.show_update_message(gem_name, current_version)
+      available = server_results[gem_name]
+      puts("")
+      puts('#######################################################################')
+      if available
+        puts("# #{gem_name} #{available} is available. You are on #{current_version}.")
+      else
+        puts("# An update for #{gem_name} is available. You are on #{current_version}.")
+      end
+      puts("# You should use the latest version.")
+      puts("# Please update using `#{update_command(gem_name: gem_name)}`.")
+
+      # this could be fetched from the gem
+      puts("# To see what's new, open https://github.com/DragonBox/#{gem_name}/releases.") if U3dCore::Env.truthy?("U3D_HIDE_CHANGELOG")
+
+      if !Helper.bundler? && Random.rand(5) == 1
+        # We want to show this message from time to time, if the user doesn't use bundler
+        puts('#######################################################################')
+        puts("# Run `sudo gem cleanup` from time to time to speed up u3d")
+      end
+      puts('#######################################################################')
+      Changelog.show_changes(gem_name, current_version, update_gem_command: UpdateChecker.update_command(gem_name)) unless U3dCore::Env.truthy?("U3D_HIDE_CHANGELOG")
+
+      ensure_rubygems_source
+    end
+
+    # The command that the user should use to update the gem
+    def self.update_command(gem_name)
+      if Helper.bundler?
+        "bundle update #{gem_name.downcase}"
+      else
+        "sudo gem install #{gem_name.downcase}"
+      end
+    end
+
+    # Check if RubyGems is set as a gem source
+    # on some machines that might not be the case
+    # and then users can't find the update when
+    # running the specified command
+    def self.ensure_rubygems_source
+      return if `gem sources`.include?("https://rubygems.org")
+
+      puts("")
+      UI.error("RubyGems is not listed as your Gem source")
+      UI.error("You can run `gem sources` to see all your sources")
+      UI.error("Please run the following command to fix this:")
+      UI.command("gem sources --add https://rubygems.org")
+    end
+
+    def self.fetch_latest(gem_name)
+      JSON.parse(U3d::Utils.page_content(generate_fetch_url(gem_name)))["version"]
+    end
+
+    def self.generate_fetch_url(gem_name)
+      "https://rubygems.org/api/v1/gems/#{gem_name}.json"
+    end
+  end
+end

data/lib/u3d_core/version.rb

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

data/lib/u3d_core.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ## --- BEGIN LICENSE BLOCK ---
 # Copyright (c) 2016-present WeWantToKnow AS
 #
@@ -27,5 +29,8 @@ require 'u3d_core/credentials'
 require 'u3d_core/ui/ui'
 require 'u3d_core/command_executor'
 require 'u3d_core/command_runner'
+require 'u3d_core/env'
+require 'u3d_core/update_checker/changelog'
+require 'u3d_core/update_checker/update_checker'
 require 'colored'
 require 'commander'

data/u3d.gemspec

@@ -1,4 +1,6 @@
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'u3d/version'
 
@@ -8,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.authors     = ["Jerome Lacoste", "Paul Niezborala"]
   spec.email       = 'jerome@wewanttoknow.com'
 
-  spec.required_ruby_version = '>= 2.1.0'
+  spec.required_ruby_version = '>= 2.5.0'
 
   spec.summary     = "U3d"
   spec.description = U3d::DESCRIPTION
@@ -25,19 +27,27 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'colored', '>= 1.2', '< 2.0.0' # terminal
   spec.add_dependency 'commander', '>= 4.4.0', '< 5.0.0' # CLI parser
-  spec.add_dependency 'file-tail', '>= 1.2.0'
   spec.add_dependency 'filesize', '>= 0.1.1' # File sizes prettifier
+  spec.add_dependency 'file-tail', '>= 1.2.0'
   spec.add_dependency 'inifile', '>= 3.0.0', '< 4.0.0' # Parses INI files
   spec.add_dependency 'plist', '>= 3.1.0', '< 4.0.0' # Generate the Xcode config plist file
+  spec.add_dependency "rexml" # rexml was unbundled from the stdlib in ruby 3
   spec.add_dependency 'rubyzip', '>= 1.0.0' # Installation of .zip files
   spec.add_dependency 'security', '= 0.1.3' # macOS Keychain manager, a dead project, no updates expected
   # Development only
-  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "activesupport", ">= 5.2.4.3" # force secure transitive dep
+  spec.add_development_dependency "addressable", ">= 2.8.0" # force secure transitive dep
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "coveralls"
-  spec.add_development_dependency "github_changelog_generator"
-  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'
-  spec.add_development_dependency 'rubocop', '~> 0.52.1'
+  spec.add_development_dependency "excon", ">= 0.71.0" # force secure transitive dep
+  spec.add_development_dependency "github_changelog_generator", ">= 1.16.4"
+  spec.add_development_dependency "json", ">= 2.3.0" # force secure transitive dep
+  # spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3.11.0"
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.5.1'
+  spec.add_development_dependency 'rubocop', '~> 1.27'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
+  # spec.add_development_dependency 'rubocop-rspec', '~> 2.10.0'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end