cocoapods-query 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5cf435960d7f5044287ffe40bc613093c945705422f45fce97d7cb6446ce383b
+  data.tar.gz: 3cc5a61cfddc810a37b3012f7d6819593e470e748cf065969e064ea632302c02
+SHA512:
+  metadata.gz: fc8ea8af042c3d10a528f6b131a9a2e3b97d0ecc9c5451ca97a2201367fed67cec9d81aaea8553b3111c8620d8606ea0089761b88dd95b9c29172cc6e66879cb
+  data.tar.gz: 8e2c7399ef648826034856cdeb660228d2a9fb0231147d0e55f3aac17d472683a4b81d97b1d5dbfdc149cc2bda5751eb9b7a3060c22107dec03c4fafc40e55ce

data/CONTRIBUTING.md

@@ -0,0 +1,16 @@
+Contributing
+============
+
+If you would like to contribute code to cocoapods-query you can do so through GitHub by
+forking the repository and sending a pull request.
+
+When submitting code, please make every effort to follow existing conventions
+and style in order to keep the code as readable as possible. Please also make
+sure your code has tests.
+
+Before your code can be accepted into the project you must also sign the
+[Individual Contributor License Agreement (CLA)][1].
+
+
+ [1]: https://spreadsheets.google.com/spreadsheet/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1
+ 

data/README.md

@@ -0,0 +1,73 @@
+# Introduction
+
+This plugin for CocoaPods helps locate pods in a project. It can show all pods or filter them based on some search term, such as author name, source file, dependency, and more. It is intended for projects with a large number of dependencies.
+
+The plugin's output can be saved to YAML format for easy parsing by other tools (e.g. a CocoaPods GUI).
+
+# Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cocoapods-query'
+
+And then run:
+
+    $ bundle
+
+Or, install it system-wide with:
+
+    $ gem build cocoapods-query.gemspec
+	$ gem install cocoapods-query-1.0.0.gem
+
+Or, in a single command:
+
+    $ bundle exec rake install
+
+# Usage
+
+The plugin adds a `query` command to CocoaPods. You can get help on its parameters with:
+
+    $ pod query --help
+
+By default, the command lists all pods in the sandbox. This list can be filtered by one of several search terms. Here are some examples:
+
+What pods contain the string "testing" in their name?
+
+    $ pod query --name testing --substring --case-insensitive
+
+What pods have a direct dependency on Foo?
+
+    $ pod query --dependency Foo
+
+What pods were created by hacker@example.com?
+
+    $ pod query --author-email hacker@example.com
+
+What pods contain a source file named `HelloWorld.swift`?
+
+    $ pod query --source-file HelloWorld.swift --substring
+
+# Caching
+
+Finding pods in the CocoaPods project can take a long time when there are many dependencies. To speed things up, the `query` command accepts a `--cache` parameter, which is used to specify a YAML file containing previous output from the `--to-yaml` parameter. When the plugin sees the `--cache` parameter, it will use the data in this file instead of rebuiding the data from the current CocoaPods instance.
+
+# Related Work
+
+This plugin provides features that are similar to, and in some cases overlapping with, existing CocoaPods plugins.
+
+* [list](https://guides.cocoapods.org/terminal/commands.html#pod_list), [search](https://github.com/CocoaPods/cocoapods-search), and [spec cat/which](https://guides.cocoapods.org/terminal/commands.html#pod_spec_cat): These commands look at all available pods, not just those in the sandbox, and they ignore local pods. The `search` command applies to all fields and cannot match a particular field.
+* [cache list](https://guides.cocoapods.org/terminal/commands.html#pod_cache_list): Similar to `query --to-yaml` but does not provide filtering and outputs a limited set of data.
+* [info](https://github.com/cocoapods/cocoapods-podfile_info): Similar to `query --to-yaml` but is old, unmaintained, and limited in options.
+* [search sort](https://github.com/DenTelezhkin/cocoapods-sorted-search): Similar to `list` or `search` but allows sorting by stars, forks, or activity.
+
+# Development
+
+For local development of this plugin, the simplest approach is to install it into an existing app via absolute path. For example, if the code is in a directory called `projects/cocoapods-query` off the home directory, add the following line to the app's Gemfile:
+
+    gem 'cocoapods-query', path: "#{ENV['HOME']}/projects/cocoapods-query"
+
+You can then make changes to the code and they will be executed when using the `query` command from the app's directory.
+
+# Copyright
+
+Copyright 2020 Square, Inc.

data/lib/cocoapods_plugin.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'pod/command/query'

data/lib/cocoapods_query.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CocoaPodsQuery
+  VERSION = '1.0.0'
+end

data/lib/pod/command/query.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require 'cocoapods'
+require 'json'
+require 'yaml'
+
+module Pod
+  class Command
+    class Query < Command
+      self.summary = 'Shows pods in the project filtered by name or other attribute'
+      self.description = <<-DESC
+        This command starts by finding all pods in the project, then filters out those that do not match
+        the specified criteria, and finally returns the results. In other words, the output is all pods
+        that satisfy the intersection of all search terms. (It returns all pods in the project if no
+        parameters are given.)
+
+        The starting list of pods comes either from the current instance or from a previously created cache
+        in YAML format (if --from-yaml is given). The output is either a list of pod names or a file containing
+        pod data in YAML format (if --to-yaml is given).
+
+        You can modify how the search terms are handled by specifying the optional --case-insensitive or
+        --substring flags. They apply to all search terms.
+      DESC
+
+      def self.options
+        [
+          ['--name=NAME', 'Include pods whose name matches the given string'],
+          ['--version=VERSION', 'Include pods whose version matches the given string'],
+          ['--author-email=EMAIL', 'Include pods having at least one author with the given email'],
+          ['--author-name=NAME', 'Include pods having at least one author of the given name'],
+          ['--summary=SUMMARY', 'Include pods whose summary matches the given string'],
+          ['--description=DESCRIPTION', 'Include pods whose description matches the given string'],
+          ['--source-file=FILE', 'Include pods whose source list includes the given file name'],
+          ['--swift', 'Only include pods that use Swift (--no-swift for only pods that do not)'],
+          ['--local', 'Only include locally sourced pods (--no-local for only remote pods)'],
+          ['--case-insensitive', 'Don\'t consider case when matching strings'],
+          ['--substring', 'Allow substring matching for string parameters'],
+          ['--to-yaml=FILE', 'Output the results in YAML format with additional Podspec data (authors, source files, dependencies, etc.) to the given file'],
+          ['--to-json=FILE', 'Output the results in JSON format with additional Podspec data (authors, source files, dependencies, etc.) to the given file'],
+          ['--cache=FILE', 'Load the sandbox data from the given YAML file (created previously with the --to-yaml parameter) instead of from the current sandbox instance']
+        ].concat(super)
+      end
+
+      def initialize(argv)
+        super
+        @name = argv.option('name')
+        @version = argv.option('version')
+        @author_email = argv.option('author-email')
+        @author_name = argv.option('author-name')
+        @summary = argv.option('summary')
+        @description = argv.option('description')
+        @source_file = argv.option('source-file')
+        @swift = argv.flag?('swift')
+        @local = argv.flag?('local')
+        @case_insensitive = argv.flag?('case-insensitive', false)
+        @substring = argv.flag?('substring', false)
+        @to_yaml = argv.option('to-yaml')
+        @to_json = argv.option('to-json')
+        @cache = argv.option('cache')
+      end
+
+      def run
+        UI.puts 'Loading targets...'
+
+        matching_targets = all_targets(@cache).select do |target|
+          (@name.nil? || str_match(@name, target[:name])) &&
+            (@version.nil? || str_match(@version, target[:version])) &&
+            (@author_name.nil? || target[:authors].any? { |author| !author[:name].nil? && str_match(@author_name, author[:name]) }) &&
+            (@author_email.nil? || target[:authors].any? { |author| !author[:email].nil? && str_match(@author_email, author[:email]) }) &&
+            (@summary.nil? || str_match(@summary, target[:summary])) &&
+            (@description.nil? || str_match(@description, target[:description])) &&
+            (@source_file.nil? || target[:source_files].nil? || target[:source_files].any? { |s| str_match(@source_file, s) }) &&
+            (@swift.nil? || @swift == target[:uses_swift]) &&
+            (@local.nil? || @local == target[:local])
+        end
+
+        File.open(@to_yaml, 'w') { |file| file.write(matching_targets.to_yaml) } if @to_yaml
+        File.open(@to_json, 'w') { |file| file.write(matching_targets.to_json) } if @to_json
+
+        matching_targets.each { |target| UI.puts target[:name] }
+      end
+
+      private
+
+      # Returns an array of all pods in the sandbox. Each element in the array is a hash with
+      # metadata about the pod such as version, authors, source files, dependencies, and more.
+      #
+      # @note For projects with a large dependency graph, this function can take a long time to
+      #       run if a cache is not given.
+      #
+      # @param [String] target_cache
+      #        If non-nil, the targets are loaded from this file instead of from the current
+      #        sandbox instance. The file should contain the YAML-encoded results of a previous
+      #        call to this function.
+      #
+      # @return [Array<Hash>] an array of hashes containing pod metadata
+      def all_targets(target_cache)
+        return YAML.safe_load(File.read(target_cache), permitted_classes: [Symbol]) unless target_cache.nil?
+
+        targets = Pod::Config.instance.with_changes(silent: true) do
+          Pod::Installer.targets_from_sandbox(
+            Pod::Config.instance.sandbox,
+            Pod::Config.instance.podfile,
+            Pod::Config.instance.lockfile
+          ).flat_map(&:pod_targets).uniq
+        end
+
+        targets.map do |target|
+          file = target.sandbox.local_podspec(target.pod_name)
+          swift_versions = target.root_spec.swift_versions
+          file_accessor = target.file_accessors.find { |accessor| accessor.spec.root == target.root_spec }
+          dependencies = target.root_spec.dependencies.map(&:name)
+
+          {
+            name: target.name,
+            version: target.version,
+            authors: target.root_spec.authors.map { |name, email| { name: name, email: email }.compact },
+            is_local: target.sandbox.local?(target.name),
+            root_directory: file_accessor.root.to_s,
+            podspec_file: file ? file.relative_path_from(file_accessor.root).to_s : nil,
+            license: target.root_spec.license,
+            summary: target.root_spec.summary,
+            description: target.root_spec.description,
+            homepage: target.root_spec.homepage,
+            uses_swift: target.uses_swift?,
+            swift_versions: swift_versions.empty? ? nil : swift_versions.map(&:to_s),
+            readme_file: file_accessor.readme.to_s.empty? ? nil : file_accessor.readme.relative_path_from(file_accessor.root).to_s,
+            platforms: target.root_spec.available_platforms.map { |platform| { name: platform.symbolic_name, version: platform.deployment_target.to_s } },
+            dependencies: dependencies.empty? ? nil : dependencies,
+            source_files: file_accessor.source_files.map { |pathname| pathname.relative_path_from(file_accessor.root).to_s }
+          }.compact
+        end
+      end
+
+      def str_match(str1, str2)
+        if @case_insensitive
+          str1 = str1.downcase
+          str2 = str2.downcase
+        end
+
+        @substring ? str2.include?(str1) : str1 == str2
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: cocoapods-query
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Trevor Harmon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: cocoapods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: This plugin for CocoaPods helps locate pods in a project. It can show
+  all pods or filter them based on some search term, such as author name, source file,
+  dependency, and more. It is intended for projects with a large number of dependencies.
+email:
+- trevorh@squareup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CONTRIBUTING.md
+- README.md
+- lib/cocoapods_plugin.rb
+- lib/cocoapods_query.rb
+- lib/pod/command/query.rb
+homepage: https://github.com/square/cocoapods-query
+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.4
+signing_key: 
+specification_version: 4
+summary: CocoaPods plugin to search for pods
+test_files: []