babosa 0.3.6 → 0.3.7

data/README.md

@@ -1,8 +1,7 @@
 # Babosa
 
-Babosa is a library for creating human-friendly identifiers. Its primary
-intended purpose is for creating URL slugs, but can also be useful for
-normalizing and sanitizing data.
+Babosa is a library for creating human-friendly identifiers, aka "slugs". It can
+also be useful for normalizing and sanitizing data.
 
 It is an extraction and improvement of the string code from
 [FriendlyId](http://github.com/norman/friendly_id). I have released this as a
@@ -11,20 +10,34 @@ FriendlyId.
 
 ## Features / Usage
 
-### ASCII transliteration
+### Transliterate UTF-8 characters to ASCII
 
     "Gölcük, Turkey".to_slug.transliterate.to_s #=> "Golcuk, Turkey"
 
-### Per-locale transliteration
+### Locale sensitive transliteration, with support for many languages
 
     "Jürgen Müller".to_slug.transliterate.to_s           #=> "Jurgen Muller"
     "Jürgen Müller".to_slug.transliterate(:german).to_s  #=> "Juergen Mueller"
 
-Many European languages using both Roman and Cyrillic alphabets are supported.
-I'll gladly accept contributions from fluent speakers to support more
-languages.
+Currently supported languages include:
 
-### Non-ASCII removal
+* Bulgarian
+* Danish
+* German
+* Greek
+* Macedonian
+* Norwegian
+* Romanian
+* Russian
+* Serbian
+* Spanish
+* Swedish
+* Ukrainian
+
+
+I'll gladly accept contributions from fluent speakers to support more languages.
+
+### Strip non-ASCII characters
 
     "Gölcük, Turkey".to_slug.to_ascii.to_s #=> "Glck, Turkey"
 
@@ -49,8 +62,46 @@ whose length is limited by bytes rather than UTF-8 characters.
 
 ### Other stuff
 
-Babosa can also generate strings for Ruby method names. (Yes, Ruby 1.9 can use UTF-8 chars
-in method names, but you may not want to):
+#### Using Babosa With FriendlyId 4
+
+    require "babosa"
+
+    class Person < ActiveRecord::Base
+      friendly_id :name, use: :slugged
+
+      def normalize_friendly_id(input)
+        input.to_s.to_slug.normalize(transliterations: :russian).to_s
+      end
+    end
+
+#### Pedantic UTF-8 support
+
+Babosa goes out of its way to handle [nasty Unicode issues you might never think
+you would have](https://github.com/norman/enc/blob/master/equivalence.rb) by
+checking, sanitizing and normalizing your string input.
+
+It will automatically use whatever Unicode library you have loaded before
+Babosa, or fall back to a simple built-in library. Supported
+Unicode libraries include:
+
+* Java (only JRuby of course)
+* Active Support
+* [Unicode](https://github.com/blackwinter/unicode)
+* Built-in
+
+This built-in module is much faster than Active Support but much slower than
+Java or Unicode. It can only do **very** naive Unicode composition to ensure
+that, for example, "é" will always be composed to a single codepoint rather than
+an "e" and a "´" - making it safe to use as a hash key.
+
+But seriously - save yourself the headache and install a real Unicode library.
+If you are using Babosa with a language that uses the Cyrillic alphabet, Babosa
+requires either Unicode, Active Support or Java.
+
+#### Ruby Method Names
+
+Babosa can also generate strings for Ruby method names. (Yes, Ruby 1.9 can use
+UTF-8 chars in method names, but you may not want to):
 
 
     "this is a method".to_slug.to_ruby_method! #=> this_is_a_method
@@ -59,9 +110,10 @@ in method names, but you may not want to):
     # You can also disallow trailing punctuation chars
     "über cool stuff!".to_slug.to_ruby_method(false) #=> uber_cool_stuff
 
+#### Easy to Extend
 
-You can easily add custom transliterators for your language with very little code,
-for example here's the transliterator for German:
+You can add custom transliterators for your language with very little code. For
+example here's the transliterator for German:
 
     # encoding: utf-8
     module Babosa
@@ -100,44 +152,67 @@ And a spec (you can use this as a template):
     end
 
 
-### UTF-8 support
+### Rails 3
+
+Some of Babosa's functionality was added to Active Support 3.
+
+Babosa now differs from ActiveSupport primarily in that it supports non-Latin
+strings by default, and has per-locale ASCII transliterations already baked-in.
+If you are considering using Babosa with Rails 3, you may want to 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)
+to see if they suit your needs.
 
-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 instead. Unless you're on
-JRuby, which already has excellent support for Unicode via Java's Standard
-Library, I recommend using the Unicode gem because it's the fastest Ruby Unicode
-library available.
+### Babosa vs. Stringex
 
-If none of these libraries are available, Babosa falls back to a simple module
-which **only** supports Latin characters.
+Babosa provides much of the functionality provided by the
+[Stringex](https://github.com/rsl/stringex) gem, but in the subjective opinion
+of the author, is for most use cases a much better choice.
 
-This default module is fast and can do very naive Unicode composition to ensure
-that, for example, "é" will always be composed to a single codepoint rather than
-an "e" and a "´" - making it safe to use as a hash key. But seriously - save
-yourself the headache and install a real Unicode library.
+#### Fewer Features
 
-If you are using Babosa with a language that uses the Cyrillic alphabet, Babosa
-requires either Unicode, Active Support or Java.
+Stringex offers functionality for storing slugs in an Active Record model, like
+a simple version of [FriendlyId](http://github.com/norman/friendly_id), in
+addition to string processing. Babosa only does string processing.
 
+#### Less Aggressive Unicode Transliteration
 
-### Rails 3
+Stringex uses an agressive Unicode to ASCII mapping which outputs gibberish for
+almost anything but Western European langages. Babosa supports only languages
+for which fluent speakers have provided transliterations, to ensure that the
+output makes sense to users.
 
-Some of Babosa's functionality is already present in Active Support/Rails 3.
+#### Better Locale Support
+
+Recent versions of Stringex support locale-specific transliterations, but
+include no built-in support for any languages. Babosa works out of the box for
+most European languages and is easy to extend if your language is not supported.
+
+#### Unicode Support
+
+Stringex does no Unicode normalization or validation before transliterating
+strings, so if you pass in strings with encoding errors or with different
+Unicode normalizations, you'll get unpredictable results.
+
+#### No Locale Assumptions
+
+Babosa avoids making assumptions about locales like Stringex does, so it doesn't
+offer transliterations like this out of the box:
+
+    "$12 worth of Ruby power".to_url => "12-dollars-worth-of-ruby-power"
+
+This is because the symbol "$" is used by many Latin American countries for the
+peso. Stringex does this in many places, for example, transliterating all Han
+characters into Pinyin, effectively treating Japanese text as if it were
+Chinese.
 
-Babosa differs from ActiveSupport primarily in that it supports non-Latin
-strings by default, and has per-locale ASCII transliterations already baked-in.
-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 may already do what you need.
 
 ### More info
 
-Please see the [API docs](http://norman.github.com/babosa) and source code for more info.
+Please see the [API docs](http://norman.github.com/babosa) and source code for
+more info.
 
 ## Getting it
 
@@ -147,12 +222,13 @@ 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, and
-Rubinius 1.0.x. It's probably compatible with other Rubies as well.
+Babosa is tested to be compatible with Ruby 1.8.6-1.9.2, JRuby 1.4+, and
+Rubinius 1.0+ It's probably compatible with other Rubies as well.
 
 ## Reporting bugs
 
-Please use Babosa's [Github issue tracker](http://github.com/norman/babosa/issues).
+Please use Babosa's [Github issue
+tracker](http://github.com/norman/babosa/issues).
 
 
 ## Misc
@@ -165,6 +241,13 @@ Please use Babosa's [Github issue tracker](http://github.com/norman/babosa/issue
 
 ## Contributors
 
+Many thanks to the following people for their help:
+
+* [Philip Arndt](https://github.com/parndt) - Bugfixes
+* [Jonas Forsberg](https://github.com/himynameisjonas) - Swedish support
+* [Jaroslav Kalistsuk](https://github.com/jarosan) - Greek support
+* [Steven Heidel](https://github.com/stevenheidel) - Bugfixes
+* [Edgars Beigarts](https://github.com/ebeigarts) - Support for multiple transliterators
 * [Tiberiu C. Turbureanu](https://gitorious.org/~tct) - Romanian support
 * [Kim Joar Bekkelund](https://github.com/kjbekkelund) - Norwegian support
 * [Alexey Shkolnikov](https://github.com/grlm) - Russian support
@@ -175,6 +258,7 @@ Please use Babosa's [Github issue tracker](http://github.com/norman/babosa/issue
 
 ## Changelog
 
+* 0.3.7 - Fix compatibility with Ruby 1.8.7. Add Swedish support.
 * 0.3.6 - Allow multiple transliterators. Add Greek support.
 * 0.3.5 - Don't strip underscores from identifiers.
 * 0.3.4 - Add Romanian support.
@@ -190,7 +274,7 @@ Please use Babosa's [Github issue tracker](http://github.com/norman/babosa/issue
 
 ## Copyright
 
-Copyright (c) 2010-2011 Norman Clarke
+Copyright (c) 2010-2012 Norman Clarke
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/lib/babosa/identifier.rb

@@ -113,6 +113,7 @@ module Babosa
     # @param *args <Symbol>
     # @return String
     def transliterate!(*kinds)
+      kinds.compact!
       kinds = [:latin] if kinds.empty?
       kinds.each do |kind|
         transliterator = Transliterator.get(kind).instance
@@ -148,8 +149,12 @@ module Babosa
       else
         options = default_normalize_options.merge(options || {})
       end
-      if options[:transliterate]
-        transliterate!(*options[:transliterations])
+      if translit_option = options[:transliterate]
+        if translit_option != true
+          transliterate!(*translit_option)
+        else
+          transliterate!(*options[:transliterations])
+        end
       end
       to_ascii! if options[:to_ascii]
       clean!

data/lib/babosa/transliterator/base.rb

@@ -17,6 +17,7 @@ module Babosa
     autoload :Russian,    "babosa/transliterator/russian"
     autoload :Serbian,    "babosa/transliterator/serbian"
     autoload :Spanish,    "babosa/transliterator/spanish"
+    autoload :Swedish,    "babosa/transliterator/swedish"
     autoload :Ukrainian,  "babosa/transliterator/ukrainian"
     autoload :Greek,      "babosa/transliterator/greek"
 

data/lib/babosa/transliterator/swedish.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+module Babosa
+  module Transliterator
+    class Swedish < Latin
+      APPROXIMATIONS = {
+        "å" => "aa",
+        "ä" => "ae",
+        "ö" => "oe",
+        "Å" => "Aa",
+        "Ä" => "Ae",
+        "Ö" => "Oe"
+      }
+    end
+  end
+end
+

data/lib/babosa/version.rb

@@ -1,5 +1,5 @@
 module Babosa
   module Version
-    STRING = "0.3.6"
+    STRING = "0.3.7"
   end
 end

data/spec/babosa_spec.rb

@@ -54,6 +54,11 @@ describe Babosa::Identifier do
   end
 
   describe "#normalize" do
+
+    it "should allow passing locale as key for :transliterate" do
+      "ö".to_slug.clean.normalize(:transliterate => :german).should eql("oe")
+    end
+
     it "should replace whitespace with dashes" do
       "a b".to_slug.clean.normalize.should eql("a-b")
     end

data/spec/transliterators/swedish_spec.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+require File.expand_path("../../spec_helper", __FILE__)
+
+describe Babosa::Transliterator::Swedish do
+
+  let(:t) { described_class.instance }
+  it_behaves_like "a latin transliterator"
+
+  it "should transliterate various characters" do
+    examples = {
+      "Räksmörgås" => "Raeksmoergaas",
+      "Öre"     => "Oere",
+      "Åre"    => "Aare",
+      "Älskar"  => "Aelskar"
+    }
+    examples.each {|k, v| t.transliterate(k).should eql(v)}
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: babosa
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-07 00:00:00.000000000 Z
+date: 2012-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70212217120220 !ruby/object:Gem::Requirement
+  requirement: &70194416980920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *70212217120220
+  version_requirements: *70194416980920
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70212217118700 !ruby/object:Gem::Requirement
+  requirement: &70194416979940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *70212217118700
+  version_requirements: *70194416979940
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70212217117820 !ruby/object:Gem::Requirement
+  requirement: &70194416979120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70212217117820
+  version_requirements: *70194416979120
 description: ! "    A library for creating slugs. Babosa an extraction and improvement
   of the\n    string code from FriendlyId, intended to help developers create similar\n
   \   libraries or plugins.\n"
@@ -66,6 +66,7 @@ files:
 - lib/babosa/transliterator/russian.rb
 - lib/babosa/transliterator/serbian.rb
 - lib/babosa/transliterator/spanish.rb
+- lib/babosa/transliterator/swedish.rb
 - lib/babosa/transliterator/ukrainian.rb
 - lib/babosa/utf8/active_support_proxy.rb
 - lib/babosa/utf8/dumb_proxy.rb
@@ -92,6 +93,7 @@ files:
 - spec/transliterators/russian_spec.rb
 - spec/transliterators/serbian_spec.rb
 - spec/transliterators/spanish_spec.rb
+- spec/transliterators/swedish_spec.rb
 - spec/transliterators/ukrainian_spec.rb
 - spec/utf8_proxy_spec.rb
 - .gemtest
@@ -115,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: ! '[none]'
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: A library for creating slugs.