gem_updater 6.1.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 242ea33b7c63f871adaadd0e90a562c10d069e9409b2da9df55972de156ce734
-  data.tar.gz: 899cdaba9b9208c33a916f7f27be10aee6347cbe28ec3509ae760bb1975ba4a7
+  metadata.gz: dc62f5f20f9d239d4eea066d409fd9900ba139630287a2884fe2497c09ce91e7
+  data.tar.gz: 0dc7e3a0446c91dc1a9d24786f381623a162f95218ce1e212d701768f2f99082
 SHA512:
-  metadata.gz: 14d744975c7a423f7b467d86e262da0c5431cbaa0b76408a89f479280403d6c81d7d8214df5e6ab3b4251b84ca1b1d266d1228a3b6848149135681778a788230
-  data.tar.gz: 73e57ed85b57033c36c55a30353a29c5a698444ea45edb9ad1d1db538f629217c5962b1de524a81e4ee3180ddba2c9c28103a55aa7976ba336d5da91c728cb84
+  metadata.gz: d7d95be3b9d660ea9af8b2b469e49613305230b6431a4c5c0ea351e49192b035546ff0da342c904062a0518fcc1c1b2327462c4380eed69b9fe189b32fa28b9f
+  data.tar.gz: 722d4d3924adb67a00b844c517da2b664685a23a0ebd4964e5bf3e16fc7f4fd69ce20ee79b7c905455bef6a511b1759dc4aa6382391a99fa55b15a0bc2180825

data/lib/gem_updater/changelog_parser/github_parser.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+require 'open-uri'
+
+module GemUpdater
+  class ChangelogParser
+    # ChangelogParser is responsible for parsing a changelog hosted on github.
+    class GithubParser
+      attr_reader :uri, :version
+
+      # @param uri [String] changelog uri
+      # @param version [String] version of gem
+      def initialize(uri:, version:)
+        @uri     = uri
+        @version = version
+      end
+
+      # Finds anchor in changelog, otherwise return the base uri.
+      #
+      # @return [String] the URL of changelog
+      def changelog
+        uri + find_anchor(document).to_s
+      end
+
+      private
+
+      # Opens changelog url and parses it.
+      #
+      # @return [Nokogiri::HTML4::Document] the changelog
+      def document
+        Nokogiri::HTML(URI.parse(uri).open, nil, Encoding::UTF_8.to_s)
+      end
+
+      # Looks into document to find it there is an anchor to new gem version.
+      #
+      # @param doc [Nokogiri::HTML4::Document] document
+      # @return [String, nil] anchor's href
+      def find_anchor(doc)
+        anchor = doc.xpath('//a[contains(@class, "heading-link")]').find do |element|
+          element.attr('href').match(version.delete('.'))
+        end
+        return unless anchor
+
+        anchor.attr('href').gsub(%(\\"), '')
+      end
+    end
+  end
+end

data/lib/gem_updater/changelog_parser.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+require 'open-uri'
+require 'gem_updater/changelog_parser/github_parser'
+
+module GemUpdater
+  # ChangelogParser is responsible for parsing a source page where
+  # the gem code is hosted.
+  class ChangelogParser
+    MARKUP_FILES = %w[.md .rdoc .textile].freeze
+
+    attr_reader :uri, :version
+
+    # @param uri [String] uri of changelog
+    # @param version [String] version of gem
+    def initialize(uri:, version:)
+      @uri     = uri
+      @version = version
+    end
+
+    # Get the changelog in an uri.
+    #
+    # @return [String, nil] URL of changelog
+    def changelog
+      return uri unless changelog_may_contain_anchor?
+
+      parse_changelog
+    rescue OpenURI::HTTPError # Uri points to nothing
+      log_error_and_return_uri("Cannot find #{uri}")
+    rescue Errno::ETIMEDOUT # timeout
+      log_error_and_return_uri("#{URI.parse(uri).host} is down")
+    rescue ArgumentError => e # x-oauth-basic raises userinfo not supported. [RFC3986]
+      log_error_and_return_uri(e)
+    end
+
+    private
+
+    # Try to find where changelog might be.
+    #
+    # @param doc [Nokogiri::XML::Element] document of source page
+    def parse_changelog
+      case URI.parse(uri).host
+      when 'github.com'
+        GithubParser.new(uri: uri, version: version).changelog
+      else
+        uri
+      end
+    end
+
+    # Some documents like the one written in markdown may contain
+    # a direct anchor to specific version.
+    #
+    # @return [Boolean] true if file may contain an anchor
+    def changelog_may_contain_anchor?
+      MARKUP_FILES.include?(File.extname(uri.to_s))
+    end
+
+    def log_error_and_return_uri(error_message)
+      Bundler.ui.error error_message
+      uri
+    end
+  end
+end

data/lib/gem_updater/{gem_file.rb → gemfile.rb}

@@ -4,8 +4,8 @@ require 'bundler'
 require 'bundler/cli'
 
 module GemUpdater
-  # GemFile is responsible for handling `Gemfile`
-  class GemFile
+  # Gemfile is responsible for handling `Gemfile`
+  class Gemfile
     attr_accessor :changes
     attr_reader :old_spec_set, :new_spec_set
 

data/lib/gem_updater/ruby_gems_fetcher.rb

@@ -8,23 +8,22 @@ module GemUpdater
   # RubyGemsFetcher is a wrapper around rubygems API.
   class RubyGemsFetcher
     HTTP_TOO_MANY_REQUESTS = '429'
-    GEM_HOMEPAGES = %w[source_code_uri homepage_uri].freeze
 
-    attr_reader :gem_name, :source
+    attr_reader :gem_name
 
     # @param gem_name [String] name of the gem
-    # @param source [Bundler::Source] source of gem
-    def initialize(gem_name, source)
+    def initialize(gem_name)
       @gem_name = gem_name
-      @source   = source
     end
 
-    # Finds where code is hosted.
-    # Most likely in will be on rubygems, else look in other sources.
+    # Finds the changelog uri.
+    # It asks rubygems.org for changelog_uri of gem.
+    # See API: http://guides.rubygems.org/rubygems-org-api/#gem-methods
     #
-    # @return [String|nil] url of gem source code
-    def source_uri
-      uri_from_rubygems || uri_from_other_sources
+    # @return [String|nil] uri of changelog
+    def changelog_uri
+      response = query_rubygems
+      response.to_h['changelog_uri']
     end
 
     private
@@ -37,19 +36,6 @@ module GemUpdater
       JSON.parse(URI.parse(url).open.read)
     end
 
-    # Ask rubygems.org for source uri of gem.
-    # See API: http://guides.rubygems.org/rubygems-org-api/#gem-methods
-    #
-    # @return [String|nil] uri of source code
-    def uri_from_rubygems
-      return unless source.remotes.map(&:host).include?('rubygems.org')
-
-      response = query_rubygems
-      return unless response
-
-      response[GEM_HOMEPAGES.find { |key| response[key] && !response[key].empty? }]
-    end
-
     # Make the real query to rubygems
     # It may fail in case we trigger too many requests
     #
@@ -63,43 +49,5 @@ module GemUpdater
         sleep 1 && retry if tries < 2
       end
     end
-
-    # Look if gem can be found in another remote
-    #
-    # @return [String|nil] uri of source code
-    def uri_from_other_sources
-      source.remotes.find do |remote|
-        case remote.host
-        when 'rubygems.org' then next # already checked
-        when 'rails-assets.org'
-          return uri_from_railsassets
-        else
-          Bundler.ui.error "Source #{remote} is not supported, ' \
-            'feel free to open a PR or an issue on https://github.com/MaximeD/gem_updater"
-        end
-      end
-    end
-
-    # Ask rails-assets.org for source uri of gem.
-    # API is at : https://rails-assets.org/packages/package_name
-    #
-    # @return [String|nil] uri of source code
-    def uri_from_railsassets
-      response = query_railsassets
-      return unless response
-
-      response['url'].gsub(/^git/, 'http')
-    end
-
-    # Make the real query to railsassets
-    # rubocop:disable Lint/SuppressedException
-    def query_railsassets
-      parse_remote_json("https://rails-assets.org/packages/#{gem_name.gsub('rails-assets-', '')}")
-    rescue JSON::ParserError
-      # if gem is not found, rails-assets returns a 200
-      # with html (instead of json) containing a 500...
-    rescue OpenURI::HTTPError
-    end
-    # rubocop:enable Lint/SuppressedException
   end
 end

data/lib/gem_updater/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GemUpdater
-  VERSION = '6.1.0'
+  VERSION = '7.0.0'
 end

data/lib/gem_updater.rb

@@ -1,22 +1,21 @@
 # frozen_string_literal: true
 
 require 'erb'
-require 'memoist'
-require 'gem_updater/gem_file'
+require 'gem_updater/changelog_parser'
+require 'gem_updater/gemfile'
 require 'gem_updater/ruby_gems_fetcher'
-require 'gem_updater/source_page_parser'
 
 # Base lib.
 module GemUpdater
   # Updater's main responsability is to fill changes
   # happened before and after update of `Gemfile`, and then format them.
   class Updater
-    extend Memoist
+    RUBYGEMS_SOURCE_NAME = 'rubygems repository https://rubygems.org/'
 
     attr_accessor :gemfile
 
     def initialize
-      @gemfile = GemUpdater::GemFile.new
+      @gemfile = GemUpdater::Gemfile.new
     end
 
     # Update process.
@@ -52,35 +51,23 @@ module GemUpdater
     # For each gem, retrieve its changelog
     def fill_changelogs
       [].tap do |threads|
-        gemfile.changes.each do |gem_name, details|
-          threads << Thread.new { retrieve_gem_changes(gem_name, details) }
+        gemfile.changes.each do |gem_changes, details|
+          threads << Thread.new { retrieve_changelog(gem_changes, details) }
         end
       end.each(&:join)
     end
 
-    # Find where is hosted the source of a gem
-    #
-    # @param gem [String] the name of the gem
-    # @param source [Bundler::Source] gem's source
-    # @return [String] url where gem is hosted
-    def find_source(gem, source)
-      case source
-      when Bundler::Source::Rubygems
-        GemUpdater::RubyGemsFetcher.new(gem, source).source_uri
-      when Bundler::Source::Git
-        source.uri.gsub(/^git/, 'http').chomp('.git')
-      end
-    end
+    # Get the changelog URL.
+    def retrieve_changelog(gem_name, details)
+      return unless details[:source].name == RUBYGEMS_SOURCE_NAME
 
-    def retrieve_gem_changes(gem_name, details)
-      source_uri = find_source(gem_name, details[:source])
-      return unless source_uri
+      changelog_uri = RubyGemsFetcher.new(gem_name).changelog_uri
 
-      source_page = GemUpdater::SourcePageParser.new(
-        url: source_uri, version: details[:versions][:new]
-      )
+      return unless changelog_uri
 
-      gemfile.changes[gem_name][:changelog] = source_page.changelog if source_page.changelog
+      changelog = ChangelogParser
+                  .new(uri: changelog_uri, version: details.dig(:versions, :new)).changelog
+      gemfile.changes[gem_name][:changelog] = changelog&.to_s
     end
 
     # Get the template for gem's diff.
@@ -92,6 +79,5 @@ module GemUpdater
     rescue Errno::ENOENT
       File.read(File.expand_path('../lib/gem_updater_template.erb', __dir__))
     end
-    memoize :template
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem_updater
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Maxime Demolin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-15 00:00:00.000000000 Z
+date: 2023-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,20 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
-- !ruby/object:Gem::Dependency
-  name: memoist
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.16.2
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -160,9 +146,10 @@ extra_rdoc_files: []
 files:
 - bin/gem_update
 - lib/gem_updater.rb
-- lib/gem_updater/gem_file.rb
+- lib/gem_updater/changelog_parser.rb
+- lib/gem_updater/changelog_parser/github_parser.rb
+- lib/gem_updater/gemfile.rb
 - lib/gem_updater/ruby_gems_fetcher.rb
-- lib/gem_updater/source_page_parser.rb
 - lib/gem_updater/version.rb
 - lib/gem_updater_template.erb
 homepage: https://github.com/MaximeD/gem_updater

data/lib/gem_updater/source_page_parser.rb

@@ -1,173 +0,0 @@
-# frozen_string_literal: true
-
-require 'nokogiri'
-require 'open-uri'
-
-module GemUpdater
-  # SourcePageParser is responsible for parsing a source page where
-  # the gem code is hosted.
-  class SourcePageParser
-    extend Memoist
-
-    HOSTS = {
-      github: /github.com/,
-      bitbucket: /bitbucket.org/,
-      rubygems: /rubygems.org/
-    }.freeze
-    MARKUP_FILES = %w[.md .rdoc .textile].freeze
-    CHANGELOG_NAMES = %w[changelog ChangeLog history changes news].freeze
-
-    attr_reader :uri, :version
-
-    # @param url [String] url of page
-    # @param version [String] version of gem
-    def initialize(url: nil, version: nil)
-      @uri     = correct_uri(url)
-      @version = version
-    end
-
-    # Get the changelog in an uri.
-    #
-    # @return [String, nil] URL of changelog
-    def changelog
-      return unless uri
-
-      Bundler.ui.warn "Looking for a changelog in #{uri}"
-      find_changelog(Nokogiri::HTML(uri.open))
-    rescue OpenURI::HTTPError # Uri points to nothing
-      log_error("Cannot find #{uri}")
-    rescue Errno::ETIMEDOUT # timeout
-      log_error("#{uri} is down")
-    rescue ArgumentError => e # x-oauth-basic raises userinfo not supported. [RFC3986]
-      log_error(e)
-    end
-    memoize :changelog
-
-    private
-
-    # Some gems have 'http://github.com' as URI which will redirect to https
-    # leading `open_uri` to crash.
-    #
-    # @param url [String] the url to parse
-    # @return [URI] valid URI
-    def correct_uri(url)
-      return unless url.is_a?(String) && !url.empty?
-
-      uri = URI.parse(url)
-      uri.scheme == 'http' ? known_https(uri) : uri
-    end
-
-    # Some uris are not https, but we know they should be,
-    # in which case we have an https redirection
-    # which is not properly handled by open-uri
-    #
-    # @param uri [URI::HTTP]
-    # @return [URI::HTTPS|URI::HTTP]
-    def known_https(uri)
-      case uri.host
-      when HOSTS[:github]
-        # remove possible subdomain like 'wiki.github.com'
-        URI "https://github.com#{uri.path}"
-      when HOSTS[:bitbucket], HOSTS[:rubygems]
-        URI "https://#{uri.host}#{uri.path}"
-      else
-        uri
-      end
-    end
-
-    # Try to find where changelog might be.
-    #
-    # @param doc [Nokogiri::XML::Element] document of source page
-    def find_changelog(doc)
-      case uri.host
-      when 'github.com'
-        GitHubParser.new(doc, version).changelog
-      end
-    end
-
-    # List possible names for a changelog
-    # since humans may have many many ways to call it.
-    #
-    # @return [Array] list of possible names
-    def changelog_names
-      CHANGELOG_NAMES.flat_map do |name|
-        [name, name.upcase, name.capitalize]
-      end.uniq
-    end
-
-    # Some documents like the one written in markdown may contain
-    # a direct anchor to specific version.
-    #
-    # @param file_name [String] file name of changelog
-    # @return [Boolean] true if file may contain an anchor
-    def changelog_may_contain_anchor?(file_name)
-      MARKUP_FILES.include?(File.extname(file_name))
-    end
-
-    def log_error(error_message)
-      Bundler.ui.error error_message
-      false
-    end
-
-    # GitHubParser is responsible for parsing source code
-    # hosted on github.com.
-    class GitHubParser < SourcePageParser
-      BASE_URL = 'https://github.com'
-
-      attr_reader :doc, :version
-
-      # @param doc [Nokogiri::XML::Element] document of source page
-      # @param version [String] version of gem
-      # rubocop:disable Lint/MissingSuper
-      def initialize(doc, version)
-        @doc     = doc
-        @version = version
-      end
-      # rubocop:enable Lint/MissingSuper
-
-      # Finds url of changelog.
-      #
-      # @return [String] the URL of changelog
-      def changelog
-        url = find_changelog_link
-        return unless url
-
-        full_url = BASE_URL + url
-
-        if changelog_may_contain_anchor?(full_url)
-          anchor = find_anchor(full_url)
-          full_url += anchor if anchor
-        end
-
-        full_url
-      end
-
-      private
-
-      # Find which link corresponds to changelog.
-      # Last one is taken as files come after directories. So if there is a directory plus a file
-      # matching a changelog name, we ensure file is preferred.
-      #
-      # @return [String, nil] url of changelog
-      def find_changelog_link
-        changelog_names.filter_map do |name|
-          doc.at_css(%([aria-labelledby="files"] a[title^="#{name}"]))
-        end.last&.attr('href')
-      end
-
-      # Looks into document to find it there is an anchor to new gem version.
-      #
-      # @param url [String] url of changelog
-      # @return [String, nil] anchor's href
-      def find_anchor(url)
-        changelog_page = Nokogiri::HTML(URI.parse(url).open)
-        anchor = changelog_page.xpath('//a[contains(@class, "anchor")]').find do |element|
-          element.attr('href').match(version.delete('.'))
-        end
-        return unless anchor
-
-        anchor.attr('href').gsub(%(\\"), '')
-      end
-    end
-  end
-end