gem-compare 0.0.2 → 0.0.3

data/lib/rubygems/comparator/report.rb

@@ -1,12 +1,43 @@
+require 'rubygems/comparator/report/entry'
+
 class Gem::Comparator
+
+  ##
+  # Gem::Comparator::Report can nest sections and print only those that
+  # contain some messages.
+  #
+  # Usage:
+  #   report = Gem::Comparator::Report.new
+  #   report['section1'] << "Message 1"
+  #   report['section1']['subsection1'].set_header 'Message 2 Header'
+  #   report['section1']['subsection1'] << "Message 2" if false
+  #   report['section1'].section
+  #     nest('subsection2').section
+  #       puts "Message 3"
+  #     end
+  #   end
+  #   report.print
+  #
+  # This won't print Message 2 nor its header saving a lot of if/else.
+
   class Report
 
+    module Signs
+      def same
+        Rainbow('SAME').green.bright
+      end
+
+      def different
+        Rainbow('DIFFERENT').red.bright
+      end
+    end
+
     def self.new(name = 'main')
       Gem::Comparator::Report::NestedSection.new(name)
     end
 
     class NestedSection
-      include Gem::Comparator::Base
+      include Report::Signs
       include Gem::UserInteraction
 
       DEFAULT_INDENT = '  '
@@ -33,12 +64,19 @@ class Gem::Comparator
       end
 
       def puts(message)
-        @messages << Entry.new(message)
+        case message
+        when String, Array
+          @messages << Entry.new(message) unless message.empty?
+        else
+          @messages << Entry.new(message) unless message
+        end
       end
       alias_method :<<, :puts
 
       def nest(name)
-        @sections.each { |s| if s.name == name; return s; end }
+        @sections.each do |s|
+          return s if s.name == name
+        end
         NestedSection.new(name, self)
       end
       alias_method :[], :nest
@@ -51,16 +89,20 @@ class Gem::Comparator
         indent = DEFAULT_INDENT*@level
 
         if @header.empty?
-          @messages.map { |m| m.set_indent!(indent) } + nested_messages
+          @messages.map do |m|
+            m.set_indent!(indent)
+          end + nested_messages
         else
-          nested = @messages.map { |m| m.set_indent!(indent * 2) } + nested_messages
+          nested = @messages.map do |m|
+            m.set_indent!(indent * 2)
+          end + nested_messages
           return [] if nested.empty?
 
           @header.set_indent!(indent)
           nested.unshift(@header)
         end
       end
-      
+
       def lines(line_num)
         all_messages[line_num].data
       end
@@ -84,38 +126,5 @@ class Gem::Comparator
         end
 
     end
-
-    class Entry
-      include Gem::UserInteraction
-
-      attr_accessor :data, :indent
-
-      def initialize(data = '', indent = '')
-        @data = data
-        @indent = indent
-      end
-
-      def set_indent!(indent)
-        @indent = indent
-        self
-      end
-
-      def empty?
-        case @data
-        when String, Array
-          @data.empty?
-        end
-      end
-
-      def print
-        printed = case @data
-                  when String
-                    "#{@indent}#{@data}"
-                  when Array
-                    @indent + @data.join("\n#{@indent}")
-                  end
-        say printed
-      end
-    end
   end
 end

data/lib/rubygems/comparator/report/entry.rb

@@ -0,0 +1,38 @@
+class Gem::Comparator
+  class Report
+    class Entry
+      include Gem::UserInteraction
+
+      attr_accessor :data, :indent
+
+      def initialize(data = '', indent = '')
+        @data = data
+        @indent = indent
+      end
+
+      def set_indent!(indent)
+        @indent = indent
+        self
+      end
+
+      def empty?
+        case @data
+        when String, Array
+          @data.empty?
+        end
+      end
+
+      def print
+        printed = case @data
+                  when String
+                    "#{@indent}#{@data}"
+                  when Array
+                    @indent + @data.join("\n#{@indent}")
+                  else
+                    "#{@indent}#{@data}"
+                  end
+        say printed
+      end
+    end
+  end
+end

data/lib/rubygems/comparator/spec_comparator.rb

@@ -5,27 +5,25 @@ class Gem::Comparator
   ##
   # Gem::Comparator::SpecComparator can
   # compare values from the gem verions specs
-  
-  class SpecComparator
-    include Gem::Comparator::Base
 
-    COMPARES = :specs
+  class SpecComparator < Gem::Comparator::Base
 
     ##
     # Compare common fields in spec
 
     def compare(specs, report, options = {})
       info 'Checking spec parameters...'
+      p = options[:param]
+      b = options[:brief]
 
-      filter_params(SPEC_PARAMS, options[:param]).each do |param|
+      filter_params(SPEC_PARAMS, p, b).each do |param|
         values = values_from_specs(param, specs)
 
-        # Are values the same?
         if same_values?(values) && options[:log_all]
-          v = value(values[0]) 
+          v = value(values[0])
           report[param].section do
-            set_header "#{same} #{param}:"
-	        puts v
+            set_header "#{self.same} #{param}:"
+	    puts v
           end
         elsif !same_values?(values)
           report[param].set_header "#{different} #{param}:"
@@ -40,28 +38,17 @@ class Gem::Comparator
 
     private
 
-      def values_from_specs(param, specs)
-        values = []
-        specs.each do |s|
-          if s.respond_to? :"#{param}"
-            values << s.send(:"#{param}")
-          else
-            warn "#{s.full_name} does not respond to " +
-                 "#{param}, skipping check"
-          end
-        end
-        values
-      end
-
       def value(value)
         case value
         when Gem::Requirement
           unless value.requirements.empty?
             r = value.requirements[0]
-            "#{r[0]} #{r[1].version} " 
+            "#{r[0]} #{r[1].version} "
           else
             '[]'
           end
+        when Gem::Platform
+          value.to_s
         when String
           return value unless value.empty?
           ''

data/lib/rubygems/comparator/utils.rb

@@ -0,0 +1,133 @@
+require 'rainbow'
+require 'rubygems'
+require 'rubygems/user_interaction'
+
+class Gem::Comparator
+  module Utils
+    include Gem::UserInteraction
+
+    SPACE = ' '
+    DEFAULT_INDENT = SPACE*7
+    OPERATORS = ['=', '!=', '>', '<', '>=', '<=', '~>']
+    VERSION_REGEX = /\A(\d+\.){0,}\d+(\.[a-zA-Z]+\d{0,1}){0,1}\z/
+    SPEC_PARAMS = %w[ author
+                      authors
+                      bindir
+                      cert_chain
+                      date
+                      description
+                      email
+                      executables
+                      extensions
+                      has_rdoc
+                      homepage
+                      license
+                      licenses
+                      metadata
+                      name
+                      platform
+                      post_install_message
+                      rdoc_options
+                      require_paths
+                      required_ruby_version
+                      required_rubygems_version
+                      requirements
+                      rubygems_version
+                      signing_key
+                      summary
+                      version ]
+    SPEC_FILES_PARAMS = %w[ files
+                            test_files
+                            extra_rdoc_files ]
+    DEPENDENCY_PARAMS = %w[ runtime_dependency
+                            development_dependency ]
+    GEMFILE_PARAMS = %w[ gemfiles ]
+
+    # Duplicates or obvious changes
+    FILTER_WHEN_BRIEF = %w[ author
+                            date
+                            license
+                            platform
+                            rubygems_version
+                            version ]
+
+    # Not present in marshal file containing the specs
+    NOT_IN_MARSHAL = %w[ cert_chain
+                         executables
+                         extensions
+                         extra_rdoc_files
+                         files
+                         license
+                         licenses
+                         metadata
+                         post_install_message
+                         rdoc_options
+                         requirements
+                         signing_key
+                         test_files ]
+
+    private
+
+      def param_exists?(param)
+        (SPEC_PARAMS.include? param) ||
+        (SPEC_FILES_PARAMS.include? param) ||
+        (DEPENDENCY_PARAMS.include? param) ||
+        (GEMFILE_PARAMS.include? param)
+      end
+
+      def param_available_in_marshal?(param)
+        param_exists?(param) && !NOT_IN_MARSHAL.include?(param)
+      end
+
+      def filter_params(params, param, brief_mode = false)
+        if param
+          if params.include? param
+            return [param]
+          else
+            return []
+          end
+        end
+        if brief_mode
+          filter_for_brief_mode(params)
+        else
+          params
+        end
+      end
+
+      def filter_for_brief_mode(params)
+        params.delete_if{ |p| FILTER_WHEN_BRIEF.include?(p) }
+      end
+
+      def values_from_specs(param, specs)
+        values = []
+        specs.each do |s|
+         val = value_from_spec(param, s)
+         values << val if val
+        end
+        values
+      end
+
+      def value_from_spec(param, spec)
+        if spec.respond_to? :"#{param}"
+          spec.send(:"#{param}")
+        else
+          warn "#{spec.full_name} does not respond to " +
+               "#{param}, skipping check"
+          nil
+        end
+      end
+
+      def info(msg)
+        say msg if Gem.configuration.really_verbose
+      end
+
+      def warn(msg)
+        say Rainbow("WARNING: #{msg}").red
+      end
+
+      def error(msg)
+        say Rainbow("ERROR: #{msg}").red
+        exit 1
+      end
+  end
+end

data/test/rubygems/comparator/test_dependency_comparator.rb

@@ -24,6 +24,7 @@ class TestDependencyComparator < TestGemComparator
     assert_equal [], @report['development_dependency']['0.0.1->0.0.2']['updated'].messages
     assert_equal [], @report['development_dependency']['0.0.2->0.0.3']['added'].messages
     assert_equal [], @report['development_dependency']['0.0.2->0.0.3']['deleted'].messages
-    assert_equal [], @report['development_dependency']['0.0.2->0.0.3']['updated'].messages
+    assert_equal 'bundler from: ["~> 1.6"] to: ["~> 1.0"]', @report['development_dependency']['0.0.2->0.0.3']['updated'].lines(1)[0]
+    assert_equal 'rake from: [">= 0"] to: [">= 10.0.0"]', @report['development_dependency']['0.0.2->0.0.3']['updated'].lines(1)[1]
   end
 end

data/test/rubygems/comparator/test_dir_utils.rb

@@ -0,0 +1,52 @@
+require 'test_helper'
+
+class TestDirUtils < TestGemModule
+
+  def test_file_first_line
+    file1 = File.join(@v001, 'lib/lorem.rb')
+    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_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_equal 0, Gem::Comparator::DirUtils.file_has_shebang?(file2)
+  end
+
+  def test_files_same_first_line?
+    file1 = File.join(@v001, 'lib/lorem.rb')
+    file2 = File.join(@v002, 'lib/lorem.rb')
+    file3 = File.join(@v003, 'bin/lorem')
+    assert_equal true, Gem::Comparator::DirUtils.files_same_first_line?(file1, file2)
+    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_equal 0, Gem::Comparator::DirUtils.gem_bin_file?(file2)
+  end
+
+  def test_dirs_of_files
+    files = ['Rakefile', '/dir1/file1', '/dir2/file2']
+    assert_equal ["Rakefile", "/dir1/", "/dir2/"], Gem::Comparator::DirUtils.dirs_of_files(files)
+  end
+
+  def test_remove_subdirs
+    dirs = ['/dir1/dir2/dir3', '/dir1/dir2', '/dir', 'Gemfile']
+    assert_equal ["/dir1/dir2", "/dir", "Gemfile"], Gem::Comparator::DirUtils.remove_subdirs(dirs) 
+  end
+end

data/test/rubygems/comparator/test_file_list_comparator.rb

@@ -5,10 +5,13 @@ 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", @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", "lib/lorem/utils.rb"], @report['files']['0.0.2->0.0.3']['added'].lines(1)
+    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 [], @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

@@ -0,0 +1,53 @@
+require 'test_helper'
+
+class TestMonitor < TestGemModule
+
+  def test_lines_changed
+    file1 = File.join(@v001, 'lib/lorem.rb')
+    file2 = File.join(@v002, 'lib/lorem.rb')
+    assert_equal '+4/-0', Gem::Comparator::Monitor.lines_changed(file1, file2)
+  end
+
+  def test_compact_files_diff
+    file1 = File.join(@v001, 'lib/lorem.rb')
+    file2 = File.join(@v002, 'lib/lorem.rb')
+    assert_equal '++++', Gem::Comparator::Monitor.compact_files_diff(file1, file2)
+  end
+
+  def test_files_permissions_changes
+    file1 = File.join(@v003, 'bin/lorem')
+    file2 = File.join(@v004, 'bin/lorem')
+    assert_equal '(!) New permissions: 100664 -> 100775', Gem::Comparator::Monitor.files_permissions_changes(file1, file2).strip 
+  end
+
+  def test_new_file_permissions
+    file1 = File.join(@v004, 'bin/lorem')
+    file2 = File.join(@v004, 'lib/lorem.rb')
+    assert_equal '(!) Unexpected permissions: 100775', Gem::Comparator::Monitor.new_file_permissions(file1).strip 
+    assert_equal '(!) Unexpected permissions: 100664', Gem::Comparator::Monitor.new_file_permissions(file2).strip 
+  end
+
+  def test_files_executability_changes
+    file1 = File.join(@v003, 'bin/lorem')
+    file2 = File.join(@v004, 'bin/lorem')
+    assert_equal '(!) File is now executable!', Gem::Comparator::Monitor.files_executability_changes(file1, file2).strip
+  end
+
+  def test_new_file_executability
+    file1 = File.join(@v003, 'bin/lorem')
+    file2 = File.join(@v004, 'bin/lorem')
+    assert_equal '(!) File is not executable', Gem::Comparator::Monitor.new_file_executability(file1).strip
+    assert_equal '', Gem::Comparator::Monitor.new_file_executability(file2).strip
+  end
+
+  def test_files_shebang_changes
+    file1 = File.join(@v003, 'bin/lorem')
+    file2 = File.join(@v004, 'bin/lorem')
+    assert_equal '', Gem::Comparator::Monitor.files_shebang_changes(file1, file2).strip
+  end
+
+  def test_new_file_shebang
+    file1 = File.join(@v003, 'bin/lorem')
+    assert_equal '(!) Shebang found: #!/usr/bin/ruby', Gem::Comparator::Monitor.new_file_shebang(file1).strip
+  end
+end