rails_dictionary 0.0.9.3 → 0.0.9.4

data/README.rdoc

@@ -14,6 +14,8 @@ or
         rails runner "DictType.new.delete_all_caches"
 and in production
         rails runner "DictType.new.delete_all_caches" -e production
+or if you use file cache,just run
+        rake tmp:clear
 See change log for brief info.
 
 == Sample
@@ -81,7 +83,7 @@ student_city is a dynamic method which returns a list of dictionary object which
 Actually Dictionary will have as many dynamic methods as DictType.count and each dynamic method name is DictType.name.
 Before version 0.1.0 or 0.2.0 ,all dynamic methods return an array,not ActiveRelation.So
    Dictionary.student_school = []
-   Dictionary.student_city :locale => :en  #=> [["shanghai",1],["beijing",2]]
+   Dictionary.student_city :locale => :en  #=> [["beijing", 2],["shanghai",1]]
 You can use it in form select method like
    collection_select :student,:city,Dictionary.student_city,:id,:name_en
    select :student,:city,Dictionary.student_city(params)
@@ -96,6 +98,13 @@ Make sure your locale is en,not en-US.
 Student has two belongs_to assocition which named as city_dict and school_dict,the naming convention is method_dict.
    Student.find(1).city_dict #=> Dictionary.find(6)
 
+=== Sort Feature
+Static data need orders frequently,so Dictionary.student_city :locale => :en has a default sort rules.
+By default,if the options contains locale,the results are sorted by the name value.
+If locale is :zh,sort rule is order by GBK encoding.
+Other locales are just order by alphabetical without case sensitive.
+You can override Dictionary.sort_dicts to customize your sort rule.But it is not recommended now as the code of sort design maybe change in a few month.
+
 = Practical Suggestion
 If you start a new application and there are more than 10 kinds of static data,you may have a try with the gem.
 However,if you see many static data in an old system and want to refactor it,the decision would be judged by the real situations.
@@ -110,8 +119,7 @@ The rails cache would not refresh.
 In short,when you confused with the debug data,try running "rails tmp:clear" first.
 
 = TODO & Problems
-There are no convention and implemention to map Class like Ckeditor::Asset to a legal method name.
-
-Rebuild core code.Using Rails engine.
-
+Is there any exist low level method to monitor the change of descendents
 Add test code for cache DictType.tab_and_column,then uncomment the cache code.
+
+There are no convention and implemention to map Class like Ckeditor::Asset to a legal method name.

data/lib/rails_dictionary/models/active_record_extension.rb

@@ -8,21 +8,21 @@ module RailsDictionary
       # TODO: move macro define in each module file
       # See Usage in readme.doc.
       def acts_as_dict_type
-        self.class_eval do
-          has_many :dictionaries
-          validates_uniqueness_of :name
-          after_save :delete_all_caches
-          after_destroy :delete_all_caches
-        end
+
+        has_many :dictionaries
+        validates_uniqueness_of :name
+        after_save :delete_all_caches
+        after_destroy :delete_all_caches
+
         include RailsDictionary::ActsAsDictType
       end
 
       def acts_as_dictionary
-        self.class_eval do
-          belongs_to :dict_type
-          after_save :delete_dicts_cache
-          after_destroy :delete_dicts_cache
-        end
+
+        belongs_to :dict_type
+        after_save :delete_dicts_cache
+        after_destroy :delete_dicts_cache
+
         include RailsDictionary::ActsAsDictionary
       end
 

data/lib/rails_dictionary/models/acts_as_dictionary.rb

@@ -37,16 +37,31 @@ module RailsDictionary
           # Instance of activerelation can not be dup?
           if options.keys.include? :locale or options.keys.include? "locale"
             locale="name_#{ options[:locale] }"
+            sort_block=sort_dicts(options)
+            listed_attr.sort!(&sort_block) if sort_block
             listed_attr.map! { |a| [a.send(locale),a.id] }.reject! {|ele| ele.first.nil?}
-            listed_attr.sort { |a,b| a.first.downcase <=> b.first.downcase }
-            # maybe remove the above line,or change some sorting and caching design
-          else
-            listed_attr
           end
+          listed_attr
         else
           super
         end
       end
+
+      # overide this method to get customed sort block
+      def sort_dicts(options)
+        if options.keys.include? :locale or options.keys.include? "locale"
+          locale="name_#{ options[:locale] }"
+          if options[:locale].to_sym == :zh
+            conv = Iconv.new("GBK", "utf-8")
+            Proc.new { |a,b| conv.iconv(a.send(locale)) <=> conv.iconv(b.send(locale)) }
+          else
+            Proc.new { |a,b| a.send(locale).downcase <=> b.send(locale).downcase }
+          end
+        else
+          false
+        end
+      end
+
     end
 
     module InstanceMethods

data/lib/rails_dictionary/railtie.rb

@@ -1,4 +1,5 @@
 require 'rails'
+require 'iconv'
 
 require File.join(File.dirname(__FILE__),"array_core_ext")
 require File.join(File.dirname(__FILE__),"models/acts_as_dict_type")

data/lib/rails_dictionary/version.rb

@@ -1,3 +1,3 @@
 module RailsDictionary
-  VERSION = "0.0.9.3"
+  VERSION = "0.0.9.4"
 end

data/spec/rails_dictionary_spec.rb

@@ -45,7 +45,7 @@ describe RailsDictionary do
     end
 
     it "generate student_city method with locale" do
-      Dictionary.student_city(:locale => :zh).should == [["上海", 1],["北京", 2]]
+      Dictionary.student_city(:locale => :zh).should == [["北京", 2],["上海",1]]
     end
 
     it "after record added or removed" do

metadata

@@ -2,7 +2,7 @@
 name: rails_dictionary
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.9.3
+  version: 0.0.9.4
 platform: ruby
 authors: 
 - Raykin Lee
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-18 00:00:00 Z
+date: 2011-04-27 00:00:00 Z
 dependencies: []
 
 description: Rails plugin for mapping static data of web application to Dictionary class
@@ -43,7 +43,6 @@ files:
 - spec/fake_app.rb
 - spec/rails_dictionary_spec.rb
 - spec/spec_helper.rb
-- test/rails_dictionary_test.rb
 homepage: https://github.com/raykin/rails_dictionary
 licenses: []
 
@@ -75,5 +74,4 @@ test_files:
 - spec/fake_app.rb
 - spec/rails_dictionary_spec.rb
 - spec/spec_helper.rb
-- test/rails_dictionary_test.rb
 has_rdoc: 

data/test/rails_dictionary_test.rb

@@ -1,137 +0,0 @@
-# -*- coding: utf-8 -*-
-# Testing for version 0.0.8 or lower.Copy the test design from acts_as_tree
-# Usage: run "ruby -I . test/rails_dictionary_test.rb " in root dir
-#
-require "test/unit"
-require "active_support"
-require "active_record"
-require "ruby-debug" # coupled with debugger to debug code
-Object.const_set "RAILS_CACHE", ActiveSupport::Cache.lookup_store
-require "active_support/cache"
-require "rails"
-require "#{File.dirname(__FILE__)}/../lib/rails_dictionary.rb"
-
-ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
-
-$stdout = StringIO.new
-
-def setup_db
-  ActiveRecord::Base.logger
-  ActiveRecord::Schema.define(:version => 1) do
-    create_table :dict_types do |t|
-      t.string :name
-      t.timestamps
-    end
-    create_table :dictionaries do |t|
-      t.string :name_en
-      t.string :name_zh
-      t.string :name_fr
-      t.integer :dict_type_id
-      t.timestamps
-    end
-    create_table :students do |t|
-      t.string :email
-      t.integer :city
-      t.integer :school
-      t.timestamps
-    end
-  end
-end
-
-def teardown_db
-  ActiveRecord::Base.connection.tables.each do |table|
-    ActiveRecord::Base.connection.drop_table(table)
-  end
-end
-
-class DictType < ActiveRecord::Base
-  acts_as_dict_type
-end
-
-class Dictionary < ActiveRecord::Base
-  acts_as_dictionary
-end
-
-class Student < ActiveRecord::Base
-end
-
-class CoreExtTest < Test::Unit::TestCase
-  def test_array
-    expected_hash={:student => %w[school city],:admin => %w[role]}
-    blank_hash={}
-    assert_equal expected_hash, %w[student_school student_city admin_role].extract_to_hash(%w[student admin])
-    assert_equal expected_hash, %w[root student_school student_city admin_role].extract_to_hash(%w[student admin])
-    assert_equal blank_hash, %w[root students_school students_city].extract_to_hash(%w[student])
-  end
-end
-
-class DictTypeTest < Test::Unit::TestCase
-  def setup
-    setup_db
-    #Object.const_set('Student',Class.new(ActiveRecord::Base))
-    @dt_stu_city=DictType.create! :name => "student_city"
-    @dt_stu_school=DictType.create! :name => "student_school"
-    @dy_shanghai=Dictionary.create! name_en: "shanghai",name_zh: "上海",name_fr: "shanghai",dict_type_id: @dt_stu_city.id
-    @dy_beijing=Dictionary.create! name_en: "beijing",name_zh: "北京",name_fr: "Pékin",dict_type_id: @dt_stu_city.id
-    @stu_beijing=Student.create! email: "beijing@dict.com",city: @dy_beijing.id
-    @stu_shanghai=Student.create! email: "shanghai@dict.com",city: @dy_shanghai.id
-  end
-
-  def teardown
-    teardown_db
-  end
-
-  def test_tab_and_column
-    expected_hash={:student => %w[city school]}
-    assert_equal expected_hash,DictType.tab_and_column
-  end
-
-  def test_all_types
-    assert_equal %w[student_city student_school],DictType.all_types
-  end
-
-  # test revert method in acts_as_dict_type
-  def test_dt_revert
-    assert_equal "student_school",DictType.revert(@dt_stu_school.id)
-    assert_equal nil,DictType.revert(100)
-  end
-
-  # test dynamic instance methods in slave model
-  def test_named_city
-    Student.acts_as_dict_slave
-    # the acts_as_dict_slave need real data to generate dynamic method
-    assert_equal %w[city school],Student.columns_in_dict_type
-    assert_equal %w[city school],Student.dict_columns
-    assert_equal "shanghai",@stu_shanghai.named_city(:en)
-    assert_equal "shanghai",@stu_shanghai.named_city("")
-    assert_equal "Pékin",@stu_beijing.named_city(:fr)
-  end
-
-  def test_named_city_with_default_locale
-    Student.acts_as_dict_slave :locale => :fr
-    assert_equal "Pékin",@stu_beijing.named_city
-  end
-
-  def test_dictionary_method_missing
-    assert_equal [["beijing",2],["shanghai",1]],Dictionary.student_city(:locale => :en)
-  end
-
-  def test_dictionary_method_missing_with_locale
-    assert_equal [["上海", 1],["北京", 2]],Dictionary.student_city(:locale => :zh)
-  end
-
-  def test_delete_dicts_cache
-    @dy_wuhan=Dictionary.create! name_en: "wuhan",name_zh: "武汉",name_fr: "wuhan",dict_type_id: @dt_stu_city.id
-    assert_equal [["beijing", 2],["shanghai",1],["wuhan", 3]],Dictionary.student_city(:locale => :en)
-    @dy_wuhan.destroy
-    assert_equal [["beijing", 2],["shanghai",1]],Dictionary.student_city(:locale => :en)
-    assert_equal [@dy_shanghai,@dy_beijing],Dictionary.student_city
-  end
-
-  def test_delete_all_caches
-    assert_equal %w[student_city student_school],DictType.all_types
-    @dt_stu_school.destroy
-    assert_equal %w[student_city],DictType.all_types
-  end
-
-end