polisher 0.6.1 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 376315592c88c3de00fca0125ae64583fb660764
-  data.tar.gz: 4d11de1d33a201b7195c090c4831d8e8ee61783c
+  metadata.gz: cccecc84da6d0524db953260dc592ee5424f33b0
+  data.tar.gz: c9dc301daf1b9366e5d62eb68615b9b53004d6a8
 SHA512:
-  metadata.gz: 6217a46af865d179c17d64e8c7cc030f624470b35b480e04f5a4cf2907161acd1afff8b57f283a8c394e0fd401baba77bef07e9318c57b9ac39e7360a461bc66
-  data.tar.gz: fa067ed1e2161d7b185108476c588c24f58f2bc26ce894f499b6b212563366fe68df5e431528d1ef6ce252263e4b930e2a4939585ba90eb908b5b1ca4b3794fa
+  metadata.gz: bd10517253ce3ddf2c69a0169d720d52031dc61586078f7598bbd25909057f73aa0b96c4f7610ef996458bc1303b9c2d21381a7a08d338f5a85c7c9a07f5f7fb
+  data.tar.gz: eea79b07d89a0966245a48654967bb49be12e6df13da1c1c15ba1b4c283ca2d85812a46be3d5f6f41bb00e75f83dd72c2b34cee107016744689323f25cbf25a6

data/README.md

@@ -136,7 +136,7 @@ The test suite is based on rspec, to run:
 
 ## Legal & Other
 
-Polisher is Licensed under the MIT License, Copyright (C) 2013 Red Hat, Inc.
+Polisher is Licensed under the MIT License, Copyright (C) 2013-2014 Red Hat, Inc.
 
 See the commit log for authors of the project. All feedback and contributions
 are more than welcome.

data/bin/binary_gem_resolver.rb

@@ -10,7 +10,7 @@
 # ./binary_gem_resolver.rb <path-to-gem-install>
 #
 # Licensed under the MIT license
-# Copyright (C) 2013 Red Hat, Inc.
+# Copyright (C) 2013-2014 Red Hat, Inc.
 ###########################################################
 
 require 'colored'

data/bin/gem_dependency_checker.rb

@@ -11,7 +11,7 @@
 # before invoking this script
 #
 # Licensed under the MIT license
-# Copyright (C) 2013 Red Hat, Inc.
+# Copyright (C) 2013-2014 Red Hat, Inc.
 ###########################################################
 
 require 'optparse'
@@ -33,7 +33,8 @@ conf = { :gemfile             => './Gemfile',
          :check_rhn           => false,
          :check_yum           => false,
          :check_bugzilla      => false,
-         :check_errata        => false}
+         :check_errata        => false,
+         :check_bodhi         => false}
 
 optparse = OptionParser.new do |opts|
   opts.on('-h', '--help', 'Display this help screen') do
@@ -118,6 +119,7 @@ targets << Polisher::VersionChecker::KOJI_TARGET   if conf[:check_koji]
 targets << Polisher::VersionChecker::FEDORA_TARGET if conf[:check_fedora]
 targets << Polisher::VersionChecker::GIT_TARGET    if conf[:check_git]
 targets << Polisher::VersionChecker::YUM_TARGET    if conf[:check_yum]
+targets << Polisher::VersionChecker::BODHI_TARGET  if conf[:check_bodhi]
 targets  = Polisher::VersionChecker::ALL_TARGETS   if targets.empty?
 Polisher::VersionChecker.check targets
 

data/bin/git_gem_updater.rb

@@ -8,7 +8,7 @@
 #   git_gem_updater.rb -n <gem_name>
 #
 # Licensed under the MIT License
-# Copyright (C) 2013 Red Hat, Inc.
+# Copyright (C) 2013-2014 Red Hat, Inc.
 
 require 'colored'
 require 'curb'
@@ -61,7 +61,7 @@ Dir.chdir conf[:dir]
 conf[:gems].each do |gem_name|
   pkg =
     begin
-      Polisher::GitPackage.clone(gem_name)
+      Polisher::GitPackage.new(:name => gem_name).clone
     rescue => e
       next
     end
@@ -73,7 +73,7 @@ conf[:gems].each do |gem_name|
 
   pkg.build
 
-  unless pkg.has_check?
+  unless pkg.spec.has_check?
     puts "Warning: no %check section in spec,\
           manually verify functionality!".bold.red
   end

data/bin/ruby_rpm_spec_updater.rb

@@ -13,9 +13,8 @@
 #   ruby_rpm_spec_updater.rb <path-to-spec> <optional-source-or-version>
 #
 # Licensed under the MIT License
-# Copyright (C) 2013 Red Hat, Inc.
+# Copyright (C) 2013-2014 Red Hat, Inc.
 
-require 'colored'
 require 'polisher'
 
 spec_file = ARGV.shift
@@ -26,4 +25,4 @@ source    = source.nil? ?
   Polisher::Upstream.parse(source)
 
 rpmspec.update_to(source)
-puts rpmspec.to_string.yellow.bold
+puts rpmspec.to_string

data/lib/polisher.rb

@@ -1,7 +1,7 @@
 # Ruby Polisher
 #
 # Licensed under the MIT license
-# Copyright (C) 2013 Red Hat, Inc.
+# Copyright (C) 2013-2014 Red Hat, Inc.
 
 require 'polisher/core'
 require 'polisher/rpmspec'

data/lib/polisher/apt.rb

@@ -1,7 +1,7 @@
 # Polisher APT Operations
 #
 # Licensed under the MIT license
-# Copyright (C) 2013 Red Hat, Inc.
+# Copyright (C) 2013-2014 Red Hat, Inc.
 
 module Polisher
   class Apt

data/lib/polisher/bodhi.rb

@@ -1,22 +1,20 @@
 # Polisher Bodhi Operations
 #
 # Licensed under the MIT license
-# Copyright (C) 2013 Red Hat, Inc.
+# Copyright (C) 2013-2014 Red Hat, Inc.
 
+# XXX issue w/ retreiving packages from pkgwat causing sporadic issues:
+# https://github.com/fedora-infra/fedora-packages/issues/55
+
+# fedora pkgwat provides a frontend to bodhi
 require 'pkgwat'
 
 module Polisher
   class Bodhi
     def self.versions_for(name, &bl)
-      # XXX issue w/ retreiving packages from pkgwat causing issues:
-      # https://github.com/fedora-infra/fedora-packages/issues/55
-
-      # fedora pkgwat provides a frontend to bodhi
-      updates = Pkgwat.get_updates("rubygem-#{name}", 'all', 'all') # TODO set timeout
-      updates.reject! { |u|
-        u['stable_version'] == 'None' && u['testing_version'] == "None"
-      }
-      versions = updates.collect { |u| u['stable_version'] }
+      versions = Pkgwat.get_updates("rubygem-#{name}", 'all', 'all').
+                   select  { |update| update['stable_version']  != 'None' }.
+                   collect { |update| update['stable_version'] }
       bl.call(:bodhi, name, versions) unless(bl.nil?) 
       versions
     end

data/lib/polisher/bugzilla.rb

@@ -1,7 +1,9 @@
 # Polisher Bugzilla Operations
 #
 # Licensed under the MIT license
-# Copyright (C) 2013 Red Hat, Inc.
+# Copyright (C) 2013-2014 Red Hat, Inc.
+
+# TODO use ruby_bugzilla to search to packages in bz
 
 module Polisher
   class Bugzilla

data/lib/polisher/core.rb

@@ -1,23 +1,29 @@
 # Polisher Core Ruby Extensions
 #
 # Licensed under the MIT license
-# Copyright (C) 2013 Red Hat, Inc.
+# Copyright (C) 2013-2014 Red Hat, Inc.
 
 require 'polisher/rpmspec'
 
 class String
+  # Return bool indicating if self is a path to a gem
   def gem?
     File.extname(self) == ".gem"
   end
 
+  # Return bool indicating if self is a path to a gemspec
   def gemspec?
     File.extname(self) == ".gemspec"
   end
 
+  # Return bool indicating if self is a path to a Gemfile
   def gemfile?
     File.basename(self) == "Gemfile"
   end
 
+  # Remove and replace all occurances of rpm macros in self with non-rpm
+  # macro correspondents. If no rpm macro is specified macro will
+  # simply be removed
   def unrpmize
     fmm = Polisher::RPMSpec::FILE_MACRO_MATCHERS
     fmr = Polisher::RPMSpec::FILE_MACRO_REPLACEMENTS
@@ -26,6 +32,8 @@ class String
     f
   end
 
+  # Replace all occurrances of non-rpm macro strings in self
+  # with their macro correspondences
   def rpmize
     fmr = Polisher::RPMSpec::FILE_MACRO_REPLACEMENTS.invert
     fmr.keys.inject(self) { |file, r| file.gsub(r, fmr[r]) }

data/lib/polisher/errata.rb

@@ -1,13 +1,15 @@
 # Polisher Errata Operations
 #
 # Licensed under the MIT license
-# Copyright (C) 2013 Red Hat, Inc.
+# Copyright (C) 2013-2014 Red Hat, Inc.
 
 require 'json'
 require 'curb'
 
 module Polisher
   class Errata
+    # Initialize/return singleton curl handle to
+    # query errata and set url
     def self.client(url)
       @curl ||= begin
         c = Curl::Easy.new
@@ -23,22 +25,32 @@ module Polisher
     end
 
     def self.versions_for(advisory_url, name, &bl)
-      url    = "#{advisory_url}/builds"
-      result = self.client(url).get
-      json   = JSON.parse result.body_str
+      result = self.client("#{advisory_url}/builds").get
       versions =
-        json.collect { |tag, builds|
-          builds.collect { |build|
-            pkg,meta = *build.flatten
-            if pkg =~ /^rubygem-#{name}-([^-]*)-.*$/
-              $1
-            else
-              nil
-            end
-          }
-        }.flatten.compact
+        JSON.parse(result.body_str).collect { |tag, builds|
+          ErrataBuild.builds_matching(builds, name)
+        }.flatten
+
       bl.call(:errata, name, versions) unless(bl.nil?) 
       versions
     end
   end
+
+  class ErrataBuild
+    def self.builds_matching(builds, name)
+      builds.collect { |build|
+        self.build_matches?(build, name) ? self.build_version(build, name) : nil
+      }.compact
+    end
+
+    def self.build_matches?(build, name)
+      pkg,meta = *build.flatten
+      pkg =~ /^rubygem-#{name}-([^-]*)-.*$/
+    end
+
+    def self.build_version(build, name)
+      pkg,meta = *build.flatten
+      pkg.split('-')[2]
+    end
+  end
 end

data/lib/polisher/fedora.rb

@@ -1,7 +1,7 @@
 # Polisher Fedora Operations
 #
 # Licensed under the MIT license
-# Copyright (C) 2013 Red Hat, Inc.
+# Copyright (C) 2013-2014 Red Hat, Inc.
 
 require 'curb'
 require 'pkgwat'

data/lib/polisher/formatter.rb

@@ -0,0 +1 @@
+# TODO

data/lib/polisher/gem.rb

@@ -1,36 +1,55 @@
 # Polisher Gem Represenation
 #
 # Licensed under the MIT license
-# Copyright (C) 2013 Red Hat, Inc.
+# Copyright (C) 2013-2014 Red Hat, Inc.
 
 require 'curb'
 require 'json'
 require 'yaml'
 require 'tempfile'
 require 'pathname'
+require 'fileutils'
+require 'awesome_spawn'
 require 'rubygems/installer'
 require 'active_support/core_ext'
 
 require 'polisher/version_checker'
+require 'polisher/gem_cache'
 
 module Polisher
   class Gem
     GEM_CMD      = '/usr/bin/gem'
+    DIFF_CMD     = '/usr/bin/diff'
+
+    # Common files shipped in gems that we should ignore
+    IGNORE_FILES = ['.gemtest', '.gitignore', '.travis.yml',
+                    /.*.gemspec/, /Gemfile.*/, 'Rakefile',
+                    /rspec.*/, '.yardopts', '.rvmrc']
+
+    # TODO also mark certain files to be tagged as %{doc}
 
     attr_accessor :spec
     attr_accessor :name
     attr_accessor :version
     attr_accessor :deps
     attr_accessor :dev_deps
-    attr_accessor :files
+
+    attr_accessor :path
 
     def initialize(args={})
       @spec     = args[:spec]
       @name     = args[:name]
       @version  = args[:version]
+      @path     = args[:path]
       @deps     = args[:deps]     || []
       @dev_deps = args[:dev_deps] || []
-      @files    = args[:files]    || []
+    end
+
+    # Return bool indiicating if the specified file is on the IGNORE_FILES list
+    def self.ignorable_file?(file)
+      IGNORE_FILES.any? do |ignore|
+        ignore.is_a?(Regexp) ? ignore.match(file) : ignore == file
+      end
     end
 
     # Retrieve list of the versions of the specified gem installed locally
@@ -67,7 +86,7 @@ module Polisher
 
         metadata[:dev_deps] =
           specj['dependencies']['development'].collect { |d|
-            ::Gem::Dependency.new d['name'], d['requirements']
+            ::Gem::Dependency.new d['name'], d['requirements'].split(',')
           }
 
       elsif args.has_key?(:gemspec)
@@ -94,55 +113,80 @@ module Polisher
     end
 
     # Download the gem and return the binary file contents as a string
+    #
     # @return [String] binary gem contents
     def download_gem
+      cached = GemCache.get(@name, @version)
+      return cached unless cached.nil?
+
+      # TODO utilize a singleton curl instance (akin to errata module)
       gem_path = "https://rubygems.org/gems/#{@name}-#{@version}.gem"
       curl = Curl::Easy.new(gem_path)
       curl.follow_location = true
       curl.http_get
       gemf = curl.body_str
+
+      GemCache.set(@name, @version, gemf)
+      gemf
+    end
+
+    # Returns path to downloaded gem
+    #
+    # @return [String] path to downloaded gem
+    def downloaded_gem_path
+      # ensure gem is downloaded
+      self.download_gem
+      GemCache.path_for(@name, @version)
     end
 
-    # Refresh the gem spec
-    def refresh_spec
-      gemf = download_gem
-      tgem = Tempfile.new(@name)
-      tgem.write gemf
-      tgem.close
-
-      @spec = YAML.load `#{GEM_CMD} specification #{tgem.path}`
-
-      # update deps, dev_deps
-      @deps =
-        @spec.dependencies.select { |dep|
-          dep.type == :runtime
-        }.collect { |dep| dep }
-
-      @dev_deps =
-        @spec.dependencies.select { |dep|
-          dep.type == :development
-        }.collect { |dep| dep }
+    # Returns path to gem, either specified one of downloaded one
+    def gem_path
+      @path || downloaded_gem_path
     end
 
-    # Retrieve the list of files in the gem
+    # Unpack files & return unpacked directory
     #
-    # @return [Array<String>] list of files in the gem
-    def refresh_files
-      gemf = download_gem
-      tgem = Tempfile.new(@name)
-      tgem.write gemf
-      tgem.close
-
-      @files = []
-      pkg = ::Gem::Installer.new tgem.path, :unpack => true
-      Dir.mktmpdir { |dir|
+    # If block is specified, it will be invoked
+    # with directory after which directory will be removed
+    def unpack(&bl)
+      dir = nil
+      pkg = ::Gem::Installer.new gem_path, :unpack => true
+
+      if bl
+        Dir.mktmpdir { |dir|
+          pkg.unpack dir
+          bl.call dir
+        }
+      else
+        dir = Dir.mktmpdir
         pkg.unpack dir
+      end
+
+      dir
+    end
+
+    # Iterate over each file in gem invoking block with path
+    def each_file(&bl)
+      self.unpack do |dir|
         Pathname(dir).find do |path|
-          pathstr = path.to_s.gsub(dir, '')
-          @files << pathstr unless pathstr.blank?
+          next if path.to_s == dir.to_s
+          bl.call path
         end
-      }
-      @files
+      end
+    end
+
+    # Retrieve the list of paths to files in the gem
+    #
+    # @return [Array<String>] list of files in the gem
+    def file_paths
+      @file_paths ||= begin
+        files = []
+        self.each_file do |path|
+          pathstr = path.to_s.gsub("#{dir}/", '')
+          files << pathstr unless pathstr.blank?
+        end
+        files
+      end
     end
 
     # Retrieve gem metadata and contents from rubygems.org
@@ -153,7 +197,6 @@ module Polisher
       gem_json_path = "https://rubygems.org/api/v1/gems/#{name}.json"
       spec = Curl::Easy.http_get(gem_json_path).body_str
       gem  = self.parse spec
-      gem.refresh_files
       gem
     end
 
@@ -193,5 +236,47 @@ module Polisher
       end
       versions
     end
+
+    # Return list of file paths marked as vendored
+    def vendored_file_paths
+      self.file_paths.select { |f| f.include?('vendor/') }
+    end
+
+    # Return list of vendered gems in file list
+    def vendored
+      vendored_file_paths.inject({}){ |v,fp|
+        vendored_file = fp.split('/')
+        vendor_index  = vendored_file.index('vendor')
+
+        # only process vendor'd dirs:
+        next v if vendor_index + 2 == vendored_file.size
+
+        vname = vendored_file[vendor_index + 1]
+        vversion = nil
+        # TODO set vversion from version.rb:
+        #vf.last.downcase == 'version.rb'
+        v[vname] = vversion
+        v
+      }
+    end
+
+    # Return diff of content in this gem against other
+    def diff(other)
+      out = nil
+
+      begin
+        this_dir  = self.unpack
+        other_dir = other.unpack
+        result = AwesomeSpawn.run("#{DIFF_CMD} -r #{this_dir} #{other_dir}")
+        out = result.output
+      rescue
+      ensure
+        FileUtils.rm_rf this_dir
+        FileUtils.rm_rf other_dir
+      end
+
+      out
+    end
+
   end # class Gem
 end # module Polisher