trecs 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 224c52d3a5d09ed6617696bbc065ed583ef3b7d3
-  data.tar.gz: 8a45676eceed2883a7ff8cb6be780722e8329166
+  metadata.gz: 87c0b4a09cb4986d22945bf20ddcb8c479f6e8fe
+  data.tar.gz: ed7c1d258de1fa55960daf9a0feab11d35a3b91c
 SHA512:
-  metadata.gz: e88acdd602058452e8639f033eb6432265ec15b589f73a8aefcdb2c348e8e699485a354491741658c32a5cdbef2571f3f91982d163bcfd5d5a8efafc13fa0b90
-  data.tar.gz: 3001428048466e650b65c89b1c0048e8f4635272ee936dd8cff946847e3305b54ceb673ffcffcde4c9220414e1493ac509861aa2c159ce51011b91c27c72e1ed
+  metadata.gz: f56ccb909c71150449dbf09ea3d99eb71281380ba0edf1ea14c4da90d39c3161cb0949163163cc519d12a5826f0ea30358086dbbbd3d7032b85e97d7ef9b31df
+  data.tar.gz: 18a03490b2849ccc036dc5ab01f8cc8788f4793927f01d30cd48faee87d52f283f71b6f41c688ce1db632060b57fe3beda2b379944de3a581260258ff1cca679

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    trecs (0.1.3)
-      rubyzip (~> 1.1.4)
+    trecs (0.1.4)
       trollop (~> 2.0)
 
 GEM
@@ -10,6 +9,7 @@ GEM
   specs:
     coderay (1.1.0)
     diff-lcs (1.2.5)
+    ffi (1.9.3-java)
     given_core (3.5.4)
       sorcerer (>= 0.3.7)
     method_source (0.8.2)
@@ -17,6 +17,11 @@ GEM
       coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
+    pry (0.9.12.6-java)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+      spoon (~> 0.0)
     pry-nav (0.2.3)
       pry (~> 0.9.10)
     rake (10.3.2)
@@ -31,12 +36,14 @@ GEM
       given_core (= 3.5.4)
       rspec (>= 2.12)
     rspec-mocks (2.99.1)
-    rubyzip (1.1.4)
     slop (3.5.0)
     sorcerer (1.0.2)
+    spoon (0.0.4)
+      ffi
     trollop (2.0)
 
 PLATFORMS
+  java
   ruby
 
 DEPENDENCIES

data/README.org

@@ -25,14 +25,86 @@ Text Recordings.
 
 Record screencasts in plain text.
 
-** Just an Idea
-The idea is to create a tool that allows to record text somehow and then reproduce it just as you would reproduce a video.
+** Still under development
+This project is still under development. It's not yet ready for use.
 
-** Some specifications
+** Installing TRecs
+To install TRecs, just run
+#+BEGIN_SRC bash
+gem install trecs
+#+END_SRC
 
-- It should have controls (play, pause, ffw, rew, stop, rec)
-- It should have some kind of timestamp, so it can be synchronized with other resources
-- The other resources:
-  + Audio track
-  + Video track
-  + Browser extension (so, if you are recording the development of a web page, you could see in a browser the current snapshot of the page)
+** Usage
+*** Reproduce a TRecs
+You have a TRecs file and want to reproduce it? You can do it on a terminal using the =trecs= command.
+
+Like this:
+#+BEGIN_SRC bash
+trecs <file>
+#+END_SRC
+
+You can also specify the refresh interval for the screen (terminal), using the =--step= argument.
+The value has to be an integer representing the amount of milliseconds between each screen refresh.
+
+#+BEGIN_SRC bash
+trecs <file> --step=800
+trecs <file> -s 800
+#+END_SRC
+
+*** Recording a TRecs
+Wanna record a TRecs? Do it using the =trecs_record= command.
+
+There are several recording plugins available for use
+
+Each options has a set of available flags (NOTE: the =--help= argument don't explain each one in detail yet)
+
+The main option to select the recording alternative is the Recording Strategy, passed to TRecs via the =--strategy= (=-s=) argument.
+
+Here it's also available the =--step= option, which will define the time between frames in milliseconds.
+
+**** Terminal session
+The most obvious use for this gem is recording a terminal session. This feature will be the default in the future, but it's not fully implemented yet.
+
+To record a terminal session, use the =--strategy=ttyrec= option:
+#+BEGIN_SRC bash
+trecs_record playing_with_bash.trecs --strategy=ttyrec
+#+END_SRC
+
+This will open a new terminal session to record. You can finish the recording typing =exit= or pressing =C-d=, then the session will be saved to =playing_with_bash.trecs= and will be ready for replaying.
+
+**** Record a file's changes
+You can record the changes that occur on a file by using =--strategy=raw-file=.
+
+What this does is sample a file every =step= milliseconds and create a frame with that file's contents.
+
+To use it:
+#+BEGIN_SRC bash
+trecs_record my_changes.trecs --strategy=raw_file
+#+END_SRC
+
+**** Incremental message TRecs
+Another possibility is to record a text message that will appear on screen character by character with an interval of =step= milliseconds. This is currently the default functionality of the command =trecs_record=
+
+#+BEGIN_SRC bash
+trecs_record my_banner.trecs --strategy=incremental --step=50 --message="TRecs"
+#+END_SRC
+
+This will create 6 frames:
+
+- 0 millis :: ""
+- 50 millis :: "T"
+- 100 millis :: "TR"
+- 150 millis :: "TRe"
+- 200 millis :: "TRec"
+- 250 millis :: "TRecs"
+
+** Extending TRecs
+Right now, you can extend TRecs in three possible ways
+
+- Recording Strategies :: This is the object that defines what to record and how to process the input to be converted into frames. To give an example, the IncrementalStrategy (provided by TRecs), will take an input string, make an array with each of it's characters and, for each char, append it to an output string and save the frame.
+- Formats :: The format corresponds to the way the frames are stored. For example, using YamlStore, a tar file or a database.
+- Tickers :: The Ticker is the way the user tells TRecs to advance frames. 
+
+# *** TODO Recording Strategies
+# *** TODO Formats
+# *** TODO Tickers

data/lib/trecs/version.rb

@@ -1,3 +1,3 @@
 module TRecs
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/trecs.gemspec

@@ -20,7 +20,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib", "lib/trecs", "bin"]
 
   # Dependencies
-  spec.add_dependency "rubyzip", "~> 1.1.4"
   spec.add_dependency "trollop", "~> 2.0"
 
   # Development dependencies

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: trecs
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Federico Iachetti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-19 00:00:00.000000000 Z
+date: 2014-06-21 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rubyzip
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.1.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.1.4
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement