rails_dictionary 0.0.7 → 0.0.8

data/.gitignore

@@ -0,0 +1 @@
+pkg/

data/README.rdoc

@@ -1,44 +1,58 @@
 = Intro
 There are many static data in application.
-In a student application,there will be some static data like diploma kind,school and city.This gem can map these static data to a Dictionary#method like Dictionary#student_diploma_kind which return data list of diploma kind and a Student.named_school like @student.named_city which return city name of @student city
+For example in a student application,there may be some static data like diploma kind,school and city of school.This gem can map these static data to a Dictionary#method like Dictionary#student_diploma_kind which return data list of diploma kind and generate a list of instance method on Student like @student.named_city which return city name of @student city
 
 = Usage
 == Installation
 Rail3
-        gem "rails_dictionary",:git => 'git://github.com/raykin/rails_dictionary'
-or
         gem 'rails_dictionary'
+or
+        gem "rails_dictionary",:git => 'git://github.com/raykin/rails_dictionary'
 
 == Sample
-In this usage sample,there are three tables.
+Run following task will give you a simple start.Maybe you should try it in a new application first.
+    rake dicts:generate
+    rake dicts:sample_slave
+    rake db:migrate
+    rake dicts:sample_data
+These task are just generate table dictionaries,dict_types,students and some sample data.The data should be
+      irb(main):013:0> DictType.select("id,name").all
+        DictType Load (0.4ms)  SELECT id,name FROM `dict_types`
+        +----+----------------+
+        | id | name           |
+        +----+----------------+
+        | 1  | student_city   |
+        | 2  | student_school |
+        +----+----------------+
+        2 rows in set
+       irb(main):014:0> Dictionary.select("id,name_en,name_zh,name_fr,dict_type_id").all
+         Dictionary Load (1.2ms)  SELECT id,name_en,name_zh,name_fr,dict_type_id FROM `dictionaries`
+         +----+----------+---------+----------+--------------+
+         | id | name_en  | name_zh | name_fr  | dict_type_id |
+         +----+----------+---------+----------+--------------+
+         | 1  | shanghai | 上海      | shanghai | 1            |
+         | 2  | beijing  | 北京      | Pékin    | 1            |
+         +----+----------+---------+----------+--------------+
+         2 rows in set
+       irb(main):016:0> Student.select("id,email,city,school").all
+         Student Load (0.4ms)  SELECT id,email,city,school FROM `students`
+         +----+-------------------+------+--------+
+         | id | email             | city | school |
+         +----+-------------------+------+--------+
+         | 1  | beijing@dict.com  | 4    |        |
+         | 2  | shanghai@dict.com | 3    |        |
+         +----+-------------------+------+--------+
+         2 rows in set
+There is one conventions of DictType.name value.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.
-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
-      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
+Table dictionaries has one convention of naming column : 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 and variable by your application.
 
 === Class Definition
-Method acts_as_dict_type,acts_as_dictionary,acts_as_dict_slave like other simple gem method used as class method.
 Here is what should be like.Student model can be other models.
+
       class DictType < ActiveRecord::Base
         acts_as_dict_type
       end
@@ -51,42 +65,23 @@ Here is what should be like.Student model can be other models.
         acts_as_dict_slave
       end
 
-=== Sample Data
-Conventions over configuration make magic again.
-The name value convention of DictType is "model_column".Here the city and school column of student model are static values that will be mapping to dynamic method,so the DictType value should be as following code according convention.
-Dictionary value has simple convention,just keep the name structure as "name_locale".Dictionary store the real static data that will not change in certain period.
-Student is a slave model which will be automatically generate a (or a list of)belongs_to associations to dictionary and a list of dynamic query method according to DictType data.
-    DictType.find(1).name => "student_city"
-    DictType.find(2).name => "student_school"
-    DictType.count => 2
-    Dictionary.count => 2
-    Dictionary.find(5) =>
-    #<Dictionary id: 1, name_en: "shanghai", name_zh: "上海", name_fr: "shanghai", dict_type_id: 1, created_at: "2011-02-27 13:28:55", updated_at: "2011-02-27 13:28:55">
-    Dictionary.find(6) =>
-    #<Dictionary id: 2, name_en: "beijing", name_zh: "北京", name_fr: "Pékin", dict_type_id: 1, created_at: "2011-02-27 13:28:55", updated_at: "2011-02-27 13:28:55">
-    Student.find(1) =>
-    #<Student id: 1, email: "beijing@dict.com", city: 6, school: nil, created_at: "2011-02-27 13:28:55", updated_at: "2011-02-27 13:28:55">
-    Student.find(2) =>
-    #<Student id: 2, email: "shanghai@dict.com", city: 5, school: nil, created_at: "2011-02-27 13:28:55", updated_at: "2011-02-27 13:28:55">
-
-== Methods and results (relies on the above data)
-   DictType.all_cached => return cache of DictType.all
-   DictType.all_types => %w[student_city student_school]
-   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.Actually Dictionary will has as many dynamic methods as DictType.count and the dynamic method name is DictType.name,so there is another dynamic method which return nil
-   Dictionary.student_school => []
-   Dictionary.student_city(:locale => :en) => [["shanghai",1],["beijing",2]]
-so you can use these method in form select like
+== Features : Methods and results (relies on the above data)
+   DictType.all_cached #=> return cache of DictType.all
+   DictType.all_types = %w[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".Actually Dictionary will have as many dynamic methods as DictType.count and each dynamic method name is DictType.name(This methods returning an array,not ActiveRelation).
+   Dictionary.student_school = []
+   Dictionary.student_city :locale => :en = [["shanghai",1],["beijing",2]]
+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)
-if params contains :locale => :fr,then it would return a list of french name of student city (from name_fr in Dictioanry)
-   Student.find(1).named_city = "beijing"
+If params contains :locale => :fr,it returns a list of french name of student city (from name_fr in Dictioanry)
+   Student.find(1).named_city = "beijing" # when default locale is :en
 Here is an other solution for international translation.
    Student.find(1).named_city(:zh) = "北京"
    Student.find(1).named_city(:fr) = "Pékin"
-Student has 2 belongs_to assocition which named as city_dict and school_dict,the naming convention is columname_dict.
-   Student.find(1).city_dict = Dictionary.find(6)
-
+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)
 
 = 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.
@@ -96,14 +91,11 @@ However,if you see many static data in an old system and want to refactor it,the
 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 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
+cause these methods all return static data(may be a mass of 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;
 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 method.
-Add generators. Rewrite Testing,make it more maintainable.
-
-= Help
-Need an friendly english native guy to help me improve this readme to make it more clear and readable.
+Rewrite Testing,make it more maintainable.

data/lib/rails_dictionary/acts_as_dict_type.rb

@@ -30,7 +30,7 @@ module ActsAsDictType
         end
 
         # TODO: get a more accurate method name
-        # parse the name to get which column and model are listed in DictType
+        # Parse the name value to get which column and model are listed in DictType
         def self.tab_and_column
           tab_and_column={}
           # There are two chooses,one is subclasses the other is descendants,

data/lib/rails_dictionary/version.rb

@@ -1,3 +1,3 @@
 module RailsDictionary
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/tasks/dicts.rake

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+namespace :dicts do
+  desc "Generate dictionary and dict_type model"
+  task :generate do
+    system "rails g model dictionary name_en:string name_zh:string name_fr:string dict_type_id:integer"
+    system "rails g model dict_type name:string"
+  end
+  desc "Generate student model"
+  task :sample_slave do
+    system "rails g model student email:string city:integer school:integer"
+  end
+  desc "Generate sample data for rails_dictionary gem"
+  task :sample_data => [:environment] do
+    @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
+end

data/rails_dictionary.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors     = ["raykin"]
   s.email       = ["raykincoldxiao@campus.com"]
   s.homepage    = "https://github.com/raykin/rails_dictionary"
-  s.summary     = %q{dictionary data for application}
-  s.description = %q{mapping static data of web application to Dictionary class}
+  s.summary     = %q{dictionary data for web application}
+  s.description = %q{Rails plugin for mapping static data of web application to Dictionary class}
 
   s.rubyforge_project = "rails_dictionary"
 

data/test/rails_dictionary_test.rb

@@ -18,7 +18,6 @@ def setup_db
   ActiveRecord::Schema.define(:version => 1) do
     create_table :dict_types do |t|
       t.string :name
-      t.string :comment
       t.timestamps
     end
     create_table :dictionaries do |t|

metadata

@@ -2,7 +2,7 @@
 name: rails_dictionary
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors: 
 - raykin
@@ -10,11 +10,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-07 00:00:00 +08:00
+date: 2011-03-21 00:00:00 +08:00
 default_executable: 
 dependencies: []
 
-description: mapping static data of web application to Dictionary class
+description: Rails plugin for mapping static data of web application to Dictionary class
 email: 
 - raykincoldxiao@campus.com
 executables: []
@@ -24,6 +24,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
 - Gemfile
 - README.rdoc
 - Rakefile
@@ -33,6 +34,7 @@ files:
 - lib/rails_dictionary/acts_as_dictionary.rb
 - lib/rails_dictionary/array_core_ext.rb
 - lib/rails_dictionary/version.rb
+- lib/tasks/dicts.rake
 - rails_dictionary.gemspec
 - test/rails_dictionary_test.rb
 has_rdoc: true
@@ -59,9 +61,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rails_dictionary
-rubygems_version: 1.6.1
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: dictionary data for application
+summary: dictionary data for web application
 test_files: 
 - test/rails_dictionary_test.rb