trecs 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 809876261c49aa7e3438e2aa09c14b3050fa366b
-  data.tar.gz: a78011eebe829a75057a1c51e25c1a4a5793662e
+  metadata.gz: 11db22d959f646d759488d0e21e070a1dd131a86
+  data.tar.gz: 14ea24c099109043abf9ee864350c21406a36d58
 SHA512:
-  metadata.gz: 8cfdc387dd0f709649d26d4090a65d4524337a7a3819bd2132afdd67101c7f922313952b5bcc328bcb9607b540a6ec45fb40b3a7b35947bc88ac71cdf45f892e
-  data.tar.gz: 36394bfa8603542a1551bc18f5ec948aa4249eb27c144050741e2bae50a1ca11baab208a573342ebf17e9cbcbcc33cd58095ffd9ed8e697a427e527ac751c824
+  metadata.gz: 5f5c7a11191cb0b495ea2fbb8759cf6f4af6da622d7c397deba90bc2382662ab344b6b5ed8021c6a2ea7c0cb22932fa4f636694a1b216658cc3b563dac3449ec
+  data.tar.gz: b31502af511913ce740f5c8b05593223a5423b071b00344a443e3e0dc6fb34b9e3e61838b00cb6b84af2cf6401724900aff96cbdf01f2702eb5e77b4ec6c9172

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    trecs (0.1.6)
+    trecs (0.1.7)
       trollop (~> 2.0)
 
 GEM

data/README.org

@@ -20,14 +20,8 @@
   |_| |_| \_\___|\___|___/
 
 #+END_EXAMPLE
-
-Text Recordings.
-
 Record screencasts in plain text.
 
-** Still under development
-This project is still under development. It's not yet ready for use.
-
 ** Installing TRecs
 To install TRecs, just run
 #+BEGIN_SRC bash
@@ -98,6 +92,87 @@ This will create 6 frames:
 - 200 millis :: "TRec"
 - 250 millis :: "TRecs"
 
+**** Fly from right
+Insert a message and se it fly from the right side of the screen
+
+#+BEGIN_SRC bash
+trecs_record my_banner.trecs --strategy=fly_from_right --step=50 --message="TRecs"
+#+END_SRC
+
+**** Shell command for message
+On some recording strategies, there's also the posibility to run a custom shell command for each frame.
+
+For example, you can use the =wc= shell command to count the characters (or lines or words) of a banner that, for example appears one char at the time
+
+#+BEGIN_SRC bash
+trecs_record my_banner.trecs --strategy=incremental --step=50 --message="TRecs" --command="echo <frame> | wc -c"
+#+END_SRC
+
+This will run, for each frame the command =<frame> | wc -c=
+
+Where =<frame>= will be eplaced by the frame contents inside double quotes
+
+And these are the generated frames with its corresponding commands:
+
+- 0 millis :: 
+  - frame ::
+    #+BEGIN_SRC bash
+    0
+    #+END_SRC
+  - command ::
+    #+BEGIN_EXAMPLE
+    echo "" | wc -c
+    #+END_EXAMPLE
+- 50 millis ::
+  - frame ::
+    #+BEGIN_SRC bash
+    1
+    #+END_SRC
+  - command ::
+    #+BEGIN_EXAMPLE
+    echo "T" | wc -c
+    #+END_EXAMPLE
+- 100 millis ::
+  - frame ::
+    #+BEGIN_SRC bash
+    2
+    #+END_SRC
+  - command ::
+    #+BEGIN_EXAMPLE
+    echo "TR" | wc -c
+    #+END_EXAMPLE
+- 150 millis ::
+  - frame ::
+    #+BEGIN_SRC bash
+    3
+    #+END_SRC
+  - command ::
+    #+BEGIN_EXAMPLE
+    echo "TRe" | wc -c
+    #+END_EXAMPLE
+- 200 millis :: 
+  - frame ::
+    #+BEGIN_SRC bash
+    4
+    #+END_SRC
+  - command ::
+    #+BEGIN_EXAMPLE
+    echo "TRec" | wc -c
+    #+END_EXAMPLE
+- 250 millis ::
+  - frame ::
+    #+BEGIN_SRC bash
+    5
+    #+END_SRC
+  - command ::
+    #+BEGIN_EXAMPLE
+    echo "TRecs" | wc -c
+    #+END_EXAMPLE
+
+Currently applies to:
+- Incremental Strategy
+- Fly from right Strategy
+
 ** Extending TRecs
 Right now, you can extend TRecs in three possible ways
 

data/bin/trecs_record

@@ -67,4 +67,4 @@ RECORDER.record
 
 puts "Recording finished"
 puts "Play with:"
-puts "  bin/trecs #{opts[:trecs_file]}"
+puts "  trecs #{opts[:trecs_file]}"

data/lib/trecs/recording_strategies/shell_command_strategy.rb

@@ -4,8 +4,11 @@ module TRecs
    
     def current_content(str)
       if self.command
-        comm_array = command.split(" ")
-        str = IO.popen([*comm_array, "#{str}"]).read
+        #comm_array = command.split(" ")
+        #str = IO.popen([*comm_array, "#{str}"]).read
+
+        comm = command.gsub(/<frame>/, "\"#{str}\"")
+        str = IO.popen(comm).read
       end
       super(str)
     end

data/lib/trecs/version.rb

@@ -1,3 +1,3 @@
 module TRecs
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/spec/trecs/recording_strategies/fly_from_right_strategy_spec.rb

@@ -60,9 +60,5 @@ module TRecs
       Then { recorder.calls[12] == [:current_frame, [ {time: 1100, content: "abc"  } ] ] }
 
     end
-
-    context "shell command" do
-      Then { skip("Test shell command") }
-    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trecs
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Federico Iachetti