ansi-sys 0.2.0

data/spec/attach/test_data.html

@@ -0,0 +1,17 @@
+<pre class="screen" style="background-color: black; padding: 0.5em; color: white; width: 40.0em">
+
+As a Hiki plugin
+<span style="color: fuchsia">- should render an HTML fragment as expected (ERROR - 1)
+
+</span>1)
+<span style="color: fuchsia">NoMethodError in 'As a Hiki plugin should render an HTML fragment as expected'
+undefined method `join' for 114:Fixnum
+</span>lib/ansisys.rb:23:in `hash_to_styles'
+./spec/hiki_spec.rb:27:in `map'
+lib/ansisys.rb:23:in `hash_to_styles'
+lib/ansisys.rb:589:in `ansi_screen'
+./spec/hiki_spec.rb:37:
+
+Finished in 0.158791 seconds
+
+<span style="color: red">1 example, 1 failure</span></pre>

data/spec/attach/test_data.txt

@@ -0,0 +1,16 @@
+
+As a Hiki plugin
+- should render an HTML fragment as expected (ERROR - 1)
+
+1)
+NoMethodError in 'As a Hiki plugin should render an HTML fragment as expected'
+undefined method `join' for 114:Fixnum
+lib/ansisys.rb:23:in `hash_to_styles'
+./spec/hiki_spec.rb:27:in `map'
+lib/ansisys.rb:23:in `hash_to_styles'
+lib/ansisys.rb:589:in `ansi_screen'
+./spec/hiki_spec.rb:37:
+
+Finished in 0.158791 seconds
+
+1 example, 1 failure

data/spec/character_screen_spec.rb

@@ -0,0 +1,32 @@
+$:.unshift('lib')
+require 'ansisys'
+
+unless defined?(:SGR)
+	class SGR
+	end
+end
+
+include AnsiSys
+describe "Normal characters echoed on a Screen" do
+	before do
+		@string = "Test string <HELLO>"
+		@char = Characters.new(@string, SGR.new)
+		@screen = Screen.new
+		@cursor = Cursor.new
+	end
+
+	it "should usually be distributed identical string onto screen" do
+		@char.echo_on(@screen, @cursor)
+		@screen.render(:text).should == <<_SCREEN.chomp
+Test string <HELLO>
+_SCREEN
+	end
+
+	it "should be HTML escaped when rendered as an HTML fragment" do
+		@char.echo_on(@screen, @cursor)
+		@screen.render(:html).should == <<_SCREEN.chomp
+<pre class="screen">\nTest string &lt;HELLO&gt;</pre>
+_SCREEN
+	end
+end
+

data/spec/character_spec.rb

@@ -0,0 +1,45 @@
+$:.unshift('lib')
+require 'ansisys'
+
+include AnsiSys
+# This spec is dependent upon Screen, Cursor, and SGR
+
+def echo(string, col, row)
+	@screen = Screen.new
+	@char = Characters.new(string, SGR.new)
+	@cursor = Cursor.new(col, row, 80, 25)
+	@char.echo_on(@screen, @cursor)
+end
+
+describe Characters, "when rendered at the right edge" do
+  before do
+		echo("Test string <HELLO>", 75, 1)
+  end
+
+	it "should fold the string at the right edge" do
+		@cursor.cur_row.should == 2
+		@cursor.cur_col.should == 14
+	end
+end
+
+describe Characters, "with Japanese characters" do
+	before do
+		$KCODE = 'u'
+		echo("\346\227\245\346\234\254\350\252\236", 1, 1)	# `Nihongo' in UTF-8
+	end
+
+	it "sohuld assume each occupies 2 columns" do
+		@cursor.cur_col.should == 7
+	end
+end
+
+describe Characters, "with tab" do
+	before do
+		echo("\t", 1, 1)
+	end
+
+	it "sohuld assume it occupies 8 columns" do
+		@cursor.cur_col.should == 9
+	end
+end
+

data/spec/cursor_spec.rb

@@ -0,0 +1,165 @@
+$:.unshift('lib')
+require 'ansisys'
+
+include AnsiSys
+describe Cursor, 'when initialized' do
+  before do
+    @cursor = Cursor.new
+  end
+
+  it "should be at (1,1) on screen" do
+		@cursor.cur_col.should == 1
+		@cursor.cur_row.should == 1
+	end
+
+	it "should be in (80,25) screen" do
+		@cursor.max_col.should == 80
+		@cursor.max_row.should == 25
+	end
+end
+
+describe Cursor, 'when moved normally' do
+	before do
+		@cursor = Cursor.new
+		@cursor.instance_variable_set('@cur_col', 5)
+		@cursor.instance_variable_set('@cur_row', 5)
+	end
+
+	it "should move up with code CUU" do
+		lambda{@cursor.apply_code!(%w(A))}.should change(@cursor, :cur_row).by(-1)
+		lambda{@cursor.apply_code!(%w(1 A))}.should change(@cursor, :cur_row).by(-1)
+		lambda{@cursor.apply_code!(%w(2 A))}.should change(@cursor, :cur_row).by(-2)
+	end
+
+	it "should move down with code CUD" do
+		lambda{@cursor.apply_code!(%w(B))}.should change(@cursor, :cur_row).by(1)
+		lambda{@cursor.apply_code!(%w(1 B))}.should change(@cursor, :cur_row).by(1)
+		lambda{@cursor.apply_code!(%w(2 B))}.should change(@cursor, :cur_row).by(2)
+	end
+
+	it "should move to right with code CUF" do
+		lambda{@cursor.apply_code!(%w(C))}.should change(@cursor, :cur_col).by(1)
+		lambda{@cursor.apply_code!(%w(1 C))}.should change(@cursor, :cur_col).by(1)
+		lambda{@cursor.apply_code!(%w(2 C))}.should change(@cursor, :cur_col).by(2)
+	end
+
+	it "should move to left with code CUB" do
+		lambda{@cursor.apply_code!(%w(D))}.should change(@cursor, :cur_col).by(-1)
+		lambda{@cursor.apply_code!(%w(1 D))}.should change(@cursor, :cur_col).by(-1)
+		lambda{@cursor.apply_code!(%w(2 D))}.should change(@cursor, :cur_col).by(-2)
+	end
+
+	it "should move to beggining of lower line with CNL" do
+		[[1, %w(E)], [1, %w(1 E)], [2, %w(2 E)]].each do |d, code|
+			lambda{@cursor.apply_code!(code)}.should change(@cursor, :cur_row).by(d)
+			@cursor.cur_col.should == 1
+		end
+	end
+
+	it "should move to beggining of upper line with CPL" do
+		[[-1, %w(F)], [-1, %w(1 F)], [-2, %w(2 F)]].each do |d, code|
+			lambda{@cursor.apply_code!(code)}.should change(@cursor, :cur_row).by(d)
+			@cursor.cur_col.should == 1
+		end
+	end
+
+	it "should move to specified column with CHA" do
+		[[1, %w(G)], [1, %w(1 G)], [2, %w(2 G)]].each do |c, code|
+			lambda{@cursor.apply_code!(code)}.should_not change(@cursor, :cur_row)
+			@cursor.cur_col.should == c
+		end
+	end
+
+	it "should move to specified position with CUP and HVP" do
+		%w(H f).each do |letter|
+			[
+				# row, column, code
+				[1, 5, [nil, '5']],
+				[1, 5, ['', '5']],
+				[1, 5, ['1', '5']],
+				[17, 1, ['17', nil]],
+				[17, 1, ['17', '']],
+				[17, 1, ['17', '1']],
+				[9, 8, ['9', '8']],
+			].each do |r, c, code|
+				@cursor.apply_code!(code + [letter])
+				@cursor.cur_col.should == c
+				@cursor.cur_row.should == r
+			end
+		end
+	end
+
+end
+
+describe Cursor, 'when tried to be moved beyond edge' do
+	before do
+		@cursor = Cursor.new
+	end
+
+	it "should not move with code CUU" do
+		@cursor.instance_variable_set('@cur_row', 1)
+		lambda{@cursor.apply_code!(%w(1 A))}.should_not change(@cursor, :cur_row)
+	end
+
+	it "should not move with code CUD" do
+		@cursor.instance_variable_set('@cur_row', @cursor.max_row)
+		lambda{@cursor.apply_code!(%w(1 B))}.should_not change(@cursor, :cur_row)
+	end
+
+	it "should not move with code CUF" do
+		@cursor.instance_variable_set('@cur_col', @cursor.max_col)
+		lambda{@cursor.apply_code!(%w(1 C))}.should_not change(@cursor, :cur_col)
+	end
+
+	it "should not move with code CUB" do
+		@cursor.instance_variable_set('@cur_col', 1)
+		lambda{@cursor.apply_code!(%w(1 D))}.should_not change(@cursor, :cur_col)
+	end
+
+	it "should make screen longer with code CNL" do
+		@cursor.instance_variable_set('@cur_row', @cursor.max_row)
+		lambda{@cursor.apply_code!(%w(1 E))}.should change(@cursor, :max_row).by(1)
+	end
+
+	it "should not change row with code CNL" do
+		@cursor.instance_variable_set('@cur_row', 1)
+		lambda{@cursor.apply_code!(%w(1 F))}.should_not change(@cursor, :cur_row)
+	end
+
+	it "should move to edge column with code CHA" do
+		lambda{@cursor.apply_code!(%w(99 G))}.should change(@cursor, :cur_col).to(@cursor.max_col)
+	end
+
+end
+
+describe Cursor, 'when advanced' do
+	it "should move to the next column for a usual move" do
+		cursor = Cursor.new(1, 1, 80, 25)
+		lambda{cursor.advance!}.should change(cursor, :cur_col).by(1)
+		[1, 2, 3].each do |w|
+			lambda{cursor.advance!(w)}.should change(cursor, :cur_col).by(w)
+		end
+		cursor = Cursor.new(79, 1, 80, 25)
+		lambda{cursor.advance!}.should change(cursor, :cur_col).by(1)
+	end
+
+	it "should move to the next row from the right edge" do
+		cursor = Cursor.new(80, 1, 80, 25)
+		lambda{cursor.advance!(1)}.should change(cursor, :cur_row).by(1)
+		cursor.cur_col.should == 1
+	end
+
+	it "should return nil for a usual move" do
+		cursor = Cursor.new(1, 1, 80, 25)
+		[1, 2, 3].each do |w|
+			cursor.advance!(w).should == nil
+		end
+	end
+	
+	it "should return \"\\n\" going beyond the right edge" do
+		cursor = Cursor.new(80, 1, 80, 25)
+		cursor.advance!(1).should == "\n"
+	end
+	
+end
+

data/spec/hiki_spec.rb

@@ -0,0 +1,39 @@
+describe "As a Hiki plugin" do
+	before do
+		include 'webrick'
+		class String
+			def escape
+				WEBrick::HTTPUtils.escape(self)
+			end
+		end
+
+		module Hiki
+			class Conf
+				def cache_path
+					'./spec'
+				end
+			end
+
+			class PluginError < StandardError; end
+
+			class Plugin
+				def initialize
+					@page = '.'
+					@conf = Conf.new
+				end
+
+				def load_plugin
+					lib = 'lib/ansisys.rb'
+					instance_eval(File.read(lib), lib, 1)
+				end
+			end
+		end
+
+		@plugin = Hiki::Plugin.new
+		@plugin.load_plugin
+	end
+
+	it "should render an HTML fragment as expected" do
+		@plugin.ansi_screen('test_data.txt').should == File.read('spec/attach/test_data.html')
+	end
+end

data/spec/lexer_spec.rb

@@ -0,0 +1,95 @@
+$:.unshift('lib')
+require 'ansisys'
+
+include AnsiSys
+describe Lexer::PARAMETER_AND_LETTER, "a regexp for parameters and a letter" do
+	it 'should not match partial code' do
+		m = Lexer::PARAMETER_AND_LETTER.match("32")
+		m.should == nil
+	end
+
+	it 'should match a code without parameter' do
+		m = Lexer::PARAMETER_AND_LETTER.match("m")
+		m.should_not == nil
+		m[2].should == 'm'
+	end
+
+	it 'should match a code with a parameter' do
+		m = Lexer::PARAMETER_AND_LETTER.match("32m")
+		m.should_not == nil
+		m[1].should == '32'
+		m[2].should == 'm'
+	end
+
+	it 'should match a code with two parameters' do
+		m = Lexer::PARAMETER_AND_LETTER.match("32;0m")
+		m.should_not == nil
+		m[1].should == '32;0'
+		m[2].should == 'm'
+	end
+
+	it 'should match a code with three parameters' do
+		m = Lexer::PARAMETER_AND_LETTER.match("32;0;1m")
+		m.should_not == nil
+		m[1].should == '32;0;1'
+		m[2].should == 'm'
+	end
+
+	it 'should match a code with three and omitted parameters' do
+		m = Lexer::PARAMETER_AND_LETTER.match("32;;1m")
+		m.should_not == nil
+		m[1].should == '32;;1'
+		m[2].should == 'm'
+	end
+end
+
+describe Lexer do
+	before do
+		@lexer = Lexer.new(["\x1b["])
+	end
+
+	it 'should return usual string as it is' do
+		x = 'Usual string.'
+		@lexer.push(x)
+		@lexer.buffer.should == x
+		@lexer.lex!.should == [[:string, x]]
+		@lexer.buffer.should be_empty
+	end
+
+	it 'should return nothing if a code is not complete' do
+		@lexer.push("\x1b[32")
+		@lexer.lex!.should be_empty
+		@lexer.buffer.should_not be_empty
+	end
+
+	it 'should return string and code' do
+		@lexer.push("string one\x1b[32mstring two")
+		@lexer.lex!.should == [[:string, 'string one'], [:code, '32m'], [:string, 'string two']]
+		@lexer.buffer.should be_empty
+	end
+
+	it 'should translate LF to a codes E' do
+		@lexer.push("line one\nline two\n")
+		@lexer.lex!.should == [[:string, 'line one'], [:code, 'E'], [:string, 'line two'], [:code, 'E']]
+		@lexer.buffer.should be_empty
+	end
+
+	it 'should translate CRLF to a code E' do
+		@lexer.push("line one\r\nline two\r\n")
+		@lexer.lex!.should == [[:string, 'line one'], [:code, 'E'], [:string, 'line two'], [:code, 'E']]
+		@lexer.buffer.should be_empty
+	end
+
+	it 'should translate LFCR to a coden E' do
+		@lexer.push("line one\n\rline two\n\r")
+		@lexer.lex!.should == [[:string, 'line one'], [:code, 'E'], [:string, 'line two'], [:code, 'E']]
+		@lexer.buffer.should be_empty
+	end
+
+	it 'should translate CR to a code B' do
+		@lexer.push("line one\rline two\r")
+		@lexer.lex!.should == [[:string, 'line one'], [:code, 'B'], [:string, 'line two'], [:code, 'B']]
+		@lexer.buffer.should be_empty
+	end
+
+end

data/spec/screen_spec.rb

@@ -0,0 +1,164 @@
+$:.unshift('lib')
+require 'ansisys'
+unless defined?(:SGR)
+	class SGR
+	end
+end
+
+include AnsiSys
+describe Screen, "when rendered as a plain text" do
+	before do
+		@screen = Screen.new
+		@sgr = SGR.new
+	end
+
+	it "should store character at the given location" do
+		@screen.write('t', 1, 3, 5, @sgr)
+		@screen.instance_variable_get(:@lines)[5][3].should == ['t', 1, SGR.new]
+	end
+	
+	it "should overwrite character" do
+		@screen.write('t', 1, 3, 5, @sgr)
+		@screen.write('u', 1, 3, 5, @sgr)
+		@screen.instance_variable_get(:@lines)[5][3].should == ['u', 1, SGR.new]
+	end
+end
+
+describe Screen, "when rendered" do
+	before do
+		@screen = Screen.new
+		@sgr = SGR.new
+	end
+
+	it "should render Ascii characters" do
+		@screen.write('h', 1, 3, 2, @sgr)
+		@screen.write('e', 1, 4, 2, @sgr)
+		@screen.write('l', 1, 5, 2, @sgr)
+		@screen.write('l', 1, 6, 2, @sgr)
+		@screen.write('o', 1, 7, 2, @sgr)
+		@screen.render(:text).should == <<_SCREEN.chomp
+
+  hello
+_SCREEN
+	end
+
+	it "should render wide characters" do
+		@screen.write('h-', 2, 3, 2, @sgr)
+		@screen.write('e-', 2, 5, 2, @sgr)
+		@screen.write('l-', 2, 7, 2, @sgr)
+		@screen.write('l-', 2, 9, 2, @sgr)
+		@screen.write('o-', 2, 11, 2, @sgr)
+		@screen.render(:text).should == <<_SCREEN.chomp
+
+  h-e-l-l-o-
+_SCREEN
+	end
+end
+
+describe Screen, "when rendered as an HTML fragment" do
+	before do
+		@screen = Screen.new
+		@sgr = SGR.new
+		@screen.write('h', 1, 3, 1, @sgr)
+		@screen.write('e', 1, 4, 1, @sgr)
+		@screen.write('l', 1, 5, 1, @sgr)
+		@screen.write('l', 1, 6, 1, @sgr)
+		@screen.write('o', 1, 7, 1, @sgr)
+	end
+
+	it "should be surrounded with <pre>" do
+		@screen.render(:html).should == <<_SCREEN.chomp
+<pre class="screen">\n  hello</pre>
+_SCREEN
+	end
+
+	it "should change colors" do
+		@sgr.apply_code!(%w(32 m))
+		@screen.write(':', 1, 1, 1, @sgr)
+		@screen.write(')', 1, 2, 1, @sgr)
+		@screen.render(:html).should == <<_SCREEN.chomp
+<pre class="screen">\n<span style="color: green">:)</span>hello</pre>
+_SCREEN
+	end
+end
+
+describe "screen with default colors set", :shared => true do
+	it "should only specify colors of special color letters" do
+		@screen.render(:html).should == <<_SCREEN.chomp
+<pre class="screen">\n<span style="color: green">:)</span>hello</pre>
+_SCREEN
+	end
+end
+
+describe Screen, "with default colors" do
+	before do
+		@screen = Screen.new
+		@sgr = SGR.new
+		@screen.write('h', 1, 3, 1, @sgr)
+		@screen.write('e', 1, 4, 1, @sgr)
+		@screen.write('l', 1, 5, 1, @sgr)
+		@screen.write('l', 1, 6, 1, @sgr)
+		@screen.write('o', 1, 7, 1, @sgr)
+		@sgr.apply_code!(%w(32 m))
+		@screen.write(':', 1, 1, 1, @sgr)
+		@screen.write(')', 1, 2, 1, @sgr)
+	end
+
+	it_should_behave_like "screen with default colors set"
+
+	it "should have default css style with silver letters on black background" do
+		css = @screen.css_style
+		css.should include('color: silver;')
+		css.should include('background-color: black;')
+	end
+end
+
+describe Screen, "with inverted colors" do
+	before do
+		@screen = Screen.new(Screen.default_css_colors(true))
+		@sgr = SGR.new
+		@screen.write('h', 1, 3, 1, @sgr)
+		@screen.write('e', 1, 4, 1, @sgr)
+		@screen.write('l', 1, 5, 1, @sgr)
+		@screen.write('l', 1, 6, 1, @sgr)
+		@screen.write('o', 1, 7, 1, @sgr)
+		@sgr.apply_code!(%w(32 m))
+		@screen.write(':', 1, 1, 1, @sgr)
+		@screen.write(')', 1, 2, 1, @sgr)
+	end
+
+	it_should_behave_like "screen with default colors set"
+
+	it "should have default css style with black letters on white background" do
+		css = @screen.css_style
+		css.should include('color: black;')
+		css.should include('background-color: silver;')
+	end
+end
+
+describe Screen, "with bright colors" do
+	before do
+		@screen = Screen.new(Screen.default_css_colors(false, true))
+		@sgr = SGR.new
+		@screen.write('h', 1, 3, 1, @sgr)
+		@screen.write('e', 1, 4, 1, @sgr)
+		@screen.write('l', 1, 5, 1, @sgr)
+		@screen.write('l', 1, 6, 1, @sgr)
+		@screen.write('o', 1, 7, 1, @sgr)
+		@sgr.apply_code!(%w(32 m))
+		@screen.write(':', 1, 1, 1, @sgr)
+		@screen.write(')', 1, 2, 1, @sgr)
+	end
+
+	it "should have colors as specified" do
+		@screen.render(:html).should == <<_SCREEN.chomp
+<pre class="screen">\n<span style="color: lime">:)</span>hello</pre>
+_SCREEN
+	end
+
+	it "should have default css style with black letters on white background" do
+		css = @screen.css_style
+		css.should include('color: white;')
+		css.should include('background-color: black;')
+	end
+end