rails_dictionary 0.1.0 → 0.1.1

data/README.rdoc

@@ -54,7 +54,7 @@ These task are just generate table dictionaries,dict_types,students and some sam
          | 2  | shanghai@dict.com | 3    |        |
          +----+-------------------+------+--------+
          2 rows in set
-There is one convention of DictType.name value.All value of DictType.name is "model_method" : student is model and city is method of student model.
+There is one convention on DictType.name .All value of DictType.name is "model_method" : student is model and city is method of student model.
 
 === Table Definition
 Make sure you have two tables which named as dict_types and dictionaries.
@@ -81,11 +81,13 @@ Here is what should be like.Student model can be other models.
    DictType.all_cached #=> return cache of DictType.all
    DictType.all_types = [:student_city,:student_school] # also cached
    Dictionary.student_city #=> [Dictionary.find(5),Dictionary.find(6)]
-student_city is a dynamic method which returns a list of dictionary object which dict_type is "student_city".
+student_city is a dynamic method(from method missing) which returns a list of dictionary object which dict_type is "student_city".
 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
+And student_city return an array,not ActiveRelation.So
    Dictionary.student_school = []
    Dictionary.student_city :locale => :en  #=> [["beijing", 2],["shanghai",1]]
+If you need a ActiveRelation, try scoped_student_city like
+   Dictionary.scoped_student_city.where(...)
 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)
@@ -121,7 +123,9 @@ The rails cache would not refresh.
 In short,when you confused with the debug data,try running "rails tmp:clear" first.
 
 = TODO & Problems
-Is there any exist low level method to monitor the change of descendents
+Remove engine. Becase for the view layer we can use gem rails_admin. so this gem did not need rails engine.
+Make Dictionary.student_city return a scope.
+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.
 Remove gems/rails_dictionary-0.0.9.4/app/views from rails view path
 

data/lib/rails_dictionary/array_core_ext.rb

@@ -1,5 +1,5 @@
 class Array
-  # returning a hash,not array
+  # Return a hash by compare two arrays
   def extract_to_hash(keys_array)
     ret_hash={}
     keys_array.each {|ky| ret_hash[ky.to_sym]=[]}

data/lib/rails_dictionary/models/active_record_extension.rb

@@ -22,17 +22,19 @@ module RailsDictionary
         belongs_to :dict_type
         after_save :delete_dicts_cache
         after_destroy :delete_dicts_cache
+        scope :dict_type_name_eq, lambda { |name| joins(:dict_type).where("dict_types.name" => name) }
 
         include RailsDictionary::ActsAsDictionary
       end
 
+      # Ex: acts_as_dict_slave :add => :category
       # :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={})
         include RailsDictionary::ActsAsDictSlave
-        class_attribute :default_dict_locale,:instance_writer => false
-        cattr_accessor :dict_mapping_columns,:instance_writes => false
+        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?

data/lib/rails_dictionary/models/acts_as_dict_slave.rb

@@ -19,9 +19,9 @@ module RailsDictionary
 
       # columns which map to dictionary
       def dict_columns(ops={})
-        conf={except: nil,add: nil}
+        conf = { except: nil, add: nil}
         conf.update(ops)
-        cidt=self.columns_in_dict_type || []
+        cidt = columns_in_dict_type || []
         cidt.delete(conf[:except])
         case conf[:add]
         when String

data/lib/rails_dictionary/models/acts_as_dict_type.rb

@@ -24,24 +24,25 @@ module RailsDictionary
         end
       end
 
-      # TODO: get a more accurate method name
       #
-      # Parse the name value to get which column and model are listed in DictType
+      # Parse the name value to get which column and model(or table) are listed in DictType
       #
       # Programmer DOC:
       #   There are two chooses to get subclass,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 "/"
+      #
+      #   Seems this method did not need to be cached in production.
+      #   Because everyclass was cached before application was run.So after application was run, it never be run again.
       # TODO:
       #   To cache this method output need more skills on how to caculate ActiveRecord::Base.descendants
       #   Temply remove the cache
       #   And add test for this situation
       def tab_and_column
-        #Rails.cache.fetch("DictType.tab_and_column") do
-          all_model_class=ActiveRecord::Base.descendants.map(&:name).map(&:underscore)
-          all_types.map(&:to_s).extract_to_hash(all_model_class)
-        #end
+        all_model_class=ActiveRecord::Base.descendants.map(&:name).map(&:underscore)
+        all_types.map(&:to_s).extract_to_hash(all_model_class)
       end
     end
 
@@ -49,7 +50,6 @@ module RailsDictionary
       def delete_all_caches
         Rails.cache.delete("DictType.all_types")
         Rails.cache.delete("DictType.cached_all")
-        #Rails.cache.delete("DictType.tab_and_column")
         return true
       end
     end

data/lib/rails_dictionary/models/acts_as_dictionary.rb

@@ -7,16 +7,9 @@ module RailsDictionary
 
     module ClassMethods
 
-      # Return an instance of array
-      # Programmer DOC:
-      #   Following design is failed with sqlite3 in test
-      #   scope :dict_type_name_eq,lambda {|method_name| joins(:dict_type).where("dict_types.name" => method_name)}
-      #   remove the all seems not pass test,return following errors
-      #   TypeError: no marshal_dump is defined for class SQLite3::Database
-      def dict_type_name_eq(method_name)
-        joins(:dict_type).where("dict_types.name" => method_name).all
-      end
-
+      # For rails3
+      # I thought it would be better to define a method in method_missing, Not just generate cache.
+      #   Cause cache can not store ActiveRecord
       # 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
@@ -24,17 +17,17 @@ module RailsDictionary
       # Programmer DOC && TODO:
       #   rethink about the cache.
       #   cache methods like Dictionary.student_city(:locale => :zh,:sort => :name_fr)
-      #   but not cache Dictionary.student_city,return it as relation
+      #   but not cache Dictionary.student_city, return it as relation
       #
       #   Remove nil noise,if listed_attr =[[nil, 201], [nil, 203], [nil, 202], ["Sciences", 200]]
       #   the sort would be failed of ArgumentError: comparison of Array with Array failed
       #   split this method ,make it more short and maintainance
       def method_missing(method_id,options={})
-        method_name=method_id.to_s.downcase
         if DictType.all_types.include? method_id
-          Rails.cache.fetch("Dictionary.#{method_name}") { dict_type_name_eq(method_name) }
-          listed_attr=Rails.cache.read("Dictionary.#{method_name}").dup
-          # Instance of activerelation can not be dup?
+          method_name=method_id.to_s.downcase
+          Rails.cache.fetch("Dictionary.#{method_name}") { dict_type_name_eq(method_name).all }
+          listed_attr=Rails.cache.read("Dictionary.#{method_name}").dup  # Instance of ActiveRecord::Relation can not be dup?
+          build_scope_method(method_id)
           if options.keys.include? :locale or options.keys.include? "locale"
             locale="name_#{ options[:locale] }"
             sort_block=sort_dicts(options)
@@ -47,7 +40,7 @@ module RailsDictionary
         end
       end
 
-      # overide this method to get customed sort block
+      # Override 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] }"
@@ -62,7 +55,18 @@ module RailsDictionary
         end
       end
 
-    end
+      private
+
+      def build_scope_method(name)
+        scope_method_name = "scoped_#{name}".to_sym
+        unless respond_to? scope_method_name
+          define_singleton_method scope_method_name do
+            dict_type_name_eq(name).scoped
+          end
+        end
+      end
+
+    end # End ClassMethods
 
     module InstanceMethods
       def delete_dicts_cache
@@ -70,6 +74,7 @@ module RailsDictionary
         Rails.cache.delete("Dictionary.#{method_name}")
         return true
       end
-    end
+    end # End InstanceMethods
+
   end
 end

data/lib/rails_dictionary/version.rb

@@ -1,3 +1,3 @@
 module RailsDictionary
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/rails_dictionary_spec.rb

@@ -48,12 +48,18 @@ describe RailsDictionary do
       Dictionary.student_city(:locale => :zh).should == [["北京", 2],["上海",1]]
     end
 
+    it "build scope method scoped_student_city" do
+      Dictionary.scoped_student_city.class.name.should == "ActiveRecord::Relation"
+      Dictionary.scoped_student_city.where(:id => 1).should == [dy_shanghai]
+    end
+
     it "after record added or removed" do
       @dy_wuhan=Dictionary.create! name_en: "wuhan",name_zh: "武汉",name_fr: "wuhan",dict_type_id: dt_stu_city.id
       Dictionary.student_city(:locale => :en).should == [["beijing", 2],["shanghai",1],["wuhan", 3]]
       @dy_wuhan.destroy
       Dictionary.student_city(:locale => :en).should == [["beijing", 2],["shanghai",1]]
     end
+
   end
 
   describe Student do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_dictionary
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-06 00:00:00.000000000Z
+date: 2011-12-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &16060860 !ruby/object:Gem::Requirement
+  requirement: &11331140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -21,10 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *16060860
+  version_requirements: *11331140
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &16060200 !ruby/object:Gem::Requirement
+  requirement: &11327380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -32,7 +32,7 @@ dependencies:
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *16060200
+  version_requirements: *11327380
 description: Rails plugin for mapping static data of web application to Dictionary
   class
 email: