fastlane 0.6.1 → 0.7.0

data/lib/fastlane/actions/testmunk.rb

@@ -11,10 +11,7 @@
 
 module Fastlane
   module Actions
-    module SharedValues
-    end
-
-    class TestmunkAction
+    class TestmunkAction < Action
       def self.run(_params)
         raise "Please pass your Testmunk email address using `ENV['TESTMUNK_EMAIL'] = 'value'`" unless ENV['TESTMUNK_EMAIL']
         raise "Please pass your Testmunk API Key using `ENV['TESTMUNK_API'] = 'value'`" unless ENV['TESTMUNK_API']
@@ -36,6 +33,22 @@ module Fastlane
           raise 'Something went wrong while uploading your app to Testmunk'.red
         end
       end
+
+      def self.description
+        "Run tests on real devices using Testmunk"
+      end
+
+      def self.available_options
+        [
+          ['', 'Your email address', 'TESTMUNK_EMAIL'],
+          ['', 'Testmunk API Key', 'TESTMUNK_API'],
+          ['', 'Testmunk App Name', 'TESTMUNK_APP']
+        ]
+      end
+
+      def self.author
+        "mposchen"
+      end
     end
   end
 end

data/lib/fastlane/actions/typetalk.rb

@@ -1,6 +1,6 @@
 module Fastlane
   module Actions
-    class TypetalkAction
+    class TypetalkAction < Action
       def self.run(params)
         options = {
             message: nil,
@@ -50,6 +50,24 @@ module Fastlane
             raise "Could not sent Typetalk notification".red
         end
       end
+
+      def self.description
+        "Post a message to Typetalk"
+      end
+
+      def self.available_options
+        [
+          ['message', 'The message to post'],
+          ['note_path', 'Path to a md file'],
+          ['topicId', ''],
+          ['success', 'Successful build?'],
+          ['typetalk_token', 'API token']
+        ]
+      end
+
+      def self.author
+        "dataich"
+      end
     end
   end
 end

data/lib/fastlane/actions/update_project_code_signing.rb

@@ -3,7 +3,7 @@ module Fastlane
     module SharedValues
     end
 
-    class UpdateProjectCodeSigningAction
+    class UpdateProjectCodeSigningAction < Action
       def self.run(params)
         path = params.first
         path = File.join(path, "project.pbxproj")
@@ -19,6 +19,18 @@ module Fastlane
 
         Helper.log.info("Successfully updated project settings to use UDID '#{udid}'".green)
       end
+
+      def self.description
+        "Updated code signing settings from 'Automatic' to a specific profile"
+      end
+
+      def self.details
+        "This feature is not yet 100% finished"
+      end
+
+      def self.author
+        "KrauseFx"
+      end
     end
   end
 end

data/lib/fastlane/actions/xcode_select.rb

@@ -17,7 +17,7 @@ module Fastlane
     #   Xcode application directory -- the xcode-select provided  shims  will  automatically  convert  the
     #   environment variable into the full Developer content path.
     #
-    class XcodeSelectAction
+    class XcodeSelectAction < Action
       def self.run(params)
         xcode_path = params.first
 
@@ -25,12 +25,20 @@ module Fastlane
         raise "Path to Xcode application required (e.x. \"/Applications/Xcode.app\")".red unless xcode_path.to_s.length > 0
 
         # Verify that a path to a directory was passed in
-        raise "Nonexistent path provided".red unless Dir.exists? xcode_path
+        raise "Path '#{xcode_path}' doesn't exist".red unless Dir.exists?(xcode_path)
 
         Helper.log.info "Setting Xcode version to #{xcode_path} for all build steps"
 
         ENV["DEVELOPER_DIR"] = xcode_path + "/Contents/Developer"
       end
+
+      def self.description
+        "Change the xcode-path to use. Useful for beta versions of Xcode"
+      end
+
+      def self.author
+        "dtrenz"
+      end
     end
   end
 end

data/lib/fastlane/actions/xcodebuild.rb

@@ -7,7 +7,7 @@ module Fastlane
     # xcodebuild man page:
     # https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man1/xcodebuild.1.html
 
-    class XcodebuildAction
+    class XcodebuildAction < Action
       ARGS_MAP = {
         # actions
         analyze: "analyze",
@@ -117,8 +117,20 @@ module Fastlane
         xcpretty_args = [ "--color" ]
 
         if testing
-          # Test report file format
-          if params[:report_formats]
+          if params[:reports]
+            # New report options format
+            reports = params[:reports].map do |report|
+              unless report[:screenshots]
+                "--report #{report[:report]} --output #{report[:output]}"
+              else
+                "--report #{report[:report]} --output #{report[:output]} --screenshots"
+              end
+            end
+
+            xcpretty_args.push reports.join(" ")
+
+          elsif params[:report_formats]
+            # Test report file format
             report_formats = params[:report_formats].map do |format|
               "--report #{format}"
             end.sort().join(" ")
@@ -187,46 +199,114 @@ module Fastlane
 
         return workspace
       end
+
+      def self.description
+        "Use the `xcodebuild` command to build and sign your app"
+      end
+
+      def self.available_options
+        [
+          ['archive', 'Set to true to build archive'],
+          ['archive_path', 'The path to archive the to. Must contain `.xcarchive`'],
+          ['workspace', 'The workspace to use'],
+          ['scheme', 'The scheme to build'],
+          ['build_settings', 'Hash of additional build information']
+        ]
+      end
+
+      def self.details
+        "More infomration on GitHub: https://github.com/KrauseFx/fastlane/blob/master/docs/Actions.md#xcodebuild"
+      end
+
+      def self.author
+        "dtrenz"
+      end
     end
 
-    class XcarchiveAction
+    class XcarchiveAction < Action
       def self.run(params)
         params_hash = params.first || {}
         params_hash[:archive] = true
         XcodebuildAction.run([params_hash])
       end
+
+      def self.description
+        "Builds the project using `xcodebuild`"
+      end
+
+      def self.author
+        "dtrenz"
+      end
     end
 
-    class XcbuildAction
+    class XcbuildAction < Action
       def self.run(params)
         params_hash = params.first || {}
         params_hash[:build] = true
         XcodebuildAction.run([params_hash])
       end
+
+      def self.description
+        "Builds the project using `xcodebuild`"
+      end
+
+      def self.author
+        "dtrenz"
+      end
     end
 
-    class XccleanAction
+    class XccleanAction < Action
       def self.run(params)
         params_hash = params.first || {}
         params_hash[:clean] = true
         XcodebuildAction.run([params_hash])
       end
+
+      def self.description
+        "Builds the project using `xcodebuild`"
+      end
+
+      def self.author
+        "dtrenz"
+      end
     end
 
-    class XcexportAction
+    class XcexportAction < Action
       def self.run(params)
         params_hash = params.first || {}
         params_hash[:export_archive] = true
         XcodebuildAction.run([params_hash])
       end
+
+      def self.description
+        "Builds the project using `xcodebuild`"
+      end
+
+      def self.author
+        "dtrenz"
+      end
     end
 
-    class XctestAction
+    class XctestAction < Action
       def self.run(params)
         params_hash = params.first || {}
         params_hash[:test] = true
         XcodebuildAction.run([params_hash])
       end
+
+      def self.description
+        "Runs tests on the given simulator"
+      end
+
+      def available_options
+        [
+          ['destination', 'The simulator to use, e.g. "name=iPhone 5s,OS=8.1"']
+        ]
+      end
+
+      def self.author
+        "dtrenz"
+      end
     end
   end
 end

data/lib/fastlane/actions/xctool.rb

@@ -1,6 +1,6 @@
 module Fastlane
   module Actions
-    class XctoolAction
+    class XctoolAction < Action
       def self.run(params)
         unless Helper.test?
           raise 'xctool not installed, please install using `brew install xctool`'.red if `which xctool`.length == 0
@@ -8,6 +8,21 @@ module Fastlane
 
         Actions.sh('xctool ' + params.join(' '))
       end
+
+      def self.description
+        "Run tests using xctool"
+      end
+
+      def self.details
+        [
+          "It is recommended to store the build configuration in the `.xctool-args` file.",
+          "More information available on GitHub: https://github.com/KrauseFx/fastlane/blob/master/docs/Actions.md#xctool"
+        ].join(' ')
+      end
+
+      def self.author
+        "KrauseFx"
+      end
     end
   end
 end

data/lib/fastlane/actions_list.rb

@@ -0,0 +1,130 @@
+module Fastlane
+  class ActionsList
+    def self.run(filter)
+      require 'terminal-table'
+      print_all unless filter
+      show_details(filter) if filter
+    end
+
+    def self.print_all
+      rows = []
+      all_actions do |action, name|
+        current = []
+        current << name.yellow
+
+        if action < Action
+          current << action.description if action.description
+          current << action.author.green if action.author
+
+          l = (action.description || '').length
+        else
+          Helper.log.error "Please update your action file #{name} to be a subclass of `Action` by adding ` < Action` after your class name.".red
+          current << "Please update action file".red
+        end
+        rows << current
+      end
+
+      table = Terminal::Table.new(
+        title: "Available fastlane actions".green,
+        headings: ['Action', 'Description', 'Author'],
+        rows: rows
+      )
+      puts table
+
+      puts "Get more information for one specific action using `fastlane action [name]`"
+    end
+
+    def self.show_details(filter)
+      puts "Loading documentation for #{filter}:".green
+
+      puts ""
+
+      all_actions do |action, name|
+        next unless name == filter.strip
+        
+        rows = []
+        rows << [action.description] if action.description
+        rows << [' ']
+        if action.details
+          rows << [action.details]
+          rows << [' ']
+        end
+        rows << ["Created by #{action.author.green}"] if action.author
+
+        puts Terminal::Table.new(
+          title: filter.green,
+          rows: rows
+        )
+
+        puts "\n"
+
+        options = parse_options(action.available_options) if action.available_options
+
+        if options
+          puts Terminal::Table.new(
+            title: filter.green,
+            headings: ['Key', 'Description', 'Env Var'],
+            rows: options
+          )
+        else
+          puts "No available options".yellow
+        end
+        puts "\n"
+
+        output = parse_options(action.output, false) if action.output
+        if output
+          puts Terminal::Table.new(
+            title: filter.green,
+            headings: ['Key', 'Description'],
+            rows: output
+          )
+          puts "Access the output values using `Actions.lane_context[VARIABLE_NAME]`"
+          puts ""
+        end
+
+        
+
+        puts "More information can be found on https://github.com/KrauseFx/fastlane/blob/master/docs/Actions.md"
+        puts "\n"
+
+        return # our job is done here
+      end
+
+      puts "Couldn't find action for the given filter.".red
+      puts "==========================================\n".red
+      print_all # show all available actions instead
+    end
+
+
+    # Iterates through all available actions and yields from there
+    def self.all_actions
+      all_actions = Fastlane::Actions.constants.select {|c| Class === Fastlane::Actions.const_get(c)}
+      all_actions.each do |symbol|        
+        action = Fastlane::Actions.const_get(symbol)
+        name = symbol.to_s.gsub('Action', '').fastlane_underscore
+        yield action, name
+      end
+    end
+    
+    private
+      def self.parse_options(options, fill_three = true)
+        rows = []
+        rows << [options] if options.kind_of?String
+
+        if options.kind_of?Array
+          options.each do |current|
+            if current.kind_of?FastlaneCore::ConfigItem
+              rows << [current.key.to_s.yellow, current.description, current.env_name]
+            elsif current.kind_of?Array
+              raise "Invalid number of elements in this row: #{current}. Must be 2 or 3".red unless ([2, 3].include?current.count)
+              rows << current
+              rows.last[0] = rows.last.first.yellow # color it yellow :) 
+              rows.last << nil if (fill_three and rows.last.count == 2) # to have a nice border in the table
+            end
+          end
+        end
+
+        rows
+      end
+  end
+end

data/lib/fastlane/core_ext/string.rb

@@ -2,4 +2,12 @@ class String
   def fastlane_class
     split('_').collect!(&:capitalize).join
   end
+
+  def fastlane_underscore
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("-", "_").
+    downcase
+  end
 end