gem-compare 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c044164ee56748354c54ebf233e953fcb35f2f3d8066c4ea6890d3ad30ea7d4
-  data.tar.gz: 6904897ef13bb77558dd451c120288a1454e5806a5de72ea5fc779bba5298392
+  metadata.gz: 0caaeffb3233009f5be958ac76e97a0f1f30ff83b9029833f83129ccfb682885
+  data.tar.gz: 40747fe01a1698f048dc67e98b7d28f2a0d52cd9c9f37badeba47ea2bf8f2e3e
 SHA512:
-  metadata.gz: e331da083741102852183767b231fddfe7d26d39ee4d7a5c6e2cac1ba3723841deb56d7f10f91e6864f37a4a9da8ef9363375c61a93d63ff2031e21f98da67f3
-  data.tar.gz: 5792b1420f20a15cf65d7d8dc6009e0381add33ee9a606cea928fe3d27d4f02dca1f7ea21fe91b49292809ad9414190a8f78221c56ba040218e1ccd3e1e2a6cf
+  metadata.gz: 449146838c58824fb8c9a74b357a2d51ee9f90dc69a10c7e40c8cc859562accb90946114c7c090a93122d4573b9ab8ef7cc175f9543e65c5d61d9361039d97bc
+  data.tar.gz: 60a07492868fbbe221089b1cb5afe3887e9f7e47f3aeafe72c72271aaf6c9e30f2fbd99560bbc999194b040ab34d19c33d01652c8da2fc22a7e496cd8695c946

data/README.md

@@ -1,6 +1,6 @@
 # gem-compare
 
-*gem-compare* is a RubyGems plugin that compares different versions of the specified gem. It can help you to track changes in metadata through the time, see how dependencies were evolving and spot important changes in gem's files such as shebang or permissions modifications.
+gem-compare is a RubyGems plugin that compares different versions of the specified gem. It can help you to track changes in metadata through the time, see how dependencies were evolving and spot important changes in gem's files such as shebang or permissions modifications.
 
 This is especially handy for:
 
@@ -20,7 +20,7 @@ $ gem install gem-compare
 
 By default, `gem-compare` compares specified versions of the given gem and includes only changes in the final report. If it's supposed to compare file lists or Gemfiles it will need to download the gems, otherwise it just downloads the specs. If you want to keep the downloaded `.gem` files, use `-k` (as 'keep') option. If you want to see the full report use `-a` (as 'all') switch:
 
-```
+```bash
 $ gem compare rails 3.0.0 4.0.0 -k
 Compared versions: ["3.0.0", "4.0.0"]
   DIFFERENT date:
@@ -63,7 +63,7 @@ Compared versions: ["3.0.0", "4.0.0"]
 
 You can also specify what you are interested in by using -p (as 'param') option:
 
-```
+```bash
 $ gem compare activesupport 4.0.0 4.1.0 -p 'runtime_dependency'
 Compared versions: ["4.0.0", "4.1.0"]
   DIFFERENT runtime dependencies:
@@ -79,7 +79,7 @@ Compared versions: ["4.0.0", "4.1.0"]
 ```
 There are also shortcuts for favourite options. Use `--runtime` for runtime dependencies, `--gemfiles` for comparing Gemfiles or `--files` for comparing file lists:
 
-```
+```bash
 $ gem compare rails 2.0.1 3.0.0 -k --files
 Compared versions: ["2.0.1", "3.0.0"]
   DIFFERENT files:
@@ -107,7 +107,7 @@ Compared versions: ["2.0.1", "3.0.0"]
 
 If you would like to see all development dependencies for `prawn` since `0.1` version, let *gem-compare* expand the versions for you (`>=0.0` won't work as RubyGems asks for the latest spec only):
 
-```
+```bash
 $ gem compare prawn '>=0.1' -k -a --development
 Compared versions: ["0.1.0", "0.1.1", "0.1.2", "0.2.0", "0.2.1", "0.2.2", "0.2.3", "0.3.0", "0.4.0", "0.4.1", "0.5.0.1", "0.5.1", "0.6.1", "0.6.2", "0.6.3", "0.7.1", "0.7.2", "0.8.4", "0.11.1", "0.12.0", "0.13.0", "0.13.1", "0.13.2", "0.14.0", "0.15.0", "1.0.0", "1.1.0"]
   DIFFERENT development dependencies:
@@ -140,7 +140,8 @@ Compared versions: ["0.1.0", "0.1.1", "0.1.2", "0.2.0", "0.2.1", "0.2.2", "0.2.3
 
 *gem-compare* supports querying different gem platforms via standard `--platform` option. To compare
 nokogiri gem on different platform run:
-```
+
+```bash
 $ gem compare nokogiri 1.5.6 1.6.1 -ak --platform java # for JRuby
 $ gem compare nokogiri 1.5.6 1.6.1 -ak --platform x86-mingw32 # on Windows
 ```
@@ -154,7 +155,8 @@ If you run your own gem source server, you can override the RubyGems.org default
 ### Supported options
 
 To see all possible options run:
-```
+
+```bash
 $ gem compare --help
 ```
 

data/lib/rubygems/commands/compare_command.rb

@@ -24,7 +24,7 @@ class Gem::Commands::CompareCommand < Gem::Command
     # Speficy the platform using --platform=PLATFORM
     add_platform_option
 
-    add_option('-pPARAM', '--param PARAM', 'Compare only a given paramater') do |param, options|
+    add_option('-pPARAM', '--param PARAM', 'Compare only a given gemspec parameter (like "version")') do |param, options|
       options[:param] = param
     end
 

data/lib/rubygems/comparator/dir_utils.rb

@@ -19,10 +19,6 @@ class Gem::Comparator
       file_first_line(file1) == file_first_line(file2)
     end
 
-    def self.file_permissions(file)
-      sprintf("%o", File.stat(file).mode)
-    end
-
     def self.gem_bin_file?(file)
       file =~ /(\A|.*\/)bin\/.*/
     end
@@ -50,4 +46,4 @@ class Gem::Comparator
       dirs
     end
   end
-end
+end

data/lib/rubygems/comparator/file_list_comparator.rb

@@ -15,7 +15,7 @@ class Gem::Comparator
 
   class FileListComparator < Gem::Comparator::Base
 
-    def initialize
+    def initialize(ignore_group_writable=true)
       expect(:packages)
 
       # We need diff
@@ -24,6 +24,8 @@ class Gem::Comparator
       rescue Exception
         error('Calling `diff` command failed. Do you have it installed?')
       end
+
+      @ignore_group_writable = ignore_group_writable
     end
 
     ##
@@ -77,7 +79,7 @@ class Gem::Comparator
             end
           end
           # Add information about permissions, shebangs etc.
-          report = check_added_files(param, vers, index, added, report, options[:brief])
+          report = check_added_files(param, vers, index, added, report, options[:brief], options[:diff])
 
           report[param][vers]['changed'].set_header '* Changed:'
           report = check_same_files(param, vers, index, same, report, options[:brief], options[:diff])
@@ -127,18 +129,27 @@ class Gem::Comparator
         [deleted, added]
       end
 
-      def check_added_files(param, vers, index, files, report, brief_mode)
+      def check_added_files(param, vers, index, files, report, brief_mode, diff_mode)
         files.each do |file|
           added_file = File.join(unpacked_gem_dirs[@packages[index].spec.version], file)
 
-          #line_changes = lines_changed(prev_file, curr_file)
+          line_changes = if diff_mode
+            Monitor.files_diff(nil, added_file)
+          else
+            Monitor.lines_changed(nil, added_file)
+          end
 
-          changes = Monitor.new_file_permissions(added_file),
+          changes = Monitor.new_file_permissions(added_file, @ignore_group_writable),
                     Monitor.new_file_executability(added_file),
                     Monitor.new_file_shebang(added_file)
 
-          if(!changes.join.empty? || !brief_mode)
-            report[param][vers]['added'] << "#{file}"
+          if(!changes.join.empty? || (!brief_mode && !line_changes.empty?))
+            if diff_mode
+              report[param][vers]['added'][file].set_header file
+              report[param][vers]['added'][file] << line_changes.split("\n")
+            else
+              report[param][vers]['added'] << "#{file} #{line_changes}"
+            end
           end
 
           changes.each do |change|
@@ -161,7 +172,7 @@ class Gem::Comparator
             Monitor.lines_changed(prev_file, curr_file)
           end
 
-          changes = Monitor.files_permissions_changes(prev_file, curr_file),
+          changes = Monitor.files_permissions_changes(prev_file, curr_file, @ignore_group_writable),
                     Monitor.files_executability_changes(prev_file, curr_file),
                     Monitor.files_shebang_changes(prev_file, curr_file)
 

data/lib/rubygems/comparator/monitor.rb

@@ -14,6 +14,7 @@ class Gem::Comparator
     end
 
     def self.compact_files_diff(prev_file, curr_file)
+      prev_file = prev_file.nil? ? Tempfile.new.path : prev_file
       changes = ''
       Diffy::Diff.new(
         prev_file, curr_file, :source => 'files', :context => 0
@@ -27,6 +28,7 @@ class Gem::Comparator
     end
 
     def self.files_diff(prev_file, curr_file)
+      prev_file = prev_file.nil? ? Tempfile.new.path : prev_file
       changes = ''
       Diffy::Diff.new(
         prev_file, curr_file, :source => 'files', :context => 0, :include_diff_info => true
@@ -40,25 +42,30 @@ class Gem::Comparator
       changes
     end
 
-    def self.files_permissions_changes(prev_file, curr_file)
-      prev_permissions = DirUtils.file_permissions(prev_file)
-      curr_permissions = DirUtils.file_permissions(curr_file)
+    def self.files_permissions_changes(prev_file, curr_file, ignore_group_writable=false)
+      prev_permissions = File.stat(prev_file).mode
+      curr_permissions = File.stat(curr_file).mode
 
-      if prev_permissions != curr_permissions
+      diff = prev_permissions ^ curr_permissions
+      diff ^= 020 if ignore_group_writable
+
+      if diff != 0
         "  (!) New permissions: " +
-        "#{prev_permissions} -> #{curr_permissions}"
+        "#{format_permissions(prev_permissions)} -> #{format_permissions(curr_permissions)}"
       else
         ''
       end
     end
 
-    def self.new_file_permissions(file)
-      file_permissions = DirUtils.file_permissions(file)
+    def self.new_file_permissions(file, ignore_group_writable=false)
+      file_permissions = File.stat(file).mode
+      formatted_file_permissions = format_permissions(file_permissions)
 
-      if file_permissions != '100644'
-        unless (DirUtils.gem_bin_file?(file) && file_permissions == '100755')
-          return "  (!) Unexpected permissions: #{file_permissions}"
-        end
+      file_permissions ^= 020 if ignore_group_writable
+
+      unless file_permissions == 0100644 || \
+          (DirUtils.gem_bin_file?(file) && file_permissions == 0100755)
+        return "  (!) Unexpected permissions: #{formatted_file_permissions}"
       end
       ''
     end
@@ -115,5 +122,9 @@ class Gem::Comparator
         ''
       end
     end
+
+    def self.format_permissions(permissions)
+      sprintf("%o", permissions)
+    end
   end
 end

data/lib/rubygems/comparator/report.rb

@@ -104,7 +104,7 @@ class Gem::Comparator
       end
 
       def lines(line_num)
-        all_messages[line_num].data
+        all_messages[line_num]&.data
       end
 
       def nested_messages

data/lib/rubygems/comparator/utils.rb

@@ -19,7 +19,6 @@ class Gem::Comparator
                       email
                       executables
                       extensions
-                      has_rdoc
                       homepage
                       license
                       licenses

data/lib/rubygems/comparator/version.rb

@@ -1,3 +1,3 @@
 class Gem::Comparator
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/test/rubygems/comparator/test_dir_utils.rb

@@ -7,14 +7,14 @@ class TestDirUtils < TestGemModule
     file2 = File.join(@v002, 'bin/lorem')
     file3 = File.join(@v003, 'bin/lorem')
     assert_equal 'require "lorem/version"', Gem::Comparator::DirUtils.file_first_line(file1)
-    assert_equal nil, Gem::Comparator::DirUtils.file_first_line(file2)
+    assert_nil Gem::Comparator::DirUtils.file_first_line(file2)
     assert_equal '#!/usr/bin/ruby', Gem::Comparator::DirUtils.file_first_line(file3)
   end
 
   def test_file_has_shebang?
     file1 = File.join(@v003, 'lib/lorem.rb')
     file2 = File.join(@v004, 'bin/lorem')
-    assert_equal nil, Gem::Comparator::DirUtils.file_has_shebang?(file1)
+    assert_nil Gem::Comparator::DirUtils.file_has_shebang?(file1)
     assert_equal 0, Gem::Comparator::DirUtils.file_has_shebang?(file2)
   end
 
@@ -26,17 +26,10 @@ class TestDirUtils < TestGemModule
     assert_equal false, Gem::Comparator::DirUtils.files_same_first_line?(file1, file3)
   end
 
-  def test_file_permissions
-    file1 = File.join(@v001, 'lib/lorem.rb')
-    file2 = File.join(@v004, 'bin/lorem')
-    assert_equal '100664', Gem::Comparator::DirUtils.file_permissions(file1)
-    assert_equal '100775', Gem::Comparator::DirUtils.file_permissions(file2)
-  end
-
   def test_gem_bin_file
     file1 = File.join(@v001, 'lib/lorem.rb')
     file2 = File.join(@v004, 'bin/lorem')
-    assert_equal nil, Gem::Comparator::DirUtils.gem_bin_file?(file1)
+    assert_nil Gem::Comparator::DirUtils.gem_bin_file?(file1)
     assert_equal 0, Gem::Comparator::DirUtils.gem_bin_file?(file2)
   end
 

data/test/rubygems/comparator/test_file_list_comparator.rb

@@ -5,13 +5,14 @@ class TestFileListComparator < TestGemComparator
   def test_files_comparison
     assert_equal 'DIFFERENT files:', @report['files'].header.data
     assert_equal '0.0.1->0.0.2:', @report['files'].lines(1)
-    assert_equal "CHANGELOG.md", @report['files']['0.0.1->0.0.2']['added'].lines(1)
+    assert_equal "CHANGELOG.md +6/-0", @report['files']['0.0.1->0.0.2']['added'].lines(1)
     assert_equal [], @report['files']['0.0.1->0.0.2']['deleted'].messages
     assert_equal [], @report['files']['0.0.1->0.0.2']['updated'].messages
-    assert_equal "bin/lorem", @report['files']['0.0.2->0.0.3']['added'].lines(1)
-    assert_equal "(!) Unexpected permissions: 100664", @report['files']['0.0.2->0.0.3']['added'].lines(2).strip
-    assert_equal "(!) File is not executable", @report['files']['0.0.2->0.0.3']['added'].lines(3).strip
-    assert_equal "(!) Shebang found: #!/usr/bin/ruby", @report['files']['0.0.2->0.0.3']['added'].lines(4).strip
+    assert_equal "bin/lorem +3/-0", @report['files']['0.0.2->0.0.3']['added'].lines(1)
+    assert_equal "(!) File is not executable", @report['files']['0.0.2->0.0.3']['added'].lines(2).strip
+    assert_equal "(!) Shebang found: #!/usr/bin/ruby", @report['files']['0.0.2->0.0.3']['added'].lines(3).strip
+    assert_equal "lib/lorem/utils.rb +7/-0", @report['files']['0.0.2->0.0.3']['added'].lines(4).strip
+    assert_nil @report['files']['0.0.2->0.0.3']['added'].lines(6)
     assert_equal [], @report['files']['0.0.2->0.0.3']['deleted'].messages
     assert_equal [], @report['files']['0.0.2->0.0.3']['updated'].messages
     assert_equal [], @report['files']['0.0.3->0.0.4']['added'].messages

data/test/rubygems/comparator/test_monitor.rb

@@ -14,18 +14,35 @@ class TestMonitor < TestGemModule
     assert_equal '++++', Gem::Comparator::Monitor.compact_files_diff(file1, file2)
   end
 
+  def test_files_added_diff
+    file1 = nil
+    file2 = File.join(@v003, 'lib/lorem/utils.rb')
+    diff = Gem::Comparator::Monitor.files_diff(file1, file2)
+    expected_diff = <<~EOF
+      @@ -0,0 +1,7 @@
+      +def check_something
+      +
+      +end
+      +
+      +def make_something
+      +
+      +end
+    EOF
+    assert_equal expected_diff, diff.split(/\n/, 3)[2]
+  end
+
   def test_files_diff
-    Rainbow.enabled = false
     file1 = File.join(@v001, 'lib/lorem.rb')
     file2 = File.join(@v002, 'lib/lorem.rb')
     diff = Gem::Comparator::Monitor.files_diff(file1, file2)
-    assert_equal diff.split(/\n/, 3)[2], <<~EOF
+    expected_diff = <<~EOF
       @@ -6,0 +7,4 @@
       +
       +  def new_method
       +    raise 'needs to be implemented'
       +  end
     EOF
+    assert_equal expected_diff, diff.split(/\n/, 3)[2]
   end
 
   def test_files_permissions_changes
@@ -34,6 +51,45 @@ class TestMonitor < TestGemModule
     assert_equal '(!) New permissions: 100664 -> 100775', Gem::Comparator::Monitor.files_permissions_changes(file1, file2).strip 
   end
 
+  def test_files_permissions_changes_ignores_group_writable_added
+    file1 = Tempfile.new
+    file2 = Tempfile.new
+    begin
+      File.chmod(0644, file1)
+      File.chmod(0664, file2)
+      assert_equal '', Gem::Comparator::Monitor.files_permissions_changes(file1.path, file2.path, true)
+    ensure
+      file1.unlink
+      file2.unlink
+    end
+  end
+
+  def test_files_permissions_changes_ignores_group_writable_other_changes
+    file1 = Tempfile.new
+    file2 = Tempfile.new
+    begin
+      File.chmod(0644, file1)
+      File.chmod(0660, file2)
+      assert_equal '  (!) New permissions: 100644 -> 100660', Gem::Comparator::Monitor.files_permissions_changes(file1.path, file2.path, true)
+    ensure
+      file1.unlink
+      file2.unlink
+    end
+  end
+
+  def test_files_permissions_changes_ignores_group_writable_removed
+    file1 = Tempfile.new
+    file2 = Tempfile.new
+    begin
+      File.chmod(0664, file1)
+      File.chmod(0644, file2)
+      assert_equal '', Gem::Comparator::Monitor.files_permissions_changes(file1.path, file2.path, true)
+    ensure
+      file1.unlink
+      file2.unlink
+    end
+  end
+
   def test_new_file_permissions
     file1 = File.join(@v004, 'bin/lorem')
     file2 = File.join(@v004, 'lib/lorem.rb')
@@ -41,6 +97,26 @@ class TestMonitor < TestGemModule
     assert_equal '(!) Unexpected permissions: 100664', Gem::Comparator::Monitor.new_file_permissions(file2).strip 
   end
 
+  def test_new_file_permissions_ignore_group_writable
+    file = Tempfile.new
+    begin
+      File.chmod(0664, file)
+      assert_equal '', Gem::Comparator::Monitor.new_file_permissions(file, true)
+    ensure
+      file.unlink
+    end
+  end
+
+  def test_new_file_permissions_ignore_group_writable_unreadable
+    file = Tempfile.new
+    begin
+      File.chmod(0660, file)
+      assert_equal '  (!) Unexpected permissions: 100660', Gem::Comparator::Monitor.new_file_permissions(file.path, true)
+    ensure
+      file.unlink
+    end
+  end
+
   def test_files_executability_changes
     file1 = File.join(@v003, 'bin/lorem')
     file2 = File.join(@v004, 'bin/lorem')

data/test/rubygems/comparator/test_spec_comparator.rb

@@ -140,11 +140,6 @@ class TestSpecComparator < TestGemComparator
     assert_equal 'SAME signing_key:', @report['signing_key'].lines(0)
   end
   
-  def test_has_rdoc_comparison
-    assert_equal 'SAME has_rdoc:', @report['has_rdoc'].header.data
-    assert_equal 'SAME has_rdoc:', @report['has_rdoc'].lines(0)
-  end
-  
   def test_date_comparison
     assert_equal 'SAME date:', @report['date'].header.data
     assert_equal 'SAME date:', @report['date'].lines(0)

data/test/test_helper.rb

@@ -1,10 +1,22 @@
 require 'minitest/autorun'
 require 'rubygems/comparator'
 
+# The tests expects these permissions, which isn't the case if you have
+# umask 022 when cloning the repo
+def setup_file_permissions
+  gemfiles_path = File.expand_path('gemfiles', File.dirname(__FILE__))
+  File.chmod(0664, File.join(gemfiles_path, 'lorem-0.0.1', 'lib', 'lorem.rb'))
+  File.chmod(0664, File.join(gemfiles_path, 'lorem-0.0.3', 'bin', 'lorem'))
+  File.chmod(0664, File.join(gemfiles_path, 'lorem-0.0.4', 'lib', 'lorem.rb'))
+  File.chmod(0775, File.join(gemfiles_path, 'lorem-0.0.4', 'bin', 'lorem'))
+end
+
 class TestGemComparator < Minitest::Test
   def setup
     super
 
+    setup_file_permissions
+
     options = { keep_all: true, log_all: true, no_color: true, brief_mode: false }
     versions = ['0.0.1', '0.0.2', '0.0.3', '0.0.4']
 
@@ -22,6 +34,8 @@ end
 class TestGemModule < Minitest::Test
   def setup
     super
+    Rainbow.enabled = false
+    setup_file_permissions
     gemfiles_path = File.expand_path('gemfiles', File.dirname(__FILE__))
     @v001 = File.join(gemfiles_path, 'lorem-0.0.1')
     @v002 = File.join(gemfiles_path, 'lorem-0.0.2')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem-compare
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Josef Stribny
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 2022-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 3.0.0
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: RubyGems plugin for comparing gem versions