cocoapods-dependencies-list 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0067dbe2db9cd3947c5f9a9af3d77aec99d2dfc8e4fa6cec126b4b8cec514a0a
+  data.tar.gz: 708f745b4f0be3f30387d59e0b4d3c40aaaebff35c8826723b9e898564c2f268
+SHA512:
+  metadata.gz: 0d84e6cbb823f7d5202ec9125df308308edafbc50a000e271aff42240dae96e28c55787a8f0cb015f4d6b998504a9debf759f828acde315240a9642b5f4dca48
+  data.tar.gz: abb9968b5e36aa88b9c3b0948f91f81e92db16bbe4e408b197846e9d17073b094b611cec65699d4881444b13b9b2f01c7ce9408aa0a08c8144ccad57e69b2c44

data/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  Exclude:
+    - test/fixtures/**/*
+    - vendor/**/*
+
+inherit_gem:
+  rubocop-github:
+    - config/default.yml
+
+Style/HashSyntax:
+  EnforcedShorthandSyntax: either

data/.ruby-version

@@ -0,0 +1 @@
+3.1.3

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cocoapods-dependencies-list.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,146 @@
+PATH
+  remote: .
+  specs:
+    cocoapods-dependencies-list (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    CFPropertyList (3.0.6)
+      rexml
+    activesupport (7.0.4.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    algoliasearch (1.27.5)
+      httpclient (~> 2.8, >= 2.8.3)
+      json (>= 1.5.1)
+    ast (2.4.2)
+    atomos (0.1.3)
+    claide (1.1.0)
+    cocoapods (1.12.0)
+      addressable (~> 2.8)
+      claide (>= 1.0.2, < 2.0)
+      cocoapods-core (= 1.12.0)
+      cocoapods-deintegrate (>= 1.0.3, < 2.0)
+      cocoapods-downloader (>= 1.6.0, < 2.0)
+      cocoapods-plugins (>= 1.0.0, < 2.0)
+      cocoapods-search (>= 1.0.0, < 2.0)
+      cocoapods-trunk (>= 1.6.0, < 2.0)
+      cocoapods-try (>= 1.1.0, < 2.0)
+      colored2 (~> 3.1)
+      escape (~> 0.0.4)
+      fourflusher (>= 2.3.0, < 3.0)
+      gh_inspector (~> 1.0)
+      molinillo (~> 0.8.0)
+      nap (~> 1.0)
+      ruby-macho (>= 2.3.0, < 3.0)
+      xcodeproj (>= 1.21.0, < 2.0)
+    cocoapods-core (1.12.0)
+      activesupport (>= 5.0, < 8)
+      addressable (~> 2.8)
+      algoliasearch (~> 1.0)
+      concurrent-ruby (~> 1.1)
+      fuzzy_match (~> 2.0.4)
+      nap (~> 1.0)
+      netrc (~> 0.11)
+      public_suffix (~> 4.0)
+      typhoeus (~> 1.0)
+    cocoapods-deintegrate (1.0.5)
+    cocoapods-downloader (1.6.3)
+    cocoapods-plugins (1.0.0)
+      nap
+    cocoapods-search (1.0.1)
+    cocoapods-trunk (1.6.0)
+      nap (>= 0.8, < 2.0)
+      netrc (~> 0.11)
+    cocoapods-try (1.2.0)
+    colored2 (3.1.2)
+    concurrent-ruby (1.2.2)
+    debug (1.7.1)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    escape (0.0.4)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.5)
+    fourflusher (2.3.1)
+    fuzzy_match (2.0.4)
+    gh_inspector (1.1.3)
+    httpclient (2.8.3)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    io-console (0.6.0)
+    irb (1.6.3)
+      reline (>= 0.3.0)
+    json (2.6.3)
+    minitest (5.18.0)
+    molinillo (0.8.0)
+    nanaimo (0.3.0)
+    nap (1.1.0)
+    netrc (0.11.0)
+    parallel (1.22.1)
+    parser (3.2.1.1)
+      ast (~> 2.4.1)
+    public_suffix (4.0.7)
+    rack (3.0.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    reline (0.3.2)
+      io-console (~> 0.5)
+    rexml (3.2.5)
+    rubocop (1.48.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    rubocop-github (0.20.0)
+      rubocop (>= 1.37)
+      rubocop-performance (>= 1.15)
+      rubocop-rails (>= 2.17)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.18.0)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+    ruby-macho (2.5.1)
+    ruby-progressbar (1.13.0)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    xcodeproj (1.22.0)
+      CFPropertyList (>= 2.3.3, < 4.0)
+      atomos (~> 0.1.3)
+      claide (>= 1.0.2, < 2.0)
+      colored2 (~> 3.1)
+      nanaimo (~> 0.3.0)
+      rexml (~> 3.2.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cocoapods (~> 1.0)
+  cocoapods-dependencies-list!
+  debug
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop-github (~> 0.20)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Jon Ruskin
+
+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,69 @@
+# Cocoapods plugin to list dependencies with metadata
+
+The cocoapods-dependencies-list enumerates dependencies from the current directory's `Podfile` and `Podfile.lock`, outputting metadata for all dependencies to the console.
+
+This plugin was built primarily to support enumerating dependencies for [github/licensed](https://github.com/github/licensed).  Dependencies are output in JSON format to make parsing and reading data easier for non-human callers.
+
+Dependencies are output as a JSON map of Podfile targets to an array of dependencies for that target.
+
+## Options
+
+1. `--targets=<comma delimited list of Podfile targets>`'
+   - Default: none
+   - Description: The `targets` option is used to filter enumerated dependencies to only the specified targets.
+1. `--fields=<comma delimited list of specification fields>`
+   - Default: `"name,version,summary,homepage,license"`
+   - Description: The `fields` option specifies which specification fields should be included in the JSON output.
+1. `--include-path`, `--no-include-path`
+   - Default: `--no-include-path`
+   - Description: Whether to include the path to the dependency in the installation sandbox in the JSON output.
+
+## Example
+
+```bash
+➜  cocoapods-dependencies-list ✗ (cd test/fixtures && bundle exec pod dependencies | jq)
+{
+  "Pods": [],
+  "Pods-ios": [
+    {
+      "name": "Alamofire",
+      "version": "5.4.3",
+      "summary": "Elegant HTTP Networking in Swift",
+      "homepage": "https://github.com/Alamofire/Alamofire",
+      "license": {
+        "type": "MIT"
+      }
+    },
+    {
+      "name": "Chatto",
+      "version": "4.1.0",
+      "summary": "Chat framework in Swift",
+      "homepage": "https://github.com/badoo/Chatto",
+      "license": {
+        "type": "MIT"
+      }
+    },
+    ...
+  ],
+  "Pods-iosTests": [
+    {
+      "name": "lottie-ios",
+      "version": "3.3.0",
+      "summary": "A library to render native animations from bodymovin json",
+      "homepage": "https://github.com/airbnb/lottie-ios",
+      "license": {
+        "type": "Apache",
+        "file": "LICENSE"
+      }
+    }
+  ]
+}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org/) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  # TODO: currently cocoapods-core, nanaimo and addressable emit many
+  # "warning: character class has duplicated range" warnings.
+  # silence them with the `-W0` ruby CLI option until dependent gems are
+  # updated to no longer emit these warnings
+  t.ruby_opts = %w{-W0}
+
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/cocoapods_dependencies_list/pod/command/dependencies.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "cocoapods"
+
+module Pod
+  class Command
+    # A cocoapods plugin command `pod project dependencies` that outputs project dependency metadata
+    class Dependencies < Command
+      include Pod::Command::Options::ProjectDirectory
+
+      DEFAULT_FIELDS = %w{name version summary homepage license}
+
+      self.summary = "List cocoapod project dependencies with metadata."
+
+      self.description = <<-DESC
+        List cocoapod project dependencies with metadata.
+      DESC
+
+      def self.options
+        [
+          ["--targets", "A comma-delimited list of podfile targets"],
+          ["--fields", "A comma-delimited list of podspec fields to include"],
+          ["--include-path", "Include the pod installation path in the installation sandbox"]
+        ].concat(super)
+      end
+
+      attr_reader :targets, :fields, :include_path
+      alias :include_path? :include_path
+
+      def initialize(argv)
+        @targets = argv.option("targets", "").split(",").map(&:strip)
+        @fields = argv.option("fields", "").split(",").map(&:strip)
+        @fields = DEFAULT_FIELDS if !@fields.any?
+        @include_path = argv.flag?("include-path", false)
+
+        super
+      end
+
+      def run
+        verify_podfile_exists!
+
+        require "json"
+        UI.puts specs_by_target.to_json
+      end
+
+      def specs_by_target
+        analyzer = Installer::Analyzer.new(config.sandbox, config.podfile, config.lockfile)
+        specs_by_target = config.with_changes(silent: true) { analyzer.analyze(false).specs_by_target }
+
+        if @targets.any?
+          specs_by_target = specs_by_target.select { |target, _| @targets.include? target.label }
+        end
+
+        specs_by_target.each do |target, specs|
+          specs.map! do |spec|
+            fields = requested_fields_from_spec(spec)
+            fields[:path] = config.sandbox.pod_dir(spec.name).to_s if include_path?
+
+            fields
+          end
+        end
+      end
+
+      def requested_fields_from_spec(spec)
+        @fields.reduce({}) do |accum, field|
+          field = field.to_sym
+          accum[field] = spec.respond_to?(field) ? spec.send(field) : nil
+          accum
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods_dependencies_list/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CocoapodsDependenciesList
+  VERSION = "1.0.0".freeze
+end

data/lib/cocoapods_dependencies_list.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "cocoapods_dependencies_list/version"
+require "cocoapods_dependencies_list/pod/command/dependencies"

data/lib/cocoapods_plugin.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "cocoapods_dependencies_list/pod/command/dependencies"

data/test/cocoapods_dependencies_list/pod/command/dependencies_test.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "json"
+
+class Pod::Command::DependenciesTest < Minitest::Test
+  def run_plugin(raw: false, options: [])
+    io = StringIO.new
+    Pod::UI.output_io = io
+
+    argv = CLAide::ARGV.new(["--project-directory=#{FIXTURES_DIRECTORY}", *options])
+    command = Pod::Command::Dependencies.new(argv)
+    command.run
+
+    io.pos = 0
+    result = io.read
+    raw ? result : JSON.parse(result)
+  ensure
+    io.close
+  end
+
+  def test_it_prints_content_as_json_string_to_the_ui
+    content = run_plugin(raw: true)
+    assert content.is_a?(String)
+
+    assert JSON.parse(content).any?
+  end
+
+  def test_it_lists_dependencies_by_target_with_default_fields
+    dependencies_by_target = run_plugin
+    assert dependencies_by_target
+
+    pods_ios_dependencies = dependencies_by_target["Pods-ios"]
+    assert pods_ios_dependencies
+
+    dependency = pods_ios_dependencies.find { |dep| dep["name"] == "Alamofire" }
+    assert dependency
+
+    assert_equal Pod::Command::Dependencies::DEFAULT_FIELDS.length, dependency.keys.length
+    Pod::Command::Dependencies::DEFAULT_FIELDS.each do |field|
+      assert dependency.has_key?(field)
+    end
+  end
+
+  def test_it_filters_targets_with_targets_option
+    dependencies_by_target = run_plugin(options: ["--targets=Pods,Pods-iosTests"])
+
+    assert dependencies_by_target.has_key?("Pods")
+    assert dependencies_by_target.has_key?("Pods-iosTests")
+    refute dependencies_by_target.has_key?("Pods-ios")
+  end
+
+  def test_it_filters_targets_with_fields_option
+    dependencies_by_target = run_plugin(options: ["--fields=name,version"])
+
+    pods_ios_dependencies = dependencies_by_target["Pods-ios"]
+    assert pods_ios_dependencies
+
+    dependency = pods_ios_dependencies.find { |dep| dep["name"] == "Alamofire" }
+    assert dependency
+
+    assert_equal 2, dependency.keys.length
+    assert dependency.has_key?("name")
+    assert dependency.has_key?("version")
+  end
+
+  def test_it_includes_pod_installation_paths_with_include_path_option
+    dependencies_by_target = run_plugin(options: ["--include-path"])
+
+    pods_ios_dependencies = dependencies_by_target["Pods-ios"]
+    assert pods_ios_dependencies
+
+    dependency = pods_ios_dependencies.find { |dep| dep["name"] == "Alamofire" }
+    assert dependency
+    assert dependency.has_key?("path")
+  end
+end

data/test/cocoapods_dependencies_list/version_test.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class CocoapodsDependenciesList::VersionTest < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::CocoapodsDependenciesList::VERSION
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: cocoapods-dependencies-list
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jon Ruskin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cocoapods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.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: rubocop-github
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+description: 
+email:
+- jon.ruskin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/cocoapods_dependencies_list.rb
+- lib/cocoapods_dependencies_list/pod/command/dependencies.rb
+- lib/cocoapods_dependencies_list/version.rb
+- lib/cocoapods_plugin.rb
+- test/cocoapods_dependencies_list/pod/command/dependencies_test.rb
+- test/cocoapods_dependencies_list/version_test.rb
+homepage: https://github.com/jonabc/cocoapods-dependencies-list
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jonabc/cocoapods-dependencies-list
+  source_code_uri: https://github.com/jonabc/cocoapods-dependencies-list
+  changelog_uri: https://github.com/jonabc/cocoapods-dependencies-list/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: List dependencies from cocoapods in an easily parseable format.
+test_files:
+- test/cocoapods_dependencies_list/pod/command/dependencies_test.rb
+- test/cocoapods_dependencies_list/version_test.rb