rbpod 0.0.4 → 0.0.5

data/README.md

@@ -70,12 +70,12 @@ device['PotsdamConf45'] = "Kilroy Was Here"
 device.save!
 ```
 
-### RbPod::Collection
+### RbPod::PlaylistCollection
 
-All methods that return lists return a `Collection` enumerator decorated depending on it's contents:
+You can get direct access to the playlists on the device:
 
 ```ruby
-database.playlists # => #<RbPod::Collection:0xdeadbeef>
+database.playlists # => #<RbPod::PlaylistCollection:0xdeadbeef>
 
 # For a list of all the names of playlists on the iPod:
 database.playlists.map(&:name) # => ["iPod", "Podcasts", "Recently Added"]
@@ -83,8 +83,8 @@ database.playlists.map(&:name) # => ["iPod", "Podcasts", "Recently Added"]
 # For direct access to the master playlist:
 database.playlists.master # => #<RbPod::Playlist:0xdeadbeef>
 
-# For direct access to the podcasts playlist:
-database.playlists.podcasts # => #<RbPod::Playlist:0xdeadbeef>
+# For direct access to the podcast playlist:
+database.playlists.podcast # => #<RbPod::Playlist:0xdeadbeef>
 ```
 
 ### RbPod::Playlist
@@ -98,11 +98,11 @@ playlist.name       # => "iPod"
 playlist.length     # => 400
 playlist.created_on # => 2008-04-05 08:47:46 -0700
 
-playlist.master_playlist?  # => true
-playlist.smart_playlist?   # => false
-playlist.podcast_playlist? # => false
+playlist.master?  # => true
+playlist.smart?   # => false
+playlist.podcast? # => false
 
-playlist.tracks # => #<RbPod::Collection:0xdeadbeef>
+playlist.tracks # => #<RbPod::TrackCollection:0xdeadbeef>
 ```
 
 ### RbPod::Track

data/Rakefile

@@ -13,8 +13,8 @@ require 'rspec/core/rake_task'
 # Bring in RDoc's built-in rake task.
 require 'rdoc/task'
 
-# By default, clean, compile and then test.
-task :default => [ :compile, :test ]
+# By default, run rspec tests.
+task :default => [ :test ]
 
 # Let Rake know what is safe to remove.
 CLEAN.include [ 'pkg/*', 'doc/*' ]
@@ -27,7 +27,7 @@ Rake::ExtensionTask.new do |extension|
   extension.lib_dir  = 'lib/rbpod'
 
   # Monitor sources for change tracking.
-  extension.source_pattern = '*.{c,h}'
+  extension.source_pattern = '*.[ch]'
 end
 
 desc "Run all available RSpec tests."
@@ -36,6 +36,8 @@ RSpec::Core::RakeTask.new(:test) do |task|
   # Execute ruby with warnings enabled.
   task.ruby_opts = '-w'
 end
+# Make compilation a prerequisite of testing.
+Rake::Task[:test].prerequisites << :compile
 
 desc "Build all RDoc documentation."
 RDoc::Task.new(:rdoc) do |task|

data/ext/rbpod/collection.c

@@ -3,37 +3,28 @@
 #include "rbpod.h"
 #include "collection.h"
 
-struct collection {
-    VALUE klass;
-    GList *list;
-};
-
-inline VALUE rbpod_collection_create(GList *list, VALUE type)
-{
-    struct collection *collection = ALLOC(struct collection);
-    collection->list  = list;
-    collection->klass = type;
-    return Data_Wrap_Struct(cRbPodCollection, NULL, NULL, (void *) collection);
-}
-
 /*
  * call-seq:
  *     [](index) -> Object or nil
  *
- * Return the item located at the given position in the list.
+ * Given an integer +index+, return the item at that position in the collection.
  */
 static VALUE rbpod_collection_get(VALUE self, VALUE key)
 {
-    struct collection *collection = TYPED_DATA_PTR(self, struct collection);
-    GList *current = NULL;
+    GList *current = NULL, *collection = TYPED_DATA_PTR(self, GList);
+    VALUE klass = rb_funcall(self, rb_intern("type"), 0);
 
     if (FIXNUM_P(key) == FALSE) {
         return Qnil;
     }
 
-    current = g_list_nth(collection->list, FIX2INT(key));
+    current = g_list_nth(collection, FIX2INT(key));
 
-    return Data_Wrap_Struct(collection->klass, NULL, NULL, (void *) current->data);
+    if (current == NULL) {
+        return Qnil;
+    }
+
+    return rb_class_new_instance_with_data(0, NULL, klass, current->data);
 }
 
 /*
@@ -44,14 +35,15 @@ static VALUE rbpod_collection_get(VALUE self, VALUE key)
  */
 static VALUE rbpod_collection_last(VALUE self)
 {
-    struct collection *collection = TYPED_DATA_PTR(self, struct collection);
-    GList *current = g_list_last(collection->list);
+    VALUE klass = rb_funcall(self, rb_intern("type"), 0);
+    GList *collection = TYPED_DATA_PTR(self, GList);
+    GList *current = g_list_last(collection);
 
     if (current == NULL) {
         return Qnil;
     }
 
-    return Data_Wrap_Struct(collection->klass, NULL, NULL, (void *) current->data);
+    return rb_class_new_instance_with_data(0, NULL, klass, current->data);
 }
 
 /*
@@ -62,26 +54,27 @@ static VALUE rbpod_collection_last(VALUE self)
  */
 static VALUE rbpod_collection_first(VALUE self)
 {
-    struct collection *collection = TYPED_DATA_PTR(self, struct collection);
-    GList *current = g_list_first(collection->list);
+    VALUE klass = rb_funcall(self, rb_intern("type"), 0);
+    GList *collection = TYPED_DATA_PTR(self, GList);
+    GList *current = g_list_first(collection);
 
     if (current == NULL) {
         return Qnil;
     }
 
-    return Data_Wrap_Struct(collection->klass, NULL, NULL, (void *) current->data);
+    return rb_class_new_instance_with_data(0, NULL, klass, current->data);
 }
 
 /*
  * call-seq:
- *     length() -> Integer
+ *     size() -> Integer
  *
  * Return the total length of all items in the collection.
  */
-static VALUE rbpod_collection_length(VALUE self)
+static VALUE rbpod_collection_size(VALUE self)
 {
-    struct collection *collection = TYPED_DATA_PTR(self, struct collection);
-    return INT2NUM(g_list_length(collection->list));
+    GList *collection = TYPED_DATA_PTR(self, GList);
+    return INT2NUM(g_list_length(collection));
 }
 
 /*
@@ -95,19 +88,25 @@ static VALUE rbpod_collection_length(VALUE self)
  */
 static VALUE rbpod_collection_each(VALUE self, VALUE argv)
 {
-    struct collection *collection = TYPED_DATA_PTR(self, struct collection);
-    VALUE item = Qnil, arguments = rb_ary_dup(argv);
-    GList *current = NULL;
+    GList *current = NULL, *collection = TYPED_DATA_PTR(self, GList);
+    VALUE klass, item, arguments;
 
     /* Return an enumerator if a block was not supplied. */
     RETURN_ENUMERATOR(self, 0, 0);
 
+    /* What sort of items are we casting this data to? */
+    klass = rb_funcall(self, rb_intern("type"), 0);
+
+    /* Create a shallow copy of the passed arguments. */
+    arguments = rb_ary_dup(argv);
+
     /* Prepend an empty element as a placeholder. */
     rb_ary_unshift(arguments, Qnil);
 
     /* If we were supplied a block, enumerate the entire list. */
-    for (current = collection->list; current != NULL; current = current->next) {
-        item = Data_Wrap_Struct(collection->klass, NULL, NULL, (void *) current->data);
+    for (current = collection; current != NULL; current = g_list_next(current)) {
+        /* TODO: Find a better workaround than this or Data_Wrap_Struct. */
+        item = rb_class_new_instance_with_data(0, NULL, klass, current->data);
         rb_ary_store(arguments, 0, item);
         rb_yield_splat(arguments);
     }
@@ -115,24 +114,28 @@ static VALUE rbpod_collection_each(VALUE self, VALUE argv)
     return self;
 }
 
-static void rbpod_collection_deallocate(void *handle)
+/*
+ * :nodoc:
+ */
+static VALUE rbpod_collection_type(VALUE self)
 {
-    struct collection *collection = (struct collection *) handle;
-
-    if (collection->list != NULL) {
-        g_list_free(collection->list);
-    }
-
-    xfree(handle);
-    return;
+    /* We should get an error if we try to create an instance of NilClass. */
+    return Qnil;
 }
 
-static VALUE rbpod_collection_allocate(VALUE self)
+/*
+ * :nodoc:
+ */
+static VALUE rbpod_collection_included(VALUE self, VALUE other)
 {
-    struct collection *collection = ALLOC(struct collection);
-    collection->list = NULL;
-    collection->klass = Qnil;
-    return Data_Wrap_Struct(cRbPodCollection, NULL, rbpod_collection_deallocate, (void *) collection);
+    /* Collections should be Enumerable and Comparable. */
+    rb_include_module(other, rb_mEnumerable);
+    rb_include_module(other, rb_mComparable);
+
+    /* Override Enumerable with our methods. */
+    rb_extend_object(other, self);
+
+    return self;
 }
 
 void Init_rbpod_collection(void)
@@ -140,22 +143,17 @@ void Init_rbpod_collection(void)
 #if RDOC_CAN_PARSE_DOCUMENTATION
     mRbPod = rb_define_module("RbPod");
 #endif
-    cRbPodCollection = rb_define_class_under(mRbPod, "Collection", rb_cObject);
-
-    rb_define_alloc_func(cRbPodCollection, rbpod_collection_allocate);
-
-    rb_include_module(cRbPodCollection, rb_mEnumerable);
-    rb_include_module(cRbPodCollection, rb_mComparable);
+    mRbPodCollection = rb_define_module_under(mRbPod, "Collection");
 
-    rb_define_method(cRbPodCollection, "each", rbpod_collection_each, -2);
+    rb_define_singleton_method(mRbPodCollection, "included", rbpod_collection_included, 1);
 
-    rb_define_method(cRbPodCollection, "length", rbpod_collection_length, 0);
+    rb_define_private_method(mRbPodCollection, "type", rbpod_collection_type, 0);
 
-    rb_define_alias(cRbPodCollection,  "size", "length");
-    rb_define_alias(cRbPodCollection,  "count", "length");
+    rb_define_method(mRbPodCollection, "each", rbpod_collection_each, -2);
+    rb_define_method(mRbPodCollection, "size", rbpod_collection_size, 0);
 
-    rb_define_method(cRbPodCollection, "first", rbpod_collection_first, 0);
-    rb_define_method(cRbPodCollection, "last", rbpod_collection_last, 0);
+    rb_define_method(mRbPodCollection, "first", rbpod_collection_first, 0);
+    rb_define_method(mRbPodCollection, "last", rbpod_collection_last, 0);
 
-    rb_define_method(cRbPodCollection, "[]", rbpod_collection_get, 1);
+    rb_define_method(mRbPodCollection, "[]", rbpod_collection_get, 1);
 }

data/ext/rbpod/collection.h

@@ -3,10 +3,8 @@
 #ifndef RBPOD_COLLECTION_H
 #define RBPOD_COLLECTION_H
 
-RUBY_EXTERN VALUE cRbPodCollection;
+RUBY_EXTERN VALUE mRbPodCollection;
 
 void Init_rbpod_collection(void);
 
-inline VALUE rbpod_collection_create(GList *list, VALUE type);
-
 #endif /* RBPOD_COLLECTION_H */

data/ext/rbpod/database.c

@@ -1,8 +1,10 @@
 /* database.c */
 
 #include "rbpod.h"
+#include "error.h"
 #include "device.h"
 #include "database.h"
+#include "playlist.h"
 #include "track_collection.h"
 #include "playlist_collection.h"
 
@@ -39,22 +41,26 @@ static VALUE rbpod_database_synchronized_p(VALUE self)
 
 /*
  * call-seq:
- *     playlists() -> RbPod::Collection
+ *     playlists() -> RbPod::PlaylistCollection
  *
  * Returns a collection of all playlists added to this database.
  */
 static VALUE rbpod_database_playlists_get(VALUE self)
 {
-    Itdb_iTunesDB *database = TYPED_DATA_PTR(self, Itdb_iTunesDB);
-    return rbpod_playlist_collection_create(self, database->playlists);
+    return rb_class_new_instance(1, &self, cRbPodPlaylistCollection);
 }
 
+/*
+ * call-seq:
+ *     tracks() -> RbPod::TrackCollection
+ *
+ * Returns a collection of all tracks added to this database.
+ */
 static VALUE rbpod_database_tracks_get(VALUE self)
 {
-    Itdb_iTunesDB *database = TYPED_DATA_PTR(self, Itdb_iTunesDB);
-    Itdb_Playlist *playlist = itdb_playlist_mpl(database);
-    VALUE parent = Data_Wrap_Struct(cRbPodPlaylist, NULL, NULL, (void *) playlist);
-    return rbpod_track_collection_create(parent, database->tracks);
+    VALUE playlists = rbpod_database_playlists_get(self);
+    VALUE master = rb_funcall(playlists, rb_intern("master"), 0);
+    return rb_class_new_instance(1, &master, cRbPodTrackCollection);
 }
 
 /*
@@ -93,6 +99,9 @@ static VALUE rbpod_database_version_get(VALUE self)
     return INT2NUM(database->version);
 }
 
+/*
+ * :nodoc:
+ */
 static VALUE rbpod_database_id_get(VALUE self)
 {
     Itdb_iTunesDB *database = TYPED_DATA_PTR(self, Itdb_iTunesDB);
@@ -112,6 +121,9 @@ static VALUE rbpod_database_mountpoint_get(VALUE self)
     return rb_class_new_instance(1, &mount_point, rb_cPathname);
 }
 
+/*
+ * :nodoc:
+ */
 static VALUE rbpod_database_mountpoint_set(VALUE self, VALUE path)
 {
     Itdb_iTunesDB *database = TYPED_DATA_PTR(self, Itdb_iTunesDB);
@@ -137,6 +149,12 @@ static VALUE rbpod_database_initialize(VALUE self, VALUE mount_point)
     Itdb_iTunesDB *previous = database;
     GError *error = NULL;
 
+    /* Check if the mount point is a directory. */
+    if (rb_file_directory_p(rb_cFile, mount_point) != Qtrue) {
+        rb_raise(eRbPodError, "The mount point must be a directory!");
+        return Qnil;
+    }
+
     /* Try to parse the database from the given mount point. */
     database = itdb_parse(StringValueCStr(mount_point), &error);
 
@@ -170,6 +188,7 @@ static VALUE rbpod_database_allocate(VALUE self)
 static VALUE rbpod_database_create(int argc, VALUE *argv, VALUE self)
 {
     gchar *_mount_point, *_device_name, *_model_number;
+    VALUE model_matcher, model_regexp, ignorecase;
     VALUE mount_point, device_name, model_number;
     GError *error = NULL;
 
@@ -185,19 +204,30 @@ static VALUE rbpod_database_create(int argc, VALUE *argv, VALUE self)
     }
 
     /* If we didn't specify a device name, default to 'iPod'. */
-    if (RTEST(device_name) && (TYPE(device_name) != T_STRING || RSTRING_LEN(device_name) < 4)) {
-        rb_raise(eRbPodError, "Device name should be a string of at least three characters.");
-        return Qnil;
-    } else {
+    if (RTEST(device_name) == FALSE) {
         device_name = rb_str_new2("iPod");
     }
 
-    /* If the specified model number is specified but isn't a string, bail now. TODO: Use a regexp, stupid. */
-    if (NIL_P(model_number) == FALSE && (TYPE(model_number) != T_STRING || RSTRING_LEN(model_number) < 4)) {
-        rb_raise(eRbPodError, "Model number should be a string of at least four characters.");
+    /* Ensure it's a valid device name, if it was given. */
+    if (TYPE(device_name) == T_STRING && RSTRING_LEN(device_name) == 0) {
+        rb_raise(eRbPodError, "Device name must not be an empty string.");
         return Qnil;
     }
 
+    /* If a model number was given, ensure it's a string. */
+    if (RTEST(model_number)) {
+        Check_Type(device_name, T_STRING);
+
+        model_matcher = rb_str_new2("/x?[A-Z][0-9]{3}/");
+        ignorecase = rb_const_get(rb_cRegexp, rb_intern("IGNORECASE"));
+        model_regexp = rb_reg_new_str(model_matcher, ignorecase);
+
+        if (RTEST(rb_reg_match(model_regexp, model_number)) == FALSE) {
+            rb_raise(eRbPodError, "Model number must be a string matching: /x?[A-Z][0-9]{3}/i");
+            return Qnil;
+        }
+    }
+
     /* Extract pointers for glib use. */
     _mount_point  = StringValueCStr(mount_point);
     _device_name  = StringValueCStr(device_name);
@@ -228,7 +258,6 @@ void Init_rbpod_database(void)
     rb_define_singleton_method(cRbPodDatabase, "create!", rbpod_database_create, -1);
 
     rb_define_private_method(cRbPodDatabase, "id", rbpod_database_id_get, 0);
-    rb_define_private_method(cRbPodDatabase, "tracks", rbpod_database_tracks_get, 0);
     rb_define_private_method(cRbPodDatabase, "mountpoint=", rbpod_database_mountpoint_set, 1);
 
     rb_define_method(cRbPodDatabase, "mountpoint", rbpod_database_mountpoint_get, 0);
@@ -237,6 +266,8 @@ void Init_rbpod_database(void)
     rb_define_method(cRbPodDatabase, "filename", rbpod_database_filename_get, 0);
 
     rb_define_method(cRbPodDatabase, "device", rbpod_database_device_get, 0);
+
+    rb_define_method(cRbPodDatabase, "tracks", rbpod_database_tracks_get, 0);
     rb_define_method(cRbPodDatabase, "playlists", rbpod_database_playlists_get, 0);
 
     rb_define_method(cRbPodDatabase, "synchronized?", rbpod_database_synchronized_p, 0);

data/ext/rbpod/device.c

@@ -1,6 +1,7 @@
 /* device.c */
 
 #include "rbpod.h"
+#include "error.h"
 #include "device.h"
 #include "database.h"
 
@@ -197,7 +198,7 @@ static VALUE rbpod_device_initialize(VALUE self, VALUE database)
     Itdb_iTunesDB *_database = TYPED_DATA_PTR(database, Itdb_iTunesDB);
 
     /* Make sure we were given an instance of a RbPod::Database. */
-    if (rb_class_of(database) != cRbPodDatabase) {
+    if (rb_obj_is_instance_of(database, cRbPodDatabase) == FALSE) {
         rb_raise(eRbPodError, "Given database must be an instance of RbPod::Database: %s", StringValueCStr(database));
         return Qnil;
     }

data/ext/rbpod/error.c

@@ -0,0 +1,27 @@
+/* error.c */
+
+#include "rbpod.h"
+#include "error.h"
+
+inline VALUE rbpod_raise_error(GError *error)
+{
+    VALUE error_message;
+
+    if (error != NULL) {
+        error_message = rb_str_new2(error->message);
+        g_error_free(error);
+        rb_raise(eRbPodError, "%s", StringValueCStr(error_message));
+    }
+
+    return Qnil;
+}
+
+void Init_rbpod_error(void)
+{
+#if RDOC_CAN_PARSE_DOCUMENTATION
+    mRbPod = rb_define_module("RbPod");
+#endif
+    /* This is a generic subclass of RuntimeError for RbPod-specific errors.*/
+    eRbPodError = rb_define_class_under(mRbPod, "Error", rb_eRuntimeError);
+}
+

data/ext/rbpod/error.h

@@ -0,0 +1,12 @@
+/* error.h */
+
+#ifndef RBPOD_ERROR_H
+#define RBPOD_ERROR_H
+
+RUBY_EXTERN VALUE eRbPodError;
+
+void Init_rbpod_error(void);
+
+inline VALUE rbpod_raise_error(GError *error);
+
+#endif /* RBPOD_ERROR_H */

data/ext/rbpod/playlist.c

@@ -6,7 +6,7 @@
 
 /*
  * call-seq:
- *     is_podcast_playlist?() -> Boolean
+ *     podcast?() -> Boolean
  *
  * Returns true or false if this playlist is the podcast-only playlist.
  */
@@ -18,7 +18,7 @@ static VALUE rbpod_playlist_podcast_p(VALUE self)
 
 /*
  * call-seq:
- *     is_master_playlist?() -> Boolean
+ *     master?() -> Boolean
  *
  * Returns true or false if this playlist is the master playlist.
  */
@@ -30,7 +30,7 @@ static VALUE rbpod_playlist_master_p(VALUE self)
 
 /*
  * call-seq:
- *     is_smart_playlist?() -> Boolean
+ *     smart?() -> Boolean
  *
  * Returns true or false if this playlist is a smart playlist.
  */
@@ -74,8 +74,7 @@ static VALUE rbpod_playlist_shuffle_bang(VALUE self)
  */
 static VALUE rbpod_playlist_tracks_get(VALUE self)
 {
-    Itdb_Playlist *playlist = TYPED_DATA_PTR(self, Itdb_Playlist);
-    return rbpod_track_collection_create(self, playlist->members);
+    return rb_class_new_instance(1, &self, cRbPodTrackCollection);
 }
 
 /*
@@ -137,21 +136,13 @@ static VALUE rbpod_playlist_id_get(VALUE self)
 
 /*
  * call-seq:
- *     initialize(name, is_smart_playlist) -> RbPod::Playlist
+ *     initialize() -> RbPod::Playlist
  *
  * Creates a detached playlist. (Not managed by the database.)
  */
-static VALUE rbpod_playlist_initialize(VALUE self, VALUE playlist_name, VALUE smart_playlist)
+static VALUE rbpod_playlist_initialize(VALUE self)
 {
-    Itdb_Playlist *playlist = TYPED_DATA_PTR(self, Itdb_Playlist);
-    gchar *_playlist_name = StringValueCStr(playlist_name);
-
-    itdb_playlist_free(playlist);
-
-    playlist = itdb_playlist_new(_playlist_name, (smart_playlist == Qtrue) ? TRUE : FALSE);
-
-    DATA_PTR(self) = playlist;
-
+    /* Nothing to see here. */
     return self;
 }
 
@@ -160,7 +151,7 @@ static void rbpod_playlist_deallocate(void *handle)
     Itdb_Playlist *playlist = (Itdb_Playlist *) handle;
 
     /* This playlist was unmanaged, so free it manually. */
-    if (playlist->itdb == NULL || playlist->id == 0) {
+    if (playlist->itdb == NULL) {
         itdb_playlist_free(playlist);
     }
 
@@ -169,7 +160,7 @@ static void rbpod_playlist_deallocate(void *handle)
 
 static VALUE rbpod_playlist_allocate(VALUE self)
 {
-    Itdb_Playlist *playlist = itdb_playlist_new("KILROY WAS HERE", FALSE);
+    Itdb_Playlist *playlist = itdb_playlist_new("New Playlist", FALSE);
     return Data_Wrap_Struct(cRbPodPlaylist, NULL, rbpod_playlist_deallocate, (void *) playlist);
 }
 
@@ -182,7 +173,7 @@ void Init_rbpod_playlist(void)
 
     rb_define_alloc_func(cRbPodPlaylist, rbpod_playlist_allocate);
 
-    rb_define_method(cRbPodPlaylist, "initialize", rbpod_playlist_initialize, 2);
+    rb_define_method(cRbPodPlaylist, "initialize", rbpod_playlist_initialize, 0);
 
     rb_define_private_method(cRbPodPlaylist, "id", rbpod_playlist_id_get, 0);
 
@@ -194,11 +185,12 @@ void Init_rbpod_playlist(void)
     rb_define_method(cRbPodPlaylist, "shuffle!", rbpod_playlist_shuffle_bang, 0);
     rb_define_method(cRbPodPlaylist, "timestamp", rbpod_playlist_timestamp_get, 0);
 
+    /* :nodoc */
     rb_define_alias(cRbPodPlaylist, "created_on", "timestamp");
 
-    rb_define_method(cRbPodPlaylist, "is_smart_playlist?", rbpod_playlist_smart_p, 0);
-    rb_define_method(cRbPodPlaylist, "is_master_playlist?", rbpod_playlist_master_p, 0);
-    rb_define_method(cRbPodPlaylist, "is_podcast_playlist?", rbpod_playlist_podcast_p, 0);
+    rb_define_method(cRbPodPlaylist, "smart?", rbpod_playlist_smart_p, 0);
+    rb_define_method(cRbPodPlaylist, "master?", rbpod_playlist_master_p, 0);
+    rb_define_method(cRbPodPlaylist, "podcast?", rbpod_playlist_podcast_p, 0);
 
     return;
 }