depix 1.0.5 → 1.0.8

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,13 @@
+=== 1.0.8 / 2009-11-14
+
+* Fix the version tag check so that it allows all versions but is still included, and so that the tests run
+
+=== 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/Manifest.txt

@@ -1,10 +1,10 @@
+.DS_Store
 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
@@ -14,6 +14,9 @@ lib/depix/enums.rb
 lib/depix/reader.rb
 lib/depix/struct_explainer.rb
 lib/depix/structs.rb
+test/.DS_Store
+test/samples/.DS_Store
+test/samples/026_FROM_HERO_TAPE_5-3-1_MOV.0029.dpx
 test/samples/E012_P001_L000002_lin.0001.dpx
 test/samples/E012_P001_L000002_lin.0002.dpx
 test/samples/E012_P001_L000002_log.0001.dpx

data/README.txt

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

data/lib/depix.rb

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

data/lib/depix/dict.rb

@@ -1,8 +1,34 @@
 module Depix
   
   #:stopdoc:
+  
+=begin
+  A basic C structs library (only works by value).
+  Here's the basic mode of operation:
+   1) You define a struct, with a number of fields in it
+   3) Each field knows how big it is and how to produce a pattern to get it's value from the byte stream
+      by using Ruby's "pack/unpack". Each field thus provides an unpack pattern, and patterns are ordered
+      into a stack, starting with the first unpack pattern
+   4) When you parse some bytes using the struct, heres what will happen:
+      - An unpack pattern will be compiled from all of the fields composing the struct,
+       and it will be a single string. The string gets applied to the bytes passed to parse()
+      - An array of unpacked values returned by unpack is then passed to the struct's consumption engine,
+        which lets each field take as many items off the stack as it needs. A field might happily produce
+        4 items for unpacking and then take the same 4 items off the stack of parsed values. Or not.
+      - A new structure gets created and for every named field it defines an attr_accessor. When consuming,
+        the values returned by Field objects get set using the accessors (so accessors can be overridden too!)
+   5) When you save out the struct roughly the same happens but in reverse (readers are called per field,
+      then it's checked whether the data can be packed and fits into the alloted number of bytes, and then
+      one big array of values is composed and passed on to Array#pack)
+=end
+
   class Field
-    attr_accessor :name, :length, :pattern, :req, :desc, :rtype
+    attr_accessor :name, # Field name
+                  :length, # Field length in bytes, including any possible padding
+                  :pattern, # The unpack pattern that defines the field
+                  :req, # Is the field required?
+                  :desc, # Field description
+                  :rtype  # To which Ruby type this has to be cast (and which type is accepted as value)
     alias_method :req?, :req
     
     # Hash init
@@ -36,17 +62,19 @@ module Depix
       R32Field.new(o)
     end
     
-    # Return a cleaned value
+    # Return a cleaned value (like a null-terminated string truncated up to null)
     def clean(v)
       v
     end
     
+    # Show a nice textual explanation of the field
     def explain
       [rtype ? ("(%s)" % rtype) : nil, desc, (req? ? "- required" : nil)].compact.join(' ')
     end
     
     # Return the actual values from the stack. The stack will begin on the element we need,
-    # so the default consumption is shift
+    # so the default consumption is shift. Normally all fields shift the stack
+    # as they go, and if they contain nested substructs they will pop the stack as well
     def consume!(stack)
       clean(stack.shift)
     end
@@ -193,7 +221,7 @@ module Depix
     
     BLANKING_VALUES = [0x00.chr, 0xFF.chr]
     BLANKING_PATTERNS = BLANKING_VALUES.inject([]) do | p, char |
-      p << /^(#{char}+)/ << /(#{char}+)$/
+      p << /^([#{char}]+)/ << /([#{char}]+)$/mu
     end
     
     def pattern

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,9 +43,9 @@ module Depix
       rescue ArgumentError
         raise InvalidHeader
       end
-    
-      raise InvalidHeader, "Unknown version tag #{result.version}" unless result.version == "V1.0"
-     
+      
+      raise InvalidHeader, "Unknown version tag #{result.version}" unless result.version =~ /V(\d)\.(\d+)/
+      
       template = is_be ? DPX.pattern : make_le(DPX.pattern)
       struct.consume!(data.unpack(struct.pattern))
     end

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! }
 

data/test/test_dict.rb

@@ -147,7 +147,7 @@ end
 class TestArrayField < Test::Unit::TestCase
   include FieldConformity
   
-  def test_array_field_conform_field!s_to_field_and_has_extra_methods
+  def test_array_field_conforms_to_field_and_has_extra_methods
     f = ArrayField.new
     conform_field!(f)
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: depix
 version: !ruby/object:Gem::Version 
-  version: 1.0.5
+  version: 1.0.8
 platform: ruby
 authors: 
 - Julik Tarkhanov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-18 00:00:00 +01:00
+date: 2009-11-14 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.2
+        version: 2.3.3
     version: 
 description: Read and write DPX file metadata
 email: 
@@ -45,13 +45,13 @@ extra_rdoc_files:
 - Manifest.txt
 - README.txt
 files: 
+- .DS_Store
 - 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
@@ -61,6 +61,9 @@ files:
 - lib/depix/reader.rb
 - lib/depix/struct_explainer.rb
 - lib/depix/structs.rb
+- test/.DS_Store
+- test/samples/.DS_Store
+- test/samples/026_FROM_HERO_TAPE_5-3-1_MOV.0029.dpx
 - test/samples/E012_P001_L000002_lin.0001.dpx
 - test/samples/E012_P001_L000002_lin.0002.dpx
 - test/samples/E012_P001_L000002_log.0001.dpx
@@ -68,7 +71,9 @@ files:
 - test/test_depix.rb
 - test/test_dict.rb
 has_rdoc: true
-homepage: http://wiretap.rubyforge.org/depix
+homepage: http://guerilla-di.org/depix
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -90,9 +95,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: guerilla-di
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Read and write DPX file metadata
 test_files: 
 - test/test_depix.rb

data/depix.gemspec

@@ -1,35 +0,0 @@
-Gem::Specification.new do |s|
-  s.name = %q{depix}
-  s.version = "1.0.5"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Julik Tarkhanov"]
-  s.date = %q{2008-12-26}
-  s.default_executable = %q{depix-describe}
-  s.description = %q{Read DPX file metadata}
-  s.email = ["me@julik.nl"]
-  s.executables = ["depix-describe"]
-  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt", "DPX_HEADER_STRUCTURE.txt"]
-  s.files = ["History.txt", "Manifest.txt", "README.txt", "DPX_HEADER_STRUCTURE.txt", "Rakefile", "bin/depix-describe", "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", "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"]
-  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 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_development_dependency(%q<hoe>, [">= 1.8.2"])
-    else
-      s.add_dependency(%q<hoe>, [">= 1.8.2"])
-    end
-  else
-    s.add_dependency(%q<hoe>, [">= 1.8.2"])
-  end
-end