subjuster 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 191871bead5ef2eb2b837a2471bb1a33122fbd85
+  data.tar.gz: d28b97d62ff5a33ed541d56bbc88c6337f4fdec1
+SHA512:
+  metadata.gz: c9c2fed49b6f742bcf33f0095b513a6ce6cd1f21c8e0dd5f1424a83e5d0e3d443fe6f1cd62a6d55d81a3a4b5b4ce532d6c7f30ecef058ef90e55c304a089996b
+  data.tar.gz: 8399acabe1456ea38fb26f4d17345e1677d440bfdc7defd8541c442697c9bf6434ab2fc55904127269007081aaca034a066bc73f515b664c6954bfc518704512

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.15.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Shiva Bhusal
+
+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/exe/subjuster

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# exe/hulaki
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+require 'subjuster'
+require 'optparse'
+
+options = {source: ARGV[0]}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: subjuster [filename.srt] [options]\n"\
+                "\n"\
+                "Special Case:\n"\
+                "subjuster [fiename.srt] -a-12.23    # for -ve number i.e '-12.23'\n"\
+                "\n"\
+                "'+ve' number will add time while '-ve' will decrease. \n"\
+                "i.e. if subtitles appears 2 sec after the audio then use '-2' as adjustment\n"\
+                "---------------------------------------------------------------------------\n"\
+                "\n"\
+
+  opts.on("-a [Numeric]", "--adjustment [Numeric]", Float, "Time adjustment in sec") do |v|
+    options[:adjustment_in_sec] = v
+  end
+
+  opts.on("-t [Filename]", "--target [Filename]", String, "If Target file name not given then will be '[source_file].modified.srt'") do |v|
+    options[:target] = v
+  end
+  
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end.parse!
+
+$stdout.puts 
+
+options.each do |key, value|
+  $stdout.puts "#{key} #{' '*(20-key.length)} => #{value}" unless key == :target
+end
+
+$stdout.puts 
+
+begin
+  Subjuster::Core.run(options)
+rescue Subjuster::InputError => error
+  $stderr.puts error.message
+end

data/lib/subjuster.rb

@@ -0,0 +1,23 @@
+require 'subjuster/version'
+require 'subjuster/user_input'
+require 'subjuster/parser'
+require 'subjuster/adjuster'
+require 'subjuster/generator'
+
+# lib/subjuster.rb
+module Subjuster
+  class Core
+    class << self
+      def run(source:, target: nil, adjustment_in_sec: 0)
+        user_input    = UserInput.new(source: source, target: target, adjustment_in_sec: adjustment_in_sec)
+        parsed_data   = Parser.new(inputs: user_input).parse
+        adjusted_data = Adjuster.new(data: parsed_data, inputs: user_input).run
+        
+        Generator.new(payload: adjusted_data, inputs: user_input).run
+        
+        $stdout.puts "Yeah! successfully adjusted and compiled to file #{user_input.target_filepath}"
+        $stdout.puts 
+      end
+    end
+  end
+end

data/lib/subjuster/adjuster.rb

@@ -0,0 +1,43 @@
+module Subjuster
+  class Adjuster
+    attr_reader :data, :inputs
+    
+    def initialize(data:, inputs:)
+      @data   = data
+      @inputs = inputs
+    end
+    
+    def run
+      # new_data = data.clone
+      data.map do |paragraph|
+        paragraph[:start_time] = process_on(paragraph[:start_time])
+        paragraph[:end_time]   = process_on(paragraph[:end_time])
+        paragraph
+      end
+    end
+    
+    private
+    
+    # TODO: Refactoring needed
+    def process_on(date)
+      _, hrs, min, sec, milli =  /(..):(..):(..),(...)/.match(date).to_a.map(&:to_i)
+      timestamp_in_msec = milli + sec*1000 + min*60000 + hrs*3600000 + (inputs.adjustment_in_sec*1000).to_i
+      rim = ""
+
+      hr = timestamp_in_msec / 3600000
+      rim << ("%02i" % hr) << ":" 
+      
+      min = timestamp_in_msec / 60000
+      timestamp_in_msec -= min*60000
+      rim << ("%02i" % min) << ":" 
+      
+      
+      sec = timestamp_in_msec / 1000
+      timestamp_in_msec -= sec*1000
+      rim << ("%02i" % sec) << ":" 
+      
+      rim.slice!(-1)
+      rim << "," << "#{timestamp_in_msec}00"[0..2]  << date[12..-1]
+    end
+  end
+end

data/lib/subjuster/generator.rb

@@ -0,0 +1,26 @@
+module Subjuster
+  class Generator
+    attr_reader :payload, :inputs
+    
+    def initialize(payload:, inputs: nil)
+      @payload = payload
+      @inputs  = inputs
+    end
+    
+    def run
+      file_content = _prepare_data
+      File.write(inputs.target_filepath, file_content)
+    end
+    
+    def _prepare_data
+      @payload.map do |hash|
+        [
+          hash[:id],
+          "#{hash[:start_time]} --> #{hash[:end_time]}",
+          hash[:dialog]
+        ].join("\n")
+      end.join("\n") + "\n\r\n"
+    end
+  end
+end
+  

data/lib/subjuster/parser.rb

@@ -0,0 +1,64 @@
+module Subjuster
+  class Parser
+    REGEXP = /\A[\d]+[\s]{,2}\Z/
+    # = Parser
+    #   
+    #   Subjuster::Parser parses the File you provide via UserInput object
+    #
+    #   Example:
+    #
+    #     inputs = Subjuster::UserInput.new(source: 'somefilename')
+    #     Subjuster::Parser.new(inputs: inputs).parse
+    #
+    #     # [{:id=>"1", 
+    #     #  :start_time=>"00:00:57,918", 
+    #     #  :end_time=>"00:01:02,514", 
+    #     #  :dialog=>"\"In order to affect a timely halt\n" + "to deteriorating conditions\n"},..]
+    #
+    attr_reader :inputs
+    def initialize(inputs:)
+      @inputs = inputs
+    end
+    
+    def parse
+      inputs.validate! unless $test 
+      _parse
+    end
+    
+    private
+      # This will find next `dialog number` embedded line and
+      # return lines joined upto that line, along with the index of line of the `dialog num` 
+      def find_dialog_from(list:, index:)
+        buffer = []
+        count = list.count
+         while !(list[index]  =~ REGEXP) && index < count do
+           buffer << list[index]
+           index += 1
+         end
+         [buffer.join("\n"), index]
+      end
+      
+      def _parse
+        items = []
+        file_content_array = File.read(inputs.source_filepath).split("\n")
+        count = file_content_array.count
+        index = 0
+
+        while index < count do
+          line = file_content_array[index]
+
+          if line =~ REGEXP
+            splitted_line = file_content_array[index+1].split(' --> ')
+            
+            dialog, index = find_dialog_from(list: file_content_array, index: index + 2)
+            
+            items << { id: line, start_time: splitted_line.first, end_time: splitted_line.last, dialog: dialog }
+          else
+            index += 1
+          end
+        end
+
+        items
+      end
+  end
+end

data/lib/subjuster/user_input.rb

@@ -0,0 +1,42 @@
+module Subjuster
+  InputError = Class.new(StandardError)
+  # = Handle User Input
+  # 
+  # Being a CLI tool, Subjuster is supposed to take input from +ARGV+
+  # This module will get those data via arguments to the constructor method.
+  #
+  # === For Example:
+  #
+  #   inputs = UserInput.new(source: ARGV[0], target: ARGV[1], adjustment_in_sec: ARGV[2])
+  #   inputs.valid? # => true / false
+  #
+  class UserInput
+    
+    attr_reader :source_filepath, :target_filepath, :adjustment_in_sec
+    def initialize(source:, target: nil, adjustment_in_sec: 0)
+      @source_filepath = File.expand_path(source || '')
+      @target_filepath = target && File.expand_path(target) || "#{source_filepath}.modified.srt"
+      @adjustment_in_sec = adjustment_in_sec
+    end
+    
+    # Validates the source file, if it exists
+    # === Valid condition
+    # 
+    #   inputs = UserInput.new(source: ARGV[0], target: ARGV[1], adjustment_in_sec: ARGV[2])
+    #   inputs.valid? # => true 
+    #
+    # === Invalid condition
+    # 
+    #   inputs = UserInput.new(source: ARGV[0], target: ARGV[1], adjustment_in_sec: ARGV[2])
+    #   inputs.valid? # => false
+    #
+    #
+    def valid?
+      File.exist?(source_filepath)
+    end
+    
+    def validate!
+      raise InputError, "Invalid file: #{source_filepath}" unless valid?
+    end
+  end
+end

data/lib/subjuster/version.rb

@@ -0,0 +1,3 @@
+module Subjuster
+  VERSION = "0.1.0"
+end

data/subjuster.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "subjuster/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "subjuster"
+  spec.version       = Subjuster::VERSION
+  spec.authors       = ["Shiva Bhusal"]
+  spec.email         = ["hotline.shiva@gmail.com"]
+
+  spec.summary       = %q{Subjuster | TDD guide for Software Engineers in OOP}
+  spec.description   = %q{A command line tool to adjust your movie subtitle files while while playing audio and subtitle do not sync with each other. Normally it lags/gains by a few seconds/milliseconds. You will be able to adjust and generate a new subtitle file or update the existing one.}
+  spec.homepage      = "http://subjuster.github.io"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|images|tmp|bin|doc)/}) || f =~ /[\w]{1,}.md\z/ || f =~ /\A.[\w]{1,}\z/
+  end
+  
+  # Since we intend to make it a CLI tool, need to have executable script
+  # Create a new dir `exe` and put `subjuster`
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  
+  spec.post_install_message = 'Please run `$ subjuster -h` to learn how to use.'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: subjuster
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shiva Bhusal
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+description: A command line tool to adjust your movie subtitle files while while playing
+  audio and subtitle do not sync with each other. Normally it lags/gains by a few
+  seconds/milliseconds. You will be able to adjust and generate a new subtitle file
+  or update the existing one.
+email:
+- hotline.shiva@gmail.com
+executables:
+- subjuster
+extensions: []
+extra_rdoc_files: []
+files:
+- ".travis.yml"
+- LICENSE.txt
+- exe/subjuster
+- lib/subjuster.rb
+- lib/subjuster/adjuster.rb
+- lib/subjuster/generator.rb
+- lib/subjuster/parser.rb
+- lib/subjuster/user_input.rb
+- lib/subjuster/version.rb
+- subjuster.gemspec
+homepage: http://subjuster.github.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: Please run `$ subjuster -h` to learn how to use.
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Subjuster | TDD guide for Software Engineers in OOP
+test_files: []