alphabetical_paginate 1.4.0 → 1.5.0

data/README.md

@@ -8,6 +8,8 @@ AlphabeticalPaginate incorporates efficient javascript partial page rerendering
 
 It has two modes - if you're working with MySQL, it allows for low level database regex queries. Otherwise, it uses a buffered search to build an array. You should be able to easily modify the gem to work with other SQL databases (please make a pull-request if you do!).
 
+We also now have Russian language support.
+
 Some code was inspired by [will_paginate](https://github.com/mislav/will_paginate).
 
 
@@ -98,6 +100,8 @@ The available options are as follows:
 
 Key | Value | Default |Description
 --- | --- | --- | ---
+`:db_mode` | `Boolean` | `false` | Whether to activate low level SQL that are faster and more memory efficient (forces `:paginate_all` to enable)
+`:db_field` | `String` | `id` | Required if `db_mode` is `true`. The field to paginate / sort by (on the same collection).
 `:enumerate` | `Boolean` | `false` | Whether you want the number field collapsed (all numbers go into `0`) or separate (`0`, `1`, `2`...).
 `:default_field` | `String` | `"a"` | Which field you want the page to default to on first load (`"0"`, `"a"`. `"*"`).
 `:paginate_all` | `Boolean` | `false` | Whether you want empty fields to still render in pagination.
@@ -106,6 +110,7 @@ Key | Value | Default |Description
 `:others` | `Boolean` | `true` | Whether you want all other characters (non alphanumeric) to be included in the pagination at all.
 `:pagination_class` | `String` | `"pagination-centered"` | All the classes you would like to add to the rendered pagination selector div (for CSS purposes).
 `:js` | `Boolean` | `"true"` | If you want the javascript with page-rerendering to be enabled.
+`:support_language` | `Symbol` | `:en` | If you want russian letters support set this value to `:ru` (only if `I18n.locale` in your application set to `:ru`).
 
 ## Advanced Pagination
 

data/lib/alphabetical_paginate/array.rb

@@ -1,14 +1,17 @@
+# coding: utf-8
 class Array
   def alpha_paginate current_field, params = {enumerate:false, default_field: "a", 
                                                 paginate_all: false, numbers: true, include_all: true,
                                                 others: true, pagination_class: "pagination-centered",
-                                                js: true}
+                                                js: true, support_language: :en}
     params[:paginate_all] ||= false
+    params[:support_language] ||= :en
+    params[:language] = AlphabeticalPaginate::Language.new(params[:support_language])
     params[:include_all] = true if !params.has_key? :include_all
     params[:numbers] = true if !params.has_key? :numbers
     params[:others] = true if !params.has_key? :others
     params[:js] = true if !params.has_key? :js
-    params[:default_field] ||= params[:include_all] ? "all" : "a"
+    params[:default_field] ||= params[:include_all] ? "all" : params[:language].default_letter
     params[:pagination_class] ||= "pagination-centered"
     output = []
     availableLetters = {}
@@ -16,13 +19,14 @@ class Array
       current_field = params[:default_field]
     end
     all = params[:include_all] && current_field.downcase == "all"
+
     self.each do |x|
       field_val = block_given? ? yield(x).to_s : x.id.to_s
-      field_letter = field_val[0].downcase
+      field_letter = field_val[0].mb_chars.downcase.to_s
       case field_letter
-        when /[a-z]/
+        when params[:language].letters_regexp
           availableLetters[field_letter] = true if !availableLetters.has_key? field_letter
-          output << x if all || (current_field =~ /[a-z]/ && field_letter == current_field)
+          output << x if all || (current_field =~ params[:language].letters_regexp && field_letter == current_field)
         when /[0-9]/
           if params[:enumerate]
             availableLetters[field_letter] = true if !availableLetters.has_key? field_letter
@@ -36,6 +40,7 @@ class Array
           output << x if all || current_field == "*"
       end
     end
+
     params[:availableLetters] = availableLetters.collect{|k,v| k.to_s}
     params[:currentField] = current_field
     output.sort! {|x, y| block_given? ? (yield(x).to_s <=> yield(y).to_s) : (x.id.to_s <=> y.id.to_s) }

data/lib/alphabetical_paginate/language.rb

@@ -0,0 +1,45 @@
+# coding: utf-8
+module AlphabeticalPaginate
+  class Language
+    attr_reader :code
+
+    def initialize(code)
+      @code = code
+    end
+
+    def russian?
+      defined?(I18n) && I18n.locale == :ru && code == :ru
+    end
+
+    def letters_regexp
+      russian? ? /[#{russian_letters}]/ : /[a-z]/
+    end
+
+    def letters_range
+      if russian?
+        letters = []
+        russian_letters.each_char{ |x| letters << x }
+        letters
+      else
+        ('a'..'z').to_a
+      end
+    end
+
+    def output_letter(l)
+      (l == "all") ? all_field : l
+    end
+
+    def all_field
+      russian? ? 'все' : "all"
+    end
+
+    def default_letter
+      russian? ? "а" : "a" # First 'a' is russian, second - english
+    end
+
+    private
+      def russian_letters
+        "абвгдежзиклмнопрстуфхцчшэюя"
+      end
+  end
+end

data/lib/alphabetical_paginate/version.rb

@@ -1,3 +1,3 @@
 module AlphabeticalPaginate
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/lib/alphabetical_paginate/view_helpers.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 module AlphabeticalPaginate
   module ViewHelpers
     def alphabetical_paginate params
@@ -7,7 +8,7 @@ module AlphabeticalPaginate
       output += javascript_include_tag 'alphabetical_paginate' if params[:js]
       
       if params[:paginate_all]
-        range = ('a'..'z').to_a
+        range = params[:language].letters_range
         if params[:others]
           range += ["*"]
         end
@@ -18,12 +19,13 @@ module AlphabeticalPaginate
         end
         range.unshift "all" if params[:include_all]
         range.each do |l|
+          value = params[:language].output_letter(l)
           if l == params[:currentField]
-            links += '<li class="active"><a href="#" data-letter="' + l + '">' + l + "</a></li>"
+            links += '<li class="active"><a href="#" data-letter="' + l + '">' + value + "</a></li>"
           elsif params[:db_mode] or params[:availableLetters].include? l
-            links += '<li><a href="?letter=' + l + '" data-letter="' + l + '">' + l + "</a></li>"
+            links += '<li><a href="?letter=' + l + '" data-letter="' + l + '">' + value + "</a></li>"
           else
-            links += '<li class="disabled"><a href="?letter=' + l + '" data-letter="' + l + '">' + l + "</a></li>"
+            links += '<li class="disabled"><a href="?letter=' + l + '" data-letter="' + l + '">' + value + "</a></li>"
           end
         end
       else
@@ -34,10 +36,11 @@ module AlphabeticalPaginate
         params[:availableLetters] -= ["*"] if !params[:others]
         
         params[:availableLetters].each do |l|
+          value = params[:language].output_letter(l)
           if l == params[:currentField]
-            links += '<li class="active"><a href="?letter=' + l + '" data-letter="' + l + '">' + l + '</a></li>'
+            links += '<li class="active"><a href="?letter=' + l + '" data-letter="' + l + '">' + value + '</a></li>'
           else
-            links += '<li><a href="?letter=' + l + '" data-letter="' + l + '">' + l + "</a></li>"
+            links += '<li><a href="?letter=' + l + '" data-letter="' + l + '">' + value + "</a></li>"
           end
         end
       end

data/lib/alphabetical_paginate.rb

@@ -1,5 +1,6 @@
 require "alphabetical_paginate/version"
 require "alphabetical_paginate/array"
+require "alphabetical_paginate/language"
 require "alphabetical_paginate/railtie" if defined?(Rails)
 
 module AlphabeticalPaginate

data/spec/alphabetical_paginate_spec.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 require 'alpha_example'
 require 'alphabetical_paginate'
 require_relative '#{File.dirname(__FILE__)}/../../lib/alphabetical_paginate/view_helpers'
@@ -59,84 +60,154 @@ module AlphabeticalPaginate
           expectedParams.to_s
       end
     end
+
+    describe "#alpha_paginate in russian characters" do
+      before :each do
+        I18n.locale = :ru
+        @list = ["аа", "аб", "ас",
+          "ба", "бб", "бв",
+          "са", "сд", "се"].map do |x|
+          AlphaExample.new(x)
+        end
+      end
+
+      it "should paginate by id automatically" do
+        expectedCollection = ["са", "сд", "се"].map do |x|
+          AlphaExample.new(x)
+        end
+        expectedParams = {
+          availableLetters: ["а", "б", "с"],
+          currentField: "с",
+          enumerate: false,
+        }
+        collection, params = @list.alpha_paginate("с", { support_language: :ru })
+        collection.to_s.should == 
+          expectedCollection.to_s
+        params.to_s.should include
+          expectedParams.to_s
+      end
+
+      it "should paginate for russian characters with default 'a' character" do
+        expectedCollection = ["аа", "аб", "ас"].map do |x|
+          AlphaExample.new(x)
+        end
+        expectedParams = {
+          availableLetters: ["а", "б", "с"],
+          currentField: "а",
+          enumerate: false,
+        }
+        collection, params = @list.alpha_paginate(nil, { include_all: false, support_language: :ru })
+        collection.to_s.should == 
+          expectedCollection.to_s
+        params.to_s.should include
+          expectedParams.to_s
+      end
+    end
+
     include ViewHelpers
 
-      describe "#alphabetical_paginate" do
-        before :each do
-          @list = []
-          (["@!#"] + (0..9).to_a.map{|x| x.to_s} + ("a".."z").to_a).each do |x|
-            ("a".."y").to_a.each do |y|
-              @list << x + y
-            end
+    describe "#alphabetical_paginate" do
+      before :each do
+        @list = []
+        (["@!#"] + (0..9).to_a.map{|x| x.to_s} + ("a".."z").to_a).each do |x|
+          ("a".."y").to_a.each do |y|
+            @list << x + y
           end
-          @list.map! do |x|
-            AlphaExample.new(x)
+        end
+        @list.map! do |x|
+          AlphaExample.new(x)
+        end
+      end
+
+      it "should have div tags and pagination classes" do
+        index, params = @list.alpha_paginate(nil)
+        pagination = alphabetical_paginate(params)
+        pagination.should include "div", "pagination"
+      end
+
+      it "should include a numbers and others field" do
+        index, params = @list.alpha_paginate(nil)
+        pagination = alphabetical_paginate(params)
+        (["*"] + ["0-9"] + ("a".."z").to_a.map{|x|
+          'data-letter="%s"'%x}).each do |x|
+          pagination.should include x
+        end
+      end
+
+      it "should default all values when necessary" do
+        index, params = @list.alpha_paginate(nil, {})
+        pagination = alphabetical_paginate(params)
+        (["*"] + ["0-9"] + ("a".."z").to_a.map{|x|
+          'data-letter="%s"'%x}).each do |x|
+          pagination.should include x
+        end
+      end
+
+      it "should hide values that don't exist" do
+        index, params = @list.alpha_paginate(nil){|x| x.word}
+        pagination = alphabetical_paginate(params)
+        (("a".."y").to_a.map{|x|
+          'data-letter="%s"'%x}).each do |x|
+          pagination.should include x
+        end
+        pagination.should_not include 'data-letter="z"', 'data-letter="*"',
+          'data-letter="0-9"'
+      end
+
+      it "should enumerate when asked" do
+        index, params = @list.alpha_paginate(nil, {enumerate: true})
+        pagination = alphabetical_paginate(params)
+        (("0".."9").to_a.map{|x|
+          'data-letter="%s"'% x.to_s }).each do |x|
+          pagination.should include x
+        end
+
+      end
+
+      it "should display all when asked" do
+        index, params = @list.alpha_paginate(nil, {paginate_all: true,
+                                             enumerate: true}){|x| x.word}
+        pagination = alphabetical_paginate(params)
+        (["*"] + (0..9).to_a.map{|x| x.to_s} + ("a".."z").to_a.map{|x|
+          'data-letter="%s"'%x}).each do |x|
+          pagination.should include x
+        end
+      end
+
+      it "should include 'all' and '0-9' fields" do
+        index, params = @list.alpha_paginate(nil, { include_all: true })
+        pagination = alphabetical_paginate(params)
+        (["all", "0-9"].map{|x|
+          'data-letter="%s"'%x}).each do |x|
+          pagination.should include x
+        end
+      end
+    end
+
+    describe "#alphabetical_paginate in russian characters" do
+      before :each do
+        @list = []
+        ("а".."я").to_a.each do |x|
+          ("а".."т").to_a.each do |y|
+            @list << x + y
           end
         end
+        @list.map! do |x|
+          AlphaExample.new(x)
+        end
+        @russian_array = []
+        "абвгдежзиклмнопрстуфхцчшэюя".each_char{ |x| @russian_array << x }
+      end
 
-				it "should have div tags and pagination classes" do
-					index, params = @list.alpha_paginate(nil)
-					pagination = alphabetical_paginate(params)
-					pagination.should include "div", "pagination"
-				end
-
-				it "should include a numbers and others field" do
-					index, params = @list.alpha_paginate(nil)
-					pagination = alphabetical_paginate(params)
-					(["*"] + ["0-9"] + ("a".."z").to_a.map{|x|
-						'data-letter="%s"'%x}).each do |x|
-						pagination.should include x
-					end
-				end
-
-				it "should default all values when necessary" do
-					index, params = @list.alpha_paginate(nil, {})
-					pagination = alphabetical_paginate(params)
-					(["*"] + ["0-9"] + ("a".."z").to_a.map{|x|
-						'data-letter="%s"'%x}).each do |x|
-						pagination.should include x
-					end
-				end
-
-				it "should hide values that don't exist" do
-					index, params = @list.alpha_paginate(nil){|x| x.word}
-					pagination = alphabetical_paginate(params)
-					(("a".."y").to_a.map{|x|
-						'data-letter="%s"'%x}).each do |x|
-						pagination.should include x
-					end
-					pagination.should_not include 'data-letter="z"', 'data-letter="*"',
-						'data-letter="0-9"'
-				end
-
-				it "should enumerate when asked" do
-					index, params = @list.alpha_paginate(nil, {enumerate: true})
-					pagination = alphabetical_paginate(params)
-					(("0".."9").to_a.map{|x|
-						'data-letter="%s"'% x.to_s }).each do |x|
-						pagination.should include x
-					end
-
-				end
-
-				it "should display all when asked" do
-					index, params = @list.alpha_paginate(nil, {paginate_all: true,
-																							 enumerate: true}){|x| x.word}
-					pagination = alphabetical_paginate(params)
-					(["*"] + (0..9).to_a.map{|x| x.to_s} + ("a".."z").to_a.map{|x|
-						'data-letter="%s"'%x}).each do |x|
-						pagination.should include x
-					end
-				end
-
-        it "should include 'all' and '0-9' fields" do
-					index, params = @list.alpha_paginate(nil, { include_all: true })
-					pagination = alphabetical_paginate(params)
-					(["all", "0-9"].map{|x|
-						'data-letter="%s"'%x}).each do |x|
-						pagination.should include x
-					end
-				end
+      it "should display russian characters through additional attribute(language)" do
+        I18n.locale = :ru
+        index, params = @list.alpha_paginate(nil, { paginate_all: true, others: false, support_language: :ru }){|x| x.word}
+        pagination = alphabetical_paginate(params)
+        (["0"] + @russian_array.map{|x|
+          'data-letter="%s"'%x}).each do |x|
+          pagination.should include x
+        end
       end
     end
+  end
 end

data/spec/language_spec.rb

@@ -0,0 +1,64 @@
+# coding: utf-8
+
+module AlphabeticalPaginate
+  describe Language do
+    context "English language" do
+      before(:all) do
+        @language = AlphabeticalPaginate::Language.new(:en)
+      end
+
+      it "should return false on russian? method" do
+        @language.russian?.should be_false
+      end
+
+      it "should return /[a-z]/ regexp" do
+        @language.letters_regexp.should eq(/[a-z]/)
+      end
+
+      it "should return array of english letters" do
+        @language.letters_range.should eq(("a".."z").to_a)
+      end
+
+      it "should return english representation of 'all' field and other english letters (for view helper)" do
+        (["all"] + ("a".."z").to_a).map do |l|
+          @language.output_letter(l).should eq(l)
+        end
+      end
+
+      it "should return english representation of 'a' letter" do
+        @language.default_letter.should eq("a")
+      end
+    end
+
+    context "Russian language" do
+      before(:all) do
+        @language = AlphabeticalPaginate::Language.new(:ru)
+        @russian_string = "абвгдежзиклмнопрстуфхцчшэюя"
+        @russian_array = []
+        @russian_string.each_char{ |x| @russian_array << x }
+      end
+
+      it "should return true on russian? method" do
+        @language.russian?.should be_true
+      end
+
+      it "should return /[абвгдежзиклмнопрстуфхцчшэюя]/ regexp" do
+        @language.letters_regexp.should eq(/[#{@russian_string}]/)
+      end
+
+      it "should return array of russian letters" do
+        @language.letters_range.should eq(@russian_array)
+      end
+
+      it "should return russian representation of 'all' field and other russian letters (for view helper)" do
+        (["все"] + @russian_array).map do |l|
+          @language.output_letter(l).should eq(l)
+        end
+      end
+
+      it "should return russian representation of 'a' letter" do
+        @language.default_letter.should eq("а")
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alphabetical_paginate
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-09 00:00:00.000000000 Z
+date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,11 +92,13 @@ files:
 - lib/alphabetical_paginate/array.rb
 - lib/alphabetical_paginate/controller_helper.rb
 - lib/alphabetical_paginate/engine.rb
+- lib/alphabetical_paginate/language.rb
 - lib/alphabetical_paginate/railtie.rb
 - lib/alphabetical_paginate/version.rb
 - lib/alphabetical_paginate/view_helpers.rb
 - spec/alpha_example.rb
 - spec/alphabetical_paginate_spec.rb
+- spec/language_spec.rb
 - spec/support/helpers.rb
 - vendor/assets/images/aloader.gif
 - vendor/assets/javascripts/alphabetical_paginate.js
@@ -129,4 +131,5 @@ summary: Pagination
 test_files:
 - spec/alpha_example.rb
 - spec/alphabetical_paginate_spec.rb
+- spec/language_spec.rb
 - spec/support/helpers.rb