aalib-ruby 0.7.1

data/spec/aalib_context_spec.rb

@@ -0,0 +1,95 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+Spec::Runner.configure do |config|
+  config.before :each do
+    @aa = AAlib.init(AAlib.memory_driver)
+  end
+
+  config.after :each do
+    @aa.close if @aa
+  end
+end
+
+describe "AAlib::Context#mulx" do
+  it "returns the ratio of image and screen widths" do
+    @aa.mulx.should == @aa.imgwidth / @aa.scrwidth
+  end
+end
+
+describe "AAlib::Context#muly" do
+  it "returns the ratio of image and screen heights" do
+    @aa.mulx.should == @aa.imgwidth / @aa.scrwidth
+  end
+end
+
+describe "AAlib::Context#imgwidth" do
+  it "returns the width of the image buffer" do
+    hp = AAlib::HardwareParams.new
+    hp.width = 100
+      aa = AAlib.init(AAlib.memory_driver, hp)
+    begin
+      aa.imgwidth.should == 100 * aa.mulx
+    ensure
+      aa.close
+    end
+  end
+end
+
+describe "AAlib::Context#imgheight" do
+  it "returns the width of the image buffer" do
+    hp = AAlib::HardwareParams.new
+    hp.height = 100
+    aa = AAlib.init(AAlib.memory_driver, hp)
+    begin
+      aa.imgheight.should == 100 * aa.muly
+    ensure
+      aa.close
+    end
+  end
+end
+
+describe "AAlib::Context#render" do
+  it "raises TypeError with wrong render_params" do
+    lambda { @aa.render(Object.new) }.should raise_error(TypeError)
+  end
+end
+
+describe "AAlib::Context#putpixel" do
+  it "puts a pixel to the image buffer" do
+    50.times do
+      color = rand(256)
+      x = rand(@aa.imgwidth)
+      y = rand(@aa.imgheight)
+      @aa.putpixel(x, y, color)
+      @aa.image[y*@aa.imgwidth + x].should == color
+    end
+  end
+end
+
+describe "AAlib::Context#copy_image_from" do
+  before :each do
+    @aa1 = AAlib.init(AAlib.memory_driver)
+    @aa2 = AAlib.init(AAlib.memory_driver)
+  end
+
+  after :each do
+    @aa1.close
+    @aa2.close
+  end
+
+  it "copies the image buffer from another AAlib::Context" do
+    pixels = Hash.new
+    100.times do
+      x = rand(@aa2.imgwidth)
+      y = rand(@aa2.imgheight)
+      color = rand(256)
+      @aa2.putpixel(x, y, color)
+      pixels[[x,y]] = color
+    end
+
+    @aa1.copy_image_from(@aa2)
+    pixels.each do |xy, color|
+      @aa1.image[@aa1.imgwidth*xy[1] + xy[0]].should == color
+    end
+  end
+end

data/spec/aalib_format_spec.rb

@@ -0,0 +1,89 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+require 'aalib'
+
+describe "AAlib::SaveFormat.find" do
+  it "finds formats when given the full formatname" do
+    format = AAlib::SaveFormat.find("Text file")
+    format.should be_an_instance_of(AAlib::SaveFormat)
+    format.formatname.should == "Text file"
+    format.extension.should == ".txt"
+
+    format = AAlib::SaveFormat.find("Pure html")
+    format.should be_an_instance_of(AAlib::SaveFormat)
+    format.formatname.should == "Pure html"
+    format.extension.should == ".html"
+
+    ## NOTE: the "seqences" typo are hard coded into AA-lib v 1.4
+    format = AAlib::SaveFormat.find("ANSI escape seqences")
+    format.should be_an_instance_of(AAlib::SaveFormat)
+    format.formatname.should == "ANSI escape seqences"
+    format.extension.should == ".ansi"
+  end
+
+  it "finds formats when given the partial formatname" do
+    format = AAlib::SaveFormat.find("Text")
+    format.should be_an_instance_of(AAlib::SaveFormat)
+    format.formatname.should == "Text file"
+    format.extension.should == ".txt"
+
+    format = AAlib::SaveFormat.find("html")
+    format.should be_an_instance_of(AAlib::SaveFormat)
+    format.formatname.should == "Pure html"
+    format.extension.should == ".html"
+
+    format = AAlib::SaveFormat.find("ANSI")
+    format.should be_an_instance_of(AAlib::SaveFormat)
+    format.formatname.should == "ANSI escape seqences"
+    format.extension.should == ".ansi"
+  end
+
+  it "finds formats ignoring case" do
+    format = AAlib::SaveFormat.find("tEXT")
+    format.should be_an_instance_of(AAlib::SaveFormat)
+    format.formatname.should == "Text file"
+    format.extension.should == ".txt"
+
+    format = AAlib::SaveFormat.find("HTML")
+    format.should be_an_instance_of(AAlib::SaveFormat)
+    format.formatname.should == "Pure html"
+    format.extension.should == ".html"
+
+    format = AAlib::SaveFormat.find("ansi")
+    format.should be_an_instance_of(AAlib::SaveFormat)
+    format.formatname.should == "ANSI escape seqences"
+    format.extension.should == ".ansi"
+  end
+
+  it "finds formats when given a Regexp" do
+    format = AAlib::SaveFormat.find(/text/i)
+    format.should be_an_instance_of(AAlib::SaveFormat)
+    format.formatname.should == "Text file"
+    format.extension.should == ".txt"
+
+    format = AAlib::SaveFormat.find(/HP.*big/)
+    format.should be_an_instance_of(AAlib::SaveFormat)
+    format.formatname.should == "HP laser jet - A4 big font"
+    format.extension.should == ".hp"
+
+    format = AAlib::SaveFormat.find(/IRC.*II/)
+    format.should be_an_instance_of(AAlib::SaveFormat)
+    format.formatname.should == "For catting to an IRC channel II"
+    format.extension.should == ".irc"
+  end
+end
+
+describe "AAlib::SaveFormat.formatname" do
+  it "returns the formatname" do
+    format = AAlib::SaveFormat.find("text")
+    format.should be_an_instance_of(AAlib::SaveFormat)
+    format.formatname.should == "Text file"
+  end
+end
+
+describe "AAlib::SaveFormat.extension" do
+  it "returns the file extension including the dot" do
+    format = AAlib::SaveFormat.find("text")
+    format.should be_an_instance_of(AAlib::SaveFormat)
+    format.extension.should == ".txt"
+  end
+end

data/spec/aalib_save_spec.rb

@@ -0,0 +1,34 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+require 'aalib'
+
+describe "The save procedure" do
+  before :each do
+    @file = File.join(File.dirname(__FILE__), "scratch", "test_save")
+  end
+
+  after :each do
+    # File.delete(@file) if File.exists?(@file)
+  end
+
+  it "saves a graphics context as text using the save driver" do
+    format = AAlib::SaveFormat.find("text")
+    data = AAlib::SaveData.new(@file, format)
+
+    hp = AAlib::HardwareParams.new
+    rp = AAlib::RenderParams.new
+
+    context = AAlib.init(AAlib.save_driver, hp, data)
+    draw_diagonal_gradient(context)
+    context.render(rp)
+    puts_hello_world(context)
+    context.flush
+
+    context.close
+
+    efile = File.join(File.dirname(__FILE__), "hello_world.txt")
+    expected = File.open(efile) { |f| f.read }
+    result = File.open(@file) { |f| f.read }
+
+    result.should == expected
+  end
+end

data/spec/aalib_savedata_spec.rb

@@ -0,0 +1,27 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+require 'aalib'
+
+describe "AAlib::SaveData.new" do
+  it "Creates a new instance of SaveData" do
+    file = "file.txt"
+    data = AAlib::SaveData.new(file, "text")
+    data.should be_an_instance_of(AAlib::SaveData)
+    data.name.should == "file.txt"
+  end
+
+  it "Uses AAlib::SaveFormat.find when given a string format name" do
+    file = "file.txt"
+    data = AAlib::SaveData.new(file, "text")
+    data.should be_an_instance_of(AAlib::SaveData)
+    data.name.should == file
+    data.format.should == AAlib::SaveFormat.find("text")
+  end
+
+  it "Uses AAlib::SaveFormat.find when given a regexp format name" do
+    file = "file.txt"
+    data = AAlib::SaveData.new(file, /text/i)
+    data.should be_an_instance_of(AAlib::SaveData)
+    data.name.should == file
+    data.format.should == AAlib::SaveFormat.find(/text/i)
+  end
+end

data/spec/aalib_spec.rb

@@ -0,0 +1,168 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+require 'aalib'
+
+describe "AAlib.autoinit" do
+  # We can't check this so much because it might initialize Curses on our terminal
+  #
+  it "raises TypeError with wrong hardware_params" do
+    clo = lambda { AAlib.autoinit(Object.new) }
+    clo.should raise_error(TypeError)
+  end
+end
+
+describe "AAlib.init" do
+  before :each do
+    @hp = AAlib::HardwareParams.new
+  end
+
+  # AAlib.init checks its arguments in violation of duck typing, but incorrect
+  # arguments can lead to segmentation faults if AAlib calls the C-library
+  # functions with incorrect arguments.
+
+  it "raises TypeError with wrong driver" do
+    clo = lambda { AAlib.init(Object.new) }
+    clo.should raise_error(TypeError)
+  end
+
+  it "raises TypeError with wrong hardware_params" do
+    clo = lambda { AAlib.init(AAlib.memory_driver, Object.new) }
+    clo.should raise_error(TypeError)
+  end
+
+  it "returns an AAlib::Context with memory driver" do
+    AAlib.init(AAlib.memory_driver, @hp).should be_an_instance_of(AAlib::Context)
+  end
+
+  it "returns an AAlib::Context with memory driver and no hardware_params" do
+    AAlib.init(AAlib.memory_driver).should be_an_instance_of(AAlib::Context)
+  end
+
+  it "returns an AAlib::Context when called with save driver" do
+    opts = AAlib::SaveData.new("test.txt", "text")
+    context = AAlib.init(AAlib.save_driver, @hp, opts)
+    context.should be_an_instance_of(AAlib::Context)
+  end
+
+  it "raises ArgumentError when called with save driver and no driver_opts" do
+    clo = lambda { AAlib.init(AAlib.save_driver, @hp, nil) }
+    clo.should raise_error(ArgumentError)
+  end
+
+  it "raises TypeError when called with save driver and wrong driver_opts" do
+    opts = AAlib::SaveFormat.find("text")
+    clo = lambda { AAlib.init(AAlib.save_driver, @hp, opts) }
+    clo.should raise_error(TypeError)
+  end
+end
+
+# describe "AAlib.color_from_rgb" do
+#   it "converts an RGB color to greyscale" do
+#     AAlib.color_from_rgb(0, 0, 0).should == 0
+#     AAlib.color_from_rgb(255, 255, 255).should == 255
+#     AAlib.color_from_rgb(255, 0, 0).should == 29
+#     AAlib.color_from_rgb(0, 255, 0).should == 58
+#     AAlib.color_from_rgb(0, 0, 255).should == 10
+#     AAlib.color_from_rgb(47, 57, 98).should == 22
+#   end
+# 
+#   it "behaves stupidly when args are larger than 255" do
+#     AAlib.color_from_rgb(256, 0, 0).should == 30
+#   end
+# end
+
+describe "AAlib.help" do
+  it "returns a large help string" do
+    AAlib.help.should be_an_instance_of(String)
+  end
+end
+
+describe "AAlib.formats" do
+  it "returns an array of formats" do
+    AAlib.formats.should be_an_instance_of(Array)
+  end
+
+  it "returns an array of AAlib::SaveFormat objects" do
+    AAlib.formats.each do |driver|
+      driver.should be_an_instance_of(AAlib::SaveFormat)
+    end
+  end
+end
+
+describe "AAlib.drivers" do
+  it "returns an array of drivers" do
+    AAlib.drivers.should be_an_instance_of(Array)
+  end
+
+  it "returns an array of AAlib::Driver objects" do
+    AAlib.drivers.each do |driver|
+      driver.should be_an_instance_of(AAlib::Driver)
+    end
+  end
+end
+
+describe "AAlib.save_driver" do
+  it "returns the driver to use for saving to disk" do
+    driver = AAlib.save_driver
+    driver.should be_an_instance_of(AAlib::Driver)
+    driver.shortname.should == 'save'
+    driver.name.should == 'Special driver for saving to files'
+  end
+end
+
+describe "AAlib.memory_driver" do
+  it "returns the driver to use for an in-memory context" do
+    driver = AAlib.memory_driver
+    driver.should be_an_instance_of(AAlib::Driver)
+    driver.shortname.should == 'mem'
+    # FIXME: may depend on AA-lib version?
+    driver.name.should == 'Dummy memory driver 1.0'
+  end
+end
+
+describe "AAlib.parseoptions" do
+  before :each do
+    @hp = AAlib::HardwareParams.new
+    @rp = AAlib::RenderParams.new
+  end
+
+  it "parses commandline options, setting values in RenderParams" do
+    argv = %w{-gamma 2.0 -contrast 5 -bright 100}
+    AAlib.parseoptions(@hp, @rp, argv).should be_true
+    @rp.gamma.should be_close(2.0, 0.01)
+    @rp.contrast.should == 5
+    @rp.bright.should == 100
+  end
+
+  it "parses commandline options, setting values in HardwareParams" do
+    argv = %w{-width 101 -height 57}
+    AAlib.parseoptions(@hp, @rp, argv).should be_true
+    @hp.width.should == 101
+    @hp.height.should == 57
+  end
+
+  it "leaves untouched other options" do
+    argv = %w{--verbose -gamma 2.0 -contrast 5 -bright 100 -other-option 70}
+    AAlib.parseoptions(@hp, @rp, argv).should be_true
+    argv.should == %w{--verbose -other-option 70}
+  end
+
+  it "uses ARGV by default" do
+    ARGV.replace %w{--verbose -gamma 2.0 -contrast 5 -bright 100 -other-option 70}
+    AAlib.parseoptions(@hp, @rp).should be_true
+    ARGV.should == %w{--verbose -other-option 70}
+
+    @rp.gamma.should be_close(2.0, 0.01)
+    @rp.contrast.should == 5
+    @rp.bright.should == 100
+  end
+
+  it "raises TypeError with wrong hardware_params" do
+    clo = lambda { AAlib.parseoptions(Object.new, @rp) }
+    clo.should raise_error(TypeError)
+  end
+
+  it "raises TypeError with wrong hardware_params" do
+    clo = lambda { AAlib.parseoptions(@hp, Object.new) }
+    clo.should raise_error(TypeError)
+  end
+end

data/spec/hello_world.txt

@@ -0,0 +1,25 @@
+    . . ........-.:.::::::::;:;;;=;=======+++++|+|+|||||||||i|iiiiiiilllllIIIvIv
+ . . .........:-::-:::::::;;;;=;=======++++++|+|+|||+|||||ii|iiiiiillllllIIvIvvv
+. .........-:-:.::::::::;;;;=========++++|+||+||||+|||||ii|iiiiiilllllIIvIvvvvvv
+........:.::.::::::::;;;=;========++|+|+|+|+||||||||iiiiiiiiillllllIIvvIvvvvvvnv
+....--::-::::::::;;;=;=========++|+++|+|+|||||||||iii|iiiillllllIvvvvvvvvvvnvnnn
+.--:-:-:::::::;;;=;=;======+++|+|=|||+|||||||||i|iiiiilillllIIvIvvIvvvvvnnnnnnnn
+::-::::::::;;;=;========+++|+|++||+||||||||i|iiiiiiillllIIIvIvvvvvvvvnnnnnnnnooo
+:-::::::;;;=;========++|++|++|+|||||||||iiiiiiiillllllIIvIvvvvvvvnvnnnnnnnnoo222
+:::::;;;=;========++|+++|+|||||||||||i|iiiiiilllllIIvIvvvvvvvvnvnnnnnnnooo22222S
+;:;=;=;=======+++|+++|||+|||||||||iiiiiiiiillllIIvIvvvvvvvvnvnnnnnnooo2o2222S2S2
+;=;========+++++|=|||+|+|||||||iiiiiiiilllIlIIvIvvvvvvvvnvnnnnnnoooo2222S2SS2XSX
+========+++|+|+|+||+|||                                 nnnnoooo2o2S22S2S2SSSSSX
+=====+++|+|++|+||||||||  AA-lib: the ascii-art library  noooo2oSoS22SS2XSSXSXXXX
+=++++|+|++|+|||||||||ii                                 oo2222SoS2SSS2XXSXXXXXXZ
++++|+|+|+|||||||||iiiiiiiililIlIIvIvvvvvvvvvnnnnnnnnooo22222S2SSSSSSSXXXXXXXZZZU
+|+|+|+||||||||i|iiiiiiiilllIIIvIvvvvvvvvvnnnnnnnooo2o22S2S2X2XS2XSXXXXXXZZZZ#Z#Z
+|+|||||||||iiiiiiiiillllIIIvIvvvvvvvvnvnnnnnnoooo222S2S2S2SSSSSXXXXXXZZZZZ#ZUZ##
+||||||||iiiiiiiillllllIvIvvvvvvvvvnnnnnnnoooo2o2S22S2S2SSSXSXXXXXXZZZZZ#Z#Z#####
+|||||iiiiiiiiilllllIvIvIvvvvvvvnnnnnnnnooo2222S22SS2XSSXXXXXXXXZZZZUZ#UZ########
+i|iiiiiiiiilllllIIvvvvvvvvvnvnnnnnnnooo22222S2S2XS2XXSXXXXXXZZZUZ#Z#UUU########m
+iiiiiiiilllIlIvvvvvvvvvvnnnnnnnnoooo2222S2SS2SSSSSXXXXXXXZZZUZ#Z#Z#########mmmBB
+iiiillllIIIvvvIvvvvvvnvnnnnnnooo2o2S22S2S2X2XXSXXXXXXZZZZ#Z#Z#Z#########mmmBBWmW
+llllllIIvIvvvvvvvvnnnnnnnnooo2oSoS22S2SSSSXXXXXXXXZZZZUZ#Z#Z#########mmmBBWBWmWW
+lllIvIvvvvvvvvvnnnnnnnnoo2o222SoS2SSSSSSXXXXXXXZZZZ#Z#Z#U########mmmBmWBWBWmWWWW
+vIvvIvvvvvvnvnnnnnnnooo2222S2S2SSSSSSXXXXXXXZZZZ#Z#Z#U########mmmBBBWBWmWWBWWWWW

data/spec/scratch/test_save

@@ -0,0 +1,25 @@
+    . . ........-.:.::::::::;:;;;=;=======+++++|+|+|||||||||i|iiiiiiilllllIIIvIv
+ . . .........:-::-:::::::;;;;=;=======++++++|+|+|||+|||||ii|iiiiiillllllIIvIvvv
+. .........-:-:.::::::::;;;;=========++++|+||+||||+|||||ii|iiiiiilllllIIvIvvvvvv
+........:.::.::::::::;;;=;========++|+|+|+|+||||||||iiiiiiiiillllllIIvvIvvvvvvnv
+....--::-::::::::;;;=;=========++|+++|+|+|||||||||iii|iiiillllllIvvvvvvvvvvnvnnn
+.--:-:-:::::::;;;=;=;======+++|+|=|||+|||||||||i|iiiiilillllIIvIvvIvvvvvnnnnnnnn
+::-::::::::;;;=;========+++|+|++||+||||||||i|iiiiiiillllIIIvIvvvvvvvvnnnnnnnnooo
+:-::::::;;;=;========++|++|++|+|||||||||iiiiiiiillllllIIvIvvvvvvvnvnnnnnnnnoo222
+:::::;;;=;========++|+++|+|||||||||||i|iiiiiilllllIIvIvvvvvvvvnvnnnnnnnooo22222S
+;:;=;=;=======+++|+++|||+|||||||||iiiiiiiiillllIIvIvvvvvvvvnvnnnnnnooo2o2222S2S2
+;=;========+++++|=|||+|+|||||||iiiiiiiilllIlIIvIvvvvvvvvnvnnnnnnoooo2222S2SS2XSX
+========+++|+|+|+||+|||                                 nnnnoooo2o2S22S2S2SSSSSX
+=====+++|+|++|+||||||||  AA-lib: the ascii-art library  noooo2oSoS22SS2XSSXSXXXX
+=++++|+|++|+|||||||||ii                                 oo2222SoS2SSS2XXSXXXXXXZ
++++|+|+|+|||||||||iiiiiiiililIlIIvIvvvvvvvvvnnnnnnnnooo22222S2SSSSSSSXXXXXXXZZZU
+|+|+|+||||||||i|iiiiiiiilllIIIvIvvvvvvvvvnnnnnnnooo2o22S2S2X2XS2XSXXXXXXZZZZ#Z#Z
+|+|||||||||iiiiiiiiillllIIIvIvvvvvvvvnvnnnnnnoooo222S2S2S2SSSSSXXXXXXZZZZZ#ZUZ##
+||||||||iiiiiiiillllllIvIvvvvvvvvvnnnnnnnoooo2o2S22S2S2SSSXSXXXXXXZZZZZ#Z#Z#####
+|||||iiiiiiiiilllllIvIvIvvvvvvvnnnnnnnnooo2222S22SS2XSSXXXXXXXXZZZZUZ#UZ########
+i|iiiiiiiiilllllIIvvvvvvvvvnvnnnnnnnooo22222S2S2XS2XXSXXXXXXZZZUZ#Z#UUU########m
+iiiiiiiilllIlIvvvvvvvvvvnnnnnnnnoooo2222S2SS2SSSSSXXXXXXXZZZUZ#Z#Z#########mmmBB
+iiiillllIIIvvvIvvvvvvnvnnnnnnooo2o2S22S2S2X2XXSXXXXXXZZZZ#Z#Z#Z#########mmmBBWmW
+llllllIIvIvvvvvvvvnnnnnnnnooo2oSoS22S2SSSSXXXXXXXXZZZZUZ#Z#Z#########mmmBBWBWmWW
+lllIvIvvvvvvvvvnnnnnnnnoo2o222SoS2SSSSSSXXXXXXXZZZZ#Z#Z#U########mmmBmWBWBWmWWWW
+vIvvIvvvvvvnvnnnnnnnooo2222S2S2SSSSSSXXXXXXXZZZZ#Z#Z#U########mmmBBBWBWmWWBWWWWW