danger-gem_changes 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59d7f53a0aa74339b86b9847b1b3416b5cb5a8d918ebe969cdca2b936407fc19
-  data.tar.gz: 000fa34400b3392649ae437f94ee55bdea025b212f3711bfd0e3ac07a7f0c6d2
+  metadata.gz: 1a1b559abd29ece1800694f42e76a86d23d76902ad050b077fd2b0fd65835d3d
+  data.tar.gz: 0a97f435483472da2d0ddc1967f327b642d9a8d9bb74dec0d1ac812f5bfe21c1
 SHA512:
-  metadata.gz: 06ddb79761d667e5c894ed43af76481cd18a3728ddf9a5fa7dbe2fcb397173906a156caa30222baff4c3ce4adecc830f02d9649aea7d194c65de7be0560b0f01
-  data.tar.gz: eaba10548ca556d7cada7e59c5171d27d4539c0ba98fe18d780ac9bb4e4400daa13c486d2cdeba14034c96863e56d2430c543a57be0dd80ef9d7d130b1141b55
+  metadata.gz: fb6de489fbed7d6df7f3be17148e0eb8c3b0081c12b624cc128bb24e93f7633131b470072d417c875f5d4bb84868de49824f3df66dc8c1f34a9229411dd4b006
+  data.tar.gz: 854c978b2c48d5322d2b6be3ac30ed543fa25e4ef2b8b9ae81893bc47ec69c83ab3019604f844a6c7331cf6166ab8526f0f9c5e691f4eb786a4dd8013da5ecf1

data/.rubocop.yml

@@ -3,11 +3,12 @@
 # If you don't like these settings, just delete this file :)
 
 require:
+  - rubocop-performance
   - rubocop-rake
   - rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.1
   NewCops: enable
 
 Style/StringLiterals:

data/Gemfile

@@ -14,6 +14,7 @@ gem "rspec"
 
 # Linting code and docs
 gem "rubocop"
+gem "rubocop-performance"
 gem "rubocop-rake"
 gem "rubocop-rspec"
 gem "yard"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-gem_changes (0.0.3)
+    danger-gem_changes (0.0.5)
       danger-plugin-api (~> 1.0)
       nokogiri (~> 1.0)
 
@@ -80,11 +80,15 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.10)
     method_source (1.1.0)
+    mini_portile2 (2.8.6)
     nap (1.1.0)
     nenv (0.3.0)
     net-http (0.4.1)
       uri
     no_proxy_fix (0.1.2)
+    nokogiri (1.16.4)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
     nokogiri (1.16.4-arm64-darwin)
       racc (~> 1.4)
     notiffany (0.1.3)
@@ -148,6 +152,9 @@ GEM
       rubocop (~> 1.41)
     rubocop-factory_bot (2.25.1)
       rubocop (~> 1.41)
+    rubocop-performance (1.21.0)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
     rubocop-rspec (2.29.2)
@@ -184,6 +191,7 @@ DEPENDENCIES
   rake
   rspec
   rubocop
+  rubocop-performance
   rubocop-rake
   rubocop-rspec
   yard

data/README.md

@@ -1,15 +1,73 @@
 # danger-gem_changes
 
-A description of danger-gem_changes.
+This is a Danger plugin that can assist with reviews involving Gemfile
+dependency changes. It can display a helpful table with links to changelogs and
+diffs, and provides a DSL for evaluating changes to your depdencies.
 
 ## Installation
 
-    $ gem install danger-gem_changes
+```shell
+$ gem install danger-gem_changes
+```
 
 ## Usage
 
-    Methods and attributes from this plugin are available in
-    your `Dangerfile` under the `gem_changes` namespace.
+The following examples are changes to your Dangerfile.
+
+### Summary Table
+
+```ruby
+# Print a markdown table summarizing Gemfile.lock changes, if any.
+gem_changes.summarize_changes
+```
+
+> ### Gemfile.lock Changes
+> | Gem | Source | Changelog | Change | Version | Level |
+> | :-: | :----: | :-------: | :----: | :-----: | :---: |
+> | [rubocop-factory_bot](https://rubygems.org/gems/rubocop-factory_bot) | [Source](https://github.com/rubocop/rubocop-factory_bot) | [Changelog](https://github.com/rubocop/rubocop-factory_bot/blob/master/CHANGELOG.md) | Downgraded | [2.25.0 <- 2.25.1](https://github.com/rubocop/rubocop-factory_bot/compare/v2.25.0...v2.25.1) | Patch |
+> | [rubocop-performance](https://rubygems.org/gems/rubocop-performance) | [Source](https://github.com/rubocop/rubocop-performance) | [Changelog](https://github.com/rubocop/rubocop-performance/blob/master/CHANGELOG.md) | Added | 1.21.0 |  |
+> | [rubocop-rake](https://rubygems.org/gems/rubocop-rake) | [Source](https://github.com/rubocop/rubocop-rake) | [Changelog](https://github.com/rubocop/rubocop-rake/blob/master/CHANGELOG.md) | Upgraded | [0.5.0 -> 0.6.0](https://github.com/rubocop/rubocop-rake/compare/v0.5.0...v0.6.0) | Minor |
+> | [rubocop-rspec](https://rubygems.org/gems/rubocop-rspec) | [Source](https://github.com/rubocop/rubocop-rspec) | [Changelog](https://github.com/rubocop/rubocop-rspec/blob/master/CHANGELOG.md) | Removed | 2.29.2 |  |
+
+### Changes DSL
+
+This gem provides a DSL for accessing metadata about changes to your Gemfile dependencies:
+
+| Method | Description |
+| :----: | ----------- |
+| `changes` | All dependency changes |
+| `additions` | Dependencies that were not present before |
+| `removals` | Dependencies that are no longer present |
+| `upgrades` | Dependencies that have a newer version than before |
+| `downgrades` | Dependencies that have a lower version than before |
+
+Each dependency change has information about the gem and version change:
+
+| Method | Example |
+| :----: | ------- |
+| `gem.name` | `rubocop-rake` |
+| `from` | `0.6.0` |
+| `to` | `0.6.1` |
+| `change?` | `true` |
+| `addition?` | `false` |
+| `removal?` | `false` |
+| `upgrade?` | `true` |
+| `downgrade?` | `false` |
+
+The `from` attribute will be nil for additions, and `to` will be nil for removals.
+
+### More Examples
+
+```ruby
+# Print a warning if new dependencies were added.
+warn "Dependencies added" if gem_changes.additions.any?
+```
+
+```ruby
+# Print a table of dependency downgrades, if any
+downgrades = gem_changes.downgrades
+gem_changes.summarize_changes changes: downgrades, title: "Dependency Downgrades"
+```
 
 ## Development
 

data/danger-gem_changes.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.metadata["rubygems_mfa_required"] = "true"
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["issue_tracker_uri"] = "#{spec.homepage}/issues"
-  spec.required_ruby_version = ">= 2.7"
+  spec.required_ruby_version = ">= 3.1"
   spec.add_runtime_dependency "danger-plugin-api", "~> 1.0"
   spec.add_runtime_dependency "nokogiri", "~> 1.0"
 end

data/lib/danger_plugin.rb

@@ -26,13 +26,13 @@ module Danger
 
       string = "### #{title}\n"
 
-      string += GemChanges::SummaryTable.new(changes: changes).markdown
+      string += GemChanges::SummaryTable.new(changes:).markdown
 
       markdown string
     end
 
     def changes
-      GemChanges::Gemfile.changes(git: git)
+      GemChanges::Gemfile.changes(git:)
     end
 
     def additions

data/lib/gem_changes/change.rb

@@ -3,7 +3,7 @@
 module GemChanges
   Change = Struct.new(:gem, :from, :to, keyword_init: true) do
     def initialize(gem:, from:, to:)
-      super(gem: gem, from: Version(from), to: Version(to))
+      super(gem:, from: Version(from), to: Version(to))
     end
 
     def change?
@@ -26,6 +26,24 @@ module GemChanges
       change? and to < from
     end
 
+    def major?
+      change? &&
+        from.segments[0] && to.segments[0] &&
+        from.segments[0] != to.segments[0]
+    end
+
+    def minor?
+      change? && !major? &&
+        from.segments[1] && to.segments[1] &&
+        from.segments[1] != to.segments[1]
+    end
+
+    def patch?
+      change? && !major? && !minor? &&
+        from.segments[2] && to.segments[2] &&
+        from.segments[2] != to.segments[2]
+    end
+
     private
 
     def Version(something)

data/lib/gem_changes/gemfile.rb

@@ -2,8 +2,8 @@
 
 module GemChanges
   module Gemfile
-    REMOVAL_REGEX = /^-    ([^ ]*) \((.*)\)/.freeze
-    ADDITION_REGEX = /^\+    ([^ ]*) \((.*)\)/.freeze
+    REMOVAL_REGEX = /^-    ([^ ]*) \((.*)\)/
+    ADDITION_REGEX = /^\+    ([^ ]*) \((.*)\)/
 
     module_function def changes(git:)
       diff = git.diff_for_file("Gemfile.lock")
@@ -27,7 +27,7 @@ module GemChanges
       all_gems.map do |gem_name|
         gem = Gem.new(name: gem_name)
 
-        Change.new(gem: gem, from: removed[gem_name], to: added[gem_name])
+        Change.new(gem:, from: removed[gem_name], to: added[gem_name])
       end
     end
   end

data/lib/gem_changes/summary_table.rb

@@ -11,10 +11,10 @@ module GemChanges
     def markdown
       string = ""
 
-      string += "| Gem | Source | Changelog | Change |\n"
-      string += "| --- | ------ | --------- | ------ |\n"
+      string += "| Gem | Source | Changelog | Change | Version | Level |\n"
+      string += "| :-: | :----: | :-------: | :----: | :-----: | :---: |\n"
 
-      rows = changes.map { |change| Row.new(change: change) }
+      rows = changes.map { |change| Row.new(change:) }
 
       string += rows.map(&:markdown).join
 
@@ -36,7 +36,9 @@ module GemChanges
           rubygems_link,
           source_link,
           changelog_link,
-          change_link
+          change_description,
+          compare_link,
+          level
         ].join(" | ")
 
         string += " |\n"
@@ -44,6 +46,8 @@ module GemChanges
         string
       end
 
+      private
+
       def rubygems_link
         "[#{gem.name}](#{gem.rubygems_uri})"
       end
@@ -64,8 +68,20 @@ module GemChanges
         end
       end
 
-      def change_link
-        text = change_text
+      def change_description
+        if change.addition?
+          "Added"
+        elsif change.removal?
+          "Removed"
+        elsif change.upgrade?
+          "Upgraded"
+        elsif change.downgrade?
+          "Downgraded"
+        end
+      end
+
+      def compare_link
+        text = compare_text
         link = compare_uri
 
         if link
@@ -75,17 +91,15 @@ module GemChanges
         end
       end
 
-      private
-
-      def change_text
+      def compare_text
         if change.addition?
-          "Added at #{change.to}"
+          change.to
         elsif change.removal?
-          "Removed at #{change.from}"
+          change.from
         elsif change.upgrade?
-          "v#{change.from} -> v#{change.to}"
+          "#{change.from} -> #{change.to}"
         elsif change.downgrade?
-          "v#{change.to} <- v#{change.from}"
+          "#{change.to} <- #{change.from}"
         else
           fail "Unknown change type"
         end
@@ -98,6 +112,16 @@ module GemChanges
 
         "#{gem.source_code_uri}/compare/v#{from}...v#{to}"
       end
+
+      def level
+        if change.major?
+          "Major"
+        elsif change.minor?
+          "Minor"
+        elsif change.patch?
+          "Patch"
+        end
+      end
     end
   end
 end

data/lib/gem_changes/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GemChanges
-  VERSION = "0.0.3"
+  VERSION = "0.0.5"
 end

data/spec/fixtures/Gemfile.lock.patch

@@ -16,8 +16,8 @@ index eabec13..f4353d2 100644
 +    rubocop-performance (1.21.0)
 +      rubocop (>= 1.48.1, < 2.0)
 +      rubocop-ast (>= 1.31.1, < 2.0)
--    rubocop-rake (0.6.0)
-+    rubocop-rake (0.6.1)
+-    rubocop-rake (0.5.0)
++    rubocop-rake (0.6.0)
        rubocop (~> 1.0)
 -    rubocop-rspec (2.29.2)
 @@ -181,6 +184,7 @@ DEPENDENCIES

data/spec/fixtures/summary_table.markdown

@@ -0,0 +1,7 @@
+### Gemfile.lock Changes
+| Gem | Source | Changelog | Change | Version | Level |
+| :-: | :----: | :-------: | :----: | :-----: | :---: |
+| [rubocop-factory_bot](https://rubygems.org/gems/rubocop-factory_bot) | [Source](https://github.com/rubocop/rubocop-factory_bot) | [Changelog](https://github.com/rubocop/rubocop-factory_bot/blob/master/CHANGELOG.md) | Downgraded | [2.25.0 <- 2.25.1](https://github.com/rubocop/rubocop-factory_bot/compare/v2.25.0...v2.25.1) | Patch |
+| [rubocop-performance](https://rubygems.org/gems/rubocop-performance) | [Source](https://github.com/rubocop/rubocop-performance) | [Changelog](https://github.com/rubocop/rubocop-performance/blob/master/CHANGELOG.md) | Added | 1.21.0 |  |
+| [rubocop-rake](https://rubygems.org/gems/rubocop-rake) | [Source](https://github.com/rubocop/rubocop-rake) | [Changelog](https://github.com/rubocop/rubocop-rake/blob/master/CHANGELOG.md) | Upgraded | [0.5.0 -> 0.6.0](https://github.com/rubocop/rubocop-rake/compare/v0.5.0...v0.6.0) | Minor |
+| [rubocop-rspec](https://rubygems.org/gems/rubocop-rspec) | [Source](https://github.com/rubocop/rubocop-rspec) | [Changelog](https://github.com/rubocop/rubocop-rspec/blob/master/CHANGELOG.md) | Removed | 2.29.2 |  |

data/spec/gem_changes/change_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe GemChanges::Change do
+  let(:gem) { GemChanges::Gem.new(name: "bummr") }
+
+  describe "patch levels" do
+    let(:major) { described_class.new(gem:, from: "1.1.1", to: "2.1.1") }
+
+    let(:minor) { described_class.new(gem:, from: "1.1.1", to: "1.2.1") }
+
+    let(:patch) { described_class.new(gem:, from: "1.1.1", to: "1.1.2") }
+
+    describe "#major?" do
+      it "is true for major changes" do
+        expect(major).to be_major
+      end
+
+      it "is false for minor changes" do
+        expect(minor).not_to be_major
+      end
+
+      it "is false for patch changes" do
+        expect(patch).not_to be_major
+      end
+    end
+
+    describe "#minor?" do
+      it "is false for major changes" do
+        expect(major).not_to be_minor
+      end
+
+      it "is true for minor changes" do
+        expect(minor).to be_minor
+      end
+
+      it "is false for patch changes" do
+        expect(patch).not_to be_minor
+      end
+    end
+
+    describe "#patch?" do
+      it "is false for major changes" do
+        expect(major).not_to be_patch
+      end
+
+      it "is false for minor changes" do
+        expect(minor).not_to be_patch
+      end
+
+      it "is true for patch changes" do
+        expect(patch).to be_patch
+      end
+    end
+  end
+end

data/spec/gem_changes_spec.rb

@@ -66,8 +66,8 @@ module Danger
           [
             GemChanges::Change.new(
               gem: GemChanges::Gem.new(name: "rubocop-rake"),
-              from: "0.6.0",
-              to: "0.6.1"
+              from: "0.5.0",
+              to: "0.6.0"
             )
           ]
         )
@@ -90,17 +90,11 @@ module Danger
       it "can generate a markdown table" do
         @my_plugin.summarize_changes
 
-        markdown = @dangerfile.status_report[:markdowns].last.message
-
-        expect(markdown).to eq(<<~MARKDOWN)
-          ### Gemfile.lock Changes
-          | Gem | Source | Changelog | Change |
-          | --- | ------ | --------- | ------ |
-          | [rubocop-factory_bot](https://rubygems.org/gems/rubocop-factory_bot) | [Source](https://github.com/rubocop/rubocop-factory_bot) | [Changelog](https://github.com/rubocop/rubocop-factory_bot/blob/master/CHANGELOG.md) | [v2.25.0 <- v2.25.1](https://github.com/rubocop/rubocop-factory_bot/compare/v2.25.0...v2.25.1) |
-          | [rubocop-performance](https://rubygems.org/gems/rubocop-performance) | [Source](https://github.com/rubocop/rubocop-performance) | [Changelog](https://github.com/rubocop/rubocop-performance/blob/master/CHANGELOG.md) | Added at 1.21.0 |
-          | [rubocop-rake](https://rubygems.org/gems/rubocop-rake) | [Source](https://github.com/rubocop/rubocop-rake) | [Changelog](https://github.com/rubocop/rubocop-rake/blob/master/CHANGELOG.md) | [v0.6.0 -> v0.6.1](https://github.com/rubocop/rubocop-rake/compare/v0.6.0...v0.6.1) |
-          | [rubocop-rspec](https://rubygems.org/gems/rubocop-rspec) | [Source](https://github.com/rubocop/rubocop-rspec) | [Changelog](https://github.com/rubocop/rubocop-rspec/blob/master/CHANGELOG.md) | Removed at 2.29.2 |
-        MARKDOWN
+        actual = @dangerfile.status_report[:markdowns].last.message
+
+        expected = File.read("spec/fixtures/summary_table.markdown")
+
+        expect(actual).to eq(expected)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-gem_changes
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - John DeSilva
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-12 00:00:00.000000000 Z
+date: 2024-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -47,7 +47,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -63,6 +62,8 @@ files:
 - lib/gem_changes/summary_table.rb
 - lib/gem_changes/version.rb
 - spec/fixtures/Gemfile.lock.patch
+- spec/fixtures/summary_table.markdown
+- spec/gem_changes/change_spec.rb
 - spec/gem_changes_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Aesthetikx/danger-gem_changes
@@ -80,7 +81,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.travis.yml

@@ -1,10 +0,0 @@
-language: ruby
-cache:
-  directories:
-    - bundle
-
-rvm:
-  - 2.7
-
-script:
-    - bundle exec rake spec