console 0.1 → 0.2

data/ext/console/console.c

@@ -63,7 +63,7 @@ static const char* default_pad_string = " ";
 
 /*
  * call-seq:
- *   slice(string, start_offset, display_width=1, pad_string=" ")
+ *   display_slice(string, start_offset, display_width=1, pad_string=" ")
  *
  * Returns a slice of a string based on display width, rather than character or
  * bytes. I.e, the <code>start_offset</code> and <code>display_width</code>
@@ -89,7 +89,7 @@ static const char* default_pad_string = " ";
  * The returned string WILL be in the current locale encoding, regardless of the
  * encoding of the original string.
  */
-static VALUE slice(int argc, VALUE *argv, VALUE v_self) {
+static VALUE display_slice(int argc, VALUE *argv, VALUE v_self) {
   VALUE v_string, v_display_start, v_display_width, v_pad_string;
   rb_scan_args(argc, argv, "22", &v_string, &v_display_start, &v_display_width, &v_pad_string);
   Check_Type(v_string, T_STRING);
@@ -189,7 +189,7 @@ static VALUE slice(int argc, VALUE *argv, VALUE v_self) {
  *
  * Console.display_width: get the number of display columns used by a string.
  *
- * Console.slice: get a substrig by display column offset and size.
+ * Console.display_slice: get a substrig by display column offset and size.
  *
  */
 
@@ -198,6 +198,6 @@ void Init_console() {
 
   cConsole = rb_define_class("Console", rb_cObject);
   rb_define_module_function(cConsole, "display_width", display_width, 1);
-  rb_define_module_function(cConsole, "slice", slice, -1);
+  rb_define_module_function(cConsole, "display_slice", display_slice, -1);
 }
 

data/test/console.rb

@@ -14,76 +14,76 @@ class ConsoleTest < ::Test::Unit::TestCase
   end
 
   def test_slice_of_zero_width_is_empty_string
-    assert_equal "", Console.slice(@s, 0, 0)
-    assert_equal "", Console.slice(@s, 1, 0)
+    assert_equal "", Console.display_slice(@s, 0, 0)
+    assert_equal "", Console.display_slice(@s, 1, 0)
   end
 
   def test_slice_out_of_bounds_is_nil
-    assert_equal nil, Console.slice(@s, 100, 3)
-    assert_equal nil, Console.slice(@s, -100, 3)
+    assert_equal nil, Console.display_slice(@s, 100, 3)
+    assert_equal nil, Console.display_slice(@s, -100, 3)
   end
 
   def test_slice_with_negative_offset
-    assert_equal "ê", Console.slice(@s, -1, 1)
-    assert_equal "aê", Console.slice(@s, -2, 2)
-    assert_equal "a", Console.slice(@s, -2, 1)
+    assert_equal "ê", Console.display_slice(@s, -1, 1)
+    assert_equal "aê", Console.display_slice(@s, -2, 2)
+    assert_equal "a", Console.display_slice(@s, -2, 1)
   end
 
   def test_slice_width_argument_defaults_to_1
-    assert_equal "ê", Console.slice(@s, -1)
-    assert_equal "a", Console.slice(@s, -2)
+    assert_equal "ê", Console.display_slice(@s, -1)
+    assert_equal "a", Console.display_slice(@s, -2)
   end
 
   def test_slice_works_on_chinese_characters
-    assert_equal "能", Console.slice(@s, 0, 2);
-    assert_equal "能吞", Console.slice(@s, 0, 4);
-    assert_equal "能吞a", Console.slice(@s, 0, 5);
-    assert_equal "能吞aê", Console.slice(@s, 0, 6);
+    assert_equal "能", Console.display_slice(@s, 0, 2);
+    assert_equal "能吞", Console.display_slice(@s, 0, 4);
+    assert_equal "能吞a", Console.display_slice(@s, 0, 5);
+    assert_equal "能吞aê", Console.display_slice(@s, 0, 6);
   end
 
   def test_slice_with_excessive_width_is_still_cool
-    assert_equal "能吞aê", Console.slice(@s, 0, 100);
-    assert_equal "吞aê", Console.slice(@s, 2, 100);
-    assert_equal "aê", Console.slice(@s, 4, 100);
-    assert_equal "ê", Console.slice(@s, 5, 100);
-    assert_equal "", Console.slice(@s, 6, 100); # yep, we get a non-nil at this value
-    assert_equal nil, Console.slice(@s, 7, 100);
+    assert_equal "能吞aê", Console.display_slice(@s, 0, 100);
+    assert_equal "吞aê", Console.display_slice(@s, 2, 100);
+    assert_equal "aê", Console.display_slice(@s, 4, 100);
+    assert_equal "ê", Console.display_slice(@s, 5, 100);
+    assert_equal "", Console.display_slice(@s, 6, 100); # yep, we get a non-nil at this value
+    assert_equal nil, Console.display_slice(@s, 7, 100);
   end
 
   def test_slice_with_the_biggest_valid_start_offset_behaves_like_String_slice_does
-    assert_equal "", Console.slice(@s, 6, 100);
-    assert_equal "", Console.slice(@s, 6, 0);
-    assert_equal nil, Console.slice(@s, 6, -1);
+    assert_equal "", Console.display_slice(@s, 6, 100);
+    assert_equal "", Console.display_slice(@s, 6, 0);
+    assert_equal nil, Console.display_slice(@s, 6, -1);
   end
 
   def test_slice_misaligned_start_offsets_get_padded
     s = "能吞aê"
 
-    assert_equal "", Console.slice(@s, 0, 0)
-    assert_equal " ", Console.slice(@s, 0, 1)
-    assert_equal "能", Console.slice(@s, 0, 2)
-    assert_equal "能 ", Console.slice(@s, 0, 3)
+    assert_equal "", Console.display_slice(@s, 0, 0)
+    assert_equal " ", Console.display_slice(@s, 0, 1)
+    assert_equal "能", Console.display_slice(@s, 0, 2)
+    assert_equal "能 ", Console.display_slice(@s, 0, 3)
 
-    assert_equal "", Console.slice(@s, 1, 0)
-    assert_equal " ", Console.slice(@s, 1, 1)
-    assert_equal "  ", Console.slice(@s, 1, 2)
-    assert_equal " 吞", Console.slice(@s, 1, 3)
+    assert_equal "", Console.display_slice(@s, 1, 0)
+    assert_equal " ", Console.display_slice(@s, 1, 1)
+    assert_equal "  ", Console.display_slice(@s, 1, 2)
+    assert_equal " 吞", Console.display_slice(@s, 1, 3)
 
-    assert_equal "", Console.slice(@s, 3, 0);
-    assert_equal " ", Console.slice(@s, 3, 1);
-    assert_equal " a", Console.slice(@s, 3, 2);
-    assert_equal " aê", Console.slice(@s, 3, 3);
+    assert_equal "", Console.display_slice(@s, 3, 0);
+    assert_equal " ", Console.display_slice(@s, 3, 1);
+    assert_equal " a", Console.display_slice(@s, 3, 2);
+    assert_equal " aê", Console.display_slice(@s, 3, 3);
   end
 
   def test_slice_misaligned_start_offsets_get_padded_with_specified_character
-    assert_equal "", Console.slice(@s, 0, 0, "X")
-    assert_equal "X", Console.slice(@s, 0, 1, "X")
-    assert_equal "XX", Console.slice(@s, 1, 2, "X")
+    assert_equal "", Console.display_slice(@s, 0, 0, "X")
+    assert_equal "X", Console.display_slice(@s, 0, 1, "X")
+    assert_equal "XX", Console.display_slice(@s, 1, 2, "X")
   end
 
   def test_slice_fails_on_nonstrings
-    assert_raises(TypeError) { Console.slice :potato, 1, 1 }
-    assert_raises(TypeError) { Console.slice 3, 1, 1 }
+    assert_raises(TypeError) { Console.display_slice :potato, 1, 1 }
+    assert_raises(TypeError) { Console.display_slice 3, 1, 1 }
   end
 
   def test_display_width_empty_string_is_zero

metadata

@@ -4,8 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  version: "0.1"
+  - 2
+  version: "0.2"
 platform: ruby
 authors: 
 - William Morgan
@@ -13,11 +13,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-10 21:59:22 -04:00
+date: 2010-05-11 08:47:32 -04:00
 default_executable: 
 dependencies: []
 
-description: Console is a hlper for displaying super-ASCII strings on the console. It turns out that all these funny foreign characters not only take up strange numbers of bytes, they also take up strange numbers of columns on the screen when you print them. Console procides utility methods for determining the display width of a string, and for taking a substring in a display-width-centric manner.
+description: Console is a helper class for displaying super-ASCII strings on the console. Console is needed when you want to mix two-column (e.g. Chinese) and single-column (e.g. ASCII) characters and know how much horizontal realestate the result takes on the screen. This is generally necessary when you want to have internationalization support in a console program. Console currently provides utility methods for determining the display width of a string, and for taking a substring based on display position and display width.
 email: wmorgan-console@masanjin.net
 executables: []
 
@@ -30,7 +30,7 @@ files:
 - ext/console/console.c
 - test/console.rb
 has_rdoc: true
-homepage: http://console.rubyforge.org
+homepage: http://console.rubygems.org
 licenses: []
 
 post_install_message: