asciinema-rails 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a77da9f1f221e64eff158e9a6f11bb996728c37f
+  data.tar.gz: c3ccee4badaeb98d419843073baf58aa5823dd1a
+SHA512:
+  metadata.gz: 3eda26b09f2775ca6e134bf2082d376aba12c5beba1bf4b1996daa73dc5c3ae11f2c0c79991b85531a980702cb2f139fa2ab9b0ef3c63a89f870454871b1a562
+  data.tar.gz: f4ae9674f9b853ecbdee0880e29a4ab79f699de0e56958a16538f836a082608a24d4d65a86f44768ed81580556f283d37ef131ccb6c4f5d3b834ccede7c63b82

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'railties'
+gem 'activesupport'
+gem 'oj'
+gem 'oj_mimic_json'
+gem 'yajl-ruby', '~> 1.2.1', :require => 'yajl'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Eddie Johnston
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,107 @@
+# Asciinema-Rails
+
+TLDR: Record terminal sessions from local or remote machines and play them back from your own website. See the demo at [http://eddiej.github.io/asciinema-rails](http://eddiej.github.io/asciinema-rails).
+
+Asciinema-rails is a gem that allows you to generate playback files from Asciinema asciicasts or Sudosh log files and host them from your own website using the bundled player.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'asciinema-rails'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it manually:
+
+    $ gem install asciinema-rails
+
+## Prerequisites
+
+Asciinema-rails gem depends on the binary `terminal` which must be compiled for your platform before using this gem. The source file `terminal.c` is located in the `/src` directory of the gem. Before compiling, you need to install a suitable version of the `libtsm` library for your platform. For Darwin based systems, a reliable source is 
+[https://github.com/skade/libtsm](https://github.com/skade/libtsm). For other distributions, see [http://www.freedesktop.org/wiki/Software/kmscon/libtsm](http://www.freedesktop.org/wiki/Software/kmscon/libtsm).
+
+Once `libtsm` has been installed, compile `terminal.c`:
+
+    $ gcc -O3 -o terminal terminal.c -ltsm
+
+The resulting binary file `terminal` should be placed in your binaries folder (e.g. `/usr/bin`), or added to the $PATH environment variable.
+
+
+## Usage
+
+Asciinema-rails consists of two parts - a Convertor module for creating player files, and an engine that provides the assets that allow you to playback the files from your own site.
+
+### Asciinema::Rails::Convertor
+
+Asciinema::Rails::Convertor has two methods, one to generate player files from Asciinema asciicast files, and another to covert Sudosh log files to the Asciinema asciicast format (which can then be used to create player files.)
+
+#### Creating playback files from asciicasts
+From within your Rails application or terminal, create playback files using the `asciicast_to_playback` function:
+
+    Asciinema::Rails::Convertor.asciicast_to_playback(asciicast_path, {playback_path: '/path/to/playback/file'})
+
+where `asciicast_path` is the path to the file created after running the Asciinema recorder and `playback_path` is the path to save the new file.
+
+#### Creating asciicasts from Sudosh log files
+To create a playback file from Sudosh log files, you must first covert them to the Asciinma asciicast format using the `sudosh_to_asciicast` function:
+
+    Asciinema::Rails::Convertor.sudosh_to_asciicast(sudosh_timing_file_path, sudosh_script_file_path, {asciicast_path: /path/to/asciicast/file})
+
+where `asciicast_path` is the path to save the new asciicast file. If the width and height of the Susodh session terminal are available, these values can be passed in as additional parameters so that the resulting player is the original size of the terminal session. Note that Playback files can be generated from the resulting asciicast using the `asciicast_to_playback` method above. 
+
+### Rails Engine
+
+To display a player from your app, you need to include the asciineama-rails javascript and stylesheet files in ```app/assets/javascripts/application.js```and ```app/assets/stylesheets/application.css respectively```:
+
+##### application.js
+    //= require asciinema-rails
+
+##### application.css
+    *= require asciinema-rails
+ 
+Then include the player markup and javascript in any of your views:
+
+    <div id='player-container'></div> <!-- the div that will contain the player -->
+
+    <%= javascript_tag do %>
+      $(function() {
+        function createPlayer() {
+          var source = new asciinema.HttpArraySource("recording.json", 1);
+          var snapshot = []
+          var movie = new asciinema.Movie(180, 43, source, snapshot, 9);
+
+          React.renderComponent(
+            asciinema.Player({ autoPlay: true, movie: movie }),
+            $('#player-container')[0]
+          );
+        }
+        createPlayer();
+      });
+    <% end %>
+
+In this example, the Asciinema player file `recording.json` has been placed in the public directory of the app. This can be replaced with a fully qualified url, as long as it points to a player file.
+
+The parameters sent to the `asciinema.Movie` constructor are the terminal width (cols), height (rows), playback file source, snapshot and playback speed. 
+The width, height and snapshot string are returned form the `Asciinema::Rails::Convertor.asciicast_to_playback` method. Typically, player files would be associated with a Rails model, and this information would be saved as model fields when the playback files are generated.
+
+
+## Testing
+The test for the gem are written in Rspec:
+
+    bundle exec rspec spec
+
+## Demo
+A demo of the player is available at [http://eddiej.github.io/asciinema-rails](http://eddiej.github.io/asciinema-rails). The embedded player shows a recording if the gem being installed and used in a new Rails application.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/asciinemosh/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/asciinema-rails.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'asciinema/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "asciinema-rails"
+  spec.version       = Asciinema::Rails::VERSION
+  spec.authors       = ["Eddie Johnston"]
+  spec.email         = ["eddie@beanstalk.ie"]
+  spec.summary       = %q{Converts sudosh log files to asciinema format. Provides JS and CSS includes to allow you host your own asciicasts.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "oj"
+  spec.add_dependency "oj_mimic_json"
+  spec.add_dependency "yajl-ruby", "~> 1.2.1"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3"
+  spec.add_development_dependency "rails"
+end

data/lib/asciinema-rails.rb

@@ -0,0 +1 @@
+require "asciinema/rails"

data/lib/asciinema/asciicast.rb

@@ -0,0 +1,44 @@
+require 'asciinema/terminal'
+require 'asciinema/stdout'
+
+class Asciicast
+
+
+  attr_reader :terminal_columns, :terminal_lines, :duration, :file, :version
+  attr_accessor :stdout_frames, :snapshot, :snapshot_at
+
+  def initialize(terminal_columns, terminal_lines, duration, file_location)
+    @terminal_columns = terminal_columns
+    @terminal_lines = terminal_lines
+    @duration = duration
+    @file = File.new(file_location)
+    @version = 1
+  end
+
+  
+
+
+  def stdout
+    return @stdout if @stdout
+    @stdout = Stdout::Buffered.new(get_stdout)
+  end
+
+  def with_terminal
+    terminal = Terminal.new(terminal_columns, terminal_lines)
+    yield(terminal)
+  ensure
+    terminal.release if terminal
+  end
+
+  private 
+
+  def get_stdout
+    if version == 0
+      Stdout::MultiFile.new(stdout_data.decompressed_path,
+                            stdout_timing.decompressed_path)
+    else
+      Stdout::SingleFile.new(file.path)
+    end
+  end
+
+end

data/lib/asciinema/asciicast_frames_file_updater.rb

@@ -0,0 +1,24 @@
+require 'asciinema/json_file_writer'
+
+class AsciicastFramesFileUpdater
+
+  def initialize(file_writer = JsonFileWriter.new)
+    @file_writer = file_writer
+  end
+
+  def update(asciicast, outfile_location=nil)
+    file = outfile_location.present? ? File.new(outfile_location, 'w') : Tempfile.new('outfile')
+    # file = File.new(new_outfile_location, 'w')
+
+    asciicast.with_terminal do |terminal|
+      film = Film.new(asciicast.stdout, terminal)
+      file_writer.write_enumerable(file, film.frames)
+    end
+    asciicast.stdout_frames = file
+  end
+
+  private
+
+  attr_reader :file_writer
+
+end

data/lib/asciinema/asciicast_snapshot_updater.rb

@@ -0,0 +1,20 @@
+require 'asciinema/film'
+
+
+class AsciicastSnapshotUpdater
+
+  def update(asciicast, at_seconds = nil)
+    at_seconds ||= asciicast.snapshot_at || asciicast.duration / 2
+    snapshot = generate_snapshot(asciicast, at_seconds)
+    asciicast.snapshot = snapshot
+  end
+
+  private
+
+  def generate_snapshot(asciicast, at_seconds)
+    asciicast.with_terminal do |terminal|
+      Film.new(asciicast.stdout, terminal).snapshot_at(at_seconds)
+    end
+  end
+
+end

data/lib/asciinema/brush.rb

@@ -0,0 +1,78 @@
+class Brush
+  require 'active_support/core_ext/hash'
+ 
+  ALLOWED_ATTRIBUTES = [:fg, :bg, :bold, :underline, :inverse, :blink]
+  DEFAULT_FG_CODE = 7
+  DEFAULT_BG_CODE = 0
+
+  def initialize(attributes = {})
+    @attributes = attributes.symbolize_keys
+  end
+
+  def ==(other)
+    fg == other.fg &&
+      bg == other.bg &&
+      bold? == other.bold? &&
+      underline? == other.underline? &&
+      blink? == other.blink?
+  end
+
+  def fg
+    inverse? ? bg_code || DEFAULT_BG_CODE : fg_code
+  end
+
+  def bg
+    inverse? ? fg_code || DEFAULT_FG_CODE : bg_code
+  end
+
+  def bold?
+    !!attributes[:bold]
+  end
+
+  def underline?
+    !!attributes[:underline]
+  end
+
+  def inverse?
+    !!attributes[:inverse]
+  end
+
+  def blink?
+    !!attributes[:blink]
+  end
+
+  def default?
+    fg.nil? && bg.nil? && !bold? && !underline? && !inverse? && !blink?
+  end
+
+  def as_json(*)
+    attributes.slice(*ALLOWED_ATTRIBUTES)
+  end
+
+  protected
+
+  attr_reader :attributes
+
+  private
+
+  def fg_code
+    calculate_code(:fg, bold?)
+  end
+
+  def bg_code
+    calculate_code(:bg, blink?)
+  end
+
+  def calculate_code(attr_name, strong)
+    code = attributes[attr_name]
+
+    if code
+      if code < 8 && strong
+        code += 8
+      end
+    end
+
+    code
+  end
+
+end

data/lib/asciinema/cell.rb

@@ -0,0 +1,33 @@
+require 'active_support/core_ext/module/delegation.rb'
+
+class Cell
+
+  attr_reader :text, :brush
+
+  delegate :size, :to => :text
+
+  def initialize(text, brush)
+    @text = text
+    @brush = brush
+  end
+
+  def empty?
+    text.blank? && brush.default?
+  end
+
+  def ==(other)
+    text == other.text && brush == other.brush
+  end
+
+  def [](*args)
+    self.class.new(text[*args], brush)
+  end
+
+  def as_json(*)
+    [text, brush.as_json]
+  end
+
+  def to_f
+    size
+  end
+end

data/lib/asciinema/cursor.rb

@@ -0,0 +1,18 @@
+class Cursor
+
+  attr_reader :x, :y, :visible
+
+  def initialize(x, y, visible)
+    @x, @y, @visible = x, y, visible
+  end
+
+  def diff(other)
+    diff = {}
+    diff[:x] = x if other && x != other.x || other.nil?
+    diff[:y] = y if other && y != other.y || other.nil?
+    diff[:visible] = visible if other && visible != other.visible || other.nil?
+
+    diff
+  end
+
+end

data/lib/asciinema/film.rb

@@ -0,0 +1,40 @@
+require 'asciinema/frame'
+require 'asciinema/frame_diff_list'
+
+class Film
+
+  def initialize(stdout, terminal)
+    @stdout = stdout
+    @terminal = terminal
+  end
+
+  def snapshot_at(time)
+    stdout_each_until(time) do |delay, data|
+      terminal.feed(data)
+    end
+
+    terminal.snapshot
+  end
+
+  def frames
+    frames = stdout.map do |delay, data|
+      terminal.feed(data)
+      [delay, Frame.new(terminal.snapshot, terminal.cursor)]
+    end
+
+    FrameDiffList.new(frames)
+  end
+
+  private
+
+  def stdout_each_until(seconds)
+    stdout.each do |delay, frame_data|
+      seconds -= delay
+      break if seconds <= 0
+      yield(delay, frame_data)
+    end
+  end
+
+  attr_reader :stdout, :terminal
+
+end