gigamo-aurb 0.5.4 → 0.5.5

data/aurb.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = 'aurb'
-  s.version = '0.5.4'
-  s.date = %q{2009-04-10}
+  s.version = '0.5.5'
+  s.date = %q{2009-04-12}
   s.summary = %q{A simple AUR utility}
   s.email = %q{gigamo@gmail.com}
   s.homepage = %q{http://github.com/gigamo/aurb}

data/bin/aurb

@@ -1,13 +1,21 @@
 #!/usr/bin/env ruby
-%w(optparse rubygems cgi json open-uri pathname zlib facets/ansicode facets/minitar facets/version).each do |lib|
-  require lib
-end
+require 'optparse'
+require 'fileutils'
+require 'rubygems'
+require 'cgi'
+require 'json'
+require 'open-uri'
+require 'pathname'
+require 'zlib'
+require 'facets/ansicode'
+require 'facets/minitar'
+require 'facets/version'
 
 module Aurb
   Config  = Struct.new(:search, :info, :sync, :dir)
-  Version = [0, 5, 4]
+  Version = [0, 5, 5]
   # Change Me!
-  DlPath  = File.join(File.expand_path('~'), 'abs') # => '/home/gig/abs' in my case
+  DlPath  = File.join(File.expand_path('~'), 'abs') # => '/home/gig/abs'
 
   def self.aur
     @aur ||= Aur.new
@@ -15,7 +23,11 @@ module Aurb
 
   module Util
     # Colorize a string
-    # Example: color('Text', :green)
+    #
+    #   color('Text', :green)
+    #
+    # For a full list of available effects, see
+    # http://facets.rubyforge.org/doc/api/more/classes/ANSICode.html
     def color(text, effect)
       ANSICode.send(effect.to_sym) << text << ANSICode.clear
     end
@@ -36,6 +48,7 @@ module Aurb
       @opts = Opts.new(ARGV)
     end
 
+    # Starts Aurb
     def start
       # Exit peacefully on *INT
       trap(:INT) { exit 0 }
@@ -48,6 +61,10 @@ module Aurb
       exit 1
     end
 
+    # Downloads +packages+
+    #
+    #   download('awesome-git', 'aurb')
+    #
     def download(*packages)
       packages.each do |package|
         list(package).each do |names|
@@ -55,13 +72,17 @@ module Aurb
             # Check if the package exists in the community repo
             # Invoke pacman if so
             if in_sync? package
-              puts "#{color('==>', :yellow)} Found #{package} in community repo. Pacman will do."
+              puts "#{color('==>', :yellow)} Found #{package} in community repo. \
+Pacman will do."
               exec "sudo pacman -S #{package}"
             else
             # Else download and untar it from the AUR
               Dir.chdir(@config.dir) do |dir|
+                # Remove old files if they already exist instead of overwriting
+                FileUtils.rm("#{package}.tar.gz") if File.exists?("#{package}.tar.gz")
                 fetch(package, dir)
                 puts "#{color('==>', :yellow)} Downloaded #{package}"
+                FileUtils.rm_r(package) if File.directory?(package)
                 untar(package)
                 puts "#{color('==>', :yellow)} Unpacked #{package}"
               end
@@ -71,6 +92,10 @@ module Aurb
       end
     end
 
+    # Searches for +package+
+    #
+    #   search('awesome')
+    #
     def search(package)
       count, threads = 0, []
       list(package).each do |names|
@@ -83,10 +108,13 @@ module Aurb
             result = result['results']
             # Skip this iteration if the package is found in the community repo
             next if in_sync? result['Name']
-            # Check both name and description for matches
-            if package.any? { |pac| (result['Name'].include?(pac)) || (result['Description'].include?(pac)) }
+            if package.any? do |pac|
+              # Check both name and description for matches
+              (result['Name'].include?(pac)) || (result['Description'].include?(pac))
+            end
               count += 1
-              puts "[#{result['OutOfDate'] == '1' ? color('✘', :red) : color('✔', :green)}] #{color(result['Name'], :blue)} (#{result['Version']}): #{result['Description']}"
+              puts "[#{result['OutOfDate'] == '1' ? color('✘', :red) : color('✔', :green)}] \
+#{color(result['Name'], :blue)} (#{result['Version']}): #{result['Description']}"
             end
           end
         end
@@ -94,9 +122,12 @@ module Aurb
       # Join the threads after searching is finished
       threads.each { |t| t.join }
 
-      puts "\n#{color('==>', :yellow)} Found #{color(count.to_s, :magenta)} #{count == 1 ? 'result' : 'results'}"
+      puts "\n#{color('==>', :yellow)} Found #{color(count.to_s, :magenta)} \
+#{count == 1 ? 'result' : 'results'}"
     end
 
+    # Checks the aur for upgrades to local packages that were not found in any
+    # official repository.
     def check_upgrade
       count, upgradable = 0, []
       `pacman -Qm`.each_line do |line|
@@ -115,7 +146,8 @@ module Aurb
               # Insert the upgradable package's name into an array which we will
               # use later to prompt the download
               upgradable << name
-              puts "#{color(name, :bold)} (#{color(version, :red)}) can be upgraded to #{color(result['Version'], :green)}"
+              puts "#{color(name, :bold)} (#{color(version, :red)}) \
+can be upgraded to #{color(result['Version'], :green)}"
             end
           else
             puts "#{color(name, :bold)} (#{color(version, :green)}) is up to date"
@@ -123,7 +155,8 @@ module Aurb
         end
       end
 
-      puts "\n#{color('==>', :yellow)} Found #{color(count.to_s, :magenta)} #{count == 1 ? 'upgrade' : 'upgrades'}"
+      puts "\n#{color('==>', :yellow)} Found #{color(count.to_s, :magenta)} \
+#{count == 1 ? 'upgrade' : 'upgrades'}"
       unless upgradable.empty?
         # Prompt asking to download the upgrades
         upgradable.each do |pkg|
@@ -134,10 +167,18 @@ module Aurb
     end
 
   private
+    # Checks if a package exists in the community repository
+    #
+    #   in_sync?('awesome-git')
+    #
     def in_sync?(package)
       Dir["#{@config.sync}/#{package}-*"].first ? true : false
     end
 
+    # Returns a list of packages found by a search
+    #
+    #   list('awesome-git')
+    #
     def list(package)
       info, list = json(@config.search % CGI::escape(package)), []
       if info['type'] == 'error'
@@ -149,6 +190,10 @@ module Aurb
       list.sort unless list.empty?
     end
 
+    # Downloads given +package+ into +dir+
+    #
+    #   fetch('awesome-git', $0.dirname)
+    #
     def fetch(package, dir)
       open("http://aur.archlinux.org/packages/#{package}/#{package}.tar.gz") do |remote|
         File.open("#{dir}/#{package}.tar.gz", 'wb') do |local|
@@ -157,10 +202,21 @@ module Aurb
       end
     end
 
+    # Untars +package+
+    #
+    #   untar('awesome-git')   #=> .tar.gz is automagically appended
+    #
     def untar(package)
-      Archive::Tar::Minitar.unpack(Zlib::GzipReader.new(File.open("#{package}.tar.gz", 'rb')), Dir.pwd)
+      Archive::Tar::Minitar.unpack(
+        Zlib::GzipReader.new(File.open("#{package}.tar.gz", 'rb')),
+        Dir.pwd
+      )
     end
 
+    # Shortcut to parsing json
+    #
+    #   json('http://foo.bar')
+    #
     def json(item)
       JSON.parse(open(item).read)
     end
@@ -169,6 +225,8 @@ module Aurb
   class Opts < Hash
     def initialize(args = ARGV)
       @@args = args.empty? ? ['-h'] : args
+
+      # Invoke this class's only private method
       parse
     end
 
@@ -177,9 +235,10 @@ module Aurb
       OptionParser.new do |o|
         o.version      = Version.join('.')
         o.program_name = 'Aurb'
-        o.release      = '2009-04-10'
+        o.release      = '2009-04-12'
 
-        o.on('-D', '--download P1,P2,...', Array, 'Download package(s). Separate by commas if multiple (no spaces).') do |d|
+        o.on('-D', '--download P1,P2,...', Array, "Download package(s). \
+Separate by commas if multiple (no spaces).") do |d|
           self[:cmd] = "download('#{d*"', '"}')"
         end
         o.on('-S', '--search PKG', 'Search for a package.') do |s|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gigamo-aurb
 version: !ruby/object:Gem::Version 
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors: 
 - Gigamo
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-10 00:00:00 -07:00
+date: 2009-04-12 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency