ansi-sys 0.2.0

data/spec/sgr_spec.rb

@@ -0,0 +1,172 @@
+$:.unshift('lib')
+require 'ansisys'
+
+include AnsiSys
+describe SGR, 'when initialized' do
+  before do
+    @sgr = SGR.new
+  end
+
+  it "should have normal intensity" do @sgr.intensity.should == :normal; end
+  it "should have italic off" do @sgr.italic.should == :off; end
+  it "should have no underline" do @sgr.underline.should == :none; end
+  it "should have blink off" do @sgr.blink.should == :off; end
+  it "should have positive image" do @sgr.image.should == :positive; end
+  it "should have conceal off" do @sgr.conceal.should == :off; end
+  it "should have white foreground color" do @sgr.foreground.should == :white; end
+  it "should have black background color" do @sgr.background.should == :black; end
+end
+
+describe SGR, 'when two are initialized' do
+  before do
+    @sgr1 = SGR.new
+    @sgr2 = SGR.new
+  end
+
+  it 'should be equal when initialized' do @sgr1.should == @sgr2; end
+  it 'should be different after a code is executed' do
+    @sgr2.apply_code!(%w(1 m))
+    @sgr1.should_not == @sgr2
+  end
+end
+
+describe SGR, 'when a code is executed' do
+  before do
+    @sgr = SGR.new
+  end
+
+  class Object
+    def change_only(accessor, expected, &block)
+      yield(self)
+      self.send(accessor).should == expected
+      other = self.class.new
+      other.instance_variable_set("@#{accessor}", expected)
+      other.should == self
+    end
+  end
+
+	it 'should treat empty parameter as a code 0' do
+		@sgr.apply_code!(['m'])
+		@sgr.should == SGR.new
+	end
+  it 'should have bold intensity with a code 1' do
+    @sgr.change_only(:intensity, :bold){|x| x.apply_code!(%w(1 m))}
+  end
+  it 'should have faint intensity with a code 2' do
+    @sgr.change_only(:intensity, :faint){|x| x.apply_code!(%w(2 m))}
+  end
+  it 'should be italic with a code 3' do
+    @sgr.change_only(:italic, :on){|x| x.apply_code!(%w(3 m))}
+  end
+  it 'should have single underline with a code 4' do
+    @sgr.change_only(:underline, :single){|x| x.apply_code!(%w(4 m))}
+  end
+  it 'should be concealed with a code 8' do
+    @sgr.change_only(:conceal, :on){|x| x.apply_code!(%w(8 m))}
+  end
+  it 'should be revealed with a code 28' do
+    @sgr.change_only(:conceal, :off) do |x|
+			x.apply_code!(%w(8 m))
+			x.apply_code!(%w(28 m))
+		end
+  end
+  it 'should have green foreground with normal intensity with a code 32' do
+    @sgr.apply_code!(%w(1 m))
+    @sgr.apply_code!(%w(32 m))
+    @sgr.foreground.should == :green
+    @sgr.intensity.should == :normal
+  end
+  it 'should have white foreground with normal intensity with a code 39' do
+    @sgr.apply_code!(%w(32 m))
+    @sgr.apply_code!(%w(1 m))
+    @sgr.apply_code!(%w(39 m))
+    @sgr.foreground.should == :white
+    @sgr.intensity.should == :normal
+  end
+  it 'should have yellow background with normal intensity with a code 43' do
+    @sgr.apply_code!(%w(1 m))
+    @sgr.apply_code!(%w(43 m))
+    @sgr.background.should == :yellow
+    @sgr.intensity.should == :normal
+  end
+  it 'should have blue foreground with bold intensity with a code 94' do
+    @sgr.apply_code!(%w(1 m))
+    @sgr.apply_code!(%w(94 m))
+    @sgr.foreground.should == :blue
+    @sgr.intensity.should == :bold
+  end
+  it 'should have magenta background with bold intensity with a code 105' do
+    @sgr.apply_code!(%w(1 m))
+    @sgr.apply_code!(%w(105 m))
+    @sgr.background.should == :magenta
+    @sgr.intensity.should == :bold
+  end
+  it 'should have white background with bold intensity with a code 107' do
+    @sgr.apply_code!(%w(1 m))
+    @sgr.apply_code!(%w(107 m))
+    @sgr.background.should == :white
+    @sgr.intensity.should == :bold
+  end
+end
+
+describe SGR, 'when an invalid code is executed' do
+  before do
+    @sgr = SGR.new
+  end
+
+  [10, -1, 108].each do |invalid_code|
+    it "should raise an error with a code #{invalid_code}" do
+      lambda{@sgr.apply_code!([invalid_code, 'm'])}.should raise_error(AnsiSysError)
+    end
+  end
+end
+
+describe SGR, 'to be rendered in HTML' do
+	before do
+		@sgr = SGR.new
+	end
+
+	it "should make no CSS with defalt properties" do
+		@sgr.css_style.should == nil
+	end
+
+	it "should change foreground color" do
+    @sgr.apply_code!(%w(32 m))
+    @sgr.css_styles.should == {'color' => ['green']}
+	end
+
+	it "shuold show underline for ANSI single underline" do
+    @sgr.apply_code!(%w(4 m))
+    @sgr.css_styles.should == {'text-decoration' => ['underline']}
+	end
+
+	it "shuold show underline for ANSI double underline" do
+    @sgr.apply_code!(%w(4 m))
+    @sgr.css_styles.should == {'text-decoration' => ['underline']}
+	end
+
+	it "should switch foreground and background colors with reverse video" do
+		@sgr.apply_code!(%w(7 m))
+    @sgr.css_styles.should == {'color' => ['black'], 'background-color' => ['silver']}
+	end
+
+	it "should blink for ANSI slow blink" do
+		@sgr.apply_code!(%w(5 m))
+    @sgr.css_styles.should == {'text-decoration' => ['blink']}
+	end
+
+	it "should blink for ANSI fast blink" do
+		@sgr.apply_code!(%w(6 m))
+    @sgr.css_styles.should == {'text-decoration' => ['blink']}
+	end
+
+	it "should be able to be italic" do
+		@sgr.apply_code!(%w(3 m))
+    @sgr.css_styles.should == {'font-style' => ['italic']}
+	end
+	
+	it "should be able to be invisible" do
+		@sgr.apply_code!(%w(8 m))
+    @sgr.css_styles.should == {'color' => ['black']}
+	end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end

data/spec/terminal_spec.rb

@@ -0,0 +1,82 @@
+$:.unshift('lib')
+require 'ansisys'
+
+include AnsiSys
+
+describe Terminal, "when ascii is echoed" do
+  before do
+		@terminal = Terminal.new
+		@terminal.echo("Hello world")
+  end
+
+	it "should render an HTML as the original string" do
+		@terminal.render.should == %Q|<pre class="screen">\nHello world</pre>|
+	end
+
+	it "should render a plain text as the original string" do
+		@terminal.render(:text).should == 'Hello world'
+	end
+end
+
+describe Terminal, 'when \n is echoed' do
+  before do
+		@terminal = Terminal.new
+		@terminal.echo("Hello\nworld")
+  end
+
+	it "should render an HTML with two rows" do
+		@terminal.render.should == %Q|<pre class="screen">\nHello\nworld</pre>|
+	end
+
+	it "should render a plain text with two rows" do
+		@terminal.render(:text).should == %Q|Hello\nworld|
+	end
+end
+
+describe Terminal, 'when SGR codes are echoed' do
+  before do
+		@terminal = Terminal.new
+		@terminal.echo("Hello \e[32mworld")
+  end
+
+	it "should render an HTML with color in span" do
+		@terminal.render.should == %Q|<pre class="screen">\nHello <span style="color: green">world</span></pre>|
+	end
+
+	it "should render a plain text without colors" do
+		@terminal.render(:text).should == 'Hello world'
+	end
+end
+
+describe Terminal, 'when SGR codes are echoed and non-standard colors are used' do
+  before do
+		@terminal = Terminal.new
+		@terminal.echo("Hello \e[32mworld")
+  end
+
+	it "should render an HTML with color in span" do
+		@terminal.render(:html, 80, 25, Screen.default_css_colors(false, true)).should == %Q|<pre class="screen">\nHello <span style="color: lime">world</span></pre>|
+	end
+end
+
+describe Terminal do
+	before do
+		@terminal = Terminal.new
+	end
+
+	it "should give CSS style-let" do
+		c = @terminal.css_style.split(/\n/)
+		e = <<"_CSS".split(/\n/)
+pre.screen {
+\tcolor: silver;
+\tbackground-color: black;
+\twidth: 40.0em;
+\tpadding: 0.5em;
+}
+_CSS
+		c.size.should == e.size
+		c.each do |line|
+			e.should include(line)
+		end
+	end
+end

data/tasks/deployment.rake

@@ -0,0 +1,27 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/*_spec.rb']
+end

data/tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/website/index.html

@@ -0,0 +1,113 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>
+      Ruby-ANSI.SYS
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+
+</style>
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+</head>
+<body>
+<div id="main">
+
+    <h1>Ruby-ANSI.SYS</h1>
+    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/ansi-sys"; return false'>
+      <p>Get Version</p>
+      <a href="http://rubyforge.org/projects/ansi-sys" class="numbers">0.2.0</a>
+    </div>
+    <h1>&#x2192; &#8216;ansi-sys&#8217;</h1>
+
+
+	<h2>What</h2>
+
+
+	<p>MS-DOS console (with <code>DEVICE=ANSI.SYS</code>), Linux
+console, and other terminal emulators usually accept escape
+sequences which tell the terminal change colors of the text or
+move the cursor.</p>
+
+
+	<p>Ruby-ANSI.SYS is a Ruby library to render texts with
+<a href="http://en.wikipedia.org/wiki/ANSI_escape_code"><span class="caps">ANSI</span> escape sequences</a>
+(Wikipedia) as an <span class="caps">HTML</span> fragment . It can also be used as a plugin
+for Hiki.</p>
+
+
+	<h2>Download</h2>
+
+
+	<p>Have a look at
+<a href="http://rubyforge.org/projects/ansi-sys">the RubyForge Project Info</a></p>
+
+
+	<h2>Installation</h2>
+
+
+	<p>As a Ruby library:</p>
+
+
+<pre>$ ruby setup.rb config
+$ ruby setup.rb setup
+# ruby setup.rb install</pre>
+
+	<p>As a Hiki plugin, copy the file lib/ansisys.rb into the
+misc/plugin directory and configure Hiki to enable the plugin.</p>
+
+
+	<h2>Usage</h2>
+
+
+	<p>As a Ruby library:</p>
+
+
+<pre>terminal = Terminal.new
+terminal.echo("ansi-escaped-text")
+terminal.render #=&gt; HTML fragment</pre>
+
+	<p>As a Hiki plugin:</p>
+
+
+<pre>{{ansi_screen(attach_file_name)}}</pre>
+
+	<h2>Contact</h2>
+
+
+	<p>Please send your comments and patches to
+<a href="http://rubyforge.org/tracker/?group_id=4656">the RubyForge Trackers</a></p>
+
+
+	<h2>License</h2>
+
+
+	<p>Please refer
+<a href="rdoc/files/License_txt.html">License.txt</a></p>
+    <p class="coda">
+      zunda, 20th October 2007<br>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
+    </p>
+</div>
+
+<!-- insert site tracking codes here, like Google Urchin -->
+
+</body>
+</html>