gem-compare 0.0.1 → 0.0.2

data/lib/rubygems/comparator/gemfile_comparator.rb

@@ -0,0 +1,150 @@
+require 'gemnasium/parser'
+require 'rubygems/comparator/base'
+
+class Gem::Comparator
+
+  ##
+  # Gem::Comparator::GemfileComparator can
+  # compare dependencies between gem's Gemfiles
+  # based on the given Gem::Package objects
+  #
+  # To compare Gemfiles it needs to extract
+  # gem packages to +options[:output]+
+
+  class GemfileComparator
+    include Gem::Comparator::Base
+
+    COMPARES = :packages
+
+    ##
+    # Compare Gemfiles using gem's +packages+
+    # and write the changes to the +report+
+
+    def compare(packages, report, options = {})
+      info 'Checking Gemfiles for dependencies...'
+      return report if options[:param] && options[:param] != 'gemfiles'
+
+      @packages = packages
+      all_same = true
+
+      # Check Gemfiles from older versions to newer
+      packages.each_with_index do |pkg, index|
+        unpacked_gem_dirs[@packages[index].spec.version] = extract_gem(pkg, options[:output])
+        next if index == 0
+
+        prev_gemfile = File.join(unpacked_gem_dirs[@packages[index-1].spec.version], 'Gemfile')
+        curr_gemfile = File.join(unpacked_gem_dirs[@packages[index].spec.version], 'Gemfile')
+
+        vers = "#{@packages[index-1].spec.version}->#{@packages[index].spec.version}"
+        report['gemfiles'][vers].set_header "#{Rainbow(packages[index-1].spec.version).blue}->" +
+                                            "#{Rainbow(packages[index].spec.version).blue}:"
+
+        if File.exist?(prev_gemfile) && File.exist?(curr_gemfile)
+          added, deleted, updated = compare_gemfiles(prev_gemfile, curr_gemfile)
+
+          report['gemfiles'][vers]['added'].section do
+            set_header '* Added:'
+            puts added.map { |x| "#{x.name} #{x.requirements_list}" }  unless added.empty?
+          end
+          report['gemfiles'][vers]['deleted'].section do
+            set_header '* Deleted'
+            puts deleted.map { |x| "#{x.name} #{x.requirements_list}" }  unless deleted.empty?
+          end
+          report['gemfiles'][vers]['updated'].section do
+            set_header '* Updated'
+            puts updated  unless updated.empty?
+          end
+          all_same = false if !added.empty? || !deleted.empty?
+        elsif File.exist?(prev_gemfile)
+          report['gemfiles'][vers] << "Gemfile removed"
+          all_same = false
+        elsif File.exist?(curr_gemfile)
+          report['gemfiles'][vers] << "Gemfile added"
+          all_same = false
+        end
+      end
+      if all_same && options[:log_all]
+        report['gemfiles'].set_header "#{same} Gemfiles:"
+        gemfile = File.join(unpacked_gem_dirs[@packages[1].spec.version], 'Gemfile')
+        if File.exist? gemfile
+          deps = gemfile_deps(gemfile)
+          deps = '[]' if deps.empty?
+          report['gemfiles'] << deps
+        else
+          report['gemfiles'] << 'No Gemfiles'
+        end
+      elsif !all_same
+        report['gemfiles'].set_header "#{different} Gemfile dependencies"
+      end
+
+      report
+    end
+
+    private
+    
+      ##
+      # Access @unpacked_gem_dirs hash that stores
+      # paths to the unpacked gem dirs
+      # 
+      # Keys of the hash are gem's versions
+
+      def unpacked_gem_dirs
+        @unpacked_gem_dirs ||= {}
+      end
+    
+      ##
+      # Compare two Gemfiles for dependencies
+      #
+      # Return [added, deleted, updated] deps
+
+      def compare_gemfiles(prev_gemfile, curr_gemfile)
+        prev_deps = gemfile_deps(prev_gemfile)
+        curr_deps = gemfile_deps(curr_gemfile)
+        added = curr_deps - prev_deps
+        deleted = prev_deps - curr_deps
+
+        split_dependencies(added, deleted)
+      end
+    
+      ##
+      # Get the Gemfile dependencies from +gemfile+
+
+      def gemfile_deps(gemfile)
+        parse_gemfile(gemfile).dependencies
+      end
+    
+      ##
+      # Parse +gemfile+ using Gemnasium::Parser
+      #
+      # Return Gemnasium::Parser::Gemfile
+
+      def parse_gemfile(gemfile)
+        Gemnasium::Parser.gemfile File.open(gemfile).read
+      end
+    
+      ##
+      # Find updated dependencies between +added+ and
+      # +deleted+ deps and move them out to +updated+.
+      #
+      # Return [added, deleted, updated] deps
+
+      def split_dependencies(added, deleted)
+        updated = []
+        added.dup.each do |ad|
+          deleted.dup.each do |dd|
+            if ad.name == dd.name && ad.type == dd.type
+              unless ad.requirements_list == dd.requirements_list
+                updated << "#{ad.name} " +
+                           "from: #{dd.requirements_list} " +
+                           "to: #{ad.requirements_list}"
+              end
+              added.delete ad
+              deleted.delete dd
+            end
+          end
+        end
+        [added, deleted, updated]
+      end
+
+  end
+end

data/lib/rubygems/comparator/report.rb

@@ -0,0 +1,121 @@
+class Gem::Comparator
+  class Report
+
+    def self.new(name = 'main')
+      Gem::Comparator::Report::NestedSection.new(name)
+    end
+
+    class NestedSection
+      include Gem::Comparator::Base
+      include Gem::UserInteraction
+
+      DEFAULT_INDENT = '  '
+
+      attr_reader :header, :messages, :parent_section, :level
+      attr_accessor :name, :sections
+
+      def initialize(name, parent_section = nil)
+        @name = name
+        @header = Entry.new
+        @messages = []
+        @sections = []
+        @level = 0
+
+        set_parent parent_section if parent_section
+      end
+
+      def section(&block)
+        instance_eval &block
+      end
+
+      def set_header(message)
+        @header = Entry.new(message)
+      end
+
+      def puts(message)
+        @messages << Entry.new(message)
+      end
+      alias_method :<<, :puts
+
+      def nest(name)
+        @sections.each { |s| if s.name == name; return s; end }
+        NestedSection.new(name, self)
+      end
+      alias_method :[], :nest
+
+      def print
+        all_messages.each { |m| m.print }
+      end
+
+      def all_messages
+        indent = DEFAULT_INDENT*@level
+
+        if @header.empty?
+          @messages.map { |m| m.set_indent!(indent) } + nested_messages
+        else
+          nested = @messages.map { |m| m.set_indent!(indent * 2) } + 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
+
+      def nested_messages
+        nested_messages = []
+        @sections.each do |section|
+          section.all_messages.each do |m|
+            nested_messages << m
+          end
+        end
+        nested_messages
+      end
+
+      private
+
+        def set_parent(parent)
+          parent.sections << self
+          @level = parent.level + 1
+          parent_section = parent
+        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/spec_comparator.rb

@@ -0,0 +1,77 @@
+require 'rubygems/comparator/base'
+
+class Gem::Comparator
+
+  ##
+  # Gem::Comparator::SpecComparator can
+  # compare values from the gem verions specs
+  
+  class SpecComparator
+    include Gem::Comparator::Base
+
+    COMPARES = :specs
+
+    ##
+    # Compare common fields in spec
+
+    def compare(specs, report, options = {})
+      info 'Checking spec parameters...'
+
+      filter_params(SPEC_PARAMS, options[:param]).each do |param|
+        values = values_from_specs(param, specs)
+
+        # Are values the same?
+        if same_values?(values) && options[:log_all]
+          v = value(values[0]) 
+          report[param].section do
+            set_header "#{same} #{param}:"
+	        puts v
+          end
+        elsif !same_values?(values)
+          report[param].set_header "#{different} #{param}:"
+          values.each_with_index do |value, index|
+            report[param] << \
+              "#{Rainbow(specs[index].version).blue}: #{value}"
+          end
+        end
+      end
+      report
+    end
+
+    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} " 
+          else
+            '[]'
+          end
+        when String
+          return value unless value.empty?
+          ''
+        else
+          value.inspect
+        end
+      end
+
+      def same_values?(values)
+        values.count(values[0]) == values.size
+      end
+  end
+end

data/lib/rubygems_plugin.rb

@@ -1,9 +1,2 @@
 require 'rubygems/command_manager'
-require 'rubygems/commands/compare_command'
-
 Gem::CommandManager.instance.register_command :compare
-
-Gem.post_install do |installer|
-  #installer.spec
-  Gem::Commands::CompareCommand.execute
-end

data/test/rubygems/comparator/test_dependency_comparator.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+class TestDependencyComparator < TestGemComparator
+
+  def test_runtime_dependencies_comparison
+    assert_equal 'DIFFERENT runtime dependencies:', @report['runtime_dependency'].header.data
+    assert_equal 'DIFFERENT runtime dependencies:', @report['runtime_dependency'].lines(0)
+    assert_equal '0.0.2->0.0.3:', @report['runtime_dependency']['0.0.2->0.0.3'].header.data
+    assert_equal '0.0.2->0.0.3:', @report['runtime_dependency'].lines(1)
+    assert_equal '* Added:', @report['runtime_dependency']['0.0.2->0.0.3']['added'].lines(0)
+    assert_equal [], @report['runtime_dependency']['0.0.2->0.0.3']['deleted'].messages
+    assert_equal [], @report['runtime_dependency']['0.0.2->0.0.3']['updated'].messages
+    assert_equal ['rails [">= 4.0.0"] (runtime)'], @report['runtime_dependency']['0.0.2->0.0.3']['added'].lines(1)
+    assert_equal '0.0.3->0.0.4:', @report['runtime_dependency']['0.0.3->0.0.4'].header.data
+    assert_equal '0.0.3->0.0.4:', @report['runtime_dependency'].lines(4)
+    assert_equal [], @report['runtime_dependency']['0.0.3->0.0.4']['added'].messages
+    assert_equal [], @report['runtime_dependency']['0.0.3->0.0.4']['deleted'].messages
+    assert_equal ['rails from: [">= 4.0.0"] to: [">= 4.1.0"]'], @report['runtime_dependency']['0.0.3->0.0.4']['updated'].lines(1)
+  end
+
+  def test_development_dependencies_comparison
+    assert_equal [], @report['development_dependency']['0.0.1->0.0.2']['added'].messages
+    assert_equal [], @report['development_dependency']['0.0.1->0.0.2']['deleted'].messages
+    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
+  end
+end

data/test/rubygems/comparator/test_file_list_comparator.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+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 [], @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 [], @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
+    assert_equal [], @report['files']['0.0.3->0.0.4']['deleted'].messages
+    assert_equal [], @report['files']['0.0.3->0.0.4']['updated'].messages
+  end
+
+  def test_test_files_comparison
+    assert_equal 'SAME test_files:', @report['test_files'].header.data
+  end
+end

data/test/rubygems/comparator/test_gemfile_comparator.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class TestGemfileComparator < TestGemComparator
+
+  def test_gemfile_comparison
+    assert_equal '0.0.1->0.0.2:', @report['gemfiles']['0.0.1->0.0.2'].header.data
+    assert_equal [], @report['gemfiles']['0.0.1->0.0.2'].messages
+    assert_equal [], @report['gemfiles']['0.0.2->0.0.3'].messages
+    assert_equal [], @report['gemfiles']['0.0.3->0.0.4']['added'].messages
+    assert_equal '* Deleted', @report['gemfiles']['0.0.3->0.0.4'].lines(1)
+    assert_equal ['appraisal [">= 0"]'], @report['gemfiles']['0.0.3->0.0.4']['deleted'].lines(1)
+    assert_equal ['minitest from: [">= 0"] to: ["= 5.0.0"]'], @report['gemfiles']['0.0.3->0.0.4']['updated'].lines(1)
+  end
+end

data/test/rubygems/comparator/test_spec_comparator.rb

@@ -0,0 +1,153 @@
+require 'test_helper'
+
+class TestSpecComparator < TestGemComparator
+
+  def test_name_comparison
+    assert_equal 'SAME name:', @report['name'].header.data
+    assert_equal 'SAME name:', @report['name'].lines(0)
+  end
+  
+  def test_version_comparison
+    assert_equal 'DIFFERENT version:',  @report['version'].header.data
+    assert_equal 'DIFFERENT version:',  @report['version'].lines(0)
+    assert_equal '0.0.1: 0.0.1', @report['version'].lines(1)
+    assert_equal '0.0.2: 0.0.2', @report['version'].lines(2)
+    assert_equal '0.0.3: 0.0.3', @report['version'].lines(3)
+    assert_equal '0.0.4: 0.0.4', @report['version'].lines(4)
+  end
+
+  def test_licenses_comparison
+    assert_equal 'DIFFERENT license:',  @report['license'].header.data
+    assert_equal 'DIFFERENT licenses:', @report['licenses'].header.data
+    assert_equal 'DIFFERENT license:',  @report['license'].lines(0)
+    assert_equal 'DIFFERENT licenses:', @report['licenses'].lines(0)
+    assert_equal '0.0.1: MIT',   @report['license'].lines(1)
+    assert_equal '0.0.2: GPLv2', @report['license'].lines(2)
+    assert_equal '0.0.3: GPLv2', @report['license'].lines(3)
+    assert_equal '0.0.4: GPLv2', @report['license'].lines(4)
+    assert_equal '0.0.1: ["MIT"]',   @report['licenses'].lines(1)
+    assert_equal '0.0.2: ["GPLv2"]', @report['licenses'].lines(2)
+    assert_equal '0.0.3: ["GPLv2"]', @report['licenses'].lines(3)
+    assert_equal '0.0.4: ["GPLv2"]', @report['licenses'].lines(4)
+  end
+  
+  def test_authors_comparison
+    assert_equal 'SAME author:',  @report['author'].header.data
+    assert_equal 'SAME authors:', @report['authors'].header.data
+    assert_equal 'SAME author:',  @report['author'].lines(0)
+    assert_equal 'SAME authors:', @report['authors'].lines(0)
+  end
+  
+  def test_email_comparison
+    assert_equal 'SAME email:', @report['email'].header.data
+    assert_equal 'SAME email:', @report['email'].lines(0)
+  end
+  
+  def test_summary_comparison
+    assert_equal 'DIFFERENT summary:', @report['summary'].header.data
+    assert_equal 'DIFFERENT summary:', @report['summary'].lines(0)
+    assert_equal '0.0.1: lorem is a gem for testing gem-compare', @report['summary'].lines(1)
+    assert_equal '0.0.2: lorem is a gem for testing gem-compare', @report['summary'].lines(2)
+    assert_equal '0.0.3: lorem is a gem for testing gem-compare', @report['summary'].lines(3)
+    assert_equal '0.0.4: lorem is a gem for testing gem-compare plugin', @report['summary'].lines(4)
+  end
+  
+  def test_description_comparison
+    assert_equal 'DIFFERENT description:', @report['description'].header.data
+    assert_equal 'DIFFERENT description:', @report['description'].lines(0)
+    assert_equal '0.0.1: lorem changes a lot so we can test gem-compare a lot', @report['description'].lines(1)
+    assert_equal '0.0.2: lorem changes a lot so we can test gem-compare a lot', @report['description'].lines(2)
+    assert_equal '0.0.3: lorem changes a lot so we can test gem-compare a lot', @report['description'].lines(3)
+    assert_equal '0.0.4: lorem changes a lot so we can test gem-compare plugin a lot', @report['description'].lines(4)
+  end
+  
+  def test_homepage_comparison
+    assert_equal 'DIFFERENT homepage:', @report['homepage'].header.data
+    assert_equal 'DIFFERENT homepage:', @report['homepage'].lines(0)
+    assert_equal '0.0.1: ', @report['homepage'].lines(1)
+    assert_equal '0.0.2: ', @report['homepage'].lines(2)
+    assert_equal '0.0.3: http://lorem.lorem', @report['homepage'].lines(3)
+    assert_equal '0.0.4: http://lorem.lorem', @report['homepage'].lines(4)
+  end
+  
+  def test_platform_comparison
+    assert_equal 'SAME platform:', @report['platform'].header.data
+    assert_equal 'SAME platform:', @report['platform'].lines(0)
+  end
+  
+  def test_require_paths_comparison
+    assert_equal 'SAME require_paths:', @report['require_paths'].header.data
+    assert_equal 'SAME require_paths:', @report['require_paths'].lines(0)
+  end
+  
+  def test_bindir_comparison
+    assert_equal 'SAME bindir:', @report['bindir'].header.data
+    assert_equal 'SAME bindir:', @report['bindir'].lines(0)
+  end
+  
+  def test_rubygems_version_comparison
+    assert_equal 'SAME rubygems_version:', @report['rubygems_version'].header.data
+    assert_equal 'SAME rubygems_version:', @report['rubygems_version'].lines(0)
+  end
+  
+  def test_cert_chain_comparison
+    assert_equal 'SAME cert_chain:', @report['cert_chain'].header.data
+    assert_equal 'SAME cert_chain:', @report['cert_chain'].lines(0)
+  end
+  
+  def test_executables_comparison
+    assert_equal 'DIFFERENT executables:', @report['executables'].header.data
+    assert_equal 'DIFFERENT executables:', @report['executables'].lines(0)
+  end
+  
+  def test_extensions_comparison
+    assert_equal 'SAME extensions:', @report['extensions'].header.data
+    assert_equal 'SAME extensions:', @report['extensions'].lines(0)
+  end
+  
+  def test_metadata_comparison
+    assert_equal 'SAME metadata:', @report['metadata'].header.data
+    assert_equal 'SAME metadata:', @report['metadata'].lines(0)
+  end
+  
+  def test_post_install_message_comparison
+    assert_equal 'SAME post_install_message:', @report['post_install_message'].header.data
+    assert_equal 'SAME post_install_message:', @report['post_install_message'].lines(0)
+  end
+  
+  def test_rdoc_options_comparison
+    assert_equal 'SAME rdoc_options:', @report['rdoc_options'].header.data
+    assert_equal 'SAME rdoc_options:', @report['rdoc_options'].lines(0)
+  end
+  
+  def test_required_ruby_version_comparison
+    assert_equal 'SAME required_ruby_version:', @report['required_ruby_version'].header.data
+    assert_equal 'SAME required_ruby_version:', @report['required_ruby_version'].lines(0)
+  end
+  
+  def test_required_rubygems_version_comparison
+    assert_equal 'SAME required_rubygems_version:', @report['required_rubygems_version'].header.data
+    assert_equal 'SAME required_rubygems_version:', @report['required_rubygems_version'].lines(0)
+  end
+  
+  def test_requirements_comparison
+    assert_equal 'SAME requirements:', @report['requirements'].header.data
+    assert_equal 'SAME requirements:', @report['requirements'].lines(0)
+  end
+  
+  def test_signing_key_comparison
+    assert_equal 'SAME signing_key:', @report['signing_key'].header.data
+    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)
+  end
+  
+end