bundle_update_interactive 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24de9c6dde2b3514ffad21a64256359200e2bb717b1a0385caa8d032776d5fe6
-  data.tar.gz: 4a1a1c65bd89e4c7e17d563c2a854c80e07edeb7d04e6b4ffdf3cbef1d47ddee
+  metadata.gz: 0bdc9b0322d61da7334ee24e12d415948f8f1117f6824ebb4afe5eec6eadd57e
+  data.tar.gz: bdc4cf0e7a740c4f33f9211b269257cc854ba49f9d190f956dcdb2513cbfef6b
 SHA512:
-  metadata.gz: 493421b5621ff128b56ed96041fd4c1e776de8c0160f330d8458d40963248e2c2e779dc64c7f7afd390c2f98d62a6203b3495534e7b57051f79add6edc729715
-  data.tar.gz: 638b235f21664177f8b9de29a0b69b9229ef1b57fc985c4ba6c73678ca2142a926caff18626a809b4ab4fdd2aeff4573e7a4137c471ca569d62b95e55322e0ec
+  metadata.gz: 6120695a0dcd0f21cc652e3e37a7b3f2a1573bfc042aba435d97896522cfd92a169c7d66cc73f7bbd2b4e5d8244b37321acda4e42ca61092201f80c584c65552
+  data.tar.gz: 37b171778494c7e5e8b89f16f6c9b0c6e47a22d2c3dc174c7d80e0324dac1a36260a485cc220aa7746d43db757917a8eb11df8dac312e6bee2048f5d0fb56371

data/README.md

@@ -75,17 +75,17 @@ If you discover a gem that is missing a changelog in `bundle update-interactive`
 
 ### Git diffs
 
-If your `Gemfile` sources a gem from a GitHub repo like this:
+If your `Gemfile` sources a gem from a Git repo like this:
 
 ```ruby
 gem "rails", github: "rails/rails", branch: "7-1-stable"
 ```
 
-Then `bundle update-interactive` will show a GitHub diff link instead of a changelog, so you can see exactly what changed when the gem is updated. For example:
+Then `bundle update-interactive` will show a diff link instead of a changelog, so you can see exactly what changed when the gem is updated. For example:
 
 https://github.com/rails/rails/compare/5a8d894...77dfa65
 
-Currently only GitHub repos are supported, but I'm considering adding GitLab and BitBucket as well.
+This feature currently works for GitHub, GitLab, and Bitbucket repos.
 
 ### Conservative updates
 

data/lib/bundle_update_interactive/changelog_locator.rb

@@ -10,48 +10,72 @@ EXT_PATTERN = /md|txt|rdoc/i.freeze
 
 module BundleUpdateInteractive
   class ChangelogLocator
-    # TODO: refactor
-    def find_changelog_uri(name:, version: nil) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
-      if version
-        response = Faraday.get("https://rubygems.org/api/v2/rubygems/#{name}/versions/#{version}.json")
-        version = nil unless response.success?
+    class GitHubRepo
+      def self.from_uris(*uris)
+        uris.flatten.each do |uri|
+          return new(Regexp.last_match(1)) if uri&.match(GITHUB_PATTERN)
+        end
+        nil
       end
 
-      response = Faraday.get("https://rubygems.org/api/v1/gems/#{name}.json") if version.nil?
+      attr_reader :path
 
-      return nil unless response.success?
+      def initialize(path)
+        @path = path
+      end
 
-      data = JSON.parse(response.body)
+      def discover_changelog_uri(version)
+        repo_html = fetch_repo_html(follow_redirect: true)
+        return if repo_html.nil?
 
-      version ||= data["version"]
-      changelog_uri = data["changelog_uri"]
-      github_repo = guess_github_repo(data)
+        changelog_path = repo_html[%r{/(#{path}/blob/[^/]+/#{FILE_PATTERN}(?:\.#{EXT_PATTERN})?)"}i, 1]
+        return "https://github.com/#{changelog_path}" if changelog_path
 
-      if changelog_uri.nil? && github_repo
-        file_list = Faraday.get("https://github.com/#{github_repo}")
-        if file_list.status == 301
-          github_repo = file_list.headers["Location"][GITHUB_PATTERN, 1]
-          file_list = Faraday.get(file_list.headers["Location"])
-        end
-        match = file_list.body.match(%r{/(#{github_repo}/blob/[^/]+/#{FILE_PATTERN}(?:\.#{EXT_PATTERN})?)"}i)
-        changelog_uri = "https://github.com/#{match[1]}" if match
+        releases_url = "https://github.com/#{path}/releases"
+        releases_url if Faraday.head("#{releases_url}/tag/v#{version}").success?
       end
 
-      if changelog_uri.nil? && github_repo
-        releases_uri = "https://github.com/#{github_repo}/releases"
-        changelog_uri = releases_uri if Faraday.head("#{releases_uri}/tag/v#{version}").success?
+      private
+
+      def fetch_repo_html(follow_redirect:)
+        response = Faraday.get("https://github.com/#{path}")
+
+        if response.status == 301 && follow_redirect
+          @path = response.headers["Location"][GITHUB_PATTERN, 1]
+          return fetch_repo_html(follow_redirect: false)
+        end
+
+        response.success? ? response.body : nil
       end
+    end
+
+    def find_changelog_uri(name:, version: nil)
+      data = fetch_rubygems_data(name, version)
+      return if data.nil?
 
-      changelog_uri
+      if (rubygems_changelog_uri = data["changelog_uri"])
+        rubygems_changelog_uri
+      elsif (github_repo = GitHubRepo.from_uris(data.values_at(*URI_KEYS)))
+        github_repo.discover_changelog_uri(data["version"])
+      end
     end
 
     private
 
-    def guess_github_repo(data)
-      data.values_at(*URI_KEYS).each do |uri|
-        return Regexp.last_match(1) if uri&.match(GITHUB_PATTERN)
-      end
-      nil
+    def fetch_rubygems_data(name, version)
+      api_url = if version.nil?
+                  "https://rubygems.org/api/v1/gems/#{name}.json"
+                else
+                  "https://rubygems.org/api/v2/rubygems/#{name}/versions/#{version}.json"
+                end
+
+      response = Faraday.get(api_url)
+
+      # Try again without the version in case the version does not exist at rubygems for some reason.
+      # This can happen when using a pre-release Ruby that has a bundled gem newer than the published version.
+      return fetch_rubygems_data(name, nil) if !response.success? && !version.nil?
+
+      response.success? ? JSON.parse(response.body) : nil
     end
   end
 end

data/lib/bundle_update_interactive/outdated_gem.rb

@@ -35,8 +35,8 @@ module BundleUpdateInteractive
       return @changelog_uri if defined?(@changelog_uri)
 
       @changelog_uri =
-        if git_version_changed? && github_repo
-          "https://github.com/#{github_repo}/compare/#{current_git_version}...#{updated_git_version}"
+        if (diff_url = build_git_diff_url)
+          diff_url
         elsif rubygems_source?
           changelog_locator.find_changelog_uri(name: name, version: updated_version.to_s)
         else
@@ -56,10 +56,34 @@ module BundleUpdateInteractive
 
     attr_reader :changelog_locator
 
+    def build_git_diff_url
+      return nil unless git_version_changed?
+
+      if github_repo
+        "https://github.com/#{github_repo}/compare/#{current_git_version}...#{updated_git_version}"
+      elsif gitlab_repo
+        "https://gitlab.com/os85/httpx/-/compare/#{current_git_version}...#{updated_git_version}"
+      elsif bitbucket_cloud_repo
+        "https://bitbucket.org/#{bitbucket_cloud_repo}/branches/compare/#{updated_git_version}..#{current_git_version}"
+      end
+    end
+
     def github_repo
       return nil unless updated_git_version
 
       git_source_uri.to_s[%r{^(?:git@github.com:|https://github.com/)([^/]+/[^/]+?)(:?\.git)?(?:$|/)}i, 1]
     end
+
+    def gitlab_repo
+      return nil unless updated_git_version
+
+      git_source_uri.to_s[%r{^(?:git@gitlab.com:|https://gitlab.com/)([^/]+/[^/]+?)(:?\.git)?(?:$|/)}i, 1]
+    end
+
+    def bitbucket_cloud_repo
+      return nil unless updated_git_version
+
+      git_source_uri.to_s[%r{(?:@|://)bitbucket.org[:/]([^/]+/[^/]+?)(:?\.git)?(?:$|/)}i, 1]
+    end
   end
 end

data/lib/bundle_update_interactive/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BundleUpdateInteractive
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bundle_update_interactive
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Matt Brictson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-17 00:00:00.000000000 Z
+date: 2024-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler