srt_subtitle_validator 0.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76cc266523c735a5fb9a42a316b50100d589a02188590dff783924a4738abb1f
+  data.tar.gz: 351be1177c397d13ff9b6e5c26c4e61de2f25c227eb84824ebc1e25cd95b5d25
+SHA512:
+  metadata.gz: 870c37daededdda8ebc614c8f2dcef8bf07b4253e3ff98f783eb452e366523e70e1994264b011994440b0376979b0dfbb801896ad46ecbdcfcc7c3f4de077d3d
+  data.tar.gz: b679b8d97f323a55cd95dc1e4374edd82ffe48e4bfa4ed350756a140e5a82b0be4b045edb863b8c5be90b553f4d3b605a8a1e48c2fcfe73455f54097c8e489f9

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Lukáš Pokorný
+
+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,38 @@
+# SRT subtitle validator & converter
+
+Check SRT file and try to fix it.
+
+* Convert to UTF-8
+* Convert line-endings to UNIX/Linux
+* Recreate number counter sequence
+
+## Why?
+Because in my case Plex server & TV doesn't show subtitle correctly.
+
+## Installation
+```ruby
+gem install 'srt_subtitle_validator'
+```
+
+## Usage
+
+* Process files are overwritten with results. 
+* For all processed files are created backup.
+
+
+### For analyze
+```
+srt_checker check <path to SRT file(s)>
+```
+
+### For direct convert
+```
+srt_checker convert <path to SRT file(s)>
+```
+
+### General options
+`--output, -o` : Specify output directory of file. By default its same as input
+
+`--without_backup` : Skip creating backup files.
+
+`--encoding, -e` : Encoding of input file. By default it's windows-1250

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/srt_checker

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+lib = File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH.unshift(lib) if !$LOAD_PATH.include?(lib)
+
+require 'srt_subtitle_validator/cli'

data/lib/srt_subtitle_validator/cli.rb

@@ -0,0 +1,57 @@
+require 'srt_subtitle_validator'
+require 'thor'
+require 'logger'
+
+if %w(--version -v).include?(ARGV.first)
+  puts "Srt Subtitle Validator #{SrtSubtitleValidator::VERSION}"
+  exit(0)
+end
+module SrtSubtitleValidator
+  class Cli < Thor
+
+    class_option :version, type: :boolean, aliases: '-v', group: :main,
+                 desc: 'Show version number and quit'
+
+    def self.srt_default_options
+      method_option :without_backup, :default => false, :type => :boolean, :desc => 'Skip backuping original SRT file'
+      method_option :output, :aliases => '-o', :default => nil, :type => :string, :desc => 'Output directory (file)'
+      method_option :encoding, :aliases => '-e', :default => Encoding::CP1250, :type => :string, :desc => 'Output directory (file)'
+    end
+
+    srt_default_options
+    desc 'check', 'Check SRT file. '
+
+    def check(*files)
+      files_to_convert = Array.new
+      Array(files).each do |file|
+        validator = SrtSubtitleValidator::Validator.new(file)
+        say("\n == #{validator.file_name} -> ")
+        if validator.valid?
+          say 'SRT file is valid', :green
+        else
+          say 'SRT file is invalid, with following errors: ', :red, true
+          validator.srt.errors.each { |e| say "* #{e}" }
+          files_to_convert << validator
+        end
+      end
+      if files_to_convert.any? && yes?("Try to convert  #{files_to_convert.length} files ?")
+        files_to_convert.each{|f| f.convert_srt(options[:output], options[:without_backup])}
+      end
+
+    end
+
+    srt_default_options
+    desc 'convert', 'Check files and fix them if needed'
+
+    def convert(*files)
+      Array(files).each do |file|
+        validator = SrtSubtitleValidator::Validator.new(file)
+        unless validator.valid?
+          validator.convert_srt(options[:output], options[:without_backup])
+        end
+      end
+    end
+
+  end
+end
+SrtSubtitleValidator::Cli.start

data/lib/srt_subtitle_validator/srt_file.rb

@@ -0,0 +1,43 @@
+module SrtSubtitleValidator
+  class SrtFile
+    attr_reader :blocks, :length
+    attr_accessor :errors
+    def initialize(source, logger = nil)
+      @logger = logger || Logger.new(STDOUT)
+      @errors = Array.new
+      x = source.dup.encode(Encoding::UTF_8).gsub(/\r/, '')
+      @srt_dialog_blocks = Hash.new
+      @blocks = x.split(/^\r?\n+/m).map { |n| i = SrtBlock.new(n); @srt_dialog_blocks[i.dialog_number] = i; i }
+      @length = !@blocks.empty? && @blocks.last.dialog_number || 0
+      @errors << 'File is zero size' if @length.zero?
+    end
+
+    def valid?
+      unless @blocks.count == @length
+        @errors << 'Numbers sequence is corrupted'
+      end
+      @errors.empty?
+    end
+
+    class SrtBlock
+      attr_accessor :dialog_number, :dialog_time, :dialog_text
+      def initialize(*args)
+        case args.count
+          when 1
+            blok = args[0].split("\n")
+            @dialog_number = blok.shift.to_i
+            @dialog_time = blok.shift
+            @dialog_text = blok.join("\n")
+          when 3
+            @dialog_number, @dialog_time, @dialog_text = args
+          else
+            raise ArgumentError
+        end
+      end
+
+      def to_s
+        [@dialog_number, @dialog_time, @dialog_text].join("\n") + "\n\n"
+      end
+    end
+  end
+end

data/lib/srt_subtitle_validator/validator.rb

@@ -0,0 +1,89 @@
+require 'srt_subtitle_validator/srt_file'
+class InvalidFile < ArgumentError; end
+module SrtSubtitleValidator
+  class Validator
+
+    require 'logger'
+    require 'tempfile'
+  
+    attr_reader :srt, :path, :file_name
+
+    def initialize(file_path, encoding = nil, logger = nil)
+      @logger = logger || Logger.new(STDOUT)
+      @path = File.absolute_path(file_path).strip
+      raise InvalidFile unless File.extname(@path) == '.srt'
+      @file_name = File.basename(@path)
+      parse_srt(File.read(@path, :encoding => (encoding || Encoding::UTF_8)))
+    end
+
+    def valid?
+      @srt.valid?
+    end
+
+    def convert_srt(output, skip_backup = false)
+      skip_backup ||= output_file(output) != @path
+      backup_original_file unless !!skip_backup
+      @new_srt = Tempfile.new([@file_name.gsub('.srt', ''), '.srt'])
+      recalculate_number_sequence
+
+      @logger.info ' > Save as UTF-8 encoded file...'
+      @new_srt.flush
+      FileUtils.copy(@new_srt.path, output_file(output))
+      @new_srt.close
+      @new_srt.unlink
+    end
+
+    def missing_numbers
+      @missing_numbers ||= (Array(1..@srt.length) - @srt.blocks.map(&:dialog_number))
+    end
+
+    private
+
+    def recalculate_number_sequence
+      @logger.info ' > Create new number sequence...'
+      @srt.blocks.each_with_index do |block, index|
+        number = index + 1
+        n = SrtSubtitleValidator::SrtFile::SrtBlock.new(number, block.dialog_time, block.dialog_text)
+        @new_srt.write(n.to_s)
+      end
+    end
+
+    def output_file(output = nil)
+      if output.to_s.empty?
+        @path
+      else
+        if File.directory?(output)
+          File.join(output, @file_name)
+        else
+          output
+        end
+      end
+    end
+
+
+    def backup_original_file
+      @logger.info ' > Create backup...'
+      backup_suffix = 1
+      possible_backup_file = @path + '.' + backup_suffix.to_s
+      while File.exist?(possible_backup_file)
+        possible_backup_file = @path + '.' + (backup_suffix += 1).to_s
+        raise StandardError if backup_suffix >= 66
+      end
+      FileUtils.cp(@path, possible_backup_file)
+    end
+
+    def parse_srt(raw, with_fallback = true)
+      begin
+        @srt = SrtSubtitleValidator::SrtFile.new(raw)
+      rescue ArgumentError => e
+        if e.to_s == 'invalid byte sequence in UTF-8' && with_fallback
+          parse_srt(raw.force_encoding(Encoding::CP1250), false)
+          @srt.errors << 'Invalid encoding'
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/srt_subtitle_validator/version.rb

@@ -0,0 +1,3 @@
+module SrtSubtitleValidator
+  VERSION = '0.1.7'
+end

data/lib/srt_subtitle_validator.rb

@@ -0,0 +1,26 @@
+require 'srt_subtitle_validator/version'
+# require 'srt_subtitle_validator/srt_file'
+require 'srt_subtitle_validator/validator'
+
+module SrtSubtitleValidator
+  # Your code goes here...
+
+end
+
+class String
+  def blank?
+    to_s == ''
+  end
+end
+
+class NilClass
+  def blank?
+    true
+  end
+end
+
+class Array
+  def blank?
+    empty?
+  end
+end

data/srt_subtitle_validator.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_subtitle_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'srt_subtitle_validator'
+  spec.version       = SrtSubtitleValidator::VERSION
+  spec.authors       = ['Lukáš Pokorný']
+  spec.email         = ['luk4s.pokorny@gmail.com']
+
+  spec.summary       = 'SRT subtitle file checker, validator'
+  spec.description   = 'For check encoding and srt subtitle number sequence'
+  spec.homepage      = 'https://github.com/luk4s/srt-subtitle-validator'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+
+  spec.add_runtime_dependency 'thor', '~> 0.20'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: srt_subtitle_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+platform: ruby
+authors:
+- Lukáš Pokorný
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+description: For check encoding and srt subtitle number sequence
+email:
+- luk4s.pokorny@gmail.com
+executables:
+- srt_checker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/srt_checker
+- lib/srt_subtitle_validator.rb
+- lib/srt_subtitle_validator/cli.rb
+- lib/srt_subtitle_validator/srt_file.rb
+- lib/srt_subtitle_validator/validator.rb
+- lib/srt_subtitle_validator/version.rb
+- srt_subtitle_validator.gemspec
+homepage: https://github.com/luk4s/srt-subtitle-validator
+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.7.7
+signing_key: 
+specification_version: 4
+summary: SRT subtitle file checker, validator
+test_files: []