cinesync 0.9.6 → 1.0.1

data/Rakefile

@@ -16,7 +16,7 @@ begin
     gem.authors = ["Jonathon Mah", "Rising Sun Research"]
     gem.add_dependency "activesupport", ">= 2.3"
     gem.add_dependency "andand", ">= 1.3.1"
-    gem.add_dependency "builder", ">= 2.1"
+    gem.add_development_dependency "bacon", ">= 1.0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
@@ -25,18 +25,18 @@ rescue LoadError
 end
 
 require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+Rake::TestTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.verbose = true
 end
 
 begin
   require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
+  Rcov::RcovTask.new do |spec|
+    spec.libs << 'spec'
+    spec.pattern = 'spec/**/*_spec.rb'
+    spec.verbose = true
   end
 rescue LoadError
   task :rcov do
@@ -44,9 +44,9 @@ rescue LoadError
   end
 end
 
-task :test => :check_dependencies
+task :spec => :check_dependencies
 
-task :default => :test
+task :default => :spec
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|

data/VERSION

@@ -1 +1 @@
-0.9.6
+1.0.1

data/cinesync.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cinesync}
-  s.version = "0.9.6"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jonathon Mah", "Rising Sun Research"]
-  s.date = %q{2010-05-08}
+  s.date = %q{2010-05-28}
   s.description = %q{      This gem provides a Ruby interface to the cineSync session file format,
       which is used by cineSync's scripting system. Use it to integrate
       cineSync into your workflow.
@@ -25,12 +25,14 @@ Gem::Specification.new do |s|
      "LICENSE",
      "README.markdown",
      "Rakefile",
-     "Samples/Export Notes to CSV.rb",
      "VERSION",
      "cineSync Session v3 Schema.rnc",
      "cinesync.gemspec",
+     "examples/Export Notes to CSV.rb",
+     "examples/Start Session.rb",
      "lib/cinesync.rb",
      "lib/cinesync/color_grading.rb",
+     "lib/cinesync/commands.rb",
      "lib/cinesync/event_handler.rb",
      "lib/cinesync/frame_annotation.rb",
      "lib/cinesync/mask.rb",
@@ -43,7 +45,31 @@ Gem::Specification.new do |s|
      "lib/cinesync/ui/win32_save_file_dialog.rb",
      "lib/cinesync/xml.rb",
      "lib/cinesync/zoom_state.rb",
-     "test/helper.rb"
+     "spec/.bacon",
+     "spec/cinesync_spec.rb",
+     "spec/event_handler_spec.rb",
+     "spec/frame_annotation_spec.rb",
+     "spec/media_file_spec.rb",
+     "spec/media_locator_spec.rb",
+     "spec/session_spec.rb",
+     "spec/small.txt",
+     "spec/spec_helper.rb",
+     "spec/v3 files/corrupt.csc",
+     "spec/v3 files/v3-Newer v4.csc",
+     "spec/v3 files/v3-Unsupported.csc",
+     "spec/v3 files/v3-active first.csc",
+     "spec/v3 files/v3-active second.csc",
+     "spec/v3 files/v3-active single.csc",
+     "spec/v3 files/v3-basic.csc",
+     "spec/v3 files/v3-groups.csc",
+     "spec/v3 files/v3-pro.csc",
+     "spec/v3 files/v3-refmovie.csc",
+     "spec/v3 files/v3-stereo-anaglyph-off.csc",
+     "spec/v3 files/v3-stereo-anaglyph.csc",
+     "spec/v3 files/v3-stereo-interlaced-off.csc",
+     "spec/v3 files/v3-stereo.csc",
+     "spec/v3 files/v3-url.csc",
+     "spec/xml_spec.rb"
   ]
   s.homepage = %q{http://github.com/jmah/cinesync}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -51,7 +77,16 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.6}
   s.summary = %q{Library for scripting the cineSync collaborative video review tool}
   s.test_files = [
-    "test/helper.rb"
+    "spec/cinesync_spec.rb",
+     "spec/event_handler_spec.rb",
+     "spec/frame_annotation_spec.rb",
+     "spec/media_file_spec.rb",
+     "spec/media_locator_spec.rb",
+     "spec/session_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/xml_spec.rb",
+     "examples/Export Notes to CSV.rb",
+     "examples/Start Session.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -61,16 +96,16 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<activesupport>, [">= 2.3"])
       s.add_runtime_dependency(%q<andand>, [">= 1.3.1"])
-      s.add_runtime_dependency(%q<builder>, [">= 2.1"])
+      s.add_development_dependency(%q<bacon>, [">= 1.0"])
     else
       s.add_dependency(%q<activesupport>, [">= 2.3"])
       s.add_dependency(%q<andand>, [">= 1.3.1"])
-      s.add_dependency(%q<builder>, [">= 2.1"])
+      s.add_dependency(%q<bacon>, [">= 1.0"])
     end
   else
     s.add_dependency(%q<activesupport>, [">= 2.3"])
     s.add_dependency(%q<andand>, [">= 1.3.1"])
-    s.add_dependency(%q<builder>, [">= 2.1"])
+    s.add_dependency(%q<bacon>, [">= 1.0"])
   end
 end
 

data/examples/Start Session.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby
+
+require 'rubygems'
+require 'cinesync'
+
+if ARGV.empty?
+  $stderr.puts("Usage: #{$0} <file.mov> ...")
+  exit 1
+end
+
+
+# Create the session and add media from command-line arguments
+session = CineSync::Session.new
+session.media = ARGV.map {|path| CineSync::MediaFile.new(path) }
+
+# Open the session
+CineSync::Commands.open_session!(session)

data/lib/cinesync/commands.rb

@@ -0,0 +1,50 @@
+require 'uri'
+require 'cgi'
+require 'tmpdir'
+
+module CineSync
+  module Commands
+    class <<self
+      def opens_url(*syms)
+        syms.each do |sym|
+          self.class.send(:define_method, :"#{sym}!") {|*args| CineSync::UI.open_url(send(sym, *args)) }
+        end
+      end
+    end
+
+    opens_url :open_session_file, :create_session, :join_session, :run_script
+
+    def self.open_session_file(path, merge_with_existing = true)
+      op = merge_with_existing ? 'merge' : 'replace'
+      "cinesync://file/#{op}?path=#{CGI.escape(path)}"
+    end
+
+    def self.create_session(username = nil, password = nil)
+      "cinesync://session/new" + if username
+        "?username=#{CGI.escape(username)}" + if password
+          "&password=#{CGI.escape(password)}"
+        else '' end
+      else '' end
+    end
+
+    def self.join_session(session_key)
+      "cinesync://session/#{URI.escape(session_key)}"
+    end
+
+    def self.run_script(script_name, query = nil)
+      "cinesync://script/#{URI.escape(script_name)}#{query ? "?#{query}" : ''}"
+    end
+
+
+    opens_url :open_session
+
+    IllegalFileChars = /[^\w ~!@#\$%&\(\)_\-\+=\[\]\{\}',\.]/
+
+    def self.open_session(session, name = nil, merge_with_existing = true)
+      name ||= "untitled session"
+      path = File.join(Dir.tmpdir, name.gsub(IllegalFileChars, '_') + ".csc")
+      File.open(path, "w") {|f| f.puts session.to_xml }
+      open_session_file(path, merge_with_existing)
+    end
+  end
+end

data/lib/cinesync/event_handler.rb

@@ -26,7 +26,6 @@ module CineSync
     def saved_frame_path(media_file, frame)
       return nil unless save_parent
 
-      # This algorithm is ugly and will be improved before release
       base = ('%s-%05d' % [media_file.name, frame])
       i = 1; p2 = nil
       begin

data/lib/cinesync/frame_annotation.rb

@@ -13,7 +13,7 @@ module CineSync
     end
 
     def valid?
-      frame >= 1
+      frame >= 1 rescue false
     end
   end
 end

data/lib/cinesync/media_file.rb

@@ -100,7 +100,7 @@ module CineSync
         maybe_uri = URI::parse(s) rescue nil
 
         if File.exist? s
-          @path = s
+          @path = File.expand_path(s)
           @short_hash = CineSync::short_hash(@path)
         elsif maybe_uri and maybe_uri.scheme
           # The argument could be parsed as a URI (use it as a URL)
@@ -110,7 +110,12 @@ module CineSync
           @short_hash = s
         else
           # Finally, assume it's a file path
-          @path = s
+          if s =~ /^[A-Z]:[\\\/]/
+            # Looks like an absolute DOS path; let it through
+            @path = s
+          else
+            @path = File.expand_path(s)
+          end
         end
       end
     end

data/lib/cinesync/xml.rb

@@ -1,6 +1,5 @@
 require 'active_support'
 require 'andand'
-require 'builder'
 require 'rexml/document'
 require 'uri'
 
@@ -152,7 +151,7 @@ module CineSync
         m.notes = elem.elements['notes'].andand.text || ''
 
         elem.get_elements('annotation').each do |ann_elem|
-          FrameAnnotation.load(ann_elem, m)
+          m.annotations << FrameAnnotation.load(ann_elem)
         end
 
         # Load optional structures
@@ -424,9 +423,9 @@ module CineSync
     end
 
 
-    def self.load(elem, media)
-      returning media.annotations[elem.attribute('frame').value.to_i] do |ann|
-        ann.notes = elem.elements['notes'].andand.text || ann.notes
+    def self.load(elem)
+      returning self.new(elem.attribute('frame').value.to_i) do |ann|
+        ann.notes = elem.elements['notes'].andand.text || ''
         DrawingObjectElements.each do |obj_name|
           ann.drawing_objects += elem.get_elements(obj_name)
         end

data/lib/cinesync.rb

@@ -1,7 +1,3 @@
-Dir["#{File.dirname(__FILE__)}/vendor/gems/**"].map do |dir|
-  $: << (File.directory?(lib = "#{dir}/lib") ? lib : dir)
-end
-
 require 'cinesync/session'
 require 'cinesync/media_file'
 require 'cinesync/play_range'
@@ -11,6 +7,7 @@ require 'cinesync/mask'
 require 'cinesync/color_grading'
 require 'cinesync/xml'
 require 'cinesync/event_handler'
+require 'cinesync/commands'
 require 'cinesync/ui'
 require 'digest'
 
@@ -39,8 +36,8 @@ module CineSync
     end
   end
 
-  def self.event_handler
-    session = Session::load($stdin) rescue nil
-    yield CineSync::EventHandler.new(ARGV, session)
+  def self.event_handler(argv = ARGV, stdin = $stdin)
+    session = Session::load(stdin) rescue nil
+    yield CineSync::EventHandler.new(argv, session)
   end
 end

data/spec/cinesync_spec.rb

@@ -0,0 +1,12 @@
+$: << File.expand_path(File.dirname(__FILE__))
+require 'spec_helper'
+
+describe "cineSync utilities" do
+  it "correctly hashes big file" do
+    CineSync.short_hash("/Volumes/Oyama/Streams/cineSync Test Files/movies/nasa_shuttle_m420p.mov").should == "08e5628d51b14278f73f36afebf0506afc2bfcf8"
+  end
+
+  it "correctly hashes small file" do
+    CineSync.short_hash("spec/small.txt").should == '1e40efb84050f92618e2c430742f44254771cf6b'
+  end
+end

data/spec/event_handler_spec.rb

@@ -0,0 +1,66 @@
+$: << File.expand_path(File.dirname(__FILE__))
+require 'spec_helper'
+
+describe "event handler" do
+  before do
+    @example_path = File.join("spec", "v3 files", "v3-basic.csc")
+    @online_args = ["--key=ASDF0000", "--save-format=JPEG", "--save-dir=/tmp/cinesync"]
+    @offline_args = ["--key=_OFFLINE_", "--save-format=PNG", "--save-dir=/tmp/cinesync"]
+    @url_args = ["--key=URL1111", "--save-format=JPEG", "--url=cinesync://script/myscript?q=hi"]
+    @handler_run = false
+  end
+
+  it "should load session from stdin" do
+    File.open(@example_path, "r") do |f|
+      CineSync.event_handler(@online_args, f) do |evt|
+        evt.session.user_data.should == "sessionUserData blah bloo blee"
+        evt.session.media.length.should == 3
+        evt.session.notes.should == "These are my session notes.\nnewline."
+        evt.session.should.be.valid?
+        @handler_run = true
+      end
+    end
+    @handler_run.should.be.true?
+  end
+
+  it "should parse online arguments" do
+    File.open(@example_path, "r") do |f|
+      CineSync.event_handler(@online_args, f) do |evt|
+        evt.should.not.be.offline?
+        evt.session_key.should == "ASDF0000"
+        evt.save_format.should == :jpeg
+        evt.save_parent.to_s.should == "/tmp/cinesync"
+        evt.url.should.be.nil?
+        @handler_run = true
+      end
+    end
+    @handler_run.should.be.true?
+  end
+
+  it "should parse offline arguments" do
+    File.open(@example_path, "r") do |f|
+      CineSync.event_handler(@offline_args, f) do |evt|
+        evt.should.be.offline?
+        evt.session_key.should.be.nil?
+        evt.save_format.should == :png
+        evt.save_parent.to_s.should == "/tmp/cinesync"
+        evt.url.should.be.nil?
+        @handler_run = true
+      end
+    end
+    @handler_run.should.be.true?
+  end
+
+  it "should parse url argument" do
+    File.open(@example_path, "r") do |f|
+      CineSync.event_handler(@url_args, f) do |evt|
+        evt.should.not.be.offline?
+        evt.session_key.should == "URL1111"
+        evt.save_format.should == :jpeg
+        evt.url.should == "cinesync://script/myscript?q=hi"
+        @handler_run = true
+      end
+    end
+    @handler_run.should.be.true?
+  end
+end

data/spec/frame_annotation_spec.rb

@@ -0,0 +1,33 @@
+$: << File.expand_path(File.dirname(__FILE__))
+require 'spec_helper'
+
+describe "frame annotations" do
+  before do
+    @obj = CineSync::FrameAnnotation.new(5)
+  end
+
+  it "should validate frame number" do
+    @obj.frame.should == 5
+    @obj.should.be.valid?
+    CineSync::FrameAnnotation.new(0).should.not.be.valid? # 1-based, so 0 is invalid
+    CineSync::FrameAnnotation.new(-5).should.not.be.valid?
+    CineSync::FrameAnnotation.new("three").should.not.be.valid?
+  end
+
+  it "should store notes" do
+    @obj.notes.should == ""
+    @obj.notes = "asdf"
+    @obj.notes.should == "asdf"
+    @obj.should.be.valid?
+  end
+
+  it "should start with no drawing objects" do
+    @obj.drawing_objects.should.be.empty?
+  end
+
+  it "should start in default state" do
+    @obj.should.be.default?
+    @obj.notes = "asdf"
+    @obj.should.not.be.default?
+  end
+end

data/spec/media_file_spec.rb

@@ -0,0 +1,125 @@
+$: << File.expand_path(File.dirname(__FILE__))
+require 'spec_helper'
+
+shared "single and group movie" do
+  it "should store user data" do
+    @obj.user_data.should.not.be.nil?
+    @obj.user_data.should.be.empty?
+    @obj.user_data = "My custom data"
+    @obj.user_data.should == "My custom data"
+    @obj.should.be.valid?
+  end
+
+  it "should have an active property" do
+    @obj.should.not.be.active?
+    @obj.active = true
+    @obj.should.be.active?
+    @obj.should.be.valid?
+  end
+
+  it "should track the current frame" do
+    @obj.current_frame.should == 1
+    @obj.current_frame = 99
+    @obj.current_frame.should == 99
+    @obj.should.be.valid?
+
+    @obj.current_frame = -1
+    @obj.current_frame.should == -1
+    @obj.should.not.be.valid?
+  end
+
+  it "should belong to groups" do
+    @obj.groups.should.be.empty?
+    @obj.groups << "My group"
+    @obj.groups.should.be == ["My group"]
+  end
+end
+
+
+describe "cineSync media file" do
+  before do
+    @obj = CineSync::MediaFile.new("ftp://ftp.cinesync.com/demo.mov")
+  end
+
+  behaves_like "single and group movie"
+
+  it "should be valid by default" do
+    @obj.should.be.valid?
+  end
+
+  it "should create annotations on demand" do
+    @obj.annotations.should.be.empty?
+    ann_on_demand = @obj.annotations[32]
+    ann_on_demand.should.not.be.nil?
+    ann_on_demand.notes.should.not.be.nil?
+    ann_on_demand.notes.should.be.empty?
+
+    # Check that the instance we have is shared with the annotations hash
+    ann_on_demand.notes = 'notes on frame 32'
+    @obj.annotations[32].notes.should == ann_on_demand.notes
+  end
+
+  it "should validate annotation frame number" do
+    ann = @obj.annotations[3]
+    ann.should.be.valid?
+    @obj.should.be.valid?
+
+    ann2 = @obj.annotations[-5]
+    ann2.should.not.be.valid?
+    @obj.should.not.be.valid?
+    @obj.annotations.delete(-5)
+    @obj.should.be.valid?
+  end
+
+  it "should require a locator for validity" do
+    mf_loc = CineSync::MediaFile.new("/Volumes/Oyama/Streams/cineSync Test Files/movies/nasa_shuttle_m420p.mov")
+    mf_loc.should.be.valid?
+    mf_noloc = CineSync::MediaFile.new
+    mf_noloc.should.not.be.valid?
+  end
+
+  it "should get name from locator" do
+    @obj.name.should == "demo.mov"
+
+    @obj.name = ""
+    @obj.name.should.be.empty?
+    @obj.should.not.be.valid?
+
+    @obj.name = "custom_name"
+    @obj.name.should == "custom_name"
+    @obj.should.be.valid?
+
+    CineSync::MediaFile.new.name.should == ""
+  end
+end
+
+
+describe "group movies" do
+  before do
+    @obj = CineSync::GroupMovie.new("grp")
+  end
+
+  behaves_like "single and group movie"
+
+  it "should be based on a group" do
+    @obj.group.should == "grp"
+    @obj.should.be.valid?
+
+    @obj.group = ""
+    @obj.group.should.be.empty?
+    @obj.should.not.be.valid?
+  end
+
+  it "should accept all files group" do
+    empty = CineSync::GroupMovie.new("")
+    empty.group.should == ""
+    empty.should.not.be.valid?
+
+    empty.group = CineSync::AllFilesGroup
+    empty.should.be.valid?
+  end
+
+  it "should trigger pro features" do
+    @obj.should.uses_pro_features?
+  end
+end

data/spec/media_locator_spec.rb

@@ -0,0 +1,68 @@
+$: << File.expand_path(File.dirname(__FILE__))
+require 'spec_helper'
+
+describe "media locators" do
+  it "should represent empty locators" do
+    ml = CineSync::MediaLocator.new
+    ml.should.not.be.valid?
+    ml.path.should.be.nil?
+    ml.url.should.be.nil?
+    ml.short_hash.should.be.nil?
+  end
+
+  it "should accept a url location" do
+    url = "http://example.com/random_file.mov"
+    ml = CineSync::MediaLocator.new(url)
+    ml.should.be.valid?
+    ml.path.should.be.nil?
+    ml.url.to_s.should == url
+    ml.short_hash.should.be.nil?
+
+    ml.url.scheme.should == "http"
+    ml.url.host.should == "example.com"
+    ml.url.path.should == "/random_file.mov"
+  end
+
+  it "should set short hash for an existing path" do
+    path = "/Volumes/Oyama/Streams/cineSync Test Files/movies/nasa_shuttle_m420p.mov"
+    ml = CineSync::MediaLocator.new(path)
+    ml.should.be.valid?
+    ml.path.should == path
+    ml.url.should.be.nil?
+    ml.short_hash.should == "08e5628d51b14278f73f36afebf0506afc2bfcf8"
+  end
+
+  it "should accept path to non-existent file" do
+    path = "/path/to/nonexistent/file.mov"
+    ml = CineSync::MediaLocator.new(path)
+    ml.should.be.valid?
+    ml.path.should == path
+    ml.url.should.be.nil?
+    ml.short_hash.should.be.nil?
+  end
+
+  it "should accept dos path" do
+    path = 'C:\path\to\myMovie.mov'
+    ml = CineSync::MediaLocator.new(path)
+    ml.should.be.valid?
+    ml.path.should == path
+    ml.url.should.be.nil?
+    ml.short_hash.should.be.nil?
+  end
+
+  it "should accept short hash as locator" do
+    hash = "08e5628d51b14278f73f36afebf0506afc2bfcf8"
+    ml = CineSync::MediaLocator.new(hash)
+    ml.should.be.valid?
+    ml.path.should.be.nil?
+    ml.url.should.be.nil?
+    ml.short_hash.should == hash
+  end
+
+  it "should convert relative paths to absolute" do
+    rel_path = "../nonexist-test.mov"
+    abs_path = File.expand_path(rel_path)
+    ml = CineSync::MediaLocator.new(rel_path)
+    ml.path.should == abs_path
+  end
+end