Class: Pod::Command::Try

Inherits:
Pod::Command show all
Includes:
RepoUpdate
Defined in:
lib/pod/command/try.rb

Overview

The pod try command.

Constant Summary collapse

TRY_TMP_DIR =

Returns:

  • (Pathname) 
Pathname.new(Dir.tmpdir) + 'CocoaPods/Try'

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(argv) ⇒ Try

Returns a new instance of Try.



32
33
34
35
36
 
# File 'lib/pod/command/try.rb', line 32

def initialize(argv)
  @name = argv.shift_argument
  @podspec_name = argv.option('podspec_name')
  super
end

Class Method Details

.options ⇒ Object 



26
27
28
29
30
 
# 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

Instance Method Details

#git_url?(name) ⇒ Bool

Returns Wether the given string is the name of a Pod or an URL for a Git repo.

Returns:

  • (Bool) —

    Wether the given string is the name of a Pod or an URL for a Git repo.



245
246
247
248
 
# File 'lib/pod/command/try.rb', line 245

def git_url?(name)
  prefixes = ['https://', 'http://']
  prefixes.any? { |prefix| name.start_with?(prefix) }
end

#install_pod(spec, sandbox) ⇒ Pathname

Installs the specification in the given directory.

Parameters:

  • The (Specification) —

    specification of the Pod.

  • The (Pathname) —

    directory of the sandbox where to install the Pod.

Returns:

  • (Pathname) —

    The path where the Pod was installed



136
137
138
139
140
141
 
# File 'lib/pod/command/try.rb', line 136

def install_pod(spec, sandbox)
  specs = { :ios => spec, :osx => spec }
  installer = Installer::PodSourceInstaller.new(sandbox, specs, :can_cache => false)
  installer.install!
  sandbox.root + spec.name
end

#install_podfile(proj) ⇒ String

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.

Returns:

  • (String) —

    proj The path of the project.

  • (String) —

    The path of the file to open, in other words the workspace of the installation or the given project.



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/pod/command/try.rb', line 186

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) ⇒ String, void

Opens the project at the given path.

Returns:

  • (String) —

    path The path of the project.

  • (void) 


228
229
230
231
 
# File 'lib/pod/command/try.rb', line 228

def open_project(path)
  UI.puts "Opening '#{path}'"
  `open "#{path}"`
end

#perform_cocoapods_installation ⇒ void

This method returns an undefined value.

Returns Performs a CocoaPods installation in the working directory.



236
237
238
239
240
 
# File 'lib/pod/command/try.rb', line 236

def perform_cocoapods_installation
  UI.titled_section 'Performing CocoaPods Installation' do
    Command::Install.invoke
  end
end

#pick_demo_project(dir) ⇒ String

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.

Parameters:

  • dir (#to_s) —

    The path where to look for projects.

Returns:

  • (String) —

    The path of the project.



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/pod/command/try.rb', line 155

def pick_demo_project(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) ⇒ Array<String>

Returns The list of the workspaces and projects in a given directory excluding The Pods project and the projects that have a sister workspace.

Returns:

  • (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.



254
255
256
257
258
259
260
261
262
 
# File 'lib/pod/command/try.rb', line 254

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 ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# 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) ⇒ Object

Puts the spec’s data in the sandbox



74
75
76
77
78
79
80
81
82
83
 
# 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) ⇒ Specification

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

Parameters:

  • name (String) —

    The name of the pod.

Returns:

  • (Specification) —

    The specification.



93
94
95
96
97
98
99
100
 
# 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) ⇒ Specification

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

Parameters:

  • url (String) —

    The URL for the pod Git repository.

  • spec_name (String) (defaults to: nil) —

    The name of the podspec file within the Git repository.

Returns:

  • (Specification) —

    The specification.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# 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 ⇒ void

This method returns an undefined value.

Returns Updates the specs repo unless disabled by the config.



214
215
216
217
218
219
 
# File 'lib/pod/command/try.rb', line 214

def update_specs_repos
  return unless repo_update?(:default => true)
  UI.section 'Updating spec repositories' do
    config.sources_manager.update
  end
end

#validate! ⇒ Object 



38
39
40
41
42
 
# 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