require_relative 'lane_manager_base.rb' module Pantograph class LaneManager < LaneManagerBase # @param platform The name of the platform to execute # @param lane_name The name of the lane to execute # @param parameters [Hash] The parameters passed from the command line to the lane # @param env Dot Env Information # @param A custom Pantfile path, this is used by pantograph.ci # rubocop:disable Metrics/PerceivedComplexity def self.cruise_lane(platform, lane, parameters = nil, env = nil, pantfile_path = nil) UI.user_error!('lane must be a string') unless lane.kind_of?(String) || lane.nil? UI.user_error!('platform must be a string') unless platform.kind_of?(String) || platform.nil? UI.user_error!('parameters must be a hash') unless parameters.kind_of?(Hash) || parameters.nil? ff = Pantograph::PantFile.new(pantfile_path || PantographCore::PantographFolder.pantfile_path) is_platform = false begin is_platform = ff.is_platform_block?(lane) rescue # rescue, because this raises an exception if it can't be found at all end unless is_platform # maybe the user specified a default platform # We'll only do this, if the lane specified isn't a platform, as we want to list all platforms then # Make sure that's not a lane without a platform unless ff.runner.available_lanes.include?(lane) platform ||= Actions.lane_context[Actions::SharedValues::DEFAULT_PLATFORM] end end if !platform && lane # Either, the user runs a specific lane in root or want to auto complete the available lanes for a platform # e.g. `pantograph ios` should list all available iOS actions if ff.is_platform_block?(lane) platform = lane lane = nil end end platform, lane = choose_lane(ff, platform) unless lane # xcodeproj has a bug in certain versions that causes it to change directories # and not return to the original working directory # https://github.com/CocoaPods/Xcodeproj/issues/426 # Setting this environment variable causes xcodeproj to work around the problem ENV["FORK_XCODE_WRITING"] = "true" if platform == 'ios' Pantograph::Helper::DotenvHelper.load_dot_env(env) started = Time.now e = nil begin ff.runner.execute(lane, platform, parameters) rescue NameError => ex print_lane_context print_error_line(ex) e = ex rescue Exception => ex # rubocop:disable Lint/RescueException # We also catch Exception, since the implemented action might send a SystemExit signal # (or similar). We still want to catch that, since we want properly finish running pantograph # Tested with `xcake`, which throws a `Xcake::Informative` object print_lane_context print_error_line(ex) UI.error(ex.to_s) if ex.kind_of?(StandardError) # we don't want to print things like 'system exit' e = ex end # After running the lanes, since skip_docs might be somewhere in-between Pantograph::DocsGenerator.run(ff) unless skip_docs? duration = ((Time.now - started) / 60.0).round finish_pantograph(ff, duration, e) return ff end # rubocop:enable Metrics/PerceivedComplexity def self.skip_docs? Helper.test? || PantographCore::Env.truthy?("PANTOGRAPH_SKIP_DOCS") end # Lane chooser if user didn't provide a lane # @param platform: is probably nil, but user might have called `pantograph $platform`, and only wants to list those actions def self.choose_lane(ff, platform) available = [] # nil is the key for lanes that are not under a specific platform lane_platforms = [nil] + Pantograph::SupportedPlatforms.all lane_platforms.each do |p| available += ff.runner.lanes[p].to_a.reject { |lane| lane.last.is_private } end if available.empty? UI.user_error!("It looks like you don't have any lanes to run just yet. Check out how to get started here: https://github.com/pantograph/pantograph 🚀") end rows = [] available.each_with_index do |lane, index| rows << [index + 1, lane.last.pretty_name, lane.last.description.join("\n")] end rows << [0, "cancel", "No selection, exit pantograph!"] require 'terminal-table' table = Terminal::Table.new( title: "Available lanes to run", headings: ['Number', 'Lane Name', 'Description'], rows: PantographCore::PrintTable.transform_output(rows) ) UI.message("Welcome to pantograph! Here's what your app is setup to do:") puts(table) i = UI.input("Which number would you like run?") i = i.to_i - 1 if i >= 0 && available[i] selection = available[i].last.pretty_name UI.important("Running lane `#{selection}`. Next time you can do this by directly typing `pantograph #{selection}` 🚀.") platform = selection.split(' ')[0] lane_name = selection.split(' ')[1] unless lane_name # no specific platform, just a root lane lane_name = platform platform = nil end return platform, lane_name # yeah else UI.user_error!("Run `pantograph` the next time you need to build, test or release your app 🚀") end end end end