ns_service_pack 0.1.0 → 0.1.1

data/CHANGELOG

@@ -1,8 +1,13 @@
 #==============History:
-* 增加service scaffold generator
+
+#==0.1.1
+* 将该gem升级为rails项目中的engine
+* 增加了一个默认的info_controller，反射出当前应用发布的api接口（仅可在非产品模式访问）
+
 
 #==0.1.0[Note: 重大变更！]
-* 初始化配置文件copy由thor任务完成： ns_service_pack init (在rails根目录下)
+* 增加service scaffold generator: rake generator ns:scaffold
+* 初始化配置文件copy由thor任务完成： ns_service_pack install (在rails根目录下)
 * 将ApplicationControllerModule重命名为：Ns::ControllerServicable
 * 在initializers/ns_service_pack.rb中默认只加载配置信息，不再为controller和model包含mapping的功能，由最终用户
   决定是否使用，这样做性能和可定制性更好（后来加上scaffold功能，减少人为操作！）

data/README.rdoc

@@ -9,10 +9,10 @@
 * 提供数据库层-业务层字段自动转换
 
 == TODO TASK LIST 
-* 添加一个默认controller用于展现interface等信息
 * 规划文档和内容调整
 * 写完整测试
 * index默认查询条件加入，传入条件的merge（目前已提供传入条件的精确搜索）
+* 如何用get请求模拟post请求
 
 #==NS Service Pack使用指南
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/app/controllers/ns/info_controller.rb

@@ -0,0 +1,37 @@
+#encoding: utf-8
+class Ns::InfoController < ApplicationController
+  unloadable #??? 什么意思？
+  #动态查看该模块发布接口列表
+  def interfaces
+    @routes = Rails.application.routes.routes
+    #删除一些无需关注的路由: /assets, /rails/info/properties, /interfaces
+    @routes.delete_if{|r| r.path =~ /\/assets|\/rails\/info|\/interfaces/}
+    #验证接口是否改变的校验码
+    @version_code = @routes.join(';').hash
+    respond_to do |format|
+      format.html #interfaces.html.erb
+      format.json {render json: @routes.map{|r| r.path}}
+    end
+  end
+ 
+  #获取字段映射对照表
+  def mappings
+    @data = GlobalConst.mappings
+    #验证接口是否改变的校验码
+    @version_code = @data.hash
+    respond_to do |format|
+      format.html 
+      format.json {render json: @data}
+    end
+  end
+  
+  def constants
+    @data = GlobalConst.constants
+    #验证接口是否改变的校验码
+    @version_code = @data.hash
+    respond_to do |format|
+      format.html {render :action=>:mappings}
+      format.json {render json: @data}
+    end
+  end
+end

data/app/views/ns/info/interfaces.html.erb

@@ -0,0 +1,42 @@
+<p>模块发布接口列表(版本码：<%=@version_code%>  获取日期:<%= Time.now.to_s(:db)%>)：</p>
+
+<table border='1'>
+  <tr>
+    <th>No.</th>
+    <th>HttpMethod</th>
+    <th>Path</th>
+    <th>Sample</th>
+    <th>Requirements  </th>
+  </tr>
+  <%@routes.each_with_index do |r, i|%>
+    <tr>
+      <td>
+        <%= i+1 %>
+      </td>
+      <td>
+        <%= r.verb%>
+      </td>
+      <td>
+        <%= r.path%>
+      </td>
+      <td>
+        <%#= link_to r.name || "示例", "#{r.path.sub('(.:format)', '.json').sub(':id', '1')}}" %> 
+        <%if r.verb.to_s.upcase == 'GET' %>
+          <%=link_to r.name || "示例", "#{r.path.sub('(.:format)', '.json').sub(':id', '1')}" %> 
+        <%else%>
+          <%= "#{r.path.sub('(.:format)', '').sub(':id', '1')}" %> 
+        <%end%>
+      </td>
+      <td>
+        <%= r.requirements%>
+      </td>
+    </tr>
+  <%end%>
+</table>
+
+<div>
+  <span>注：</span>
+  <ul>
+    <li>:format 一般为 json</li>
+  </ul>
+</div>

data/app/views/ns/info/mappings.html.erb

@@ -0,0 +1,21 @@
+<p>业务-数据库字段对照表(版本码：<%=@version_code%>  获取日期:<%= Time.now.to_s(:db)%>)：</p>
+
+<table border='1'>
+  <%@data.each do |k, v|%>
+    <%if v.is_a?(Hash)%>
+      <%v.each_with_index do |e1, i|%>
+        <tr>
+          <td>  <%= i==0 ? k : ''%></td>
+          <td>  <%= e1[0]%>       </td>
+          <td>  <%= e1[1]%>       </td>
+        </tr>
+      <%end%>
+    <%else%>
+      <tr>
+        <td>  <%= k%>       </td>
+        <td>  <%= v%>       </td>
+        <td>   &nbsp;       </td>
+      </tr>
+    <%end%>
+  <%end%>
+</table>

data/config/routes.rb

@@ -0,0 +1,10 @@
+#encoding: utf-8
+
+# 发布的接口仅在非生产模式可访问
+unless Rails.env.production?
+  Rails.application.routes.draw do
+    get 'interfaces', :to=>"ns/info#interfaces"
+    get 'constants', :to=>"ns/info#constants"
+    get 'mappings', :to=>"ns/info#mappings"
+  end
+end

data/lib/generators/ns/scaffold/scaffold_generator.rb

@@ -25,17 +25,11 @@ class Ns::ScaffoldGenerator < Rails::Generators::ScaffoldGenerator
   end
   
   desc "Modify the route to add some action support"
-  def interfaces
+  def reroute
+    #TODO MOVE dev interface TO this gem controller
     gsub_file('config/routes.rb', /^\s*resources :#{plural_name}$/) do
       <<-Doc 
-  resources :#{plural_name}, :except=>[:new, :edit, :destroy] do
-    collection do
-      get 'new_buz_obj'
-      #TODO MOVE INTO THE GEM
-      get 'field_mapping'
-      get 'interfaces'
-    end    
-  end
+  resources :#{plural_name}, :except=>[:edit, :destroy] 
       Doc
     end
   end 

data/lib/ns_service_pack/controller_servicable.rb

@@ -52,6 +52,12 @@ module Ns
       }
     end
     
+    #get a new buz obj with db default value
+    def new
+      @_data = model_class.buz_hashize
+      render :json=>ResultPacker.data(model_class.name.underscore.to_sym=>@_data)
+    end
+    
     #查找单条记录
     def show
       @_obj = model_class.find(params[:id])
@@ -77,32 +83,10 @@ module Ns
         render :json=>ResultPacker.help(valid_errors(model_class.buz_hashize(@_obj.errors.to_hash)))
       end
     end
-   
-    #get a new buz obj with db default value
-    def new_buz_obj
-      @_data = model_class.buz_hashize
-      render :json=>ResultPacker.data(model_class.name.underscore.to_sym=>@_data)
-    end
-   
-    #get the mapping info
-    def field_mapping
-      @_data = model_class.mapping.data
-      render :json=>ResultPacker.data(:field_mapping=>@_data)
-    end
-
-    #动态查看该模块发布接口列表
-    def interfaces
-      @routes = Rails.application.routes.routes
-      #TODO 写一个像rails info一样的那种内置controller
-      respond_to do |format|
-        format.html #interfaces.html.erb
-        format.json {render json: @routes.map{|r| r.path}}
-      end
-    end
     
     protected 
       #验证错误回传
-      def valid_errors(error_hash={})
+      def valid_errors(error_hash = {})
         (error_hash||{}).each{|k, v| error_hash[k] = v.join(', ') if v.is_a? Array }
       end
   end

data/lib/ns_service_pack/engine.rb

@@ -0,0 +1,9 @@
+#encoding: utf-8
+
+require 'rails'
+module Ns 
+  class Engine < Rails::Engine
+    engine_name :ns_service_pack
+  end
+end
+

data/lib/ns_service_pack/field_mapping.rb

@@ -65,23 +65,6 @@ module Ns
         end
       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
-      
       #辅助方法
       def new_from_buz(params = {})
         new(db_hashize(params))

data/lib/ns_service_pack/global_const.rb

@@ -3,6 +3,9 @@
 * 20111115 find bug
   避免每次重新生成CodeHash的对象
 * TODO 在项目中要分自己用的还是提供给外边的
+* 将常量部分和mapping部分进行分离 TODO
+    常量在宿主应用中要引用
+    mapping只在插件内部使用，用户只需按要求进行配置
 =end
 require 'fileutils'
 module GlobalConst 
@@ -10,12 +13,26 @@ module GlobalConst
 
   mattr_accessor :global_data
   @@global_data = {}
-  
+ 
+  #TODO 加载的时候直接生成方法，而不用这样动态查找，效率会更好吗？
   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.constants
+    data = @@global_data.select{|k| k.to_s !~ /\w+_mapping$/}.dup
+    data.map{|k, v| data[k] = v.data}
+    data
+  end
+ 
+  # TODO 考虑在数据结构和设置时优化
+  def self.mappings
+    data = @@global_data.select{|k| k.to_s =~ /\w+_mapping$/}.dup
+    data.map{|k, v| data[k] = v.data}
+    data
+  end
   
   def self.load_code_hashes!(hash_or_file = {})
     if hash_or_file.is_a?(Hash)
@@ -24,14 +41,14 @@ module GlobalConst
       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!你自己去看看，别找我！"
+        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|
       if @@global_data.key?(k)
-        puts "==>Warning: new value(from #{hash_or_file.inspect}) is set for key:#{k}! Please check that is your need!"
+        puts "==>Warning: new value(from #{hash_or_file.inspect}) is set for key:#{k}! Please check that!"
       end
       @@global_data[k] = CodeHash.new(nh[k])
     end

data/lib/ns_service_pack.rb

@@ -15,3 +15,7 @@ require 'ns_service_pack/controller_servicable'
 require 'ns_service_pack/client'
 require 'ns_service_pack/service_config'
 # TODO FOR optimize
+
+# 将本应用作为一个engine
+require 'ns_service_pack/engine' if defined?(Rails)
+

data/ns_service_pack.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "ns_service_pack"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Caory, Shang, Geogeous"]
-  s.date = "2011-11-30"
+  s.date = "2011-12-01"
   s.description = "abstract some common pattern to service pack"
   s.email = "cao7113@hotmail.com"
   s.executables = ["nsp"]
@@ -26,7 +26,11 @@ Gem::Specification.new do |s|
     "README.rdoc",
     "Rakefile",
     "VERSION",
+    "app/controllers/ns/info_controller.rb",
+    "app/views/ns/info/interfaces.html.erb",
+    "app/views/ns/info/mappings.html.erb",
     "bin/nsp",
+    "config/routes.rb",
     "lib/generators/ns/scaffold/scaffold_generator.rb",
     "lib/generators/ns/scaffold/templates/active_record/model/model.rb",
     "lib/generators/ns/scaffold/templates/rails/scaffold_controller/controller.rb",
@@ -36,6 +40,7 @@ Gem::Specification.new do |s|
     "lib/ns_service_pack/client.rb",
     "lib/ns_service_pack/code_hash.rb",
     "lib/ns_service_pack/controller_servicable.rb",
+    "lib/ns_service_pack/engine.rb",
     "lib/ns_service_pack/field_mapping.rb",
     "lib/ns_service_pack/global_const.rb",
     "lib/ns_service_pack/result.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ns_service_pack
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-30 00:00:00.000000000Z
+date: 2011-12-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &78640940 !ruby/object:Gem::Requirement
+  requirement: &80545720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.6.7
   type: :runtime
   prerelease: false
-  version_requirements: *78640940
+  version_requirements: *80545720
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &78640700 !ruby/object:Gem::Requirement
+  requirement: &80545480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.14.6
   type: :runtime
   prerelease: false
-  version_requirements: *78640700
+  version_requirements: *80545480
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &78640460 !ruby/object:Gem::Requirement
+  requirement: &80545240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *78640460
+  version_requirements: *80545240
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &78640220 !ruby/object:Gem::Requirement
+  requirement: &80545000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *78640220
+  version_requirements: *80545000
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &78639980 !ruby/object:Gem::Requirement
+  requirement: &80544760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *78639980
+  version_requirements: *80544760
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &78639740 !ruby/object:Gem::Requirement
+  requirement: &80544520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *78639740
+  version_requirements: *80544520
 description: abstract some common pattern to service pack
 email: cao7113@hotmail.com
 executables:
@@ -94,7 +94,11 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- app/controllers/ns/info_controller.rb
+- app/views/ns/info/interfaces.html.erb
+- app/views/ns/info/mappings.html.erb
 - bin/nsp
+- config/routes.rb
 - lib/generators/ns/scaffold/scaffold_generator.rb
 - lib/generators/ns/scaffold/templates/active_record/model/model.rb
 - lib/generators/ns/scaffold/templates/rails/scaffold_controller/controller.rb
@@ -104,6 +108,7 @@ files:
 - lib/ns_service_pack/client.rb
 - lib/ns_service_pack/code_hash.rb
 - lib/ns_service_pack/controller_servicable.rb
+- lib/ns_service_pack/engine.rb
 - lib/ns_service_pack/field_mapping.rb
 - lib/ns_service_pack/global_const.rb
 - lib/ns_service_pack/result.rb
@@ -134,7 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -733976717
+      hash: 373915261
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: