exiv2 0.0.1 → 0.0.2

data/README.rdoc

@@ -4,6 +4,8 @@ A simple wrapper around the C++ Exiv2 libary for reading image metadata.
 
 See http://www.exiv2.org/
 
+Requires that the exiv2 C++ library is installed.
+
 == Usage
 
     gem install exiv2
@@ -11,8 +13,10 @@ See http://www.exiv2.org/
     require 'exiv2'
     image = Exiv2::ImageFactory.open("image.jpg")
     image.read_metadata
-    puts image.exif_data.inspect
-    puts image.iptc_data.inspect
+    image.iptc_data.each do |key, value|
+      puts "#{key} = #{value}\n"
+    end
+    image.exif_data.each { ... }
 
 == Why?
 

data/ext/exiv2/exiv2.cpp

@@ -11,20 +11,22 @@ static std::string to_std_string(VALUE string) {
   return std::string(RSTRING(string)->ptr, RSTRING(string)->len);
 }
 
-// Extract data from an Exiv2::IptcData or an Exiv2::ExifData into a Ruby hash.
+// Shared method for implementing each on IptcData and ExifData.
 template <class T>
-static VALUE data_to_hash(T& data) {
-  VALUE hash = rb_hash_new();
+static VALUE metadata_each(VALUE self) {
+  T* data;
+  Data_Get_Struct(self, T, data);
 
-  for(typename T::iterator i = data.begin(); i != data.end(); i++) {
+  for(typename T::iterator i = data->begin(); i != data->end(); i++) {
     VALUE key   = to_ruby_string(i->key());
     VALUE value = to_ruby_string(i->value().toString());
-    rb_hash_aset(hash, key, value);
+    rb_yield(rb_ary_new3(2, key, value));
   }
 
-  return hash;
+  return Qnil;
 }
 
+
 extern "C" {
   typedef VALUE (*Method)(...);
 
@@ -41,8 +43,16 @@ extern "C" {
   static VALUE image_factory_class;
   static VALUE image_factory_open(VALUE klass, VALUE path);
 
+  static VALUE exif_data_class;
+  static VALUE exif_data_each(VALUE self);
+
+  static VALUE iptc_data_class;
+  static VALUE iptc_data_each(VALUE self);
+
 
   void Init_exiv2() {
+    VALUE enumerable_module = rb_const_get(rb_cObject, rb_intern("Enumerable"));
+
     exiv2_module = rb_define_module("Exiv2");
 
     basic_error_class = rb_define_class_under(exiv2_module, "BasicError", rb_eRuntimeError);
@@ -54,6 +64,14 @@ extern "C" {
 
     image_factory_class = rb_define_class_under(exiv2_module, "ImageFactory", rb_cObject);
     rb_define_singleton_method(image_factory_class, "open", (Method)image_factory_open, 1);
+
+    exif_data_class = rb_define_class_under(exiv2_module, "ExifData", rb_cObject);
+    rb_include_module(exif_data_class, enumerable_module);
+    rb_define_method(exif_data_class, "each", (Method)exif_data_each, 0);
+
+    iptc_data_class = rb_define_class_under(exiv2_module, "IptcData", rb_cObject);
+    rb_include_module(iptc_data_class, enumerable_module);
+    rb_define_method(iptc_data_class, "each", (Method)iptc_data_each, 0);
   }
 
   
@@ -81,14 +99,20 @@ extern "C" {
     Exiv2::Image* image;
     Data_Get_Struct(self, Exiv2::Image, image);
 
-    return data_to_hash<Exiv2::ExifData>(image->exifData());
+    VALUE exif_data = Data_Wrap_Struct(exif_data_class, 0, 0, &image->exifData());
+    rb_iv_set(exif_data, "@image", self);  // Make sure we don't GC the image until there are no references to the EXIF data left.
+
+    return exif_data;
   }
 
   static VALUE image_iptc_data(VALUE self) {
     Exiv2::Image* image;
     Data_Get_Struct(self, Exiv2::Image, image);
 
-    return data_to_hash<Exiv2::IptcData>(image->iptcData());
+    VALUE iptc_data = Data_Wrap_Struct(iptc_data_class, 0, 0, &image->iptcData());
+    rb_iv_set(iptc_data, "@image", self);  // Make sure we don't GC the image until there are no references to the IPTC data left.
+
+    return iptc_data;
   }
 
 
@@ -108,4 +132,18 @@ extern "C" {
     return Data_Wrap_Struct(image_class, 0, image_free, image);
   }
 
+
+  // Exiv2::ExifData methods
+
+  static VALUE exif_data_each(VALUE self) {
+    return metadata_each<Exiv2::ExifData>(self);
+  }
+  
+
+  // Exiv2::IptcData methods
+  
+  static VALUE iptc_data_each(VALUE self) {
+    return metadata_each<Exiv2::IptcData>(self);
+  }
+  
 }

data/lib/exiv2.rb

@@ -1 +1,2 @@
 require 'exiv2/exiv2'
+require 'exiv2/iptc_data'

data/lib/exiv2/iptc_data.rb

@@ -0,0 +1,22 @@
+class Exiv2::IptcData
+  def to_hash
+    result = {}
+
+    self.each do |key, value|
+      if result[key]
+        if result[key].is_a? Array
+          result[key] << value
+        else
+          result[key] = [result[key], value]
+        end
+      else
+        result[key] = value
+      end
+    end
+    result
+  end
+
+  def inspect
+    "#<Exiv2::IptcData: #{self.to_hash.inspect}>"
+  end
+end

data/lib/exiv2/version.rb

@@ -1,3 +1,3 @@
 module Exiv2
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/exiv2_spec.rb

@@ -4,8 +4,24 @@ describe Exiv2 do
   it "should read IPTC data" do
     image = Exiv2::ImageFactory.open("spec/files/test.jpg")
     image.read_metadata
-    image.iptc_data.should == {
-      "Iptc.Application2.Caption" => "Rhubarb rhubarb rhubard"
+    iptc_data = image.iptc_data
+    iptc_data.should be_a(Exiv2::IptcData)
+    iptc_data.inspect.should == '#<Exiv2::IptcData: {"Iptc.Application2.Caption"=>"Rhubarb rhubarb rhubard", "Iptc.Application2.Keywords"=>["fish", "custard"]}>'
+    iptc_data.to_a.should == [
+      ["Iptc.Application2.Caption", "Rhubarb rhubarb rhubard"],
+      ["Iptc.Application2.Keywords", "fish"],
+      ["Iptc.Application2.Keywords", "custard"]
+    ]
+  end
+
+  it "should convert iptc data into a hash" do
+    image = Exiv2::ImageFactory.open("spec/files/test.jpg")
+    image.read_metadata
+    iptc_hash = image.iptc_data.to_hash
+    iptc_hash.should be_a(Hash)
+    iptc_hash.should == {
+      "Iptc.Application2.Caption" => "Rhubarb rhubarb rhubard",
+      "Iptc.Application2.Keywords" => ["fish", "custard"]
     }
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: exiv2
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Pete Yandell
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-24 00:00:00 +11:00
+date: 2011-01-27 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,6 +66,7 @@ files:
 - ext/exiv2/exiv2.cpp
 - ext/exiv2/extconf.rb
 - lib/exiv2.rb
+- lib/exiv2/iptc_data.rb
 - lib/exiv2/version.rb
 - spec/exiv2_spec.rb
 - spec/files/test.jpg