gem_updater 0.4.5 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 430902d1ecdddd688a1f3e2aa06979c634dfe92d
-  data.tar.gz: c874786403e4a630a259633c8c0db0dc384e960d
+  metadata.gz: 66ba0cea1b0c09848cc7e9662257d9f9e366b487
+  data.tar.gz: 20527e80b3fc8da321ef1539a59d4e693aac2885
 SHA512:
-  metadata.gz: 4a39b320ea39735ec2e0066d3db925f4212e28d516dace351f6661fb3f272ea40920f48c606fd21bbb9002283025affd1382c5e90ac24fa2d8e81875cf2e6fc7
-  data.tar.gz: 790be8de469953d53b90a2d20d4d5c74940dc2802891b28814a791178ce98f472ea7a48a16131c42f244feafcc581d49472d14a07a0b398cf802d85a4d9e831d
+  metadata.gz: 0740383ec2b47aa3d68adeb7f96e49e7bb7210e8c08ae74d02efc9557e3fc0a17e18fa7de9be0bfae404db30a091f0ba5dc09c7fe53d8c1b4c69dd8fb8beb559
+  data.tar.gz: bb02299d459070caadb163aa9fe2f9624eacd5bd86aca23510844cff14ea5a19d50c52bdce416104194e45d13f51eed3c591808f5b82c95604d800bc6490440d

data/bin/gem_update

@@ -2,34 +2,38 @@
 require 'optparse'
 
 # Exit cleanly from an early interrupt
-Signal.trap("INT") { exit 1 }
+Signal.trap('INT') { exit 1 }
 
-$:.unshift File.expand_path( '../../lib', __FILE__ )
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'gem_updater'
 
 Bundler.ui = Bundler::UI::Shell.new
 
 options = {}
 OptionParser.new do |opts|
-  opts.on( "-c", "--commit", "Auto commit" ) do |v|
-    options[ :commit ] = v
+  opts.on('-c', '--commit', 'Auto commit') do |v|
+    options[:commit] = v
   end
 end.parse!
 
 gems = GemUpdater::Updater.new
-gems.update!( ARGV )
+gems.update!(ARGV)
 
 if gems.gemfile.changes.any?
-  if options[ :commit ]
+  if options[:commit]
     require 'tempfile'
-    file = Tempfile.new( 'gem_updater' )
+    file = Tempfile.new('gem_updater')
     file.write "UPDATE gems\n\n"
     file.write gems.format_diff.join
     file.close
 
     gemfile = Bundler.default_gemfile.to_s
 
-    system %(git add #{gemfile} #{gemfile}.lock && git commit -t #{file.path} --allow-empty-message)
+    system %(
+      git add #{gemfile} #{gemfile}.lock \
+      && git commit -t #{file.path} --allow-empty-message
+    )
+
     file.unlink
   else
     Bundler.ui.confirm "\nHere are your changes:"

data/lib/gem_updater.rb

@@ -4,8 +4,8 @@ require 'gem_updater/source_page_parser'
 
 module GemUpdater
 
-  # Updater's main responsability is to fill changes happened before and after update
-  # of `Gemfile`, and then format them.
+  # Updater's main responsability is to fill changes
+  # happened before and after update of `Gemfile`, and then format them.
   class Updater
     attr_accessor :gemfile
 
@@ -19,8 +19,8 @@ module GemUpdater
     #   2. find changelogs for updated gems
     #
     # @param gems [Array] list of gems to update
-    def update!( gems )
-      gemfile.update!( gems )
+    def update!(gems)
+      gemfile.update!(gems)
       gemfile.compute_changes
 
       fill_changelogs
@@ -35,7 +35,7 @@ module GemUpdater
     # on the gems that were updated.
     def format_diff
       gemfile.changes.map do |gem, details|
-        ERB.new( template, nil, '<>' ).result( binding )
+        ERB.new(template, nil, '<>').result(binding)
       end
     end
 
@@ -47,29 +47,32 @@ module GemUpdater
 
       gemfile.changes.each do |gem_name, details|
         threads << Thread.new do
-          if source_uri = find_source( gem_name, details[ :source ] )
-            source_page = GemUpdater::SourcePageParser.new( url: source_uri, version: details[ :versions ][ :new ] )
+          if source_uri = find_source(gem_name, details[:source])
+            source_page = GemUpdater::SourcePageParser.new(
+              url: source_uri, version: details[:versions][:new]
+            )
 
-            gemfile.changes[ gem_name ][ :changelog ] = source_page.changelog if source_page.changelog
+            if source_page.changelog
+              gemfile.changes[gem_name][:changelog] = source_page.changelog
+            end
           end
         end
       end
 
-      threads.each( &:join )
+      threads.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 )
+    def find_source(gem, source)
       case source
       when Bundler::Source::Rubygems
-        GemUpdater::RubyGemsFetcher.new( gem, source ).source_uri
+        GemUpdater::RubyGemsFetcher.new(gem, source).source_uri
       when Bundler::Source::Git
-        source.uri.gsub( /^git/, 'http' ).chomp( '.git' )
+        source.uri.gsub(/^git/, 'http').chomp('.git')
       end
     end
 
@@ -79,9 +82,9 @@ module GemUpdater
     # @return [ERB] the template
     def template
       @template ||= begin
-        File.read( "#{Dir.home}/.gem_updater_template.erb" )
+        File.read("#{Dir.home}/.gem_updater_template.erb")
       rescue Errno::ENOENT
-        File.read( File.expand_path( '../../lib/gem_updater_template.erb', __FILE__ ) )
+        File.read(File.expand_path('../../lib/gem_updater_template.erb', __FILE__))
       end
     end
   end

data/lib/gem_updater/gem_file.rb

@@ -12,9 +12,9 @@ module GemUpdater
     end
 
     # Run `bundle update` to update gems.
-    def update!( gems )
-      Bundler.ui.warn "Updating gems..."
-      Bundler::CLI.start( [ 'update' ] + gems )
+    def update!(gems)
+      Bundler.ui.warn 'Updating gems...'
+      Bundler::CLI.start(['update'] + gems)
     end
 
     # Compute the diffs between two `Gemfile.lock`.
@@ -24,10 +24,10 @@ module GemUpdater
       get_spec_sets
 
       old_spec_set.each do |old_gem|
-        if updated_gem = new_spec_set.find{ |new_gem| new_gem.name == old_gem.name }
-          unless old_gem.version == updated_gem.version
-            changes[ old_gem.name ] = { versions: { old: old_gem.version.to_s, new: updated_gem.version.to_s }, source: updated_gem.source }
-          end
+        updated_gem = new_spec_set.find { |new_gem| new_gem.name == old_gem.name }
+
+        if updated_gem && old_gem.version != updated_gem.version
+          fill_changes(old_gem, updated_gem)
         end
       end
     end
@@ -52,7 +52,20 @@ module GemUpdater
     # will return the same result.
     # Use a hacky way to tell bundle we want to parse the new `Gemfile.lock`
     def reinitialize_spec_set!
-      Bundler.remove_instance_variable( "@locked_gems" )
+      Bundler.remove_instance_variable('@locked_gems')
+    end
+
+    # Add changes to between two versions of a gem
+    #
+    # @param old_gem [Bundler::LazySpecification]
+    # @param new_gem [Bundler::LazySpecification]
+    def fill_changes(old_gem, updated_gem)
+      changes[old_gem.name] = {
+        versions: {
+          old: old_gem.version.to_s, new: updated_gem.version.to_s
+        },
+        source: updated_gem.source
+      }
     end
   end
 end

data/lib/gem_updater/ruby_gems_fetcher.rb

@@ -6,11 +6,14 @@ module GemUpdater
 
   # RubyGemsFetcher is a wrapper around rubygems API.
   class RubyGemsFetcher
+    HTTP_TOO_MANY_REQUESTS = '429'.freeze
+    GEM_HOMEPAGES = %w[source_code_uri homepage_uri].freeze
+
     attr_reader :gem_name, :source
 
     # @param gem_name [String] name of the gem
     # @param source [Bundler::Source] source of gem
-    def initialize( gem_name, source )
+    def initialize(gem_name, source)
       @gem_name = gem_name
       @source   = source
     end
@@ -30,29 +33,30 @@ module GemUpdater
     #
     # @return [String|nil] uri of source code
     def uri_from_rubygems
-      return unless source.remotes.map( &:host ).include?( 'rubygems.org' )
-      tries = 0
-
-      response = begin
-        JSON.parse( open( "https://rubygems.org/api/v1/gems/#{gem_name}.json" ).read )
-      rescue OpenURI::HTTPError => e
-        # We may trigger too many requests, in which case give rubygems a break
-        if e.io.status.include?( '429' )
-          if ( tries += 1 ) < 2
-            sleep 1 and retry
-          end
-        end
-      end
+      return unless source.remotes.map(&:host).include?('rubygems.org')
 
-      if response
+      if response = query_rubygems
         response[
-          %w( source_code_uri homepage_uri ).find do |key|
-            response[ key ] && !response[ key ].empty?
-          end
+          GEM_HOMEPAGES.find { |key| response[key] && !response[key].empty? }
         ]
       end
     end
 
+    # Make the real query to rubygems
+    # It may fail in case we trigger too many requests
+    #
+    # @param tries [Integer|nil] (optional) how many times we tried
+    def query_rubygems(tries = 0)
+      JSON.parse(open("https://rubygems.org/api/v1/gems/#{gem_name}.json").read)
+    rescue OpenURI::HTTPError => e
+      # We may trigger too many requests, in which case give rubygems a break
+      if e.io.status.include?(HTTP_TOO_MANY_REQUESTS)
+        if (tries += 1) < 2
+          sleep 1 and retry
+        end
+      end
+    end
+
     # Look if gem can be found in another remote
     #
     # @return [String|nil] uri of source code
@@ -78,17 +82,22 @@ module GemUpdater
     #
     # @return [String|nil] uri of source code
     def uri_from_railsassets
-      begin
-        response = JSON.parse( open( "https://rails-assets.org/packages/#{gem_name.gsub( /rails-assets-/, '' )}" ).read )
-      rescue JSON::ParserError
-        # if gem is not found, rails-assets returns a 200
-        # with html (instead of json) containing a 500...
-      rescue OpenURI::HTTPError
+      if response = query_railsassets
+        response['url'].gsub(/^git/, 'http')
       end
+    end
 
-      if response
-        response[ "url" ].gsub( /^git/, 'http' )
-      end
+    # Make the real query to railsassets
+    def query_railsassets
+      JSON.parse(
+        open(
+          "https://rails-assets.org/packages/#{gem_name.gsub(/rails-assets-/, '')}"
+        ).read
+      )
+    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
   end
 end

data/lib/gem_updater/source_page_parser.rb

@@ -6,11 +6,16 @@ module GemUpdater
   # SourcePageParser is responsible for parsing a source page where
   # the gem code is hosted.
   class SourcePageParser
+    HOSTS = { github: /github.com/, bitbucket: /bitbucket.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 )
+    def initialize(url: nil, version: nil)
+      @uri     = correct_uri(url)
       @version = version
     end
 
@@ -19,16 +24,18 @@ module GemUpdater
     # @return [String, nil] URL of changelog
     def changelog
       @changelog ||= begin
-        Bundler.ui.warn "Looking for a changelog in #{@uri}"
-        doc = Nokogiri::HTML( open( @uri ) )
+        if uri
+          Bundler.ui.warn "Looking for a changelog in #{uri}"
+          doc = Nokogiri::HTML(open(uri))
 
-        find_changelog( doc )
+          find_changelog(doc)
+        end
 
       rescue OpenURI::HTTPError # Uri points to nothing
-        Bundler.ui.error "Cannot find #{@uri}"
+        Bundler.ui.error "Cannot find #{uri}"
         false
       rescue Errno::ETIMEDOUT # timeout
-        Bundler.ui.error "#{@uri} is down"
+        Bundler.ui.error "#{uri} is down"
         false
       end
     end
@@ -40,28 +47,43 @@ module GemUpdater
     #
     # @param url [String] the url to parse
     # @return [URI] valid URI
-    def correct_uri( url )
-      uri = URI( url )
+    def correct_uri(url)
+      return unless String === url && !url.empty?
+
+      uri = URI(url)
+
       if uri.scheme == 'http'
-        case
-        when uri.host.match( 'github.com' )
-          # remove possible subdomain like 'wiki.github.com'
-          uri = URI "https://github.com#{uri.path}"
-        when uri.host.match( 'bitbucket.org' )
-          uri = URI "https://#{uri.host}#{uri.path}"
-        end
+        known_https(uri)
+      else
+        uri
       end
+    end
 
-      uri
+    # 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
+      when uri.host =~ HOSTS[:github]
+        # remove possible subdomain like 'wiki.github.com'
+        URI "https://github.com#{uri.path}"
+      when uri.host =~ HOSTS[:bitbucket]
+        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
+    def find_changelog(doc)
+      case uri.host
       when 'github.com'
-        GitHubParser.new( doc, @version ).changelog
+        GitHubParser.new(doc, version).changelog
       end
     end
 
@@ -70,9 +92,9 @@ module GemUpdater
     #
     # @return [Array] list of possible names
     def changelog_names
-      base_names = %w( changelog history changes news )
-      other_names = %w( ChangeLog )
-      base_names + base_names.map( &:upcase ) + base_names.map( &:capitalize ) + other_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
@@ -80,18 +102,20 @@ module GemUpdater
     #
     # @param file_name [String] file name of changelog
     # @return [Boolean] true if file may contain an anchor
-    def changelog_may_contain_anchor?( file_name )
-      %w( .md .rdoc .textile ).include?( File.extname( file_name ) )
+    def changelog_may_contain_anchor?(file_name)
+      MARKUP_FILES.include?(File.extname(file_name))
     end
 
     # GitHubParser is responsible for parsing source code
     # hosted on github.com.
     class GitHubParser < SourcePageParser
-      BASE_URL = 'https://github.com'
+      BASE_URL = 'https://github.com'.freeze
+
+      attr_reader :doc, :version
 
       # @param doc [Nokogiri::XML::Element] document of source page
       # @param version [String] version of gem
-      def initialize( doc, version )
+      def initialize(doc, version)
         @doc     = doc
         @version = version
       end
@@ -105,8 +129,8 @@ module GemUpdater
         if url
           full_url = BASE_URL + url
 
-          if changelog_may_contain_anchor?( full_url )
-            anchor = find_anchor( full_url )
+          if changelog_may_contain_anchor?(full_url)
+            anchor = find_anchor(full_url)
             full_url += anchor if anchor
           end
 
@@ -121,10 +145,9 @@ module GemUpdater
       # @return [String, nil] url of changelog
       def find_changelog_link
         changelog_names.find do |name|
-          node = @doc.at_css( %(table.files a[title^="#{name}"]) )
-          if node
-            break node.attr( 'href' )
-          end
+          node = doc.at_css(%(table.files a[title^="#{name}"]))
+
+          break node.attr('href') if node
         end
       end
 
@@ -132,13 +155,13 @@ module GemUpdater
       #
       # @param url [String] url of changelog
       # @return [String, nil] anchor's href
-      def find_anchor( url )
-        changelog_page = Nokogiri::HTML( open( url ) )
-        anchor = changelog_page.css( %(a.anchor) ).find{ |element| element.attr( 'href' ).match( @version.gsub('.', '') ) }
-
-        if anchor
-          anchor.attr( 'href' )
+      def find_anchor(url)
+        changelog_page = Nokogiri::HTML(open(url))
+        anchor = changelog_page.css(%(a.anchor)).find do |element|
+          element.attr('href').match(version.delete('.'))
         end
+
+        anchor.attr('href') if anchor
       end
     end
   end

data/lib/gem_updater_template.erb

@@ -1,5 +1,5 @@
-* <%= gem %> <%= details[ :versions ][ :old ] %> → <%= details[ :versions ][ :new ] %>
-<% if details[ :changelog ] %>
-[changelog](<%= details[ :changelog ] %>)
+* <%= gem %> <%= details[:versions][:old] %> → <%= details[:versions][:new] %>
+<% if details[:changelog] %>
+[changelog](<%= details[:changelog] %>)
 <% end %>
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem_updater
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.5.0
 platform: ruby
 authors:
 - Maxime Demolin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-13 00:00:00.000000000 Z
+date: 2016-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Update your gems and find their changelogs