Subber

This is the Subber gem from Viki. This gem helps you convert subtitles from SRT to VTT and vice versa.

Installation

Add this line to your application's Gemfile:

gem 'subber'

And then execute:

$ bundle

Or install it yourself as:

$ gem install subber

Usage

# Ways to instantiate a `Subber::File::Srt` or `Subber::File::Vtt`
#
srt_file = Subber::File::Srt.from_content("pass file content here")
srt_file = Subber::File::Srt.from_path("pass local or remote file path here")
srt_file = Subber::File::Srt.new(Array<Subber::Subtitle>)

# Read the content of the file
#
srt_file.content

# Get Subber::Subtitle objects
#
srt_file.subtitles

# Export to a local file
#
srt_file.export("pass local path here")

# Convert between Srt and Vtt
#
vtt_file = srt_file.to_vtt
srt_file = vtt_file.to_srt

Development

Add a new file type

Do replace NewType and new_type with corresponding values

• Add Subber::File::NewType
• Add to_new_type to other Subber::File files
• Add Subber::Formatted::NewType
• Add Subber::Parser::NewType
• Update Subber::File::Base#to_file_type
• Update Subber::File.from_content

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Changelog

0.x.x

0.3.x

• 0.3.3: [Security Patch] Upgrade nokogiri to 1.12.3 + Add 2.5 as minimum ruby verison requirement
• 0.3.2: [Security Patch] Upgrade nokogiri to 1.10.4 + Add 2.3 as minimum ruby verison requirement
• 0.3.1: Allow subtitle in json file to have nil content
• 0.3.0: Add support for Timed Text Markup Language (TTML)

0.2.x

• 0.2.3: Only reject json subtitle if content is nil
• 0.2.2: Fix timestamp parser + Add error message
• 0.2.1: Fix missing counter issue
• 0.2.0: Add support for json + Introduce generic interfaces for files and parsers

0.1.x

• 0.1.0: Add support for vtt and srt

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/viki-org/subber-gem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.