gem_updater 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b964766638c2f8ef6afc1b87b3d17ae68fec20c
+  data.tar.gz: 92e434d50c4d81fb9d95537afe89001fdd9536ea
+SHA512:
+  metadata.gz: 04b7c13adf8c38658fb0a47e6df184373f826d94c5bc29f889bd86d85b942cf96506eb6d58d05b41fdf4a5f1d3f457fa2ff3d4cda224080697e5bf5939b6f92b
+  data.tar.gz: f01e1bc74d5618300f0728d0e2ed7bf43a8244d27beaedf12b34b4943bf061f3eada7f856ccbc31d15da5e37228d4ae493d95fe0165b31aa088f9f4a57ee32d7

data/bin/gem_update

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+# Exit cleanly from an early interrupt
+Signal.trap("INT") { exit 1 }
+
+require 'gem_updater'
+
+gems = GemUpdater::Updater.new
+gems.update!
+
+puts "\nHere are your changes:"
+puts '------------------------'
+gems.format_diff

data/lib/gem_updater.rb

@@ -0,0 +1,49 @@
+require 'gem_updater/gem_file'
+require 'gem_updater/ruby_gems_fetcher'
+require 'gem_updater/source_page_parser'
+
+module GemUpdater
+  class Updater
+
+    def initialize
+      @gemfile = GemUpdater::GemFile.new
+    end
+
+    # Update process.
+    # This will:
+    #   1. update gemfile
+    #   2. find changelogs for updated gems
+    def update!
+      @gemfile.update!
+
+      @gemfile.changes.each do |gem_name, details|
+        source_uri  = GemUpdater::RubyGemsFetcher.new( gem_name ).source_uri
+        source_page = GemUpdater::SourcePageParser.new( url: source_uri, version: details[ :versions ][ :new ] )
+
+        @gemfile.changes[ gem_name ][ :changelog ] = source_page.changelog if source_page.changelog
+      end
+    end
+
+    # Format the diff to get human readable information
+    # on the gems that were updated.
+    def format_diff
+      @gemfile.changes.each do |gem, details|
+        puts ERB.new( template, nil, '<>' ).result( binding )
+      end
+    end
+
+    private
+
+    # Get the template for gem's diff.
+    # It can use a custom template.
+    #
+    # @return [ERB] the template
+    def template
+      @template ||= begin
+        File.read( "#{Dir.home}/.gem_updater_template.erb" )
+      rescue Errno::ENOENT
+        File.read( File.expand_path( '../../lib/gem_updater_template.erb', __FILE__ ) )
+      end
+    end
+  end
+end

data/lib/gem_updater/gem_file.rb

@@ -0,0 +1,34 @@
+require 'bundler/cli'
+
+module GemUpdater
+
+  # GemFile is responsible for handling `Gemfile`
+  class GemFile
+    attr_accessor :changes
+
+    def initialize
+      @old_spec_set = Bundler.definition.specs
+      @changes      = {}
+    end
+
+    # Run `bundle update` to update gems.
+    # Then get new spec set.
+    def update!
+      puts "Updating gems..."
+      Bundler::CLI.new.update
+      @new_spec_set = Bundler.definition.specs
+      compute_changes
+    end
+
+    # Compute the diffs between two `Gemfile.lock`.
+    #
+    # @return [Hash] gems for which there are differences.
+    def compute_changes
+      @old_spec_set.each do |gem_specs|
+        unless ( old_version = gem_specs.version ) == ( new_version = @new_spec_set[ gem_specs.name ].first.version )
+          @changes[ gem_specs.name ] = { versions: { old: old_version.to_s, new: new_version.to_s } }
+        end
+      end
+    end
+  end
+end

data/lib/gem_updater/ruby_gems_fetcher.rb

@@ -0,0 +1,34 @@
+require 'json'
+require 'nokogiri'
+require 'open-uri'
+
+module GemUpdater
+
+  # RubyGemsFetcher is a wrapper around rubygems API.
+  class RubyGemsFetcher
+
+    # @param gem_name [String] name of the gem
+    def initialize( gem_name )
+      @gem_name = gem_name
+    end
+
+    # Finds where code is hosted.
+    # Most likely in will be in 'source_code_uri' or 'homepage_uri'
+    #
+    # @return [String] url of gem source code
+    def source_uri
+      information[ "source_code_uri" ] || information[ "homepage_uri" ]
+    end
+
+    private
+
+    # Obtain information about a given gem
+    # from rubygems.org.
+    # See API: http://guides.rubygems.org/rubygems-org-api/#gem-methods
+    #
+    # @return [Hash] parse of json information
+    def information
+      @information ||= JSON.parse( open( "https://rubygems.org/api/v1/gems/#{@gem_name}.json" ).read )
+    end
+  end
+end

data/lib/gem_updater/source_page_parser.rb

@@ -0,0 +1,131 @@
+require 'nokogiri'
+require 'open-uri'
+
+module GemUpdater
+
+  # SourcePageParser is responsible for parsing a source page where
+  # the gem code is hosted.
+  class SourcePageParser
+
+    # @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
+      @changelog ||= begin
+        puts "Looking for a changelog in #{@uri}"
+        doc = Nokogiri::HTML( open( @uri ) )
+
+        find_changelog( doc )
+
+      rescue OpenURI::HTTPError # Uri points to nothing
+        puts "Cannot find #{@uri}"
+      end
+    end
+
+    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 )
+      uri = URI( url )
+      uri.scheme = 'https' if uri.host == 'github.com' && uri.scheme == 'http'
+
+      uri
+    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
+      %w( CHANGELOG Changelog ChangeLog changelog HISTORY History history )
+    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 )
+      %w( .md .rdoc ).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'
+
+      # @param doc [Nokogiri::XML::Element] document of source page
+      # @param version [String] version of gem
+      def initialize( doc, version )
+        @doc     = doc
+        @version = version
+      end
+
+      # Finds url of changelog.
+      #
+      # @return [String] the URL of changelog
+      def changelog
+        url = find_changelog_link
+
+        if 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
+      end
+
+      private
+
+      # Find which link corresponds to changelog.
+      #
+      # @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
+        end
+      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( open( url ) )
+        anchor = changelog_page.css( %(a.anchor) ).find{ |element| element.attr( 'href' ).match( @version.gsub('.', '') ) }
+
+        if anchor
+          anchor.attr( 'href' )
+        end
+      end
+    end
+  end
+end

data/lib/gem_updater_template.erb

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

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: gem_updater
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Maxime Demolin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: It updates the gems of your Gemfile and fetches the links pointing to
+  where their changelogs are
+email: akbarova.armia@gmail.com
+executables:
+- gem_update
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/gem_update
+- lib/gem_updater.rb
+- lib/gem_updater/gem_file.rb
+- lib/gem_updater/ruby_gems_fetcher.rb
+- lib/gem_updater/source_page_parser.rb
+- lib/gem_updater_template.erb
+homepage: https://github.com/MaximeD/gem_updater
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Update your gems and find their changelogs
+test_files: []
+has_rdoc: