trecs 0.0.1.alpha

data/spec/trecs_message_spec.rb

@@ -0,0 +1,125 @@
+require "spec_helper"
+require "fileutils"
+require 'zip'
+
+describe "T-Recs" do
+  include FileUtils
+
+  define :have_frames do |expected|
+    match do |actual|
+      actual   = actual.split("\e[H\e[2J\n").select { |f|
+        (/\S/ === f)
+      }.map(&:chomp)
+      expected = Array(expected)
+      actual == expected
+    end
+  end
+
+  let(:trecs_root)   { File.expand_path("../..", __FILE__) }
+  let(:bin)          { "#{trecs_root}/bin" }
+  let(:exe)          { "#{bin}/trecs_message" }
+  let(:play_exe)     { "#{bin}/trecs" }
+
+  let(:project_dir)  { create_dir("#{trecs_root}/tmp") }
+
+  def trecs(*args, &block)
+    command = [exe]
+      .concat(args.map(&:to_s))
+      .concat(["2>&1"])
+      .join(" ")
+    IO.popen(command) do |output|
+      yield output.read if block_given?
+    end
+  end
+
+  def play(*args, &block)
+    command = [play_exe]
+      .concat(args.map(&:to_s))
+      .concat(["testing", "2>&1"])
+      .join(" ")
+    IO.popen(command) do |output|
+      yield output.read if block_given?
+    end
+  end
+
+  context "trecs_message command" do
+    after do
+      rm file_name if file_name
+    end
+
+    specify "is in place and executes" do
+      expect { trecs }.not_to raise_exception
+      trecs do |output|
+        output.should_not match /error/i
+      end
+    end
+
+    it "expects a file name" do
+      trecs do |output|
+        output.should have_frames "Please give a file name"
+      end
+    end
+
+    it "generates a .trecs compressed file" do
+      file_name "i_should_exist"
+      trecs("-f", file_name, "--message", "a")
+
+      File.exists?(file_name).should be_true
+      expect { Zip::File.open(file_name) }.not_to raise_error(Zip::ZipError)
+    end
+
+    context "recording" do
+      it "records a one letter message screencast" do
+        file_name "a"
+
+        trecs("-f", file_name, "--message", "a")
+
+        play("-f", file_name) do |output|
+          output.should have_frames "a"
+        end
+      end
+
+      it "records a two letters message screencast" do
+        file_name "ab"
+
+        trecs("-f", file_name, "--message", "ab")
+
+        play("-f", file_name) do |output|
+          output.should have_frames ["a", "ab"]
+        end
+      end
+
+      it "records a three letters message screencast" do
+        file_name "abc"
+
+        trecs("-f", file_name, "--message", "abc")
+
+        play("-f", file_name) do |output|
+          output.should have_frames ["a", "ab", "abc"]
+        end
+      end
+    end
+
+    context "timestamps" do
+      it "uses 100 ms by default" do
+        file_name "abcd"
+
+        trecs("-f", file_name, "-m", "abcd")
+
+        play("-f", file_name, "--timestamps") do |output|
+          output.should have_frames "[0, 100, 200, 300]"
+        end
+      end
+
+      it "accepts a step parameter" do
+        file_name "abc"
+
+        trecs("-f", file_name, "-m", "abcd", "-s", "250")
+
+        play("-f", file_name, "--timestamps") do |output|
+          output.should have_frames "[0, 250, 500, 750]"
+        end
+      end
+    end
+  end
+end

data/spec/trecs_spec.rb

@@ -0,0 +1,110 @@
+require "spec_helper"
+require "fileutils"
+require 'zip'
+require 'rspec/expectations'
+
+describe "T-Recs" do
+  define :have_frames do |expected|
+    match do |actual|
+      actual   = actual.split("\e[H\e[2J\n").select { |f|
+        (/\S/ === f)
+      }.map(&:chomp)
+      expected = Array(expected)
+      actual == expected
+    end
+  end
+
+  after do
+    rm file_name if file_name
+  end
+
+  include FileUtils
+
+  let(:trecs_root)   { File.expand_path("../..", __FILE__) }
+  let(:bin)          { "#{trecs_root}/bin" }
+  let(:exe)          { "#{bin}/trecs" }
+
+  let(:project_dir)  { create_dir("#{trecs_root}/tmp") }
+
+  def trecs(*args, &block)
+    command = [exe]
+      .concat(args.map(&:to_s))
+      .concat(["--testing"])
+      .join(" ")
+    IO.popen(command) do |output|
+      yield output.read if block_given?
+    end
+  end
+
+  def create_recording(file_name: "")
+    unless File.exist?(file_name)
+      recording_dir = "#{File.dirname(file_name)}/frames"
+      rm_rf recording_dir
+      mkdir_p recording_dir
+      rm file_name if File.exists? file_name
+
+      yield recording_dir
+
+      files_to_record = Dir.glob("#{recording_dir}/*")
+
+      Zip::File.open(file_name, Zip::File::CREATE) do |trecs_file|
+        files_to_record.each do |file_to_rec|
+          dest_file_name = File.basename(file_to_rec)
+          trecs_file.add(dest_file_name, file_to_rec)
+        end
+      end
+      rm_rf Dir.glob("#{recording_dir}")
+    end
+  end
+
+  def create_frame(file_name: "", content: "", time: 0)
+    File.open("#{project_dir}/frames/#{time.to_i}", File::WRONLY|File::CREAT) do |f|
+      f << content
+    end
+  end
+
+  context "trecs command" do
+    it "is in place and executes" do
+      expect { trecs }.not_to raise_exception
+    end
+
+    it "returns an error whe project doesn't exist" do
+      non_existent = "path/to/a/non/existing/file.trecs"
+
+      trecs("-f", non_existent) do |output|
+        output.should have_frames "File #{non_existent} does not exist."
+      end
+    end
+
+    context "Player" do
+
+      context "playing a recording" do
+
+        it "plays a recording" do
+          file_name "multiple_frames"
+
+          create_recording(file_name: file_name) do
+            create_frame(time: 0,   content: "FIRST FRAME")
+            create_frame(time: 100, content: "FRAME AT 100")
+            create_frame(time: 200, content: "FRAME AT 200")
+            create_frame(time: 301, content: "FRAME AT 301")
+            create_frame(time: 499, content: "FRAME AT 499")
+            create_frame(time: 599, content: "FRAME AT 599")
+          end
+
+          trecs("-f", file_name) do |output|
+            output.should have_frames [
+              "FIRST FRAME",
+              "FRAME AT 100",
+              "FRAME AT 200",
+              "FRAME AT 200",
+              "FRAME AT 301",
+              "FRAME AT 499",
+              "FRAME AT 599",
+            ]
+          end
+        end
+      end
+    end
+  end
+end

data/spec/zip_file_recorder_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+require "zip"
+
+require "recorders/zip_file_recorder"
+require "players/zip_file_player"
+
+module TRecs
+  describe ZipFileRecorder do
+    class DummyRecordingStrategy
+      attr_reader :recorder
+
+      def initialize(recorder:)
+        @recorder = recorder
+      end
+      def perform
+        recorder.current_frame(time: 0, content: "zero")
+        recorder.current_frame(time: 1, content: "one")
+        recorder.current_frame(time: 2, content: "two")
+      end
+    end
+
+    class DummyZipFileRecorder < ZipFileRecorder
+      def initialize(**options)
+        @recording_strategy = DummyRecordingStrategy.new(recorder: self)
+        super(**options)
+      end
+    end
+
+    it "expects a file name" do
+      expect { ZipFileRecorder.new }.to raise_error
+    end
+
+    it "generates a .trecs compressed file" do
+      file_name = "tmp/i_should_exist.trecs"
+      recorder  = DummyZipFileRecorder.new(file_name: file_name)
+
+      recorder.record
+
+      File.exists?(file_name).should be_true
+      expect { Zip::File.open(file_name) }.not_to raise_error(Zip::ZipError)
+    end
+
+    it "has the correct frames" do
+      file_name = "tmp/zero_one_two.trecs"
+      recorder  = DummyZipFileRecorder.new(file_name: file_name)
+
+      recorder.record
+
+      player = ZipFilePlayer.new(file_name: file_name)
+
+      player.timestamps.should == [0, 1, 2]
+      player.get_frame(0).should == "zero"
+      player.get_frame(1).should == "one"
+      player.get_frame(2).should == "two"
+    end
+
+  end
+end

data/trecs.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+bin = File.expand_path('../bin', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+$LOAD_PATH.unshift(bin) unless $LOAD_PATH.include?(bin)
+require 'trecs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "trecs"
+  spec.version       = TRecs::VERSION
+  spec.authors       = ["Federico Iachetti"]
+  spec.email         = ["iachetti.federico@gmail.com"]
+  spec.summary       = %q{TRecs: Text Recordings.}
+  spec.description   = %q{Record text screencasts.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib", "bin"]
+
+  # Dependencies
+  spec.add_dependency "rubyzip", "~> 1.0.0"
+  spec.add_dependency "trollop", "~> 2.0"
+
+  # Development dependencies
+  spec.add_development_dependency "bundler",     "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec",       "~> 2.12"
+  spec.add_development_dependency "rspec-given", "~> 3.5.4"
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification
+name: trecs
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+platform: ruby
+authors:
+- Federico Iachetti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: rspec-given
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.4
+description: Record text screencasts.
+email:
+- iachetti.federico@gmail.com
+executables:
+- trecs
+- trecs_message
+- trecs_terminal
+extensions: []
+extra_rdoc_files: []
+files:
+- ".bundle/config"
+- ".gitignore"
+- ".rspec"
+- ".spec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENCE.txt
+- README.org
+- Rakefile
+- bin/trecs
+- bin/trecs_message
+- bin/trecs_terminal
+- doc/steps.org
+- lib/player.rb
+- lib/players/zip_file_player.rb
+- lib/recorder.rb
+- lib/recorders/message_recorder.rb
+- lib/recorders/ttyrec_recorder.rb
+- lib/recorders/zip_file_recorder.rb
+- lib/recording_strategies/incremental_recording_strategy.rb
+- lib/recording_strategies/ttyrec_recording_strategy.rb
+- lib/recording_strategy.rb
+- lib/screens/terminal_screen.rb
+- lib/timestamps.rb
+- lib/trecs/version.rb
+- sandbox/create_recording.rb
+- sandbox/lipsum_end
+- sandbox/lipsum_start
+- sandbox/record
+- sandbox/record_diff
+- sandbox/record_script_file
+- spec/player_spec.rb
+- spec/recorder_spec.rb
+- spec/spec_helper.rb
+- spec/timestamps_spec.rb
+- spec/trecs_message_spec.rb
+- spec/trecs_spec.rb
+- spec/zip_file_recorder_spec.rb
+- trecs.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- bin
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: 'TRecs: Text Recordings.'
+test_files:
+- spec/player_spec.rb
+- spec/recorder_spec.rb
+- spec/spec_helper.rb
+- spec/timestamps_spec.rb
+- spec/trecs_message_spec.rb
+- spec/trecs_spec.rb
+- spec/zip_file_recorder_spec.rb