content_type 2.1.2 → 2.1.3

data/README

@@ -16,6 +16,7 @@ SYNOPSIS
      irb> require 'content_type'
      irb> File.content_type('file.pdf')             #=> "application/pdf"
      irb> File.open('file.doc').content_type        #=> "application/msword"
+     irb> "hi".content_type                         #=> "text/plain"
      irb> ContentType.new('file.jpg').content_type  #=> "image/jpeg"
 
 DESCRIPTION

data/Rakefile

@@ -29,8 +29,8 @@ Jeweler::Tasks.new do |s|
   s.email = 'dsturnbull@me.com'
   s.homepage = 'http://github.com/dsturnbull/content_type'
   s.description =<<-eod
-      Provides ContentType#content_type, File#content_type and
-      File::content_type methods to determine mime type
+      Provides ContentType#content_type, File#content_type, File::content_type
+      and String#content_type methods to determine mime type
   eod
   s.executables = []
   s.authors = ['David Turnbull']

data/ext/content_type.c

@@ -4,19 +4,27 @@
 #include <sys/stat.h>
 #include <stdbool.h>
 
+// see libmagic(3)
 #define MAGIC_OPTIONS MAGIC_SYMLINK | MAGIC_MIME_TYPE | MAGIC_PRESERVE_ATIME
+
+// presume file extensions are at max 16 chars. this is fine for now since
+// only microsoft crap is overridden.
 #define MAX_EXT_LEN 16
 
+// ContentType prototypes
 VALUE content_type = Qnil;
 VALUE content_type_initialize(VALUE self, VALUE path);
 VALUE content_type_content_type(VALUE self);
 
+// File prototypes
 VALUE file_content_type_wrap(VALUE self, VALUE path);
 VALUE file_content_type(VALUE self);
 VALUE file_singleton_content_type(VALUE self, VALUE path);
 
+// String prototypes
 VALUE string_content_type(VALUE self);
 
+// internal prototypes
 bool content_type_file_ext(VALUE self, char *ext);
 void magic_fail(const char *error);
 
@@ -41,6 +49,7 @@ const char *content_type_ext_overrides[][2] = {
 	{ "xltx", "application/vnd.openxmlformats-officedocument.spreadsheetml.template" },
 };
 
+// Init_content_type - initialize the extension
 void
 Init_content_type()
 {
@@ -64,6 +73,8 @@ Init_content_type()
 	rb_define_method(rb_cString, "content_type", string_content_type, 0);
 }
 
+// content_type_initialize - initialize the object and check file path exists
+//
 // iv @content_type, @filepath and @processed are available in all variations
 // because each implementation creates a ContentType obj through here
 // (except String#content_type)
@@ -85,7 +96,7 @@ content_type_initialize(VALUE self, VALUE path)
 	return self;
 }
 
-// content_type_file_ext
+// content_type_file_ext - return the file extension of the file
 bool
 content_type_file_ext(VALUE self, char *ext)
 {
@@ -115,6 +126,7 @@ content_type_file_ext(VALUE self, char *ext)
 	return false;
 }
 
+// content_type_content_type - check for hardcoded extensions or use libmagic
 VALUE
 content_type_content_type(VALUE self)
 {
@@ -125,6 +137,7 @@ content_type_content_type(VALUE self)
 	char				ext[MAX_EXT_LEN];	// TODO dynamicly sized
 	int					i;
 
+	// check for hardcoded extension overrides first
 	if (content_type_file_ext(self, ext))
 		for (i = sizeof(content_type_ext_overrides) / sizeof(char *) / 2 - 1;
 				i >= 0; i--) {
@@ -134,12 +147,14 @@ content_type_content_type(VALUE self)
 
 			if ((memcmp(ext, o_ext, strlen(o_ext))) == 0) {
 				ct = rb_str_new2(o_mime);
+				// memoize
 				rb_iv_set(self, "@content_type", ct);
 				rb_iv_set(self, "@processed", Qtrue);
 				return ct;
 			}
 		}
 
+	// otherwise use libmagic to get the mime type
 	if (rb_iv_get(self, "@processed"))
 		return rb_iv_get(self, "@content_type");
 
@@ -153,6 +168,8 @@ content_type_content_type(VALUE self)
 		magic_fail("file");
 
 	ct = rb_str_new(mime, strlen(mime));
+
+	// memoize
 	rb_iv_set(self, "@content_type", ct);
 	rb_iv_set(self, "@processed", Qtrue);
 	magic_close(mh);
@@ -160,6 +177,7 @@ content_type_content_type(VALUE self)
 	return ct;
 }
 
+// file_content_type_wrap - pass file path into ContentType#content_type
 VALUE
 file_content_type_wrap(VALUE self, VALUE path)
 {
@@ -172,18 +190,21 @@ file_content_type_wrap(VALUE self, VALUE path)
 	return rb_funcall(ct, rb_intern("content_type"), 0);
 }
 
+// file_content_type - provide File#content_type
 VALUE
 file_content_type(VALUE self)
 {
 	return file_content_type_wrap(self, rb_funcall(self, rb_intern("path"), 0));
 }
 
+// file_singleton_content_type - provide File.content_type
 VALUE
 file_singleton_content_type(VALUE self, VALUE path)
 {
 	return file_content_type_wrap(self, path);
 }
 
+// string_content_type - pass the string as a buffer to libmagic
 VALUE
 string_content_type(VALUE self)
 {
@@ -209,6 +230,7 @@ string_content_type(VALUE self)
 	return ct;
 }
 
+// magic_fail - raise exceptions
 void
 magic_fail(const char *error)
 {
@@ -219,3 +241,4 @@ magic_fail(const char *error)
 	sprintf((char *)error_message, format, error);
 	rb_raise(rb_const_get(rb_cObject, rb_intern("RuntimeError")), error_message);
 }
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 2
   - 1
-  - 2
-  version: 2.1.2
+  - 3
+  version: 2.1.3
 platform: ruby
 authors: 
 - David Turnbull
@@ -18,7 +18,7 @@ date: 2010-04-10 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
-description: "      Provides ContentType#content_type, File#content_type and\n      File::content_type methods to determine mime type\n"
+description: "      Provides ContentType#content_type, File#content_type, File::content_type\n      and String#content_type methods to determine mime type\n"
 email: dsturnbull@me.com
 executables: []