danger-spm_version_updates 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 067f3b06cb1a331d6f12dca4e9f8be0b02f8a4888547aa6b235b8f1b87f26197
-  data.tar.gz: 07ab0f2b6b729fe4e2bb7b3956ed67ee63ba2c59f4db9f435b3e0237a47fdeb0
+  metadata.gz: e09f13ea3447749c8a464e7583af7df15daa485a2fd4859642686dfa099d6686
+  data.tar.gz: 29cdfaae73b66e0288cd94c84b14d674f9ab2d1f6c3fd30431f31ad49b1d4fdc
 SHA512:
-  metadata.gz: 164e7eb99a8fc9f1ba227be7683236995047adb066c4e21da3c70827917d800ab84d6508001a0d06e995610e12760e73930626638cce019dfd19a2ea92ed676a
-  data.tar.gz: 043e6a93d677bdc70e94563594f6703feeca2f9790823f1a63327100e99ca20c19dc5e111a0d7545658bfc626086d61cf8c66c446f58d4bd950ef9b1c5e7b963
+  metadata.gz: 885f9f92765ee4dad799321b3251cf8e8961196470b3e934d6ca25067cad96356759d88b845f1ccd2adde92008cc80239e57caa5d0f4833fefe1f6f49a0c9deb
+  data.tar.gz: 124352559472f974630fb4a28d3fa436b7f30360a23cc21864c20939b47718047bffd08190e61676c429ee567306089c5e0c6c7dc69b451ea42185b486db7541

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    danger-spm_version_updates (0.0.1)
+    danger-spm_version_updates (0.0.3)
       danger-plugin-api (~> 1.0)
       semantic (~> 1.6)
+      xcodeproj (~> 1.23)
 
 GEM
   remote: https://rubygems.org/

data/danger-spm_version_updates.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "A Danger plugin to detect if there are any updates to your Swift Package Manager dependencies."
   spec.homepage      = "https://github.com/hbmartin/danger-spm_version_updates"
   spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.7"
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -21,6 +22,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency("danger-plugin-api", "~> 1.0")
   spec.add_runtime_dependency("semantic", "~> 1.6")
+  spec.add_runtime_dependency("xcodeproj", "~> 1.23")
 
   # General ruby development
   spec.add_development_dependency("bundler", "~> 2.0")

data/lib/spm_version_updates/gem_version.rb

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

data/lib/spm_version_updates/plugin.rb

@@ -4,46 +4,50 @@ require "semantic"
 require "xcodeproj"
 
 module Danger
+  # A plugin for checking if there are versions upgrades available for SPM packages
+  #
   # @example Ensure people are well warned about merging on Mondays
   #
-  #          my_plugin.warn_on_mondays
+  #          spm_version_updates.check_for_updates("MyApp.xcodeproj")
   #
   # @see  Harold Martin/danger-spm_version_updates
   # @tags swift, spm, swift package manager, xcode, xcodeproj, version, updates
   #
   class DangerSpmVersionUpdates < Plugin
-    # The path to the xcodeproj file
-    # @return   [String]
-    attr_accessor :xcodeproj_path
-
     # Whether to check when dependencies are exact versions or commits, default false
     # @return   [Boolean]
     attr_accessor :check_when_exact
 
-    # Whether to ignore version above the maximum version range, default true
+    # Whether to ignore versions above the maximum version range, default true
     # @return   [Boolean]
     attr_accessor :quiet_above_maximum
 
+    # Whether to report pre-release versions, default false
+    # @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
     # @return   [Array<String>]
     attr_accessor :ignore_repos
 
     # A method that you can call from your Dangerfile
-    # @return   [Array<String>]
-    def check_for_updates
+    # @param   [String] xcodeproj_path
+    #          The path to your Xcode project
+    # @return   [void]
+    def check_for_updates(xcodeproj_path)
       raise(XcodeprojPathMustBeSet) if xcodeproj_path.nil?
 
       project = Xcodeproj::Project.open(xcodeproj_path)
       remote_packages = filter_remote_packages(project)
 
-      resolved_path = find_packages_resolved
+      resolved_path = find_packages_resolved(xcodeproj_path)
       raise(CouldNotFindResolvedFile) unless File.exist?(resolved_path)
 
       resolved_versions = JSON.load_file!(resolved_path)["pins"]
         .to_h { |pin| [pin["location"], pin["state"]["version"] || pin["state"]["revision"]] }
 
       remote_packages.each { |repository_url, requirement|
-        next if ignore_repos != nil && ignore_repos.include?(repository_url)
+        next if ignore_repos&.include?(repository_url)
 
         name = repo_name(repository_url)
         resolved_version = resolved_versions[repository_url]
@@ -76,6 +80,8 @@ Newer version of #{name}: #{available_versions.first} (but this package is set t
       }
     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)?$})
 
@@ -86,6 +92,8 @@ Newer version of #{name}: #{available_versions.first} (but this package is set t
       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) &&
@@ -94,7 +102,9 @@ Newer version of #{name}: #{available_versions.first} (but this package is set t
         .to_h { |package| [package.repositoryURL, package.requirement] }
     end
 
-    def find_packages_resolved
+    # Find the Packages.resolved file
+    # @return [String]
+    def find_packages_resolved(xcodeproj_path)
       if Dir.exist?(xcodeproj_path.sub("xcodeproj", "xcworkspace"))
         File.join(xcodeproj_path.sub("xcodeproj", "xcworkspace"), "xcshareddata", "swiftpm", "Package.resolved")
       else
@@ -110,7 +120,7 @@ Newer version of #{name}: #{available_versions.first} (but this package is set t
         warn("Newer version of #{name}: #{available_versions.first}")
       else
         newest_meeting_reqs = available_versions.find { |version|
-          version < max_version
+          version < max_version && report_pre_releases ? true : version.pre.nil?
         }
         warn("Newer version of #{name}: #{newest_meeting_reqs} ") unless newest_meeting_reqs.to_s == resolved_version
         warn(
@@ -127,7 +137,7 @@ Newest version of #{name}: #{available_versions.first} (but this package is conf
         warn("Newer version of #{name}: #{available_versions.first}")
       else
         newest_meeting_reqs = available_versions.find { |version|
-          version.send(major_or_minor) == resolved_version.send(major_or_minor)
+          version.send(major_or_minor) == resolved_version.send(major_or_minor) && report_pre_releases ? true : version.pre.nil?
         }
         warn("Newer version of #{name}: #{newest_meeting_reqs}") unless newest_meeting_reqs == resolved_version
         warn(

data/spec/spm_version_updates_spec.rb

@@ -22,35 +22,27 @@ module Danger
         allow(@my_plugin.github).to receive(:pr_json).and_return(json)
       end
 
-      it "raises error if xcodeproj_path is not set" do
-        expect { @my_plugin.check_for_updates }
-          .to raise_error(Danger::XcodeprojPathMustBeSet)
-      end
-
       it "Reports none without exact version matching" do
-        monday_date = Date.parse("2016-07-11")
-        allow(Date).to receive(:today).and_return monday_date
+        allow(@my_plugin).to receive(:git_versions).and_return false
 
-        @my_plugin.xcodeproj_path = "#{File.dirname(__FILE__)}/support/fixtures/Example.xcodeproj"
-        @my_plugin.check_for_updates
+        @my_plugin.check_for_updates("#{File.dirname(__FILE__)}/support/fixtures/Example.xcodeproj")
 
         expect(@dangerfile.status_report[:warnings]).to eq([])
       end
 
       it "Reports some with exact version matching" do
         # TODO: mock git calls
-        # allow(@my_plugin).to receive(:git_versions).and_return false
+        allow(@my_plugin).to receive(:git_versions).and_return false
 
-        @my_plugin.xcodeproj_path = "#{File.dirname(__FILE__)}/support/fixtures/Example.xcodeproj"
         @my_plugin.check_when_exact = true
-        @my_plugin.check_for_updates
+        @my_plugin.check_for_updates("#{File.dirname(__FILE__)}/support/fixtures/Example.xcodeproj")
 
         expect(@dangerfile.status_report[:warnings]).to eq(
           [
             "Newer version of pointfreeco/swift-snapshot-testing: 1.14.2 (but this package is set to exact version 1.13.0)\n",
             "Newer version of kean/Nuke: 12.2.0-beta.2 (but this package is set to exact version 12.1.6)\n",
             "Newer version of pointfreeco/swiftui-navigation: 1.0.3 (but this package is set to exact version 1.0.2)\n",
-            "Newer version of getsentry/sentry-cocoa: 8.14.2 (but this package is set to exact version 8.12.0)\n",
+            "Newer version of getsentry/sentry-cocoa: 8.15.0 (but this package is set to exact version 8.12.0)\n",
             "Newer version of firebase/firebase-ios-sdk: 10.17.0 (but this package is set to exact version 10.15.0)\n",
           ]
         )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-spm_version_updates
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Harold Martin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-06 00:00:00.000000000 Z
+date: 2023-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: xcodeproj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -247,7 +261,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="