ns_service_pack 0.0.19 → 0.0.21

data/lib/ns_service_pack/field_mapping.rb

@@ -1,148 +1,154 @@
 #coding: utf-8
 =begin
   字段映射，业务字段-数据库字段对应
+
+  TODO: 不需做字段转换的处理
 =end
 require 'fileutils'
-module FieldMapping
-  def self.included(base)
-    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) 
-  end
-
-  #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)#给出默认实现
-      end
+module Ns
+  module FieldMapping
+    def self.included(base)
+      base.extend(ClassMethods)
     end
-    db_buz_attrs
-  end
 
-  def update_from_buz(params={})
-    update_attributes(self.class.db_hashize(params))
-  end
-  
-  module ClassMethods
-    #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}_mapping"
+    #在将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) 
     end
 
-    def mapping
-      GlobalConst.send(model_key)
+    # 将对象转成json数据时，允许添加额外的属性字段，但并不存入数据库
+    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)#给出默认实现
+        end
+      end
+      db_buz_attrs
     end
 
-    def get_map_value(k, value)
-      #raise "Not implemented!"
-      #提供默认处理 #TODO 根据数据类型做些更好的转换
-      case k
-      when :created_at, :updated_at
-        value.try(:to_s, :db)
-      else
-        value
-      end
+    def update_from_buz(params={})
+      update_attributes(self.class.db_hashize(params))
     end
     
-    def dump_new(force=true)
-      if defined?(Rails)
-        file = "#{Rails.root}/data/#{model_key}_#{Time.now.to_i}.yml"
-        path = File.dirname(file)
-        FileUtils.mkpath(path) unless File.directory?(path)
-        existed = File.exists?(file)
-        if existed
-          puts "Warning: #{file} has existed! check it! Default override it!"
+    module ClassMethods
+      #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}_mapping"
+      end
+
+      def mapping
+        GlobalConst.send(model_key)
+      end
+
+      def get_map_value(k, value)
+        #raise "Not implemented!"
+        #提供默认处理 #TODO 根据数据类型做些更好的转换
+        case k
+        when :created_at, :updated_at
+          value.try(:to_s, :db)
+        else
+          value
         end
-        if !existed || force
-          File.open(file, 'w+') do |f|
-            f.puts YAML.dump(buz_hashize)
+      end
+      
+      def dump_new(force=true)
+        if defined?(Rails)
+          file = "#{Rails.root}/data/#{model_key}.yml.#{Time.now.to_i}"
+          path = File.dirname(file)
+          FileUtils.mkpath(path) unless File.directory?(path)
+          existed = File.exists?(file)
+          if existed
+            puts "Warning: #{file} has existed! check it! Default override it!"
+          end
+          if !existed || force
+            File.open(file, 'w+') do |f|
+              f.puts YAML.dump(buz_hashize)
+            end
           end
         end
       end
-    end
-    
-    #辅助方法
-    def new_from_buz(params = {})
-      new(db_hashize(params))
-    end
-    def create_from_buz(params = {})
-      create(db_hashize(params))
-    end
-    
-    #生成field mapping，dump到指定的yaml文件中
-    def dump_mapping(attr_prefix = nil, force = true)
-      if defined?(Rails)
-        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)
-        if existed
-          puts "Warning: #{file} has existed! check it! Default override it!"
-        end
-        if !existed || force
-          #获取数据库字段列表，屏蔽掉自动维护的created_at/updated_at，也可在生成的文件中配上
-          keys = new.attributes.symbolize_keys.keys.delete_if{|k| k =~ /^created_at|updated_at$/}
-          h = keys.inject({}) do |r, k|
-            #移除掉表前缀
-            rm_prefix = attr_prefix.nil? ? "#{__model_clazz_name}_" : attr_prefix
-            new_key = k.to_s.sub(rm_prefix, '').to_sym
-            r[new_key] = k 
-            r
+      
+      #辅助方法
+      def new_from_buz(params = {})
+        new(db_hashize(params))
+      end
+      def create_from_buz(params = {})
+        create(db_hashize(params))
+      end
+      
+      #生成field mapping，dump到指定的yaml文件中
+      def dump_mapping(attr_prefix = nil, force = true, with_timestamp = false)
+        file = nil
+        if defined?(Rails)
+          tstamp = with_timestamp ? ".#{Time.now.to_i}" : ""
+          file = "#{Rails.root}/#{GlobalConst::APP_CODE_HASHES}mappings/#{model_key}.yml#{tstamp}"
+          path = File.dirname(file)
+          FileUtils.mkpath(path) unless File.directory?(path)
+          existed = File.exists?(file)
+          if existed
+            puts "Warning: #{file} has existed! check it! Default override it!"
           end
-          FileUtils.rm_f(file) if existed
-          File.open(file, 'w+') do |f|
-            f.puts YAML.dump(model_key.to_sym=>h)
+          if !existed || force
+            #获取数据库字段列表，屏蔽掉自动维护的created_at/updated_at，也可在生成的文件中配上
+            keys = new.attributes.symbolize_keys.keys.delete_if{|k| k =~ /^created_at|updated_at$/}
+            h = keys.inject({}) do |r, k|
+              #移除掉表前缀
+              rm_prefix = attr_prefix.nil? ? "#{__model_clazz_name}_" : attr_prefix
+              new_key = k.to_s.sub(rm_prefix, '').to_sym
+              r[new_key] = k 
+              r
+            end
+            FileUtils.rm_f(file) if existed
+            File.open(file, 'w+') do |f|
+              f.puts YAML.dump(model_key.to_sym=>h)
+            end
           end
-          puts "==>gen new file #{file} ..."
+          file
         end
       end
-    end
 
-    #TODO
-    def dump_field_map(force=true)
-      puts "==Warning: please use dump_mapping instead, this will be removed..."
-      dump_mapping(nil, true)
-    end
-   
-    #业务层到数据层字段参数转换并做一定值处理
-    def db_hashize(params = {})
-      new_params = params.symbolize_keys
-      common_keys = new_params.keys & mapping.keys
-      common_keys.inject({}) do |result, key|
-        result[mapping[key]] = get_map_value(key, new_params[key])
-        result
+      #TODO
+      def dump_field_map(force=true)
+        puts "==Warning: please use dump_mapping instead, this will be removed..."
+        dump_mapping(nil, true)
       end
-    end
- 
-    #将数据层表示转成业务层表示
-    def buz_hashize(attrs = {})
-      #return {} if attrs.blank?
-      #获取默认初始值
-      attrs = new.attributes if attrs.blank?
-      new_attrs = attrs.symbolize_keys
-      invert_maps = mapping.invert_data
-      common_db_attrs = new_attrs.keys & invert_maps.keys
-      common_db_attrs.inject({}) do |result, attr| 
-        buz_field = invert_maps[attr]
-        result[buz_field] = get_map_value(buz_field, new_attrs[attr])
-        result
+     
+      #业务层到数据层字段参数转换并做一定值处理
+      def db_hashize(params = {})
+        new_params = params.symbolize_keys
+        common_keys = new_params.keys & mapping.keys
+        common_keys.inject({}) do |result, key|
+          result[mapping[key]] = get_map_value(key, new_params[key])
+          result
+        end
+      end
+   
+      #将数据层表示转成业务层表示
+      def buz_hashize(attrs = {})
+        #return {} if attrs.blank?
+        #获取默认初始值
+        attrs = new.attributes if attrs.blank?
+        new_attrs = attrs.symbolize_keys
+        invert_maps = mapping.invert_data
+        common_db_attrs = new_attrs.keys & invert_maps.keys
+        common_db_attrs.inject({}) do |result, attr| 
+          buz_field = invert_maps[attr]
+          result[buz_field] = get_map_value(buz_field, new_attrs[attr])
+          result
+        end
       end
     end
   end

data/lib/ns_service_pack/global_const.rb

@@ -6,7 +6,6 @@
 =end
 require 'fileutils'
 module GlobalConst 
-  SAMPLE_FILE = "templates/code_hashes/code_hash.yml.sample"
   APP_CODE_HASHES = "config/code_hashes/" 
 
   mattr_accessor :global_data
@@ -18,7 +17,7 @@ module GlobalConst
     raise "Method name: #{method_name}(#{args.inspect}) is not defined!"
   end
   
-  def self.load_code_hashes!(hash_or_file = SAMPLE_FILE)
+  def self.load_code_hashes!(hash_or_file = {})
     if hash_or_file.is_a?(Hash)
       h = hash_or_file
     else
@@ -49,39 +48,4 @@ module GlobalConst
       end
     end
   end
-  
-  #为引用项目生成样例文件， TODO rake方式生成
-  def self.setup_sample(yml_file = "#{APP_CODE_HASHES}code_hash.yml.sample")
-    if defined? Rails
-      target = "#{Rails.root}/#{yml_file}"
-      unless File.exists?(target)
-        path = File.dirname(target)
-        FileUtils.mkpath(path)
-        #默认覆盖已有
-        FileUtils.cp(SAMPLE_FILE, target)
-      end
-    end
-  end
-
-  #将一个hash和array写入data下的yaml结构中
-  def self.yamlize(hash_or_array = {}, file_name = nil)
-    return if hash_or_array.nil?
-    hash = if hash_or_array.is_a?(Array)
-      hash_or_array.inject({}) do |r, k|
-        r[k] = nil
-        r
-      end
-    else
-      hash_or_array
-    end
-
-    method_key = file_name.nil? ? "hash" : file_name.to_s
-    name = "#{method_key}_#{Time.now.to_i}"
-    file = "#{Rails.root}/data/#{name}.yml"
-    path = File.dirname(file)
-    Fileutils.mkpath(path) unless File.directory?(path)
-    File.open(file, 'w+') do |f|
-      f.puts YAML.dump(method_key.to_sym=>hash)
-    end
-  end
 end

data/lib/ns_service_pack/result.rb

@@ -0,0 +1,21 @@
+#coding: utf-8
+
+module Ns
+  #TODO 封装在gem包中
+  class Result
+    STATUSES = [:ok, :imperfect, :illegal, :error]
+    attr_accessor :status, :msg, :data, :errors
+    def initialize(params = {})
+      _params = params.symbolize_keys
+      @status = _params[:status]
+      @msg = _params[:msg]
+      @data = _params[:data]
+      @errors = _params[:errors]
+    end
+
+    def ok?
+      status == 'ok'
+    end
+  end
+end
+

data/lib/ns_service_pack/result_error.rb

@@ -0,0 +1,17 @@
+#coding: utf-8
+
+module Ns
+  class ResultError < RuntimeError
+    attr_reader :result
+    def initialize(result = nil)
+      raise "Invalid result argument!" unless result.is_a?(Result)
+      super(result.msg)
+      @result = result
+    end
+
+    def to_s
+      "RusultError: #{@result.status} #{@result.msg}, detail: #{@result.errors.inspect}"
+    end
+  end
+end
+

data/lib/ns_service_pack/service_config.rb

@@ -0,0 +1,30 @@
+#coding: utf-8
+module Ns
+  class ServiceConfig
+    SERVICE_CONFIG_FILE = 'config/ns_services.yml'
+    cattr_accessor :services
+    @@services = {}
+    
+    def self.load_services!(config_file = SERVICE_CONFIG_FILE)
+      return unless File.exists?(config_file)
+      service_configs = YAML.load(File.read(SERVICE_CONFIG_FILE))
+      @@services.merge!(service_configs[Rails.env])
+      #load common parts if exists
+      if (common_parts = service_configs['common']).is_a?(Hash)
+        common_parts.each do |k, v|
+          @@services[k] = if v.is_a?(Array)
+            if v.size == 2
+              v[0] =  @@services[v[0].to_sym]
+              Util.concat_url(v[0], v[1])
+            else
+              raise "Invalid path!"
+            end #/if
+          else
+            v
+          end #/if
+        end #/do
+      end #/if
+      @@services
+    end #/def
+  end
+end

data/lib/ns_service_pack/util.rb

@@ -0,0 +1,36 @@
+#coding: utf-8
+require 'fileutils'
+module Ns
+  module Util
+    extend self 
+    def concat_url(prefix_url='', url='')
+      prefix_url = prefix_url.to_s
+      sep = (prefix_url[-1, 1] == '/' || url[0, 1] == '/') ? '' : '/'
+      "#{prefix_url}#{sep}#{url}"
+    end
+  
+    #将一个hash和array写入data下的yaml结构中
+    def self.yamlize(hash_or_array = {}, file_name = nil)
+      return if hash_or_array.nil?
+      hash = if hash_or_array.is_a?(Array)
+        hash_or_array.inject({}) do |r, k|
+          r[k] = nil
+          r
+        end
+      else
+        hash_or_array
+      end
+
+      method_key = file_name.nil? ? "hash" : file_name.to_s
+      name = "#{method_key}_#{Time.now.to_i}"
+      file = "#{Rails.root}/data/#{name}.yml"
+      path = File.dirname(file)
+      FileUtils.mkpath(path) unless File.directory?(path)
+      File.open(file, 'w+') do |f|
+        f.puts YAML.dump(method_key.to_sym=>hash)
+      end
+      puts "Generate a yaml file in #{file}"
+      file
+    end
+  end
+end

data/lib/ns_service_pack/version.rb

@@ -1,4 +1,5 @@
 #coding: utf-8
 module NsServicePack 
+  puts "Warnign: TODO USE JEWELER DEFAULT VERSION MECHANISM NOW!"
   VERSION = '0.0.16'
 end

data/lib/ns_service_pack.rb

@@ -4,26 +4,23 @@
 #$LOAD_PATH.unshift("#{NS_GEM_ROOT}/lib")
 
 require 'fileutils'
+require 'ns_service_pack/util'
 require 'ns_service_pack/code_hash'
 require 'ns_service_pack/global_const'
 require 'ns_service_pack/field_mapping'
+require 'ns_service_pack/result'
+require 'ns_service_pack/result_error'
 require 'ns_service_pack/result_packer'
-require 'ns_service_pack/application_controller_module'
+require 'ns_service_pack/controller_servicable'
+require 'ns_service_pack/client'
+require 'ns_service_pack/service_config'
+# TODO FOR optimize
 
-module NsServicePack
-
-  PRE_INIT_FILE = "config/initializers/ns_service_pack.rb"
-  INIT_FILE_TMPL = "templates/initializers/ns_service_pack.rb"
-  #初始安装设置
-  def self.install 
-    init_file = "#{Rails.root}/#{PRE_INIT_FILE}"
-    unless File.exists?(init_file)
-      FileUtils.cp(INIT_FILE_TMPL, init_file)
-      puts "==>I have installed a intializer file: #{init_file}"
-      GlobalConst.setup_sample
-      puts "==>Now 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
+# customize deeply TODO
+module Ns
+  class Railtie < Rails::Railtie
+    config.app_generators do |g|
+      g.templates.unshift File::expand_path('../templates', __FILE__)
+    end 
   end
-end
+end 

data/lib/templates/active_record/model/model.rb

@@ -0,0 +1,9 @@
+#encoding: utf-8
+<% module_namespacing do -%>
+class <%= class_name %> < <%= parent_class_name.classify %>
+<% attributes.select {|attr| attr.reference? }.each do |attribute| -%>
+  belongs_to :<%= attribute.name %>
+<% end -%>
+  include Ns::FieldMapping
+end
+<% end -%>

data/lib/templates/config/database.yml.sample

@@ -0,0 +1,44 @@
+# Oracle/OCI 8i, 9, 10g
+#
+# Requires Ruby/OCI8:
+#  http://rubyforge.org/projects/ruby-oci8/
+#
+# Specify your database using any valid connection syntax, such as a
+# tnsnames.ora service name, or an SQL connect string of the form:
+#
+#   //host:[port][/service name]
+#
+# By default prefetch_rows (OCI_ATTR_PREFETCH_ROWS) is set to 100. And
+# until true bind variables are supported, cursor_sharing is set by default
+# to 'similar'. Both can be changed in the configuration below; the defaults
+# are equivalent to specifying:
+#
+#  prefetch_rows: 100
+#  cursor_sharing: similar
+#
+
+development:
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  pool: 5
+  host: localhost
+  database: ningshangOracle
+  username: root
+  password: root
+  socket: /var/run/mysqld/mysqld.sock
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test: 
+  adapter: oracle_enhanced
+  database: oradb.ningshang.me/ningshang
+  username: xxx  
+  password: utf8  
+
+production:
+  adapter: oracle_enhanced
+  database: oradb.ningshang.me/ningshang
+  username: xxx  
+  password: utf8  

data/lib/templates/config/initializers/ns_service_pack.rb

@@ -0,0 +1,8 @@
+#coding: utf-8
+
+#导入项目中使用的CodeHashes
+GlobalConst.load_app_code_hashes!
+
+#加载外部services依赖
+NsServices = Ns::ServiceConfig.load_services!
+

data/lib/templates/config/initializers/oracle_db_config.rb

@@ -0,0 +1,21 @@
+#encoding: utf-8
+#If you want to change Oracle enhanced adapter default settings then create initializer file e.g. config/initializers/oracle.rb specify there necessary defaults, e.g.:
+
+# It is recommended to set time zone in TZ environment variable so that the same timezone will be used by Ruby and by Oracle session
+#ENV['TZ'] = 'UTC'
+
+if defined?(ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter)
+  ActiveSupport.on_load(:active_record) do
+    ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter.class_eval do
+      # id columns and columns which end with _id will always be converted to integers
+      #self.emulate_integers_by_column_name = true
+      # DATE columns which include "date" in name will be converted to Date, otherwise to Time
+      #self.emulate_dates_by_column_name = true
+      # true and false will be stored as 'Y' and 'N'
+      #self.emulate_booleans_from_strings = true
+      # start primary key sequences from 1 (and not 10000) and take just one next value in each session
+      self.default_sequence_start_value = "1"# NOCACHE INCREMach ENT BY 1"
+      # other settings ...
+    end
+  end
+end

data/lib/templates/config/ns_services.yml

@@ -0,0 +1,19 @@
+#coding: utf-8
+
+#依赖的服务配置，注意：key不能重复哦！！！
+
+#==依赖于运行环境的设置
+development:
+  :customer_service_base_url: http://localhost:5000
+
+test:
+  :customer_service_base_url: http://customer.api.ilining.cn
+
+production:
+  :customer_service_base_url: http://customer.api.ilining.cn
+
+#==依赖于前面值的共有设置
+#如：开发模式下， AppConfig.services[:customers]==>http://localhost:5000/customers
+#语法： 键: [依赖键（字符串形式）, 附加字串]
+common:
+  :customers: [customer_service_base_url, customers]

data/lib/templates/rails/scaffold_controller/controller.rb

@@ -0,0 +1,9 @@
+#encoding: utf-8
+<% module_namespacing do -%>
+class <%= controller_class_name %>Controller < ApplicationController
+  include Ns::ControllerServicable
+  def model_class
+    <%= class_name %>
+  end
+end
+<% end -%>