bundler-versions_report 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d0eaee09b6ca8a99bdc875830c8cbe7145179fa84e2de8db9042f3a5ec3bba92
+  data.tar.gz: f7a3dc0034276415563b2aa9e6be90048148d806e12a518e7bcf19a6bd632a25
+SHA512:
+  metadata.gz: 680da7a118a2deb96e1bf91025cd3fd36179ad0d656679777aa501cd0692ab252a39e22d8d6f70ee5eee36461cb85d93d429d087102bb0d169faa326cdb17158
+  data.tar.gz: ddb9397dd16bc8e9cd38e3990a0ee958e8b09c522fc64503fbcfa8d9bd7a0cdc8c45a49cc13ac4a42feb347aa069430869889b9e5e04c395220473c5855f74b0

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-01-27
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jakub Pavlík
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# Bundler::VersionsReport
+
+[Bundler][bundler] plugin extending the output of `bundle update` with a report of gems
+updated by a major or minor version.
+
+We assume [semantic versioning][semver]: major version updates definitely deserve attention;
+minor version ones should be backward-compatible, but may be worth attention nevertheless;
+updates beyond the major and minor version are considered harmless.
+
+```
+MINOR version updates:
+- builder 3.2.4 -> 3.3.0 (by 1 minor versions)
+- concurrent-ruby 1.2.3 -> 1.3.5 (by 1 minor versions)
+- dry-inflector 1.0.0 -> 1.2.0 (by 2 minor versions)
+- jbuilder 2.11.5 -> 2.13.0 (by 2 minor versions)
+- loofah 2.22.0 -> 2.24.0 (by 2 minor versions)
+- rouge 4.2.1 -> 4.5.1 (by 3 minor versions)
+- tilt 2.3.0 -> 2.6.0 (by 3 minor versions)
+- tins 1.32.1 -> 1.38.0 (by 6 minor versions)
+
+MAJOR version updates:
+- rspec-rails 6.1.2 -> 7.1.0 (by 1 major versions)
+```
+
+## Installation
+
+`$ bundle plugin install bundler-versions_report`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+[bundler]: https://bundler.io
+[semver]: https://semver.org

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec]

data/bundler-versions_report.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/bundler/versions_report/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "bundler-versions_report"
+  spec.version = Bundler::VersionsReport::VERSION
+  spec.authors = ["Jakub Pavlík"]
+  spec.email = ["jkb.pavlik@gmail.com"]
+
+  spec.summary = "Bundler plugin extending 'bundle update' with a report of gems updated by a major or minor version"
+  # spec.description = ""
+  spec.homepage = "https://github.com/igneus/bundler-versions_report"
+  spec.licenses = ["MIT"]
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage + "/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/bundler/versions_report/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Bundler
+  module VersionsReport
+    VERSION = "0.1.0"
+  end
+end

data/lib/bundler/versions_report.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "versions_report/version"

data/plugins.rb

@@ -0,0 +1,103 @@
+require 'bundler/versions_report'
+
+Bundler::Plugin.add_hook 'before-install-all' do
+  Bundler::VersionsReport.save_locked
+end
+
+Bundler::Plugin.add_hook 'before-install' do |spec_installation|
+  Bundler::VersionsReport.check spec_installation.spec
+end
+
+Bundler::Plugin.add_hook 'after-install-all' do
+  Bundler::VersionsReport.report
+end
+
+module Bundler
+  module VersionsReport
+    # save gem versions locked before the update
+    def self.save_locked
+      @updated = []
+      @previous_locked = Bundler.locked_gems.specs.inject({}) do |memo, spec|
+        memo[spec.name] = spec.version
+        memo
+      end
+    end
+
+    # check if the given gem is being updated
+    def self.check(spec)
+      previous_spec = @previous_locked[spec.name]
+      if previous_spec && spec.version != previous_spec.version
+        @updated << Update.new(spec.name, spec.version, Gem::Version.new(previous_spec.version))
+      end
+    end
+
+    # report major and minor version updates
+    def self.report
+      report = Report.new @updated
+
+      if report.significant?
+        puts
+        puts report
+        puts
+      end
+    end
+
+    class Update
+      SEGMENT_NAMES = %i[major minor patch]
+
+      attr_reader :gem_name,
+                  :version,
+                  :previous_version,
+                  :update_type, # major/minor/patch
+                  :update_by # version number difference
+
+      def initialize(gem_name, version, previous_version)
+        @gem_name = gem_name
+        @version = version
+        @previous_version = previous_version
+
+        version
+          .segments
+          .zip(previous_version.segments)
+          .each_with_index
+          .find {|((ver, prev), i)| ver != prev }
+          &.then do |((ver, prev), i)|
+          @update_type = SEGMENT_NAMES[i]
+          @update_by = ver - prev
+        end
+      end
+    end
+
+    class Report
+      SIGNIFICANT_SEGMENTS = Update::SEGMENT_NAMES[0..1]
+
+      def initialize(updates)
+        @data =
+          updates
+            .sort_by {|u| [u.update_by, u.gem_name] }
+            .group_by(&:update_type)
+      end
+
+      def significant?
+        SIGNIFICANT_SEGMENTS.find {|s| @data[s] }
+      end
+
+      def to_s
+        r = StringIO.new
+
+        SIGNIFICANT_SEGMENTS
+          .reverse # most important last, we are in the terminal
+          .each do |s|
+          next unless @data[s]
+
+          r.puts "\n#{s.to_s.upcase} version updates:"
+          @data[s].each do |update|
+            r.puts "- #{update.gem_name} #{update.previous_version} -> #{update.version} (by #{update.update_by} #{s} versions)"
+          end
+        end
+
+        r.string
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: bundler-versions_report
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jakub Pavlík
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-28 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- jkb.pavlik@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- bundler-versions_report.gemspec
+- lib/bundler/versions_report.rb
+- lib/bundler/versions_report/version.rb
+- plugins.rb
+homepage: https://github.com/igneus/bundler-versions_report
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/igneus/bundler-versions_report
+  source_code_uri: https://github.com/igneus/bundler-versions_report
+  changelog_uri: https://github.com/igneus/bundler-versions_report/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Bundler plugin extending 'bundle update' with a report of gems updated by
+  a major or minor version
+test_files: []