tscripter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9027856dc86868bb991a34c30472780bd05f81f3
+  data.tar.gz: 65c56d380abd7c08b9d976e0a5451a22f793d2b0
+SHA512:
+  metadata.gz: 3030aacac118dba2450245e2bb6c74df4534fe36d859ea7fcacce65962cf6275361e691bf662f17d72c776035de8be1fd7eb5abc15eb4e467784f929c806d132
+  data.tar.gz: cb4d127d1ca7376c2c388fce81f9a940ca0db6d572ec563b8120151f38bf090df4c7430e64a60f767e7e88990eb77882893b870ecc2009ddfc9c31562335c602

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 TODO: Write your name
+
+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,43 @@
+# Tscripter
+
+This gem edits transcript files, given that they are in the expected format.
+
+Current features:
+- Prepends alternating IDs to spoken lines
+
+Planned features:
+- Detect spoken lines that start with stage directions
+- Implement notation for consecutive lines by the same speaker
+- Accept multiple filenames
+- Accept wildcard filenames
+
+Expected format:
+- File must be .txt
+- Speakers of each line must alternate
+- Lines that start with square brackets (stage directions) will be skipped
+- Whitespace lines are skipped
+
+## Installation
+
+    $ gem install tscripter
+
+## Usage
+
+    $ tscripter filename.txt AAA BBB
+
+AAA and BBB are the IDs to prepend.
+
+## Development
+
+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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ichthala/tscripter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tscripter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/tscripter

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'tscripter'
+
+runner = Tscripter::Runner.new
+runner.go

data/lib/test_input.txt

@@ -0,0 +1,11 @@
+This is a line.
+
+This is another line.
+
+Oh look, another line!
+[simultaneously]
+This is fun!
+I agree!
+I mean right?
+Yup!
+

data/lib/tscripter.rb

@@ -0,0 +1,57 @@
+require 'bundler/setup'
+require "tscripter/version"
+
+module Tscripter
+  class Runner
+    def go
+      puts(go_with_args(ARGV))
+    end
+
+    def go_with_args(args)
+      if filename = args[0]
+        file_basename = File.basename(filename, File.extname(filename))
+        id1 = args[1]
+        id2 = args[2]
+
+        return "Please supply two ID arguments." if (id1.nil? || id2.nil?)
+
+        transcript_text = File.new(filename).read
+
+        edited_file_content = generate_edited_text(transcript_text, id1, id2)
+
+        edited_file = File.new("#{file_basename}_edited_#{Time.now.to_i}.txt", "w")
+        edited_file.write(edited_file_content)
+        edited_file.close
+
+        "Transcript edit complete."
+      else
+        "Please supply a filename."
+      end
+    rescue IOError
+      "ERROR: File named #{args[0]} does not exist in this directory.\nPlease supply a valid filename."
+    end
+
+    def generate_edited_text(text, id1, id2)
+      edited_text = ""
+      use_id1 = true
+
+      text.split("\n").each do |line, i|
+        if line[0] == "[" || line.strip == ""
+          edited_text << "#{line}\n"
+          next
+        end
+
+        if use_id1
+          edited_text << "#{id1}: #{line}\n"
+        else
+          edited_text << "#{id2}: #{line}\n"
+        end
+
+        use_id1 = !use_id1
+      end
+
+      edited_text
+    end
+
+  end
+end

data/lib/tscripter/version.rb

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

data/test_input.txt

@@ -0,0 +1,11 @@
+This is a line.
+
+This is another line.
+
+Oh look, another line!
+[simultaneously]
+This is fun!
+I agree!
+I mean right?
+Yup!
+

data/tscripter.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tscripter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tscripter"
+  spec.version       = Tscripter::VERSION
+  spec.authors       = ["A. M."]
+  spec.email         = ["ichthala@gmail.com"]
+
+  spec.summary       = %q{This gem edits transcript files.}
+  spec.description   = %q{This gem edits transcript files.}
+  spec.homepage      = "https://github.com/ichthala/tscripter"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = ["tscripter"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: tscripter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- A. M.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: This gem edits transcript files.
+email:
+- ichthala@gmail.com
+executables:
+- tscripter
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/tscripter
+- lib/test_input.txt
+- lib/tscripter.rb
+- lib/tscripter/version.rb
+- test_input.txt
+- tscripter.gemspec
+homepage: https://github.com/ichthala/tscripter
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.8
+signing_key: 
+specification_version: 4
+summary: This gem edits transcript files.
+test_files: []