pidgin2adium 2.0.1 → 2.0.2

data/History.txt

@@ -1,3 +1,13 @@
+=== 2.0.2 / 2009-12-18
+* Much better documentation (more of it, and higher quality too!)
+* Allow user-provided output dir at commandline
+* Cleaner error messages
+* require 'time' for Time.zone_offset (fixes bug)
+* Gracefully handle lack of timezone info
+* Gracefully handle nonexistent output dir
+* Gracefully handle parsing errors
+* Print error messages during *and* after batch converting so they're actually seen
+
 === 2.0.1 / 2009-12-06
 * Fix timestamps so they show up in Adium chat log viewer
 

data/README.rdoc

@@ -38,8 +38,9 @@ Or:
 
 ===Example (using library)
 The library style allows you to parse a log file and get back a
-LogFile instance for easy reading, manipulation, etc.
-You can also create log files yourself using Pidgin2Adium.parse_and_generate.
+LogFile[link:classes/Pidgin2Adium/LogFile.html] instance for easy reading, manipulation, etc.
+You can also create log files yourself using Pidgin2Adium.parse_and_generate[link:classes/Pidgin2Adium.html#M000006].
+For batch processing, use LogConverter[link:classes/Pidgin2Adium/LogConverter.html].
  
  require 'pidgin2adium'
  logfile = Pidgin2Adium.parse("/path/to/log/file.html", "gabe,gbw,gabeb-w")
@@ -64,12 +65,35 @@ You can also create log files yourself using Pidgin2Adium.parse_and_generate.
  	# Prints out the message in Adium log format
  	puts message.to_s
      end
+     success = logfile.write_out()
+     # To overwrite file if it exists:
+     # logfile.write_out(overwrite = true)
+     # To specify your own output dir (default = Pidgin2Adium::ADIUM_LOG_DIR):
+     # logfile.write_out(false, output_dir = my_dir)
+     # Or combine them:
+     # logfile.write_out(true, my_dir)
+     if success == false
+	 puts "An error occurred!"
+     elsif success == Pidgin2Adium::FILE_EXISTS
+	# Not returned if overwrite set to true
+	puts "File already exists."
+    else
+	puts "Successfully wrote out log file!"
+	puts "Path to output file: #{success}"
+    end
+    # This deletes search indexes to Adium re-indexes the new chat logs.
+    # Not automatically called after log_file.write_out()
+    # If you're converting >1 log, call it after converting all of them, since
+    # it takes up a tiny bit of processing power.
+    Pidgin2Adium.delete_search_indexes()
  end
 
 ===Example 2 (using library)
 If you want to output the logfile to an output dir instead of just parsing it, use Pidgin2Adium.parse_and_generate:
  
  require 'pidgin2adium'
+ # Both options are optional; without :output_dir, writes to Adium log dir
+ # (which is usually what you want anyway).
  opts = {:overwrite => true, :output_dir => "/my/output/dir"}
  path_to_converted_log = Pidgin2Adium.parse_and_generate("/path/to/log/file.html", "gabe,gbw,gabeb-w", opts)
 

data/bin/pidgin2adium

@@ -15,21 +15,41 @@ automatically recognized.
 require 'pidgin2adium/log_converter'
 require 'optparse'
 
+version = <<EOL
+Pidgin2Adium, version #{Pidgin2Adium::VERSION}
+Written by Gabe Berke-Williams (gbw@rubyforge.org)
+EOL
+
 options = {}
 oparser = OptionParser.new do |opts|
     opts.banner = "Usage: #{File.basename($0)} [options]"
-    opts.on('-i', '--in=IN_DIR', String, 'Specify directory where pidgin logs are stored') do |i|
+    opts.on('-i', '--in=IN_DIR', String, 'Directory where pidgin logs are stored') do |i|
 	options[:in] = i
     end
     opts.on('-a alias1,alias2', "--aliases alias1,alias2",
-	    "A comma-separated list of your alias(es) so this script knows
-	    which person in a chat is you.", "Whitespace and case do not matter.") do |aliases|
+	    "A comma-separated list of your alias(es)",
+	    "so this script knows which person in a chat",
+	    "is you. Whitespace and case do not matter.") do |aliases|
 	options[:aliases] = aliases
     end
-    opts.on('-f', '--force', 'If this is set, then logs in the Adium log folder that have the same name as converted logs will be overwritten.') do |f|
+    opts.on('-o', '--out [OUT_DIR]',
+	    'The top-level directory under which to',
+	    'store the logs (each in its own folder',
+	    'by screen name).',
+	    "Defaults  to: #{Pidgin2Adium::ADIUM_LOG_DIR}") do |out|
+	options[:output_dir] = out
+    end
+    opts.on('-f', '--force', 'If this is set, then logs in the Adium log',
+	    'folder that have the same name as converted',
+	    'logs will be overwritten.') do |f|
 	options[:force] = f
     end
+    opts.on("-v", "--version", "Show version information") do
+	puts version
+	exit
+    end
     opts.on_tail("-h", "--help", "Show this message") do
+	puts version
 	puts opts
 	exit
     end
@@ -65,8 +85,12 @@ if need_opts
     exit 1
 end
 
+extra_opts = {:overwrite => options[:force]}
+if options.has_key?(:output_dir)
+    extra_opts[:output_dir] = options[:output_dir]
+end
+
 log_converter = Pidgin2Adium::LogConverter.new(options[:in],
 					       options[:aliases],
-					       {:overwrite =>  options[:force]}
-					      )
+					       extra_opts)
 log_converter.start

data/lib/pidgin2adium.rb

@@ -14,17 +14,22 @@ module Pidgin2Adium
     ADIUM_LOG_DIR = File.expand_path('~/Library/Application Support/Adium 2.0/Users/Default/Logs/') << '/' 
     # These files/directories show up in Dir.entries()
     BAD_DIRS = %w{. .. .DS_Store Thumbs.db .system}
-    VERSION = "2.0.1"
+    VERSION = "2.0.2"
+    # For displaying after we finish converting
+    @@oops_messages = []
+    @@error_messages = []
 
-    def log_msg(str) #:nodoc
+    def log_msg(str) #:nodoc:
 	puts str.to_s
     end
 
-    def oops(str) #:nodoc
+    def oops(str) #:nodoc:
+	@@oops_messages << str
 	warn("Oops: #{str}")
     end
 
-    def error(str) #:nodoc
+    def error(str) #:nodoc:
+	@@error_messages << str
 	warn("Error: #{str}")
     end
 
@@ -43,7 +48,7 @@ module Pidgin2Adium
 	elsif(ext == "txt")
 	    parser = TextLogParser.new(logfile_path, my_aliases) 
 	else
-	    error("logfile (#{logfile_path}) is not a text or html file. Doing nothing.")
+	    error("Doing nothing, logfile is not a text or html file. Path: #{logfile_path}.")
 	    return false
 	end
 
@@ -72,14 +77,19 @@ module Pidgin2Adium
 	
 	unless File.directory?(output_dir)
 	    puts "Output log directory (#{output_dir}) does not exist or is not a directory."
-	    raise Errno::ENOENT
+	    begin
+		FileUtils.mkdir_p(output_dir)
+	    rescue Errno::EACCES
+		puts "Permission denied, could not create output directory (#{output_dir})"
+		return false
+	    end
 	end
 
 	logfile_obj = parse(logfile_path, my_aliases)
 	return false if logfile_obj == false
 	dest_file_path = logfile_obj.write_out(overwrite, output_dir)
 	if dest_file_path == false
-	    error("Converting #{logfile_path} failed.") 
+	    error("Successfully parsed file, but failed to write it out. Path: #{logfile_path}.")
 	    return false
 	elsif dest_file_path == FILE_EXISTS
 	    log_msg("File already exists.")
@@ -109,7 +119,7 @@ module Pidgin2Adium
 		if File.writable?(f)
 		    File.delete(f)
 		else
-		    error("#{f} exists but is not writable. Please delete it yourself.")
+		    error("File exists but is not writable. Please delete it yourself: #{f}")
 		end
 	    end
 	end

data/lib/pidgin2adium/log_converter.rb

@@ -53,6 +53,10 @@ module Pidgin2Adium
 	    delete_search_indexes()
 
 	    log_msg "Finished converting! Converted #{total_successes} files of #{total_files} total."
+	    puts "Minor error messages:"
+	    puts @@oops_messages.join("\n")
+	    puts "Major error messages:"
+	    puts @@error_messages.join("\n")
 	end
 
 	###########

data/lib/pidgin2adium/log_file.rb

@@ -1,16 +1,17 @@
-# ADD DOCUMENTATION
-
 require 'fileutils'
 
 module Pidgin2Adium
     # A holding object for the result of LogParser.parse.  It makes the
-    # instance variable @chat_lines available, which is an array of objects
-    # which each have at least the instance variables _sender_, _time_, and
-    # _buddy_alias_ available. Some objects in @chat_lines have more variables
-    # available, specifically:
-    # * XMLMessage, AutoReplyMessage, and Event:: _body_
-    # * Event:: _event_type_
-    # * StatusMessage:: _status_
+    # instance variable @chat_lines available, which is an array of Message
+    # subclass instances (XMLMessage, Event, etc.)
+    # Here is a list of the instance variables for each class in @chat_lines:
+    # 
+    # <b>All of these variables are read/write.</b>
+    # All::		 sender, time, buddy_alias
+    # XMLMessage::	 body
+    # AutoReplyMessage:: body
+    # Event::		 body, event_type
+    # StatusMessage::	 status
     class LogFile
 	include Pidgin2Adium
 	def initialize(chat_lines, service, user_SN, partner_SN, adium_chat_time_start)

data/lib/pidgin2adium/log_parser.rb

@@ -5,6 +5,7 @@
 # Please use Pidgin2Adium.parse or Pidgin2Adium.parse_and_generate instead of
 # using these classes directly.
 require 'parsedate'
+require 'time' # for Time.zone_offset
 
 require 'pidgin2adium/balance_tags'
 require 'pidgin2adium/log_file'
@@ -64,7 +65,7 @@ module Pidgin2Adium
 		@adium_chat_time_start = pre_parse()
 	    rescue InvalidFirstLineError
 		@first_line_is_valid = false
-		error("Parsing of #{@src_path} failed (could not find valid first line).")
+		error("Failed to parse, invalid first line: #{@src_path}")
 		return # stop processing
 	    end
 	    
@@ -143,19 +144,26 @@ module Pidgin2Adium
 	    @file_content = cleanup(@file_content).split("\n")
 
 	    @file_content.map! do |line|
+		# "next" returns nil which is removed by compact
 		next if line =~ /^\s+$/
 		if line =~ @line_regex
 		    create_msg($~.captures)
 		elsif line =~ @line_regex_status
-		    create_status_or_event_msg($~.captures)
+		    msg = create_status_or_event_msg($~.captures)
+		    # Error occurred while parsing
+		    return false if msg == false
 		else
 		    error "Could not parse line:"
-		    p line # returns nil which is then removed by compact
-		    exit 1 # if $DEBUG FIXME
+		    p line
+		    return false
 		end
-	    end.compact!
+	    end
+	    @file_content.compact!
 	    return LogFile.new(@file_content, @service, @user_SN, @partner_SN, @adium_chat_time_start)
 	end
+	# Prevent parse from being called directly from BasicParser, since
+	# it uses subclassing magic.
+	protected :parse
 
 	#################
 	private
@@ -167,7 +175,7 @@ module Pidgin2Adium
 	    # 1) the log has an empty start date column in the viewer
 	    # 2) The timestamps are all the same for the whole log
 	    tz_match = /([-\+]\d+)[A-Z]{3}\.(?:txt|htm|html)/.match(@src_path)
-	    if tz_match[1]
+	    if tz_match and tz_match[1]
 		tz_offset = tz_match[1]
 	    else
 		zone = Time.local(Time.new.year).zone
@@ -296,6 +304,8 @@ module Pidgin2Adium
 	#--
 	# create_status_or_event_msg takes an array of +MatchData+ captures from
 	# matching against @line_regex_status and returns an Event or Status.
+	# Returns nil if it's a message that should be ignored, or false if an
+	# error occurred.
 	#++
 	def create_status_or_event_msg(matches)
 	    # ["22:58:00", "BuddyName logged in."]
@@ -322,10 +332,8 @@ module Pidgin2Adium
 		    if @event_map.detect{|regex,event_type| str =~ regex}
 			regex, event_type = $1, $2
 		    else
-			error("Could not match string to status or event!")
-			error(sprintf("matches: %p", matches))
-			error(sprintf("str: %p", str))
-			exit 1
+			error(sprintf("Error parsing status or event message, no status or event found: %p", str))
+			return false
 		    end
 		end
 		if regex and event_type
@@ -367,6 +375,8 @@ module Pidgin2Adium
 	    @line_regex_status = /#{@timestamp_rx} ([^:]+)/o
 	end
 
+	public :parse
+
 	#################
 	private
 	#################
@@ -407,6 +417,8 @@ module Pidgin2Adium
 	    # 1: status message
 	    @line_regex_status = /#{@timestamp_rx} ?<b> (.+)<\/b><br ?\/>/o
 	end
+	
+	public :parse
 
 	#################
 	private
@@ -520,8 +532,12 @@ module Pidgin2Adium
     # Subclasses: XMLMessage, AutoReplyMessage, StatusMessage, Event.
     class Message
 	def initialize(sender, time, buddy_alias)
+	    # The sender's screen name
 	    @sender = sender
+	    # The time the message was sent, in Adium format (e.g.
+	    # "2008-10-05T22:26:20-0800")
 	    @time = time
+	    # The receiver's alias (NOT screen name)
 	    @buddy_alias = buddy_alias
 	end
 	attr_accessor :sender, :time, :buddy_alias

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pidgin2adium
 version: !ruby/object:Gem::Version 
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors: 
 - Gabe B-W
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-06 00:00:00 -05:00
+date: 2009-12-18 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.3
+        version: 2.4.0
     version: 
 description: |-
   Pidgin2Adium is a fast, easy way to convert Pidgin (formerly gaim) logs to the