skillnad 1.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 99492a058a9870c0d9856a4bb3707b2897d6701bbfdbc0003c39944561e32d2d
+  data.tar.gz: b843677a5d7cb2397d05e9fcb2ca7d658e8c824481b453e59bc48358a7cbf841
+SHA512:
+  metadata.gz: c115570ab3fae285961e3ff68dc0aac4d3a23db1bd283c96bd79670d70483ca905b95b6a872ad8dae34735ebc8554fd9cfcf4f45a7982a370d1b5a67c0fc6e46
+  data.tar.gz: 32d9715037c10509f0de5bab56f8a1ab47f8a56d18f35b9c9c491d6bca887d4fb5fdff9e1bbaf6761021a1ebdcd9c705c7b53c1a3e7abfe28f0dd3a4b91d3a4f

data/LICENSE

@@ -0,0 +1,20 @@
+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
+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
+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,
+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.

data/README.md

@@ -0,0 +1,172 @@
+# skillnad
+
+skillnad 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:
+
+- checking what goes into to a next gem release
+- tracking dependencies and license changes before upgrades
+- spotting anything suspicious and unusual
+
+## Installation
+
+You can install `skillnad` as a gem from RubyGems.org:
+
+```bash
+$ gem install skillnad
+```
+
+## Usage
+
+By default, `skillnad` 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:
+    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
+(...)
+```
+
+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:
+    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:
+
+```bash
+$ 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 *skillnad* 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:
+    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"]
+```
+
+#### Platforms
+
+*skillnad* 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
+```
+
+#### Gems from different source server
+
+If you run your own gem source server, you can override the RubyGems.org default with
+`--sources SOURCE1,SOURCE2` option.
+
+
+### Supported options
+
+To see all possible options run:
+
+```bash
+$ gem compare --help
+```
+
+## Requirements
+
+Currently tested against RubyGems 3.x. Use the `0.0.7` release for RubyGems 2.x.
+
+
+## Copyright
+
+Made by [Josef Strzibny](https://strzibny.name).
+
+Released under the MIT license. Feel free to contribute!

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rake/testtask'
+require 'rdoc/task'
+
+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

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+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
+
+    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
+
+    # Speficy the platform using --platform=PLATFORM
+    add_platform_option
+
+    add_option('-pPARAM', '--param PARAM', 'Compare only a given gemspec parameter (like "version")') 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('-F', '--diff', 'Diff file contents') do
+      options[:diff] = true
+      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
+
+    add_option('-sSOURCES', '--sources SOURCES', 'Use different source URIs for gems (separated by comma)') do |sources, options|
+      options[:sources] = sources.split ','
+    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
+           skillnad 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
+    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/base.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'rainbow'
+require 'rubygems/comparator/utils'
+require 'rubygems/comparator/report'
+
+class Gem::Comparator
+  class Base
+    include Gem::Comparator::Utils
+    include Gem::Comparator::Report::Signs
+
+    attr_accessor :compares
+
+    ##
+    # Compare Gem::Specification objects by default
+    #
+    # To override create your own initialize method and
+    # set expect(:packages) to expect Gem::Package objects.
+
+    def initialize
+      expect(:specs)
+    end
+
+    private
+
+      def expect(what)
+        @compares = what
+      end
+
+      def extract_gem(package, target_dir)
+        gem_file = File.basename(package.spec.full_name, '.gem')
+        gem_dir = File.join(target_dir, gem_file)
+
+        if Dir.exist? gem_dir
+          info "Unpacked gem version exists, using #{gem_dir}."
+          return gem_dir
+        end
+
+        info "Unpacking gem '#{package.spec.full_name}' in " + gem_dir
+        package.extract_files gem_dir
+        gem_dir
+      end
+
+  end
+end

data/lib/rubygems/comparator/dependency_comparator.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require 'rubygems/comparator/base'
+
+class Gem::Comparator
+
+  ##
+  # Gem::Comparator::DependencyComparator can
+  # compare dependencies between gem's versions
+  # based on the given Gem::Specification objects
+
+  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
+
+    def compare(specs, report, options = {})
+      info 'Checking dependencies...'
+
+      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.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?)
+            all_same = false
+          end
+
+          ver = "#{specs[index-1].version}->#{specs[index].version}"
+
+          report[param][ver].section do
+            set_header "#{Rainbow(specs[index-1].version).cyan}->#{Rainbow(s.version).cyan}:"
+
+            nest('deleted').section do
+              set_header '* Deleted:'
+              puts deleted.map { |x| "#{x.name} #{x.requirements_list} (#{x.type})" } unless deleted.empty?
+            end
+
+            nest('added').section do
+              set_header '* Added:'
+              puts added.map { |x| "#{x.name} #{x.requirements_list} (#{x.type})" } unless added.empty?
+            end
+
+            nest('updated').section do
+              set_header '* Updated:'
+              puts updated unless updated.empty?
+            end
+          end
+        end
+        if all_same && options[:log_all]
+          report[param].set_header "#{same} #{type} dependencies:" if options[:log_all]
+          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+
+      #
+      # Return [added, deleted, updated] deps
+
+      def resolve_dependencies(prev_deps, curr_deps)
+        added = curr_deps - prev_deps
+        deleted = prev_deps - curr_deps
+        split_dependencies(added, deleted)
+      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
+              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/dir_utils.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+class Gem::Comparator
+  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.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
+end