solaris-patch 1.0.2 → 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b774165f33d7ac5ff6223d37e0931a4d585f8f22
+  data.tar.gz: 218a198a52c6a11cc1ba0c75bf77ae1dca6cfd0f
+SHA512:
+  metadata.gz: 3d0e51b0fda8d09109d78bc7083d13160d6d1334816e112e79ac598f69eeecaf10c1669167ba87b132be63eed2f6dceae24bca0df1cd24fe2bf6f7b4ee76b1e2
+  data.tar.gz: cb174c16a0d537816bebddf78868a62ca7482dd1808aa3cda8f5193ce783c9ae31e879f0df629c9eeaefebfda5deb765e99059ed070c64ffe4992e498bd0db7f

data/README.rdoc

@@ -7,7 +7,7 @@ Copyright:: Copyright (c) Martin Carpenter 2011
 
 == About
 The solaris-patch gem helps with the manipulation of SunOS and Solaris
-patches. 
+patches.
 
 * Read (or write!) patchdiag.xref files.
 * Find latest version of a patch.
@@ -20,30 +20,30 @@ patches.
 === Download a patch
 
     require 'solaris/patch'
-    Solaris::Patch.download_patch!( '123456-78',
-                                    :to_file => '/tmp/123456-78.zip' )
+    Solaris::Patch.download_patch!('123456-78',
+                                   :to_file => '/tmp/123456-78.zip')
 
 Alternatively:
 
-    patch = Solaris::Patch.new( '123456-78' )
-    patch.download_patch!( :to_dir => '/tmp' )
+    patch = Solaris::Patch.new('123456-78')
+    patch.download_patch!(:to_dir => '/tmp')
 
 === Download a readme
 
     require 'solaris/patch'
-    Solaris::Patch.download_readme!( '123456-78',
-                                     :to_file => '/tmp/123456-78.txt' )
+    Solaris::Patch.download_readme!('123456-78',
+                                    :to_file => '/tmp/123456-78.txt')
 
 === Get the latest version of a patch
 
     require 'solaris/patch'
-    Solaris::Patchdiag.open( '/tmp/patchdiag.xref' ).latest( '123456-01' )
+    Solaris::Patchdiag.open('/tmp/patchdiag.xref').latest('123456-01')
     => "123456|12|..."
 
 === Get the latest non-obsolete version of a possibly obsoleted patch
 
     require 'solaris/patch'
-    Solaris::Patchdiag.open( '/tmp/patchdiag.xref' ).successor( '123456-01' )
+    Solaris::Patchdiag.open('/tmp/patchdiag.xref').successor('123456-01')
     => "234567|12|..."
 
 === Interrogate patchdiag.xref
@@ -51,14 +51,14 @@ Alternatively:
     require 'solaris/patch'
 
     # slurp in patchdiag.xref
-    patchdiag = Solaris::Patchdiag.new( '/tmp/patchdiag.xref' )
+    patchdiag = Solaris::Patchdiag.new('/tmp/patchdiag.xref')
 
     # all sparc patches
     patchdiag.select { |p| p.archs.include? 'sparc' }.inspect
-    => [ "123456-78", ... ]
+    => ["123456-78", ...]
 
     # latest line added to patchdiag.xref
-    most_recent = patchdiag.sort_by( &:date ).last
+    most_recent = patchdiag.sort_by(&:date).last
     most_recent
     => "123456|78|..."
 
@@ -74,4 +74,3 @@ Alternatively:
 
 Dates in patchdiag.xref are Mon/dd/yy format. This gem will break in
 2050 since it assumes year 50 and above is in the 20th century.
-

data/Rakefile

@@ -7,12 +7,12 @@ require 'rubygems/package_task'
 desc 'Default task (package)'
 task :default => [:package]
 
-Rake::TestTask.new( 'test' )
+Rake::TestTask.new('test')
 
 SPECFILE = 'solaris-patch.gemspec'
-if File.exist?( SPECFILE )
-  spec = eval( File.read( SPECFILE ) )
-  Gem::PackageTask.new( spec ).define
+if File.exist?(SPECFILE)
+  spec = eval(File.read(SPECFILE))
+  Gem::PackageTask.new(spec).define
 end
 
 RDoc::Task.new do |rdoc|
@@ -20,8 +20,8 @@ RDoc::Task.new do |rdoc|
   rdoc.title = 'solaris-patch'
   rdoc.options << '--charset' << 'utf-8'
   rdoc.options << '--all'
-  rdoc.rdoc_files.include( 'README.rdoc' )
-  rdoc.rdoc_files.include( FileList[ 'lib/**/*' ] )
-  rdoc.rdoc_files.include( FileList[ 'test/**/*' ] )
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include(FileList['lib/**/*'])
+  rdoc.rdoc_files.include(FileList['test/**/*'])
 end
 

data/lib/solaris.rb

@@ -1,4 +1,3 @@
-
 # Namespace for child classes.
 module Solaris
 
@@ -7,4 +6,3 @@ module Solaris
   require 'solaris/patchdiag_entry'
 
 end # Solaris
-

data/lib/solaris/exception.rb

@@ -1,4 +1,3 @@
-
 module Solaris
 
   class Patch
@@ -32,4 +31,3 @@ module Solaris
   end
 
 end # Solaris
-

data/lib/solaris/patch.rb

@@ -1,4 +1,3 @@
-
 module Solaris
 
   # Class to represent a patch number.
@@ -17,7 +16,7 @@ module Solaris
       :patch => 'https://getupdates.oracle.com/all_unsigned/%s.zip',
       :readme => 'https://getupdates.oracle.com/readme/README.%s'
     }
-    
+
     # The major number of the patch (integer), the part before the dash.
     attr_accessor :major
 
@@ -45,7 +44,7 @@ module Solaris
     # TLDR: Patch.new('123456-78')
     def initialize(major=nil, minor=nil)
       if major
-        patch_no = major.to_s + ( minor ? "-#{minor}" : '' )
+        patch_no = major.to_s + (minor ? "-#{minor}" : '')
         if patch_no =~ /^(\d+)(-(\d+))?$/
           @major = $1.to_i
           @minor = $3.to_i if $3
@@ -57,18 +56,18 @@ module Solaris
 
     # Download this patch. For the options hash see private method Patch#download!
     def download_patch!(opts={})
-      download!( :patch, opts )
+      download!(:patch, opts)
     end
 
     # Download this README. For the options hash see private method Patch#download!
     def download_readme!(opts={})
-      download!( :readme, opts )
+      download!(:readme, opts)
     end
 
     # Return a string representation of this patch. If the minor
     # number has not been set then just return the major number.
     def to_s
-      minor ? "#{@major}-#{Patch.pad_minor( @minor )}" : "#{@major}"
+      minor ? "#{@major}-#{Patch.pad_minor(@minor)}" : "#{@major}"
     end
 
     # Compare patch versions. (Performs a string compare on the full patch numbers).
@@ -79,20 +78,20 @@ module Solaris
     # Download the given patch (this may be a Patch object or a string
     # like '123456-78'). For the options hash see Patch#download!.
     def Patch.download_patch!(patch, opts={})
-      patch_to_dl = Patch.new( patch.to_s )
-      patch_to_dl.download_patch!( opts )
+      patch_to_dl = Patch.new(patch.to_s)
+      patch_to_dl.download_patch!(opts)
     end
 
     # Download the given readme (this may be a Patch object or a string
     # like '123456-78'). For the options hash see Patch#download!.
     def Patch.download_readme!(patch, opts={})
-      patch_to_dl = Patch.new( patch.to_s )
-      patch_to_dl.download_readme!( opts )
+      patch_to_dl = Patch.new(patch.to_s)
+      patch_to_dl.download_readme!(opts)
     end
 
     # Left pad a minor version number with zeros as required.
     def Patch.pad_minor(minor)
-      "#{minor.to_s.rjust( 2, '0' )}"
+      "#{minor.to_s.rjust(2, '0')}"
     end
 
     private
@@ -102,15 +101,14 @@ module Solaris
     def download!(type, opts={})
       raise ArgumentError, "Patch #{self.inspect} requires a major number to download" unless @major
       raise ArgumentError, "Patch #{self.inspect} requires a minor number to download" unless @minor
-      raise ArgumentError, "Unknown type #{type.inspect}" unless URL[ type ]
-      url = URL[ type ] % self.to_s
+      raise ArgumentError, "Unknown type #{type.inspect}" unless URL[type]
+      url = URL[type] % self.to_s
       opts = {
         :agent => 'Wget/1.10.2', # default user agent, required by Oracle
-      }.merge( opts )
-      Solaris::Util.download!( url, opts )
+      }.merge(opts)
+      Solaris::Util.download!(url, opts)
     end
-      
+
   end # Patch
 
 end # Solaris
-

data/lib/solaris/patchdiag.rb

@@ -1,4 +1,3 @@
-
 module Solaris
 
   # Class to represent the Oracle patchdiag "database" (file).
@@ -20,17 +19,30 @@ module Solaris
     # URL of latest patchdiag.xref from Oracle.
     DEFAULT_XREF_URL = 'https://getupdates.oracle.com/reports/patchdiag.xref'
 
+    # The date of this patchdiag.xref, parsed from the header.
+    attr_writer :date
+
+    # The array of lines that comprise the header, sans trailing newline.
+    attr_accessor :header
+
+    # The array of lines that comprise the footer, sans trailing newline.
+    attr_accessor :footer
+
     # Create a new patchdiag database object by reading the given
     # xref file (this may be a filename (string) or a fileish object
     # (File, StringIO)). If no xref file is given then the default
     # is read (/var/tmp/patchdiag.xref); this is the cache file used
     # by Patch Check Advanced (pca).
     def initialize(xref_file=DEFAULT_XREF_FILE)
-      xref_file = File.new( xref_file ) if xref_file.is_a?( String )
-      @_entries = xref_file.
-        readlines.
-        reject { |line| line =~ /^#|^\s*$/ }. # discard comments, blanks
-        map { |line| PatchdiagEntry.new( line ) }
+      xref_file = File.new(xref_file) if xref_file.is_a?(String)
+      @entries, @header, @footer = [], [], []
+      xref_file.each_line do |line|
+        if line =~ /^\d/
+          @entries << PatchdiagEntry.new(line)
+        else
+          (@entries.empty? ? @header : @footer) << line.chomp
+        end
+      end
     end
 
     # Download the patchdiag database and return it as a string.
@@ -38,14 +50,14 @@ module Solaris
     # to disk unless :to_file or :to_dir are given.
     # For the options hash argument see Solaris::Util.download!
     def Patchdiag.download!(opts={})
-      url = opts.delete( :url ) || DEFAULT_XREF_URL
-      Util.download!( url, opts )
+      url = opts.delete(:url) || DEFAULT_XREF_URL
+      Util.download!(url, opts)
     end
 
     # Open the given optional patchdiag xref file and yield to the
     # optional block.
     def Patchdiag.open(xref_file=DEFAULT_XREF_FILE, &blk)
-      patchdiag = Patchdiag.new( xref_file )
+      patchdiag = Patchdiag.new(xref_file)
       if block_given?
         yield patchdiag
       else
@@ -55,13 +67,20 @@ module Solaris
 
     # Create and return a deep copy of this object.
     def clone
-      Marshal.load( Marshal.dump( self ) )
+      Marshal.load(Marshal.dump(self))
+    end
+
+    # Return the date parsed from the patchdiag.xref comment lines.
+    def date
+      ## PATCHDIAG TOOL CROSS-REFERENCE FILE AS OF Jan/23/14 ##
+      @date ||= @header.find { |line| line =~ /\s(\w\w\w\/\d\d\/\d\d)\s/ } &&
+        Date.parse($1)
     end
 
     # For Enumerator module: yields each Solaris::PatchdiagEntry in
     # turn.
     def each(&blk)
-      @_entries.each( &blk )
+      @entries.each(&blk)
     end
 
     # Returns an array of Solaris::PatchdiagEntry from the
@@ -73,16 +92,16 @@ module Solaris
     # major number are returned. Returns an empty array if no such
     # patches can be found. This method overrides Enumerable#find.
     def find(patch)
-      patch = Patch.new( patch.to_s )
+      patch = Patch.new(patch.to_s)
       property = patch.minor ? :to_s : :major
-      comparator = patch.send( property )
-      entries.select { |pde| pde.patch.send( property ) == comparator }
+      comparator = patch.send(property)
+      @entries.select { |pde| pde.patch.send(property) == comparator }
     end
 
     # Strangely Enumerable module does not define Enumerable#last (although
     # it does define Enumerable#first) so we define last here.
     def last
-      entries.last
+      @entries.last
     end
 
     # Return the Solaris::PatchdiagEntry of the latest version of the
@@ -90,24 +109,24 @@ module Solaris
     # Solaris::Patch). Throws Solaris::Patch::NotFound if the patch
     # cannot be found in patchdiag.xref.
     def latest(patch)
-      major = Patch.new( patch.to_s ).major
-      find( major ).max ||
-        raise( Solaris::Patch::NotFound,
-              "Cannot find patch #{patch} in patchdiag.xref" )
+      major = Patch.new(patch.to_s).major
+      find(major).max ||
+        raise(Solaris::Patch::NotFound,
+              "Cannot find patch #{patch} in patchdiag.xref")
     end
 
     # Returns a (deep) copy of +self+ with the entries sorted, takes an
     # optional block. This method overrides Enumerable#sort. See also
     # Solaris::Patchdiag#sort!.
     def sort(&blk)
-      clone.sort!( &blk )
+      clone.sort!(&blk)
     end
 
     # Returns +self+ with the entries sorted in place, takes an optional
     # block. See also Solaris::Patchdiag#sort.
     def sort!(&blk)
-      # use @_entries since #entries returns a copy
-      @_entries.sort!( &blk )
+      # use @entries since #entries returns a copy
+      @entries.sort!(&blk)
       self
     end
 
@@ -125,21 +144,21 @@ module Solaris
     # The ancestors parameter is a recursion accumulator and should not
     # normally be assigned to by callers.
     def successors(patch, ancestors=[])
-      patch = Patch.new( patch.to_s )
+      patch = Patch.new(patch.to_s)
       raise Solaris::Patch::SuccessorLoop,
-        "Loop detected for patch #{patch} with ancestors #{ancestors.inspect}" if ancestors.include?( patch )
+        "Loop detected for patch #{patch} with ancestors #{ancestors.inspect}" if ancestors.include?(patch)
       ancestors << patch
       if ! patch.minor # patch has no minor number
-        successors( latest( patch ).patch, ancestors )
-      elsif ! entry = find( patch ).last # explicit patch not found
-        latest_patch = latest( patch ).patch
+        successors(latest(patch).patch, ancestors)
+      elsif ! entry = find(patch).last # explicit patch not found
+        latest_patch = latest(patch).patch
         raise Solaris::Patch::NotFound,
           "Patch #{patch} not found and has no later version" if latest_patch.minor <= patch.minor
-        successors( latest_patch, ancestors )
+        successors(latest_patch, ancestors)
       else
         if entry.obsolete?
           succ = entry.successor
-          successors( succ, ancestors )
+          successors(succ, ancestors)
         elsif entry.bad?
           raise BadSuccessor, "Terminal successor #{patch} is bad/withdrawn"
         else
@@ -151,17 +170,16 @@ module Solaris
     # Return the Solaris::PatchdiagEntry of the latest non-obsolete successor
     # of this patch. This is a convenience method for #successors.last.
     def successor(patch)
-      latest( successors( patch ).last )
+      latest(successors(patch).last)
     end
 
     # Returns a string representation of the patchdiag.xref. All comments
     # and blank lines are elided.
     def to_s
-      entries.join("\n")
+      (@header + @entries + @footer).join("\n") << "\n"
     end
     alias to_str to_s
 
   end # Patchdiag
 
 end # Solaris
-

data/lib/solaris/patchdiag_entry.rb

@@ -1,4 +1,3 @@
-
 module Solaris
 
   # Class to represent a line from Sun's patchdiag.xref patch "database".
@@ -56,23 +55,27 @@ module Solaris
     # patchdiag.xref).
     attr_accessor :y2k
 
+    # Number of pipe-delimited fields in a patchdiag line.
+    FIELDS = 11
+
     def initialize(patchdiag_line)
-      fields = patchdiag_line.split( '|', 11 )
+      fields = patchdiag_line.split('|', FIELDS)
+      raise ArgumentError, "Not enough fields in line: #{patchdiag_line}" unless fields.size == FIELDS
       major, minor, date, @recommended, @security, @obsolete, bad, @os, archs, pkgs, @synopsis = *fields
-      @archs = archs.split( ';' )
+      @archs = archs.split(';')
       if date == ''
         year, month, day = 1970, 1, 1
       else
-        month_s, day_s, year_s = *date.split( '/' )
-        year = ( year_s.to_i > 50 ? "19#{year_s}" : "20#{year_s}" ).to_i
-        month = Date::ABBR_MONTHNAMES.index( month_s )
+        month_s, day_s, year_s = *date.split('/')
+        year = (year_s.to_i > 50 ? "19#{year_s}" : "20#{year_s}").to_i
+        month = Date::ABBR_MONTHNAMES.index(month_s)
         day = day_s.to_i
       end
       @bad = bad =~ /B/ ? 'B' : ' '
       @y2k = bad =~ /Y/ ? 'Y' : ' '
-      @date = Date.new( year, month, day )
-      @patch = Patch.new( major, minor )
-      @pkgs = pkgs.split( ';' )
+      @date = Date.new(year, month, day)
+      @patch = Patch.new(major, minor)
+      @pkgs = pkgs.split(';')
       @synopsis.chomp!
     end
 
@@ -82,12 +85,12 @@ module Solaris
 
     # Download this patch. For options hash see Patch#download!.
     def download_patch!(opts={}) ;
-      @patch.download_patch!( opts )
+      @patch.download_patch!(opts)
     end
 
     # Download the README for this patch. For options hash see Patch#download!.
     def download_readme!(opts={})
-      @patch.download_readme!( opts )
+      @patch.download_readme!(opts)
     end
 
     # Returns this entries major patch number as an integer.
@@ -141,7 +144,7 @@ module Solaris
 
       # See if we can find a successor
       if synopsis =~ /obsolete(d?) by\s*(:?)\s*(\d+(-\d+)?)/i
-        Patch.new( $3 )
+        Patch.new($3)
       else
         raise Solaris::Patch::InvalidSuccessor,
           "Failed to parse successor to obsolete patchdiag entry for patch #{patch.inspect}"
@@ -151,16 +154,17 @@ module Solaris
     # Output this patchdiag xref entry as a string, in format of Oracle's
     # database.
     def to_s
-      [ patch.major,
-        Patch.pad_minor( patch.minor ),
+      [
+        patch.major,
+        Patch.pad_minor(patch.minor),
         date_s,
         @recommended,
         @security,
         @obsolete,
-        @bad + @y2k,
+        @y2k + @bad,
         @os,
-        join_semis( @archs ),
-        join_semis( @pkgs ),
+        join_semis(@archs),
+        join_semis(@pkgs),
         @synopsis
       ].join('|')
     end
@@ -179,9 +183,10 @@ module Solaris
 
     # Convert the Date object to a date string as found in patchdiag.xref.
     def date_s
-      [ Date::ABBR_MONTHNAMES[ @date.mon ], # month eg Jan
+      [
+        Date::ABBR_MONTHNAMES[@date.mon], # month eg Jan
         @date.mday.to_s.rjust(2, '0'), # day of month
-        @date.year % 100 # 2 digit year
+        (@date.year % 100).to_s.rjust(2, '0') # 2 digit year
       ].join('/')
     end
 
@@ -195,4 +200,3 @@ module Solaris
   end # PatchdiagEntry
 
 end # Solaris
-