gem-compare 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59f10c0b2b0394d2e8a87fbab57322967e748748
-  data.tar.gz: 71cd97b2bfc5ce47c313ed5f463d4df591b85934
+  metadata.gz: 41f631f7e0326a83d40c522f6003ee17c58d3862
+  data.tar.gz: 93bbd6f62d8c2a98bd93458f6dbb1c9f74647825
 SHA512:
-  metadata.gz: 07b26651170a32be9f87c5f94e8ec954be21ce652bcd4459adab5daaf624f3e403aa5b1c68cf7e17617ade3e55c0ff0db2bae4b517659abf754b91cf34c9eb01
-  data.tar.gz: d4321b3394deb868ed199c46c41a26a09dc436084d59d97d03ab986d92fc6a95a6e91550164e6d3b003b2ff175efeb809b637c2d99789e7137cb8251c10a0381
+  metadata.gz: d384515bab09282848e2900d9737f13222e331d2853cc4fc2bc49411b08118368aec9a4d3fcd023055fba4c3dc127654b35ff09679956485824196b01f35fea5
+  data.tar.gz: 3859779673f455b99b0a0230386b25f1b9aab3e02a8db1a533c1fb5fc2f2b97ee16a06707168d041cb7e0dfd89848a98eaeaf14c769944c18c283dc1c8359a48

data/{LICENSE.txt → LICENSE}

@@ -1,10 +1,8 @@
-Copyright (c) 2013 sanemat
-
-MIT License
+Copyright (c) Josef Strzibny.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
+'Software'), to deal in the Software without restriction, including
 without limitation the rights to use, copy, modify, merge, publish,
 distribute, sublicense, and/or sell copies of the Software, and to
 permit persons to whom the Software is furnished to do so, subject to
@@ -13,10 +11,10 @@ the following conditions:
 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,29 +1,154 @@
-# Gem::Compare
+# gem-compare
 
-Compare gem source code
+## Description
+
+*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.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+You can install `gem-compare` as a gem from RubyGems.org:
 
-    gem 'gem-compare'
+```
+gem install gem-compare
+```
 
-And then execute:
+Once it's stable I will package it for Fedora.
 
-    $ bundle
+## Usage
 
-Or install it yourself as:
+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:
 
-    $ gem install gem-compare
+```
+$ gem compare rails 3.0.0 4.0.0 -k
+Compared versions: ["3.0.0", "4.0.0"]
+  DIFFERENT date:
+    3.0.0: 2010-08-29 00:00:00 UTC
+    4.0.0: 2013-06-25 00:00:00 UTC
+  DIFFERENT executables:
+    3.0.0: ["rails"]
+    4.0.0: []
+  DIFFERENT has_rdoc:
+    3.0.0: true
+    4.0.0: 
+  DIFFERENT license:
+    3.0.0: 
+    4.0.0: MIT
+  DIFFERENT licenses:
+    3.0.0: []
+    4.0.0: ["MIT"]
+  DIFFERENT required_ruby_version:
+    3.0.0: >= 1.8.7
+    4.0.0: >= 1.9.3
+  DIFFERENT required_rubygems_version:
+    3.0.0: >= 1.3.6
+    4.0.0: >= 1.8.11
+  DIFFERENT rubygems_version:
+    3.0.0: 1.3.7
+    4.0.0: 2.0.2
+  DIFFERENT version:
+    3.0.0: 3.0.0
+    4.0.0: 4.0.0
+  DIFFERENT files:
+    3.0.0->4.0.0:
+      * Deleted:
+            bin/rails
+      * Added:
+            README.md
+            guides/assets/images/belongs_to.png
+            guides/assets/images/book_icon.gif
+(...)
+```
 
-## Usage
+You can also specify what you are interested in by using -p (as 'param') option:
+
+```
+$ gem compare activesupport 4.0.0 4.1.0 -p 'runtime_dependency'
+Compared versions: ["4.0.0", "4.1.0"]
+  DIFFERENT runtime dependencies:
+    4.0.0->4.1.0:
+      * Deleted:
+            multi_json ["~> 1.3"] (runtime)
+      * Added:
+            json [">= 1.7.7", "~> 1.7"] (runtime)
+      * Updated:
+            i18n from: [">= 0.6.4", "~> 0.6"] to: [">= 0.6.9", "~> 0.6"]
+            tzinfo from: ["~> 0.3.37"] to: ["~> 1.1"]
+            minitest from: ["~> 4.2"] to: ["~> 5.1"]
+```
+There are also shortcuts for favourite options. Use `--runtime` for runtime dependencies, `--gemfiles` for comparing Gemfiles or `--files` for comparing file lists:
+
+```
+$ gem compare rails 2.0.1 3.0.0 -k --files
+Compared versions: ["2.0.1", "3.0.0"]
+  DIFFERENT files:
+    2.0.1->3.0.0:
+      * Deleted:
+            bin
+            builtin
+            CHANGELOG
+            configs
+            dispatches
+            doc
+            environments
+            fresh_rakefile
+            helpers
+            html
+            lib
+            MIT-LICENSE
+(...)
+      * Changed:
+            bin/rails 7/17
+              (!) New permissions: 100644 -> 100755
+              (!) File is now executable!
+              (!) Shebang probably added: #!/usr/bin/env ruby
+```
+
+If you would like to see all development dependencies for `prawn` since `0.1` version, let *gem-compare* expand the versions for you:
+
+```
+$ gem compare prawn '>=0.1' -k -a -p --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:
+    0.12.0->0.13.0:
+      * Added:
+            pdf-inspector ["~> 1.1.0"] (development)
+            coderay ["~> 1.0.7"] (development)
+            rdoc [">= 0"] (development)
+    0.13.2->0.14.0:
+      * Deleted:
+            rdoc [">= 0"] (development)
+      * Added:
+            yard [">= 0"] (development)
+            rspec [">= 0"] (development)
+            mocha [">= 0"] (development)
+            rake [">= 0"] (development)
+    0.14.0->0.15.0:
+      * Added:
+            simplecov [">= 0"] (development)
+            pdf-reader ["~> 1.2"] (development)
+    1.0.0->1.1.0:
+      * Added:
+            prawn-manual_builder [">= 0.1.1"] (development)
+            rubocop ["= 0.20.1"] (development)
+      * Updated:
+            rspec from: [">= 0"] to: ["= 2.14.1"]
+```
+
+### Supported options
+
+To see all possible options run:
+```
+$ gem compare --help
+```
+
+## Requirements
+
+Currently tested against RubyGems 2.x.
+
+## Contributions
 
-    $ bundle exec gem compare bundler 2.0.0...2.0.1
+Contributions are welcome! Please send a PR and make sure you follow the coding style.
 
-## Contributing
+## Copyright
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Released under the MIT license. Feel free to contribute!

data/Rakefile

@@ -1 +1,41 @@
-require "bundler/gem_tasks"
+require 'rubygems/package_task'
+require 'rake/testtask'
+require 'rdoc/task'
+
+gemspec = Gem::Specification.new do |s|
+  s.name     = 'gem-compare'
+  s.version  = '0.0.2'
+  s.platform = Gem::Platform::RUBY
+  s.summary     = 'RubyGems plugin for comparing gem versions'
+  s.description = <<-EOF
+                    gem-compare is a RubyGems plugin that helps to compare versions of the given gem.
+                    It searches for differences in metadata as well as in files.
+                  EOF
+  s.homepage = 'http://github.com/strzibny/gem-compare'
+  s.licenses = ['MIT']
+  s.author   = 'Josef Stribny'
+  s.email    = 'strzibny@strzibny.name'
+  s.files = FileList['README.md', 'LICENSE', 'Rakefile',
+                     '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 'diffy'
+  s.add_runtime_dependency 'rainbow'
+  s.add_runtime_dependency 'gemnasium-parser'
+end
+
+Gem::PackageTask.new gemspec do |pkg|
+end
+
+Rake::RDocTask.new do |rd|
+  rd.main = 'README.md'
+  rd.rdoc_files.include('README.md', 'lib/**/*.rb')
+end
+
+Rake::TestTask.new('test') do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/test*.rb'
+  t.verbose = true
+end
+
+task :default => [:test]

data/lib/rubygems/commands/compare_command.rb

@@ -1,11 +1,88 @@
 require 'rubygems/command'
+require 'rubygems/comparator'
 
 class Gem::Commands::CompareCommand < Gem::Command
   def initialize
-    super 'compare', 'Compare!!!'
+    super 'compare', 'Compare gem\'s versions and generate a report of changes',
+      :output => Dir.pwd
+
+    add_option('-a', '--all', 'Show every comparison') do
+      options[:log_all] = true
+    end
+
+    add_option('-k', '--keep-all', 'Keep downloaded and extracted gem files') do
+      options[:keep_all] = true
+    end
+
+    add_option('-n', '--no-color', 'Do not colorize output') do
+      options[:no_color] = true
+    end
+
+    add_option('-pPARAM', '--param=PARAM', 'Compare only a given paramater') do |param, options|
+      options[:param] = param
+    end
+
+    add_option('-r', '--runtime', 'Compare only runtime dependencies') do
+      options[:param] = 'runtime_dependency'
+    end
+
+    add_option('-d', '--development', 'Compare only development dependencies') do
+      options[:param] = 'development_dependency'
+    end
+
+    add_option('-f', '--files', 'Compare only files for runtime') do
+      options[:param] = 'files'
+    end
+
+    add_option('-g', '--gemfiles', 'Compare only Gemfiles') do
+      options[:param] = 'gemfiles'
+    end
+
+    add_option('-b', '--brief', 'Include only important changes in the report') do
+      options[:log_all] = false
+      options[:brief] = true
+    end
+
+  end
+
+  def arguments # :nodoc:
+    args = <<-EOF
+          GEMNAME               gem name
+          VERSION [VERSION ...] list of versions to compare
+    EOF
+    return args.gsub(/^\s+/, '')
+  end
+
+  def description # :nodoc:
+    desc = <<-EOF
+           gem-compare is a RubyGems plugin that compares versions of the given gem.
+           It searches for differences in metadata as well as in files.
+    EOF
+    return desc.gsub(/^\s+/, '')
+  end
+
+  def usage # :nodoc:
+    "#{program_name} GEMNAME VERSION [VERSION ...]"
   end
 
   def execute
-    say 'compare compare compare'
+    gem_name = options[:args].shift
+    versions = options[:args]
+
+    # No gem specified
+    unless gem_name
+      raise Gem::CommandLineError,
+        "Please specify a gem (e.g. gem compare foo VERSION [VERSION ...])"
+    end
+
+    # No versions specified
+    if versions.empty?
+      raise Gem::CommandLineError,
+        "Please specify versions you want to compare (e.g. gem compare foo 0.1.0 0.2.0)"
+    end
+
+    comparator = Gem::Comparator.new(options)
+    comparator.compare_versions(gem_name, versions)
+    comparator.print_results
   end
 end

data/lib/rubygems/comparator.rb

@@ -0,0 +1,198 @@
+require 'tmpdir'
+require 'rbconfig'
+require 'rainbow'
+require 'rubygems/package'
+require 'rubygems/dependency'
+require 'rubygems/spec_fetcher'
+require 'rubygems/comparator/base'
+require 'rubygems/comparator/report'
+require 'rubygems/comparator/spec_comparator'
+require 'rubygems/comparator/file_list_comparator'
+require 'rubygems/comparator/dependency_comparator'
+require 'rubygems/comparator/gemfile_comparator'
+
+##
+# Gem::Comparator compares different version of the given
+# gem. It can compare spec values as well as file lists or
+# Gemfiles
+
+class Gem::Comparator
+  include Gem::Comparator::Base
+  attr_accessor :options, :report
+
+  VERSION = '0.0.2'
+
+  ##
+  # Set the working dir and process options
+  #
+  # Creates temporal directory if the gem files shouldn't be kept
+
+  def initialize(options)
+    unless options[:keep_all]
+      options[:output] = Dir.mktmpdir
+    end
+
+    if options[:param] && !param_exists?(options[:param])
+      error 'Invalid parameter.'
+    end
+
+    if options[:no_color]
+      Rainbow.enabled = false
+    end
+
+    @options = options
+
+    # Results from the comparison
+    @report = Gem::Comparator::Report.new
+  end
+
+  ##
+  # Compare versions
+  #
+  # 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
+
+    versions.each do |version|
+      download_gems? ? download_package(gem_name, version) : download_specification(gem_name, version)
+    end
+
+    @report.set_header "Compared versions: #{versions}"
+
+    comparators = [SpecComparator,
+                   FileListComparator,
+                   DependencyComparator,
+                   GemfileComparator]
+
+    comparators.each do |c|
+      comparator = c.new
+      cmp = (c::COMPARES == :packages) ? gem_packages.values : gem_specs.values
+      @report = comparator.compare(cmp, @report, @options)
+    end
+
+    # Clean up
+    FileUtils.rm_rf options[:output] unless options[:keep_all]
+  end
+
+  def print_results
+    info 'Printing results...'
+    @report.print
+  end
+
+  private
+
+    ##
+    # If there is an unexpanded version in +versions+ such
+    # as '>= 4.0.0' or '~>1.0.0', find all existing
+    # +gem_name+ versions that match the criteria
+    #
+    # Return list of expanded versions
+
+    def expand_versions(gem_name, versions)
+      info 'Expanding versions...'
+      expanded = []
+      versions.each do |version|
+        if version =~ VERSION_REGEX
+          expanded << version
+          next
+        end
+        op, v = (version.scan /(>=|<=|~>|!=|>|<|=)\s*(.*)/).flatten
+        # Supported operator and version?
+        if OPERATORS.include?(op) && v =~ VERSION_REGEX
+          dep = Gem::Dependency.new gem_name, version
+          specs_and_sources, errors = Gem::SpecFetcher.fetcher.spec_for_dependency dep
+          specs_and_sources.each do |s|
+            expanded << s[0].version
+          end
+        else
+          warn "Unsupported version specification: #{version}, skipping."
+        end
+      end
+
+      versions = expanded.uniq.map do |v|
+        Gem::Version.new v
+      end.sort.map(&:to_s)
+
+      error 'No versions found.' if versions.size == 0
+
+      info "Versions: #{versions}"
+      versions
+    end
+
+    def gem_file_name(gem_name, version)
+      "#{gem_name}-#{version}.gem"
+    end
+
+    def download_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)
+
+      Dir.chdir @options[:output] do
+        source.download spec
+      end
+
+      package = Gem::Package.new File.join(@options[:output], gem_file)
+      use_package(package)
+      info "#{gem_file} downloaded."
+
+      package
+    end
+
+    def download_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}"]
+
+      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?
+      gem_specs["#{gem_file}"] = spec
+
+      [spec, source]
+    end
+
+    def find_downloaded_gem(gem_file)
+      if File.exist? File.join(@options[:output], gem_file)
+        info "#{gem_file} exists, using already downloaded file."
+        package = Gem::Package.new File.join(@options[:output], gem_file)
+        use_package(package)
+        [package, package.spec]
+      else
+        [nil, nil]
+      end
+    end
+
+    def use_package(package)
+      gem_file = gem_file_name(package.spec.name, package.spec.version)
+      gem_packages["#{gem_file}"] = package
+      gem_specs["#{gem_file}"] = package.spec
+    end
+
+    def download_gems?
+      return true if @options[:keep_all]
+      @options[:param] ? SPEC_FILES_PARAMS.include?(@options[:param]) : true
+    end
+
+    def gem_packages
+      @gem_packages ||= {}
+    end
+
+    def gem_specs
+      @gem_specs ||= {}
+    end
+
+end