u3d 0.9

data/lib/u3d_core/globals.rb

@@ -0,0 +1,84 @@
+## --- 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
+  # all these attributes are false by default
+  # and can be set overriden temporarily using a
+  #   with_attr(value) do
+  #     something
+  #   end
+  # construct
+  class Globals
+    class << self
+      attr_writer :verbose, :log_timestamps, :use_keychain, :do_not_login
+
+      def attributes
+        @attributes ||= ((methods - public_instance_methods).grep(/=$/) - [:<=, :>=]).map do |s|
+          a = s.to_s
+          a[0..(a.length - 2)] # remove the '='
+        end
+      end
+
+      def with(attr, value)
+        orig_attr = send("#{attr}?")
+        send("#{attr}=", value)
+        yield if block_given?
+      ensure
+        send("#{attr}=", orig_attr)
+      end
+
+      def is?(attr)
+        instance_variable_get("@#{attr}")
+      end
+
+      def method_missing(method_sym, *arguments, &block)
+        if method_sym.to_s =~ /^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 =~ /^(.*)\?$/
+          if attributes.include? Regexp.last_match(1)
+            is?(Regexp.last_match(1).to_sym)
+          else
+            super
+          end
+        else
+          super
+        end
+      end
+
+      def respond_to?(method_sym, include_private = false)
+        if method_sym.to_s =~ /^with_(.*)$/
+          return attributes.include? Regexp.last_match(1)
+        elsif method_sym.to_s =~ /^(.*)\?$/
+          return attributes.include? Regexp.last_match(1)
+        else
+          super
+        end
+      end
+    end
+    private_class_method :is?, :with, :attributes
+  end
+end

data/lib/u3d_core/helper.rb

@@ -0,0 +1,149 @@
+## --- 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 ---
+
+require 'logger'
+require 'colored'
+
+module U3dCore
+  module Helper
+    # Runs a given command using backticks (`)
+    # and prints them out using the UI.command method
+    def self.backticks(command, print: true)
+      UI.command(command) if print
+      result = `#{command}`
+      UI.command_output(result) if print
+      return result
+    end
+
+    # @return true if the currently running program is a unit test
+    def self.is_test?
+      defined? SpecHelper
+    end
+
+    # removes ANSI colors from string
+    def self.strip_ansi_colors(str)
+      str.gsub(/\e\[([;\d]+)?m/, '')
+    end
+
+    # @return [boolean] true if executing with bundler (like 'bundle exec fastlane [action]')
+    def self.bundler?
+      # Bundler environment variable
+      %w(BUNDLE_BIN_PATH BUNDLE_GEMFILE).each do |current|
+        return true if ENV.key?(current)
+      end
+      return false
+    end
+
+    # Do we run from a bundled fastlane, which contains Ruby and OpenSSL?
+    # Usually this means the fastlane directory is ~/.fastlane/bin/
+    # We set this value via the environment variable `FASTLANE_SELF_CONTAINED`
+    def self.contained_fastlane?
+      ENV["FASTLANE_SELF_CONTAINED"].to_s == "true" && !homebrew?
+    end
+
+    # returns true if fastlane was installed from the Fabric Mac app
+    def self.mac_app?
+      ENV["FASTLANE_SELF_CONTAINED"].to_s == "false"
+    end
+
+    # returns true if fastlane was installed via Homebrew
+    def self.homebrew?
+      ENV["FASTLANE_INSTALLED_VIA_HOMEBREW"].to_s == "true"
+    end
+
+    # returns true if fastlane was installed via RubyGems
+    def self.rubygems?
+      !bundler? && !contained_fastlane? && !homebrew? && !mac_app?
+    end
+
+    # @return [boolean] true if building in a known CI environment
+    def self.ci?
+      # Check for Jenkins, Travis CI, ... environment variables
+      %w(JENKINS_HOME JENKINS_URL TRAVIS CIRCLECI CI TEAMCITY_VERSION GO_PIPELINE_NAME bamboo_buildKey GITLAB_CI XCS).each do |current|
+        return true if ENV.key?(current)
+      end
+      return false
+    end
+
+    def self.windows?
+      # taken from: http://stackoverflow.com/a/171011/1945875
+      (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
+    end
+
+    def self.linux?
+      (/linux/ =~ RUBY_PLATFORM) != nil
+    end
+
+    # Is the currently running computer a Mac?
+    def self.mac?
+      (/darwin/ =~ RUBY_PLATFORM) != nil
+    end
+
+    # the valid operating systems
+    def self.operating_systems
+      [:linux, :mac, :win]
+    end
+
+    # the current operating system
+    def self.operating_system
+      if linux?
+        return :linux
+      elsif mac?
+        return :mac
+      elsif windows?
+        return :win
+      else
+        raise 'Could not assume what OS you\'re running, please specify it as much as possible'
+      end
+    end
+
+    def self.win_64?
+      (/x64/ =~ RUBY_PLATFORM) != nil
+    end
+
+    def self.win_32?
+      (/i386/ =~ RUBY_PLATFORM) != nil
+    end
+
+    # Do we want to disable the colored output?
+    def self.colors_disabled?
+      ENV["U3D_DISABLE_COLORS"]
+    end
+
+    # Does the user use the Mac stock terminal
+    def self.mac_stock_terminal?
+      !!ENV["TERM_PROGRAM_VERSION"]
+    end
+
+    # Does the user use iTerm?
+    def self.iterm?
+      !!ENV["ITERM_SESSION_ID"]
+    end
+
+    # Logs base directory
+    # def self.buildlog_path
+    #  return ENV["FL_BUILDLOG_PATH"] || "~/Library/Logs"
+    # end
+  end
+  # rubocop:enable Metrics/ModuleLength
+end

data/lib/u3d_core/ui/disable_colors.rb

@@ -0,0 +1,40 @@
+## --- 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 ---
+
+# This code overwrites the methods from the colored gem
+# via https://github.com/defunkt/colored/blob/master/lib/colored.rb
+
+require 'colored'
+
+class String
+  Colored::COLORS.keys.each do |color|
+    define_method(color) do
+      self # do nothing with the string, but return it
+    end
+  end
+  Colored::EXTRAS.keys.each do |extra|
+    define_method(extra) do
+      self # do nothing with the string, but return it
+    end
+  end
+end

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

@@ -0,0 +1,157 @@
+## --- 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
+  # Shell is the terminal output of things
+  # For documentation for each of the methods open `interface.rb`
+  class Shell < Interface
+    def log
+      return @log if @log
+
+      $stdout.sync = true
+
+      @log ||= if Helper.is_test?
+                 Logger.new(nil) # don't show any logs when running tests
+               else
+                 Logger.new($stdout)
+               end
+
+      @log.formatter = proc do |severity, datetime, _progname, msg|
+        "#{format_string(datetime, severity)}#{msg}\n"
+      end
+
+      require 'u3d_core/ui/disable_colors' if U3dCore::Helper.colors_disabled?
+
+      @log
+    end
+
+    def format_string(datetime = Time.now, severity = "")
+      if U3dCore::Globals.log_timestamps?
+        timestamp = ENV["U3D_UI_TIMESTAMP"]
+        # default timestamp if none specified
+        unless timestamp
+          timestamp = if U3dCore::Globals.verbose?
+                        '%Y-%m-%d %H:%M:%S.%2N'
+                      else
+                        '%H:%M:%S'
+                      end
+        end
+      end
+      # hide has last word
+      timestamp = nil if ENV["U3D_HIDE_TIMESTAMP"]
+      s = []
+      s << "#{severity} " if U3dCore::Globals.verbose? && severity && !severity.empty?
+      s << "[#{datetime.strftime(timestamp)}] " if timestamp
+      s.join('')
+    end
+
+    #####################################################
+    # @!group Messaging: show text to the user
+    #####################################################
+
+    def error(message)
+      log.error(message.to_s.red)
+    end
+
+    def important(message)
+      log.warn(message.to_s.yellow)
+    end
+
+    def success(message)
+      log.info(message.to_s.green)
+    end
+
+    def message(message)
+      log.info(message.to_s)
+    end
+
+    def deprecated(message)
+      log.error(message.to_s.bold.blue)
+    end
+
+    def command(message)
+      log.info("$ #{message}".cyan.underline)
+    end
+
+    def command_output(message)
+      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)
+      end
+    end
+
+    def verbose(message)
+      log.debug(message.to_s) if U3dCore::Globals.verbose?
+    end
+
+    def header(message)
+      i = message.length + 8
+      success("-" * i)
+      success("--- " + message + " ---")
+      success("-" * i)
+    end
+
+    #####################################################
+    # @!group Errors: Inputs
+    #####################################################
+
+    def interactive?
+      interactive = true
+      interactive = false if $stdout.isatty == false
+      interactive = false if Helper.ci?
+      return interactive
+    end
+
+    def input(message)
+      verify_interactive!(message)
+      ask("#{format_string}#{message.to_s.yellow}").to_s.strip
+    end
+
+    def confirm(message)
+      verify_interactive!(message)
+      agree("#{format_string}#{message.to_s.yellow} (y/n)", true)
+    end
+
+    def select(message, options)
+      verify_interactive!(message)
+
+      important(message)
+      choose(*options)
+    end
+
+    def password(message)
+      verify_interactive!(message)
+
+      ask("#{format_string}#{message.to_s.yellow}") { |q| q.echo = "*" }
+    end
+
+    private
+
+    def verify_interactive!(message)
+      return if interactive?
+      important(message)
+      crash!("Could not retrieve response as u3d runs in non-interactive mode")
+    end
+  end
+end

data/lib/u3d_core/ui/interface.rb

@@ -0,0 +1,182 @@
+## --- 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
+  # Abstract super class
+  class Interface
+    #####################################################
+    # @!group Messaging: show text to the user
+    #####################################################
+
+    # Level Error: Can be used to show additional error
+    #   information before actually raising an exception
+    #   or can be used to just show an error from which
+    #   u3d can recover (much magic)
+    #
+    #   By default those messages are shown in red
+    def error(_message)
+      not_implemented(__method__)
+    end
+
+    # Level Important: Can be used to show warnings to the user
+    #   not necessarly negative, but something the user should
+    #   be aware of.
+    #
+    #   By default those messages are shown in yellow
+    def important(_message)
+      not_implemented(__method__)
+    end
+
+    # Level Success: Show that something was successful
+    #
+    #   By default those messages are shown in green
+    def success(_message)
+      not_implemented(__method__)
+    end
+
+    # Level Message: Show a neutral message to the user
+    #
+    #   By default those messages shown in white/black
+    def message(_message)
+      not_implemented(__method__)
+    end
+
+    # Level Deprecated: Show that a particular function is deprecated
+    #
+    #   By default those messages shown in strong blue
+    def deprecated(_message)
+      not_implemented(__method__)
+    end
+
+    # Level Command: Print out a terminal command that is being
+    #   executed.
+    #
+    #   By default those messages shown in cyan
+    def command(_message)
+      not_implemented(__method__)
+    end
+
+    # Level Command Output: Print the output of a command with
+    #   this method
+    #
+    #   By default those messages shown in magenta
+    def command_output(_message)
+      not_implemented(__method__)
+    end
+
+    # Level Verbose: Print out additional information for the
+    #   users that are interested. Will only be printed when
+    #   $verbose = true
+    #
+    #   By default those messages are shown in white
+    def verbose(_message)
+      not_implemented(__method__)
+    end
+
+    # Print a header = a text in a box
+    #   use this if this message is really important
+    def header(_message)
+      not_implemented(__method__)
+    end
+
+    #####################################################
+    # @!group Errors: Inputs
+    #####################################################
+
+    # Is is possible to ask the user questions?
+    def interactive?(_message)
+      not_implemented(__method__)
+    end
+
+    # get a standard text input (single line)
+    def input(_message)
+      not_implemented(__method__)
+    end
+
+    # A simple yes or no question
+    def confirm(_message)
+      not_implemented(__method__)
+    end
+
+    # Let the user select one out of x items
+    # return value is the value of the option the user chose
+    def select(_message, _options)
+      not_implemented(__method__)
+    end
+
+    # Password input for the user, text field shouldn't show
+    # plain text
+    def password(_message)
+      not_implemented(__method__)
+    end
+
+    #####################################################
+    # @!group Errors: Different kinds of exceptions
+    #####################################################
+
+    # raised from crash!
+    class UICrash < StandardError
+    end
+
+    # raised from user_error!
+    class UIError < StandardError
+      attr_reader :show_github_issues
+
+      def initialize(show_github_issues: false)
+        @show_github_issues = show_github_issues
+      end
+    end
+
+    # Pass an exception to this method to exit the program
+    #   using the given exception
+    # Use this method instead of user_error! if this error is
+    # unexpected, e.g. an invalid server response that shouldn't happen
+    def crash!(exception)
+      raise UICrash.new, exception.to_s
+    end
+
+    # Use this method to exit the program because of an user error
+    #   e.g. app doesn't exist on the given Developer Account
+    #        or invalid user credentials
+    #        or scan tests fail
+    # This will show the error message, but doesn't show the full
+    #   stack trace
+    # Basically this should be used when you actively catch the error
+    # and want to show a nice error message to the user
+    def user_error!(error_message, options = {})
+      options = { show_github_issues: false }.merge(options)
+      raise UIError.new(show_github_issues: options[:show_github_issues]), error_message.to_s
+    end
+
+    #####################################################
+    # @!group Helpers
+    #####################################################
+    def not_implemented(method_name)
+      UI.user_error!("Current UI '#{self}' doesn't support method '#{method_name}'")
+    end
+
+    def to_s
+      self.class.name.split('::').last
+    end
+  end
+end