tscripter 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07b2b5f211bd76bacfce348ca69be7b641dd7163
-  data.tar.gz: 10456f0151e1d6e577628060c08ceb8901190039
+  metadata.gz: 313653814cd5a9837b7d68eef157798c989801f3
+  data.tar.gz: 1516a38bd9f606d27d5ea40943313d116a4993c6
 SHA512:
-  metadata.gz: f1bd2a76d12c8a504fc198aa402efd5f7fdf768c377d73bc517b8752f8ab886cd6b5a34fa1542f68dd2d6d17587173836b86c69e224ad7758baa363a6c0d9bd2
-  data.tar.gz: b989478276db9c255961944df33f551f52a3c1ce17ec7b0d61f537bf6000ecf54de3d9c6563d7678b15bd7abe78785d76a1dcbd23d8fd710f38f0ff5c8a8a57e
+  metadata.gz: 4267ee3298c0afe598f7acada5ddf49f1ffc45b175302ee4c15b4b7d59c2fa7f4647b0d3ee1a122d8cb462b5bb84234037361aee66eeb36ab52592f184bd27ed
+  data.tar.gz: b131ce9dedb922955137eed63d48e313ee9400d72a7e9b7aaa3c7ece57edfc8c18533849a8824ffc94acba6f14ca724de203c5143e110ab2226621d7730a5bcb

data/README.md

@@ -1,23 +1,78 @@
 # Tscripter
 
-This gem edits transcript files, given that they are in the expected format.
+This gem edits transcript files. Files must be plaintext (.txt).
 
-Current features:
-- Prepends alternating IDs to spoken lines
-- Detect spoken lines that start with stage directions
-- Implement notation for consecutive lines by the same speaker
+## Current features:
+- Prepend alternating IDs to spoken lines
 - If a line starts with `^`, then the speaker is the same as the previous line
-- The pattern `*i 00:00` (where 00:00 is any timestamp) is replaced with `inaudible [00:00]
-
-Planned features:
+  - Example:
+  ```
+  You've changed, Heathcliff...
+  [looks to the moon]
+  ^ ...and I don't know who you are anymore.
+  That's not true!
+  ```
+  becomes...
+  ```
+  Cathy: You've changed, Heathcliff...
+  [looks to the moon]
+  Cathy: ...and I don't know who you are anymore.
+  Heathcliff: That's not true!
+  ```
+
+- Replace pattern `*i MM:SS` (where MM:SS is any timestamp) with `inaudible [MM:SS]`
+  - Example:
+  ```
+  But what if *i 10:05 to the end?
+  ```
+  becomes...
+  ```
+  Heathcliff: But what if [inaudible 10:05] to the end?
+  ```
+  - Note: Currently only supports MM:SS timestamps, not HH:MM:SS
+
+- Lines that contain _only_ stage directions (text inside [square brackets]) are left intact
+
+- Lines that contain _only_ whitespace are left intact
+
+## Sample input and output
+
+Input:
+```
+Hello there.
+
+Hello to you too.
+
+Lovely night on the moors.
+[uncomfortable silence]
+This is splendid, don't you agree?
+I mean, I would never...
+[pause]
+^ disagree with you.
+But what if *i 45:09 tomorrow?
+[turns away] You can't mean that!
+```
+
+Output:
+```
+Heathcliff: Hello there.
+
+Cathy: Hello to you too.
+
+Heathcliff: Lovely night on the moors.
+[uncomfortable silence]
+Cathy: This is splendid, don't you agree?
+Heathcliff: I mean, I would never...
+[pause]
+Heathcliff: disagree with you.
+Cathy: But what if [inaudible 45:09] tomorrow?
+Heathcliff: [turns away] You can't mean that!
+```
+
+## Planned features:
 - 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
+- Support HH:MM:SS timestamps
 
 ## Installation
 
@@ -25,9 +80,9 @@ Expected format:
 
 ## Usage
 
-    $ tscripter filename.txt AAA BBB
+    $ tscripter filename.txt Heathcliff Cathy
 
-AAA and BBB are the IDs to prepend.
+`Heathcliff` and `Cathy` are the IDs to prepend.
 
 ## Development
 

data/lib/tscripter.rb

@@ -72,14 +72,14 @@ module Tscripter
 
     def remove_markup(line)
       if line[0] == '^'
-        line = line.slice(/\^\s(.*)/, 1)
+        line = line.slice(/\^\s*(.*)/, 1)
       else
         line
       end
     end
 
     def add_inaudible_notation(line)
-      line.scan(/\*[iI]\s\d{1,2}\:\d{1,2}/) do |inaud_markup|
+      line.scan(/\*[iI]\s*\d{1,2}\:\d{1,2}/) do |inaud_markup|
         timestamp = inaud_markup.match(/(\d{1,2}\:\d{1,2})/)[1]
         inaudible_notation = "[inaudible #{timestamp}]"
         line = line.gsub(inaud_markup, inaudible_notation)

data/lib/tscripter/version.rb

@@ -1,3 +1,3 @@
 module Tscripter
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/test_input.txt

@@ -1,13 +1,13 @@
-This is a line.
+Hello there.
 
-This is another line.
+Hello to you too.
 
-Oh look, another line!
-[simultaneously]
-This is fun!
-I agree!
-I mean right?
-^ Yup!
+I can't read books anymore.
+[uncomfortable silence]
+This is fun, don't you agree?
+I mean, I would never...
+[pause]
+^ disagree with you.
 But what if *i 45:09
 [turns away] You can't really mean that!
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tscripter
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - A. M.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-11 00:00:00.000000000 Z
+date: 2018-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,10 +70,10 @@ files:
 - bin/console
 - bin/setup
 - bin/tscripter
-- lib/test_input.txt
 - lib/tscripter.rb
 - lib/tscripter/version.rb
 - test_input.txt
+- tscripter-0.1.1.gem
 - tscripter.gemspec
 homepage: https://github.com/ichthala/tscripter
 licenses:

data/lib/test_input.txt

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