shift_subtitles 0.1.0

data/bin/shift_subtitles

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+require 'ruby-debug'
+require 'optparse'
+
+require File.dirname(__FILE__) + '/../lib/shift_subtitles'
+
+options = {}
+
+optparse = OptionParser.new do |opts|
+  options[:action] = nil
+  opts.on('--action OPERATION') { |action| options[:action] = action }
+
+  options[:time] = nil
+  opts.on('--time TIME') { |time| options[:time] = time }
+
+  options[:input] = nil
+  opts.on('--input INPUT') { |input| options[:input] = input }
+
+  options[:output] = nil
+  opts.on('--output OUTPUT') { |output| options[:output] = output }
+end
+
+optparse.parse!
+
+begin
+  ShiftSubtitles::Process.shift_subtitles(options)
+rescue => e
+  puts "OOPS! something went wrong......#{e.message}"
+else
+  puts 'Shift Subtitle successfully run. Welcome to AV heaven'  
+end

data/lib/shift_subtitles/core_ext/numeric.rb

@@ -0,0 +1,11 @@
+class Numeric
+  
+  def minutes_to_secs
+    self*60
+  end
+
+  def hours_to_secs
+    self*60*60
+  end
+    
+end

data/lib/shift_subtitles/file_helper.rb

@@ -0,0 +1,16 @@
+module ShiftSubtitles
+
+  module FileHelper
+
+    def self.operation_with_validation operation, file_name
+      raise("Please specify an #{operation} file") unless file_name
+      if operation == 'input'
+        raise("Please specify a valid #{operation} file") unless File.exists?(file_name)
+      end
+      yield      
+    end
+
+
+  end
+
+end

data/lib/shift_subtitles/operation.rb

@@ -0,0 +1,47 @@
+module ShiftSubtitles
+
+  class Operation
+
+    attr_reader :action, :time
+
+    def initialize action, time
+      @action = action_with_validation(action)
+      @time = time_with_validation(time)
+    end
+
+    def seconds_difference
+      case action
+      when "add" then return time_difference
+      when "subtract" then return negative_time_difference
+      end
+    end
+    
+    def action_with_validation action 
+      valid_action?(action) ? action : raise("Please specify either 'add' or 'subtract' as the operation")
+    end
+
+    def time_with_validation time
+      raise("Please specify a time to shift") unless time
+      raise("Please specify a valid time to shift") unless valid_time?(time)
+      time      
+    end
+
+    def valid_time? time
+      time =~ /\A[0-9]{2},[0-9]{3}\Z/
+    end
+    
+    def valid_action? action
+      action =~ /\A(add|subtract)\Z/
+    end
+
+    def time_difference
+      time.sub(',','.').to_f
+    end
+    
+    def negative_time_difference
+      -time_difference
+    end
+
+  end
+
+end

data/lib/shift_subtitles/process.rb

@@ -0,0 +1,20 @@
+module ShiftSubtitles
+
+  module Process
+
+    def self.shift_subtitles options
+      operation = ShiftSubtitles::Operation.new(options[:action], options[:time])
+      subtitles = ShiftSubtitles::Subtitles.new(options[:input])
+      subtitles.update_subtitles(operation.seconds_difference)
+      create_and_populate_output_file(options[:output], subtitles)
+    end
+
+    def self.create_and_populate_output_file output_file_name, subtitles
+      ShiftSubtitles::FileHelper.operation_with_validation('output', output_file_name) do 
+        File.open(output_file_name, 'w') { |file| file << subtitles.formatted_subtitles_for_file }
+      end
+    end
+
+  end
+
+end

data/lib/shift_subtitles/subtitle.rb

@@ -0,0 +1,36 @@
+require 'time'
+
+  module ShiftSubtitles
+
+  class Subtitle
+
+    attr_reader :index, :start_time, :end_time, :text
+
+    def initialize subtitle_string
+      subtitle_pattern =~ subtitle_string
+      @index, @start_time, @end_time, @text = $1, $2, $3, $4
+    end
+
+    def update_duration seconds_difference
+      @start_time = update_time(start_time, seconds_difference)
+      @end_time = update_time(end_time, seconds_difference)
+    end
+    
+    def update_time time_string, seconds_difference
+      time = Time.parse(time_string)
+      updated_time = Time.parse(time_string) + seconds_difference
+      raise("Please specify a legal time to shift, this will push the subs into negative values") if updated_time.day < time.day
+      updated_time.strftime("%H:%M:%S,%L")
+    end
+
+    def format
+      "#{index}\n#{start_time} --> #{end_time}\n#{text}\n\n"
+    end
+    
+    def subtitle_pattern
+      /([0-9]+)\n([0-9]{2}:[0-9]{2}:[0-9]{2},[0-9]{3}) --> ([0-9]{2}:[0-9]{2}:[0-9]{2},[0-9]{3})\n(.*)/      
+    end
+
+  end
+
+end

data/lib/shift_subtitles/subtitles.rb

@@ -0,0 +1,36 @@
+module ShiftSubtitles
+
+  class Subtitles
+
+    include Enumerable
+
+    attr_accessor :subtitle_list
+
+    def initialize input_file_path
+      input_file_subtitles = input_file_contents(input_file_path).scan(input_file_pattern)
+      @subtitle_list = input_file_subtitles.collect { |subtitle| ShiftSubtitles::Subtitle.new(subtitle) }
+    end
+
+    def each
+      @subtitle_list.each {|subtitle| yield(subtitle)}
+    end
+
+    def update_subtitles seconds_difference
+      each { |subtitle| subtitle.update_duration(seconds_difference) }
+    end
+
+    def formatted_subtitles_for_file
+      collect { |subtitle| subtitle.format }.join
+    end
+
+    def input_file_contents input_file_path
+      ShiftSubtitles::FileHelper.operation_with_validation('input', input_file_path) { File.read(input_file_path) }
+    end
+
+    def input_file_pattern
+      /[0-9]+\n[0-9]{2}:[0-9]{2}:[0-9]{2},[0-9]{3} --> [0-9]{2}:[0-9]{2}:[0-9]{2},[0-9]{3}\n.*/
+    end
+    
+  end
+
+end

data/lib/shift_subtitles.rb

@@ -0,0 +1,6 @@
+require File.dirname(__FILE__) + '/shift_subtitles/process'
+require File.dirname(__FILE__) + '/shift_subtitles/operation'
+require File.dirname(__FILE__) + '/shift_subtitles/subtitles'
+require File.dirname(__FILE__) + '/shift_subtitles/subtitle'
+require File.dirname(__FILE__) + '/shift_subtitles/file_helper'
+require File.dirname(__FILE__) + '/shift_subtitles/core_ext/numeric'

data/spec/shift_subtitles/core_ext/numeric_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Numeric do
+  
+  it "converts a 1 minute into 60 seconds" do
+    1.minutes_to_secs.should == 60
+  end
+  
+  it "converts a 1 hour into 3600 seconds" do
+    1.hours_to_secs.should == 3600
+  end
+  
+end

data/spec/shift_subtitles/file_helper_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe ShiftSubtitles::FileHelper do
+  
+  before(:each) do
+    @block = lambda { 'yielded_value' }    
+  end
+
+  context "output file" do
+
+    it "yields the block when a file_name & block are passed in" do
+      File.should_not_receive(:exists?)
+      yielded_value = ShiftSubtitles::FileHelper.operation_with_validation('output', 'filename.txt', &@block)
+      yielded_value.should == 'yielded_value'    
+    end
+
+    it "raises a invalid file error when no file_name & block are passed in" do
+      File.should_not_receive(:exists?)
+      lambda { ShiftSubtitles::FileHelper.operation_with_validation('output', nil, &@block) }.should raise_error("Please specify an output file")
+    end
+
+  end
+  
+  context "input file" do
+    
+    it "yields the block when a file_name & block are passed in" do
+      File.should_receive(:exists?).with('filename.txt').and_return(true)
+      yielded_value = ShiftSubtitles::FileHelper.operation_with_validation('input', 'filename.txt', &@block)
+      yielded_value.should == 'yielded_value'    
+    end
+    
+    it "raises a invalid file error when no file_name is passed in" do
+      File.should_not_receive(:exists?)
+      lambda { ShiftSubtitles::FileHelper.operation_with_validation('input', nil, &@block) }.should raise_error("Please specify an input file")
+    end
+
+    it "raises a file doesn't exist error when an invalid file_name is passed in" do
+      File.should_receive(:exists?).with('invalid.txt').and_return(false)
+      lambda { ShiftSubtitles::FileHelper.operation_with_validation('input', 'invalid.txt', &@block) }.should raise_error("Please specify a valid input file")
+    end
+    
+  end
+
+end
+

data/spec/shift_subtitles/operation_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe ShiftSubtitles::Operation do
+
+  context "operation adds 2 seconds" do
+
+    before(:each) do    
+      @operation = ShiftSubtitles::Operation.new('add', '02,000')
+    end
+
+    it "sets the action on initialization" do
+      @operation.action.should == 'add'    
+    end
+
+    it "sets the time on initialization" do
+      @operation.time.should == '02,000'    
+    end
+
+    it "converts the time and action to a float of the amount of seconds to change" do
+      @operation.seconds_difference.should == 2.0
+    end
+
+  end
+
+  context "operation subtracts 1.5 seconds" do
+
+    before(:each) do
+      @operation = ShiftSubtitles::Operation.new('subtract', '01,500')
+    end
+
+    it "converts the time and action to a float of the amount of seconds to change" do
+      @operation.seconds_difference.should == -1.5
+    end
+
+  end
+  
+  context "invalid scenarios" do
+    
+    it "no time is passed in on initialization raises an error" do
+      lambda { @operation = ShiftSubtitles::Operation.new('subtract', nil) }.should raise_error("Please specify a time to shift")
+    end
+    
+    it "invalid time is passed in on initialization raises an error" do
+      lambda { @operation = ShiftSubtitles::Operation.new('subtract', 'rogue-time') }.should raise_error("Please specify a valid time to shift")
+    end
+    
+    it "invalid time is passed in on initialization raises an error" do
+      lambda { @operation = ShiftSubtitles::Operation.new('subtract', '111,889') }.should raise_error("Please specify a valid time to shift")
+    end
+
+    it "invalid time is passed in on initialization raises an error" do
+      lambda { @operation = ShiftSubtitles::Operation.new('ssubtractt', '02,222') }.should raise_error("Please specify either 'add' or 'subtract' as the operation")
+    end
+  
+  end
+
+end

data/spec/shift_subtitles/process_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe ShiftSubtitles::Process do
+
+  context "valid input" do
+
+    it "reads in the output file name and creates the file" do
+      options = {:action => "add", :time => "2,000", :input => "input.srt", :output => "output.srt"}
+      mock_operation = mock(ShiftSubtitles::Operation, :seconds_difference => 2.0)
+      mock_subtitles = mock(ShiftSubtitles::Subtitles, :formatted_subtitles => 'formatted_subtitles')
+      ShiftSubtitles::Operation.should_receive(:new).with("add", "2,000").and_return(mock_operation)
+      ShiftSubtitles::Subtitles.should_receive(:new).with("input.srt").and_return(mock_subtitles)      
+      file_block = lambda { File.open(options[:output], 'w') { |file| file << mock_subtitles.formatted_subtitles_for_file } }      
+      ShiftSubtitles::FileHelper.should_receive(:operation_with_validation).with('output', options[:output], &file_block)
+      mock_subtitles.should_receive(:update_subtitles).with(2.0)    
+      mock_operation.should_receive(:seconds_difference).with()
+      mock_subtitles.should_receive(:formatted_subtitles_for_file).with()
+      ShiftSubtitles::Process.shift_subtitles(options)
+    end
+
+  end
+
+  context "invalid input" do
+
+    it "fails when no output file is specified" do    
+      options = {:action => "add", :time => "2,000", :input => "input.srt"}
+      mock_operation = mock(ShiftSubtitles::Operation, :seconds_difference => 2.0)
+      mock_subtitles = mock(ShiftSubtitles::Subtitles)
+      ShiftSubtitles::Operation.should_receive(:new).with("add", "2,000").and_return(mock_operation)
+      ShiftSubtitles::Subtitles.should_receive(:new).with("input.srt").and_return(mock_subtitles)    
+      file_block = lambda { File.open(nil, 'w') { |file| file << mock_subtitles.formatted_subtitles_for_file } }      
+      ShiftSubtitles::FileHelper.should_receive(:operation_with_validation).with('output', nil, &file_block)
+      mock_subtitles.should_receive(:update_subtitles).with(2.0)    
+      mock_operation.should_receive(:seconds_difference).with()
+      mock_subtitles.should_not_receive(:formatted_subtitles_for_file)
+
+      lambda { ShiftSubtitles::Process.shift_subtitles(options) }.should raise_error
+    end
+
+  end
+
+end

data/spec/shift_subtitles/subtitle_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe ShiftSubtitles::Subtitle do
+
+  context "valid subtitle" do
+
+    before(:each) do
+      @subtitle = ShiftSubtitles::Subtitle.new("1\n01:31:51,210 --> 01:31:54,893\ntext")    
+    end
+
+    it "sets an index on initialization" do
+      @subtitle.index.should == '1'
+    end
+
+    it "sets the start_time on initialization" do
+      @subtitle.start_time.should == '01:31:51,210'
+    end
+
+    it "sets the end_time on initialization" do
+      @subtitle.end_time.should == '01:31:54,893'
+    end
+
+    it "sets the text on initialization" do
+      @subtitle.text.should == 'text'
+    end
+
+    it "adds 2 seconds to the start_time and end_time" do
+      seconds_difference = 2.0
+      @subtitle.update_duration(seconds_difference)
+      @subtitle.start_time.should == '01:31:53,210'
+      @subtitle.end_time.should == '01:31:56,893'
+    end
+
+    it "subtracts 1.5 seconds to the start_time and end_time" do
+      seconds_difference = -1.5
+      @subtitle.update_duration(seconds_difference)
+      @subtitle.start_time.should == '01:31:49,710'
+      @subtitle.end_time.should == '01:31:53,393'
+    end
+
+    it "formats index, start_time, end_time, text for output" do
+      formatted_subtitle = @subtitle.format
+      formatted_subtitle.should == "1\n01:31:51,210 --> 01:31:54,893\ntext\n\n"
+    end
+
+  end
+
+  context "valid subtitle with illegal seconds difference" do
+
+    it "raises an error for negative times" do
+      @subtitle = ShiftSubtitles::Subtitle.new("1\n00:00:01,210 --> 00:00:01,893\ntext")
+      seconds_difference = -3.0
+      lambda { @subtitle.update_duration(seconds_difference) }.should raise_error("Please specify a legal time to shift, this will push the subs into negative values")
+    end  
+
+  end
+
+end

data/spec/shift_subtitles/subtitles_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe ShiftSubtitles::Subtitles do
+
+  context "a file with 1 subtitle is input" do
+
+    before(:each) do
+      input_file_contents = "1\n01:31:51,210 --> 01:31:54,893\ntext"
+      @mock_subtitle = mock(ShiftSubtitles::Subtitle)
+      @seconds_difference = 2.0
+      File.should_receive(:read).with('input.srt').and_return(input_file_contents)      
+      file_block = lambda { File.read('input.srt') }
+      ShiftSubtitles::FileHelper.should_receive(:operation_with_validation).with('input', 'input.srt', &file_block)
+      ShiftSubtitles::Subtitle.should_receive(:new).once.with("1\n01:31:51,210 --> 01:31:54,893\ntext").and_return(@mock_subtitle)
+      @subtitles = ShiftSubtitles::Subtitles.new('input.srt') 
+    end
+
+    it "is initialized with a file containing 1 subtitle" do
+      @subtitles.subtitle_list.count.should == 1    
+    end
+
+    it "includes the Enumerable each method to access the subtitle_list" do
+      @subtitles.count.should == 1
+    end
+
+    it "updates each subtitle using the Operation" do
+      @mock_subtitle.should_receive(:update_duration).with(@seconds_difference)
+      updated_subtitles = @subtitles.update_subtitles(@seconds_difference)
+    end
+
+    it "formats the subtitles for output" do
+      @mock_subtitle.should_receive(:format).once.and_return("1\n01:31:51,210 --> 01:31:54,893\ntext\n\n")
+      formatted_subtitles = @subtitles.formatted_subtitles_for_file
+      formatted_subtitles.should == "1\n01:31:51,210 --> 01:31:54,893\ntext\n\n"
+    end
+
+  end
+
+  context "a file with 2 subtitles is input" do
+
+    before(:each) do
+      input_file_contents = "1\n01:31:51,210 --> 01:31:54,893\ntext\n\n2\n01:31:54,210 --> 01:31:57,893\nmore text\n\n\n"
+      @mock_subtitle = mock(ShiftSubtitles::Subtitle)
+      @seconds_difference = 2.0
+      File.should_receive(:read).with('input.srt').and_return(input_file_contents)
+      file_block = lambda { File.read('input.srt') }
+      ShiftSubtitles::FileHelper.should_receive(:operation_with_validation).with('input', 'input.srt', &file_block)
+      ShiftSubtitles::Subtitle.should_receive(:new).once.with("1\n01:31:51,210 --> 01:31:54,893\ntext").and_return(@mock_subtitle)
+      ShiftSubtitles::Subtitle.should_receive(:new).once.with("2\n01:31:54,210 --> 01:31:57,893\nmore text").and_return(@mock_subtitle)
+      @subtitles = ShiftSubtitles::Subtitles.new('input.srt') 
+    end
+
+    it "is initialized with a file containing 2 subtitles" do
+      @subtitles.subtitle_list.count.should == 2    
+    end
+
+  end
+  
+  context "invalid input file" do
+
+    it "is initialized with no file" do
+      ShiftSubtitles::FileHelper.should_receive(:operation_with_validation).and_raise
+      lambda { ShiftSubtitles::Subtitles.new(nil) }.should raise_error
+    end
+    
+    it "is initialized with an invalid filename" do
+      ShiftSubtitles::FileHelper.should_receive(:operation_with_validation).and_raise
+      lambda { ShiftSubtitles::Subtitles.new('dud') }.should raise_error    
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require File.dirname(__FILE__) + '/../lib/shift_subtitles'
+
+RSpec.configure do |config|  
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.color_enabled = true  
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: shift_subtitles
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- James Shipton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-31 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.6"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: aruba
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.4.6
+  type: :development
+  version_requirements: *id003
+description: "Shift Subtitles - Ruby Learning Challenge #1"
+email: 
+- ionysis@gmail.com
+executables: 
+- shift_subtitles
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/shift_subtitles/core_ext/numeric.rb
+- lib/shift_subtitles/file_helper.rb
+- lib/shift_subtitles/operation.rb
+- lib/shift_subtitles/process.rb
+- lib/shift_subtitles/subtitle.rb
+- lib/shift_subtitles/subtitles.rb
+- lib/shift_subtitles.rb
+- spec/shift_subtitles/core_ext/numeric_spec.rb
+- spec/shift_subtitles/file_helper_spec.rb
+- spec/shift_subtitles/operation_spec.rb
+- spec/shift_subtitles/process_spec.rb
+- spec/shift_subtitles/subtitle_spec.rb
+- spec/shift_subtitles/subtitles_spec.rb
+- spec/spec_helper.rb
+- bin/shift_subtitles
+has_rdoc: true
+homepage: https://github.com/jamesshipton/quizzes/shift_subtitles
+licenses: []
+
+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.6.2
+signing_key: 
+specification_version: 3
+summary: "Shift Subtitles - Ruby Learning Challenge #1"
+test_files: 
+- spec/shift_subtitles/core_ext/numeric_spec.rb
+- spec/shift_subtitles/file_helper_spec.rb
+- spec/shift_subtitles/operation_spec.rb
+- spec/shift_subtitles/process_spec.rb
+- spec/shift_subtitles/subtitle_spec.rb
+- spec/shift_subtitles/subtitles_spec.rb
+- spec/spec_helper.rb