runoff 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68f134e0964050cf348514719437dde550790071
-  data.tar.gz: 23af26df004e1810c9a6b937ca161932eb157ef1
+  metadata.gz: 2cbece2f0614ed17f5c62f98227f7c000e3b7985
+  data.tar.gz: f10c4978d07c72e9e004d7bbdb9647c54f36bc32
 SHA512:
-  metadata.gz: ff8e74e3aab2ec0a04d05c08e9544afc4fffeadf1d479549a45349627aeb200e9db76afb3ef52be5113f06ae1733289928d8f8416efd0c07110e6065d7c85963
-  data.tar.gz: f286bd9541f12f7b5b9ab04b2f3e6c2670b8cf27bb15b0c8ef56a979005f717e774bea8473f54f073691b51343d7038e5ef58ca65914ef68cfd164f845f42a0d
+  metadata.gz: b086d0b09ba49f49d81a376d7c4c0f8c56aa2f9f6f4ecc04851046129f53567ae07a70adb05b48bc8342f5cbc921f65c88b275f893fb05d385fd02db8c0f6bb3
+  data.tar.gz: 9b149cab21193959a02575b6ad5111a63b9b71e80e21817cc5ad7dace585db70018f12f9131511d42b15f13b8083a34239566c502ae3d155bf342ab0a42edc22

data/README.md

@@ -26,7 +26,7 @@ To export specific chats.
 
     runoff chat skype_username
 
-If you don't want to put files into an archive, use `--no-archive` option
+If you don't want to put files into an archive, use `-a` option
 
     runoff all skype_username -a false
 
@@ -34,7 +34,6 @@ If you don't want to put files into an archive, use `--no-archive` option
 
 Things to do in the future versions:
 
-- Refactore tests (move from MiniTest::Spec to MiniTest::Unit).
 - 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 when using `-a false` option.
 - Add some colors.

data/lib/runoff/location.rb

@@ -28,6 +28,10 @@ module Runoff
       if RbConfig::CONFIG['host_os'] =~ /mingw/
         location = "#{ENV['APPDATA']}\\Skype\\#{skype_username}\\main.db"
 
+        unless File.exist?("#{ENV['APPDATA']}\\Skype")
+          location = self.get_default_skype_data_location_on_windows_8 skype_username
+        end
+
         location.gsub!(/\\/, '/')
         location.gsub(/^[a-zA-Z]:/, '')
       elsif RbConfig::CONFIG['host_os'] =~ /linux/
@@ -36,5 +40,30 @@ module Runoff
         "#{ENV['HOME']}/Library/Application Support/Skype/#{skype_username}/main.db"
       end
     end
+
+    private
+
+    # Public: Composes the default Skype database location for the Windows 8 operating system.
+    #
+    # skype_username - A String that contains a username of the Skype account,
+    #                  which database we want to access.
+    #
+    # Examples
+    #
+    #   get_default_skype_data_location_on_windows_8 skype_username
+    #   # => C:/Users/user/AppData/Local/Packages/Microsoft.SkypeApp_sakjhds8asd/LocalState/skype_username/main.db
+    #
+    # Returns a String that contains the path to the Skype database file.
+    def self.get_default_skype_data_location_on_windows_8(skype_username)
+      location = "#{ENV['HOME']}/AppData/Local/Packages"
+
+      Dir["#{location}/*"].each do |item|
+        if item =~ /Microsoft\.SkypeApp/
+          location = "#{item}/LocalState/#{skype_username}/main.db"
+        end
+      end
+
+      location
+    end
   end
 end

data/lib/runoff/version.rb

@@ -1,3 +1,3 @@
 module Runoff
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/test/all_test.rb

@@ -1,25 +1,37 @@
-require 'minitest/spec'
 require 'minitest/autorun'
+require 'minitest/unit'
 require 'runoff'
+require 'fileutils'
 
-describe Runoff::Commands::All do
-  it 'must output an error message if no username or --from option is provided' do
-    ->{ Runoff::Commands::All.process []  }.must_output "You must specify a username or a --from option\n"
-  end
+class TestAll < MiniTest::Test
+  def teardown
+    Dir.glob('test/*.zip').each do |archive|
+      File.delete archive
+    end
 
-  it 'must output result of the command' do
-    ->{ Runoff::Commands::All.process [], {
-      from: 'test/test_db.sqlite', destination: 'test/tmp' }
-    }.must_output "Finished: 2 files were exported\n"
+    FileUtils.rm_rf 'test/tmp'
   end
 
-  it 'must put exported files into an archive' do
-    capture_io { Runoff::Commands::All.process [], { from: 'test/test_db.sqlite', destination: 'test/tmp' } }
+  def test_must_output_an_error_message_if_no_username_or_from_option_is_provided
+    assert_output "You must specify a username or a --from option\n" do
+      Runoff::Commands::All.process []
+    end
+  end
 
-    Dir["test/*.zip"].length.must_equal 1
+  def test_must_output_result_of_the_command
+    assert_output "Finished: 2 files were exported\n" do
+      Runoff::Commands::All.process [], {
+        from: 'test/test_db.sqlite',
+        destination: 'test/tmp'
+      }
+    end
+  end
 
-    Dir.glob('test/*.zip').each do |archive|
-      File.delete archive
+  def test_must_put_exported_files_into_an_archive
+    capture_io do
+      Runoff::Commands::All.process [], { from: 'test/test_db.sqlite', destination: 'test/tmp' }
     end
+
+    assert_equal 1, Dir["test/*.zip"].length, "test directory must contain 1 Zip file"
   end
 end

data/test/chat_test.rb

@@ -1,9 +1,11 @@
-require 'minitest/spec'
 require 'minitest/autorun'
+require 'minitest/unit'
 require 'runoff'
 
-describe Runoff::Commands::Chat do
-  it 'must output an error message if no username or --from option is provided' do
-    ->{ Runoff::Commands::Chat.process []  }.must_output "You must specify a username or a --from option\n"
+class TestChat < MiniTest::Test
+  def test_must_output_an_error_message_if_no_username_or_from_option_is_procided
+    assert_output "You must specify a username or a --from option\n" do
+      Runoff::Commands::Chat.process []
+    end
   end
 end

data/test/command_test.rb

@@ -1,29 +1,41 @@
-require 'minitest/spec'
 require 'minitest/autorun'
+require 'minitest/unit'
 require 'runoff'
 
-describe Runoff::Commands::Command do
-  it 'must create a Composition object based on the Skype username or a specific path' do
-    Runoff::Commands::Command.send(:get_composition, nil, 'test/test_db.sqlite').must_be_instance_of Runoff::Composition
+class TestCommand < MiniTest::Test
+  def test_must_create_a_composition_object_based_on_a_specified_path_to_database_file
+    assert_instance_of Runoff::Composition, Runoff::Commands::Command.send(:get_composition, nil, 'test/test_db.sqlite')
   end
 
-  it 'must return a default destination path if no optional path is specified' do
-    Runoff::Commands::Command.send(:get_destination, nil).must_equal "#{ENV['HOME']}/skype-backup"
+  def test_must_return_a_default_destination_path_if_no_optional_path_is_specified
+    assert_equal "#{ENV['HOME']}/skype-backup", Runoff::Commands::Command.send(:get_destination, nil)
   end
 
-  it 'must return a custom path if an optional path variable is specified' do
-    path = Runoff::Commands::Command.send(:get_destination, 'test/test_db.sqlite')
-    path.must_equal 'test/test_db.sqlite'
+  def test_must_return_a_custom_path_if_an_optional_path_is_specified
+    path = Runoff::Commands::Command.send :get_destination, 'test/test_db.sqlite'
+
+    assert_equal 'test/test_db.sqlite', path
   end
 
-  it 'must output correct message based on the exported items count' do
-    ->{ Runoff::Commands::Command.send(:print_result, 1) }.must_output "Finished: 1 file was exported\n"
-    ->{ Runoff::Commands::Command.send(:print_result, 2) }.must_output "Finished: 2 files were exported\n"
+  def test_must_output_correct_message_based_on_the_exported_items_count
+    assert_output "Finished: 1 file was exported\n" do
+      Runoff::Commands::Command.send :print_result, 1
+    end
+
+    assert_output "Finished: 2 files were exported\n" do
+      Runoff::Commands::Command.send :print_result, 2
+    end
   end
 
-  it 'must output a list of available chatnames' do
+  def test_must_output_a_list_of_available_chatnames
     chatnames = ['first-chatname', 'second-chatname']
 
-    ->{ Runoff::Commands::Command.send(:list_chatnames, chatnames) }.must_output "[0] first-chatname\n[1] second-chatname\n\n"
+    assert_output "[0] first-chatname\n[1] second-chatname\n\n" do
+      Runoff::Commands::Command.send :list_chatnames, chatnames
+    end
+  end
+
+  def test_does_not_create_an_archive_if_the_archive_option_is_set_to_false
+    skip
   end
 end

data/test/composition_test.rb

@@ -1,53 +1,58 @@
-require 'minitest/spec'
 require 'minitest/autorun'
+require 'minitest/unit'
 require 'runoff'
 require 'fileutils'
 
-describe Runoff::Composition do
-  before { @composition = Runoff::Composition.new 'test/test_db.sqlite' }
+class TestComposition < MiniTest::Test
+  def setup
+    @composition = Runoff::Composition.new 'test/test_db.sqlite'
+  end
+
+  def teardown
+    FileUtils.rm_rf 'test/tmp'
+  end
 
-  it "must raise an IOError if the file that is passed to the constructor doesn't exist" do
-    ->{ composition = Runoff::Composition.new 'not_existing.db' }.must_raise IOError
+  def test_must_raise_an_IOError_if_the_file_that_is_passed_to_the_constructor_does_not_exist
+    assert_raises IOError do
+      composition = Runoff::Composition.new 'not_existing.db'
+    end
   end
 
-  it 'must have a getter method for exported filenames' do
-    @composition.must_respond_to :exported_filenames
+  def test_must_respond_to_exported_filenames_method
+    assert_respond_to @composition, :exported_filenames
   end
 
-  it 'must return parsed chatnames together with partly parsed chatnames' do
+  def test_must_return_parsed_chatnames_together_with_partly_parsed_chatnames
     chatnames, raw_chatnames = @composition.get_chatnames
 
-    chatnames.must_equal ['something-more', 'something-else']
-    raw_chatnames.must_equal ['#something/$more;', '#something/$else;']
+    assert_equal ['something-more', 'something-else'], chatnames
+    assert_equal ['#something/$more;', '#something/$else;'], raw_chatnames
   end
 
-  it 'must return a count of the exported filenames' do
+  def test_must_return_a_count_of_the_exported_filenames
     file_count = @composition.send(
       :run_export,
       [{
-        chatname: '#test/$one;7687623',
+        chatname: '#john/$elis;7687623',
         timestamp: 123123213,
-        from_dispname: 'Aidzis',
+        from_dispname: 'John',
         body_xml: ''
       }],
       'test/tmp'
     )
 
-    file_count.must_equal 1
-    FileUtils.rm_rf 'test/tmp'
+    assert_equal 1, file_count
   end
 
-  it 'must return a count of the exported filenames when called for all chats' do
+  def test_must_return_a_count_of_the_exported_filenames_when_called_for_all_chats
     file_count = @composition.export 'test/tmp'
 
-    file_count.must_equal 2
-    FileUtils.rm_rf 'test/tmp'
+    assert_equal 2, file_count
   end
 
-  it 'must return a count of the exported filenames when called for specific chats' do
+  def test_must_return_a_count_of_the_exported_filenames_when_called_for_specific_chats
     file_count = @composition.export_chats ['#something/$more;', '#something/$else;'], 'test/tmp'
 
-    file_count.must_equal 2
-    FileUtils.rm_rf 'test/tmp'
+    assert_equal 2, file_count
   end
 end

data/test/file_writer_test.rb

@@ -1,80 +1,90 @@
+require 'minitest/autorun'
 require 'minitest/unit'
 require 'runoff'
 require 'fileutils'
 
-describe Runoff::FileWriter do
-  before do
+class TestFileWriter < MiniTest::Test
+  def setup
     @incorrect_chat_record = {
       chatname: '#john/$;521357125362',
       timestamp: 1366280218,
-      from_dispname: 'Aidzis',
+      from_dispname: 'John',
       body_xml: 'This is a text'
     }
 
     @chat_record = {
       chatname: '#braun/$drake;521357125362',
       timestamp: 1366280218,
-      from_dispname: 'Aidzis',
+      from_dispname: 'Braun',
       body_xml: 'This is a text.'
     }
 
-    correct_format = MiniTest::Mock.new
-
-    correct_format.expect :get_filename, 'something-more', [Hash]
-    correct_format.expect :get_filename, 'something-more', [Hash]
-    correct_format.expect :build_entry, '[2013-04-18 13:16:58] Aidzis: This is a text.', [Hash]
-    correct_format.expect :build_entry, '[2013-04-18 13:16:58] Aidzis: This is a text.', [Hash]
-
+    correct_format = get_correct_format_mock
     @correct_file_writer = Runoff::FileWriter.new correct_format
-
-    incorrect_format = MiniTest::Mock.new
-
-    incorrect_format.expect :get_filename, 'something', [Hash]
-    incorrect_format.expect :build_entry, '[2013-04-18 13:16:58] Aidzis: This is a text.', [Hash]
-
+    incorrect_format = get_incorrect_format_mock
     @incorrect_file_writer = Runoff::FileWriter.new incorrect_format
   end
 
-  describe "#save_to_file" do
-    after do
-      FileUtils.rm_rf 'test/tmp'
-      Dir.glob('test/*.zip').each do |archive|
-        File.delete archive
-      end
-    end
+  def teardown
+    FileUtils.rm_rf 'test/tmp'
 
-    it 'must write chat content to file' do
-      @correct_file_writer.save_to_file @chat_record, 'test/tmp'
-      @incorrect_file_writer.save_to_file @incorrect_chat_record, 'test/tmp'
-      Dir.glob('test/tmp/*.txt').count.must_equal 2
+    Dir.glob('test/*.zip').each do |archive|
+      File.delete archive
     end
+  end
 
-    it 'must append to a file if the filename already exists' do
-      @additional_chat_record = @chat_record
+  def test_must_write_chat_content_to_file
+    @correct_file_writer.save_to_file @chat_record, 'test/tmp'
+    @incorrect_file_writer.save_to_file @incorrect_chat_record, 'test/tmp'
 
-      @correct_file_writer.save_to_file @chat_record, 'test/tmp'
-      @incorrect_file_writer.save_to_file @incorrect_chat_record, 'test/tmp'
-      @correct_file_writer.save_to_file @additional_chat_record, 'test/tmp'
-      Dir.glob('test/tmp/*.txt').count.must_equal 2
-    end
+    assert_equal 2, Dir['test/tmp/*.txt'].count
+  end
+
+  def test_must_append_to_a_file_if_the_filename_already_exists
+    @additional_chat_record = @chat_record
+
+    @correct_file_writer.save_to_file @chat_record, 'test/tmp'
+    @incorrect_file_writer.save_to_file @incorrect_chat_record, 'test/tmp'
+    @correct_file_writer.save_to_file @additional_chat_record, 'test/tmp'
+
+    assert_equal 2, Dir['test/tmp/*.txt'].count
   end
 
-  it 'must create a Zip file of the file output directory' do
+  def test_must_create_a_zip_file_of_the_destination_directory
     output_directory = 'test/tmp'
     files = %w[first.txt second.txt]
 
     Dir.mkdir(output_directory) unless File.exists?(output_directory)
+
     files.each do |filename|
-      File.new "#{output_directory}/#{filename}", 'w'
+      file = File.new "#{output_directory}/#{filename}", 'w'
+      file.close
     end
 
     Runoff::FileWriter.archive output_directory
-    Dir["test/*.zip"].length.must_equal 1
 
-    Dir.glob('test/*.zip').each do |archive|
-      File.delete archive
-    end
+    assert_equal 1, Dir['test/*.zip'].count
+  end
 
-    FileUtils.rm_rf 'test/tmp'
+  private
+
+  def get_correct_format_mock
+    correct_format = MiniTest::Mock.new
+
+    correct_format.expect :get_filename, 'braun-drake.txt', [Hash]
+    correct_format.expect :get_filename, 'braun-drake.txt', [Hash]
+    correct_format.expect :build_entry, '[2013-04-18 13:16:58] Braun: This is a text.', [Hash]
+    correct_format.expect :build_entry, '[2013-04-18 13:16:58] Braun: This is a text.', [Hash]
+
+    correct_format
+  end
+
+  def get_incorrect_format_mock
+    incorrect_format = MiniTest::Mock.new
+
+    incorrect_format.expect :get_filename, 'john.txt', [Hash]
+    incorrect_format.expect :build_entry, '[2013-04-18 13:16:58] John: This is a text.', [Hash]
+
+    incorrect_format
   end
 end

data/test/location_test.rb

@@ -1,19 +1,23 @@
-require 'minitest/spec'
 require 'minitest/autorun'
+require 'minitest/unit'
 require 'runoff'
 
-describe Runoff::Location do
-  describe '.default_skype_data_location' do
-    it 'must return a default path depending on the operating system' do
-      path = Runoff::Location.default_skype_data_location 'aidzis_skype'
+class TestLocation < MiniTest::Test
+  def setup
+    @path = Runoff::Location.default_skype_data_location 'aidzis_skype'
+  end
 
-      if RbConfig::CONFIG['host_os'] =~ /mingw/
-        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/
+  def test_must_return_a_default_path_depending_on_the_operating_system
+    if RbConfig::CONFIG['host_os'] =~ /mingw/
+      if File.exist?("#{ENV['APPDATA']}\\Skype")
+        assert_match /\/Users\/[a-zA-Z0-9]+\/AppData\/Roaming\/Skype\/aidzis_skype\/main\.db/, @path
       else
-        path.must_match /~\/Library\/Application Support\/Skype\/aidzis_skype\/main\.db/
+        assert_match /\/Users\/[a-zA-Z0-9]+\/AppData\/Local\/Packages\/[a-zA-Z0-9_\/\.]+\/aidzis_skype\/main\.db/, @path
       end
+    elsif RbConfig::CONFIG['host_os'] =~ /linux/
+      assert_match /\/home\/[a-zA-Z0-9]+\/\.Skype\/aidzis_skype\/main\.db/, @path
+    else
+      assert_match /~\/Library\/Application Support\/Skype\/aidzis_skype\/main\.db/, @path
     end
   end
 end

data/test/skype_data_format_test.rb

@@ -1,70 +1,71 @@
-require 'minitest/spec'
 require 'minitest/autorun'
+require 'minitest/unit'
 require 'runoff'
 
-describe Runoff::SkypeDataFormat do
-  before do
+class TestSkypeDataFormat < MiniTest::Test
+  def setup
     @format = Runoff::SkypeDataFormat.new
   end
 
-  it 'must return a valid filename from a hash (single record in a database)' do
+  def test_must_return_a_valid_filename_from_a_hash
     record = { chatname: '#brian/$john;521357125362' }
     filename = @format.get_filename record
 
-    filename.must_equal 'brian-john.txt'
+    assert_equal 'brian-john.txt', filename
   end
 
-  it 'must build a string from the necessary database record columns' do
+  def test_must_build_a_string_from_the_necessary_database_record_columns
     record = {
       chatname: '#brian/$john;521357125362',
       timestamp: 1366280218,
       from_dispname: 'Aidzis',
       body_xml: 'This is a text.'
     }
+
     entry = @format.build_entry record
 
-    entry.must_equal '[2013-04-18 13:16:58] Aidzis: This is a text.'
+    assert_equal '[2013-04-18 13:16:58] Aidzis: This is a text.', entry
   end
 
-  it 'must return a valid and readable name from a raw chatname' do
+  def test_must_return_a_valid_and_readable_name_from_a_raw_chatname
     raw_chatname = '#something/$else;521357125362'
     chatname = @format.parse_chatname raw_chatname
 
-    chatname.must_equal 'something-else'
+    assert_equal 'something-else', chatname
   end
 
-  it 'must return a valid and readable name from broken chatname records' do
+  def test_must_return_a_valid_and_readable_name_from_a_broken_chatname_record
     raw_chatname = '#something/$521357125362'
     chatname = @format.parse_chatname raw_chatname
 
-    chatname.must_equal 'something'
+    assert_equal 'something', chatname
   end
 
-  it 'must return a chatname without the extra symbols' do
+  def test_must_return_a_chatname_without_the_extra_symbols
     raw_chatname = '#something/$else;521357125362'
     chatname = @format.partly_parse_chatname raw_chatname
 
-    chatname.must_equal '#something/$else;'
+    assert_equal '#something/$else;', chatname
   end
 
-  it 'must return a chatname without the extra symbols for broken chatname records' do
+  def test_must_return_a_chatname_without_the_extra_symbols_for_a_broken_chatname_record
     raw_chatname = '#something/$521357125362'
     chatname = @format.partly_parse_chatname raw_chatname
 
-    chatname.must_equal '#something/$'
+    assert_equal '#something/$', chatname
   end
 
-  it 'must return a string without Skype emotion XML tags' do
+  def test_must_return_a_string_without_skype_emotion_xml_tags
     string = 'Some text <ss type="laugh">:D</ss>'
     clean_string = @format.send :parse_body_xml, string
 
-    clean_string.must_equal 'Some text :D'
+    assert_equal 'Some text :D', clean_string
   end
 
-  it 'must remove all starting and ending dashes from a string' do
+  def test_must_remove_all_starting_and_ending_dashes_from_a_string
     string = '---example--'
     valid_name = @format.send :trim_dashes, string
 
-    valid_name.must_equal 'example'
+    assert_equal 'example', valid_name
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runoff
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Aigars Dzerviniks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-27 00:00:00.000000000 Z
+date: 2013-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander