Class: Pod::Command::Diff

Inherits:
Pod::Command show all
Defined in:
lib/cocoapods-api-diff/command/diff.rb

Overview

TODO:

Create a PR to add your plugin to CocoaPods/cocoapods.org in the ‘plugins.json` file, once your plugin is released.

This is an example of a cocoapods plugin adding a top-level subcommand to the ‘pod’ command.

You can also create subcommands of existing or new commands. Say you wanted to add a subcommand to ‘list` to show newly deprecated pods, (e.g. `pod list deprecated`), there are a few things that would need to change.

  • move this file to ‘lib/pod/command/list/deprecated.rb` and update the class to exist in the the Pod::Command::List namespace

  • change this class to extend from ‘List` instead of `Command`. This tells the plugin system that it is a subcommand of `list`.

  • edit ‘lib/cocoapods_plugins.rb` to require this file

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(argv) ⇒ Diff

Returns a new instance of Diff.



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/cocoapods-api-diff/command/diff.rb', line 39

def initialize(argv)
  @name = argv.shift_argument
  @version_a = Version.new(argv.shift_argument)
  @version_b = Version.new(argv.shift_argument)
  @platform = :ios

  @spec_sources = argv.option('spec-sources', 'master').split(',')
  repos = Dir["#{ENV['HOME']}/.cocoapods/repos/*"].select do |path|
    source = Pod::Source.new(path)
    matches = false
    @spec_sources.each do |s|
      if s == source.name || s == source.url
        matches = true
      end
    end
    matches
  end

  @sources = repos.map do |path|
    source = Pod::Source.new(path)
  end
  @sources = @sources || []

  super
end

Class Method Details

.options ⇒ Object 



33
34
35
36
37
 
# File 'lib/cocoapods-api-diff/command/diff.rb', line 33

def self.options
  [
    ['--spec-sources=private,https://github.com/CocoaPods/Specs.git', 'The sources to pull dependent pods from (defaults to https://github.com/CocoaPods/Specs.git)'],
  ]
end

Instance Method Details

#clang_parse_headers(spec, platform) ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/cocoapods-api-diff/command/diff.rb', line 146

def clang_parse_headers(spec, platform)

  consumer = spec.consumer(platform)

  public_header_files = []
  (consumer.public_header_files.length > 0 ? consumer.public_header_files : ["**/*.h"]).each do |file|
    public_header_files += Dir[file]
  end

  private_header_files = []
  consumer.private_header_files.each do |file|
    private_header_files += Dir[file]
  end

  public_header_files -= private_header_files
  public_header_files.select! do |file|
    !File.symlink?(file)
  end

  # Remove all import lines to avoid duplicate result and speed up
  public_header_files.each do |file|
    data = File.read(file)
    data.gsub!(/[#@](import|include|class)\s*.*/, '')
    data.gsub!(/(FOUNDATION_EXTERN|UIKIT_EXTERN)/, '')
    File.delete(file)
    File.write(file, data)
  end

  # UI.puts "public_header_files: #{public_header_files}"

  result = `clang \
    -Xclang -ast-print \
    -ObjC \
    -fno-diagnostics-color \
    -fsyntax-only \
    #{public_header_files.map{ |file| "\"#{file}\""}.join(" ")} \
    2> /dev/null
  `

  # TODO parse & sort

  return result
end

#diff_results(result_a, result_b) ⇒ Object 



190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/cocoapods-api-diff/command/diff.rb', line 190

def diff_results(result_a, result_b)
  `git init`
  file = "#{@name}.h"
  File.write(file, result_a)
  `git add #{file}`
  `rm #{file}`
  File.write(file, result_b)

  system("git --no-pager diff #{file}")

end

#get_spec_from_sources(sources, name, version) ⇒ Object 



109
110
111
112
113
114
115
116
117
 
# File 'lib/cocoapods-api-diff/command/diff.rb', line 109

def get_spec_from_sources(sources, name, version)
  spec = nil
  sources.each do |source|
    if source.versions(name).include?(version)
      spec = source.specification(name, version)
    end
  end
  return spec
end

#install_pod(spec, platform_name, sandbox_root) ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/cocoapods-api-diff/command/diff.rb', line 119

def install_pod(spec, platform_name, sandbox_root)
  # Remove useless dependencies & platform deployment_target
  spec.store_attribute(:dependencies, nil)
  spec.store_attribute(:dependencies, nil, @platform)
  spec.store_attribute(:platforms, {platform_name => 0})

  # Recreate podspec
  spec_path = "#{spec.name}-#{spec.version}.podspec.json"
  # UI.puts "podspec: #{spec.to_json}"
  File.write(spec_path, spec.to_json)

  podfile = Pod::Podfile.new do
    install!('cocoapods', :integrate_targets => false)
    platform(platform_name)
    target('api-diff') do
      pod(spec.name, podspec: spec_path)
    end
  end

  sandbox = Sandbox.new(sandbox_root)
  installer = Installer.new(sandbox, podfile)

  UI.puts "> Installing #{spec.name} #{spec.version}..."
  installer.install!

end

#run ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/cocoapods-api-diff/command/diff.rb', line 83

def run
  Dir.mktmpdir('cocoapods-api-diff-') do |tmpDir|
    Dir.chdir(tmpDir) do
      UI.puts "> Create temp dir at: #{tmpDir}"

      spec_a = get_spec_from_sources(@sources, @name, @version_a)
      install_pod(spec_a, @platform, spec_a.version.to_s)
      result_a = nil
      Dir.chdir(File.join(spec_a.version.to_s, @name)) do
        result_a = clang_parse_headers(spec_a, @platform.to_s)
      end

      spec_b = get_spec_from_sources(@sources, @name, @version_b)
      sandbox_b = install_pod(spec_b, @platform, spec_b.version.to_s)
      result_b = nil
      Dir.chdir(File.join(spec_b.version.to_s, @name)) do
        result_b = clang_parse_headers(spec_b, @platform.to_s)
      end

      UI.puts "> Diff #{@name} #{@version_a} & #{@version_b}"
      diff_results(result_a, result_b)

    end
  end
end

#validate! ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/cocoapods-api-diff/command/diff.rb', line 65

def validate!
  super
  help! 'A Pod name is required.' unless @name
  help! 'Version A is required.' unless @version_a
  help! 'Version B is required.' unless @version_b
  help! 'Version A and Version B are same.' unless @version_a != @version_b

  versions = []
  @sources.each do |source|
    versions += source.versions(@name) || []
  end

  help! "#{@name} can not be found in repo #{@spec_sources}." unless versions.length != 0
  help! "#{@name} (#{@version_a}) can not be found in repo #{@spec_sources}. Avaliable versions: #{versions.map{|v| v.to_s}}" unless versions.include?(@version_a)
  help! "#{@name} (#{@version_b}) can not be found in repo #{@spec_sources}. Avaliable versions: #{versions.map{|v| v.to_s}}" unless versions.include?(@version_b)

end