rails_dictionary 0.0.4 → 0.0.5

data/README.rdoc

@@ -14,7 +14,9 @@ In this usage sample,there are three tables.
 === Table Definition
 Make sure you have two tables which named as dict_types and dictionaries.
 For version 0.0.1,I'm not going to add more configurations.
+Table dictionaries has one conventions on column naming: name_locale.So the name_fr means this column have a french value,you can see more usage later.
 The students table is not required.
+
     create_table :dict_types do |t|
       t.string :name
       t.string :comment
@@ -90,9 +92,9 @@ Student has 2 belongs_to assocition which named as city_dict and school_dict,the
 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.
 
-= Warnning
+= Beware
 The most used debug method would be DictType.all_types and Dictionary.student_city(or other dynamic generate method)
-When you get some confused with these method,try running
+When you get some confused with the output of these method,try running
      rails tmp:clear
 cause these methods all return static data,I just caches these output for better performance.If you change db data in db console(not through Rails) like running
      delete from dict_types;
@@ -100,7 +102,8 @@ The rails cache would not refresh.
 In short,when you confused with the debug data,try running "rails tmp:clear" first.
 
 = TODO & Problems
-Get a more smart method(Rails way method) to get all Model Class and there is a problem with it.Class like Ckeditor::Asset will not be recognized.
+There are no convention and implemention to map Class like Ckeditor::Asset to a method.
+Add generators.
 
 = Help
 Need an friendly english native guy to help me improve this readme to make it more clear and readable.

data/lib/rails_dictionary/acts_as_dict_slave.rb

@@ -4,11 +4,15 @@ module ActsAsDictSlave
   end
 
   module ClassMethods
-    # argument except will remove dynamic column method
-    # argument add will add dynamic column method
+    # :except - remove dict mapping column
+    # :add - add dict mapping column
+    # :locale - add and initialize class attribute default_dict_locale
     def acts_as_dict_slave(ops={})
-      @@dict_columns = dict_columns(ops)
-      unless @@dict_columns.nil?
+      class_attribute :default_dict_locale,:instance_writer => false
+      cattr_accessor :dict_mapping_columns,:instance_writes => false
+      self.default_dict_locale = ops[:locale] if ops[:locale]
+      self.dict_mapping_columns = dict_columns(ops)
+      unless dict_mapping_columns.nil?
         add_dynamic_column_method
       end
     end
@@ -37,19 +41,24 @@ module ActsAsDictSlave
     # add a belongs_to(Dictionary) association and a named_{column} method
     def add_dynamic_column_method
       self.extend(DynamicInsMethods)
-      @@dict_columns.each { |e| belongs_to "#{e.to_s}_dict".to_sym,class_name: "Dictionary",foreign_key: e }
-      @@dict_columns.each { |ele| named_dict_value ele.to_sym }
+      dict_mapping_columns.each { |e| belongs_to "#{e.to_s}_dict".to_sym,class_name: "Dictionary",foreign_key: e }
+      dict_mapping_columns.each { |ele| named_dict_value ele.to_sym }
     end
   end
 
   module DynamicInsMethods
     # generate dynamic instance method named_column to slave model
+    # def named_city(locale=nil)
+    #   locale = locale.presence || default_dict_locale.presence || :en
+    #   locale = "name_#{locale}"
+    #   self.send(city_dict).try(:send,locale)
+    # end
     def named_dict_value(method_name)
       belongs_to_name="#{method_name.to_s}_dict".to_sym
       method_name="named_#{method_name.to_s}"
-      define_method(method_name) do | locale=:en |
-        # arg.first ? locale = "name_#{arg.first}" : locale ='name_en'
-        locale ="name_#{locale}"
+      define_method(method_name) do | locale=nil |
+        locale = locale.presence || default_dict_locale.presence || :en
+        locale = "name_#{locale}"
         self.send(belongs_to_name).try(:send,locale)
       end
     end

data/lib/rails_dictionary/acts_as_dict_type.rb

@@ -32,16 +32,13 @@ module ActsAsDictType
         # TODO: get a more accurate method name
         # parse the name to get which column and model are listed in DictType
         def self.tab_and_column
-          @tab_and_column={}
-          @all_types=all_types
-          # TODO: any better way to retrive the class name in app/model ?
-          # Here maybe a problem when class like Ckeditor::Asset(.name.underscore => "ckeditor/asset"
-          all_tabs=ActiveRecord::Base.connection.tables.sort.reject! do |t|
-            ['schema_migrations', 'sessions'].include?(t)
-          end
-          all_class=all_tabs.map(&:singularize)
-          all_tabs=all_class
-          @tab_and_column=@all_types.extract_to_hash(all_tabs)
+          tab_and_column={}
+          # There are two chooses,one is subclasses the other is descendants,
+          # I don't know which is better,but descendants contains subclass of subclass,it contains more.
+          # Class like +Ckeditor::Asset+ transfer to "ckeditor/asset",but we can not naming method like that,
+          # So it still not support, the solution may be simple,just make another convention to escape "/"
+          all_model_class=ActiveRecord::Base.descendants.map(&:name).map(&:underscore)
+          tab_and_column=all_types.extract_to_hash(all_model_class)
         end
       end
     end

data/lib/rails_dictionary/acts_as_dictionary.rb

@@ -4,31 +4,33 @@ module ActsAsDictionary
   end
 
   module ClassMethods
-    def acts_as_dictionary
-      self.class_eval do
-        include InstanceMethods
-        belongs_to :dict_type
-        after_save :delete_dicts_cache
-        after_destroy :delete_dicts_cache
 
-        # TODO: need to add more function
-        def self.method_missing(method_id,options={},&block)
-          method_name=method_id.to_s.downcase
-          if DictType.all_types.include? method_id.to_s
-            Rails.cache.fetch("Dictionary.#{method_name}") { Dictionary.joins(:dict_type).where('dict_types.name'=>method_name).all }
-            listed_attr=Rails.cache.read("Dictionary.#{method_name}").dup
-            if options.keys.include? :locale or options.keys.include? "locale"
-              locale="name_#{options[:locale]}"
-              listed_attr.map! { |a| [a.send(locale),a.id] }
-              listed_attr.sort {|a,b| a.last <=> b.last } # maybe remove this one
-            else
-              listed_attr
-            end
+    def acts_as_dictionary
+      belongs_to :dict_type
+      after_save :delete_dicts_cache
+      after_destroy :delete_dicts_cache
+      scope :dict_type_name_eq,lambda {|method_name| joins(:dict_type).where("dict_types.name" => method_name).all}
+      include InstanceMethods
+      # Generate methods like Dictionary.student_city
+      # Dictionary.student_city - a list of dictionary object which dict type is student_city
+      # Dictionary.student_city(:locale => :zh) - a select format array which can be used
+      # in view method select as choice params
+      # Is this design good?
+      def self.method_missing(method_id,options={},&block)
+        method_name=method_id.to_s.downcase
+        if DictType.all_types.include? method_id.to_s
+          Rails.cache.fetch("Dictionary.#{method_name}") { Dictionary.dict_type_name_eq(method_name) }
+          listed_attr=Rails.cache.read("Dictionary.#{method_name}").dup
+          if options.keys.include? :locale or options.keys.include? "locale"
+            locale="name_#{ options[:locale] }"
+            listed_attr.map! { |a| [a.send(locale),a.id] }
+            listed_attr.sort {|a,b| a.last <=> b.last } # maybe remove this line
           else
-            super
+            listed_attr
           end
+        else
+          super
         end
-
       end
 
     end

data/lib/rails_dictionary/version.rb

@@ -1,3 +1,3 @@
 module RailsDictionary
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/test/rails_dictionary_test.rb

@@ -2,7 +2,7 @@
 require "test/unit"
 require "active_support"
 require "active_record"
-require "ruby-debug"
+require "ruby-debug" # coupled with debugger to debug code
 Object.const_set "RAILS_CACHE", ActiveSupport::Cache.lookup_store
 require "active_support/cache"
 require "rails"
@@ -73,8 +73,6 @@ class DictTypeTest < Test::Unit::TestCase
     @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
-    Student.acts_as_dict_slave
-    # the acts_as_dict_slave need real data to generate dynamic method
   end
 
   def teardown
@@ -105,12 +103,20 @@ class DictTypeTest < Test::Unit::TestCase
 
   # 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_delete_dicts_cache
     @dy_wuhan=Dictionary.create! name_en: "wuhan",name_zh: "武汉",name_fr: "wuhan",dict_type_id: @dt_stu_city.id
     assert_equal [["shanghai", 1], ["beijing", 2], ["wuhan", 3]],Dictionary.student_city(:locale => :en)

metadata

@@ -2,7 +2,7 @@
 name: rails_dictionary
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - raykin
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-01 00:00:00 +08:00
+date: 2011-03-07 00:00:00 +08:00
 default_executable: 
 dependencies: []
 
@@ -59,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rails_dictionary
-rubygems_version: 1.5.2
+rubygems_version: 1.6.1
 signing_key: 
 specification_version: 3
 summary: dictionary data for application