shift_subtitle 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2009-09-26
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,18 @@
+bin/shift_subtitle
+History.txt
+lib/rsrt.rb
+lib/rsrt/srt_parser.rb
+lib/rsrt/subtitle.rb
+lib/rsrt/time_range.rb
+lib/shift_subtitle/cli.rb
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+rsrt.gemspec
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_subtitle.rb
+test/test_time_range.rb

data/PostInstall.txt

@@ -0,0 +1,3 @@
+Run shift_subtitle -h to get help on using this application.
+
+

data/README.rdoc

@@ -0,0 +1,52 @@
+= ShiftSubtitle
+
+* http://github.com/olivernn/ShiftSubtitle
+
+== DESCRIPTION:
+
+This gem includes the command line application shift_subtitle, a quick application that allows people to shift the times of subtitles in a .srt file.
+
+This application was created as part of the RubyLearning Blog competition here http://rubylearning.com/blog/2009/09/24/rpcfn-shift-subtitle-1/
+
+== FEATURES/PROBLEMS:
+
+Subtitles can be shifted forward or backwards.
+You can start shifting from any subtitle.
+
+== SYNOPSIS:
+
+run ruby shift_subtitle -h for a full list of options
+	-p --operation : either add or sub to add time or subtract time from the subtitles
+	-t --time : the amount of time to add or subtract from each subtitle range, this should be in milliseconds using the , as a thousand separator, e.g. 1,500 is 1 and a half seconds
+	-s --start_from : optional, the id of the subtitle to start shifting from, defaults to 1
+	-i --input_file : the full path to the input .srt file, this must be in the correct format
+	-o --output_file : the full path to the output .srt file
+
+== INSTALL:
+
+sudo gem install shift_subtitle
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/rsrt'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'shift_subtitle' do
+  self.developer 'Oliver Nightingale', 'oliver.nightingale2@ntlworld.com'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/bin/shift_subtitle

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+#
+#  Created by Oliver Nightingale on 2009-9-28.
+#  Copyright (c) 2009. All rights reserved.
+
+require 'rubygems'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/rsrt")
+require "rsrt/srt_parser"
+require "rsrt/subtitle"
+require "rsrt/time_range"
+require "shift_subtitle/cli"
+
+ShiftSubtitle::CLI.execute(STDOUT, ARGV)

data/lib/rsrt.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Rsrt
+  VERSION = '0.1.0'
+end

data/lib/rsrt/srt_parser.rb

@@ -0,0 +1,35 @@
+require 'open-uri'
+
+class SRTParser
+  
+  attr_reader :subtitles
+  
+  def initialize(srt_file_path)
+    @srt_file_path = srt_file_path
+    @regex_subtitle_id = Regexp.new('^\d+$')
+    @regex_time_range = Regexp.new('^\d{2}:\d{2}:\d{2},\d{3} --> \d{2}:\d{2}:\d{2},\d{3}$')
+    @regex_text = Regexp.new('^.+$')
+    @subtitles = Array.new
+    parse
+  end
+  
+  private
+  
+  def parse
+    subtitle_details = {}
+    subtitle_details[:text] = ""
+    
+    File.open(@srt_file_path).each do |line|
+      if @regex_subtitle_id.match(line)
+        subtitle_details[:id] = line
+      elsif @regex_time_range.match(line)
+        subtitle_details[:time_range] = line
+      elsif @regex_text.match(line)
+        subtitle_details[:text] += line
+      else # we think this is the end of the subtitle
+        @subtitles << Subtitle.new(subtitle_details)
+        subtitle_details[:text] = ""
+      end
+    end
+  end
+end

data/lib/rsrt/subtitle.rb

@@ -0,0 +1,31 @@
+class Subtitle
+  
+  attr_reader :start_time, :end_time, :id, :text
+  
+  def initialize(details={})
+    @id = details[:id].to_i
+    @text = details[:text]
+    parse_time_range(details[:time_range])
+  end
+  
+  def shift_time_range_forward(shift)
+    @start_time.from_ms(@start_time.to_ms + shift)
+    @end_time.from_ms(@end_time.to_ms + shift)
+  end
+  
+  def shift_time_range_backward(shift)
+    @start_time.from_ms(@start_time.to_ms - shift)
+    @end_time.from_ms(@end_time.to_ms - shift)
+  end
+  
+  def to_s
+    @id.to_s + "\n" + @start_time.to_s + " --> " + @end_time.to_s + "\n" + @text.to_s
+  end
+  
+  private
+  
+  def parse_time_range(time_range)
+    @start_time = TimeRange.new(time_range.split(" --> ")[0])
+    @end_time = TimeRange.new(time_range.split(" --> ")[1])
+  end
+end

data/lib/rsrt/time_range.rb

@@ -0,0 +1,67 @@
+class TimeRange
+  
+  attr_accessor :hours, :minutes, :seconds, :millieseconds
+  
+  def initialize(time)
+    @time = time
+    parse
+  end
+  
+  def to_ms
+    @millieseconds + (@seconds * 1000) + (@minutes * 60000) + (@hours * 3600000)
+  end
+  
+  def from_ms(ms)
+    t = Time.at(ms/1000)
+    @hours = t.hour - 1 #epoch was at 01:00:00!
+    @minutes = t.min
+    @seconds = t.sec
+    @millieseconds = ms.to_s.reverse.slice(0,3).reverse.to_i
+  end
+  
+  def to_s
+    hours_to_s + ":" + minutes_to_s + ":" + seconds_to_s + "," + millieseconds_to_s
+  end
+  
+  private
+  
+  def parse
+    time_split = @time.split(':')
+    @hours = time_split[0].to_i
+    @minutes = time_split[1].to_i
+    @seconds = time_split[2].split(',')[0].to_i
+    @millieseconds = time_split[2].split(',')[1].to_i
+  end
+  
+  def hours_to_s
+    if @hours.to_s.length == 2
+      @hours.to_s
+    else
+      @hours.to_s.rjust(2, "0")
+    end
+  end
+  
+  def minutes_to_s
+    if @minutes.to_s.length == 2
+      @minutes.to_s
+    else
+      @minutes.to_s.rjust(2, "0")
+    end
+  end
+  
+  def seconds_to_s
+    if @seconds.to_s.length == 2
+      @seconds.to_s
+    else
+      @seconds.to_s.rjust(2, "0")
+    end
+  end
+  
+  def millieseconds_to_s
+    if @millieseconds.to_s.length == 3
+      @millieseconds.to_s
+    else
+      @millieseconds.to_s.rjust(3, "0")
+    end
+  end
+end

data/lib/shift_subtitle/cli.rb

@@ -0,0 +1,64 @@
+require 'optparse'
+require 'open-uri'
+
+module ShiftSubtitle
+  class CLI
+    def self.execute(stdout, arguments=[])
+
+      options = {}
+
+      optparse = OptionParser.new do |opts|
+        opts.banner = "Usage: shift_subtitle.rb [options] input_file output_file"
+
+        options[:operation] = ""
+        opts.on('-p', '--operation OPERATION', 'add or sub') do |operation|
+          options[:operation] = operation
+        end
+
+        options[:time] = ""
+        opts.on('-t', '--time TIME', 'how much time to shift subtitles by') do |time|
+          options[:time] = time
+        end
+
+        options[:start] = 1
+        opts.on('-s', '--start_from [START]', 'where to start shifting subtitles from') do |start|
+          options[:start] = start
+        end
+
+        options[:input_file] = ""
+        opts.on('-i', '--input_file INPUT_FILE', 'the original subtitles') do |input_file|
+          options[:input_file] = input_file
+        end
+
+        options[:output_file] = 
+        opts.on('-o', '--output_file OUTPUT_FILE', 'where to save results') do |output_file|
+          options[:output_file] = output_file
+        end
+      end
+
+      optparse.parse!
+
+      @time_shift_ms = options[:time].gsub(",", "").to_i
+      @input_file_path = options[:input_file]
+      @output_file_path = options[:output_file]
+      @operation = options[:operation]
+      @start = options[:start].to_i
+      
+      @subtitles = SRTParser.new(@input_file_path).subtitles
+      
+      output_file = File.new(@output_file_path, "w+")
+
+      @subtitles.each do |subtitle|
+        if @operation == "add"
+          subtitle.shift_time_range_forward(@time_shift_ms) if subtitle.id >= @start
+        elsif @operation == "sub"
+          subtitle.shift_time_range_backward(@time_shift_ms) if subtitle.id >= @start
+        end
+        output_file.puts subtitle.to_s
+        output_file.puts "\n"
+      end
+
+      output_file.close
+    end
+  end
+end

data/rsrt.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{shift_subtitle}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Oliver Nightingale"]
+  s.date = %q{2009-09-29}
+  s.default_executable = %q{shift_subtitle}
+  s.description = %q{This gem includes the command line application shift_subtitle, a quick application that allows people to shift the times of subtitles in a .srt file.
+
+This application was created as part of the RubyLearning Blog competition here http://rubylearning.com/blog/2009/09/24/rpcfn-shift-subtitle-1/}
+  s.email = ["oliver.nightingale2@ntlworld.com"]
+  s.executables = ["shift_subtitle"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt"]
+  s.files = ["bin/shift_subtitle", "History.txt", "lib/rsrt.rb", "lib/rsrt/srt_parser.rb", "lib/rsrt/subtitle.rb", "lib/rsrt/time_range.rb", "lib/shift_subtitle/cli.rb", "Manifest.txt", "PostInstall.txt", "README.rdoc", "Rakefile", "rsrt.gemspec", "script/console", "script/destroy", "script/generate", "test/test_helper.rb", "test/test_subtitle.rb", "test/test_time_range.rb"]
+  s.homepage = %q{http://github.com/olivernn/shift_subtitle}
+  s.post_install_message = %q{PostInstall.txt}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rsrt}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{This gem includes the command line application shift_subtitle, a quick application that allows people to shift the times of subtitles in a .srt file}
+  s.test_files = ["test/test_helper.rb", "test/test_subtitle.rb", "test/test_time_range.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<hoe>, [">= 2.3.3"])
+    else
+      s.add_dependency(%q<hoe>, [">= 2.3.3"])
+    end
+  else
+    s.add_dependency(%q<hoe>, [">= 2.3.3"])
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/rsrt.rb'}"
+puts "Loading rsrt gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/rsrt'
+require "rsrt/subtitle"
+require "rsrt/time_range"

data/test/test_subtitle.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestSubtitle < Test::Unit::TestCase
+
+  def setup
+    @subtitle = Subtitle.new(:id =>"100", :time_range => "01:31:51,210 --> 01:31:54,893", :text => "MNU Head Office")
+  end
+  
+  def test_time_range_parsing
+    assert_equal 1, @subtitle.start_time.hours
+    assert_equal 1, @subtitle.end_time.hours
+    
+    assert_equal 31, @subtitle.start_time.minutes
+    assert_equal 54, @subtitle.end_time.seconds
+  end
+  
+  def test_id
+    assert_equal 100, @subtitle.id
+  end
+  
+  def test_shift_time_range_forward
+    @subtitle.shift_time_range_forward(1000)
+    assert_equal 52, @subtitle.start_time.seconds
+    assert_equal 55, @subtitle.end_time.seconds
+    
+    assert_equal 1, @subtitle.start_time.hours
+    assert_equal 893, @subtitle.end_time.millieseconds
+  end
+  
+  def test_shift_time_range_backward
+    @subtitle.shift_time_range_backward(1500)
+    assert_equal 49, @subtitle.start_time.seconds
+    assert_equal 53, @subtitle.end_time.seconds
+    
+    assert_equal 710, @subtitle.start_time.millieseconds
+    assert_equal 393, @subtitle.end_time.millieseconds
+  end
+  
+  def test_to_s
+    assert_equal expected_subtitle_to_s, @subtitle.to_s
+  end
+  
+  private
+  
+  def expected_subtitle_to_s
+    "100\n01:31:51,210 --> 01:31:54,893\nMNU Head Office"
+  end
+end

data/test/test_time_range.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestTimeRange < Test::Unit::TestCase
+  
+  def setup
+    @time_range = TimeRange.new("01:31:51,210")
+  end
+  
+  def test_hours_parsing
+    assert_equal 1, @time_range.hours
+  end
+  
+  def test_minutes_parsing
+    assert_equal 31, @time_range.minutes
+  end
+  
+  def test_seconds_parsing
+    assert_equal 51, @time_range.seconds
+  end
+  
+  def test_millieseconds_parsing
+    assert_equal 210, @time_range.millieseconds
+  end
+  
+  def test_to_ms
+    assert_equal 5511210, @time_range.to_ms
+  end
+  
+  def test_from_ms
+    @time_range.from_ms(5511210)
+    assert_equal 1, @time_range.hours
+    assert_equal 31, @time_range.minutes
+    assert_equal 51, @time_range.seconds
+    assert_equal 210, @time_range.millieseconds
+  end
+  
+  def test_to_s
+    assert_equal "01:31:51,210", @time_range.to_s
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: shift_subtitle
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Oliver Nightingale
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-05 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+description: |-
+  This gem includes the command line application shift_subtitle, a quick application that allows people to shift the times of subtitles in a .srt file.
+  
+  This application was created as part of the RubyLearning Blog competition here http://rubylearning.com/blog/2009/09/24/rpcfn-shift-subtitle-1/
+email: 
+- oliver.nightingale2@ntlworld.com
+executables: 
+- shift_subtitle
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- bin/shift_subtitle
+- History.txt
+- lib/rsrt.rb
+- lib/rsrt/srt_parser.rb
+- lib/rsrt/subtitle.rb
+- lib/rsrt/time_range.rb
+- lib/shift_subtitle/cli.rb
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- rsrt.gemspec
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_subtitle.rb
+- test/test_time_range.rb
+has_rdoc: true
+homepage: http://github.com/olivernn/ShiftSubtitle
+licenses: []
+
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: shift_subtitle
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: This gem includes the command line application shift_subtitle, a quick application that allows people to shift the times of subtitles in a .srt file
+test_files: 
+- test/test_helper.rb
+- test/test_subtitle.rb
+- test/test_time_range.rb