class Pod::Command::Try

The pod try command. @CocoaPods 0.29.0

Constants

TRY_TMP_DIR

@return [Pathname]

Public Class Methods

new(argv) click to toggle source
Calls superclass method
# File lib/pod/command/try.rb, line 32
def initialize(argv)
  @name = argv.shift_argument
  @podspec_name = argv.option('podspec_name')
  super
end
options() click to toggle source
Calls superclass method
# File lib/pod/command/try.rb, line 26
def self.options
  [
    ['--podspec_name=[name]', 'The name of the podspec file within the Git Repository'],
  ].concat(super)
end

Public Instance Methods

cocoapods_version() click to toggle source

@return [Pod::Version] the version of CocoaPods currently running

# File lib/pod/command/try.rb, line 272
def cocoapods_version
  Pod::Version.new(Pod::VERSION)
end
git_url?(name) click to toggle source

@return [Bool] Wether the given string is the name of a Pod or an URL

for a Git repo.
# File lib/pod/command/try.rb, line 251
def git_url?(name)
  prefixes = ['https://', 'http://']
  prefixes.any? { |prefix| name.start_with?(prefix) }
end
install_pod(spec, sandbox) click to toggle source

Installs the specification in the given directory.

@param [Specification] The specification of the Pod. @param [Pathname] The directory of the sandbox where to install the

Pod.

@return [Pathname] The path where the Pod was installed

# File lib/pod/command/try.rb, line 136
def install_pod(spec, sandbox)
  specs = { :ios => spec, :osx => spec }
  if cocoapods_version >= Pod::Version.new('1.8.0')
    dummy_podfile = Podfile.new
    installer = Installer::PodSourceInstaller.new(sandbox, dummy_podfile, specs, :can_cache => false)
  else
    installer = Installer::PodSourceInstaller.new(sandbox, specs, :can_cache => false)
  end
  installer.install!
  sandbox.root + spec.name
end
install_podfile(proj) click to toggle source

Performs a CocoaPods installation for the given project if Podfile is found. Shells out to avoid issues with the config of the process running the try command.

@return [String] proj

The path of the project.

@return [String] The path of the file to open, in other words the

workspace of the installation or the given project.
# File lib/pod/command/try.rb, line 192
def install_podfile(proj)
  return unless proj
  dirname = Pathname.new(proj).dirname
  podfile_path = dirname + 'Podfile'
  if podfile_path.exist?
    Dir.chdir(dirname) do
      perform_cocoapods_installation

      podfile = Pod::Podfile.from_file(podfile_path)

      if podfile.workspace_path
        File.expand_path(podfile.workspace_path)
      else
        proj.to_s.chomp(File.extname(proj.to_s)) + '.xcworkspace'
      end
    end
  else
    proj
  end
end
open_project(path) click to toggle source

Opens the project at the given path.

@return [String] path

The path of the project.

@return [void]

# File lib/pod/command/try.rb, line 234
def open_project(path)
  UI.puts "Opening '#{path}'"
  `open "#{path}"`
end
perform_cocoapods_installation() click to toggle source

@return [void] Performs a CocoaPods installation in the working

directory.
# File lib/pod/command/try.rb, line 242
def perform_cocoapods_installation
  UI.titled_section 'Performing CocoaPods Installation' do
    Command::Install.invoke
  end
end
pick_demo_project(dir) click to toggle source

Picks a project or workspace suitable for the demo purposes in the given directory.

To decide the project simple heuristics are used according to the name, if no project is found this method raises and `Informative` otherwise if more than one project is found the choice is presented to the user.

@param [#to_s] dir

The path where to look for projects.

@return [String] The path of the project.

# File lib/pod/command/try.rb, line 160
def pick_demo_project(dir)
  dir = Pathname.new(dir)
  projs = projects_in_dir(dir)
  if projs.count == 0
    raise Informative, 'Unable to find any project in the source files' \
      " of the Pod: `#{dir}`"
  elsif projs.count == 1
    projs.first
  elsif (workspaces = projs.grep(/(demo|example|sample).*\.xcworkspace$/i)).count == 1
    workspaces.first
  elsif (projects = projs.grep(/demo|example|sample/i)).count == 1
    projects.first
  else
    message = 'Which project would you like to open'
    selection_array = projs.map do |p|
      Pathname.new(p).relative_path_from(dir).to_s
    end
    index = UI.choose_from_array(selection_array, message)
    projs[index]
  end
end
projects_in_dir(dir) click to toggle source

@return [Array<String>] The list of the workspaces and projects in a

given directory excluding The Pods project and the projects
that have a sister workspace.
# File lib/pod/command/try.rb, line 260
def projects_in_dir(dir)
  glob_match = Dir.glob("#{dir}/**/*.xc{odeproj,workspace}")
  glob_match = glob_match.reject do |p|
    next true if p.include?('Pods.xcodeproj')
    next true if p.end_with?('.xcodeproj/project.xcworkspace')
    sister_workspace = p.chomp(File.extname(p.to_s)) + '.xcworkspace'
    p.end_with?('.xcodeproj') && glob_match.include?(sister_workspace)
  end
end
run() click to toggle source
# File lib/pod/command/try.rb, line 44
def run
  ensure_master_spec_repo_exists!
  sandbox = Sandbox.new(TRY_TMP_DIR)
  spec = setup_spec_in_sandbox(sandbox)

  UI.title "Trying #{spec.name}" do
    pod_dir = install_pod(spec, sandbox)
    settings = TrySettings.settings_from_folder(pod_dir)
    Dir.chdir(pod_dir) { settings.run_pre_install_commands(true) }
    proj = settings.project_path || pick_demo_project(pod_dir)
    file = install_podfile(proj)
    if file
      open_project(file)
    else
      UI.puts "Unable to locate a project for #{spec.name}"
    end
  end
end
setup_spec_in_sandbox(sandbox) click to toggle source

Puts the spec's data in the sandbox

# File lib/pod/command/try.rb, line 74
def setup_spec_in_sandbox(sandbox)
  if git_url?(@name)
    spec = spec_with_url(@name, @podspec_name)
    sandbox.store_pre_downloaded_pod(spec.name)
  else
    update_specs_repos
    spec = spec_with_name(@name)
  end
  spec
end
spec_with_name(name) click to toggle source

Returns the specification of the last version of the Pod with the given name.

@param [String] name

The name of the pod.

@return [Specification] The specification.

# File lib/pod/command/try.rb, line 93
def spec_with_name(name)
  set = config.sources_manager.search(Dependency.new(name))
  if set
    set.specification.root
  else
    raise Informative, "Unable to find a specification for `#{name}`"
  end
end
spec_with_url(url, spec_name = nil) click to toggle source

Returns the specification found in the given Git repository URL by downloading the repository.

@param [String] url

The URL for the pod Git repository.

@param [String] spec_name

The name of the podspec file within the Git repository.

@return [Specification] The specification.

# File lib/pod/command/try.rb, line 113
def spec_with_url(url, spec_name = nil)
  name = url.split('/').last
  name = name.chomp('.git') if name.end_with?('.git')
  name = spec_name unless spec_name.nil?

  target_dir = TRY_TMP_DIR + name
  target_dir.rmtree if target_dir.exist?

  downloader = Pod::Downloader.for_target(target_dir, :git => url)
  downloader.download

  spec_file = Pathname.glob(target_dir + "#{name}.podspec{,.json}").first
  Pod::Specification.from_file(spec_file)
end
update_specs_repos() click to toggle source

@return [void] Updates the specs repo unless disabled by the config.

# File lib/pod/command/try.rb, line 220
def update_specs_repos
  return unless repo_update?(:default => true)
  UI.section 'Updating spec repositories' do
    config.sources_manager.update
  end
end
validate!() click to toggle source
Calls superclass method
# File lib/pod/command/try.rb, line 38
def validate!
  super
  help! 'A Pod name or URL is required.' unless @name
  help! 'Podspec name can only be used with a Git URL' if @podspec_name && !git_url?(@name)
end