ns_service_pack 0.0.1

data/config/code_hashes.yml.sample

@@ -0,0 +1,20 @@
+#coding: utf-8
+
+#CodeHash数据格式规则：
+#访问方法名(应是合法方法名)
+#  键: 值
+#
+#数据被输送到GlobalConst命名空间下，通过如下方式访问：
+#GlobalConst.genders['男']            =>0
+#GlobalConst.genders[0]               =>'男'
+#GlobalConst.genders[key_or_value_var]    =>value_or_key
+
+genders:
+  男: 0
+  女: 1
+  保密: 2
+  
+booleans:
+  是: true
+  否: false
+

data/config/initializers/ns_service_pack.rb

@@ -0,0 +1,5 @@
+#coding: utf-8
+
+#导入项目中使用的CodeHashes
+GlobalConst.load_app_code_hashes!
+

data/lib/ns_service_pack/application_controller_module.rb

@@ -0,0 +1,80 @@
+#coding: utf-8
+module ApplicationControllerModule
+  def index
+    @conds ||= {}
+    #TODO 添加默认搜索行为
+    result = paginate(model_class, @conds, params)
+    render :json=>ResultPacker.data(result.as_json)
+  end
+
+  #分页方法
+  def paginate(base_class=nil, conds={}, params={})
+    #TODO 
+    raise "参数无效！" unless base_class.superclass == ActiveRecord::Base
+    page_num = params[:current_page].to_i
+    page_num = page_num < 1 ? 1 : page_num
+    page_size = params[:page_size].to_i
+    page_size = page_size <= 0 ? 10 : page_size
+    page_size = page_size > 250 ? 250 : page_size
+    offset = (page_num-1)*page_size
+    
+    total_count = base_class.count(conds)
+    conds.merge!(:limit=>page_size,
+                 :offset=>offset,
+                 :order=>params[:order])
+
+    new_conds = conds #yield conds
+    #添加select子句 TODO
+    page_data = base_class.all(new_conds)
+    {
+     :total_size=>total_count,
+     :page_size=>page_size,
+     :current_page=>page_num,
+     :page_from=>offset + 1,
+     :page_to=>offset + page_data.size,
+     :page_items=>page_data
+    }
+  end
+  #查找单条记录
+  def show
+    result = model_class.find(params[:id])
+    render :json=>ResultPacker.data(result.as_json)
+  end
+  
+  #创建记录
+  def create
+    c = model_class.new_from_buz(params[:data]) 
+    if c.save
+      render :json=>ResultPacker.data(c)
+    else
+      render :json=>ResultPacker.help(valid_errors(model_class.buz_hashize(c.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)
+    else
+      render :json=>ResultPacker.help(valid_errors(model_class.buz_hashize(c.errors.to_hash)))
+    end
+  end
+ 
+  #验证错误回传
+  def valid_errors(error_hash={})
+    (error_hash||{}).each{|k, v| error_hash[k] = v.join(', ') if v.is_a? Array }
+  end
+
+  #ABORTED NOW
+  def query_fields
+    data = model_class.field_maps.keys.inject({}){|result, k| result[k]=nil; result}
+    #model_class.new.attributes #初始值问题 TODO 
+    render :json=>ResultPacker.data(:fields=>data)
+  end
+
+  #动态查看该模块发布接口列表
+  def interfaces
+    @routes = Rails.application.routes.routes
+  end
+end

data/lib/ns_service_pack/code_hash.rb

@@ -0,0 +1,47 @@
+#coding: utf-8
+=begin
+用一致化方法根据key查值或反查，使用hash方法([])，如
+  code_hash = CodeHash.new({'普通会员'=>0, '高级会员'=>10})
+  code_hash['普通会员']  #=>0
+  dode_hash[0]           #=>'普通会员'
+
+相关概念：
+  key：  人可识别的编码，如‘普通会员’
+  value: 存入数据库的编码，一般为增加数据检索速度
+
+规则： 
+  * 键/值具有唯一性(符合大部分使用情况)
+  * 字符串键统一用字符串访问，而非符号，如code_hash['a'], not code_hash[:a] (因为很多键为汉字)
+=end
+class CodeHash
+  attr_accessor :data, :invert_data
+
+  def initialize(code_hash={})
+    @data = code_hash
+    @invert_data = code_hash.invert
+  end
+
+  def [](code)
+    #Fix a bug on 20111115
+    #@data[code] || @invert_data[code]||"真的没找到呀！[code=#{code.to_s}]"
+    if @data.key?(code)
+      @data[code]
+    elsif @invert_data.key?(code)
+      @invert_data[code]
+    else
+      "注意：没找到对应键[#{code.to_s}]的值！"
+    end
+  end
+
+  def all
+    @data.merge(@invert_data)
+  end
+
+  def keys
+    @data.keys
+  end
+
+  def values
+    @data.values
+  end
+end

data/lib/ns_service_pack/code_hash.rb~

@@ -0,0 +1,37 @@
+#coding: utf-8
+=begin
+用一致化方法根据key查值或反查，使用hash方法([])，如
+  code_hash = CodeHash.new({'普通会员'=>0, '高级会员'=>10})
+  code_hash['普通会员']  #=>0
+  dode_hash[0]          #=>'普通会员'
+相关概念：
+  key：  人可识别的编码，如‘普通会员’
+  value: 存入数据库的编码，一般为增加数据检索速度
+
+规则： 
+  * 键/值具有唯一性(符合大部分使用情况)
+=end
+class CodeHash
+  attr_accessor :data, :invert_data
+
+  def initialize(code_hash={})
+    @data = code_hash
+    @invert_data = code_hash.invert
+  end
+
+  def [](code)
+    @data[code] || @invert_data[code]||"真的没找到呀！[code=#{code.to_s}]"
+  end
+
+  def all
+    @data.merge(@invert_data)
+  end
+
+  def keys
+    @data.keys
+  end
+
+  def values
+    @data.values
+  end
+end

data/lib/ns_service_pack/field_mapping.rb

@@ -0,0 +1,70 @@
+#coding: utf-8
+=begin
+  字段映射，业务字段-数据库字段对应
+=end
+module FieldMapping
+  def self.included(base)
+    #TODO 条件检查
+    base.extend(ClassMethods)
+  end
+
+  def as_json(options={})
+    self.class.buz_hashize(self.attributes)
+  end
+
+  def update_from_buz(params={})
+    update_attributes(self.class.db_hashize(params))
+  end
+  
+  module ClassMethods
+    def new_from_buz(params={})
+      new(db_hashize(params))
+    end
+    
+    def create_from_buz(params={})
+      create(db_hashize(params))
+    end
+    
+    #TODO 在包装类提供此方法，可在include前检查
+    def field_maps
+      raise "Not implemented!"
+    end
+
+    def inspect_fields
+      puts "#buz fields\t\t#db fields\t\t #the rules"
+      field_maps.each do |k, v|
+        puts "#{k}\t\t #{v}           "
+      end
+    end
+
+    def get_map_value(k, value)
+      #raise "Not implemented!"
+      value
+    end
+   
+    #业务层到数据层字段的转换
+    def db_hashize(params={})
+      new_params = params.symbolize_keys
+      common_keys = new_params.keys & field_maps.keys
+      common_keys.inject({}) do |r, e|
+        r[field_maps[e]] = get_map_value(e, new_params[e])
+        r
+      end
+    end
+ 
+    #转成业务层key表示
+    def buz_hashize(attrs={})
+      #return {} if attrs.blank?
+      #获取默认初始值
+      attrs = new.attributes if attrs.blank?
+      new_attrs = attrs.symbolize_keys
+      invert_maps = field_maps.invert
+      common_db_attrs = new_attrs.keys & invert_maps.keys
+      common_db_attrs.inject({}) do |r, da| 
+        ba = invert_maps[da]
+        r[ba]=get_map_value(ba, new_attrs[da])
+        r
+      end
+    end
+  end
+end

data/lib/ns_service_pack/global_const.rb

@@ -0,0 +1,62 @@
+#coding: utf-8
+=begin
+* 20111115 find bug
+  避免每次重新生成CodeHash的对象
+* TODO 在项目中要分自己用的还是提供给外边的
+=end
+require 'fileutils'
+module GlobalConst 
+  SAMPLE_FILE = "#{NS_GEM_ROOT}/config/code_hashes.yml.sample"
+  APP_CODE_HASHES = "config/code_hashes/" 
+
+  mattr_accessor :global_data
+  @@global_data = {}
+  
+  def self.method_missing(method_name, *args, &block)
+    ms = method_name.to_sym
+    return @@global_data[ms] if @@global_data.key?(ms)
+    raise "Method name: #{method_name}(#{args.inspect}) is not defined!"
+  end
+  
+  def self.load_code_hashes!(hash_or_file = SAMPLE_FILE)
+    if hash_or_file.is_a?(Hash)
+      h = hash_or_file
+    else
+      h = YAML.load(File.open(hash_or_file))
+    end
+    nh = h.symbolize_keys
+    nh.keys.each do |k|
+      if @@global_data.key?(k)
+        puts "==>Warning: new value(#{nh[k]}) is set for key:#{k}!"
+      end
+      @@global_data[k] = CodeHash.new(nh[k])
+    end
+  end
+
+  def self.load_app_code_hashes!(dir = APP_CODE_HASHES)
+    if defined? Rails
+      target = "#{Rails.root}/#{APP_CODE_HASHES}"
+      if File.directory?(target)
+        hfiles = Dir.glob("#{target}**/*.yml")
+        hfiles.each do |f|
+          puts "==>loading: #{f} ..."
+          load_code_hashes!(f)
+        end
+      end
+    end
+  end
+  
+  #为引用项目生成样例文件， TODO rake方式生成
+  def self.setup_code_hashes(yml_file = "#{APP_CODE_HASHES}/code_hashes.yml.sample")
+    if defined? Rails
+      target = "#{Rails.root}/#{yml_file}"
+      unless File.exists?(target)
+        path = File.dirname(target)
+        FileUtils.mkpath(path)
+        #默认覆盖已有
+        FileUtils.cp("#{NS_GEM_ROOT}/config/code_hashes.yml.sample", target)
+      end
+    end
+  end
+end
+

data/lib/ns_service_pack/result_packer.rb

@@ -0,0 +1,25 @@
+#coding: utf-8
+=begin
+  Service模块提供的json数据格式封装
+=end
+class ResultPacker
+  #自定义打包
+  def self.pack(response_hash={})
+    {:status=>'ok',:msg=>''}.merge!(response_hash)
+  end
+  
+  #封装数据
+  def self.data(data_hash={}, msg='通信正常！')
+    {:status=>'ok',:msg=>msg, :data=>data_hash}
+  end
+ 
+  #前台验证错误
+  def self.help(hint_hash={}, msg='数据逻辑有误，请查看错误提示！')
+    {:status=>'illegal',:msg=>msg, :errors=>hint_hash}
+  end
+  
+  #异常错误
+  def self.error(msg='通信异常，请查看出错信息！', error_hash={})
+    {:status=>'error',:msg=>msg, :errors=>error_hash}
+  end
+end

data/lib/ns_service_pack/version.rb

@@ -0,0 +1,3 @@
+module NsServicePack 
+  VERSION = '0.0.1'
+end

data/lib/ns_service_pack.rb

@@ -0,0 +1,38 @@
+#coding: utf-8
+NS_GEM_ROOT = File.expand_path('../..', __FILE__)
+#debug this gem
+#$LOAD_PATH.unshift("#{NS_GEM_ROOT}/lib")
+
+require 'fileutils'
+require 'ns_service_pack/code_hash'
+require 'ns_service_pack/global_const'
+require 'ns_service_pack/field_mapping'
+require 'ns_service_pack/result_packer'
+require 'ns_service_pack/application_controller_module'
+
+if defined?(Rails)
+  #TODO 为什么不能像ActiveRecord::Base一样include，到底什么道理呢？？？
+  class ApplicationController < ActionController::Base
+    include ApplicationControllerModule
+  end
+  if defined?(ActiveRecord::Base)
+    ActiveRecord::Base.send(:include, FieldMapping)
+  end
+end
+
+module NsServicePack
+  def self.install 
+    #添加一个初始化文件
+    init_file = "#{Rails.root}/config/initializers/ns_service_pack.rb"
+    unless File.exists?(init_file)
+      FileUtils.cp("#{NS_GEM_ROOT}/config/initializers/ns_service_pack.rb", init_file)
+      puts "==>I have installed a intializer file: #{init_file}"
+      GlobalConst.setup_code_hashes
+      puts "==>Now you can config your constants in folder: #{GlobalConst::APP_CODE_HASHES}"
+    else
+      puts "==>It seems you have installed ns service pack, happy with it or bug report to caory!"
+    end
+  end
+end
+
+puts "==>NsServicePack has installed into application, ^^caory"

data/lib/ns_service_pack.rb~

@@ -0,0 +1,26 @@
+##TODO 
+#$LOAD_PATH.unshift("#{Dir.pwd}/lib/ns_service_pack/lib")
+
+require 'ns_service_pack/code_hash.rb'
+require 'ns_service_pack/result_packer.rb'
+require 'ns_service_pack/field_mapping.rb'
+require 'ns_service_pack/application_controller_module.rb'
+
+#TODO WHY FIXME
+#if defined?(ActionController::Base)
+  #ActionController::Base.include(ApplicationControllerModule)
+#  ActionController::Base.send(:include, ApplicationControllerModule)
+#end
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.send(:include, FieldMapping)
+end
+
+GlobalConstants = {
+  :genders => CodeHash.new('男'=>0, '女'=>1, '保密'=>2),
+  :trues => CodeHash.new('是'=>true, '否'=>false) 
+}
+
+#Genders = CodeHash.new('男'=>0, '女'=>1, '保密'=>2) 
+#Trues = CodeHash.new('是'=>true, '否'=>false) 
+
+puts "============ns service pack has installed in your application..."

data/ns_service_pack.gemspec

@@ -0,0 +1,24 @@
+require './lib/ns_service_pack/version'
+
+Gem::Specification.new do |s|
+  s.name = %q{ns_service_pack}
+  s.version = NsServicePack::VERSION
+
+  s.authors = %w(Caory Shang Gorgeous)
+  s.date = Time.now.utc.strftime("%Y-%m-%d")
+  s.description = %q{Service package for our service lier}
+  s.email = %q{cao7113@gmail.com}
+  s.files = Dir.glob("lib/**/*") + Dir.glob("config/**/*") + [
+     "Gemfile",
+     "ns_service_pack.gemspec",
+     "Rakefile",
+     "README"
+  ]
+  s.homepage = %q{http://weibo.com/cao7113}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.summary = %q{common package for our service pack}
+  #s.test_files = Dir.glob("test/**/*")
+  #s.add_development_dependency(%q<shoulda>, [">= 0"])
+  s.add_development_dependency(%q<rails>, [">= 3.1.0"])
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: ns_service_pack
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Caory
+- Shang
+- Gorgeous
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-15 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &76036470 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *76036470
+description: Service package for our service lier
+email: cao7113@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ns_service_pack.rb
+- lib/ns_service_pack/global_const.rb
+- lib/ns_service_pack/version.rb
+- lib/ns_service_pack/application_controller_module.rb
+- lib/ns_service_pack/code_hash.rb~
+- lib/ns_service_pack/code_hash.rb
+- lib/ns_service_pack/field_mapping.rb
+- lib/ns_service_pack/result_packer.rb
+- lib/ns_service_pack.rb~
+- config/code_hashes.yml.sample
+- config/initializers/ns_service_pack.rb
+- Gemfile
+- ns_service_pack.gemspec
+- Rakefile
+- README
+homepage: http://weibo.com/cao7113
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: common package for our service pack
+test_files: []