babosa 0.1.0 → 0.1.1

data/README.md

@@ -2,7 +2,7 @@
 
 Babosa is a library for creating slugs. It is an extraction and improvement of
 the string code from [FriendlyId](http://github.com/norman/friendly_id),
-intended to help developers create libraries similar to FriendlyId.
+intended to help developers create similar libraries and plugins.
 
 ## Features / Usage
 
@@ -10,12 +10,13 @@ intended to help developers create libraries similar to FriendlyId.
 
     "Gölcük, Turkey".to_slug.approximate_ascii.to_s #=> "Golcuk, Turkey"
 
-### Special cases for German and Spanish
+### Per-locale transliteration
 
     "Jürgen Müller".to_slug.approximate_ascii.to_s           #=> "Jurgen Muller"
     "Jürgen Müller".to_slug.approximate_ascii(:german).to_s  #=> "Juergen Mueller"
-    "feliz año".to_slug.approximate_ascii.to_s               #=> "feliz ano"
-    "feliz año".to_slug.approximate_ascii(:spanish).to_s     #=> "feliz anio"
+
+Currently, only German, Spanish and Serbian are supported. I'll gladly accept
+contributions and support more languages.
 
 ### Non-ASCII removal
 
@@ -32,12 +33,45 @@ whose length is limited by bytes rather than UTF-8 characters.
 
     "üüü".to_slug.truncate_bytes(2).to_s #=> "ü"
 
+### Remove punctuation chars
+
+    "this is, um, **really** cool, huh?".to_slug.word_chars.to_s #=> "this is um really cool huh"
+
 ### All-in-one
 
     "Gölcük, Turkey".to_slug.normalize.to_s #=> "golcuk-turkey"
 
-There are many more features; check the API docs and source code to find out
-more.
+
+### UTF-8 support
+
+Babosa has no hard dependencies, but if you have either the Unicode or
+ActiveSupport gems installed and required prior to requiring "babosa", these
+will be used to perform upcasing and downcasing on UTF-8 strings. On JRuby 1.5
+and above, Java's native Unicode support will be used.
+
+If none of these libraries are available, Babosa falls back to a simple module
+which supports only Unicode strings only with Latin characters. I recommend
+using the Unicode gem where possible since it's a C extension and is very fast.
+
+
+### Rails 3
+
+Most of Babosa's functionality is already present in Active Support/Rails 3.
+Babosa exists primarily to support non-Rails applications, and Rails apps prior
+to 3.0. Most of the code here was originally written for FriendlyId. Several
+things, like tidy_bytes and ASCII transliteration, were later added to Rails and I18N.
+
+Babosa differs from ActiveSupport primarily in that it supports non-Latin
+strings by default. If you are considering using Babosa with Rails 3, you should first
+take a look at Active Support's
+[transliterate](http://edgeapi.rubyonrails.org/classes/ActiveSupport/Inflector.html#M000565)
+and
+[parameterize](http://edgeapi.rubyonrails.org/classes/ActiveSupport/Inflector.html#M000566)
+because it's very likely they already do what you need.
+
+### More info
+
+Please see the [API docs](http://norman.github.com/babosa) and source code for more info.
 
 ## Getting it
 
@@ -47,6 +81,9 @@ Babosa can be installed via Rubygems:
 
 You can get the source code from its [Github repository](http://github.com/norman/babosa).
 
+Babosa is tested to be compatible with Ruby 1.8.6-1.9.2, JRuby 1.4-1.5,
+Rubinius 1.0, and is probably compatible with other Rubies as well.
+
 ## Reporting bugs
 
 Please use Babosa's [Github issue tracker](http://github.com/norman/babosa/issues).
@@ -54,20 +91,22 @@ Please use Babosa's [Github issue tracker](http://github.com/norman/babosa/issue
 
 ## Misc
 
-The speed and quality of Babosa's UTF-8 support depends on which Ruby and which
-gems you are using.
-
-On JRuby 1.5 and above, Babosa uses Java's native UTF-8 support. If you require
-[Unicode](http://github.com/blackwinter/unicode) or ActiveSupport before
-Babosa, it will use the support provided by those libraries. Otherwise, Babosa
-defaults to very basic UTF-8 support for Latin characters only.
-
 "Babosa" means slug in Spanish.
 
 ## Author
 
 [Norman Clarke](http://njclarke.com)
 
+## Contributors
+
+* [Milan Dobrota](http://github.com/milandobrota) - Serbian support
+
+
+## Changelog
+
+* 0.1.1 - Added support for Serbian.
+* 0.1.0 - Initial extraction from FriendlyId.
+
 ## Copyright
 
 Copyright (c) 2010 Norman Clarke

data/lib/babosa/characters.rb

@@ -37,6 +37,7 @@ module Babosa
 
     add_approximations :spanish, "ñ" => "ni"
     add_approximations :german, "ä" => "ae", "ö" => "oe", "ü" => "ue"
+    add_approximations :serbian, "Ð" => "Dj", "đ" => "dj" ,"Č" => "Ch", "č" => "ch", "Š" => "Sh", "š" => "sh"
     add_approximations :latin, {
       "À" => "A", "Á" => "A", "Â" => "A", "Ã" => "A", "Ä" => "A", "Å" => "A",
       "Æ" => "AE", "Ç" => "C", "È" => "E", "É" => "E", "Ê" => "E", "Ë" => "E",

data/lib/babosa/slug_string.rb

@@ -50,7 +50,7 @@ module Babosa
       @wrapped_string.__send__(symbol, *args, &block)
     end
 
-    # @param string [String] The string to use as the basis of the SlugString.
+    # @param string [#to_s] The string to use as the basis of the SlugString.
     def initialize(string)
       @wrapped_string = string.to_s
       tidy_bytes!
@@ -101,7 +101,8 @@ module Babosa
       @wrapped_string = @wrapped_string.gsub("-", " ").squeeze(" ").strip
     end
 
-    # Remove any non-word characters.
+    # Remove any non-word characters. For this library's purposes, this means
+    # anything other than letters, numbers, spaces, newlines and linefeeds.
     # @return String
     def word_chars!
       @wrapped_string = (unpack("U*") - Characters.strippable).pack("U*")
@@ -218,6 +219,5 @@ module Babosa
       string.send(*args)
       string
     end
-
   end
 end

data/lib/babosa/version.rb

@@ -1,5 +1,5 @@
 module Babosa
   module Version
-    STRING = "0.1.0"
+    STRING = "0.1.1"
   end
 end

data/test/babosa_test.rb

@@ -113,6 +113,10 @@ class  BabosaTest < Test::Unit::TestCase
     assert_equal "anio", "año".to_slug.approximate_ascii!(:spanish)
   end
 
+  test "should do special approximations for Serbian" do
+    assert_equal "Indjija", "Inđija".to_slug.approximate_ascii!(:serbian)
+  end
+
   test "should work with non roman chars" do
     assert_equal "検-索", "検 索".to_slug.normalize!
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Norman Clarke
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-12 00:00:00 -03:00
+date: 2010-08-09 00:00:00 -03:00
 default_executable: 
 dependencies: []