bundler-audited_update 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bbfc1d502ed22c2bc57ce8560f3851f6dae3cb95914c3499cac9759ad689abfa
+  data.tar.gz: 93ab57d94ee1ef17af96febfe7310cd790028d573ed652336087fe8bd525a05c
+SHA512:
+  metadata.gz: 102338a0fc8098a5acac9cd047928ee09b92be8b70ae80fa5ff18222c52a7f28d37096cbeb6577b28cff190c71c79f3ff17aab57abaf3054a8721198ad89c2b9
+  data.tar.gz: ac8ef5414c618a802943495281dcf204d945ac362cbe318fb93e91094863dbb208dad34db8ca24571e79f78f13f216816fd8381f8b2194dfd6edcdee9ecf4ba1

data/lib/bundler/audited_update.rb

@@ -0,0 +1,252 @@
+require 'bundler'
+require 'bundler/lockfile_parser'
+require "bundler/cli"
+require "bundler/cli/update"
+require "open-uri"
+require 'net/http'
+require 'json'
+require 'versionomy'
+require 'launchy'
+
+module Bundler
+  class AuditedUpdate
+    def run!
+      @before_specs = gem_specs
+      bundle_update
+      @after_specs = gem_specs
+
+      @output = ""
+      @output += "# Gem Changes\n"
+      @output += "\n"
+
+      output_gems("Added Gems", added_gems)
+      output_gems("Removed Gems", removed_gems)
+      output_changed_gems(changed_gems)
+
+      puts "\n\n\n\n\n"
+
+      puts "--------------------------------"
+      puts "Audited Bundle Upgrade Text"
+      puts "--------------------------------"
+
+      puts @output
+    end
+
+    def output_gems(title, gems)
+      return if gems.empty?
+
+      @output += "## #{title}\n"
+      @output += "\n"
+      gems.each { |the_gem| gem_output(the_gem.name, the_gem.version) }
+
+      @output += "\n"
+    end
+
+    def output_changed_gems(gems)
+      return if gems.empty?
+
+      major_upgrades = gems.select {|_, versions| versions[:before].major != versions[:after].major }
+      minor_upgrades = gems.select {|name, versions| !major_upgrades.keys.include?(name) && versions[:before].minor != versions[:after].minor }
+      point_upgrades = gems.reject { |name, _| major_upgrades.keys.include?(name) || minor_upgrades.keys.include?(name) }
+
+      @output += "## Upgraded Gems\n"
+      @output += "\n"
+
+      output_changed_gems_section("Major", major_upgrades)
+      output_changed_gems_section("Minor", minor_upgrades)
+      output_changed_gems_section("Point", point_upgrades)
+
+      @output += "\n"
+    end
+
+    def output_changed_gems_section(title, gems)
+      @output += "### #{title} Upgrades\n"
+      @output += "\n"
+      gems.each { |name, versions| gem_output(name, versions) }
+
+      @output += "\n"
+    end
+
+    def gem_output(name, version)
+      if version.is_a? Hash
+        version_string = "#{version[:before]} -> #{version[:after]}"
+        info = gem_info(name, version[:after])
+
+        guessed_source = gem_source_url(info)
+
+        if guessed_source
+          changelog_text, changelog_url = guess_changelog(guessed_source)
+
+          if changelog_text && !changelog_text.empty?
+            puts "\n\n\n"
+            puts "--------------------------------"
+            puts "#{name} changes from #{version_string}"
+            puts "--------------------------------"
+            # Output the changelog text from top until the line that contains the previous version
+            changelog_output = changelog_text.split(/^.*#{version[:before]}/, 2).first
+              # Max 200 lines
+              changelog_output = changelog_output.lines.to_a[0...200].join
+            puts changelog_output
+            impact = nil
+            while impact.nil?
+              puts "Does this impact your application? (y/n/[o]pen in browser)"
+              answer = gets
+              answer = answer.downcase.strip
+              if answer == "y"
+                puts "What's a short description of the impact?"
+                impact = gets
+              elsif answer == "n"
+                impact = "No impact"
+              elsif answer == "o"
+                Launchy.open(changelog_url)
+              else
+                puts "Invalid answer"
+              end
+            end
+
+            change_detail = impact
+          end
+        end
+
+      else
+        version_string = version
+        info = gem_info(name, version)
+        guessed_source = gem_source_url(info)
+        change_detail = guessed_source
+      end
+
+      change_detail ||= "Unsupported source URL, cannot search for changelog"
+
+
+      @output += "* #{name} (#{version_string}): #{change_detail}\n"
+    end
+
+    def guess_changelog(root_url)
+      filenames = %w{
+      CHANGELOG
+      CHANGELOG.md
+      Changelog
+      Changelog.md
+      History
+      History.md
+      History.rdoc
+      Changes
+      CHANGES
+      CHANGES.md
+      NEWS
+      }
+      changelog_text = nil
+      changelog_url = nil
+
+      filenames.each do |filename|
+        changelog_text = try_changelog_url(root_url, filename)
+        if changelog_text
+          changelog_url = changelog_url_for(root_url, filename)
+          break
+        end
+      end
+
+      unless changelog_text
+        changelog_text = github_releases_bodies(root_url)
+        changelog_url = github_releases_url(root_url) if changelog_text
+      end
+
+      unless changelog_text
+        changelog_text = "Could not find changelog URL, try manually"
+        changelog_url = root_url
+      end
+
+      [changelog_text, changelog_url]
+    end
+
+    def gem_source_url(info)
+      source_url_guess = info["source_code_uri"] || info["homepage_uri"]
+      if source_url_guess&.include?("github.com")
+        source_url_guess
+      else
+        # Unsupported source URL
+        nil
+      end
+    end
+
+    def added_gems
+      @after_specs.reject {|spec| @before_specs.map(&:name).include?(spec.name) }
+    end
+
+    def removed_gems
+      @before_specs.reject {|spec| @after_specs.map(&:name).include?(spec.name) }
+    end
+
+    def changed_gems
+      gems = @after_specs.reject do |after_spec|
+        next unless after_spec
+        before_spec = @before_specs.find {|before_spec| before_spec && before_spec.name == after_spec.name }
+        next unless before_spec # new gem
+        before_spec.version == after_spec.version
+      end
+
+      gems.map! do |the_gem|
+        before_gem = @before_specs.find {|before_spec| before_spec.name == the_gem.name }
+        after_gem = @after_specs.find {|after_spec| after_spec.name == the_gem.name }
+        versions = {
+          before: Versionomy.parse(before_gem.version.to_s),
+          after: Versionomy.parse(after_gem.version.to_s)
+        }
+        [the_gem.name, versions]
+      end
+
+      gems.to_h
+    end
+
+    def github_releases_url(source_root)
+      api_source_root = source_root.gsub("github.com/", "api.github.com/repos/")
+      "#{api_source_root}/releases"
+    end
+
+    def github_releases_bodies(source_root)
+      response = URI.parse(github_releases_url(source_root)).read
+      releases = JSON.parse(response)
+      release_notes = ""
+      releases.each do |release|
+        next unless release["body"]
+        release_notes += release["name"]
+        release_notes += "\n"
+        release_notes += release["body"]
+        release_notes += "\n"
+        release_notes += "\n"
+      end
+      release_notes
+    rescue OpenURI::HTTPError
+      return nil
+    end
+
+    def changelog_url_for(source_root, filename)
+      raw_source_root = source_root.gsub("github.com", "raw.githubusercontent.com")
+      url = "#{raw_source_root}/master/#{filename}"
+    end
+
+    def try_changelog_url(source_root, filename)
+      URI.parse(changelog_url_for(source_root, filename)).read
+    rescue OpenURI::HTTPError
+      return nil
+    end
+
+    def gem_info(name, version)
+      gem_url = "https://rubygems.org/api/v2/rubygems/#{name}/versions/#{version}"
+      response = URI.parse(gem_url).read
+      JSON.parse(response)
+    end
+
+    def gem_specs
+      root     = File.expand_path(Dir.pwd)
+      lockfile = Bundler::LockfileParser.new(
+        File.read(File.join(root, 'Gemfile.lock'))
+      )
+      lockfile.specs
+    end
+
+    def bundle_update
+      Bundler::CLI::Update.new({}, []).run
+    end
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: bundler-audited_update
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brendan Mulholland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: versionomy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Runs a bundle upgrade, shows the changelog for each gem that was upgraded,
+  and outputs a summary view of gem changes plus their impact.
+email: audited_bundle_update@bmulholland.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bundler/audited_update.rb
+homepage: http://rubygems.org/gems/bundler-audited_update
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Streamlined bundler audit with Changelog detection and summary ouput
+test_files: []