danger-spm_version_updates 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4b25309d2ebf835c0a6f0a13d22605cc95ef04aab3b73b48d2f780c273bec47
-  data.tar.gz: 0421f910cdbbba4b4b39912510a5272b898e2ecf0b420e7bb50211d3fc2c3f97
+  metadata.gz: 45434b8470d53708ee3261e6415b61eb6ca22dd4c3bd2080cbb0f28014c48276
+  data.tar.gz: c41a9d67f408fdaeaec72bdca65a8b0abefd998c0e852d9ce1f4c4ed76bda79c
 SHA512:
-  metadata.gz: 55238e841c8c1509667baf8dc4f44116eb4d3a792d24527bad0c00093daa69fc796155637489c986d4b5aecfa99a30122400cd98d3959b3678b747e3036b0270
-  data.tar.gz: 85af80394fffbb6ec7779b633022b8d6315defd422731e49827b135081620e5b004624ec5980fff6878ba11df0e2ee0e2378b02849f379c557fab519207e0cc5
+  metadata.gz: 949714767a85ebbf99c10aa1e8b424344a54a0cd3d8c7e1dcaae759b3f656a92f45b6df6adf9bf90468448f80636025ec659758c9309bf1a3c723f2c24ccfe18
+  data.tar.gz: 75e265f2a49a1efddae3c0272818ef67e2254739ce100bf3551306e670fe0e7e9fc5b608a49e91aa7b218bde1a92ae2d856ee87bd8e58276d4d01d53e18932ee

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-spm_version_updates (0.1.1)
+    danger-spm_version_updates (0.1.3)
       danger-plugin-api (~> 1.0)
       semantic (~> 1.6)
       xcodeproj (~> 1.24)

data/README.md

@@ -15,7 +15,9 @@ Note that version 0.1.0 is the last version to support Ruby 2.7
 
 ## Installation
 
-`gem install danger-spm_version_updates`
+```sh
+gem install danger-spm_version_updates
+```
 
 or add the following to your Gemfile:
 
@@ -43,7 +45,7 @@ spm_version_updates.report_above_maximum = true
 # Whether to report pre-release versions, default false
 spm_version_updates.report_pre_releases = true
 
-# A list of repositories to ignore entirely, must exactly match the URL as configured in the Xcode project
+# A list of repository URLs for packages to ignore entirely
 spm_version_updates.ignore_repos = ["https://github.com/pointfreeco/swift-snapshot-testing"]
 ```
 
@@ -63,7 +65,7 @@ spm_version_updates.ignore_repos = ["https://github.com/pointfreeco/swift-snapsh
 
 Swift and the Swift logo are trademarks of Apple Inc.
 
-Copyright (c) 2023 Harold Martin <harold.martin@gmail.com>
+Copyright (c) 2023 Harold Martin
 
 MIT License
 

data/danger-spm_version_updates.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
   spec.required_ruby_version = ">= 3.0"
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = Dir['lib/*'] + Dir['lib/**/*'] + Dir['*']
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   spec.metadata["rubygems_mfa_required"] = "true"

data/lib/spm_version_updates/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SpmVersionUpdates
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/spm_version_updates/git.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Git
+  # Removes protocol and trailing .git from a repo URL
+  # @param   [String] repo_url
+  #          The URL of the repository
+  # @return [String]
+  def self.trim_repo_url(repo_url)
+    repo_url.split("://").last.gsub(/\.git$/, "")
+  end
+
+  # Extract a readable name for the repo given the url, generally org/repo
+  # @return [String]
+  def self.repo_name(repo_url)
+    match = repo_url.match(%r{([\w-]+/[\w-]+)(.git)?$})
+
+    if match
+      match[1] || match[0]
+    else
+      repo_url
+    end
+  end
+
+  # Call git to list tags
+  # @param   [String] repo_url
+  #          The URL of the dependency's repository
+  # @return [Array<Semantic::Version>]
+  def self.version_tags(repo_url)
+    versions = `git ls-remote -t #{repo_url}`
+      .split("\n")
+      .map { |line| line.split("/tags/").last }
+      .filter_map { |line|
+        begin
+          Semantic::Version.new(line)
+        rescue ArgumentError
+          nil
+        end
+      }
+    versions.sort!
+    versions.reverse!
+    versions
+  end
+
+  # Call git to find the last commit on a branch
+  # @param   [String] repo_url
+  #          The URL of the dependency's repository
+  # @param   [String] branch_name
+  #          The name of the branch on which to find the last commit
+  # @return [String]
+  def self.branch_last_commit(repo_url, branch_name)
+    `git ls-remote -h #{repo_url}`
+      .split("\n")
+      .find { |line| line.split("\trefs/heads/")[1] == branch_name }
+      .split("\trefs/heads/")[0]
+  end
+end

data/lib/spm_version_updates/plugin.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
 require "semantic"
-require "xcodeproj"
+require_relative "git"
+require_relative "xcode"
 
 module Danger
-  # A plugin for checking if there are versions upgrades available for SPM packages
+  # A Danger plugin for checking if there are versions upgrades available for SPM dependencies
   #
   # @example Check if MyApp's SPM dependencies are up to date
-  #
   #          spm_version_updates.check_for_updates("MyApp.xcodeproj")
   #
-  # @see  Harold Martin/danger-spm_version_updates
+  # @see  hbmartin/danger-spm_version_updates
   # @tags swift, spm, swift package manager, xcode, xcodeproj, version, updates
   #
   class DangerSpmVersionUpdates < Plugin
@@ -26,35 +26,42 @@ module Danger
     # @return   [Boolean]
     attr_accessor :report_pre_releases
 
-    # A list of repositories to ignore entirely, must exactly match the URL as configured in the Xcode project
+    # A list of repository URLs for packages to ignore entirely
     # @return   [Array<String>]
     attr_accessor :ignore_repos
 
     # A method that you can call from your Dangerfile
     # @param   [String] xcodeproj_path
     #          The path to your Xcode project
+    # @raise [XcodeprojPathMustBeSet] if the xcodeproj_path is blank
     # @return   [void]
     def check_for_updates(xcodeproj_path)
-      remote_packages = get_remote_package(xcodeproj_path)
-      resolved_versions = get_resolved_versions(xcodeproj_path)
+      remote_packages = Xcode.get_packages(xcodeproj_path)
+      resolved_versions = Xcode.get_resolved_versions(xcodeproj_path)
+      $stderr.puts("Found resolved versions for #{resolved_versions.size} packages")
+
+      self.ignore_repos = self.ignore_repos&.map! { |repo| Git.trim_repo_url(repo) }
 
       remote_packages.each { |repository_url, requirement|
-        next if ignore_repos&.include?(repository_url)
+        next if self.ignore_repos&.include?(repository_url)
 
-        name = repo_name(repository_url)
+        name = Git.repo_name(repository_url)
         resolved_version = resolved_versions[repository_url]
         kind = requirement["kind"]
 
-        # kind can be major, minor, range, exact, branch, or commit
+        if resolved_version.nil?
+          $stderr.puts("Unable to locate the current version for #{name} (#{repository_url})")
+          next
+        end
 
         if kind == "branch"
           branch = requirement["branch"]
-          last_commit = git_branch_last_commit(repository_url, branch)
+          last_commit = Git.branch_last_commit(repository_url, branch)
           warn("Newer commit available for #{name} (#{branch}): #{last_commit}") unless last_commit == resolved_version
           next
         end
 
-        available_versions = git_versions(repository_url)
+        available_versions = Git.version_tags(repository_url)
         next if available_versions.first.to_s == resolved_version
 
         if kind == "exactVersion" && @check_when_exact
@@ -69,60 +76,6 @@ module Danger
       }
     end
 
-    # Extracts remote packages from an Xcode project
-    # @param   [String] xcodeproj_path
-    #          The path to your Xcode project
-    # @return [Hash<String, Hash>]
-    def get_remote_package(xcodeproj_path)
-      raise(XcodeprojPathMustBeSet) if xcodeproj_path.nil?
-
-      filter_remote_packages(Xcodeproj::Project.open(xcodeproj_path))
-    end
-
-    # Extracts resolved versions from Package.resolved relative to an Xcode project
-    # @param   [String] xcodeproj_path
-    #          The path to your Xcode project
-    # @return [Hash<String, String>]
-    def get_resolved_versions(xcodeproj_path)
-      resolved_path = find_packages_resolved_file(xcodeproj_path)
-      raise(CouldNotFindResolvedFile) unless File.exist?(resolved_path)
-
-      JSON.load_file!(resolved_path)["pins"]
-        .to_h { |pin| [pin["location"], pin["state"]["version"] || pin["state"]["revision"]] }
-    end
-
-    # Extract a readable name for the repo given the url, generally org/repo
-    # @return [String]
-    def repo_name(repo_url)
-      match = repo_url.match(%r{([\w-]+/[\w-]+)(.git)?$})
-
-      if match
-        match[1] || match[0]
-      else
-        repo_url
-      end
-    end
-
-    # Find the configured SPM dependencies in the xcodeproj
-    # @return [Hash<String, Hash>]
-    def filter_remote_packages(project)
-      project.objects.select { |obj|
-        obj.kind_of?(Xcodeproj::Project::Object::XCRemoteSwiftPackageReference) &&
-          obj.requirement["kind"] != "commit"
-      }
-        .to_h { |package| [package.repositoryURL, package.requirement] }
-    end
-
-    # Find the Packages.resolved file
-    # @return [String]
-    def find_packages_resolved_file(xcodeproj_path)
-      if Dir.exist?(xcodeproj_path.sub("xcodeproj", "xcworkspace"))
-        File.join(xcodeproj_path.sub("xcodeproj", "xcworkspace"), "xcshareddata", "swiftpm", "Package.resolved")
-      else
-        File.join(xcodeproj_path, "project.xcworkspace", "xcshareddata", "swiftpm", "Package.resolved")
-      end
-    end
-
     private
 
     def warn_for_new_versions_exact(available_versions, name, resolved_version)
@@ -171,36 +124,5 @@ Newest version of #{name}: #{available_versions.first} (but this package is conf
         TEXT
       ) unless newest_above_reqs == newest_meeting_reqs || newest_meeting_reqs.to_s == resolved_version
     end
-
-    # Remove git call to list tags
-    # @return [Array<Semantic::Version>]
-    def git_versions(repo_url)
-      versions = `git ls-remote -t #{repo_url}`
-        .split("\n")
-        .map { |line| line.split("/tags/").last }
-        .filter_map { |line|
-          begin
-            Semantic::Version.new(line)
-          rescue ArgumentError
-            nil
-          end
-        }
-      versions.sort!
-      versions.reverse!
-      versions
-    end
-
-    def git_branch_last_commit(repo_url, branch_name)
-      `git ls-remote -h #{repo_url}`
-        .split("\n")
-        .find { |line| line.split("\trefs/heads/")[1] == branch_name }
-        .split("\trefs/heads/")[0]
-    end
-  end
-
-  class XcodeprojPathMustBeSet < StandardError
-  end
-
-  class CouldNotFindResolvedFile < StandardError
   end
 end

data/lib/spm_version_updates/xcode.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "xcodeproj"
+
+module Xcode
+  # Find the configured SPM dependencies in the xcodeproj
+  # @param   [String] xcodeproj_path
+  #          The path of the Xcode project
+  # @return [Hash<String, Hash>]
+  def self.get_packages(xcodeproj_path)
+    raise(XcodeprojPathMustBeSet) if xcodeproj_path.nil? || xcodeproj_path.empty?
+
+    project = Xcodeproj::Project.open(xcodeproj_path)
+    project.objects.select { |obj|
+      obj.kind_of?(Xcodeproj::Project::Object::XCRemoteSwiftPackageReference) &&
+        obj.requirement["kind"] != "commit"
+    }
+      .to_h { |package|
+        [Git.trim_repo_url(package.repositoryURL), package.requirement]
+      }
+  end
+
+  # Extracts resolved versions from Package.resolved relative to an Xcode project
+  # @param   [String] xcodeproj_path
+  #          The path to your Xcode project
+  # @raise [CouldNotFindResolvedFile] if no Package.resolved files were found
+  # @return [Hash<String, String>]
+  def self.get_resolved_versions(xcodeproj_path)
+    resolved_paths = find_packages_resolved_file(xcodeproj_path)
+    raise(CouldNotFindResolvedFile) if resolved_paths.empty?
+
+    resolved_versions = resolved_paths.map { |resolved_path|
+      JSON.load_file!(resolved_path)["pins"]
+        .to_h { |pin|
+          [Git.trim_repo_url(pin["location"]), pin["state"]["version"] || pin["state"]["revision"]]
+        }
+    }
+    resolved_versions.reduce(:merge!)
+  end
+
+  # Find the Packages.resolved file
+  # @return [Array<String>]
+  def self.find_packages_resolved_file(xcodeproj_path)
+    locations = []
+    # First check the workspace for a resolved file
+    workspace = xcodeproj_path.sub("xcodeproj", "xcworkspace")
+    if Dir.exist?(workspace)
+      path = File.join(workspace, "xcshareddata", "swiftpm", "Package.resolved")
+      locations << path if File.exist?(path)
+    end
+
+    # Then check the project for a resolved file
+    path = File.join(xcodeproj_path, "project.xcworkspace", "xcshareddata", "swiftpm", "Package.resolved")
+    locations << path if File.exist?(path)
+
+    $stderr.puts("Searching for resolved packages in: #{locations}")
+    locations
+  end
+
+  private_class_method :find_packages_resolved_file
+
+  class XcodeprojPathMustBeSet < StandardError
+  end
+
+  class CouldNotFindResolvedFile < StandardError
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-spm_version_updates
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Harold Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-15 00:00:00.000000000 Z
+date: 2024-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -284,20 +284,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".github/workflows/docs.yml"
-- ".github/workflows/lint_and_test.yml"
-- ".github/workflows/push_gem.yml"
-- ".github/workflows/readme.yml"
-- ".gitignore"
-- ".idea/.gitignore"
-- ".idea/danger-plugin-spm-version-updates.iml"
-- ".idea/misc.xml"
-- ".idea/modules.xml"
-- ".idea/vcs.xml"
-- ".markdownlint.jsonc"
-- ".reek.yml"
-- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -309,18 +295,9 @@ files:
 - lib/danger_plugin.rb
 - lib/danger_spm_version_updates.rb
 - lib/spm_version_updates/gem_version.rb
+- lib/spm_version_updates/git.rb
 - lib/spm_version_updates/plugin.rb
-- spec/spec_helper.rb
-- spec/spm_version_updates_spec.rb
-- spec/support/fixtures/Branch.xcodeproj/project.pbxproj
-- spec/support/fixtures/Branch.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
-- spec/support/fixtures/ExactVersion.xcodeproj/project.pbxproj
-- spec/support/fixtures/ExactVersion.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
-- spec/support/fixtures/UpToNextMajor.xcodeproj/project.pbxproj
-- spec/support/fixtures/UpToNextMajor.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
-- spec/support/fixtures/VersionRange.xcodeproj/project.pbxproj
-- spec/support/fixtures/VersionRange.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
-- spec/support/fixtures/github_pr.json
+- lib/spm_version_updates/xcode.rb
 homepage: https://github.com/hbmartin/danger-spm_version_updates
 licenses:
 - MIT

data/.editorconfig

@@ -1,15 +0,0 @@
-root = true
-
-[*]
-end_of_line = lf
-insert_final_newline = true
-charset = utf-8
-trim_trailing_whitespace = true
-
-[*.{rb,yml,gemspec}]
-indent_style = space
-indent_size = 2
-
-[Dangerfile, Rakefile, Guardfile, Gemfile]
-indent_style = space
-indent_size = 2

data/.github/workflows/docs.yml

@@ -1,43 +0,0 @@
-name: Publish Yard HTML to GitHub Pages
-
-on:
-  push:
-    tags:
-      - "*"
-  workflow_dispatch:
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 3.2
-          bundler-cache: true
-      - name: Build HTML docs
-        run: bundle exec yard
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v2
-        with:
-          path: ./doc
-  deploy:
-    needs: build
-
-    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
-    permissions:
-      pages: write # to deploy to Pages
-      id-token: write # to verify the deployment originates from an appropriate source
-
-    # Deploy to the github-pages environment
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-
-    # Specify runner + deployment step
-    runs-on: ubuntu-latest
-    steps:
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v2 # or the latest "vX.X.X" version tag for this action

data/.github/workflows/lint_and_test.yml

@@ -1,32 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-
-jobs:
-  build:
-    strategy:
-      matrix:
-        ruby-version:
-          - "3.0"
-          - "3.1"
-          - "3.2"
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby-version }}
-          bundler-cache: true
-      - name: Running Tests
-        run: bundle exec rake spec
-      - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v4
-        with:
-          fail_ci_if_error: true
-        env:
-          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

data/.github/workflows/push_gem.yml

@@ -1,26 +0,0 @@
-name: Push Gem
-
-on:
-  push:
-    tags:
-      - v*
-
-jobs:
-  push:
-    runs-on: ubuntu-latest
-
-    permissions:
-      contents: write
-      id-token: write
-
-    steps:
-      # Set up
-      - uses: actions/checkout@v4
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-          ruby-version: ruby
-
-      # Release
-      - uses: rubygems/release-gem@v1

data/.github/workflows/readme.yml

@@ -1,21 +0,0 @@
-name: Readme formatting and typo checking
-
-on:
-  push:
-    branches: ["main"]
-  pull_request:
-    branches: ["main"]
-
-jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out repository code
-        uses: actions/checkout@v4
-      - name: Markdown Lint
-        uses: avto-dev/markdown-lint@v1.5.0
-        with:
-          args: "./README.md"
-          config: "./.markdownlint.jsonc"
-      - name: Typos
-        uses: crate-ci/typos@v1.19.0