colloquy_log_to_text 1.0.5 → 1.1

data/README.md

@@ -0,0 +1,19 @@
+This is a simple ruby script to convert Colloquy's awful XML logs
+(`.colloquyTranscript`) to plain text (`.txt`).
+
+## Installation
+
+1. `gem install colloquy_log_to_text`
+2. Done!
+
+## Usage
+
+1. `colloquy_log_to_text log.colloquyTranscript`
+2. Plain text log will be in the file named `log.txt`
+
+## Development
+
+1. Fork
+1. Edit `lib/colloquy_log_to_text.rb`
+2. `rake`
+3. Submit pull request

data/bin/colloquy_log_to_text

@@ -11,41 +11,55 @@ if argc < 1
   exit 1
 end
 
-if !ARGV[0].match(/\.colloquyTranscript$/)
-  puts "Error: File is not a Colloquy log."
-  exit 1
+for arg in ARGV
+  case arg
+  when "-h"
+    puts "Usage: colloquy_log_to_text [-h] <LOGFILE>"
+    puts "The log file specified (.colloquyTranscript) will then be converted into plain text."
+    puts "The -h option is used to display this help message."
+    exit 0
+  else
+    if !arg.match(/\.colloquyTranscript$/)
+      puts "Error: File is not a Colloquy log."
+      next
+    end
+    filenames.push arg
+  end
 end
 
-f = File.open(ARGV[0])
-doc = Nokogiri::XML(f)
-f.close
-f = File.open(ARGV[0].gsub(".colloquyTranscript", ".txt"), "w")
-envelopes = doc.css("envelope")
-envelopes.each { |envelope|
-  messages = envelope.css("message")
-  messages.each { |message|
-    @printed_message = message.content
-    @timestamp_string = message.attr("received")
-    @timestamp = DateTime.strptime(@timestamp_string, "%F %H:%M:%S")
-    @is_action = message.attr("action")
-  }
-  senders = envelope.css("sender")
-  senders.each { |sender|
-    @nick = sender.content
-    case sender.attr("class")
-    when "voice"
-      @class = "+"
-    when "operator"
-      @class = "@"
-    when "founder"
-      @class = "~"
-    when "administrator"
-      @class = "&"
+for file in filenames
+  puts "Converting #{file}..."
+  f = File.open(file)
+  doc = Nokogiri::XML(f)
+  f.close
+  f = File.open(file.gsub(".colloquyTranscript", ".txt"), "w")
+  envelopes = doc.css("envelope")
+  envelopes.each { |envelope|
+    messages = envelope.css("message")
+    messages.each { |message|
+      @printed_message = message.content
+      @timestamp_string = message.attr("received")
+      @timestamp = DateTime.strptime(@timestamp_string, "%F %H:%M:%S")
+      @is_action = message.attr("action")
+    }
+    senders = envelope.css("sender")
+    senders.each { |sender|
+      @nick = sender.content
+      case sender.attr("class")
+      when "voice"
+        @class = "+"
+      when "operator"
+        @class = "@"
+      when "founder"
+        @class = "~"
+      when "administrator"
+        @class = "&"
+      end
+    }
+    if @is_action == "yes"
+      f.puts "[#{@timestamp.day}-#{@timestamp.month}-#{@timestamp.year} #{@timestamp.hour}:#{@timestamp.minute}] * #{@nick} #{@printed_message}"
+    else
+      f.puts "[#{@timestamp.day}-#{@timestamp.month}-#{@timestamp.year} #{@timestamp.hour}:#{@timestamp.minute}] <#{@class}#{@nick}> #{@printed_message}"
     end
   }
-  if @is_action == "yes"
-    f.puts "[#{@timestamp.day}-#{@timestamp.month}-#{@timestamp.year} #{@timestamp.hour}:#{@timestamp.minute}] * #{@nick} #{@printed_message}"
-  else
-    f.puts "[#{@timestamp.day}-#{@timestamp.month}-#{@timestamp.year} #{@timestamp.hour}:#{@timestamp.minute}] <#{@class}#{@nick}> #{@printed_message}"
-  end
-}
+end

data/lib/colloquy_log_to_text.rb

@@ -10,41 +10,55 @@ if argc < 1
   exit 1
 end
 
-if !ARGV[0].match(/\.colloquyTranscript$/)
-  puts "Error: File is not a Colloquy log."
-  exit 1
+for arg in ARGV
+  case arg
+  when "-h"
+    puts "Usage: colloquy_log_to_text [-h] <LOGFILE>"
+    puts "The log file specified (.colloquyTranscript) will then be converted into plain text."
+    puts "The -h option is used to display this help message."
+    exit 0
+  else
+    if !arg.match(/\.colloquyTranscript$/)
+      puts "Error: File is not a Colloquy log."
+      next
+    end
+    filenames.push arg
+  end
 end
 
-f = File.open(ARGV[0])
-doc = Nokogiri::XML(f)
-f.close
-f = File.open(ARGV[0].gsub(".colloquyTranscript", ".txt"), "w")
-envelopes = doc.css("envelope")
-envelopes.each { |envelope|
-  messages = envelope.css("message")
-  messages.each { |message|
-    @printed_message = message.content
-    @timestamp_string = message.attr("received")
-    @timestamp = DateTime.strptime(@timestamp_string, "%F %H:%M:%S")
-    @is_action = message.attr("action")
-  }
-  senders = envelope.css("sender")
-  senders.each { |sender|
-    @nick = sender.content
-    case sender.attr("class")
-    when "voice"
-      @class = "+"
-    when "operator"
-      @class = "@"
-    when "founder"
-      @class = "~"
-    when "administrator"
-      @class = "&"
+for file in filenames
+  puts "Converting #{file}..."
+  f = File.open(file)
+  doc = Nokogiri::XML(f)
+  f.close
+  f = File.open(file.gsub(".colloquyTranscript", ".txt"), "w")
+  envelopes = doc.css("envelope")
+  envelopes.each { |envelope|
+    messages = envelope.css("message")
+    messages.each { |message|
+      @printed_message = message.content
+      @timestamp_string = message.attr("received")
+      @timestamp = DateTime.strptime(@timestamp_string, "%F %H:%M:%S")
+      @is_action = message.attr("action")
+    }
+    senders = envelope.css("sender")
+    senders.each { |sender|
+      @nick = sender.content
+      case sender.attr("class")
+      when "voice"
+        @class = "+"
+      when "operator"
+        @class = "@"
+      when "founder"
+        @class = "~"
+      when "administrator"
+        @class = "&"
+      end
+    }
+    if @is_action == "yes"
+      f.puts "[#{@timestamp.day}-#{@timestamp.month}-#{@timestamp.year} #{@timestamp.hour}:#{@timestamp.minute}] * #{@nick} #{@printed_message}"
+    else
+      f.puts "[#{@timestamp.day}-#{@timestamp.month}-#{@timestamp.year} #{@timestamp.hour}:#{@timestamp.minute}] <#{@class}#{@nick}> #{@printed_message}"
     end
   }
-  if @is_action == "yes"
-    f.puts "[#{@timestamp.day}-#{@timestamp.month}-#{@timestamp.year} #{@timestamp.hour}:#{@timestamp.minute}] * #{@nick} #{@printed_message}"
-  else
-    f.puts "[#{@timestamp.day}-#{@timestamp.month}-#{@timestamp.year} #{@timestamp.hour}:#{@timestamp.minute}] <#{@class}#{@nick}> #{@printed_message}"
-  end
-}
+end

metadata

@@ -2,7 +2,7 @@
 name: colloquy_log_to_text
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.5
+  version: "1.1"
 platform: ruby
 authors: 
 - Mark Szymanski
@@ -23,7 +23,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- README
+- README.md
 - lib/colloquy_log_to_text.rb
 - bin/colloquy_log_to_text
 has_rdoc: true