srt-shell 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 451374bce528e8072d296659b7b80776094761da
+  data.tar.gz: 05bc3f85cce7d283c7a04204f6ffb3e4db81054f
+SHA512:
+  metadata.gz: 0508c7547e778cee210482dfd5e9d88afb0cebd7edff39fa77649e7710db1fde4ec32fef18bb5697987f5d14a90a03b18206e266d7f09b4f3f51f9e249d3a1d1
+  data.tar.gz: 4122c0f3beaa7f290f98692ac87c5acdd6656011c5ced75dacb94da6cd5f4168b78cf5dc364be8c388f20ab312ea44b0518a7270ac1d7a763a7baee7042eb970

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in srt-shell.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 skliew
+
+MIT License
+
+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.md

@@ -0,0 +1,69 @@
+# SRT::Shell
+
+An interactive shell to retime SRT files.
+
+## Installation
+
+For now you can only install this by cloning the repo, and then run the following commands:
+
+```shell
+bundle install
+rake install
+```
+## Usage
+
+Start the shell with the command:
+
+```shell
+srt-shell
+```
+
+You could also optionally pass in an SRT file's path as an argument:
+```shell
+srt-shell file.srt
+```
+
+## Commands
+
+In the shell, the commands available will be shown with the 'help' command:
+```shell
+help
+```
+
+#### load '[filename]'
+Load an SRT file.
+
+### exit
+Exit the shell
+
+###### The following commands can only be used when we already have an SRT file loaded.
+###### Do note that all indexes start from 1, not 0.
+
+#### interval [time in ms]
+This would scan the SRT file for time gaps larger than the given time in ms. This is useful to search for indexes to be used with the time-shifting commands.
+
+#### upshift|u [index] [time in ms]
+Rewind the given time in ms for lines from index onwards.
+
+#### forward|f [index] [time in ms]
+Forward the given time in ms for lines from index onwards.
+
+#### remove [index]
+Remove line with the given index
+
+#### save
+Save (overwrite) the SRT file. You can place an executable file in $HOME/.srt_shell_hook to be executed when 'save' is used.
+
+#### search [word]
+Search for the given word in the SRT file and print out the entries that contain the word.
+
+## Platform
+I've only tested this on Linux because it's the only machine I have.
+
+## Contributing
+
+1. Fork it ( https://github.com/skliew/srt-shell/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+desc 'Run tests'
+task :test do |t|
+  sh 'rspec -Ilib -I. test/spec_*.rb'
+end
+

data/bin/srt-shell

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require 'srt/shell'
+require 'readline'
+
+WORDS = %w( load interval upshift u forward f remove save show s search help h exit )
+DEFAULT_WORD_BREAK_CHARS = " \t\n\"\\'`@$><=;|&{("
+FILENAME_WORD_BREAK_CHARS = "\t\n\"\\'`@$><=;|&{"
+
+Readline.completion_proc = lambda do |word|
+  Readline.completer_word_break_characters = DEFAULT_WORD_BREAK_CHARS
+  buffer = Readline.line_buffer.chomp
+
+  if buffer.match(/^\s*load\s+/)
+    Readline.completer_word_break_characters = FILENAME_WORD_BREAK_CHARS
+    return Readline::FILENAME_COMPLETION_PROC.call(word)
+  end
+
+  return [] if WORDS.find { |w| buffer.match(/^\s*#{w}\s+/) }
+  WORDS.grep(/^#{Regexp.escape(word)}/)
+end
+
+Signal.trap('INT') do
+  puts "Caught SIGINT, exiting..."
+  exit 0
+end
+shell = SRT::Shell.new(ARGV[0])
+
+loop do
+  line = Readline.readline('> ', true)
+  shell.eval_command(line.chomp)
+end
+

data/lib/srt/patches.rb

@@ -0,0 +1,7 @@
+module SRT
+  class Line
+    def to_s(time_str_function=:time_str)
+      [sequence, (display_coordinates ? send(time_str_function) + display_coordinates : send(time_str_function)), text, ''].flatten.join("\n")
+    end
+  end
+end

data/lib/srt/shell/version.rb

@@ -0,0 +1,5 @@
+module SRT
+  class Shell
+    VERSION = "0.0.1"
+  end
+end

data/lib/srt/shell.rb

@@ -0,0 +1,181 @@
+# encoding: utf-8
+require 'srt/shell/version'
+require 'srt'
+require 'srt/patches'
+
+module SRT
+  class Shell
+    SAVE_HOOK_FILE = ::File.expand_path('~/.srt_shell_hook')
+    BOM_STRING = "\xEF\xBB\xBF"
+    BOM_REGEX = /#{BOM_STRING}/
+    USAGE_MSG = <<USAGE
+Usage: #{$0} [SRT_FILENAME]
+    Commands:
+        EX: load 'SRT_FILENAME'
+        EX: interval 90
+        EX: upshift|u 50 5000
+        EX: forward|f 50 5000
+        EX: remove 50
+        EX: save
+        EX: show|s 50
+        EX: search TERM
+        EX: help|h
+        EX: exit
+USAGE
+
+    def initialize(path = nil, save_hook=SAVE_HOOK_FILE)
+      @file, @path = nil, nil
+      @bom = false
+      load_path(path) if path
+      @save_hook = ::File.exists?(save_hook) ? save_hook : nil
+    end
+
+    def load_path(path)
+      path = ::File.expand_path(path)
+      @path = path
+
+      # Test if file contains BOM
+      ::File.open(path) do |file|
+        lines = file.read.split("\n")
+        unless lines.empty?
+          if lines[0].match(BOM_REGEX)
+            lines[0].sub!(BOM_REGEX, '')
+            @bom = true
+          end
+          @file = SRT::File.parse(lines.join("\n"))
+        else
+          raise ArgumentError, 'Invalid SRT file'
+        end
+      end
+      self
+    end
+
+    def show(index)
+      check_index(index)
+      puts @file.lines[index - 1].to_s + "\n"
+    rescue IndexError => error
+      puts error.message
+    end
+
+    def timeshift(index, timecode)
+      check_index(index)
+      if time = Parser.timespan(timecode)
+        @file.lines[index-1..-1].each do |line|
+          line.start_time += time
+          line.end_time += time
+        end
+      else
+        puts "Invalid timeshift input (#{index}, #{timecode})"
+      end
+    rescue IndexError => error
+      puts error.message
+    end
+
+    def rewind(index, time)
+      timeshift(index, "-#{time}ms")
+    end
+
+    def forward(index, time)
+      timeshift(index, "+#{time}ms")
+    end
+
+    def scan_interval(input_time)
+      unless time = Parser.timespan("#{input_time}ms")
+        puts "Invalid time used #{input_time}"
+        return
+      end
+      end_time = 0
+      result = []
+      @file.lines.each do |line|
+        interval = line.start_time - end_time
+        if interval >= time
+          result << "index: #{line.sequence} time: #{line.time_str} gap: #{interval}"
+        end
+        end_time = line.end_time
+      end
+      puts result.join("\n")
+    end
+
+    def remove(index)
+      check_index(index)
+      index -= 1
+      @file.lines.delete_at(index)
+      @file.lines[index..-1].each do |line|
+        line.sequence -= 1
+      end
+    rescue IndexError => error
+      puts error.message
+    end
+
+    def search(term)
+      result = []
+      @file.lines.each do |line|
+        if line.text.find { |text| text[term] }
+          result << line.to_s
+        end
+      end
+      puts result.join("\n") + "\n"
+    end
+
+    def show_all
+      puts @file
+    end
+
+    def save(path=@path)
+      ::File.open(path, 'w') do |file|
+        file.print BOM_STRING if @bom
+        file.print @file.to_s.split("\n").join("\r\n"), "\r\n\r\n"
+      end
+      if @save_hook
+        output = `sh #{@save_hook}`
+        puts output unless output.empty?
+      end
+    end
+
+    def eval_command(cmd)
+      case cmd
+      when /^\s*(?:help|h)\s*$/
+        puts USAGE_MSG
+        return
+      when /^\s*exit\s*$/
+        exit 0
+      when /^\s*load\s+\'?([^']+)\'?\s*$/
+        load_path($1)
+        return
+      end
+
+      if @file
+        case cmd
+        when /^\s*(?:show|s)\s+(\d+)\s*$/
+          show($1.to_i)
+        when /^\s*(?:showall)\s*$/
+          show_all
+        when /^\s*interval\s+(\d+)\s*$/
+          scan_interval($1.to_i)
+        when /^\s*(?:u|rewind)\s+(\d+)\s+(\d+)\s*$/
+          rewind($1.to_i, $2.to_i)
+        when /^\s*(?:f|forward)\s+(\d+)\s+(\d+)\s*$/
+          forward($1.to_i, $2.to_i)
+        when /^\s*(?:remove)\s+(\d+)\s*$/
+          remove($1.to_i)
+        when /^\s*save\s*$/
+          save
+        when /^\s*search\s*(.*)$/
+          search($1)
+        else
+          puts "Invalid command"
+        end
+      else
+        puts "File is not loaded. Load a file using the 'load' command"
+      end
+    end
+
+    private
+
+    def check_index(index)
+      if index < 1
+        raise IndexError, "Invalid index given, index must be more than 0"
+      end
+    end
+  end
+end

data/srt-shell.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'srt/shell/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "srt-shell"
+  spec.version       = SRT::Shell::VERSION
+  spec.authors       = ["skliew"]
+  spec.email         = ["skliew@gmail.com"]
+  spec.summary       = %q{An interactive shell to retime SRT files.}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.9"
+
+  spec.add_runtime_dependency "srt", "~> 0.1"
+end

data/test/fixtures/sample.srt

@@ -0,0 +1,21 @@
+1
+00:03:55,339 --> 00:03:57,236
+I had the craziest dream last night.
+
+2
+00:03:59,679 --> 00:04:01,586
+I was dancing the White Swan.
+
+3
+00:04:03,346 --> 00:04:06,552
+It was different choreography, though.
+It was more like the Bolshoi's.
+
+4
+00:04:10,566 --> 00:04:12,193
+It was the prologue,
+
+5
+00:04:12,228 --> 00:04:15,015
+when Rothbart casts his spell.
+

data/test/fixtures/save_hook

@@ -0,0 +1 @@
+echo "Saved"

data/test/helper.rb

@@ -0,0 +1,4 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'srt/shell'

data/test/spec_shell.rb

@@ -0,0 +1,91 @@
+require File.join(File.dirname(__FILE__), 'helper')
+
+describe SRT::Shell do
+  before do
+    @app = SRT::Shell.new(
+      File.dirname(__FILE__) + '/fixtures/sample.srt',
+      File.dirname(__FILE__) + '/fixtures/save_hook'
+    )
+  end
+
+  it "should return a SRT::Shell" do
+    expect(@app.class).to eq(SRT::Shell)
+  end
+
+  it "should load a file" do
+    expect{ @app.load_path(File.dirname(__FILE__) + '/fixtures/sample.srt') }.to_not raise_error(Exception)
+
+  end
+
+  it 'should print out its USAGE' do
+    expect(STDOUT).to receive(:puts).with(SRT::Shell::USAGE_MSG)
+    @app.eval_command('help')
+  end
+
+  describe "With a loaded SRT file" do
+    it "should show a line" do
+      expect(STDOUT).to receive(:puts).with(
+        "1\n00:03:55,339 --> 00:03:57,236\nI had the craziest dream last night.\n\n"
+      )
+      @app.eval_command('show 1')
+    end
+
+    it "should forward SRT file's time" do
+      @app.eval_command('forward 1 1')
+      expect(STDOUT).to receive(:puts).with(
+        "1\n00:03:55,340 --> 00:03:57,237\nI had the craziest dream last night.\n\n"
+      )
+      @app.eval_command('show 1')
+    end
+
+    it "should rewind SRT file's time" do
+      @app.eval_command('rewind 1 1')
+      expect(STDOUT).to receive(:puts).with(
+        "1\n00:03:55,338 --> 00:03:57,235\nI had the craziest dream last night.\n\n"
+      )
+      @app.eval_command('show 1')
+    end
+
+    it "should show a message when an invalid index is used for rewind/forward" do
+      expect(STDOUT).to receive(:puts).with(/Invalid/)
+      @app.eval_command('rewind 0  1')
+    end
+
+    it "should scan for lines' interval" do
+      expect(STDOUT).to receive(:puts).with(
+"index: 1 time: 00:03:55,339 --> 00:03:57,236 gap: 235.339\nindex: 4 time: 00:04:10,566 --> 00:04:12,193 gap: 4.01400000000001"
+      )
+      @app.eval_command('interval 3000')
+    end
+
+    it "should remove a line from SRT::File" do
+      @app.eval_command('remove 1')
+      expect(STDOUT).to receive(:puts).with(
+<<OUT
+1
+00:03:59,679 --> 00:04:01,586
+I was dancing the White Swan.
+
+OUT
+      )
+      @app.eval_command('show 1')
+    end
+
+    it "should return the lines containing the searched term" do
+      expect(STDOUT).to receive(:puts).with(
+<<OUT
+2
+00:03:59,679 --> 00:04:01,586
+I was dancing the White Swan.
+
+OUT
+      )
+      @app.eval_command('search dancing')
+    end
+
+    it "should save and trigger its hook" do
+      expect(STDOUT).to receive(:puts).with("Saved\n")
+      @app.save
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: srt-shell
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- skliew
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: srt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: ''
+email:
+- skliew@gmail.com
+executables:
+- srt-shell
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/srt-shell
+- lib/srt/patches.rb
+- lib/srt/shell.rb
+- lib/srt/shell/version.rb
+- srt-shell.gemspec
+- test/fixtures/sample.srt
+- test/fixtures/save_hook
+- test/helper.rb
+- test/spec_shell.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: An interactive shell to retime SRT files.
+test_files:
+- test/fixtures/sample.srt
+- test/fixtures/save_hook
+- test/helper.rb
+- test/spec_shell.rb