rails_dictionary 0.0.2 → 0.0.3

data/README.rdoc

@@ -5,7 +5,7 @@ In a student application,there will be some static data like diploma kind,school
 = Usage
 == Installation
 Rail3
-        gem "dictionary",:git => 'git://github.com/raykin/dictionary'
+        gem "rails_dictionary",:git => 'git://github.com/raykin/rails_dictionary'
 or
         gem 'rails_dictionary'
 
@@ -72,17 +72,19 @@ Student is a slave model which will be automatically generate a (or a list of)be
    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 => nil
+   Dictionary.student_school => []
    Dictionary.student_city(:locale => :en) => [["shanghai",1],["beijing",2]]
 so you can use these method in form select like
-   select :student,:city,Dictionary.student_city
-this select method has a more clear format which may do some other magic coding
+   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"
+Here is an other solution for international translation.
    Student.find(1).named_city(:zh) = "北京"
    Student.find(1).named_city(:fr) = "Pékin"
-Here is an other solution for international translation.
+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)
-In these simple example,Student has 2 belongs_to assocition which named as city_dict and school_dict,the naming convention is columname_dict.
+
 
 = 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.
@@ -92,7 +94,7 @@ 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 these method,try running
      rails tmp:clear
-cause these methods all return static data,I just add caches to these output for better performance.If you straight forward change db data in db console(not throught Rails) like running
+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;
 The rails cache would not refresh.
 In short,when you confused with the debug data,try running "rails tmp:clear" first.

data/Rakefile

@@ -3,6 +3,6 @@ Bundler::GemHelper.install_tasks
 
 desc "Running Test"
 task :test do
-  system "ruby -I . test/dictionary_test.rb "
+  system "ruby -I . test/rails_dictionary_test.rb "
 end
 

data/lib/{dictionary → rails_dictionary}/acts_as_dict_slave.rb

@@ -43,6 +43,7 @@ module ActsAsDictSlave
   end
 
   module DynamicInsMethods
+    # generate dynamic instance method named_column to slave model
     def named_dict_value(method_name)
       belongs_to_name="#{method_name.to_s}_dict".to_sym
       method_name="named_#{method_name.to_s}"

data/lib/{dictionary → rails_dictionary}/acts_as_dict_type.rb

@@ -1,4 +1,3 @@
-require "rails"
 module ActsAsDictType
   def self.included(base)
     base.extend(ClassMethods)
@@ -21,19 +20,21 @@ module ActsAsDictType
           Rails.cache.fetch("DictType.cached_all") { all }.dup
         end
 
+        # short method to transfer id to name or name to id
         def self.revert(arg)
-          if arg.class == String
-            DictType.find_by_name(arg).id
-          elsif arg.class == Fixnum
-            DictType.find_by_id(arg).name
+          if arg.is_a?(String)
+            DictType.where(name: arg).try(:first).id
+          elsif arg.is_a?(Fixnum)
+            DictType.where(id: arg).try(:first).name
           end
         end
 
-        #TODO: get a more accurate method name
+        # 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 ?
+          # 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)

data/lib/{dictionary → rails_dictionary}/acts_as_dictionary.rb

@@ -17,7 +17,7 @@ module ActsAsDictionary
           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
+            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

data/lib/rails_dictionary/version.rb

@@ -0,0 +1,3 @@
+module RailsDictionary
+  VERSION = "0.0.3"
+end

data/lib/rails_dictionary.rb

@@ -1,4 +1,4 @@
-require "dictionary/acts_as_dictionary"
-require "dictionary/acts_as_dict_slave"
-require "dictionary/acts_as_dict_type"
-require "dictionary/array_core_ext"
+require "rails_dictionary/acts_as_dictionary"
+require "rails_dictionary/acts_as_dict_slave"
+require "rails_dictionary/acts_as_dict_type"
+require "rails_dictionary/array_core_ext"

data/{dictionary.gemspec → rails_dictionary.gemspec}

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "dictionary/version"
+require "rails_dictionary/version"
 
 Gem::Specification.new do |s|
   s.name        = "rails_dictionary"
-  s.version     = Dictionary::VERSION
+  s.version     = RailsDictionary::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["raykin"]
   s.email       = ["raykincoldxiao@campus.com"]
-  s.homepage    = "https://github.com/raykin/dictionary"
+  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}
 

data/test/{dictionary_test.rb → rails_dictionary_test.rb}

@@ -1,5 +1,4 @@
 # -*- coding: utf-8 -*-
-# min test
 require "test/unit"
 require "active_support"
 require "active_record"
@@ -7,7 +6,7 @@ require "ruby-debug"
 Object.const_set "RAILS_CACHE", ActiveSupport::Cache.lookup_store
 require "active_support/cache"
 require "rails"
-# $: << "/home/raykin/studio/dictionary/lib" # tmply added for local testing
+# $: << "/home/raykin/studio/rails_dictionary/lib" # tmply added for local testing
 require "#{File.dirname(__FILE__)}/../lib/rails_dictionary.rb"
 
 ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")

metadata

@@ -2,7 +2,7 @@
 name: rails_dictionary
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - raykin
@@ -24,20 +24,19 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- .gitignore
 - Gemfile
 - README.rdoc
 - Rakefile
-- dictionary.gemspec
-- lib/dictionary/acts_as_dict_slave.rb
-- lib/dictionary/acts_as_dict_type.rb
-- lib/dictionary/acts_as_dictionary.rb
-- lib/dictionary/array_core_ext.rb
-- lib/dictionary/version.rb
 - lib/rails_dictionary.rb
-- test/dictionary_test.rb
+- lib/rails_dictionary/acts_as_dict_slave.rb
+- lib/rails_dictionary/acts_as_dict_type.rb
+- lib/rails_dictionary/acts_as_dictionary.rb
+- lib/rails_dictionary/array_core_ext.rb
+- lib/rails_dictionary/version.rb
+- rails_dictionary.gemspec
+- test/rails_dictionary_test.rb
 has_rdoc: true
-homepage: https://github.com/raykin/dictionary
+homepage: https://github.com/raykin/rails_dictionary
 licenses: []
 
 post_install_message: 
@@ -65,4 +64,4 @@ signing_key:
 specification_version: 3
 summary: dictionary data for application
 test_files: 
-- test/dictionary_test.rb
+- test/rails_dictionary_test.rb

data/.gitignore

@@ -1,4 +0,0 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*

data/lib/dictionary/version.rb

@@ -1,3 +0,0 @@
-module Dictionary
-  VERSION = "0.0.2"
-end