runoff 0.1.2 → 0.1.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MmUzMWI2ZWE4ZThmNTE1OTk5NmU2MjVhYmIzOGNmOGU5MGUyZDNiYg==
+    OTA3ZDMwNGJlZWY3YWE2MTVlMmJjY2RiMWJmYzJjZGI1NzdjNTI0Mw==
   data.tar.gz: !binary |-
-    OWZiYzc1Y2I0NzdiN2M0MTExOWEwYTFhZjI0YTJkYzU2N2JmYzg5Zg==
+    NzIyYzU3ZDJhM2YyMmYzY2VmYmMxZjhkNzAwY2MxZTBkMzBhY2MyNA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MTg5NzYxNmZlNWRkMWU3YzkyZmMwMWRkODdkMmY1MTBkM2Y2ZjI2ODU4Yjli
-    ZDc1ZmU3NjA5ZWU2YWFhNTE2NmZiOWNlNDJlMGYzNzhkYzkxNDlhZjY2MWEz
-    ZDM5ZjNiNjJlNGJlNmFiZWQzMGRkYWE3N2ZhYmQ5MDFjZGQ2ZGY=
+    ODM4OGYzZTBlMDM0MmY2NGYxNTIxYTk3YzkxOTAxY2QzYWU0MmZkY2ZlMjFm
+    NTZiMDU3NjgxODJiZTE0MzIxZDM3NjU0NzEwNzQ2ZjMzZGQ5NWUwYTQzZmU5
+    NTkwZTg5YTlmNjg0M2NmYTE3MjRhNjI0MWRlN2UyYmMyMDc2OTc=
   data.tar.gz: !binary |-
-    YWU1YjU5NDNmZjE3Mjc5Mzk2MmY4ZjE1MWIwNDk0OTQ4MmUxZDE2OTNjOWFj
-    Y2U0N2UwNTQxM2U5NDJmOTY3YmJhNzE1ODYxMzY0ZDE0ODhiY2E3ZDQ4Nzdh
-    Y2U3M2FkNDRmNmM3NTM4OWY1NDA1M2E4MmQyN2Q5YmRlOGJmNjI=
+    MmRhYzdiNjliNDVhMjIyYmI5YzRmMGM0NThhZDllMjU3ODhhZjM3YjgzMDAy
+    NzY4NzQyMDg4NTEyOGEwYzA5YjNhNmNmYWUwMGY3Mzc5N2Y0NjNlZjY3NDAx
+    ZmVmYzY3NTVkOWQ1YmE3ODk2Y2RlNmY5MWY5YjM2OGU5ZDBmZTk=

data/README.md

@@ -30,15 +30,11 @@ If you're confused, you can get some help.
 
     runoff help all
 
-## Problems
-
-The current version (0.1.1) doesn't support Windows, but it will be fixed soon.
-
 ## What else?
 
 Things to do in the future versions:
 
-- Fix sqlite path bug in Windows.
+- Parse body_xml to filter XML tags and character entities.
 - Append only new messages to the previously genetrated files instead of appending everything or create different versions for the files.
 - Add some colors.
 

data/lib/runoff/composition.rb

@@ -2,7 +2,6 @@ require 'sequel'
 require 'set'
 
 module Runoff
-
   # Public: Provides interaction with a Skype database file.
   #
   # Examples
@@ -10,6 +9,7 @@ module Runoff
   #   composition = Composition.new 'path/to/the/main.db'
   #   exported_files_count = composition.export 'export/folder'
   class Composition
+    include FileWriter
 
     # Public: Returns a Set object of all the names of the exported files.
     attr_reader :exported_filenames
@@ -35,16 +35,14 @@ module Runoff
     #
     # Examples
     #
-    #   export '~/skype_backup'
+    #   export '/home/username/skype_backup'
     #   # => 8
     #
     # Returns the count of the exported files.
     def export(destination_path)
       chat_records = @messages.select(:chatname, :timestamp, :from_dispname, :body_xml)
 
-      chat_records.each { |record| save_to_file record, destination_path }
-
-      @exported_filenames.count
+      run_export chat_records, destination_path
     end
 
     # Public: Gets parsed chatnames together with partly parsed chatnames.
@@ -78,86 +76,29 @@ module Runoff
       pattern_chatnames = chatnames.map { |name| "#{name}%" }
       chat_records = @messages.where(Sequel.like(:chatname, *pattern_chatnames))
 
-      chat_records.each { |record| save_to_file record, destination_path }
-
-      @exported_filenames.count
+      run_export chat_records, destination_path
     end
 
     private
 
-    # Internal: Saves a single chat message to a file.
-    #
-    # chat_record - a Hash containing data about a single chat message.
-    # output_directory - A String with the path to the directory, wher the file will be saved.
+    # Internal: Performs the export process.
+    #
+    # chat_records -
 Array of chat records read from database
     #
     # Examples
     #
-    #   save_to_file record, '~/skype_backup'
-    def save_to_file(chat_record, output_directory)
-      datetime = Time.at chat_record[:timestamp]
-      output_record = "[#{datetime.to_date}] #{chat_record[:from_dispname]}: #{chat_record[:body_xml]}"
-      filename = "#{output_directory}/#{parse_chatname chat_record[:chatname]}.txt"
-
-      File.open(filename, 'a') do |file|
-        file.puts output_record
+    #   run_export [{chatname: '#sadsad/$kjhkjh;9878977', 123123213, 'Aidzis', ''}]
+    #   # => 1
+    #
+    # Returns the count of the exported files.
+    def run_export(chat_records, destination_path)
+      chat_records.each do |record|
+        if filename = save_to_file(record, destination_path)
+          @exported_filenames << filename
+        end
       end
 
-      @exported_filenames << filename
-    rescue StandardError
-      puts 'An error occured while parsing a chatname'
-    end
-
-    # Internal: Converts chatname from database to a valid file name.
-    #
-    # raw_chatname - A String with a chatname read from the database.
-    #
-    # Examples
-    #
-    #   parse_chatname '#someone/$someone_else;521357125362'
-    #   # => someone-someone_else.txt
-    #
-    # Returns a String with a valid file name.
-    def parse_chatname(raw_chatname)
-      match = raw_chatname.match(/#(.+)\/\$(.+);|#(.+)\/\$/)
-      first_part, second_part, third_part = match.captures
-      chatname = "#{first_part}-#{second_part}-#{third_part}"
-
-      trim_dashes chatname
-    end
-
-    # Internal: Removes extra characters from the end of a chatname.
-    #
-    # raw_chatname - A String with a chatname read from the database
-    #
-    # Examples
-    #
-    #   partly_parse_chatname '#someone/$someone_else;521357125362'
-    #   # => #someone/$someone_else;
-    #
-    # Returns a String with a chatname without extra characters at the end.
-    def partly_parse_chatname(raw_chatname)
-      match = raw_chatname.match(/(#.+\/\$.+;)|(#.+\/\$)/)
-      first_group, second_group = match.captures
-
-      first_group || second_group
-    end
-
-    # Internal: Removes unnecessary dashes from the begining and the end of the string.
-    #
-    # string - A String possibly containing dashes at the beggining or the end
-    #
-    # Examples
-    #
-    #   str = '--example-'
-    #   trim_dashes str
-    #   # => example
-    #
-    # Returns a string without leading and ending dashes.
-    def trim_dashes(string)
-      string.gsub! /^-+/, ''
-      string.gsub! /-+$/, ''
-
-      string
+      @exported_filenames.count
     end
   end
 end

data/lib/runoff/file_writer.rb

@@ -0,0 +1,93 @@
+module Runoff
+  # Public: Methods used for writing to files.
+  module FileWriter
+    # Public: Saves a single chat message to a file.
+    #
+    # chat_record - a Hash containing data about a single chat message.
+    # output_directory - A String with the path to the directory, wher the file will be saved.
+    #
+    # Examples
+    #
+    #   save_to_file record, '/home/username/skype_backup'
+    def save_to_file(chat_record, output_directory)
+      datetime = Time.at chat_record[:timestamp]
+      output_record = "[#{datetime.strftime "%Y-%m-%d %H:%M:%S"}] "
+      output_record << "#{chat_record[:from_dispname]}: #{parse_body_xml chat_record[:body_xml]}"
+      filename = "#{output_directory}/#{parse_chatname chat_record[:chatname]}.txt"
+
+      File.open(filename, 'a') do |file|
+        file.puts output_record
+      end
+
+      filename
+    rescue StandardError
+      puts 'An error occured while parsing a chatname'
+    end
+
+    # Internal: Converts chatname from database to a valid file name.
+    #
+    # raw_chatname - A String with a chatname read from the database.
+    #
+    # Examples
+    #
+    #   parse_chatname '#someone/$someone_else;521357125362'
+    #   # => someone-someone_else.txt
+    #
+    # Returns a String with a valid file name.
+    def parse_chatname(raw_chatname)
+      match = raw_chatname.match(/#(.+)\/\$(.+);|#(.+)\/\$/)
+      first_part, second_part, third_part = match.captures
+      chatname = "#{first_part}-#{second_part}-#{third_part}"
+
+      trim_dashes chatname
+    end
+
+    # Internal: Removes extra characters from the end of a chatname.
+    #
+    # raw_chatname - A String with a chatname read from the database
+    #
+    # Examples
+    #
+    #   partly_parse_chatname '#someone/$someone_else;521357125362'
+    #   # => #someone/$someone_else;
+    #
+    # Returns a String with a chatname without extra characters at the end.
+    def partly_parse_chatname(raw_chatname)
+      match = raw_chatname.match(/(#.+\/\$.+;)|(#.+\/\$)/)
+      first_group, second_group = match.captures
+
+      first_group || second_group
+    end
+
+    # Internal: Removes unnecessary dashes from the begining and the end of the string.
+    #
+    # string - A String possibly containing dashes at the beggining or the end
+    #
+    # Examples
+    #
+    #   str = '--example-'
+    #   trim_dashes str
+    #   # => example
+    #
+    # Returns a string without leading and ending dashes.
+    def trim_dashes(string)
+      clean_string = string.gsub /^-+/, ''
+      clean_string.gsub /-+$/, ''
+    end
+
+    # Public: Remove Skype emotion tags.
+    #
+    # text -
 String containing XML data
+    #
+    # Examples
+    #
+    #   parse_body_xml "Some text <ss type="laugh">:D</ss>"
+    #   # => "Some text :D"
+    #
+    # Returns the duplicated String.
+    def parse_body_xml(text)
+      clean_text = text.gsub /<ss type=".+">/, ''
+      clean_text.gsub /<\/ss>/, ''
+    end
+  end
+end

data/lib/runoff/version.rb

@@ -1,3 +1,3 @@
 module Runoff
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/runoff.rb

@@ -1,4 +1,7 @@
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
 require "runoff/version"
 require "runoff/location"
+require "runoff/file_writer"
 require "runoff/composition"
 require "runoff/source"

data/test/runoff_composition_test.rb

@@ -13,41 +13,6 @@ describe Runoff::Composition do
     @composition.must_respond_to :exported_filenames
   end
 
-  it "must remove all starting and ending dashes from a string" do
-    string = "---example--"
-    valid_name = @composition.send :trim_dashes, string
-
-    valid_name.must_equal 'example'
-  end
-
-  it "must return a valid and readable name from a raw chatname" do
-    raw_chatname = '#something/$else;521357125362'
-    chatname = @composition.send :parse_chatname, raw_chatname
-
-    chatname.must_equal 'something-else'
-  end
-
-  it "must return a valid and readable name from broken chatname records" do
-    raw_chatname = '#something/$521357125362'
-    chatname = @composition.send :parse_chatname, raw_chatname
-
-    chatname.must_equal 'something'
-  end
-
-  it "must return a chatname without the extra symbols" do
-    raw_chatname = '#something/$else;521357125362'
-    chatname = @composition.send :partly_parse_chatname, raw_chatname
-
-    chatname.must_equal '#something/$else;'
-  end
-
-  it "must return a chatname without the extra symbols for broken chatname records" do
-    raw_chatname = '#something/$521357125362'
-    chatname = @composition.send :partly_parse_chatname, raw_chatname
-
-    chatname.must_equal '#something/$'
-  end
-
   it "must return parsed chatnames together with partly parsed chatnames" do
     chatnames, raw_chatnames = @composition.get_chatnames
 
@@ -55,63 +20,37 @@ describe Runoff::Composition do
     raw_chatnames.must_equal ['#something/$more;', '#something/$else;']
   end
 
-  describe "#save_to_file" do
-    before do
-      @composition = Runoff::Composition.new 'test/test_db.sqlite'
-      @incorrect_chat_record = {
-        chatname: '#something/$;521357125362',
-        timestamp: 1362864487,
-        from_dispname: 'Aidzis',
-        body_xml: ''
-      }
-      @chat_record = {
-        chatname: '#something/$more;521357125362',
-        timestamp: 1362864487,
+  it "must have a save_to_file method" do
+    @composition.must_respond_to :save_to_file
+  end
+
+  it "must return a count of the exported filenames" do
+    file_count = @composition.send(
+      :run_export,
+      [{
+        chatname: '#test/$one;7687623',
+        timestamp: 123123213,
         from_dispname: 'Aidzis',
         body_xml: ''
-      }
-    end
+      }],
+      'test/tmp'
+    )
 
-    after { FileUtils.rm_rf 'test/tmp/.' }
-
-    it "must write chat content to file" do
-      @incorrect_chat_record[:chatname] = '#something/$else;521357125362'
-
-      @composition.send :save_to_file, @chat_record, 'test/tmp'
-      @composition.send :save_to_file, @incorrect_chat_record, 'test/tmp'
-      @composition.exported_filenames.count.must_equal 2
-    end
-
-    it "must append to a file if the filename already exists" do
-      @incorrect_chat_record[:chatname] = '#something/$else;521357125362'
-      @additional_chat_record = @chat_record
-
-      @composition.send :save_to_file, @chat_record, 'test/tmp'
-      @composition.send :save_to_file, @incorrect_chat_record, 'test/tmp'
-      @composition.send :save_to_file, @additional_chat_record, 'test/tmp'
-      @composition.exported_filenames.count.must_equal 2
-    end
+    file_count.must_equal 1
+    FileUtils.rm_rf 'test/tmp/.'
   end
 
-  describe "#export" do
-    after { FileUtils.rm_rf 'test/tmp/.' }
-
-    it "must return a count of the exported filenames" do
-      composition = Runoff::Composition.new 'test/test_db.sqlite'
-      file_count = composition.export 'test/tmp'
+  it "must return a count of the exported filenames when called for all chats" do
+    file_count = @composition.export 'test/tmp'
 
-      file_count.must_equal 2
-    end
+    file_count.must_equal 2
+    FileUtils.rm_rf 'test/tmp/.'
   end
 
-  describe "#export_chats" do
-    after { FileUtils.rm_rf 'test/tmp/.' }
-
-    it "must return a count of the exported filenames" do
-      composition = Runoff::Composition.new 'test/test_db.sqlite'
-      file_count = composition.export_chats ['#something/$more;', '#something/$else;'], 'test/tmp'
+  it "must return a count of the exported filenames when called for specific chats" do
+    file_count = @composition.export_chats ['#something/$more;', '#something/$else;'], 'test/tmp'
 
-      file_count.must_equal 2
-    end
+    file_count.must_equal 2
+    FileUtils.rm_rf 'test/tmp/.'
   end
 end

data/test/runoff_file_writer_test.rb

@@ -0,0 +1,87 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'runoff'
+
+describe Runoff::FileWriter do
+  before do
+    @incorrect_chat_record = {
+      chatname: '#something/$;521357125362',
+      timestamp: 1362864487,
+      from_dispname: 'Aidzis',
+      body_xml: ''
+    }
+    @chat_record = {
+      chatname: '#something/$more;521357125362',
+      timestamp: 1362864487,
+      from_dispname: 'Aidzis',
+      body_xml: ''
+    }
+
+    class ClassWithFileWriterMixin
+      include Runoff::FileWriter
+    end
+
+    @test_object = ClassWithFileWriterMixin.new
+  end
+
+  it "must return a string without Skype emotion XML tags" do
+    string = 'Some text <ss type="laugh">:D</ss>'
+    clean_string = @test_object.parse_body_xml string
+
+    clean_string.must_equal 'Some text :D'
+  end
+
+  it "must remove all starting and ending dashes from a string" do
+    string = "---example--"
+    valid_name = @test_object.trim_dashes string
+
+    valid_name.must_equal 'example'
+  end
+
+  it "must return a valid and readable name from a raw chatname" do
+    raw_chatname = '#something/$else;521357125362'
+    chatname = @test_object.parse_chatname raw_chatname
+
+    chatname.must_equal 'something-else'
+  end
+
+  it "must return a valid and readable name from broken chatname records" do
+    raw_chatname = '#something/$521357125362'
+    chatname = @test_object.parse_chatname raw_chatname
+
+    chatname.must_equal 'something'
+  end
+
+  it "must return a chatname without the extra symbols" do
+    raw_chatname = '#something/$else;521357125362'
+    chatname = @test_object.partly_parse_chatname raw_chatname
+
+    chatname.must_equal '#something/$else;'
+  end
+
+  it "must return a chatname without the extra symbols for broken chatname records" do
+    raw_chatname = '#something/$521357125362'
+    chatname = @test_object.partly_parse_chatname raw_chatname
+
+    chatname.must_equal '#something/$'
+  end
+
+  describe "#save_to_file" do
+    after { FileUtils.rm_rf 'test/tmp/.' }
+
+    it "must write chat content to file" do
+      @test_object.save_to_file @chat_record, 'test/tmp'
+      @test_object.save_to_file @incorrect_chat_record, 'test/tmp'
+      Dir["test/tmp/**/*"].length.must_equal 2
+    end
+
+    it "must append to a file if the filename already exists" do
+      @additional_chat_record = @chat_record
+
+      @test_object.save_to_file @chat_record, 'test/tmp'
+      @test_object.save_to_file @incorrect_chat_record, 'test/tmp'
+      @test_object.save_to_file @additional_chat_record, 'test/tmp'
+      Dir["test/tmp/**/*"].length.must_equal 2
+    end
+  end
+end

data/test/runoff_locations_test.rb

@@ -8,7 +8,7 @@ describe Runoff::Location do
       path = Runoff::Location.default_skype_data_location 'aidzis_skype'
 
       if RbConfig::CONFIG['host_os'] =~ /mingw/
-        path.must_match /[A-Z]:\\Users\\[a-zA-Z0-9]+\\AppData\\Roaming\\Skype\\aidzis_skype\\main\.db/
+        path.must_match /\/Users\/[a-zA-Z0-9]+\/AppData\/Roaming\/Skype\/aidzis_skype\/main\.db/
       elsif RbConfig::CONFIG['host_os'] =~ /linux/
         path.must_match /\/home\/[a-zA-Z0-9]+\/\.Skype\/aidzis_skype\/main\.db/
       else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runoff
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Aigars Dzerviniks
@@ -39,7 +39,7 @@ cert_chain:
   dHFPWFp1ck5FWmdTMlRSWG5GRG9TWmRtT3IxMjM2ZS9SNTBzc1dlR0dIUUox
   V2wKN2ZZbFZpQThPY2Z3aGdyaDcyc05mVHpTCi0tLS0tRU5EIENFUlRJRklD
   QVRFLS0tLS0K
-date: 2013-03-27 00:00:00.000000000 Z
+date: 2013-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -101,11 +101,13 @@ files:
 - gem-public_cert.pem
 - lib/runoff.rb
 - lib/runoff/composition.rb
+- lib/runoff/file_writer.rb
 - lib/runoff/location.rb
 - lib/runoff/source.rb
 - lib/runoff/version.rb
 - runoff.gemspec
 - test/runoff_composition_test.rb
+- test/runoff_file_writer_test.rb
 - test/runoff_locations_test.rb
 - test/runoff_source_test.rb
 - test/test_db.sqlite
@@ -135,6 +137,7 @@ specification_version: 4
 summary: Tool to export Skype chat history from the SQLite database to text files
 test_files:
 - test/runoff_composition_test.rb
+- test/runoff_file_writer_test.rb
 - test/runoff_locations_test.rb
 - test/runoff_source_test.rb
 - test/test_db.sqlite