danger-gem_changes 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3391e9592f6b4fbac7f4d3e17a3b0acc207020da5ebe9427f2f440f26cb3d2ab
-  data.tar.gz: 95c5d5e123ce639e16181fb3c3bd81cc8a1147475fb6bf354d3a3fc5528ff04f
+  metadata.gz: 1fa9c080dfc155ec38268174f825848bff64fbbe2e752be5f142d18086c887cd
+  data.tar.gz: 04b94a88454a9ae93127adb8ad4322a65c7b17dc0af75f39a4ee8ed711d7b0fb
 SHA512:
-  metadata.gz: f6a11521f18156c2040ef794065ebb68d1b5b99d67c77ad0cdb8965f8bc02501ed386092f141a05308128a8a3836184e862468652cb955540a6473118c6f0335
-  data.tar.gz: 23ac060a030371ec40cebd8076b6a94adf4b45f14f16597bc6b8dd39aa46e5ac272ed56268bc4d94a97c3d96af4930d49fe54e3d892a6a73752ff6af9a00f6ee
+  metadata.gz: a60b5ce13398d355fd17b9ce5c7c6ea21386843d4582aa11b7b218e3cac5ab7d08a1b1cbeafe8101635bb43d443ad187700157fb97b4e29e32ef172e0e27b7b7
+  data.tar.gz: 1f01989b792ae9f1ff4dc6f683ee4cf3ca372ab8e1e71f029a82faf12d47ca4318fe98fe48c200530e041345becf39655c60596dfc81b76bff0cf27faaee1d75

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-gem_changes (0.0.5)
+    danger-gem_changes (0.0.7)
       danger-plugin-api (~> 1.0)
       nokogiri (~> 1.0)
 

data/lib/danger_plugin.rb

@@ -3,24 +3,18 @@
 require "gem_changes"
 
 module Danger
-  # This is your plugin class. Any attributes or methods you expose here will
-  # be available from within your Dangerfile.
+  # A Danger plugin that can help code review for PRs that have changes to Gemfile.lock.
   #
-  # To be published on the Danger plugins site, you will need to have
-  # the public interface documented. Danger uses [YARD](http://yardoc.org/)
-  # for generating documentation from your plugin source, and you can verify
-  # by running `danger plugins lint` or `bundle exec rake spec`.
+  # @example Print a markdown table summarizing all gem dependency changes
   #
-  # You should replace these comments with a public description of your library.
-  #
-  # @example Ensure people are well warned about merging on Mondays
-  #
-  #          my_plugin.warn_on_mondays
-  #
-  # @see  Aesthetikx/danger-gems
-  # @tags monday, weekends, time, rattata
+  #          gem_changes.summarize_changes
   #
+  # @see Aesthetikx/danger-gem_changes
   class DangerGemChanges < Plugin
+    # Print a summary of the changes to the Gemfile.lock.
+    # @param changes [Array<GemChanges::Change>] An optional list of changes to summarize, defaulting to all changes.
+    # @param title [String] An optional title for the header.
+    # @return [void]
     def summarize_changes(changes: self.changes, title: "Gemfile.lock Changes")
       return if changes.empty?
 
@@ -31,22 +25,32 @@ module Danger
       markdown string
     end
 
+    # All dependencies that have changed.
+    # @return [Array<GemChanges::Change>]
     def changes
       GemChanges::Gemfile.changes(git:)
     end
 
+    # New dependencies that have been added.
+    # @return [Array<GemChanges::Change>]
     def additions
       changes.select(&:addition?)
     end
 
+    # Dependencies that have been removed.
+    # @return [Array<GemChanges::Change>]
     def removals
       changes.select(&:removal?)
     end
 
+    # Dependencies that were upgraded.
+    # @return [Array<GemChanges::Change>]
     def upgrades
       changes.select(&:upgrade?)
     end
 
+    # Dependencies that were downgraded.
+    # @return [Array<GemChanges::Change>]
     def downgrades
       changes.select(&:downgrade?)
     end

data/lib/gem_changes/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: danger-gem_changes
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - John DeSilva