gem-compare 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41f631f7e0326a83d40c522f6003ee17c58d3862
-  data.tar.gz: 93bbd6f62d8c2a98bd93458f6dbb1c9f74647825
+  metadata.gz: c0bf945c951c897beae61add41492c92c95248fa
+  data.tar.gz: 1113168bb3eeb4cc7af658f2b8a7bd2665c771a4
 SHA512:
-  metadata.gz: d384515bab09282848e2900d9737f13222e331d2853cc4fc2bc49411b08118368aec9a4d3fcd023055fba4c3dc127654b35ff09679956485824196b01f35fea5
-  data.tar.gz: 3859779673f455b99b0a0230386b25f1b9aab3e02a8db1a533c1fb5fc2f2b97ee16a06707168d041cb7e0dfd89848a98eaeaf14c769944c18c283dc1c8359a48
+  metadata.gz: c4da75c477e6784574cc96651df72e4aaa3621fac232170ace9634dce53192b88997cf42115285bad9a047fb69a0f217823f20e5a4da095ab85213f707ff0232
+  data.tar.gz: 0c0b71c3002837de7e87b096cd6c98189708baa56e9a478135974a35d7853c88620bdb145bf12321b11950bf9e92c3d3a962c032e1068cb4f904e7ea52dec24d

data/README.md

@@ -134,6 +134,15 @@ Compared versions: ["0.1.0", "0.1.1", "0.1.2", "0.2.0", "0.2.1", "0.2.2", "0.2.3
             rspec from: [">= 0"] to: ["= 2.14.1"]
 ```
 
+#### Platforms
+
+*gem-compare* supports querying different gem platforms via standard `--platform` option. To compare
+nokogiri gem on different platform run:
+```
+$ 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
+```
+
 ### Supported options
 
 To see all possible options run:

data/Rakefile

@@ -4,7 +4,7 @@ require 'rdoc/task'
 
 gemspec = Gem::Specification.new do |s|
   s.name     = 'gem-compare'
-  s.version  = '0.0.2'
+  s.version  = '0.0.3'
   s.platform = Gem::Platform::RUBY
   s.summary     = 'RubyGems plugin for comparing gem versions'
   s.description = <<-EOF
@@ -19,6 +19,8 @@ gemspec = Gem::Specification.new do |s|
                      'lib/**/*.rb', 'lib/**/**/*.rb', 'test/**/test*.rb']
   s.required_ruby_version     = '>= 2.0.0'
   s.required_rubygems_version = '>= 2.0.0'
+  s.add_runtime_dependency 'json'
+  s.add_runtime_dependency 'curl'
   s.add_runtime_dependency 'diffy'
   s.add_runtime_dependency 'rainbow'
   s.add_runtime_dependency 'gemnasium-parser'

data/lib/rubygems/commands/compare_command.rb

@@ -1,7 +1,10 @@
 require 'rubygems/command'
+require 'rubygems/version_option'
 require 'rubygems/comparator'
 
 class Gem::Commands::CompareCommand < Gem::Command
+  include Gem::VersionOption
+
   def initialize
     super 'compare', 'Compare gem\'s versions and generate a report of changes',
       :output => Dir.pwd
@@ -18,7 +21,10 @@ class Gem::Commands::CompareCommand < Gem::Command
       options[:no_color] = true
     end
 
-    add_option('-pPARAM', '--param=PARAM', 'Compare only a given paramater') do |param, options|
+    # Speficy the platform using --platform=PLATFORM
+    add_platform_option
+
+    add_option('-pPARAM', '--param PARAM', 'Compare only a given paramater') do |param, options|
       options[:param] = param
     end
 

data/lib/rubygems/comparator.rb

@@ -1,10 +1,12 @@
 require 'tmpdir'
 require 'rbconfig'
 require 'rainbow'
+require 'curb'
+require 'json'
 require 'rubygems/package'
 require 'rubygems/dependency'
 require 'rubygems/spec_fetcher'
-require 'rubygems/comparator/base'
+require 'rubygems/comparator/utils'
 require 'rubygems/comparator/report'
 require 'rubygems/comparator/spec_comparator'
 require 'rubygems/comparator/file_list_comparator'
@@ -17,7 +19,7 @@ require 'rubygems/comparator/gemfile_comparator'
 # Gemfiles
 
 class Gem::Comparator
-  include Gem::Comparator::Base
+  include Gem::Comparator::Utils
   attr_accessor :options, :report
 
   VERSION = '0.0.2'
@@ -28,6 +30,8 @@ class Gem::Comparator
   # Creates temporal directory if the gem files shouldn't be kept
 
   def initialize(options)
+    info "gem-compare in #{VERSION}"
+
     unless options[:keep_all]
       options[:output] = Dir.mktmpdir
     end
@@ -40,6 +44,14 @@ class Gem::Comparator
       Rainbow.enabled = false
     end
 
+    # Let's override platforms with the latest one if
+    # a platform has been specified via --platform
+    if options[:added_platform]
+      Gem.platforms = [Gem.platforms.last]
+      options[:platform] = Gem.platforms.last.to_s
+      info "Overriding platform to: #{options[:platform]}"
+    end
+
     @options = options
 
     # Results from the comparison
@@ -52,18 +64,22 @@ class Gem::Comparator
   # Compares file lists, requirements, other meta data
 
   def compare_versions(gem_name, versions)
-    info "gem-compare in #{VERSION}"
     # Expand versions (<=, >=, ~>) and sort them
     versions = expand_versions(gem_name, versions)
 
     error 'Only one version specified. Specify at lease two versions.' \
       if versions.size == 1
 
+    # This should match the final versions that has been compared
+    @compared_versions = versions
+
     versions.each do |version|
-      download_gems? ? download_package(gem_name, version) : download_specification(gem_name, version)
+      download_gems? ?
+        get_package(gem_name, version) :
+        get_specification(gem_name, version)
     end
 
-    @report.set_header "Compared versions: #{versions}"
+    @report.set_header "Compared versions: #{@compared_versions}"
 
     comparators = [SpecComparator,
                    FileListComparator,
@@ -72,7 +88,7 @@ class Gem::Comparator
 
     comparators.each do |c|
       comparator = c.new
-      cmp = (c::COMPARES == :packages) ? gem_packages.values : gem_specs.values
+      cmp = (comparator.compares == :packages) ? gem_packages.values : gem_specs.values
       @report = comparator.compare(cmp, @report, @options)
     end
 
@@ -95,9 +111,10 @@ class Gem::Comparator
     # Return list of expanded versions
 
     def expand_versions(gem_name, versions)
-      info 'Expanding versions...'
+      info "Expanding versions #{versions}..."
       expanded = []
       versions.each do |version|
+        version = latest_gem_version(gem_name) if version == '_'
         if version =~ VERSION_REGEX
           expanded << version
           next
@@ -121,22 +138,46 @@ class Gem::Comparator
 
       error 'No versions found.' if versions.size == 0
 
-      info "Versions: #{versions}"
+      info "Expanded versions: #{versions}"
       versions
     end
 
+    def remote_gem_versions(gem_name)
+      client = Curl::Easy.new
+      client.url = "https://rubygems.org/api/v1/versions/#{gem_name}.json"
+      client.follow_location = true
+      client.http_get
+      json = JSON.parse(client.body_str)
+      gems = json.collect { |version| version['number'] }
+      info "Upstream versions: #{gems}"
+      gems
+    end
+
+    def latest_gem_version(gem_name)
+      remote_gem_versions(gem_name).map{ |v| Gem::Version.new v }.max.to_s
+    end
+
     def gem_file_name(gem_name, version)
-      "#{gem_name}-#{version}.gem"
+      if @options[:platform]
+        "#{gem_name}-#{version}-#{@options[:platform]}.gem"
+      else
+        "#{gem_name}-#{version}.gem"
+      end
     end
 
-    def download_package(gem_name, version)
+    def get_package(gem_name, version)
       gem_file = gem_file_name(gem_name, version)
       return gem_packages["#{gem_file}"] if gem_packages["#{gem_file}"]
 
       find_downloaded_gem(gem_file)
       return gem_packages["#{gem_file}"] if gem_packages["#{gem_file}"]
 
-      spec, source = download_specification(gem_name, version)
+      download_package(gem_name, version)
+    end
+
+    def download_package(gem_name, version)
+      spec, source = get_specification(gem_name, version)
+      gem_file = gem_file_name(gem_name, spec.version.to_s)
 
       Dir.chdir @options[:output] do
         source.download spec
@@ -149,22 +190,44 @@ class Gem::Comparator
       package
     end
 
-    def download_specification(gem_name, version)
+    def get_specification(gem_name, version)
       gem_file = gem_file_name(gem_name, version)
       return gem_specs["#{gem_file}"] if gem_specs["#{gem_file}"]
 
       find_downloaded_gem(gem_file)
       return gem_specs["#{gem_file}"] if gem_specs["#{gem_file}"]
 
+      download_specification(gem_name, version)
+    end
+
+    def download_specification(gem_name, version)
       dep = Gem::Dependency.new gem_name, version
       specs_and_sources, _errors = Gem::SpecFetcher.fetcher.spec_for_dependency dep
       spec, source = specs_and_sources.max_by { |s,| s.version }
       error "Gem #{gem_name} in #{version} doesn't exist." if spec.nil?
+
+      fix_comparing_version(version, spec.version.to_s)
+      gem_file = gem_file_name(gem_name, spec.version.to_s)
+
       gem_specs["#{gem_file}"] = spec
 
       [spec, source]
     end
 
+    ##
+    # Ensure the right version is referenced
+
+    def fix_comparing_version(version, spec_version)
+      if spec_version != version
+        @compared_versions.each do |v|
+          if v == version
+            @compared_versions[@compared_versions.index(version)] = spec_version
+            return
+          end
+        end
+      end
+    end
+
     def find_downloaded_gem(gem_file)
       if File.exist? File.join(@options[:output], gem_file)
         info "#{gem_file} exists, using already downloaded file."
@@ -184,7 +247,7 @@ class Gem::Comparator
 
     def download_gems?
       return true if @options[:keep_all]
-      @options[:param] ? SPEC_FILES_PARAMS.include?(@options[:param]) : true
+      @options[:param] ? !param_available_in_marshal?(@options[:param]) : true
     end
 
     def gem_packages

data/lib/rubygems/comparator/base.rb

@@ -1,65 +1,28 @@
 require 'rainbow'
+require 'rubygems/comparator/utils'
+require 'rubygems/comparator/report'
 
 class Gem::Comparator
-  module Base
-    include Gem::UserInteraction
+  class Base
+    include Gem::Comparator::Utils
+    include Gem::Comparator::Report::Signs
 
-    class DiffCommandMissing < StandardError; end
+    attr_accessor :compares
 
-    SPACE = ' '
-    DEFAULT_INDENT = SPACE*7
-    OPERATORS = ['=', '!=', '>', '<', '>=', '<=', '~>']
-    VERSION_REGEX = /\A(\d+\.){0,}\d+(\.[a-zA-Z]+\d{0,1}){0,1}\z/
-    SHEBANG_REGEX = /\A#!.*/
-    SPEC_PARAMS = %w[ author authors name platform require_paths rubygems_version summary
-                      license licenses  bindir cert_chain description email executables
-                      extensions homepage metadata post_install_message rdoc_options
-                      required_ruby_version required_rubygems_version requirements
-                      signing_key has_rdoc date version ].sort
-    SPEC_FILES_PARAMS = %w[ files test_files extra_rdoc_files ]
-    DEPENDENCY_PARAMS = %w[ runtime_dependency development_dependency ]
-    GEMFILE_PARAMS = %w[ gemfiles ]
+    ##
+    # Compare Gem::Specification objects by default
+    #
+    # To override create your own initialize method and
+    # set expect(:packages) to expect Gem::Package objects.
 
-    private
-
-      def param_exists?(param)
-        (SPEC_PARAMS.include? param) ||
-        (SPEC_FILES_PARAMS.include? param) ||
-        (DEPENDENCY_PARAMS.include? param) ||
-        (GEMFILE_PARAMS.include? param)
-      end
-
-      def filter_params(params, param)
-        if param
-          if params.include? param
-            return [param]
-          else
-            return []
-          end
-        end
-
-        params
-      end
-
-      def same
-        Rainbow('SAME').green.bright
-      end
+    def initialize
+      expect(:specs)
+    end
 
-      def different
-        Rainbow('DIFFERENT').red.bright
-      end
-
-      def info(msg)
-        say msg if Gem.configuration.really_verbose
-      end
-
-      def warn(msg)
-        say Rainbow("WARNING: #{msg}").red
-      end
+    private
 
-      def error(msg)
-        say Rainbow("ERROR: #{msg}").red
-        exit 1
+      def expect(what)
+        @compares = what
       end
 
       def extract_gem(package, target_dir)
@@ -76,13 +39,5 @@ class Gem::Comparator
         gem_dir
       end
 
-      def check_diff_command_is_installed
-        begin
-          IO.popen('diff --version')
-        rescue Exception
-          raise DiffCommandMissing, \
-            'Calling `diff` command failed. Do you have it installed?'
-        end
-      end
   end
 end

data/lib/rubygems/comparator/dependency_comparator.rb

@@ -7,15 +7,12 @@ class Gem::Comparator
   # compare dependencies between gem's versions
   # based on the given Gem::Specification objects
 
-  class DependencyComparator
-    include Gem::Comparator::Base
-
-    COMPARES = :specs
+  class DependencyComparator < Gem::Comparator::Base
 
     ##
     # Compare dependencies in given +specs+ and
     # write the changes to the +report+
-    # 
+    #
     # If +options[:param]+ is set, it compares only
     # those dependencies
 
@@ -25,12 +22,11 @@ class Gem::Comparator
       filter_params(DEPENDENCY_PARAMS, options[:param]).each do |param|
         all_same = true
         type = param.gsub('_dependency', '').to_sym
-
         specs.each_with_index do |s, index|
           next if index == 0
 
-          prev_deps = specs[index-1].dependencies.keep_if { |d| d.type == type }
-          curr_deps = specs[index].dependencies.keep_if { |d| d.type == type }
+          prev_deps = specs[index-1].dependencies.select { |d| d.type == type }
+          curr_deps = specs[index].dependencies.select { |d| d.type == type }
           added, deleted, updated = resolve_dependencies(prev_deps, curr_deps)
 
           if (!deleted.empty? || !added.empty? || !updated.empty?)
@@ -60,20 +56,21 @@ class Gem::Comparator
         end
         if all_same && options[:log_all]
           report[param].set_header "#{same} #{type} dependencies:" if options[:log_all]
-          deps = specs[0].dependencies.keep_if{ |d| d.type == type }.map{ |d| "#{d.name}: #{d.requirements_list}" }
+          deps = specs[0].dependencies.select{ |d| d.type == type }.map{ |d| "#{d.name}: #{d.requirements_list}" }
           deps = '[]' if deps.empty?
           report[param] << deps
         elsif !all_same
           report[param].set_header "#{different} #{type} dependencies:"
         end
       end
+
       report
     end
 
     private
-      
+
       ##
-      # Find dependencies between +prev_deps+ and +curr_deps+  
+      # Find dependencies between +prev_deps+ and +curr_deps+
       #
       # Return [added, deleted, updated] deps
 
@@ -82,7 +79,7 @@ class Gem::Comparator
         deleted = prev_deps - curr_deps
         split_dependencies(added, deleted)
       end
-    
+
       ##
       # Find updated dependencies between +added+ and
       # +deleted+ deps and move them out to +updated+.

data/lib/rubygems/comparator/dir_utils.rb

@@ -0,0 +1,51 @@
+require 'pathname'
+
+module DirUtils
+  SHEBANG_REGEX = /\A#!.*/
+
+  attr_accessor :files_first_line
+
+  def self.file_first_line(file)
+    File.open(file){ |f| f.readline }.gsub(/(.*)\n/, '\1')
+  rescue
+  end
+
+  def self.file_has_shebang?(file)
+    file_first_line(file) =~ SHEBANG_REGEX
+  end
+
+  def self.files_same_first_line?(file1, file2)
+    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
+
+  ##
+  # Returns a unique list of directories and top level files
+  # out of an array of files
+
+  def self.dirs_of_files(file_list)
+    dirs_of_files = []
+    file_list.each do |file|
+      unless Pathname.new(file).dirname.to_s == '.'
+        dirs_of_files << "#{Pathname.new(file).dirname.to_s}/"
+      else
+        dirs_of_files << file
+      end
+    end
+    dirs_of_files.uniq
+  end
+
+  def self.remove_subdirs(dirs)
+    dirs.dup.sort_by(&:length).reverse.each do |dir|
+      dirs.delete_if{ |d| d =~ /#{dir}\/.+/ }
+    end
+    dirs
+  end
+end