thuss-shift_subtitle 0.2.0

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Todd Huss
+
+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,37 @@
+= shift_subtitle
+
+My submission for Ruby Challenge #1: Shift Subtitle
+
+http://rubylearning.com/blog/2009/09/24/rpcfn-shift-subtitle-1
+
+== Features
+* 100% RSpec[http://rspec.info/] test coverage of both lib/* and bin/*
+* Bundled as a github gem (thanks to Jeweler[http://github.com/technicalpickles/jeweler])
+* No external gem dependencies to use the gem
+* Command line related code in shift_subtitle_cli.rb and SubRib/SRT processing code in shift_subtitle.rb
+* shift_subtitle.rb uses IO streams (such as File and StringIO) to support processing large files
+* Time shifting handles boundary cases
+  * Lower boundary shifting 00:00:00,001 down by a second shifts to 00:00:00,000
+  * Shifting above the 24 hour boundary works fine (25, 26, 27 hours) and doesn't rollover back to 00 hours
+
+== Requirements
+
+You must have Github in your gem sources
+
+gem sources -a http://gems.github.com
+
+== Install
+
+sudo gem install thuss-shift_subtitle
+
+== Usage
+shift_subtitle --operation add --time 2,500 input output
+
+== Todo
+
+* Add a --version flag
+* Perhaps throw a warning if a subtraction shift results in the floor of 00:00:00,000
+
+== Copyright
+
+Copyright (c) 2009 Todd Huss. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "thuss-shift_subtitle"
+    gem.summary = %Q{Ruby Challenge #1: Shift Subtitle}
+    gem.description = %Q{Submission for the Ruby Challenge to create a command line tool to shift SubRib formatted movie subtitles}
+    gem.email = "thuss@gabrito.com"
+    gem.homepage = "http://github.com/thuss/shift_subtitle"
+    gem.authors = ["Todd Huss"]
+    gem.add_development_dependency "rspec"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler is not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+  spec.rcov_opts = ['--exclude', 'lib/spec,bin/spec,spec/*,rcov*']
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "shift_subtitle #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/bin/shift_subtitle

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2009-9-26.
+#  Copyright (c) 2009. All rights reserved.
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require "shift_subtitle_cli"
+
+ShiftSubtitleCli.new.execute(ARGV)

data/lib/shift_subtitle.rb

@@ -0,0 +1,33 @@
+require 'time'
+
+class ShiftSubtitle
+
+  # Takes an SRT IO stream (such as File) and shifts it by shift_seconds (e.g. -2.5)
+  def shift_srt(input_srt, output_srt, shift_seconds)
+    input_srt.each_line do | line |
+      srt_time_regex = /^(\d\d:\d\d:\d\d,\d\d\d)( --> )(\d\d:\d\d:\d\d,\d\d\d)/ 
+      if (line =~ srt_time_regex)
+        start_time = shift_timestamp($1, shift_seconds)
+        end_time = shift_timestamp($3, shift_seconds)
+        line.gsub!(srt_time_regex, start_time + $2 + end_time)        
+      end
+      output_srt.write line
+    end
+  end
+
+  # Takes an SRT timestamp ('01:01:23,500') and shifts it by shift seconds (-2.5)
+  def shift_timestamp(srt_time_string, shift_seconds)
+    if (srt_time_string =~ /(\d\d):(\d\d):(\d\d),(\d\d\d)/)
+      time = Time.parse('2000-01-01 ' + srt_time_string + 'UTC') + shift_seconds
+      hours = time.hour
+      case
+        when time.day == 31 then hours = 0; time = Time.at(0).utc # Never go below 00:00:00,000
+        when time.day > 1 then hours += (time.day - 1) * 24 # Support times > 23 hours
+      end
+      "#{'%02d'%hours}:#{'%02d'%time.min}:#{'%02d'%time.sec},#{'%03d'%(time.usec/1000)}"
+    else
+      raise ArgumentError, "unexpected SRT timestamp format " + srt_time_string
+    end
+  end
+
+end

data/lib/shift_subtitle_cli.rb

@@ -0,0 +1,59 @@
+require 'optparse'
+require 'shift_subtitle'
+
+class ShiftSubtitleCli < ShiftSubtitle
+  def execute(arguments)
+    begin
+      options = parse_options arguments
+      input_file = File.new options[:input_file], 'r'
+      output_file = File.new options[:output_file], 'w'
+      shift_srt input_file, output_file, time_to_shift(options)
+    ensure
+      input_file.close unless input_file.nil?
+      output_file.close unless output_file.nil?
+    end
+  end
+
+  def parse_options(arguments)
+    options = {}
+    mandatory_options = [ :operation, :seconds, :milliseconds, :input_file, :output_file ]
+    parser = OptionParser.new do |opts|
+      opts.banner = <<-BANNER.gsub(/^      /,'')
+      Shift Subtitle Ruby Challenge
+      
+      Usage: #{File.basename($0)} --operation [add|sub] --time [seconds,milliseconds] input_file output_file
+      
+      Options are:
+      BANNER
+      opts.separator ""
+
+      opts.on("-o", "--operation add|sub", [:add, :sub], "Add or Subtract time") do |operation|
+        options[:operation] = operation
+      end
+
+      opts.on("-t", "--time seconds,milliseconds", "Seconds AND milliseconds to add or subtract") do |time|
+        if (time =~ /\d+,\d+/)
+          options[:seconds], options[:milliseconds] = time.split(/,/).map!{ |t| t.to_i }
+        else
+          raise OptionParser::InvalidArgument, "should be seconds,milliseconds"
+        end
+      end
+
+      opts.on("-h", "--help", "Show this help message.") { puts opts; exit 0 }
+
+      opts.parse!(arguments)
+      options[:input_file], options[:output_file] = arguments.pop(2) 
+
+      if mandatory_options.find { |option| options[option].nil? } 
+        $stderr.puts opts; exit 1
+      end
+    end
+    options
+  end
+
+  # Converts the time and operation into a float (:sub 2,500 returns -2.5) 
+  def time_to_shift(options)
+    shift_time = options[:seconds].to_i + options[:milliseconds].to_f/1000
+    shift_time *= (options[:operation] == :sub)?-1:1
+  end
+end

data/shift_subtitle.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{shift_subtitle}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Todd Huss"]
+  s.date = %q{2009-10-03}
+  s.default_executable = %q{shift_subtitle}
+  s.description = %q{Submission for the Ruby Challenge to create a command line tool to shift SubRib formatted movie subtitles}
+  s.email = %q{thuss@gabrito.com}
+  s.executables = ["shift_subtitle"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/shift_subtitle",
+     "lib/shift_subtitle.rb",
+     "lib/shift_subtitle_cli.rb",
+     "shift_subtitle.gemspec",
+     "spec/shift_subtitle_cli_spec.rb",
+     "spec/shift_subtitle_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/thuss/shift_subtitle}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby Challenge #1: Shift Subtitle}
+  s.test_files = [
+    "spec/shift_subtitle_cli_spec.rb",
+     "spec/shift_subtitle_spec.rb",
+     "spec/spec_helper.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<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end

data/spec/shift_subtitle_cli_spec.rb

@@ -0,0 +1,89 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'shift_subtitle_cli'
+
+describe ShiftSubtitleCli do
+
+  before(:each) do
+    @cli = ShiftSubtitleCli.new
+  end
+  
+  describe "running bin/shift_subtitle" do
+    before :each do
+      Object.send(:remove_const, :ARGV)
+      input = StringIO.new("1\n00:00:24,600 --> 00:00:27,800\nthis is a test...")
+      @output = StringIO.new
+      File.stub!(:new).and_return(input, @output)
+    end
+
+    it "should shift the time when an SRT file is provided" do   
+      ARGV = ['--operation', 'sub', '--time', '2,500', 'infile', 'outfile']
+      eval File.read(File.join(File.dirname(__FILE__), '..', 'bin', 'shift_subtitle'))
+      @output.string.should eql("1\n00:00:22,100 --> 00:00:25,300\nthis is a test...")
+    end
+  end
+
+  it "should print help to stderr when no options are provided" do
+    output = capture_stderr do
+      lambda { @cli.parse_options([]) }.should raise_error(SystemExit)
+    end
+    output.should match(/Usage:/)
+  end
+  
+  it "should set the input_file and output_file in the options hash" do
+    options = @cli.parse_options(['--operation', 'add', '--time', '2,500', 'infile', 'outfile'])
+    options[:input_file].should eql('infile')
+    options[:output_file].should eql('outfile')
+  end
+  
+  it "should not allow a missing argument" do
+    args = ['--operation', 'add', '--time', '2,500', 'infile']
+    output = capture_stderr do
+      lambda { @cli.parse_options(args) }.should raise_error(SystemExit)
+    end
+  end
+  
+  it "should convert the operation, seconds, and milliseconds into a float of seconds to shift" do
+    options = @cli.parse_options(['--operation', 'sub', '--time', '2,500', 'infile', 'outfile'])
+    @cli.time_to_shift(options).should eql(-2.5)
+  end
+  
+  it "should convert unusually large millisecond values correctly" do
+    options = @cli.parse_options(['--operation', 'add', '--time', '2,5000', 'infile', 'outfile'])
+    @cli.time_to_shift(options).should eql(7.0)
+  end
+
+  describe "when the --operation argument is specified" do
+    it "should not allow an invalid operation" do
+      args = ['--operation', 'foo', '--time', '2,500', 'infile', 'outfile']
+      lambda { @cli.parse_options(args) }.should raise_error(OptionParser::InvalidArgument)
+    end
+
+    it "should allow the add operation and set the options hash" do
+      options = @cli.parse_options(['--operation', 'add', '--time', '2,500', 'infile', 'outfile'])
+      options[:operation].should eql(:add) 
+    end
+  end
+  
+  describe "when the --time argument is provided" do
+    it "should not allow an invalid time" do
+      args = ['--operation', 'add', '--time', 'XYZ', 'infile', 'outfile']
+      output = capture_stderr do
+        lambda { @cli.parse_options(args) }.should raise_error(OptionParser::InvalidArgument)
+      end
+    end
+
+    it "should parse a valid time and set the options hash" do
+      options = @cli.parse_options(['--operation', 'add', '--time', '2,500', 'infile', 'outfile'])
+      options[:seconds].should eql(2)
+      options[:milliseconds].should eql(500) 
+    end
+  end  
+  
+  def capture_stderr
+    $stderr = StringIO.new
+    yield
+    $stderr.string
+  ensure
+    $stderr = STDERR
+  end
+end

data/spec/shift_subtitle_spec.rb

@@ -0,0 +1,66 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe ShiftSubtitle do
+  before(:each) do
+    @shift_subtitle = ShiftSubtitle.new
+  end
+
+  describe "when shifting time" do
+    it "should raise an exception on invalid input" do
+      lambda { @shift_subtitle.shift_timestamp('X1:31:51,210', 0) }.should raise_error(ArgumentError)
+    end
+
+    it "should leave time unchanged when shifting by zero" do
+      @shift_subtitle.shift_timestamp('01:31:51,210', 0).should eql('01:31:51,210')
+    end
+
+    it "should add time" do
+      @shift_subtitle.shift_timestamp('01:31:51,210', 1.5).should eql('01:31:52,710')
+    end
+
+    it "should add time beyond the 24 hour boundary" do
+      @shift_subtitle.shift_timestamp('23:59:59,500', 1.5).should eql('24:00:01,000')
+    end
+
+    it "should subtract time" do
+      @shift_subtitle.shift_timestamp('01:31:51,210', -1.5).should eql('01:31:49,710')
+    end
+
+    it "should not subtract below zero" do
+      @shift_subtitle.shift_timestamp('00:00:01,000', -1.5).should eql('00:00:00,000')
+    end
+  end
+
+  describe "when processing srt input" do
+    before(:each) do
+      @input_srt = StringIO.new(<<-SRT.gsub(/^        /,'')
+        1
+        00:00:20,000 --> 00:00:24,400
+        In connection with a dramatic increase
+        in crime in certain neighbourhoods,
+
+        2 
+        00:00:24,600 --> 00:00:27,800 
+        the government is implementing a new policy...
+      SRT
+      )
+      @output_srt = StringIO.new
+    end
+
+    it "should output the shifted srt" do
+      @shift_subtitle.shift_srt(@input_srt, @output_srt, 1.5)
+      @output_srt.string.should eql(<<-SRTOUT.gsub(/^        /,'')
+        1
+        00:00:21,500 --> 00:00:25,900
+        In connection with a dramatic increase
+        in crime in certain neighbourhoods,
+
+        2 
+        00:00:26,100 --> 00:00:29,300 
+        the government is implementing a new policy...
+      SRTOUT
+      )
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'shift_subtitle'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: thuss-shift_subtitle
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Todd Huss
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-03 00:00:00 -07:00
+default_executable: shift_subtitle
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Submission for the Ruby Challenge to create a command line tool to shift SubRib formatted movie subtitles
+email: thuss@gabrito.com
+executables: 
+- shift_subtitle
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/shift_subtitle
+- lib/shift_subtitle.rb
+- lib/shift_subtitle_cli.rb
+- shift_subtitle.gemspec
+- spec/shift_subtitle_cli_spec.rb
+- spec/shift_subtitle_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/thuss/shift_subtitle
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: "Ruby Challenge #1: Shift Subtitle"
+test_files: 
+- spec/shift_subtitle_cli_spec.rb
+- spec/shift_subtitle_spec.rb
+- spec/spec_helper.rb