exiv2 0.0.5 → 0.0.6

data/README.rdoc

@@ -1,6 +1,6 @@
 = Exiv2
 
-A simple wrapper around the C++ Exiv2 libary for reading image metadata.
+A simple wrapper around the C++ Exiv2 libary for reading and writing image metadata.
 
 See http://www.exiv2.org/
 
@@ -21,10 +21,18 @@ Requires that the exiv2 C++ library is installed.
 
     iptc_data_hash  = image.iptc_data.to_hash
     xmp_data_hash   = image.xmp_data.to_hash
+    
+    image.exif_data.delete("Exif.Image.Software")
+    image.iptc_data.delete_all("Iptc.Application2.Keywords")
+    
+    image.iptc_data["Iptc.Application2.Caption"] = "A New Caption"
+    image.iptc_data.add("Iptc.Application2.Keywords", "fishy")
+    
+    image.write_metadata
 
 == Why?
 
-None of the existing Ruby libraries for reading image metadata did quite what
+None of the existing Ruby libraries for reading and writing image metadata did quite what
 we wanted, so we figured it wouldn't be too hard to wrap enough of Exiv2 to
 meet our needs.
 
@@ -34,7 +42,7 @@ are welcome.
 
 == Compatibility
 
-Tested with Ruby 1.8.7 and Exiv2 0.21.
+Tested with Ruby 1.8.7 and 1.9.3, and Exiv2 0.20 and 0.21
 
 == Developing
  
@@ -51,6 +59,10 @@ Tested with Ruby 1.8.7 and Exiv2 0.21.
 In early development. Very little of Exiv2's API is supported, and it hasn't
 been heavily tested.
 
+== Contributors
+
+Pete Yandell, Mark Turnley, Lucas Parry, Norbert Wojtwoicz, Jan Graichen, John Barton
+
 == Copyright
 
 Copyright (c) 2010 Envato & Pete Yandell. See LICENSE for details.

data/Rakefile

@@ -5,8 +5,12 @@ task :default => :spec
 require 'rake/extensiontask'
 Rake::ExtensionTask.new('exiv2') do |ext|
   ext.lib_dir = "lib/exiv2"
+  if ENV['EXIV2_DIR']
+    ext.config_options << "--with-exiv2-dir=#{ENV['EXIV2_DIR']}"
+  end
 end
 Rake::Task[:spec].prerequisites << :compile
 
 require 'bundler'
 Bundler::GemHelper.install_tasks
+

data/ext/exiv2/exiv2.cpp

@@ -9,7 +9,7 @@ static VALUE to_ruby_string(const std::string& string) {
 // Create a C++ std::string from a Ruby string.
 static std::string to_std_string(VALUE string) {
   string = StringValue(string); // Convert the Ruby object to a string if it isn't one.
-  return std::string(RSTRING(string)->ptr, RSTRING(string)->len);
+  return std::string(RSTRING_PTR(string), RSTRING_LEN(string));
 }
 
 // Shared method for implementing each on XmpData, IptcData and ExifData.
@@ -38,6 +38,7 @@ extern "C" {
   static VALUE image_class;
   static void image_free(Exiv2::Image* image);
   static VALUE image_read_metadata(VALUE self);
+  static VALUE image_write_metadata(VALUE self);
   static VALUE image_iptc_data(VALUE self);
   static VALUE image_xmp_data(VALUE self);
   static VALUE image_exif_data(VALUE self);
@@ -47,12 +48,18 @@ extern "C" {
 
   static VALUE exif_data_class;
   static VALUE exif_data_each(VALUE self);
+  static VALUE exif_data_add(VALUE self, VALUE key, VALUE value);
+  static VALUE exif_data_delete(VALUE self, VALUE key);
 
   static VALUE iptc_data_class;
   static VALUE iptc_data_each(VALUE self);
+  static VALUE iptc_data_add(VALUE self, VALUE key, VALUE value);
+  static VALUE iptc_data_delete(VALUE self, VALUE key);
 
   static VALUE xmp_data_class;
   static VALUE xmp_data_each(VALUE self);
+  static VALUE xmp_data_add(VALUE self, VALUE key, VALUE value);
+  static VALUE xmp_data_delete(VALUE self, VALUE key);
 
   void Init_exiv2() {
     VALUE enumerable_module = rb_const_get(rb_cObject, rb_intern("Enumerable"));
@@ -63,6 +70,7 @@ extern "C" {
 
     image_class = rb_define_class_under(exiv2_module, "Image", rb_cObject);
     rb_define_method(image_class, "read_metadata", (Method)image_read_metadata, 0);
+    rb_define_method(image_class, "write_metadata", (Method)image_write_metadata, 0);
     rb_define_method(image_class, "iptc_data", (Method)image_iptc_data, 0);
     rb_define_method(image_class, "xmp_data", (Method)image_xmp_data, 0);
     rb_define_method(image_class, "exif_data", (Method)image_exif_data, 0);
@@ -73,14 +81,20 @@ extern "C" {
     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);
+    rb_define_method(exif_data_class, "add", (Method)exif_data_add, 2);
+    rb_define_method(exif_data_class, "delete", (Method)exif_data_delete, 1);
 
     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);
+    rb_define_method(iptc_data_class, "add", (Method)iptc_data_add, 2);
+    rb_define_method(iptc_data_class, "delete", (Method)iptc_data_delete, 1);
     
     xmp_data_class = rb_define_class_under(exiv2_module, "XmpData", rb_cObject);
     rb_include_module(xmp_data_class, enumerable_module);
     rb_define_method(xmp_data_class, "each", (Method)xmp_data_each, 0);
+    rb_define_method(xmp_data_class, "add", (Method)xmp_data_add, 2);
+    rb_define_method(xmp_data_class, "delete", (Method)xmp_data_delete, 1);
   }
 
   
@@ -103,6 +117,20 @@ extern "C" {
 
     return Qnil;
   }
+  
+  static VALUE image_write_metadata(VALUE self) {
+    Exiv2::Image* image;
+    Data_Get_Struct(self, Exiv2::Image, image);
+
+    try {
+      image->writeMetadata();
+    }
+    catch (Exiv2::BasicError<char> error) {
+      rb_raise(basic_error_class, "%s", error.what());
+    }
+
+    return Qnil;
+  }
 
   static VALUE image_exif_data(VALUE self) {
     Exiv2::Image* image;
@@ -157,16 +185,103 @@ extern "C" {
     return metadata_each<Exiv2::ExifData>(self);
   }
   
+  static VALUE exif_data_add(VALUE self, VALUE key, VALUE value) {
+    Exiv2::ExifData* data;
+    Data_Get_Struct(self, Exiv2::ExifData, data);
+    
+    Exiv2::ExifKey exifKey = Exiv2::ExifKey(to_std_string(key));
+    
+#if EXIV2_MAJOR_VERSION <= 0 && EXIV2_MINOR_VERSION <= 20
+    Exiv2::TypeId typeId = Exiv2::ExifTags::tagType(exifKey.tag(), exifKey.ifdId());
+#else
+    Exiv2::TypeId typeId = exifKey.defaultTypeId();
+#endif
+    
+    Exiv2::Value::AutoPtr v = Exiv2::Value::create(typeId);
+    v->read(to_std_string(value));
+    
+    data->add(exifKey, v.get());
+    return Qtrue;
+  }
+  
+  static VALUE exif_data_delete(VALUE self, VALUE key) {
+    Exiv2::ExifData* data;
+    Data_Get_Struct(self, Exiv2::ExifData, data);
+    
+    Exiv2::ExifKey exifKey = Exiv2::ExifKey(to_std_string(key));
+    Exiv2::ExifData::iterator pos = data->findKey(exifKey);
+    if(pos == data->end()) return Qfalse;
+    data->erase(pos);
+    
+    return Qtrue;
+  }
+  
 
   // Exiv2::IptcData methods
   
   static VALUE iptc_data_each(VALUE self) {
     return metadata_each<Exiv2::IptcData>(self);
   }
+  
+  static VALUE iptc_data_add(VALUE self, VALUE key, VALUE value) {
+    Exiv2::IptcData* data;
+    Data_Get_Struct(self, Exiv2::IptcData, data);
+    
+    Exiv2::IptcKey iptcKey  = Exiv2::IptcKey(to_std_string(key));
+    Exiv2::TypeId typeId    = Exiv2::IptcDataSets::dataSetType(iptcKey.tag(), iptcKey.record());
+    
+    Exiv2::Value::AutoPtr v = Exiv2::Value::create(typeId);
+    v->read(to_std_string(value));
+    
+    if(data->add(iptcKey, v.get())) {
+      return Qfalse;
+    }
+    return Qtrue;
+  }
+  
+  static VALUE iptc_data_delete(VALUE self, VALUE key) {
+    Exiv2::IptcData* data;
+    Data_Get_Struct(self, Exiv2::IptcData, data);
+    
+    Exiv2::IptcKey iptcKey = Exiv2::IptcKey(to_std_string(key));
+    Exiv2::IptcData::iterator pos = data->findKey(iptcKey);
+    if(pos == data->end()) return Qfalse;
+    data->erase(pos);
+    
+    return Qtrue;
+  }
  
   // Exiv2::XmpData methods
   
   static VALUE xmp_data_each(VALUE self) {
     return metadata_each<Exiv2::XmpData>(self);
-  } 
+  }
+  
+  static VALUE xmp_data_add(VALUE self, VALUE key, VALUE value) {
+    Exiv2::XmpData* data;
+    Data_Get_Struct(self, Exiv2::XmpData, data);
+    
+    Exiv2::XmpKey xmpKey = Exiv2::XmpKey(to_std_string(key));
+    Exiv2::TypeId typeId = Exiv2::XmpProperties::propertyType(xmpKey);
+    
+    Exiv2::Value::AutoPtr v = Exiv2::Value::create(typeId);
+    v->read(to_std_string(value));
+    
+    if(data->add(xmpKey, v.get())) {
+      return Qfalse;
+    }
+    return Qtrue;
+  }
+  
+  static VALUE xmp_data_delete(VALUE self, VALUE key) {
+    Exiv2::XmpData* data;
+    Data_Get_Struct(self, Exiv2::XmpData, data);
+    
+    Exiv2::XmpKey xmpKey = Exiv2::XmpKey(to_std_string(key));
+    Exiv2::XmpData::iterator pos = data->findKey(xmpKey);
+    if(pos == data->end()) return Qfalse;
+    data->erase(pos);
+    
+    return Qtrue;
+  }
 }

data/lib/exiv2/shared_methods.rb

@@ -17,6 +17,32 @@ module SharedMethods
   end
 
   def inspect
-    "#<#{self.class.name}: #{self.to_hash.inspect}>"
+    items = []
+    self.to_hash.sort.each do |k,v|
+      items << %Q["#{k}"=>#{v.inspect}]
+    end
+    "#<#{self.class.name}: {#{items.join(', ')}}>"
+  end
+  
+  def [](key) 
+    self.to_hash[key]
+  end
+  
+  def []=(key, value)
+    delete_all(key)
+    if value.is_a?(Array)
+      value.each do |v|
+        self.add(key, v)
+      end
+    else
+      self.add(key, value)
+    end
+  end
+  
+  def delete_all(key)
+    del = true
+    while(del) do
+      del = self.delete(key)
+    end 
   end
 end

data/lib/exiv2/version.rb

@@ -1,3 +1,3 @@
 module Exiv2
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/exiv2_spec.rb

@@ -1,9 +1,10 @@
 require 'exiv2'
+require 'fileutils'
 
 describe Exiv2 do
 
   it "should handle a Pathname being passed to open" do
-    image = Exiv2::ImageFactory.open(Pathname.new("spec/files/test.jpg"))
+    image = Exiv2::ImageFactory.open(Pathname.new("spec/files/test.jpg").to_s)
     image.read_metadata
     image.iptc_data.to_hash.should_not be_empty
   end
@@ -14,6 +15,20 @@ describe Exiv2 do
     }.should raise_error(Exiv2::BasicError)
   end
 
+  it "should write metadata" do
+    FileUtils.cp("spec/files/test.jpg", "spec/files/test_tmp.jpg")
+    image = Exiv2::ImageFactory.open("spec/files/test_tmp.jpg")
+    image.read_metadata
+    image.iptc_data["Iptc.Application2.Caption"] = "A New Caption"
+    image.write_metadata
+    image = nil
+    
+    image2 = Exiv2::ImageFactory.open("spec/files/test_tmp.jpg")
+    image2.read_metadata
+    image2.iptc_data["Iptc.Application2.Caption"].should == "A New Caption"
+    FileUtils.rm("spec/files/test_tmp.jpg")
+  end
+  
   let(:image) do
     image = Exiv2::ImageFactory.open("spec/files/test.jpg")
     image.read_metadata
@@ -43,6 +58,36 @@ describe Exiv2 do
         "Iptc.Application2.Keywords" => ["fish", "custard"]
       }
     end
+    
+    it "should write IPTC data" do
+      @iptc_data.add("Iptc.Application2.Keywords", "fishy")
+      @iptc_data.to_a.should == [
+        ["Iptc.Application2.Caption", "Rhubarb rhubarb rhubard"],
+        ["Iptc.Application2.Keywords", "fish"],
+        ["Iptc.Application2.Keywords", "custard"],
+        ["Iptc.Application2.Keywords", "fishy"]
+      ]
+    end
+    
+    it "should set IPTC data" do
+      @iptc_data["Iptc.Application2.Caption"] = "A New Caption"
+      @iptc_data.to_hash["Iptc.Application2.Caption"].should == "A New Caption"
+    end
+    
+    it "should set multiply IPTC data values" do
+      @iptc_data["Iptc.Application2.Keywords"] = ["abc", "cde"]
+      @iptc_data.to_hash["Iptc.Application2.Keywords"].should == ["abc", "cde"]
+    end
+    
+    it "should delete one value of IPTC data" do
+      @iptc_data.delete("Iptc.Application2.Keywords")
+      @iptc_data.to_hash["Iptc.Application2.Keywords"].should == "custard"
+    end
+    
+    it "should delete all values of IPTC data" do
+      @iptc_data.delete_all("Iptc.Application2.Keywords")
+      @iptc_data.to_hash["Iptc.Application2.Keywords"].should == nil
+    end
   end
 
   context "XMP data" do
@@ -68,6 +113,31 @@ describe Exiv2 do
       }
     end
 
+    it "should write XMP data" do
+      @xmp_data["Xmp.dc.title"] = "lang=\"x-default\" Changed!"
+      @xmp_data.to_hash["Xmp.dc.title"].should == "lang=\"x-default\" Changed!"
+    end
+    
+    it "should set XMP data" do
+      @xmp_data["Xmp.dc.title"] = "A New Title"
+      @xmp_data.to_hash["Xmp.dc.title"].should == "lang=\"x-default\" A New Title"
+    end
+    
+    it "should set multiply XMP data values" do
+      @xmp_data["Xmp.dc.title"] = ["abc", "cde"]
+      @xmp_data.to_hash["Xmp.dc.title"].should == ["lang=\"x-default\" abc", "lang=\"x-default\" cde"]
+    end
+    
+    it "should delete one value of XMP data" do
+      @xmp_data["Xmp.dc.title"] = ["abc", "cde"]
+      @xmp_data.delete("Xmp.dc.title")
+      @xmp_data.to_hash["Xmp.dc.title"].should == "lang=\"x-default\" cde"
+    end
+    
+    it "should delete all values of XMP data" do
+      @xmp_data.delete_all("Xmp.dc.title")
+      @xmp_data.to_hash["Xmp.dc.title"].should == nil
+    end
   end
 
   context "EXIF data" do
@@ -77,7 +147,7 @@ describe Exiv2 do
 
     it "should read Exif data" do
       @exif_data.should be_a(Exiv2::ExifData)
-      @exif_data.inspect.should == "#<Exiv2::ExifData: {\"Exif.Photo.PixelXDimension\"=>\"32\", \"Exif.Photo.ExifVersion\"=>\"48 50 49 48\", \"Exif.Image.Software\"=>\"plasq skitch\", \"Exif.Photo.PixelYDimension\"=>\"32\", \"Exif.Image.ExifTag\"=>\"52\"}>"
+      @exif_data.inspect.should == '#<Exiv2::ExifData: {"Exif.Image.ExifTag"=>"52", "Exif.Image.Software"=>"plasq skitch", "Exif.Photo.ExifVersion"=>"48 50 49 48", "Exif.Photo.PixelXDimension"=>"32", "Exif.Photo.PixelYDimension"=>"32"}>'
       @exif_data.to_a.should == [
         ["Exif.Image.Software",         "plasq skitch"],
         ["Exif.Image.ExifTag",          "52"],
@@ -99,5 +169,36 @@ describe Exiv2 do
       }
     end
 
+    it "should write Exif data" do
+      @exif_data.add("Exif.Image.Software", "ruby-exiv2")
+      @exif_data.to_hash.should == {
+        "Exif.Photo.PixelXDimension" => "32",
+        "Exif.Photo.ExifVersion"     => "48 50 49 48",
+        "Exif.Image.Software"        => ["plasq skitch", "ruby-exiv2"],
+        "Exif.Photo.PixelYDimension" => "32",
+        "Exif.Image.ExifTag"         => "52"
+      }
+    end
+    
+    it "should set Exif data" do
+      @exif_data["Exif.Image.Software"] = "ruby-exiv2"
+      @exif_data.to_hash["Exif.Image.Software"].should == "ruby-exiv2"
+    end
+    
+    it "should set multiply Exif data values" do
+      @exif_data["Exif.Image.Software"] = ["ruby-exiv2", "plasq skitch"]
+      @exif_data.to_hash["Exif.Image.Software"].should == ["ruby-exiv2", "plasq skitch"]
+    end
+    
+    it "should delete one value of Exif data" do
+      @exif_data["Exif.Image.Software"] = ["ruby-exiv2", "plasq skitch"]
+      @exif_data.delete("Exif.Image.Software")
+      @exif_data.to_hash["Exif.Image.Software"].should == "plasq skitch"
+    end
+    
+    it "should delete all values of Exif data" do
+      @exif_data.delete_all("Exif.Image.Software")
+      @exif_data.to_hash["Exif.Image.Software"].should == nil
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: exiv2
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Pete Yandell
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-23 00:00:00 +10:00
+date: 2011-11-11 00:00:00 +11:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency