sort-by-alphabet 0.1.6 → 0.2.0

data/README.textile

@@ -1 +1,41 @@
-bc. %w{ahoj čau nazdar}.sort_by_alphabet(CzechAlphabet)
+This library implements alphabetical sorting according to given alphabet scheme. Currently, only Czech alphabet is included, but it is super-easy to create a new one.
+
+h1. Setup
+
+Install the gem:
+
+bc. gem install sort-by-alphabet
+
+Or require it into Rails:
+
+bc. gem require "sort-by-alphabet"
+
+h1. Requirements
+
+Support of @mb_chars@, i.e. _ActiveSupport_ in practice.
+
+h1. Usage
+
+Classical sort puts accented chars after normal:
+
+bc. %w{nazdar ahoj čau}.sort # => %w{ahoj nazdar čau}
+
+@sort_by_alphabet@ does a better job:
+
+bc. %w{nazdar ahoj čau}.sort_by_alphabet(CzechAlphabet) # => %w{ahoj čau nazdar}
+
+@sort_by_alphabet@ can take a block which acts similarly as that in @sort_by@:
+
+bc. Something.all.sort_by_alphabet(CzechAlphabet) {|o| o.title}
+
+You can also make a class alphabetically comparable:
+
+bc. class Something
+  comparable_by_alphabet(CzechAlphabet)
+end
+
+or use a block, e.g. for case insensitivity:
+
+bc. class SomethingElse
+  comparable_by_alphabet(CzechAlphabet) {|obj| obj.mb_chars.downcase}
+end

data/init.rb

@@ -1,5 +1,6 @@
 require "#{File::dirname __FILE__}/lib/alphabets"
 require "#{File::dirname __FILE__}/lib/enumerable"
+require "#{File::dirname __FILE__}/lib/object"
 require "#{File::dirname __FILE__}/lib/sort_by_alphabet"
+
 String.send(:include, SortByAlphabet::InstanceMethods)
-String.send(:extend, SortByAlphabet::ClassMethods)

data/lib/alphabets.rb

@@ -1,41 +1,24 @@
 class Alphabet
   
-  def self.compare_letters_sensitive(x, y)
-    i1 = lower_case.mb_chars.index(x)
-    i2 = upper_case.mb_chars.index(x)
-    j1 = lower_case.mb_chars.index(y)
-    j2 = upper_case.mb_chars.index(y)
-    if !i1 && !i2 or !j1 && !j2
-      x <=> y
-    elsif i1 && j2
-      -1
-    elsif i2 && j1
-      +1
-    elsif i1 && j1
-      i1 <=> j1
-    elsif i2 && j2
-      i2 <=> j2
+  def self.compare_letters(x, y)
+    i = letters.mb_chars.index(x)
+    j = letters.mb_chars.index(y)
+    if i && j
+      i <=> j
     else
-      raise "I did not think of something"
-    end
-  end
-
-  def self.compare_letters_insensitive(x, y)
-    i = lower_case.mb_chars.index(letter_to_lowercase(x))
-    j = lower_case.mb_chars.index(letter_to_lowercase(y))
-    if !i || !j
       x <=> y
-    else
-      i <=> j
     end
   end
   
-  def self.letter_to_lowercase(a)
-    i = upper_case.mb_chars.index(a)
-    if i
-      lower_case.mb_chars[i] 
-    else
-      a
+  def self.by_locale(locale)
+    language = locale.split('-').first.downcase
+    case language
+      when 'cs'
+        CzechAlphabet
+      when 'en'
+        EnglishAlphabet
+      else
+        raise "Language #{language} of locale #{locale} is unknown."
     end
   end
   
@@ -43,12 +26,16 @@ end
 
 class CzechAlphabet < Alphabet
   
-  def self.lower_case
-    "aábcčdďeéěfghiíjklmnňoópqrřsštťuúůvwxyýzž"
+  def self.letters
+    "AÁBCČDĎEÉĚFGHIÍJKLMNŇOÓPQRŘSŠTŤUÚŮVWXYÝZŽaábcčdďeéěfghiíjklmnňoópqrřsštťuúůvwxyýzž"
   end
   
-  def self.upper_case
-    "AÁBCČDĎEÉĚFGHIÍJKLMNŇOÓPQRŘSŠTŤUÚŮVWXYÝZŽ"
+end
+
+class EnglishAlphabet < Alphabet
+  
+  def self.letters
+    "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklnopqrstuvwxyz"
   end
   
 end

data/lib/enumerable.rb

@@ -2,17 +2,9 @@ module Enumerable
   
   def sort_by_alphabet(alphabet)
     if block_given?
-      sort{|a, b| yield(a).to_s.compare_by_alphabet_sensitive(yield(b).to_s, alphabet)}
+      sort{|a, b| yield(a).to_s.compare_by_alphabet(yield(b).to_s, alphabet)}
     else
-      sort{|a, b| a.to_s.compare_by_alphabet_sensitive(b.to_s, alphabet)}
-    end
-  end
-
-  def isort_by_alphabet(alphabet)
-    if block_given?
-      sort{|a, b| yield(a).to_s.compare_by_alphabet_insensitive(yield(b).to_s, alphabet)}
-    else
-      sort{|a, b| a.to_s.compare_by_alphabet_insensitive(b.to_s, alphabet)}
+      sort{|a, b| a.to_s.compare_by_alphabet(b.to_s, alphabet)}
     end
   end
 

data/lib/object.rb

@@ -0,0 +1,15 @@
+class Object
+  
+  def self.comparable_by_alphabet(alphabet, &block)
+    if block
+      define_method :"<=>" do |other|
+        block[self].to_s.compare_by_alphabet(block[other].to_s, alphabet)
+      end
+    else
+      define_method :"<=>" do |other|
+        self.to_s.compare_by_alphabet(other.to_s, alphabet)
+      end
+    end    
+  end
+  
+end

data/lib/sort_by_alphabet.rb

@@ -1,27 +1,17 @@
 module SortByAlphabet
-  
-  module ClassMethods
-
-  end
-  
-  module InstanceMethods
-    def compare_by_alphabet_insensitive(other, alphabet)
-      compare_by_alphabet(other, alphabet, :compare_letters_insensitive)
-    end
     
-    def compare_by_alphabet_sensitive(other, alphabet)
-      compare_by_alphabet(other, alphabet, :compare_letters_sensitive)
-    end
-    
-    def compare_by_alphabet(other, alphabet, method)
+  module InstanceMethods
+        
+    def compare_by_alphabet(other, alphabet)
       l1 = self.mb_chars.length
       l2 = other.mb_chars.length
       (0...[l1, l2].min).each do |i|
-        c = alphabet.send(method, self.mb_chars[i..i], other.mb_chars[i..i])
+        c = alphabet.compare_letters(self.mb_chars[i..i], other.mb_chars[i..i])
         return c unless c == 0
       end
       l1 <=> l2
     end
+    
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sort-by-alphabet
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors: 
 - Frantisek Havluj
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-19 00:00:00 +01:00
+date: 2010-01-22 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -24,6 +24,7 @@ extra_rdoc_files: []
 files: 
 - lib/alphabets.rb
 - lib/enumerable.rb
+- lib/object.rb
 - lib/sort-by-alphabet.rb
 - lib/sort_by_alphabet.rb
 - init.rb