ns_service_pack 0.0.15 → 0.0.16

data/README

@@ -1,6 +1,6 @@
-##===========README
+##======:==========README
   
-  Service层基础共享代码模式抽取
+  实现部分REST架构（ROA）中Service层基础共享代码抽取
 
 #==功能列表：
 
@@ -12,11 +12,13 @@
 
 * 更好用的安装使用接口，自动完成，可配置
 * rake 任务的引入， 产品模式将数据文件预编译成一个数据文件
+* 提供scaffold模式方法
+  生成一些辅助接口和方法
+  service_scaffold，生成需要的模板和基本方法
+
 * fieldmapping 和 常量管理的分离
    让使用者可以决定是否使用mapping，目前可以通过注释initializer中片段完成
 * 用模板的方法生成initializer，以便插入一些动态数据
-* 提供scaffold模式方法
-  生成一些辅助的接口和方法
 * application_controller_module的引入还是有问题！！！
 * 如何为application_controller_module中的action自动生成路由呢？
   直接生成服务端和客户端基础代码
@@ -65,18 +67,28 @@ end
 
 
 #==============History:
-#==0.0.15
-* 在mapping中支持可配置的json数据输出格式，需要：
+#==0.0.16 20111119
+* 由Gao发现load_code_hashes!时引入空.yml文件时出错，已修复
+* 修改dump_mapping文件目录从code_hashes/fields到code_hashes/mappings
+
+#==0.0.15 20111118
+* 在mapping中支持可配置的json数据(自定义属性)输出，需要：
   1. 在<mapping>.yml文件中增加一个自定义属性
-    :some_key_name: :get_key_value_method
-  2. 在model类中增加一个该键的方法，如下：
-     def get_key_value_method
+    :some_key_name: :get_key_value_method_name
+
+  2. 在model类中增加一个获取键值的方法，如下：
+     def <get_key_value_method_name>
        #give some value for the key
      end
      另一种方式：
      def self.get_map_value(key, value)
-       #ref implemented else where!
-       #add a when branch
+       #add a new when branch for the key
+       case key 
+       ...
+       when :<some_key_name>
+         #get value for the key
+       ...
+       end
      end
 
 #==0.0.14

data/lib/ns_service_pack.rb

@@ -24,4 +24,3 @@ module NsServicePack
     end
   end
 end
-

data/lib/ns_service_pack/application_controller_module.rb

@@ -1,10 +1,10 @@
 #coding: utf-8
 module ApplicationControllerModule
   def index
-    result = paginate(params) do |start, page_size|
+    @result = paginate(params) do |start, page_size|
       get_page_data(start, page_size, params)
     end
-    render :json=>ResultPacker.data(result.as_json)
+    render :json=>ResultPacker.data(@result.as_json)
   end
 
   #return [total_count, page_data]
@@ -51,27 +51,27 @@ module ApplicationControllerModule
   
   #查找单条记录
   def show
-    result = model_class.find(params[:id])
-    render :json=>ResultPacker.data(result.as_json)
+    @_obj = model_class.find(params[:id])
+    render :json=>ResultPacker.data(@_obj.as_json)
   end
   
   #创建记录
   def create
-    c = model_class.new_from_buz(params[:data]) 
-    if c.save
-      render :json=>ResultPacker.data(c)
+    @_obj = model_class.new_from_buz(params[:data]) 
+    if @_obj.save
+      render :json=>ResultPacker.data(@_obj)
     else
-      render :json=>ResultPacker.help(valid_errors(model_class.buz_hashize(c.errors.to_hash)))
+      render :json=>ResultPacker.help(valid_errors(model_class.buz_hashize(@_obj.errors.to_hash)))
     end
   end
   
   #更新记录
   def update
-    c = model_class.find(params[:id])
-    if c.update_from_buz(params[:data])
-      render :json=>ResultPacker.data(c)
+    @_obj = model_class.find(params[:id])
+    if @_obj.update_from_buz(params[:data])
+      render :json=>ResultPacker.data(@_obj)
     else
-      render :json=>ResultPacker.help(valid_errors(model_class.buz_hashize(c.errors.to_hash)))
+      render :json=>ResultPacker.help(valid_errors(model_class.buz_hashize(@_obj.errors.to_hash)))
     end
   end
  
@@ -82,8 +82,8 @@ module ApplicationControllerModule
 
   #ABORTED NOW, keep here
   def query_fields
-    data = model_class.buz_hashize
-    render :json=>ResultPacker.data(:fields=>data)
+    @_data = model_class.buz_hashize
+    render :json=>ResultPacker.data(:fields=>@_data)
   end
 
   #动态查看该模块发布接口列表

data/lib/ns_service_pack/field_mapping.rb

@@ -8,7 +8,10 @@ module FieldMapping
     base.extend(ClassMethods)
   end
 
+  #在将model转成json数据时会自动调用该方法
   def as_json(options={})
+    #获取数据库属性数据
+    #TODO 想到的一个改进点：数据库查的时候根据mapping来选字段，而非全查出来，影响效率，影响较大，先不改！
     default_attrs = self.class.buz_hashize(self.attributes)
     #支持自定义方法的传入 20111118 for gao
     add_virtual_buz_attributes!(default_attrs) 
@@ -17,13 +20,14 @@ module FieldMapping
   #TODO check  add some notes
   def add_virtual_buz_attributes!(db_buz_attrs = {})
     the_mapping = self.class.mapping
+    #获取非数据库属性，称为业务虚拟属性
     delta_attrs = the_mapping.keys - db_buz_attrs.keys
     delta_attrs.each do |key|
       method_name = the_mapping[key]
       db_buz_attrs[key] = if self.respond_to?(method_name)
         self.send(method_name)
       else
-        self.class.get_map_value(key, nil)
+        self.class.get_map_value(key, nil)#给出默认实现
       end
     end
     db_buz_attrs
@@ -34,12 +38,12 @@ module FieldMapping
   end
   
   module ClassMethods
-    #Fix a bug on 20111117 by shang
+    #Fix a bug on 20111117 by shang, this override the original method name
     def __model_clazz_name
       self.name.underscore
     end
     def model_key
-      "#{__model_clazz_name}_fields"
+      "#{__model_clazz_name}_mapping"
     end
 
     def mapping
@@ -48,8 +52,7 @@ module FieldMapping
 
     def get_map_value(k, value)
       #raise "Not implemented!"
-      #提供默认处理
-      #TODO 根据数据类型做些更好的转换
+      #提供默认处理 #TODO 根据数据类型做些更好的转换
       case k
       when :created_at, :updated_at
         value.try(:to_s, :db)
@@ -86,7 +89,7 @@ module FieldMapping
     #生成field mapping，dump到指定的yaml文件中
     def dump_mapping(attr_prefix = nil, force = true)
       if defined?(Rails)
-        file = "#{Rails.root}/#{GlobalConst::APP_CODE_HASHES}fields/#{model_key}_#{Time.now.to_i}.yml"
+        file = "#{Rails.root}/#{GlobalConst::APP_CODE_HASHES}mappings/#{model_key}_#{Time.now.to_i}.yml"
         path = File.dirname(file)
         FileUtils.mkpath(path) unless File.directory?(path)
         existed = File.exists?(file)

data/lib/ns_service_pack/global_const.rb

@@ -23,6 +23,11 @@ module GlobalConst
       h = hash_or_file
     else
       h = YAML.load(File.open(hash_or_file))
+      unless h.is_a?(Hash)
+        #格式异常检查，过滤掉空和无效文件
+        puts "==>Warning: Invalid arguments: #{hash_or_file}, it does not evalute to a Hash!你自己去看看，别找我！"
+        return
+      end
     end
     nh = h.symbolize_keys
     nh.keys.each do |k|
@@ -39,7 +44,6 @@ module GlobalConst
       if File.directory?(target)
         hfiles = Dir.glob("#{target}**/*.yml")
         hfiles.each do |f|
-          puts "==>loading: #{f} ..."
           load_code_hashes!(f)
         end
       end

data/lib/ns_service_pack/result_packer.rb

@@ -19,7 +19,7 @@ class ResultPacker
   end
   
   #前台验证错误
-  def self.help(hint_hash={}, msg='数据逻辑有误，请查看错误提示！')
+  def self.help(hint_hash={}, msg='数据逻辑有误，请查看错误明细！')
     {:status=>'illegal',:msg=>msg, :errors=>hint_hash}
   end
   

data/lib/ns_service_pack/version.rb

@@ -1,4 +1,4 @@
 #coding: utf-8
 module NsServicePack 
-  VERSION = '0.0.15'
+  VERSION = '0.0.16'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ns_service_pack
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-18 00:00:00.000000000Z
+date: 2011-11-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &78102970 !ruby/object:Gem::Requirement
+  requirement: &69782970 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,7 +23,7 @@ dependencies:
         version: 3.1.0
   type: :development
   prerelease: false
-  version_requirements: *78102970
+  version_requirements: *69782970
 description: Service package for our service lier
 email: cao7113@gmail.com
 executables: []