julik-depix 1.0.5 → 1.0.6

data/DPX_HEADER_STRUCTURE.txt

@@ -18,7 +18,7 @@ DPX metadata gets returned as a Depix::DPX object with nested properties.
   * <tt>filename</tt> (String) Original filename
   * <tt>timestamp</tt> (String) Creation timestamp
   * <tt>creator</tt> (String) Creator application
-  * <tt>roject</tt> (String) Project name
+  * <tt>project</tt> (String) Project name
   * <tt>copyright</tt> (String) Copyright
   * <tt>encrypt_key</tt> Encryption key
   * <tt>reserve</tt> (String)

data/History.txt

@@ -1,3 +1,9 @@
+=== 1.0.7 / 2009-05-21
+
+* Do not bail out on headers newer than V1.0
+* Allow access to headers directly in Depix::Editor
+* Fix project field name
+
 === 1.0.5 / 2009-01-18
 
 * Switch project to guerilla-di

data/README.txt

@@ -1,6 +1,6 @@
 = depix
 
-* http://wiretap.rubyforge.org/depix
+* http://guerilla-di.rubyforge.org/depix
 
 == DESCRIPTION:
 

data/depix.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{depix}
+  s.version = "1.0.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Julik Tarkhanov"]
+  s.date = %q{2009-05-21}
+  s.default_executable = %q{depix-describe}
+  s.description = %q{Read and write DPX file metadata}
+  s.email = ["me@julik.nl"]
+  s.executables = ["depix-describe"]
+  s.extra_rdoc_files = ["DPX_HEADER_STRUCTURE.txt", "History.txt", "Manifest.txt", "README.txt"]
+  s.files = ["DPX_HEADER_STRUCTURE.txt", "History.txt", "Manifest.txt", "README.txt", "Rakefile", "bin/depix-describe", "depix.gemspec", "lib/depix.rb", "lib/depix/benchmark.rb", "lib/depix/compact_structs.rb", "lib/depix/dict.rb", "lib/depix/editor.rb", "lib/depix/enums.rb", "lib/depix/reader.rb", "lib/depix/struct_explainer.rb", "lib/depix/structs.rb", "test/samples/E012_P001_L000002_lin.0001.dpx", "test/samples/E012_P001_L000002_lin.0002.dpx", "test/samples/E012_P001_L000002_log.0001.dpx", "test/samples/E012_P001_L000002_log.0002.dpx", "test/test_depix.rb", "test/test_dict.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://guerilla-di.rubyforge.org/depix}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{guerilla-di}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Read and write DPX file metadata}
+  s.test_files = ["test/test_depix.rb", "test/test_dict.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<timecode>, [">= 0"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.3"])
+    else
+      s.add_dependency(%q<timecode>, [">= 0"])
+      s.add_dependency(%q<hoe>, [">= 1.8.3"])
+    end
+  else
+    s.add_dependency(%q<timecode>, [">= 0"])
+    s.add_dependency(%q<hoe>, [">= 1.8.3"])
+  end
+end

data/lib/depix.rb

@@ -10,7 +10,7 @@ require File.dirname(__FILE__) + '/depix/editor'
 
 
 module Depix
-  VERSION = '1.0.5'
+  VERSION = '1.0.7'
   
   class InvalidHeader < RuntimeError; end
   

data/lib/depix/editor.rb

@@ -1,32 +1,54 @@
+require 'delegate'
+
 module Depix
   # Used to edit DPX headers. Create an Editor object and pass the path to the file to it. Change the headers variable to contain the edited
-  # DPX headers and call commit!. Note that the DPX header will be overwritten in place - if you want to save another version you need to manage it yourself
-  class Editor
+  # DPX headers and call commit!. Note that the DPX header will be overwritten in place - if you want to save another version you need to manage
+  # it yourself.
+  #
+  #      dpx = Depix::Editor.new("/RAID/scans/1374470_adjusted.dpx")
+  #      dpx.file.copyright = "Copyleft"
+  #      dpx.file.reserve = "FileReserve"
+  #      dpx.orientation.reserve = "OrientReserve"
+  #      dpx.orientation.device = "Chainik"
+  #      dpx.orientation.serial = "43"
+  #      dpx.film.reserve = "FilmRezerve"
+  #      dpx.file.project = "Mastermind"
+  #      
+  #      dpx.commit! # will write out the headers
+  class Editor < Delegator
 
     # Stores the path to file
     attr_reader :path
     
-    # Stores the Depix::DPX object with headers
-    attr_accessor :headers
-    
     # Create a new editor for the file at path
     def initialize(file_path)
       @path = file_path
-      @headers = Depix.from_file(@path)
+      @dpx = Depix.from_file(@path)
     end
     
     # Save the headers to file at path, overwriting the old ones
     def commit!
-      raise "No headers" unless @headers
-      raise "Cannot pack LE headers" if @headers.le?
-      packed = @headers.class.pack(@headers)
+      raise "No headers" unless @dpx
+      raise "Cannot pack LE headers yet" if @dpx.le?
+      packed = @dpx.class.pack(@dpx)
       
       # Validate that we can unpack first - what if something went wrong?
       Depix::Reader.new.parse(packed, false)
       
+      # Use in-place writing into DPX file (this is what + does)
       File.open(@path, 'rb+') do | f |
         f.seek(0, IO::SEEK_SET); f.write(packed)
       end
     end
+    
+    # DEPRECATED
+    def headers
+      STDERR.puts "Depix::Editor#headers is deprecated, use the Editor itself instead"
+      self
+    end
+    
+    def __getobj__
+      @dpx # return object we are delegating to, required
+    end
   end
 end

data/lib/depix/reader.rb

@@ -26,14 +26,14 @@ module Depix
     # The hear of Depix
     def parse(data, compact)
       magic = data[0..3]
-    
+      
       raise InvalidHeader, "No magic bytes found at start" unless %w( SDPX XPDS).include?(magic)
-    
+      
       struct = compact ? CompactDPX : DPX
-    
+      
       is_be = (magic == "SDPX")
       version_check = FileInfo.only(:magic, :version)
-    
+      
       result = begin
         if is_be
           version_check.consume!(data.unpack(version_check.pattern))
@@ -43,8 +43,6 @@ module Depix
       rescue ArgumentError
         raise InvalidHeader
       end
-    
-      raise InvalidHeader, "Unknown version tag #{result.version}" unless result.version == "V1.0"
      
       template = is_be ? DPX.pattern : make_le(DPX.pattern)
       struct.consume!(data.unpack(struct.pattern))

data/lib/depix/structs.rb

@@ -17,7 +17,7 @@ module Depix
     char :filename, 100,  :desc => 'Original filename'
     char :timestamp, 24,  :desc => 'Creation timestamp'
     char :creator, 100,   :desc => 'Creator application'
-    char :roject, 200,    :desc => 'Project name'
+    char :project, 200,    :desc => 'Project name'
     char :copyright, 200, :desc => 'Copyright'
     
     u32  :encrypt_key,    :desc => 'Encryption key'

data/test/test_depix.rb

@@ -119,7 +119,8 @@ class EditorTest < Test::Unit::TestCase
     e = Depix::Editor.new(SAMPLE_DPX)
     assert_not_nil e
     assert_equal SAMPLE_DPX, e.path
-    assert_not_nil e.headers
+    assert_respond_to e, :flame_reel
+    assert_equal "E012", e.flame_reel
   end
   
   def test_commit
@@ -127,7 +128,7 @@ class EditorTest < Test::Unit::TestCase
     begin
       FileUtils.cp(SAMPLE_DPX, temp_path)
       e  = Depix::Editor.new(temp_path)
-      e.headers.flame_reel = "E013"
+      e.flame_reel = "E013"
 
       assert_nothing_raised { e.commit! }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: julik-depix
 version: !ruby/object:Gem::Version 
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors: 
 - Julik Tarkhanov
@@ -9,19 +9,30 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-26 00:00:00 -08:00
+date: 2009-05-21 00:00:00 -07:00
 default_executable: depix-describe
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: timecode
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.2
+        version: 1.8.3
     version: 
-description: Read DPX file metadata
+description: Read and write DPX file metadata
 email: 
 - me@julik.nl
 executables: 
@@ -29,32 +40,33 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
+- DPX_HEADER_STRUCTURE.txt
 - History.txt
 - Manifest.txt
 - README.txt
-- DPX_HEADER_STRUCTURE.txt
 files: 
+- DPX_HEADER_STRUCTURE.txt
 - History.txt
 - Manifest.txt
 - README.txt
-- DPX_HEADER_STRUCTURE.txt
 - Rakefile
 - bin/depix-describe
+- depix.gemspec
 - lib/depix.rb
-- lib/depix/struct_explainer.rb
-- lib/depix/structs.rb
 - lib/depix/benchmark.rb
 - lib/depix/compact_structs.rb
-- lib/depix/enums.rb
 - lib/depix/dict.rb
-- lib/depix/reader.rb
 - lib/depix/editor.rb
-- test/test_dict.rb
-- test/test_depix.rb
+- lib/depix/enums.rb
+- lib/depix/reader.rb
+- lib/depix/struct_explainer.rb
+- lib/depix/structs.rb
 - test/samples/E012_P001_L000002_lin.0001.dpx
 - test/samples/E012_P001_L000002_lin.0002.dpx
 - test/samples/E012_P001_L000002_log.0001.dpx
 - test/samples/E012_P001_L000002_log.0002.dpx
+- test/test_depix.rb
+- test/test_dict.rb
 has_rdoc: true
 homepage: http://guerilla-di.rubyforge.org/depix
 post_install_message: 
@@ -81,7 +93,7 @@ rubyforge_project: guerilla-di
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Read DPX file metadata
+summary: Read and write DPX file metadata
 test_files: 
 - test/test_depix.rb
 - test/test_dict.rb