sync_songs 0.0.1

data/test/unit/sample_data/sample_data.rb

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+
+require_relative '../../../lib/sync_songs/song'
+
+# Public: Classes for syncing sets of songs.
+module SyncSongs
+  # Internal: Data for tests. DO NOT CHANGE unless you want to change
+  # the meaning of many tests.
+  module SampleData
+    def setupTestSongs
+      @songs = [Song.new('Name1  '    , '  Artist1'),   # 0
+                Song.new(' Name2 '    , ' Artist2 '),   # 1
+                Song.new('  Name2    ', '   Artist1 '), # 2
+                Song.new('Name1'      , 'Artist2'),     # 3
+                Song.new(' Name1   '  , 'Artist1'),     # 4
+                Song.new('  Name2 '   , 'Artist2'),     # 5
+                Song.new('Name'       , '     artist'), # 6
+                Song.new('      name ', 'Artist     '), # 7
+                Song.new('Some name', 'An Artist',      # 8
+                         'The Album', 330, 'qwerty')]
+    end
+  end
+end

data/test/unit/services/test_csv_set.rb

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+
+require 'test/unit'
+require_relative '../../../lib/sync_songs/services/csv_set'
+require_relative '../sample_data/sample_data'
+
+# Public: Classes for syncing sets of songs.
+module SyncSongs
+  # Internal: Unit test for the class CsvSet.
+  class TestCsvSet < Test::Unit::TestCase
+    include SampleData
+
+    # Internal: Setup CsvSets.
+    def setup
+      setupTestSongs
+      @file_names = []
+      1.upto(2) do |i|
+        @file_names << 'test/unit/services/sample_data/'\
+        "test_csv_set_sample#{i}.csv"
+      end
+
+      @sets = []
+      @file_names.each { |n| @sets << CsvSet.new(n) }
+    end
+
+    def test_simple
+      # Add some songs to CSV files
+      @sets[0].addToLibrary(SongSet.new(@songs[0], @songs[8]))
+      @sets[1].addToLibrary(SongSet.new(@songs[0], @songs[7]))
+
+      assert(File.exists?(@file_names[0]), 'Should create a file')
+
+      # Then get data from them.
+      @lib = []
+      @sets.each { |s| @lib << s.library }
+
+      # Should work as expected.
+      assert(@lib[0].member?(@songs[0]),
+             'Reading from CSV should not corrupt data')
+      assert(@lib[0].member?(@songs[8]),
+             'Reading from CSV should not corrupt data')
+      @lib.each do |l|
+        assert_not_nil(l, 'Should read something from CSV')
+        assert_equal(l, l.search(l),
+                     'Search should simply return what is searched for')
+      end
+
+      ex_to_l0 = @lib[0].exclusiveTo(@lib[1])
+      exl_msg = 'exclusiveTo works as expected'
+      assert(ex_to_l0.size == 1, exl_msg)
+      assert_equal(ex_to_l0, Set.new([@songs[7]]), exl_msg)
+    end
+  end
+end

data/test/unit/services/test_service_controller.rb

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+
+require 'test/unit'
+require_relative '../../../lib/sync_songs/controller'
+require_relative '../../../lib/sync_songs/cli'
+require_relative '../../../lib/sync_songs/services/service_controller'
+
+# Public: Classes for syncing sets of songs.
+module SyncSongs
+  # Internal: Unit test for the class ServiceController.
+  class TestLastfmSet < Test::Unit::TestCase
+
+    def test_simple
+      c = Controller.new(CLI.new())
+      ca = [ServiceController.new(c, 'user', 'name', 'type'),
+            ServiceController.new(c, 'USER', 'NAME', 'TYPE')]
+
+      eql_msg = 'Service controllers with the same user, name and '\
+      'type are equal'
+      assert(ca[0].eql?(ca[1]))
+      assert(ca[1].eql?(ca[0]))
+
+      cs = Set.new(ca)
+
+      assert_equal(cs.size, 1, 'There cannot be several service '\
+                   'controllers with the same user, name and type '\
+                   'in a Set are equalService controller')
+    end
+  end
+end

data/test/unit/suite_data.rb

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+
+# Test suite for data classes.
+require 'test/unit'
+require_relative 'test_song'
+require_relative 'test_song_set'
+require_relative './services/test_service_controller'
+require_relative './services/test_csv_set'
+
+# The following tests takes too long time to be included in the suit.
+# require_relative './services/test_grooveshark_set'
+# require_relative './services/test_lastfm_set'

data/test/unit/test_song.rb

@@ -0,0 +1,129 @@
+# -*- coding: utf-8 -*-
+
+require 'test/unit'
+require_relative 'sample_data/sample_data'
+
+# Public: Classes for syncing sets of songs.
+module SyncSongs
+  # Internal: Unit test for the class Song.
+  class TestSong < Test::Unit::TestCase
+    include SampleData
+
+    def setup
+      setupTestSongs
+    end
+
+    def test_simple
+      init_msg = 'Songs should initialize'
+      assert_not_nil(@songs[0], init_msg)
+      assert_not_nil(@songs[1], init_msg)
+
+      assert_raise(ArgumentError) { @songs << Song.new(''       , 'Name') }
+      assert_raise(ArgumentError) { @songs << Song.new('Artist' , '') }
+      assert_raise(ArgumentError) { @songs << Song.new('   '    , '    ') }
+    end
+
+    def test_strip
+      lead_trail_ws = /(^\s+)|(\s+$)/
+      strip_msg = 'Songs should be stripped from leading and '\
+      'trailing whitespace'
+      @songs.each do |song|
+        assert_nil(lead_trail_ws.match(song.name), strip_msg)
+        assert_nil(lead_trail_ws.match(song.artist), strip_msg)
+      end
+    end
+
+    def test_getters
+      getter_msg = 'Getters should return an unchanged value'
+      assert_equal(@songs[0].artist, 'Artist1', getter_msg)
+      assert_equal(@songs[1].artist, 'Artist2', getter_msg)
+      assert_not_equal(@songs[0].artist, 'Artist2', getter_msg)
+      assert_not_equal(@songs[1].artist, 'Artist1', getter_msg)
+
+      assert_equal(@songs[0].name, 'Name1', getter_msg)
+      assert_equal(@songs[1].name, 'Name2', getter_msg)
+      assert_not_equal(@songs[0].name, 'Name2', getter_msg)
+      assert_not_equal(@songs[1].name, 'Name1', getter_msg)
+    end
+
+    def test_spaceship
+      spaceship_msg = 'The spaceship works as expected'
+      assert_equal(@songs[0] <=> @songs[1], -1, spaceship_msg)
+      assert_equal(@songs[1] <=> @songs[0], 1, spaceship_msg)
+      assert_equal(@songs[1] <=> @songs[2], 1, spaceship_msg)
+      assert_equal(@songs[4] <=> @songs[3], -1, spaceship_msg)
+      assert_equal(@songs[0] <=> @songs[4], 0, spaceship_msg)
+      assert_equal(@songs[1] <=> @songs[5], 0, spaceship_msg)
+      assert_equal(@songs[6] <=> @songs[7], 0, spaceship_msg)
+    end
+
+    def test_comparison_operators
+      comparison_msg = 'Comparison operators works as expected'
+      assert(@songs[0] < @songs[1], comparison_msg)
+      assert(@songs[1] > @songs[0], comparison_msg)
+      assert(@songs[1] > @songs[2], comparison_msg)
+      assert(@songs[0] < @songs[3], comparison_msg)
+      assert(@songs[4] <= @songs[5], comparison_msg)
+      assert(@songs[6] <= @songs[7], comparison_msg)
+      assert(@songs[6] == @songs[7], comparison_msg)
+    end
+
+    def test_eql?
+      identity_msg = 'Songs should be self-identical'
+      assert(@songs[0].eql?(@songs[0]), identity_msg)
+      assert(@songs[1].eql?(@songs[1]), identity_msg)
+
+      assert(!@songs[0].eql?(@songs[1]) && !@songs[1].eql?(@songs[0]),
+             'Non-equality for songs is symmetrical')
+
+      both_fields_equality_msg = 'Only the fields name and artist '\
+      'affect equality'
+      assert(!@songs[1].eql?(@songs[2]), both_fields_equality_msg)
+      assert(!@songs[2].eql?(@songs[3]), both_fields_equality_msg)
+      assert(!@songs[3].eql?(@songs[4]), both_fields_equality_msg)
+      assert(!@songs[4].eql?(@songs[5]), both_fields_equality_msg)
+
+      spaces_not_significant_msg = 'Spaces are not significant for equality'
+      assert(@songs[0].eql?(@songs[4]), spaces_not_significant_msg)
+      assert(@songs[1].eql?(@songs[5]), spaces_not_significant_msg)
+
+      assert(@songs[6].eql?(@songs[7]), 'Case should not matter for equality')
+
+      sanity_msg = 'Assumptions about test data should be correct'
+      assert_not_equal(@songs[1], @songs[2], sanity_msg)
+      assert_not_equal(@songs[2], @songs[3], sanity_msg)
+      assert_not_equal(@songs[3], @songs[4], sanity_msg)
+      assert_not_equal(@songs[4], @songs[5], sanity_msg)
+    end
+
+    def test_include?
+      identical_msg = 'Identical songs includes each others'
+      assert(@songs[0].include?(@songs[4]), identical_msg)
+      assert(@songs[4].include?(@songs[0]), identical_msg)
+      assert(@songs[1].include?(@songs[5]), identical_msg)
+      assert(@songs[5].include?(@songs[1]), identical_msg)
+
+      case_msg = 'include? works as expected and is not sensitive to case'
+      assert(@songs[2].include?(@songs[6]), case_msg)
+      assert(@songs[2].include?(@songs[7]), case_msg)
+    end
+
+    def test_similar?
+      similar_msg = 'similar? is like reflexive include'
+      assert(@songs[0].similar?(@songs[6]), similar_msg)
+      assert(@songs[6].similar?(@songs[0]), similar_msg)
+      assert(@songs[3].similar?(@songs[7]), similar_msg)
+      assert(@songs[7].similar?(@songs[3]), similar_msg)
+    end
+
+    def to_search_term
+      assert_equal(@songs[0].to_search_term, 'name1 artist1',
+                   'Search term is in correct form')
+    end
+
+    def test_to_s
+      assert_equal(@songs[0].to_s, 'Artist1 - Name1',
+                   'String is in correct form')
+    end
+  end
+end

data/test/unit/test_song_set.rb

@@ -0,0 +1,134 @@
+# -*- coding: utf-8 -*-
+
+require 'test/unit'
+require_relative '../../lib/sync_songs/song_set'
+require_relative 'sample_data/sample_data'
+
+# Public: Classes for syncing sets of songs.
+module SyncSongs
+  # Private: Unit test for the class SongSet.
+  class TestSongSet < Test::Unit::TestCase
+    include SampleData
+
+    def setup
+      setupTestSongs
+    end
+
+    def test_size
+      set = SongSet.new
+      set << @songs[0]
+
+      size_msg = 'Should return set\'s size'
+      assert(set.size == 1, size_msg)
+      assert(set.length == 1, size_msg)
+    end
+
+    def test_simple
+      sets = [SongSet.new, SongSet.new]
+
+      init_msg = 'Song sets should initialize'
+      assert_not_nil(sets[0], init_msg)
+      assert_not_nil(sets[1], init_msg)
+    end
+
+    def test_add
+      # add is used by the constructor of SongSet
+      sets = [SongSet.new(@songs[0]), SongSet.new(@songs[0])]
+
+      add_msg = 'A song set should not manipulate its content'
+      assert_equal(@songs[0], sets[0].first, add_msg)
+      assert_equal(@songs[0], sets[1].first, add_msg)
+      assert(sets[0].member?(@songs[0]), add_msg)
+      assert(sets[1].member?(@songs[0]), add_msg)
+    end
+
+    def test_add?
+      addq_msg = 'add? works as expected'
+      set = SongSet.new
+      set.add?(@songs[0])
+      assert_equal(set.add?(@songs[0]), nil, addq_msg)
+    end
+
+    def test_difference
+      sets = [SongSet.new(@songs[0]), SongSet.new(@songs[0])]
+
+      diff_eql_msg = 'There is no difference between sets with the '\
+      'same members'
+      assert(sets[0].difference(sets[1]).empty?, diff_eql_msg)
+      assert(sets[1].difference(sets[0]).empty?, diff_eql_msg)
+
+      sets[0].add(@songs[1])  # sets[0] = {@songs[0], @songs[1]}
+      sets[1].add(@songs[2])  # sets[1] = {@songs[0], @songs[2]}
+      assert(!(sets[0] - sets[1]).member?(@songs[0]),
+             'The difference is not the shared element')
+
+      diff_msg = 'The difference is the non-shared element in the receiver'
+      assert((sets[0] - sets[1]).member?(@songs[1]), diff_msg)
+      assert((sets[1] - sets[0]).member?(@songs[2]), diff_msg)
+      sets[0].add(@songs[2]) # sets[0] = {@songs[0], @songs[1], @songs[2]}
+      assert((sets[0] - sets[1]).member?(@songs[1]), diff_msg)
+      assert((sets[1] - sets[0]).empty?, diff_msg)
+
+      sets[2] = SongSet.new(@songs[0], @songs[1], @songs[2])
+      sets[3] = SongSet.new(@songs[2], @songs[0], @songs[1])
+      assert((sets[2] - sets[3]).empty?,
+             'There is no difference between sets with the same '\
+             'members that has been added in different order')
+      assert((sets[2] - sets[3]).empty?,
+             'The alias - for difference should work')
+
+      sets[2].add(@songs[0])
+      sets[3].add(@songs[2])
+      assert((sets[2] - sets[3]).empty?, 'There are no duplicate entries')
+
+      sets[2].add(@songs[6])
+      sets[3].add(@songs[7])
+      assert((sets[2] - sets[3]).empty?,
+             'Case should not matter for the difference')
+    end
+
+    def test_empty?
+      empty_msg = 'empty? works as expected'
+      set = SongSet.new()
+      assert(set.empty?, empty_msg)
+      set << @songs[0]
+      assert(!set.empty?, empty_msg)
+    end
+
+    def test_exclusiveTo
+      sets = [SongSet.new(@songs[0], @songs[1]),
+               SongSet.new(@songs[1], @songs[2])]
+
+      exclusiveTo_msg = 'The songs to add are those that are in the '\
+      'given set but not in this set'
+      assert(sets[0].exclusiveTo(sets[1]).first.eql?(@songs[2]),
+             exclusiveTo_msg)
+      assert(sets[1].exclusiveTo(sets[0]).first.eql?(@songs[0]),
+             exclusiveTo_msg)
+    end
+
+    def test_inspect
+      sets = [SongSet.new, SongSet.new(@songs[0], @songs[1])]
+
+      # There should be a working inspect method.
+      assert_nothing_raised do
+        sets.each { |set| set.inspect }
+      end
+    end
+
+    def test_clear
+      set = SongSet.new
+      @songs.each { |song| set << song }
+
+      assert(set.clear.empty?, 'Set should be empty after being cleared')
+    end
+
+    def test_to_a
+      to_a_msg = 'to_a works as expected'
+      set = SongSet.new(@songs[0], @songs[1])
+      set = set.to_a
+      assert_equal(set.class, Array, to_a_msg)
+      assert_equal(set[0], @songs[0], to_a_msg)
+    end
+  end
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: sync_songs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sleft
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grooveshark
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.7
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.16
+- !ruby/object:Gem::Dependency
+  name: lastfm
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.17.0
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+description: Sync sets of songs
+email:
+- fte08eas@student.lu.se
+executables:
+- sync_songs
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CONTRIBUTING.org
+- Gemfile
+- Gemfile.lock
+- LICENSE.org
+- README.org
+- Rakefile
+- bin/sync_songs
+- development.org
+- lib/sync_songs.rb
+- lib/sync_songs/cli.rb
+- lib/sync_songs/controller.rb
+- lib/sync_songs/services/csv_cli.rb
+- lib/sync_songs/services/csv_controller.rb
+- lib/sync_songs/services/csv_set.rb
+- lib/sync_songs/services/grooveshark_cli.rb
+- lib/sync_songs/services/grooveshark_controller.rb
+- lib/sync_songs/services/grooveshark_set.rb
+- lib/sync_songs/services/lastfm_cli.rb
+- lib/sync_songs/services/lastfm_controller.rb
+- lib/sync_songs/services/lastfm_set.rb
+- lib/sync_songs/services/service_controller.rb
+- lib/sync_songs/song.rb
+- lib/sync_songs/song_set.rb
+- lib/sync_songs/version.rb
+- plan.org
+- sync_songs.gemspec
+- test/unit/sample_data/sample_data.rb
+- test/unit/services/test_csv_set.rb
+- test/unit/services/test_service_controller.rb
+- test/unit/suite_data.rb
+- test/unit/test_song.rb
+- test/unit/test_song_set.rb
+homepage: https://github.com/Sleft/sync_songs
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: SyncSongs
+test_files:
+- test/unit/sample_data/sample_data.rb
+- test/unit/services/test_csv_set.rb
+- test/unit/services/test_service_controller.rb
+- test/unit/suite_data.rb
+- test/unit/test_song.rb
+- test/unit/test_song_set.rb