rbpod 0.0.4 → 0.0.5

data/ext/rbpod/playlist_collection.c

@@ -1,6 +1,7 @@
 /* playlist_collection.c */
 
 #include "rbpod.h"
+#include "database.h"
 #include "playlist.h"
 #include "collection.h"
 #include "playlist_collection.h"
@@ -9,7 +10,7 @@
  * call-seq:
  *     database() -> RbPod::Database
  *
- * The database from which this collection of playlists is attached to.
+ * Returns the database this playlist collection is attached to.
  */
 static VALUE rbpod_playlist_collection_database(VALUE self)
 {
@@ -18,65 +19,92 @@ static VALUE rbpod_playlist_collection_database(VALUE self)
 
 /*
  * call-seq:
- *     [](index) -> RbPod::Playlist
- *     [](name) -> RbPod::Playlist
+ *     include?(playlist) -> Boolean
  *
- * Returns a playlist by either position or name in the collection, or nil if it wasn't found.
+ * Returns true or false if the given RbPod::Playlist +playlist+ exists within the database.
  */
-static VALUE rbpod_playlist_collection_get(VALUE self, VALUE key)
+static VALUE rbpod_playlist_collection_include_p(VALUE self, VALUE playlist)
 {
-    VALUE parent = rbpod_playlist_collection_database(self);
-    Itdb_iTunesDB *database = TYPED_DATA_PTR(parent, Itdb_iTunesDB);
-    Itdb_Playlist *playlist = NULL;
-    int key_type = TYPE(key);
-
-    if (key_type == T_SYMBOL || key_type == T_STRING) {
-        playlist = itdb_playlist_by_name(database, StringValueCStr(key));
-        return Data_Wrap_Struct(cRbPodPlaylist, NULL, NULL, (void *) playlist);
+    VALUE database = rbpod_playlist_collection_database(self);
+    Itdb_iTunesDB *_database = TYPED_DATA_PTR(database, Itdb_iTunesDB);
+    Itdb_Playlist *_playlist = TYPED_DATA_PTR(playlist, Itdb_Playlist);
+
+    if (rb_obj_is_instance_of(playlist, cRbPodPlaylist) == FALSE) {
+        rb_raise(eRbPodError, "Invalid argument: expected RbPod::Playlist, got %s", StringValueCStr(playlist));
+        return Qfalse;
     }
 
-    if (key_type == T_FIXNUM) {
-        playlist = itdb_playlist_by_nr(database, FIX2INT(key));
-        return Data_Wrap_Struct(cRbPodPlaylist, NULL, NULL, (void *) playlist);
+    return BooleanValue(itdb_playlist_exists(_database, _playlist));
+}
+
+/*
+ * call-seq:
+ *     master() -> RbPod::Playlist
+ *
+ * Returns the master playlist from the database.
+ */
+static VALUE rbpod_playlist_collection_master(VALUE self)
+{
+    VALUE database = rbpod_playlist_collection_database(self);
+    Itdb_iTunesDB *_database = TYPED_DATA_PTR(database, Itdb_iTunesDB);
+    Itdb_Playlist *_playlist = itdb_playlist_mpl(_database);
+
+    if (_playlist == NULL) {
+        return Qnil;
     }
 
-    return Qnil;
+    /* Create a new instance of the master playlist from the data provided. */
+    return rb_class_new_instance_with_data(0, NULL, cRbPodPlaylist, _playlist);
 }
 
 /*
  * call-seq:
  *     podcast() -> RbPod::Playlist
  *
- * Returns the podcast playlist in this collection.
+ * Returns the podcast playlist from the database.
  */
-static VALUE rbpod_playlist_collection_podcast_get(VALUE self)
+static VALUE rbpod_playlist_collection_podcast(VALUE self)
 {
-    VALUE parent = rbpod_playlist_collection_database(self);
-    Itdb_iTunesDB *database = TYPED_DATA_PTR(parent, Itdb_iTunesDB);
-    Itdb_Playlist *podcasts = itdb_playlist_podcasts(database);
-    return Data_Wrap_Struct(cRbPodPlaylist, NULL, NULL, (void *) podcasts);
+    VALUE database = rbpod_playlist_collection_database(self);
+    Itdb_iTunesDB *_database = TYPED_DATA_PTR(database, Itdb_iTunesDB);
+    Itdb_Playlist *_playlist = itdb_playlist_podcasts(_database);
+
+    if (_playlist == NULL) {
+        return Qnil;
+    }
+
+    /* Create a new instance of the podcast playlist from the data provided. */
+    return rb_class_new_instance_with_data(0, NULL, cRbPodPlaylist, _playlist);
 }
 
 /*
  * call-seq:
- *     master() -> RbPod::Playlist
+ *     initialize(database) -> RbPod::PlaylistCollection
  *
- * Returns the master playlist in this collection.
+ * Given an RbPod::Database +database+ creates a collection of playlists from it.
  */
-static VALUE rbpod_playlist_collection_master_get(VALUE self)
+static VALUE rbpod_playlist_collection_initialize(VALUE self, VALUE database)
 {
-    VALUE parent = rbpod_playlist_collection_database(self);
-    Itdb_iTunesDB *database = TYPED_DATA_PTR(parent, Itdb_iTunesDB);
-    Itdb_Playlist *master = itdb_playlist_mpl(database);
-    return Data_Wrap_Struct(cRbPodPlaylist, NULL, NULL, (void *) master);
+    Itdb_iTunesDB *_database = TYPED_DATA_PTR(database, Itdb_iTunesDB);
+
+    if (rb_obj_is_instance_of(database, cRbPodDatabase) == FALSE) {
+        rb_raise(eRbPodError, "Invalid Arguments: Expected RbPod::Database, got %s", StringValueCStr(database));
+        return Qnil;
+    }
+
+    rb_iv_set(self, "@database", database);
+
+    DATA_PTR(self) = _database->playlists;
+
+    return self;
 }
 
-inline VALUE rbpod_playlist_collection_create(VALUE database, GList *items)
+/*
+ * :nodoc:
+ */
+static VALUE rbpod_playlist_collection_type(VALUE self)
 {
-    VALUE collection = rbpod_collection_create(items, cRbPodPlaylist);
-    rb_extend_object(collection, mRbPodPlaylistCollection);
-    rb_iv_set(collection, "@database", database);
-    return collection;
+    return cRbPodPlaylist;
 }
 
 void Init_rbpod_playlist_collection(void)
@@ -84,15 +112,20 @@ void Init_rbpod_playlist_collection(void)
 #if RDOC_CAN_PARSE_DOCUMENTATION
     mRbPod = rb_define_module("RbPod");
 #endif
-    /* This module extends any collection of playlists at runtime. */
-    mRbPodPlaylistCollection = rb_define_module_under(mRbPod, "PlaylistCollection");
+    cRbPodPlaylistCollection = rb_define_class_under(mRbPod, "PlaylistCollection", rb_cObject);
+
+    rb_real_include_module(cRbPodPlaylistCollection, mRbPodCollection);
+
+    rb_define_private_method(cRbPodPlaylistCollection, "type", rbpod_playlist_collection_type, 0);
+
+    rb_define_method(cRbPodPlaylistCollection, "initialize", rbpod_playlist_collection_initialize, 1);
 
-    rb_define_method(mRbPodPlaylistCollection, "database", rbpod_playlist_collection_database, 0);
+    rb_define_method(cRbPodPlaylistCollection, "database", rbpod_playlist_collection_database, 0);
 
-    rb_define_method(mRbPodPlaylistCollection, "master", rbpod_playlist_collection_master_get, 0);
-    rb_define_method(mRbPodPlaylistCollection, "podcast", rbpod_playlist_collection_podcast_get, 0);
+    rb_define_method(cRbPodPlaylistCollection, "include?", rbpod_playlist_collection_include_p, 1);
 
-    rb_define_method(mRbPodPlaylistCollection, "[]", rbpod_playlist_collection_get, 1);
+    rb_define_method(cRbPodPlaylistCollection, "master", rbpod_playlist_collection_master, 0);
+    rb_define_method(cRbPodPlaylistCollection, "podcast", rbpod_playlist_collection_podcast, 0);
 
     return;
 }

data/ext/rbpod/playlist_collection.h

@@ -3,12 +3,8 @@
 #ifndef RBPOD_PLAYLIST_COLLECTION_H
 #define RBPOD_PLAYLIST_COLLECTION_H
 
-#include "playlist.h"
-
-RUBY_EXTERN VALUE mRbPodPlaylistCollection;
+RUBY_EXTERN VALUE cRbPodPlaylistCollection;
 
 void Init_rbpod_playlist_collection(void);
 
-inline VALUE rbpod_playlist_collection_create(VALUE parent, GList *items);
-
 #endif /* RBPOD_PLAYLIST_COLLECTION_H */

data/ext/rbpod/rbpod.c

@@ -1,6 +1,7 @@
 /* rbpod.c */
 
 #include "rbpod.h"
+#include "error.h"
 #include "track.h"
 #include "device.h"
 #include "playlist.h"
@@ -15,28 +16,15 @@ VALUE eRbPodError;
 VALUE cRbPodDatabase;
 VALUE cRbPodDevice;
 
-VALUE cRbPodCollection;
-
-VALUE cRbPodPlaylist;
-VALUE mRbPodPlaylistCollection;
-
 VALUE cRbPodTrack;
-VALUE mRbPodTrackCollection;
-
-VALUE rb_cPathname;
+VALUE cRbPodPlaylist;
 
-inline VALUE rbpod_raise_error(GError *error)
-{
-    VALUE error_message;
+VALUE mRbPodCollection;
 
-    if (error != NULL) {
-        error_message = rb_str_new2(error->message);
-        g_error_free(error);
-        rb_raise(eRbPodError, "%s", StringValueCStr(error_message));
-    }
+VALUE cRbPodTrackCollection;
+VALUE cRbPodPlaylistCollection;
 
-    return Qnil;
-}
+VALUE rb_cPathname;
 
 /*
  * call-seq:
@@ -50,16 +38,38 @@ static VALUE rbpod_load_database(VALUE self, VALUE mount_point)
     return rb_class_new_instance(1, &mount_point, cRbPodDatabase);
 }
 
+/*
+ * This is a hack used to inject a pointer from the data of one class instance into another.
+ */
+inline VALUE rb_class_new_instance_with_data(int argc, VALUE *argv, VALUE class, void *handle)
+{
+    /* Create a new instance of this class. */
+    VALUE instance = rb_class_new_instance(argc, argv, class);
+
+    /* Assign it's DATA pointer to the given handle. */
+    DATA_PTR(instance) = handle;
+
+    return instance;
+}
+
+/*
+ * This is a hack so that including a module will trigger the +included+ singleton method.
+ */
+inline void rb_real_include_module(VALUE klass, VALUE module)
+{
+    ID included = rb_intern("included");
+
+    rb_include_module(klass, module);
+
+    rb_funcall(mRbPodCollection, included, 1, klass);
+}
+
 void Init_rbpod(void)
 {
     /* This is the wrapper for all RbPod related classes. */
     mRbPod = rb_define_module("RbPod");
 
-    /* This is a generic subclass of RuntimeError for RbPod-specific errors.*/
-    eRbPodError = rb_define_class_under(mRbPod, "Error", rb_eRuntimeError);
-
-    rb_cPathname = rb_const_get(rb_cObject, rb_intern("Pathname"));
-
+    Init_rbpod_error();
     Init_rbpod_database();
     Init_rbpod_device();
     Init_rbpod_collection();
@@ -70,6 +80,8 @@ void Init_rbpod(void)
 
     rb_define_global_function("RbPod", rbpod_load_database, 1);
 
+    rb_cPathname = rb_const_get(rb_cObject, rb_intern("Pathname"));
+
     return;
 }
 

data/ext/rbpod/rbpod.h

@@ -15,6 +15,8 @@ RUBY_EXTERN VALUE eRbPodError;
 
 RUBY_EXTERN VALUE rb_cPathname;
 
-inline VALUE rbpod_raise_error(GError *error);
+inline VALUE rb_class_new_instance_with_data(int argc, VALUE *argv, VALUE class, void *handle);
+
+inline void rb_real_include_module(VALUE klass, VALUE module);
 
 #endif /* RBPOD_H */

data/ext/rbpod/track_collection.c

@@ -2,6 +2,7 @@
 
 #include "rbpod.h"
 #include "track.h"
+#include "playlist.h"
 #include "collection.h"
 #include "track_collection.h"
 
@@ -9,19 +10,41 @@
  * call-seq:
  *     playlist() -> RbPod::Playlist
  *
- * The playlist from which this collection of tracks is attached to.
+ * Returns the playlist this track collection is attached to.
  */
 static VALUE rbpod_track_collection_playlist(VALUE self)
 {
-    return rb_iv_get(self, "@pkaylist");
+    return rb_iv_get(self, "@playlist");
 }
 
-inline VALUE rbpod_track_collection_create(VALUE playlist, GList *items)
+/*
+ * call-seq:
+ *     initialize(playlist) -> RbPod::TrackCollection
+ *
+ * Given an RbPod::Playlist +playlist+, returns a collection of tracks within the playlist.
+ */
+static VALUE rbpod_track_collection_initialize(VALUE self, VALUE playlist)
+{
+    Itdb_Playlist *_playlist = TYPED_DATA_PTR(playlist, Itdb_Playlist);
+
+    if (rb_obj_is_instance_of(playlist, cRbPodPlaylist) == FALSE) {
+        rb_raise(eRbPodError, "Invalid Arguments: Expected RbPod::Playlist, got %s", StringValueCStr(playlist));
+        return Qnil;
+    }
+
+    rb_iv_set(self, "@playlist", playlist);
+
+    DATA_PTR(self) = _playlist->members;
+
+    return self;
+}
+
+/*
+ * :nodoc:
+ */
+static VALUE rbpod_track_collection_type(VALUE self)
 {
-    VALUE collection = rbpod_collection_create(items, cRbPodTrack);
-    rb_extend_object(collection, mRbPodTrackCollection);
-    rb_iv_set(collection, "@playlist", playlist);
-    return collection;
+    return cRbPodTrack;
 }
 
 void Init_rbpod_track_collection(void)
@@ -29,10 +52,15 @@ void Init_rbpod_track_collection(void)
 #if RDOC_CAN_PARSE_DOCUMENTATION
     mRbPod = rb_define_module("RbPod");
 #endif
-    /* This module extends any collection of tracks at runtime. */
-    mRbPodTrackCollection = rb_define_module_under(mRbPod, "TrackCollection");
+    cRbPodTrackCollection = rb_define_class_under(mRbPod, "TrackCollection", rb_cObject);
+
+    rb_real_include_module(cRbPodTrackCollection, mRbPodCollection);
+
+    rb_define_method(cRbPodTrackCollection, "initialize", rbpod_track_collection_initialize, 1);
+
+    rb_define_private_method(cRbPodTrackCollection, "type", rbpod_track_collection_type, 0);
 
-    rb_define_method(mRbPodTrackCollection, "playlist", rbpod_track_collection_playlist, 0);
+    rb_define_method(cRbPodTrackCollection, "playlist", rbpod_track_collection_playlist, 0);
 
     return;
 }

data/ext/rbpod/track_collection.h

@@ -3,12 +3,8 @@
 #ifndef RBPOD_TRACK_COLLECTION_H
 #define RBPOD_TRACK_COLLECTION_H
 
-#include "track.h"
-
-RUBY_EXTERN VALUE mRbPodTrackCollection;
+RUBY_EXTERN VALUE cRbPodTrackCollection;
 
 void Init_rbpod_track_collection(void);
 
-inline VALUE rbpod_track_collection_create(VALUE parent, GList *items);
-
 #endif /* RBPOD_TRACK_COLLECTION_H */

data/lib/rbpod/version.rb

@@ -1,3 +1,3 @@
 module RbPod # :nodoc:
-  VERSION = "0.0.4" # :nodoc:
+  VERSION = "0.0.5" # :nodoc:
 end

data/spec/rbpod/collection_spec.rb

@@ -0,0 +1,25 @@
+shared_examples_for RbPod::Collection do
+  it 'should be a collection' do
+    collection.should be_kind_of(RbPod::Collection)
+  end
+
+  it 'should implement #each' do
+    collection.should respond_to(:each)
+  end
+
+  it 'should implement #size' do
+    collection.should respond_to(:size)
+  end
+
+  it 'should implement #first' do
+    collection.should respond_to(:first)
+  end
+
+  it 'should implement #last' do
+    collection.should respond_to(:last)
+  end
+
+  it 'should implement #[]' do
+    collection.should respond_to(:[])
+  end
+end

data/spec/{database_spec.rb → rbpod/database_spec.rb}

@@ -1,5 +1,5 @@
 describe RbPod::Database do
-  context 'Overall' do
+  context 'Without a new database' do
     describe '.create!' do
       it 'should create an empty default database and load it' do
         within_temporary_directory do |directory|
@@ -33,55 +33,48 @@ describe RbPod::Database do
     end
   end
 
-  context 'Given a blank database' do
-    before do
-      @directory = within_temporary_directory
-      @database  = RbPod::Database.create!(@directory)
-    end
-
-    after do
-      # This is a godawful hack.
-      FileUtils.remove_entry_secure(@directory)
-    end
+  context 'With a new database' do
+    include_context 'a new database'
 
     describe '#initialize' do
       it 'should return a Database instance' do
-        @database.should be_instance_of(RbPod::Database)
+        database.should be_instance_of(RbPod::Database)
       end
     end
 
     describe '#mountpoint' do
       it 'should match the mount point it was loaded from' do
-        @database.mountpoint.to_s.should == @directory
+        database.mountpoint.to_s.should == directory
       end
     end
 
     describe '#filename' do
       it 'should be an existing iTunes database on the file system' do
-        File.exists?(@database.filename).should be_true
+        File.exists?(database.filename).should be_true
       end
     end
 
     describe '#device' do
       it 'should return a Device instance' do
-        @database.device.should be_instance_of(RbPod::Device)
+        database.device.should be_instance_of(RbPod::Device)
       end
     end
 
     describe '#synchronized?' do
       it 'should be marked as synchronized' do
-        @database.should be_synchronized
+        database.should be_synchronized
       end
     end
 
     describe '#playlists' do
-      it 'should return a collection' do
-        @database.playlists.should be_instance_of(RbPod::Collection)
+      it 'should return a playlist collection' do
+        database.playlists.should be_instance_of(RbPod::PlaylistCollection)
       end
+    end
 
-      it 'should have a single master playlist' do
-        @database.playlists.length.should eq(1)
-        @database.playlists.first.is_master_playlist?.should be_true
+    describe '#tracks' do
+      it 'should return a track collection' do
+        database.tracks.should be_instance_of(RbPod::TrackCollection)
       end
     end
   end

data/spec/rbpod/device_spec.rb

@@ -0,0 +1,70 @@
+describe RbPod::Device do
+  context 'On a device backed by a new database' do
+    include_context 'a new database'
+
+    let(:device) { database.device }
+
+    describe '#[]' do
+      it 'should return a nil value for any key' do
+        device['ModelNumStr'].should be_nil
+      end
+
+      it 'should return nil with an invalid key' do
+        device['NonExistentValue'].should be_nil
+      end
+
+      it 'should return nil when unsetting a key' do
+        device['NotARealKey'] = nil
+        device['NotARealKey'].should be_nil
+      end
+    end
+
+    describe '#save!' do
+      it 'should return nil' do
+        device.save!.should eq(nil)
+      end
+    end
+
+    describe '#uuid' do
+      it 'should be nil' do
+        device.uuid.should eq(nil)
+      end
+    end
+
+    describe '#capacity' do
+      it 'should be zero' do
+        device.capacity.should be_kind_of(Float)
+        device.capacity.should eq(0.0)
+      end
+    end
+
+    describe '#generation' do
+      it 'should be "Unknown"' do
+        device.generation.should be_kind_of(String)
+        device.generation.should eq('Unknown')
+      end
+    end
+
+    describe '#model_name' do
+      it 'should be "Invalid"' do
+        device.model_name.should be_kind_of(String)
+        device.model_name.should eq('Invalid')
+      end
+    end
+
+    describe '#model_number' do
+      it 'should be "Invalid"' do
+        device.model_number.should be_kind_of(String)
+        device.model_number.should eq('Invalid')
+      end
+    end
+
+    %w[photos videos artwork podcasts chapter_images].each do |feature|
+      describe "#supports_#{feature}?" do
+        it 'should be false' do
+          device.send("supports_#{feature}?").should be_false
+        end
+      end
+    end
+  end
+end

data/spec/rbpod/playlist_collection_spec.rb

@@ -0,0 +1,44 @@
+describe RbPod::PlaylistCollection do
+  it_behaves_like RbPod::Collection
+  # Create a temporary database for the test.
+  include_context 'a new database'
+
+  # Use it as a parent to the playlist collection.
+  let (:collection) { RbPod::PlaylistCollection.new(database) }
+
+  describe '#database' do
+    it 'should return the parent database' do
+      collection.database.should eq(database)
+      collection.database.should be_kind_of(RbPod::Database)
+    end
+  end
+
+  describe '#master' do
+    it 'should return a playlist' do
+      collection.master.should be_kind_of(RbPod::Playlist)
+    end
+
+    it 'should be marked as the master playlist' do
+      collection.master.should be_master
+    end
+  end
+
+  describe '#podcast' do
+    context 'on a new database' do
+      it 'should return nil' do
+        collection.podcast.should be_nil
+      end
+    end
+  end
+
+  describe '#include?' do
+    it 'should detect the master playlist' do
+      collection.include?(collection.master).should be_true
+    end
+
+    it 'should not detect a new playlist' do
+      anonymous_playlist = RbPod::Playlist.new()
+      collection.include?(anonymous_playlist).should be_false
+    end
+  end
+end

data/spec/{playlist_spec.rb → rbpod/playlist_spec.rb}

@@ -1,3 +1,3 @@
 describe RbPod::Playlist do
-
+  # Nothing yet.
 end

data/spec/rbpod/track_collection_spec.rb

@@ -0,0 +1,15 @@
+describe RbPod::TrackCollection do
+  it_behaves_like RbPod::Collection
+  # A track collection only requires a playlist, so we don't need a database.
+  let(:playlist) { RbPod::Playlist.new() }
+
+  # Use the new playlist as a parent for this track collection.
+  let(:collection) { described_class.new(playlist) }
+
+  describe '#playlist' do
+    it 'should return the parent playlist' do
+      collection.playlist.should eq(playlist)
+      collection.playlist.should be_kind_of(RbPod::Playlist)
+    end
+  end
+end

data/spec/{track_spec.rb → rbpod/track_spec.rb}

@@ -1,3 +1,3 @@
 describe RbPod::Track do
-
+  # Nothing yet.
 end

data/spec/spec_helper.rb

@@ -2,6 +2,8 @@ require 'rspec'
 require 'rbpod'
 require 'tmpdir'
 
+require 'support/shared_contexts'
+
 RSpec.configure do |config|
   config.color_enabled = true
   config.formatter     = 'documentation'

data/spec/support/shared_contexts.rb

@@ -0,0 +1,18 @@
+shared_context 'a new database' do
+  # Create a temporary folder and initialize a database in it.
+  before(:all) do
+    @directory = within_temporary_directory
+    @database  = RbPod::Database.create!(@directory)
+  end
+
+  # This is a godawful hack, but it's needed to clean up after the tests finish.
+  after(:all) do
+    FileUtils.remove_entry_secure(@directory)
+  end
+
+  # Temporary directory for database.
+  let(:directory) { @directory }
+
+  # The database instance itself.
+  let(:database) { @database }
+end