edl 0.1.5 → 0.1.6

data/lib/edl/cutter.rb

@@ -1,34 +1,37 @@
+# frozen_string_literal: true
+
 module EDL
   # Can chop an offline edit into events according to the EDL
   class Cutter #:nodoc:
     def initialize(source_path)
       @source_path = source_path
     end
-    
+
     def cut(edl)
-      source_for_cutting = edl.from_zero #.without_transitions.without_generators
+      source_for_cutting = edl.from_zero # .without_transitions.without_generators
       # We need to use the original length in record
-      source_for_cutting.events.each do | evt |
+      source_for_cutting.events.each do |evt|
         cut_segment(evt, evt.rec_start_tc, evt.rec_start_tc + evt.length)
       end
     end
-    
+
     def cut_segment(evt, start_at, end_at)
       STDERR.puts "Cutting #{@source_path} from #{start_at} to #{end_at} - #{evt.num}"
     end
   end
-  
+
   class FFMpegCutter < Cutter #:nodoc:
     def cut_segment(evt, start_at, end_at)
-      source_dir, source_file = File.dirname(@source_path), File.basename(@source_path)
+      source_dir = File.dirname(@source_path)
+      source_file = File.basename(@source_path)
       dest_segment = File.join(source_dir, ('%s_%s' % [evt.num, source_file]))
-    # dest_segment.gsub!(/\.mov$/i, '.mp4')
-      
+      # dest_segment.gsub!(/\.mov$/i, '.mp4')
+
       offset = end_at - start_at
-      
+
       cmd = "/opt/local/bin/ffmpeg -i #{@source_path} -ss #{start_at} -vframes #{offset.total} -vcodec photojpeg -acodec copy #{dest_segment}"
-     #puts cmd 
-     `#{cmd}`
+      # puts cmd
+      `#{cmd}`
     end
   end
-end
+end

data/lib/edl/event.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module EDL
   # Represents an edit event (or, more specifically, an EDL line denoting a clip being part of an EDL event)
   class Event
@@ -6,7 +8,7 @@ module EDL
 
     # Reel name as in the EDL
     attr_accessor :reel
-  
+
     # Event tracks as in the EDL
     attr_accessor :track
 
@@ -19,7 +21,7 @@ module EDL
     attr_accessor :src_end_tc
 
     # Record start timecode of the event in the master as in the EDL
-    attr_accessor :rec_start_tc 
+    attr_accessor :rec_start_tc
 
     # Record end timecode of the event in the master as in the EDL,
     # outgoing transition is not included
@@ -36,76 +38,76 @@ module EDL
 
     # Incoming transition metadata (EDL::Transition), or nil if no transition is used
     attr_accessor :transition
-  
+
     # How long is the incoming transition on the next event
     attr_accessor :outgoing_transition_duration
-    
+
     # Where is this event located in the original file
     attr_accessor :line_number
-    
+
     def initialize(opts = {})
-      opts.each_pair{|k,v| send("#{k}=", v) }
+      opts.each_pair { |k, v| send("#{k}=", v) }
       yield(self) if block_given?
     end
-    
+
     # Output a textual description (will not work as an EDL line!)
     def to_s
-      %w( num reel track src_start_tc src_end_tc rec_start_tc rec_end_tc).map{|a| self.send(a).to_s}.join("  ")
+      %w[num reel track src_start_tc src_end_tc rec_start_tc rec_end_tc].map { |a| send(a).to_s }.join('  ')
     end
-  
+
     def inspect
       to_s
     end
-  
+
     def comments #:nodoc:
       @comments ||= []
       @comments
     end
-    
+
     def outgoing_transition_duration #:nodoc:
       @outgoing_transition_duration ||= 0
     end
-  
+
     # Is the clip reversed in the edit?
     def reverse?
       (timewarp && timewarp.reverse?)
     end
-    alias_method :reversed?, :reverse?
-  
+    alias reversed? reverse?
+
     def copy_properties_to(evt)
-      %w( num reel track src_start_tc src_end_tc rec_start_tc rec_end_tc).each do | k |
+      %w[num reel track src_start_tc src_end_tc rec_start_tc rec_end_tc].each do |k|
         evt.send("#{k}=", send(k)) if evt.respond_to?(k)
       end
       evt
     end
-  
+
     # Returns true if the clip starts with a transiton (not a jump cut)
     def has_transition?
       !!@transition
     end
-    alias_method :starts_with_transition?, :has_transition?
-    
+    alias starts_with_transition? has_transition?
+
     # The duration of the incoming transition, or 0 if no transition is used
     def incoming_transition_duration
       @transition ? @transition.duration : 0
     end
-    
+
     # Returns true if the clip ends with a transition (if the next clip starts with a transition)
     def ends_with_transition?
       outgoing_transition_duration > 0
     end
-  
+
     # Returns true if the clip has a timewarp (speed ramp, motion memory, you name it)
     def has_timewarp?
       !timewarp.nil?
     end
-  
+
     # Is this a black slug?
     def black?
       reel == 'BL'
     end
-    alias_method :slug?, :black?
-  
+    alias slug? black?
+
     # Get the record length of the event (how long it occupies in the EDL without an eventual outgoing transition)
     def rec_length
       (rec_end_tc.to_i - rec_start_tc.to_i).to_i
@@ -115,37 +117,45 @@ module EDL
     def rec_length_with_transition
       rec_length + outgoing_transition_duration.to_i
     end
-  
+
     # How long does the capture need to be to complete this event including timewarps and transitions
     def src_length
       @timewarp ? @timewarp.actual_length_of_source : rec_length_with_transition
     end
-  
-    alias_method :capture_length, :src_length
+
+    alias capture_length src_length
 
     # Capture from (and including!) this timecode to complete this event including timewarps and transitions
     def capture_from_tc
       @timewarp ? @timewarp.source_used_from : src_start_tc
     end
-    
+
     # Capture up to AND INCLUDING this timecode to complete this event including timewarps and transitions
     def capture_to_and_including_tc
       capture_to_tc - 1
     end
-    
+
     # Capture up to BUT NOT INCLUDING this timecode to complete this event including timewarps and transitions
     def capture_to_tc
       @timewarp ? @timewarp.source_used_upto : (src_end_tc + outgoing_transition_duration)
     end
-    
+
     # Speed of this clip in percent relative to the source speed. 100 for non-timewarped events
     def speed
       @timewarp ? @timewarp.speed : 100.0
     end
-    
+
+    # Sets the reel name and outputs a warning if it contains dots or spaces
+    def reel=(new_reel_name)
+      if new_reel_name =~ /[\s\.]/
+        $stderr.puts "Reel name #{new_reel_name.inspect} contains dots or spaces, beware."
+      end
+      @reel = new_reel_name
+    end
+
     # Returns true if this event is a generator
     def generator?
-      black? || (%(AX GEN).include?(reel))
+      black? || %(AX GEN).include?(reel)
     end
   end
-end
+end

data/lib/edl/grabber.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module EDL
   # When initialized with a file and passed an EDL, will generate thumbnail images
   # of the first frame of every event. It is assumed that the movie file starts at the same
@@ -7,23 +9,23 @@ module EDL
     def initialize(with_file)
       @source_path = with_file
     end
-    
+
     def ffmpeg_bin
       @ffmpeg_bin || 'ffmpeg'
     end
-    
+
     def grab(edl)
-      edl.from_zero.events.each do | evt |
-        grab_frame_tc = evt.rec_start_tc + (offset || 0 )
-        
+      edl.from_zero.events.each do |evt|
+        grab_frame_tc = evt.rec_start_tc + (offset || 0)
+
         to_file = File.dirname(@source_path) + '/' + evt.num + '_' + File.basename(@source_path).gsub(/\.(\w+)$/, '')
         generate_grab(evt.num, grab_frame_tc, to_file)
       end
     end
-    
-    def generate_grab(evt, at, to_file)
+
+    def generate_grab(_evt, at, to_file)
       cmd = "#{ffmpeg_bin} -i #{@source_path} -an -ss #{at.with_frames_as_fraction} -vframes 1 -y #{to_file}%d.jpg"
       `#{cmd}`
     end
   end
-end
+end

data/lib/edl/linebreak_magician.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # EDLs sometimes come with \r line breaks, and this is something that fails
 # with Ruby standard line separator detection. We need something to help us
 # with that. In this case we can just do a bulk replace because EDLs will be relatively
@@ -8,4 +10,4 @@ class EDL::LinebreakMagician < StringIO
     blob = with_io.read
     super(blob.gsub(LOOSE_CR, "\n"))
   end
-end
+end

data/lib/edl/parser.rb

@@ -1,48 +1,53 @@
+# frozen_string_literal: true
+
 module EDL
-  
   # Is used to parse an EDL
+  # Parsing errors are collected in +errors+
   class Parser
-  
     attr_reader :fps
-  
-    # Initialize an EDL parser. Pass the FPS to it, as the usual EDL does not contain any kind of reference 
+    attr_accessor :errors
+
+    # Initialize an EDL parser. Pass the FPS to it, as the usual EDL does not contain any kind of reference
     # to it's framerate
     def initialize(with_fps = DEFAULT_FPS)
       @fps = with_fps
     end
-  
+
     def get_matchers #:nodoc:
-      [ EventMatcher.new(@fps), EffectMatcher.new, NameMatcher.new, TimewarpMatcher.new(@fps), CommentMatcher.new ]
+      [EventMatcher.new(@fps), EffectMatcher.new, NameMatcher.new, TimewarpMatcher.new(@fps), CommentMatcher.new]
     end
-  
+
     # Parse a passed File or IO object line by line, or the whole string
     def parse(input_string_or_io)
       return parse(StringIO.new(input_string_or_io)) unless input_string_or_io.respond_to?(:read)
-      
-      magic = ::EDL::LinebreakMagician.new(input_string_or_io)
-      
+      self.errors = []
+
+      magic = EDL::LinebreakMagician.new(input_string_or_io)
+
       # Normalize line breaks
-      stack, matchers = List.new, get_matchers
-      
+      stack = List.new
+      matchers = get_matchers
+
       while current_line = magic.gets
-        
-        m = matchers.find{|m| m.matches?(current_line) }
-        
+        m = matchers.find { |m| m.matches?(current_line) }
+
         next unless m
         begin
           m.apply(stack, current_line)
           stack[-1].line_number = magic.lineno if m.is_a?(EventMatcher)
         rescue Matcher::ApplyError => e
-          STDERR.puts "Cannot parse #{current_line} - #{e}"
+          error = "Cannot parse #{current_line} - #{e}"
+          errors << error
+          STDERR.puts error
         end
       end
       stack
     end
-  
+
     # Init a Timecode object from the passed elements with the passed framerate
     def self.timecode_from_line_elements(elements, fps) #:nodoc:
-      args = (0..3).map{|_| elements.shift.to_i} + [fps.to_f]
+      args = (0..3).map { |_| elements.shift.to_i } + [fps.to_f]
       Timecode.at(*args)
     end
   end
-end
+end

data/lib/edl/timewarp.rb

@@ -1,24 +1,25 @@
+# frozen_string_literal: true
+
 module EDL
   # Represents a timewarp. Will be placed in EDL::Event#timewarp
   # For a reversed clip, the source start we get from the EDL in the src start
-  # is the LAST used frame. For a pos rate clip, the source start is the bona fide source start. Nice eh? 
+  # is the LAST used frame. For a pos rate clip, the source start is the bona fide source start. Nice eh?
   class Timewarp
-  
     # What is the actual framerate of the clip (float)
     attr_accessor :actual_framerate
     attr_accessor :clip #:nodoc:
-    
+
     # Does this timewarp reverse the clip?
     def reverse?
       @actual_framerate < 0
     end
-    
+
     # Get the speed in percent
     def speed_in_percent
       (@actual_framerate / @clip.rec_start_tc.fps) * 100
     end
-    alias_method :speed, :speed_in_percent
-    
+    alias speed speed_in_percent
+
     # Compute the length of the clip we need to capture. The length is computed in frames and
     # is always rounded up (better one frame more than one frame less!)
     def actual_length_of_source
@@ -28,7 +29,7 @@ module EDL
       factor = @actual_framerate / @clip.rec_start_tc.fps
       (target_len * factor).ceil.abs
     end
-    
+
     # What is the starting frame for the captured clip? If we are a reverse, then the src start of the
     # clip is our LAST frame, otherwise it's the first
     def source_used_from
@@ -36,10 +37,10 @@ module EDL
       compensation = 2
       reverse? ? (@clip.src_start_tc - actual_length_of_source + compensation) : @clip.src_start_tc
     end
-    
+
     # Where to end the capture? This is also dependent on whether we are a reverse or not
     def source_used_upto
       source_used_from + actual_length_of_source
     end
   end
-end
+end

data/lib/edl/transition.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
+
 module EDL
   # Represents a transition. We currently only support dissolves and SMPTE wipes
   # Will be avilable as EDL::Clip#transition
   class Transition
-  
     # Length of the transition in frames
     attr_accessor :duration
-    
+
     # Which effect is used (like CROSS DISSOLVE)
     attr_accessor :effect
   end
@@ -16,11 +17,10 @@ module EDL
 
   # Represents an SMPTE wipe
   class Wipe < Transition
-    
     # Which SMPTE wipe is needed
     attr_accessor :smpte_wipe_index
   end
-  
+
   class Key < Transition
   end
-end
+end

data/lib/edl/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EDL
+  VERSION = '0.1.6'
+end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: edl
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
 date: 2014-03-24 00:00:00.000000000 Z
 dependencies:
@@ -14,86 +14,44 @@ dependencies:
   name: timecode
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: shoulda-context
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: test-unit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: flexmock
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: '3.5'
 description: 
 email: me@julik.nl
 executables: []
@@ -101,6 +59,11 @@ extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - History.txt
 - README.rdoc
@@ -115,21 +78,7 @@ files:
 - lib/edl/parser.rb
 - lib/edl/timewarp.rb
 - lib/edl/transition.rb
-- test/samples/45S_SAMPLE.EDL
-- test/samples/FCP_REVERSE.EDL
-- test/samples/KEY_TRANSITION.EDL
-- test/samples/PLATES.EDL
-- test/samples/REEL_IS_CLIP.txt
-- test/samples/REVERSE.EDL
-- test/samples/SIMPLE_DISSOLVE.EDL
-- test/samples/SPEEDUP_AND_FADEOUT.EDL
-- test/samples/SPEEDUP_REVERSE_AND_FADEOUT.EDL
-- test/samples/SPLICEME.EDL
-- test/samples/TIMEWARP.EDL
-- test/samples/TIMEWARP_HALF.EDL
-- test/samples/TRAILER_EDL.edl
-- test/samples/edl_mixed_line_endings.edl
-- test/test_edl.rb
+- lib/edl/version.rb
 homepage: http://guerilla-di.org/edl
 licenses: []
 metadata: {}
@@ -139,17 +88,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Parser for EDL (Edit Decision List) files