cocoapods-check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d464625d3eba53ea9ddf31b4ba57ebc0c37fcad2
+  data.tar.gz: fc987db227dccab588e97345a3c30e3ec3692f53
+SHA512:
+  metadata.gz: 4d55b9d5ab7d111d799954a6c119a30a49217035cba4158c7c377017967b80ae5fa478711444af103b7d6f47faacec596586f4758902cc778bd4875d3bef4875
+  data.tar.gz: 520e7086f606c0cbb03f51fa5cc28018af3fb1f34f103813bd8ad4ebf36d0c3f893f511cab0d1d1678a1534bfee97b00771325b192c5d1234d9fef4105d968b9

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+Gemfile.lock
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cocoapods-check.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,41 @@
+# cocoapods-check
+
+[![license](https://img.shields.io/badge/license-apache_2.0-red.svg?style=flat)](https://raw.githubusercontent.com/square/keywhiz/master/LICENSE)
+
+cocoapods-check displays the differences between locked and installed Pods. It can save time by quickly showing whether it's necessary to run `pod install`. For more information see https://github.com/CocoaPods/CocoaPods/issues/4385 and https://github.com/CocoaPods/CocoaPods/issues/4346.
+
+## Installation
+
+    $ gem install cocoapods-check
+
+## Usage
+
+`pod check` will display a list of Pods that will be installed by running `pod install`:
+
+    $ pod check
+    ~SquareData, +SquareItems, ΔSquareTables
+    [!] `pod install` will install 3 Pods.
+
+The symbol before each Pod name indicates the status of the Pod. A `~` indicates a version of a Pod exists locally, but the version specified in `Podfile.lock` is different. A `+` indicates no version of the Pod exists locally, while a `Δ` indicates the Pod is a development Pod. Development pods are always assumed to be 'dirty'. Pods that don't require an update will not be listed.
+
+Verbose mode shows a bit more detail:
+
+    $ pod check --verbose
+    SquareData 1.2.1 -> 1.2.2
+    SquareItems newly added
+    SquareTables {:path=>"/Users/doo/Code/SquareTables"}
+    [!] `pod install` will install 3 Pods.
+
+If no Pods are out of date, then the output looks like:
+
+    $ pod check
+    The Podfile's dependencies are satisfied
+
+## Exit Code
+
+If any Pods are out of date, `pod check` will exit with a non-zero exit code. Otherwise it will exit with an exit code of zero.
+
+## License
+
+cocoapods-check is under the Apache 2.0 license. See the [LICENSE](LICENSE) file for details.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/cocoapods-check.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cocoapods_check.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cocoapods-check'
+  spec.version       = CocoapodsCheck::VERSION
+  spec.authors       = ['Matt Di Iorio']
+  spec.email         = ['doo@squareup.com']
+
+  spec.summary       = %q{'check' plugin for CocoaPods}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/square/cocoapods-check"
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10.6'
+  spec.add_development_dependency "rake", '~> 10.0'
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency 'cocoapods', "~> 0.39.0"
+end

data/lib/cocoapods_check.rb

@@ -0,0 +1,3 @@
+module CocoapodsCheck
+  VERSION = '0.1.0'
+end

data/lib/cocoapods_plugin.rb

@@ -0,0 +1 @@
+require 'pod/command/check'

data/lib/pod/command/check.rb

@@ -0,0 +1,119 @@
+# The CocoaPods check command.
+
+# The CocoaPods namespace
+module Pod
+  class Command
+    class Check < Command
+      self.summary = <<-SUMMARY
+          Displays which Pods would be changed by running `pod install`
+      SUMMARY
+
+      self.description = <<-DESC
+          Compares the Pod lockfile with the manifest lockfile and shows
+          any differences. In non-verbose mode, '~' indicates an existing Pod
+          will be updated to the version specified in Podfile.lock, '+'
+          indicates a missing Pod will be installed, and 'Δ' indicates a Pod
+          is a development Pod. Development Pods are always considered
+          to need installation.
+      DESC
+
+      self.arguments = []
+
+      def self.options
+        [
+          ['--verbose', 'Show change details.']
+        ].concat(super)
+      end
+
+      def initialize(argv)
+        @check_command_verbose = argv.flag?('verbose')
+        super
+      end
+
+      def run
+        unless config.lockfile
+          raise Informative, 'Missing Podfile.lock!'
+        end
+
+        development_pods = find_development_pods(config.podfile)
+        results = find_differences(config, development_pods)
+        print_results(results)
+      end
+
+      def find_development_pods(podfile)
+        development_pods = {}
+        podfile.dependencies.each do |dependency|
+          development_pods[dependency.name] = dependency.external_source if dependency.external?
+        end
+        development_pods
+      end
+
+      def find_differences(config, development_pods)
+        all_pod_names = config.lockfile.pod_names
+        all_pod_names.concat development_pods.keys
+
+        all_pod_names.sort.uniq.map do |spec_name|
+          locked_version = config.lockfile.version(spec_name)
+
+          # If no manifest, assume Pod hasn't been installed
+          if config.sandbox.manifest
+            manifest_version = config.sandbox.manifest.version(spec_name)
+          else
+            manifest_version = nil
+          end
+
+          # If this is a development Pod
+          if development_pods[spec_name] != nil
+            development_result(spec_name, development_pods[spec_name])
+
+          # If this Pod is installed
+          elsif manifest_version
+            if locked_version != manifest_version
+              changed_result(spec_name, manifest_version, locked_version)
+            end
+
+          # If this Pod is not installed
+          else
+            added_result(spec_name)
+          end
+        end.compact
+      end
+
+      def development_result(spec_name, external_source)
+        if @check_command_verbose
+          "#{spec_name} #{external_source}"
+        else
+          "Δ#{spec_name}"
+        end
+      end
+
+      def changed_result(spec_name, manifest_version, locked_version)
+        if @check_command_verbose
+          "#{spec_name} #{manifest_version} -> #{locked_version}"
+        else
+          "~#{spec_name}"
+        end
+      end
+
+      def added_result(spec_name)
+        if @check_command_verbose
+          "#{spec_name} newly added"
+        else
+          "+#{spec_name}"
+        end
+      end
+
+      def print_results(results)
+        return UI.puts "The Podfile's dependencies are satisfied" if results.empty?
+
+        if @check_command_verbose
+          UI.puts results.join("\n")
+        else
+          UI.puts results.join(', ')
+        end
+
+        raise Informative, "`pod install` will install #{results.length} Pod#{'s' if results.length > 1}."
+      end
+    end
+  end
+end

data/spec/check_spec.rb

@@ -0,0 +1,105 @@
+require 'cocoapods'
+require_relative '../lib/pod/command/check'
+
+describe Pod::Command::Check do
+  it 'detects no differences' do
+    check = Pod::Command::Check.new(CLAide::ARGV.new([]))
+
+    config = create_config({ :pod_one => '1.0', :pod_two => '2.0' }, { :pod_one => '1.0', :pod_two => '2.0' })
+
+    development_pods = {}
+    results = check.find_differences(config, development_pods)
+
+    expect(results).to eq([])
+  end
+
+  it 'detects modifications and additions' do
+    check = Pod::Command::Check.new(CLAide::ARGV.new([]))
+
+    config = create_config(
+        {
+            :pod_one => '1.0',
+            :pod_two => '3.0',
+            :pod_three => '2.0'
+        },
+        {
+            :pod_one => '1.0',
+            :pod_two => '2.0',
+            :pod_three => nil
+        }
+    )
+
+    development_pods = {}
+    results = check.find_differences(config, development_pods)
+
+    # Alphabetical order
+    expect(results).to eq([ '+pod_three', '~pod_two' ])
+  end
+
+  it 'detects modifications and additions with verbosity' do
+    check = Pod::Command::Check.new(CLAide::ARGV.new([ '--verbose' ]))
+
+    config = create_config(
+        {
+            :pod_one => '1.0',
+            :pod_two => '3.0',
+            :pod_three => '2.0'
+        },
+        {
+            :pod_one => '1.0',
+            :pod_two => '2.0',
+            :pod_three => nil
+        }
+    )
+
+    development_pods = {}
+    results = check.find_differences(config, development_pods)
+
+    # Alphabetical order
+    expect(results).to eq([ 'pod_three newly added', 'pod_two 2.0 -> 3.0' ])
+  end
+
+  it 'handles development pods' do
+    check = Pod::Command::Check.new(CLAide::ARGV.new([]))
+
+    config = create_config({ :pod_one => '1.0', :pod_two => nil }, { :pod_one => '1.0', :pod_two => nil })
+
+    development_pods = { :pod_two => 'source' }
+    results = check.find_differences(config, development_pods)
+
+    expect(results).to eq([ 'Δpod_two' ])
+  end
+
+  it 'handles development pods with verbosity' do
+    check = Pod::Command::Check.new(CLAide::ARGV.new([ '--verbose' ]))
+
+    config = create_config({ :pod_one => '1.0', :pod_two => nil }, { :pod_one => '1.0', :pod_two => nil })
+
+    development_pods = { :pod_two => 'source' }
+    results = check.find_differences(config, development_pods)
+
+    expect(results).to eq([ 'pod_two source' ])
+  end
+
+  def create_config(lockfile_hash, manifest_hash)
+    config = Pod::Config.new
+    lockfile = double('lockfile')
+    sandbox = double('sandbox')
+    manifest = double('manifest')
+
+    allow(config).to receive(:lockfile).and_return(lockfile)
+    allow(config).to receive(:sandbox).and_return(sandbox)
+    allow(sandbox).to receive(:manifest).and_return(manifest)
+
+    allow(lockfile).to receive(:pod_names).and_return(lockfile_hash.keys)
+    lockfile_hash.each do |key, value|
+      allow(lockfile).to receive(:version).with(key).and_return(value)
+    end
+
+    manifest_hash.each do |key, value|
+      allow(manifest).to receive(:version).with(key).and_return(value)
+    end
+
+    config
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: cocoapods-check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Di Iorio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.6
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: cocoapods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+description: "'check' plugin for CocoaPods"
+email:
+- doo@squareup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cocoapods-check.gemspec
+- lib/cocoapods_check.rb
+- lib/cocoapods_plugin.rb
+- lib/pod/command/check.rb
+- spec/check_spec.rb
+homepage: https://github.com/square/cocoapods-check
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: "'check' plugin for CocoaPods"
+test_files:
+- spec/check_spec.rb
+has_rdoc: