fastlane_core 0.28.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91fc2f52c866a8347a057dd45f6734fb192303a5
-  data.tar.gz: 71b696f8c444e64187a31fbfc7009ded60e0dea1
+  metadata.gz: 26d39ce9978be6553334d8cf4213bb844d5df8ff
+  data.tar.gz: bd80eed52b439ac6c7ce8792137df2256f9c1579
 SHA512:
-  metadata.gz: c0f5f662a7e349040b28d1582eb2f8c775b4c4042c88f00b5d382e8b56a401924dfe860f8dcb181f73e7f727032e8ba8e2bdd82162ac416bc5fe2c1fea4a86f9
-  data.tar.gz: a3f5146dcc4a4319ad83658b87d8e301aa68a7e3684bf6f27931a538dcc9bbd9ac9e76abfea6495ca2332b44883fc61e2c929f4705630494ff4670d6b8fb1f39
+  metadata.gz: 0ab0dc29557bce345a43f887ec2f3eae3738c86b7cd95055ad49b28b3147e9b9a3a795e7eddce6c9ebf7e821cda4afd3d32072930b7077641e8b87b418751402
+  data.tar.gz: 043b377c7cca9211f3dbfe3c2178f0fb07cff105f91bfc4237c3972aadf1ef57ab17f9541996ea362588361109d06ad45ed623af691634c5282ab6395eea5103

data/README.md

@@ -9,7 +9,7 @@
   <a href="https://github.com/fastlane/deliver">deliver</a> &bull; 
   <a href="https://github.com/fastlane/snapshot">snapshot</a> &bull; 
   <a href="https://github.com/fastlane/frameit">frameit</a> &bull; 
-  <a href="https://github.com/fastlane/PEM">PEM</a> &bull; 
+  <a href="https://github.com/fastlane/pem">pem</a> &bull; 
   <a href="https://github.com/fastlane/sigh">sigh</a> &bull; 
   <a href="https://github.com/fastlane/produce">produce</a> &bull;
   <a href="https://github.com/fastlane/cert">cert</a> &bull;

data/lib/fastlane_core.rb

@@ -15,6 +15,7 @@ require 'fastlane_core/print_table'
 require 'fastlane_core/project'
 require 'fastlane_core/simulator'
 require 'fastlane_core/crash_reporting/crash_reporting'
+require 'fastlane_core/ui/ui'
 
 # Third Party code
 require 'colored'

data/lib/fastlane_core/command_executor.rb

@@ -15,10 +15,10 @@ module FastlaneCore
 
         output = []
         command = command.join(" ") if command.kind_of?(Array)
-        Helper.log.info command.yellow.strip if print_command
+        UI.command(command) if print_command
 
         if print_all and loading # this is only used to show the "Loading text"...
-          puts loading.cyan
+          UI.command_output(loading)
         end
 
         begin
@@ -29,14 +29,12 @@ module FastlaneCore
 
               next unless print_all
 
-              line = line.cyan
-
               # Prefix the current line with a string
               prefix.each do |element|
                 line = element[:prefix] + line if element[:block] && element[:block].call(line)
               end
 
-              puts line
+              UI.command_output(line)
             end
             Process.wait(pid)
           end
@@ -54,7 +52,7 @@ module FastlaneCore
         if status != 0
           o = output.join("\n")
           puts o # the user has the right to see the raw output
-          Helper.log.info "Exit status: #{status}"
+          UI.error "Exit status: #{status}"
           error.call(o, status)
         end
 

data/lib/fastlane_core/configuration/commander_generator.rb

@@ -11,6 +11,8 @@ module FastlaneCore
 
       short_codes = []
       options.each do |option|
+        next if option.description.to_s.length == 0 # "private" options
+
         appendix = (option.is_string ? "STRING" : "")
         type = (option.is_string ? String : nil)
         short_option = option.short_option

data/lib/fastlane_core/helper.rb

@@ -1,6 +1,7 @@
 require 'logger'
 
 module FastlaneCore
+  # rubocop:disable Metrics/ModuleLength
   module Helper
     # Logging happens using this method
     def self.log
@@ -45,6 +46,15 @@ module FastlaneCore
       Helper.log.info(("-" * i).green)
     end
 
+    # 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.test?
       defined?SpecHelper
@@ -141,4 +151,5 @@ module FastlaneCore
       end
     end
   end
+  # rubocop:enable Metrics/ModuleLength
 end

data/lib/fastlane_core/print_table.rb

@@ -8,7 +8,7 @@ module FastlaneCore
         rows = []
 
         config.available_options.each do |config_item|
-          value = config[config_item.key]
+          value = config._values[config_item.key] # using `_values` here to not ask the user for missing values at this point
           next if value.nil?
           next if value.to_s == ""
           next if hide_keys.include?(config_item.key)

data/lib/fastlane_core/ui/disable_colors.rb

@@ -0,0 +1,17 @@
+# 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/fastlane_core/ui/implementations/shell.rb

@@ -0,0 +1,100 @@
+module FastlaneCore
+  # 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
+
+      if Helper.is_test?
+        @log ||= Logger.new(nil) # don't show any logs when running tests
+      else
+        @log ||= Logger.new($stdout)
+      end
+
+      @log.formatter = proc do |severity, datetime, progname, msg|
+        string = "#{severity} [#{datetime.strftime('%Y-%m-%d %H:%M:%S.%2N')}]: " if $verbose
+        string = "[#{datetime.strftime('%H:%M:%S')}]: " unless $verbose
+
+        string += "#{msg}\n"
+
+        string
+      end
+
+      @log
+    end
+
+    #####################################################
+    # @!group Messaging: show text to the user
+    #####################################################
+
+    def error(message)
+      log.error(message.red)
+    end
+
+    def important(message)
+      log.warn(message.yellow)
+    end
+
+    def success(message)
+      log.info(message.green)
+    end
+
+    def message(message)
+      log.info(message)
+    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|
+        log.info("> #{msg}".magenta)
+      end
+    end
+
+    def verbose(message)
+      log.debug(message) if $verbose
+    end
+
+    def header(message)
+      i = message.length + 8
+      Helper.log.info(("-" * i).green)
+      Helper.log.info(("--- " + message + " ---").green)
+      Helper.log.info(("-" * i).green)
+    end
+
+    #####################################################
+    # @!group Errors: Different kinds of exceptions
+    #####################################################
+
+    def crash!(exception)
+      if exception.kind_of?(String)
+        raise exception.red
+      elsif exception.kind_of?(Exception)
+        # From https://stackoverflow.com/a/4789702/445598
+        # We do this to make the actual error message red and therefore more visible
+        begin
+          raise exception
+        rescue => ex
+          raise $!, "[!] #{ex.message}".red, $!.backtrace
+        end
+      else
+        raise exception # we're just raising whatever we have here #yolo
+      end
+    end
+
+    def user_error!(error_message)
+      error_message = "[!] #{error_message}".red
+      if $verbose
+        # On verbose we want to see the full stack trace
+        raise error_message
+      else
+        abort(error_message)
+      end
+    end
+  end
+end

data/lib/fastlane_core/ui/interface.rb

@@ -0,0 +1,102 @@
+module FastlaneCore
+  # 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
+    #   fastlane 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 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: Different kinds of exceptions
+    #####################################################
+
+    # Pass an exception to this method to exit the program
+    #   using the given exception
+    def crash!(_exception)
+      not_implemented(__method__)
+    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
+    # This will show the error message, but doesn't show the full
+    #   stack trace
+    def user_error!(_error_message)
+      not_implemented(__method__)
+    end
+
+    #####################################################
+    # @!group Helpers
+    #####################################################
+    def not_implemented(method_name)
+      raise "Current UI '#{self}' doesn't support method '#{method_name}'".red
+    end
+
+    def to_s
+      self.class.name.split('::').last
+    end
+  end
+end

data/lib/fastlane_core/ui/ui.rb

@@ -0,0 +1,28 @@
+module FastlaneCore
+  class UI
+    class << self
+      def current
+        @current ||= Shell.new
+      end
+    end
+
+    def self.method_missing(method_sym, *args, &_block)
+      raise "Only pass exactly one parameter to UI".red if args.length != 1
+
+      # not using `responds` beacuse we don't care about methods like .to_s and so on
+      interface_methods = Interface.instance_methods - Object.instance_methods
+      raise "Unknown method '#{method_sym}', supported #{interface_methods}" unless interface_methods.include?(method_sym)
+
+      self.current.send(method_sym, args.first)
+    end
+  end
+end
+
+require 'fastlane_core/ui/interface'
+
+# Import all available implementations
+Dir[File.expand_path('implementations/*.rb', File.dirname(__FILE__))].each do |file|
+  require file
+end
+
+require 'fastlane_core/ui/disable_colors' if ENV["FASTLANE_DISABLE_COLORS"]

data/lib/fastlane_core/version.rb

@@ -1,3 +1,3 @@
 module FastlaneCore
-  VERSION = "0.28.0"
+  VERSION = "0.29.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane_core
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.29.0
 platform: ruby
 authors:
 - Felix Krause
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-03 00:00:00.000000000 Z
+date: 2015-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -339,6 +339,10 @@ files:
 - lib/fastlane_core/project.rb
 - lib/fastlane_core/provisioning_profile.rb
 - lib/fastlane_core/simulator.rb
+- lib/fastlane_core/ui/disable_colors.rb
+- lib/fastlane_core/ui/implementations/shell.rb
+- lib/fastlane_core/ui/interface.rb
+- lib/fastlane_core/ui/ui.rb
 - lib/fastlane_core/update_checker/changelog.rb
 - lib/fastlane_core/update_checker/update_checker.rb
 - lib/fastlane_core/version.rb
@@ -362,7 +366,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.0
 signing_key: 
 specification_version: 4
 summary: Contains all shared code/dependencies of the fastlane.tools