trecs 0.0.3 → 0.0.4

data/spec/trecs/recorder_spec.rb

@@ -0,0 +1,227 @@
+require "spec_helper"
+require "recorder"
+require "recording_strategies/hash_strategy"
+require "recording_strategies/custom_strategy"
+
+module TRecs
+  describe Recorder do
+    context "initialization" do
+      Given(:writer)   { OpenStruct.new }
+      Given(:strategy) { OpenStruct.new }
+
+      When(:recorder) {
+        Recorder.new(
+          writer: writer,
+          strategy: strategy,
+          )
+      }
+
+      Then { recorder.writer == writer }
+      Then { writer.recorder == recorder}
+
+      Then { recorder.strategy == strategy }
+      Then { strategy.recorder == recorder}
+
+      Then { recorder.step == 100}
+    end
+
+    context "Recording" do
+      Given { Spy.clear }
+      Given(:writer)   { Spy.new("writer").ignore(:recorder=) }
+      Given(:strategy) { Spy.new("strategy").ignore(:recorder=) }
+      Given(:recorder) {
+        Recorder.new(writer: writer, strategy: strategy)
+      }
+
+      When { recorder.record }
+
+      Then { Spy.calls[1] == ["writer",   :setup,   []] }
+      Then { Spy.calls[2] == ["strategy", :perform, []] }
+      Then { Spy.calls[3] == ["writer",   :render,  []] }
+    end
+
+    context "#recording" do
+      Given(:writer)   { OpenStruct.new }
+      Given(:strategy) { OpenStruct.new }
+      Given(:recorder) {
+        Recorder.new(writer: writer, strategy: strategy)
+      }
+
+      context "before start" do
+        Then { recorder.recording == false }
+      end
+
+      context "when recording" do
+        Given(:strategy) { CustomStrategy.new }
+
+        When(:recording) {
+          result = nil
+          strategy.action = -> { result = recorder.recording }
+          recorder.record
+          result
+        }
+        Then { recording == true }
+      end
+
+      context "after finished start" do
+        When { recorder.record }
+        Then { recorder.recording == false }
+      end
+    end
+
+    context "#current_frame" do
+      Given   { Spy.clear }
+      Given(:writer)   { Spy.new("Writer").ignore(:recorder=, :setup, :render) }
+      Given(:strategy) { CustomStrategy.new }
+
+      Given(:recorder) {
+        Recorder.new(writer: writer, strategy: strategy)
+      }
+
+      context "setting current frame and time" do
+        When(:result) {
+          result = []
+          strategy.action = -> {
+            recorder.current_frame(time: 10, content: "CONTENT")
+            result << {
+              time: recorder.current_time,
+              content: recorder.current_content,
+            }
+            recorder.current_frame(time: 15, content: "CONTENT 2")
+            result << {
+              time: recorder.current_time,
+              content: recorder.current_content,
+            }
+          }
+          recorder.record
+          result
+        }
+
+        Then {
+          result == [
+            {time: 10, content: "CONTENT"},
+            {time: 15, content: "CONTENT 2"},
+          ]
+        }
+        Then {
+          writer.calls[1] == [
+            :create_frame,
+            [ { time: 10, content: "CONTENT" } ]
+          ]
+        }
+        Then {
+          writer.calls[2] == [
+            :create_frame,
+            [ { time: 15, content: "CONTENT 2" } ]
+          ]
+        }
+      end
+    end
+
+    context "#current_frame" do
+      Given   { Spy.clear }
+      Given(:writer)   { Spy.new("Writer").ignore(:recorder=, :setup, :render) }
+      Given(:strategy) { CustomStrategy.new }
+
+      Given(:recorder) {
+        Recorder.new(writer: writer, strategy: strategy)
+      }
+
+      context "setting current frame and time with content duplicates" do
+        When(:result) {
+          result = []
+          strategy.action = -> {
+            recorder.current_frame(time: 10, content: "CONTENT")
+            result << {
+              time: recorder.current_time,
+              content: recorder.current_content,
+            }
+            recorder.current_frame(time: 15, content: "CONTENT 2")
+            result << {
+              time: recorder.current_time,
+              content: recorder.current_content,
+            }
+            recorder.current_frame(time: 20, content: "CONTENT 2")
+            result << {
+              time: recorder.current_time,
+              content: recorder.current_content,
+            }
+            recorder.current_frame(time: 25, content: "CONTENT 3")
+            result << {
+              time: recorder.current_time,
+              content: recorder.current_content,
+            }
+          }
+          recorder.record
+          result
+        }
+
+        Then {
+          writer.calls[1] == [
+            :create_frame,
+            [ { time: 10, content: "CONTENT" } ]
+          ]
+        }
+        Then {
+          writer.calls[2] == [
+            :create_frame,
+            [ { time: 15, content: "CONTENT 2" } ]
+          ]
+        }
+        Then {
+          writer.calls[3] == [
+            :create_frame,
+            [ { time: 25, content: "CONTENT 3" } ]
+          ]
+        }
+      end
+    end
+
+    context "#next_timestamp" do
+      Given(:writer)   { OpenStruct.new }
+      Given(:strategy) { OpenStruct.new }
+
+      Given(:recorder) {
+        Recorder.new(
+          writer:   writer,
+          strategy: strategy,
+          step:     50
+          )
+      }
+
+      context "no stepping" do
+        Then { recorder.current_time == nil }
+      end
+
+      context "one step" do
+        When { recorder.next_timestamp == 0 }
+        Then { recorder.current_time   == 0 }
+      end
+
+      context "two step" do
+        When {
+          recorder.next_timestamp
+          recorder.next_timestamp  == 50
+        }
+        Then { recorder.current_time   == 50 }
+      end
+    end
+
+    context "#next_timestamp" do
+      Given { Spy.clear }
+      Given(:writer)   { OpenStruct.new }
+      Given(:strategy) { Spy.new("strategy").ignore(:recorder=) }
+
+      Given(:recorder) {
+        Recorder.new(
+          writer:   writer,
+          strategy: strategy,
+          )
+      }
+
+      When { recorder.stop }
+
+      Then { strategy.calls[1] == [:stop, []] }
+    end
+  end
+end

data/spec/trecs/recording_strategies/incremental_strategy_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+require "recording_strategies/incremental_strategy"
+
+module TRecs
+  describe IncrementalStrategy do
+    context "initialization" do
+      When(:strategy1) { IncrementalStrategy.new(message: "HELLO") }
+      Then { strategy1.message == "HELLO" }
+      
+      When(:strategy2) { IncrementalStrategy.new }
+      Then { expect(strategy2).to have_failed(KeyError, /message/) }
+    end
+
+    context "recorder" do
+      Given(:strategy) { IncrementalStrategy.new(message: "HELLO") }
+      Given(:recorder) { Object.new }
+      When { strategy.recorder = recorder }
+      Then { strategy.recorder == recorder }
+    end
+    
+    context "perform" do
+      Given { Spy.clear }
+      Given(:recorder) { Spy.new("recorder") }
+      Given(:strategy) { IncrementalStrategy.new(message: "Hello World") }
+
+      When { recorder.stub(:step) { 100 } }
+      When { strategy.recorder = recorder }
+      When { strategy.perform }
+
+      Then { recorder.calls[1]  == [:current_frame, [ {time: 0,    content: "H"}           ] ] }
+      Then { recorder.calls[2]  == [:current_frame, [ {time: 100,  content: "He"}          ] ] }
+      Then { recorder.calls[3]  == [:current_frame, [ {time: 200,  content: "Hel"}         ] ] }
+      Then { recorder.calls[4]  == [:current_frame, [ {time: 300,  content: "Hell"}        ] ] }
+      Then { recorder.calls[5]  == [:current_frame, [ {time: 400,  content: "Hello"}       ] ] }
+      Then { recorder.calls[6]  == [:current_frame, [ {time: 500,  content: "Hello "}      ] ] }
+      Then { recorder.calls[7]  == [:current_frame, [ {time: 600,  content: "Hello W"}     ] ] }
+      Then { recorder.calls[8]  == [:current_frame, [ {time: 700,  content: "Hello Wo"}    ] ] }
+      Then { recorder.calls[9]  == [:current_frame, [ {time: 800,  content: "Hello Wor"}   ] ] }
+      Then { recorder.calls[10] == [:current_frame, [ {time: 900,  content: "Hello Worl"}  ] ] }
+      Then { recorder.calls[11] == [:current_frame, [ {time: 1000, content: "Hello World"} ] ] }
+    end
+  end
+end

data/spec/trecs/recording_strategies/raw_file_strategy_spec.rb

@@ -0,0 +1,66 @@
+require "spec_helper"
+require "recording_strategies/raw_file_strategy"
+
+module TRecs
+  describe RawFileStrategy do
+    context "initialization" do
+      When(:strategy) { RawFileStrategy.new(file: "tmp/input_file.txt") }
+      Then { Pathname(strategy.file).to_s == "tmp/input_file.txt" }
+
+      context "file keyword" do
+        When(:strategy) { RawFileStrategy.new }
+        Then { expect(strategy).to have_failed(KeyError, /file/) }
+      end
+
+      context "file existence" do
+        Given(:existent)   { "tmp/exist.txt" }
+        Given(:inexistent) { "tmp/nope.txt" }
+        Given { FileUtils.touch(existent) }
+        Given { FileUtils.rm(inexistent, force: true) }
+
+        When(:strategy1) { RawFileStrategy.new(file: existent) }
+        Then { expect(strategy1).not_to have_failed }
+
+        When(:strategy2) { RawFileStrategy.new(file: inexistent) }
+        Then { expect(strategy2).to have_failed(Errno::ENOENT, /No such file or directory/) }
+      end
+    end
+
+    context "recorder" do
+      Given(:strategy) {
+        RawFileStrategy.new(file: "tmp/input_file.txt")
+      }
+      Given(:recorder) { Object.new }
+      When { strategy.recorder = recorder }
+      Then { strategy.recorder == recorder }
+    end
+
+    # context "perform" do
+    #   Given { Spy.clear }
+    #   Given(:recorder) { Spy.new("recorder").ignore }
+
+    #   Given(:input_file)   { "tmp/input_file.txt" }
+    #   Given(:clock) { DummyClock.new }
+
+    #   Given(:strategy) {
+    #     RawFileStrategy.new(
+    #       file: input_file,
+    #       clock: clock)
+    #   }
+
+    #   When { recorder.stub(:step) { 100 } }
+    #   When { strategy.recorder = recorder }
+
+    #   When { strategy.perform }
+    #   When {
+    #     File.open(input_file, "rw") do |f|
+    #       f.write "A"
+    #       clock.sleep()
+    #     end
+    #   }
+
+    #   When { strategy.stop }
+    #   Then { recorder.calls[1]  == [:current_frame, [ {time: 0,    content: "A"}           ] ] }
+    # end
+  end
+end

data/spec/trecs/writers/in_memory_writer_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+require "writers/in_memory_writer"
+
+module TRecs
+  describe InMemoryWriter do
+    context "recorder" do
+      Given(:writer) {
+        InMemoryWriter.new
+      }
+      Given(:recorder) { Object.new }
+      When { writer.recorder = recorder }
+      Then { writer.recorder == recorder }
+    end
+
+    context "recording frames" do
+      Given(:writer) {
+        InMemoryWriter.new
+      }
+      Given(:recorder) { Object.new }
+
+      context "after setup" do
+        When { writer.setup }
+        Then { writer.frames == {} }
+      end
+
+      context "after recording frames" do
+        When { writer.setup }
+        When { writer.create_frame(time: 0,   content: "A") }
+        When { writer.create_frame(time: 100, content: "B") }
+        When { writer.create_frame(time: 200, content: "C") }
+
+        Then {
+          writer.frames == {
+            0   => "A",
+            100 => "B",
+            200 => "C",
+          } }
+      end
+    end
+
+    context "render" do
+      Then { InMemoryWriter.new.respond_to?(:render) == true }
+    end
+  end
+end

data/trecs.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   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"]
+  spec.require_paths = ["lib", "lib/trecs", "bin"]
 
   # Dependencies
   spec.add_dependency "rubyzip", "~> 1.1.4"
@@ -28,4 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec",       "~> 2.12"
   spec.add_development_dependency "rspec-given", "~> 3.5.4"
+
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-nav"
 end

metadata

@@ -1,99 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: trecs
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Federico Iachetti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-11 00:00:00.000000000 Z
+date: 2014-06-17 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
     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
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-nav
+  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'
 description: Record text screencasts.
 email:
 - iachetti.federico@gmail.com
@@ -105,11 +133,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .bundle/config
-- .gitignore
-- .rspec
-- .spec
-- .travis.yml
+- ".bundle/config"
+- ".gitignore"
+- ".rspec"
+- ".spec"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENCE.txt
@@ -120,37 +148,46 @@ files:
 - bin/trecs_raw_file
 - 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/raw_file_recorder.rb
 - lib/recorders/ttyrec_recorder.rb
-- lib/recorders/zip_file_recorder.rb
-- lib/recording_strategies/incremental_recording_strategy.rb
-- lib/recording_strategies/raw_file_recording_strategy.rb
-- lib/recording_strategies/ttyrec_recording_strategy.rb
 - lib/recording_strategy.rb
-- lib/screens/terminal_screen.rb
 - lib/timestamps.rb
+- lib/trecs.rb
+- lib/trecs/player.rb
+- lib/trecs/recorder.rb
+- lib/trecs/recording_strategies/custom_strategy.rb
+- lib/trecs/recording_strategies/hash_strategy.rb
+- lib/trecs/recording_strategies/incremental_strategy.rb
+- lib/trecs/recording_strategies/raw_file_strategy.rb
+- lib/trecs/recording_strategies/ttyrec_recording_strategy.rb
+- lib/trecs/screens/terminal_screen.rb
 - lib/trecs/version.rb
+- lib/trecs/writers/in_memory_writer.rb
+- lib/trecs/writers/zip_file_writer.rb
+- old_specs/player_spec.rb
+- old_specs/recorders/zip_file_recorder_spec.rb
+- old_specs/timestamps_spec.rb
+- old_specs/trecs_message_spec.rb
+- old_specs/trecs_spec.rb
 - pkg/trecs-0.0.1.alpha.gem
 - pkg/trecs-0.0.1.alpha2.gem
 - pkg/trecs-0.0.2.alpha.gem
 - pkg/trecs-0.0.2.alpha2.gem
+- pkg/trecs-0.0.3.gem
 - 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
+- spec/trecs/player_spec.rb
+- spec/trecs/recorder_spec.rb
+- spec/trecs/recording_strategies/incremental_strategy_spec.rb
+- spec/trecs/recording_strategies/raw_file_strategy_spec.rb
+- spec/trecs/writers/in_memory_writer_spec.rb
 - tmp/.gitignore
 - trecs.gemspec
 homepage: ''
@@ -161,15 +198,16 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
+- lib/trecs
 - 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: '0'
 requirements: []
@@ -177,12 +215,11 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: ! 'TRecs: Text Recordings.'
+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
+- spec/trecs/player_spec.rb
+- spec/trecs/recorder_spec.rb
+- spec/trecs/recording_strategies/incremental_strategy_spec.rb
+- spec/trecs/recording_strategies/raw_file_strategy_spec.rb
+- spec/trecs/writers/in_memory_writer_spec.rb