cocoapods-api-diff 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dcfcfee72ab20b2af4e8b62f3c1006f98cc06bf8de51f8f2f3ec272052d111c9
+  data.tar.gz: a13f0786a173759ed8ebe4468b8b7ffacff8fe941c12d618c0e1ab8a0460f870
+SHA512:
+  metadata.gz: 43da02b004f8db558959ef26b57730ccd12ecf3233e3cc9c10445f9c54bf77b307e9f3e610cedfb11f9bc589418f2ac9a8182a54623fe10a20212dbec3317597
+  data.tar.gz: 2002a2ba669eaa96233181866b49587bc8693bad23f14604f4ce2f060cd40d59b14e5bae8e28c2b209a595aa30c4e72da5909345eeddc68fdfa7f75a9bf5c596

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+pkg
+.idea/

data/Gemfile

@@ -0,0 +1,14 @@
+# source 'https://rubygems.org'
+source 'https://gems.ruby-china.com/'
+
+# Specify your gem's dependencies in cocoapods-api-diff.gemspec
+gemspec
+
+group :development do
+  gem 'cocoapods'
+
+  gem 'mocha'
+  gem 'bacon'
+  gem 'mocha-on-bacon'
+  gem 'prettybacon'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2019 高森 <gaosen@tuya.com>
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,11 @@
+# cocoapods-api-diff
+
+A description of cocoapods-api-diff.
+
+## Installation
+
+    $ gem install cocoapods-api-diff
+
+## Usage
+
+    $ pod spec diff POD_NAME

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+
+def specs(dir)
+  FileList["spec/#{dir}/*_spec.rb"].shuffle.join(' ')
+end
+
+desc 'Runs all the specs'
+task :specs do
+  sh "bundle exec bacon #{specs('**')}"
+end
+
+task :default => :specs
+

data/cocoapods-api-diff.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cocoapods-api-diff/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cocoapods-api-diff'
+  spec.version       = CocoapodsApiDiff::VERSION
+  spec.authors       = ['高森']
+  spec.email         = ['gaosen@tuya.com']
+  spec.description   = %q{A short description of cocoapods-api-diff.}
+  spec.summary       = %q{A longer description of cocoapods-api-diff.}
+  spec.homepage      = 'https://registry.code.tuya-inc.top/tuyaIOSSDK/cocoapods-api-diff'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/cocoapods-api-diff.rb

@@ -0,0 +1 @@
+require 'cocoapods-api-diff/gem_version'

data/lib/cocoapods-api-diff/command.rb

@@ -0,0 +1 @@
+require 'cocoapods-api-diff/command/diff'

data/lib/cocoapods-api-diff/command/diff.rb

@@ -0,0 +1,204 @@
+module Pod
+  class Command
+    # 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
+    #
+    # @todo Create a PR to add your plugin to CocoaPods/cocoapods.org
+    #       in the `plugins.json` file, once your plugin is released.
+    #
+    class Diff < Command
+      self.summary = 'Simply review the api change of a pod between two versions.'
+
+      self.description = <<-DESC
+        cocoapods-api-diff will compare two versions of the pod, preprocessing the public headers with `clang` command line tool, and diff. Then show you the changes.
+      DESC
+
+      self.arguments = [
+        CLAide::Argument.new('NAME', true),
+        CLAide::Argument.new('[VERSION_A]', true),
+        CLAide::Argument.new('[VERSION_B]', true),
+      ]
+
+      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
+
+      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
+
+      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
+
+      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
+
+      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
+
+      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
+
+      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
+
+      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
+
+    end
+  end
+end

data/lib/cocoapods-api-diff/gem_version.rb

@@ -0,0 +1,3 @@
+module CocoapodsApiDiff
+  VERSION = "0.1.0"
+end

data/lib/cocoapods_plugin.rb

@@ -0,0 +1 @@
+require 'cocoapods-api-diff/command'

data/spec/command/diff_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+module Pod
+  describe Command::Diff do
+    describe 'CLAide' do
+      it 'registers it self' do
+        Command.parse(%w{ diff }).should.be.instance_of Command::Diff
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+require 'pathname'
+ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+$:.unshift((ROOT + 'lib').to_s)
+$:.unshift((ROOT + 'spec').to_s)
+
+require 'bundler/setup'
+require 'bacon'
+require 'mocha-on-bacon'
+require 'pretty_bacon'
+require 'pathname'
+require 'cocoapods'
+
+Mocha::Configuration.prevent(:stubbing_non_existent_method)
+
+require 'cocoapods_plugin'
+
+#-----------------------------------------------------------------------------#
+
+module Pod
+
+  # Disable the wrapping so the output is deterministic in the tests.
+  #
+  UI.disable_wrap = true
+
+  # Redirects the messages to an internal store.
+  #
+  module UI
+    @output = ''
+    @warnings = ''
+
+    class << self
+      attr_accessor :output
+      attr_accessor :warnings
+
+      def puts(message = '')
+        @output << "#{message}\n"
+      end
+
+      def warn(message = '', actions = [])
+        @warnings << "#{message}\n"
+      end
+
+      def print(message)
+        @output << message
+      end
+    end
+  end
+end
+
+#-----------------------------------------------------------------------------#

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: cocoapods-api-diff
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- 高森
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A short description of cocoapods-api-diff.
+email:
+- gaosen@tuya.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cocoapods-api-diff.gemspec
+- lib/cocoapods-api-diff.rb
+- lib/cocoapods-api-diff/command.rb
+- lib/cocoapods-api-diff/command/diff.rb
+- lib/cocoapods-api-diff/gem_version.rb
+- lib/cocoapods_plugin.rb
+- spec/command/diff_spec.rb
+- spec/spec_helper.rb
+homepage: https://registry.code.tuya-inc.top/tuyaIOSSDK/cocoapods-api-diff
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A longer description of cocoapods-api-diff.
+test_files:
+- spec/command/diff_spec.rb
+- spec/spec_helper.rb