subtitle_shifter 1.0.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Gabriel Fortuna
+
+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/README.rdoc

@@ -0,0 +1,19 @@
+= subtitle_shifter
+
+A simple little gem for modifying SubRip subtitle files. Done as a mentoring exercise with Citizen428, and taken from the Ruby Programming Challenge For Newbies
+
+== Contributing to subtitle_shifter
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Gabriel Fortuna. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+require 'jeweler'
+
+require './lib/subtitle_shifter'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name        = "subtitle_shifter"
+  gem.version     = SubtitleShifter::Version::STRING
+  gem.homepage    = "http://github.com/gee-forr/subtitle_shifter"
+  gem.license     = "MIT"
+  gem.summary     = %Q{A simple library for adjusting SubRip (.srt) subtitles}
+  gem.description = %Q{A simple little gem for modifying SubRip subtitle files. Done as a mentoring exercise with Citizen428, and taken from the Ruby Programming Challenge For Newbies}
+  gem.email       = "gee.forr@gmail.com"
+  gem.authors     = ["Gabriel Fortuna"]
+  gem.executables = ['shift_subtitle']
+
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  gem.add_development_dependency "minitest", ">= 0"
+  gem.add_development_dependency "bundler", "~> 1.0.0"
+  gem.add_development_dependency "jeweler", "~> 1.6.4"
+  gem.add_development_dependency "rcov", ">= 0"
+  gem.add_development_dependency "rdoc", ">= 0"
+end
+
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test' << 'spec'
+  test.pattern = 'test/**/*_spec.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/*_spec.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+#require 'rdoc/task'
+#RDoc::Task.new do |rdoc|
+  #version = File.exist?('VERSION') ? File.read('VERSION') : ""
+#
+  #rdoc.rdoc_dir = 'rdoc'
+  #rdoc.title = "subtitle_shifter #{version}"
+  #rdoc.rdoc_files.include('README*')
+  #rdoc.rdoc_files.include('lib/**/*.rb')
+#end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/bin/shift_subtitle

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+require 'getoptlong'
+require 'subtitle_shifter'
+#shift_subtitle --operation add --time 02,110 input_file output_file
+
+opts = GetoptLong.new(
+  ['--help',      '-h', GetoptLong::NO_ARGUMENT],
+  ['--operation', '-o', GetoptLong::REQUIRED_ARGUMENT],
+  ['--index',     '-i', GetoptLong::REQUIRED_ARGUMENT],
+  ['--time',      '-t', GetoptLong::REQUIRED_ARGUMENT],
+)
+
+operation = 'add'
+index     = 1
+time      = 0
+
+opts.each do |opt, arg|
+  case opt
+    when '--help'
+      puts <<-EOF
+shift_subtitle [REQUIRED ARGUMENTS] input_file output_file
+
+-h, --help:
+   show this help
+
+--operation [add|sub], -o [add|sub]:
+   either add time to or subtract time from subtitles
+
+--index [index], -i [index]:
+  choose from which index to start the operation
+
+--time [time], -t [time]:
+  the amount of time shifted e.g. 10,500 - 10 seconds, 500 ms.
+
+      EOF
+
+      exit 0
+    when '--operation'
+      operation = (['add', 'sub'].index(arg)) ? arg : 'add'
+    when '--index'
+      index = arg.to_i
+    when '--time'
+      time_parts = arg.split(',')
+      time       = (time_parts[0].to_i * 1000) + time_parts[1].to_i
+  end
+end
+
+if ARGV.length != 2
+  puts "Input and output files appear to be missing (try --help)"
+  exit 0
+end
+
+input  = ARGV.shift
+output = ARGV.shift
+time   = -time if operation.eql? 'sub' # Subtracting time works with negative numbers
+
+subtitles = SubtitleShifter.new(input)
+subtitles.shift(index: index, time: time)
+
+puts subtitles
+
+#puts "op = -#{operation}-, index = -#{index}-, time = -#{time}-, input = -#{input}-, output = -#{output}-"

data/lib/subtitle_shifter.rb

@@ -0,0 +1,130 @@
+
+# encoding: UTF-8
+
+class SubtitleShifter
+  module Version
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
+    BUILD = 0
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+
+  attr_reader :subtitles, :parsed_ok
+
+  TIME_SEPERATOR = '-->'
+
+  def initialize(file, linebreak = "\r\n")
+    @sub_file  = file
+    @linebreak = linebreak
+  end
+
+  def parse
+    raw_text  = File.open(@sub_file, 'r').read.force_encoding('UTF-8')
+    raw_text.gsub!("\xEF\xBB\xBF".force_encoding("UTF-8"), '') #Remove stupid BOM that was causing me so much grief!
+
+    #raw_text       = IO.read @sub_file
+    subtitle_parts = raw_text.split "#{@linebreak}#{@linebreak}"
+    @subtitles     = {}
+
+    subtitle_parts.each do |subtitle|
+      @subtitles.update extract_sub_data subtitle
+    end
+
+    # No longer needed due to removal of BOM
+    #fix_first_index   # What a hack :(
+    @parsed_ok = true # Not very useful, but will help when error checking is added
+  end
+
+  def shift(args)
+    first = args[:index] # used for checking first go round.
+    index = first
+    shift = args[:time]
+
+    if shift < 0 # backward shift check
+      time1 = @subtitles[first][:start] + shift
+      time2 = @subtitles[first-1][:end]
+      raise RuntimeError, 'Cannot overlap backward shift' if time2 > time1
+    end
+
+    loop do
+      break unless @subtitles.has_key?(index)
+
+      @subtitles[index][:start] += shift
+      @subtitles[index][:end]   += shift
+
+      index += 1
+    end
+  end
+
+  def to_s
+    raise RuntimeError, 'File has not been parsed yet' unless @parsed_ok
+
+    output = ''
+
+    @subtitles.sort.map do |index, sub| 
+      start = ms_to_srt_time sub[:start]
+      fin   = ms_to_srt_time sub[:end]
+
+      output += "#{index}#{@linebreak}#{start} #{TIME_SEPERATOR} #{fin}#{@linebreak}#{sub[:subtitle]}#{@linebreak}#{@linebreak}"
+    end
+
+    output.chomp
+  end
+
+  private
+
+  def extract_sub_data(subtitle)
+    s     = subtitle.split @linebreak
+    times = s[1].split " #{TIME_SEPERATOR} "
+
+    {s[0].to_i => {
+      start:    srt_time_to_ms(times[0]),
+      end:      srt_time_to_ms(times[1]),
+      subtitle: s[2..-1].join(@linebreak)
+      }
+    }
+  end
+
+  def srt_time_to_ms(srt_time)
+    time_parts = parse_srt_time srt_time
+
+    hours_ms = time_parts[:hours] * 60 * 60 * 1000
+    mins_ms  = time_parts[:mins]  * 60 * 1000
+    secs_ms  = time_parts[:secs]  * 1000
+
+    hours_ms + mins_ms + secs_ms + time_parts[:ms]
+  end
+
+  def ms_to_srt_time(ms)
+    hours   = (ms / (1000 * 60 *60)) % 60
+    minutes = (ms / (1000 * 60))     % 60
+    seconds = (ms / 1000)            % 60
+    adj_ms  = ms.to_s[-3..-1].to_i
+
+    "%02d:%02d:%02d,%03d" % [hours, minutes, seconds, adj_ms]
+  end
+
+  def parse_srt_time (srt_time)
+    # Time looks like: hh:mm:ss,ms
+    #              ... 10:09:08,756
+    /^(\d+):(\d+):(\d+),(\d+)$/ =~ srt_time
+
+    {hours: $1.to_i,
+     mins:  $2.to_i,
+     secs:  $3.to_i,
+     ms:    $4.to_i
+    }
+  end
+
+  # No longer needed due to fixing the BOM issue. But I'm leaving it in.
+  def fix_first_index
+    # This makes me feel *so* dirty :/
+    sub_arr = @subtitles.to_a
+    idx1    = sub_arr[0][0]
+    idx2    = sub_arr[1][0]
+
+    @subtitles[idx2 - 1] = @subtitles.delete idx1 # At least I learnt this trick :) How to rename a hash key
+  end
+end

data/test/The.Big.Bang.Theory.srt

@@ -0,0 +1,37 @@
+46
+00:02:53,610 --> 00:02:57,196
+♪ Our whole universe
+was in a hot, dense state ♪
+
+47
+00:02:57,198 --> 00:03:00,532
+♪ Then nearly 14 billion years
+ago expansion started... Wait! ♪
+
+48
+00:03:00,534 --> 00:03:02,184
+♪ The Earth began to cool ♪
+
+49
+00:03:02,186 --> 00:03:04,736
+♪ The autotrophs began to drool,
+Neanderthals developed tools ♪
+
+50
+00:03:04,738 --> 00:03:07,372
+♪ We built the Wall ♪
+♪ <i>We built the pyramids</i> ♪
+
+51
+00:03:07,374 --> 00:03:10,058
+♪ Math, Science, History,
+unraveling the mystery ♪
+
+52
+00:03:10,060 --> 00:03:11,960
+♪ That all started
+with a big bang ♪
+
+53
+00:03:11,962 --> 00:03:12,710
+♪ <i>Bang!</i> ♪

data/test/helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'minitest/spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'subtitle_shifter'
+
+MiniTest::Spec.autorun

data/test/subtitle_shifter_spec.rb

@@ -0,0 +1,106 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require 'minitest/spec'
+require 'minitest/autorun'
+
+require './lib/subtitle_shifter'
+
+describe SubtitleShifter do
+  it "should have a new method" do
+    SubtitleShifter.must_respond_to('new')
+  end
+
+  describe "parsing a subtitle file" do
+    srt = SubtitleShifter.new('./test/The.Big.Bang.Theory.srt')
+    srt.parse
+
+    it "should work with utf-8 files" do
+      srt.parsed_ok.must_equal true
+    end
+
+    it "should have some parsed data" do
+      first_sub = srt.subtitles[46]
+      first_sub.must_be_instance_of Hash
+
+      first_sub[:subtitle].must_equal  "♪ Our whole universe\r\nwas in a hot, dense state ♪"
+      first_sub[:start].must_equal     173610
+      first_sub[:end].must_equal       177196
+    end
+  end
+
+  describe "shifting subtitles" do
+    before(:each) do
+      @srt = SubtitleShifter.new('./test/The.Big.Bang.Theory.srt')
+      @srt.parse
+    end
+
+    describe "forward" do
+      it "should shift subtitles forward from an index" do
+        @srt.must_respond_to('shift')
+
+        shift = 2500
+        start = @srt.subtitles[50][:start]
+        fin   = @srt.subtitles[50][:end]
+
+        @srt.shift(:index => 50, :time => shift)
+        @srt.subtitles[50][:start].must_equal start+shift
+        @srt.subtitles[50][:end].must_equal   fin+shift
+      end
+
+      it "should affect all indexes till the end" do
+        # start = @srt
+        # 53 - s - 191962 e - 192710
+        @srt.shift(:index => 50, :time => 2500)
+        @srt.subtitles[53][:start].must_equal 194462
+        @srt.subtitles[53][:end].must_equal   195210
+      end
+    end
+
+    describe "backward" do
+      it "should shift subtitles backward from an index" do
+        # Test start of shift
+        @srt.shift(:index => 50, :time => -1)
+        @srt.subtitles[50][:start].must_equal 184737
+        @srt.subtitles[50][:end].must_equal   187371
+      end
+
+      it "should affect all indexes till the end" do
+        # start = @srt
+        # 53 - s - 191962 e - 192710
+        @srt.shift(:index => 50, :time => -1)
+        @srt.subtitles[53][:start].must_equal 191961
+        @srt.subtitles[53][:end].must_equal   192709
+      end
+
+      it "should raise an exception if shifted too far back" do
+        proc do
+          @srt.shift(:index => 50, :time => -2500)
+        end.must_raise RuntimeError
+      end
+    end
+  end
+
+  describe "outputting an srt file" do
+    before(:each) do
+      @srt = SubtitleShifter.new('./test/The.Big.Bang.Theory.srt')
+    end
+
+    it "should raise an exception if it hasn't been parsed yet" do
+      proc do
+        @srt.to_s
+      end.must_raise RuntimeError
+    end
+
+    it "should provide a string that is similar to the file when no shifting takes place" do
+      @srt.parse
+      @srt.to_s.must_equal "46\r\n00:02:53,610 --> 00:02:57,196\r\n♪ Our whole universe\r\nwas in a hot, dense state ♪\r\n\r\n47\r\n00:02:57,198 --> 00:03:00,532\r\n♪ Then nearly 14 billion years\r\nago expansion started... Wait! ♪\r\n\r\n48\r\n00:03:00,534 --> 00:03:02,184\r\n♪ The Earth began to cool ♪\r\n\r\n49\r\n00:03:02,186 --> 00:03:04,736\r\n♪ The autotrophs began to drool,\r\nNeanderthals developed tools ♪\r\n\r\n50\r\n00:03:04,738 --> 00:03:07,372\r\n♪ We built the Wall ♪\r\n♪ <i>We built the pyramids</i> ♪\r\n\r\n51\r\n00:03:07,374 --> 00:03:10,058\r\n♪ Math, Science, History,\r\nunraveling the mystery ♪\r\n\r\n52\r\n00:03:10,060 --> 00:03:11,960\r\n♪ That all started\r\nwith a big bang ♪\r\n\r\n53\r\n00:03:11,962 --> 00:03:12,710\r\n♪ <i>Bang!</i> ♪\r\n"
+    end
+
+    it "should provide a string that shows shifted times when a shift op occurs" do
+      @srt.parse
+      @srt.shift(:index => 50, :time => 2500)
+      @srt.to_s.must_equal "46\r\n00:02:53,610 --> 00:02:57,196\r\n♪ Our whole universe\r\nwas in a hot, dense state ♪\r\n\r\n47\r\n00:02:57,198 --> 00:03:00,532\r\n♪ Then nearly 14 billion years\r\nago expansion started... Wait! ♪\r\n\r\n48\r\n00:03:00,534 --> 00:03:02,184\r\n♪ The Earth began to cool ♪\r\n\r\n49\r\n00:03:02,186 --> 00:03:04,736\r\n♪ The autotrophs began to drool,\r\nNeanderthals developed tools ♪\r\n\r\n50\r\n00:03:07,238 --> 00:03:09,872\r\n♪ We built the Wall ♪\r\n♪ <i>We built the pyramids</i> ♪\r\n\r\n51\r\n00:03:09,874 --> 00:03:12,558\r\n♪ Math, Science, History,\r\nunraveling the mystery ♪\r\n\r\n52\r\n00:03:12,560 --> 00:03:14,460\r\n♪ That all started\r\nwith a big bang ♪\r\n\r\n53\r\n00:03:14,462 --> 00:03:15,210\r\n♪ <i>Bang!</i> ♪\r\n"
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: subtitle_shifter
+version: !ruby/object:Gem::Version
+  version: 1.0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Gabriel Fortuna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-13 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70285953842120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70285953842120
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70285953840700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70285953840700
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70285953839740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70285953839740
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70285953838260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70285953838260
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70285953837240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70285953837240
+description: A simple little gem for modifying SubRip subtitle files. Done as a mentoring
+  exercise with Citizen428, and taken from the Ruby Programming Challenge For Newbies
+email: gee.forr@gmail.com
+executables:
+- shift_subtitle
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/shift_subtitle
+- lib/.subtitle_shifter.rb.swp
+- lib/subtitle_shifter.rb
+- test/The.Big.Bang.Theory.srt
+- test/helper.rb
+- test/subtitle_shifter_spec.rb
+homepage: http://github.com/gee-forr/subtitle_shifter
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: A simple library for adjusting SubRip (.srt) subtitles
+test_files: []