ns_service_pack 0.0.21 → 0.1.0

data/README.rdoc

@@ -1,69 +1,31 @@
 = ns_service_pack
 
-  实现部分REST架构（ROA）中Service层基础共享代码抽取
+  实现REST架构（ROA）中Service层部分基础代码抽取
 
-#==功能列表：
+== 功能列表：
 
 * 支持自定义json格式的资源crud操作
 * 提供全局字典常量/转换管理
 * 提供数据库层-业务层字段自动转换
 
-#==TODO TASK LIST 
-
-* 更好用的安装使用接口，自动完成，可配置
-* rake 任务的引入， 产品模式将数据文件预编译成一个数据文件
-* 提供scaffold模式方法
-  生成一些辅助接口和方法
-  service_scaffold，生成需要的模板和基本方法
-
-* fieldmapping 和 常量管理的分离
-   让使用者可以决定是否使用mapping，目前可以通过注释initializer中片段完成
-* 用模板的方法生成initializer，以便插入一些动态数据
-* application_controller_module的引入还是有问题！！！
-* 如何为application_controller_module中的action自动生成路由呢？
-  直接生成服务端和客户端基础代码
+== TODO TASK LIST 
+* 添加一个默认controller用于展现interface等信息
+* 规划文档和内容调整
+* 写完整测试
 * index默认查询条件加入，传入条件的merge（目前已提供传入条件的精确搜索）
 
 #==NS Service Pack使用指南
 
-*1 在rails3项目Gemfile中引入
-   gem 'ns_service_pack'
+*1 在rails3项目中使用，命令行执行：
+   gem install ns_service_pack
+   ns_service_pack install
+   bundle install
   
-*2 启动控制台 rails c，运行命令
-   NsServicePack.install
-
-*3 配置项目中的常量数据
-   config/code_hashes/**/*.yml中数据会作为CodeHash加载
-   可在控制台下用以下命令辅助生成：
-     <ModelName>.dump_mapping
-     生成buz-db field_mapping, 可配置, --><app>/config/code_hashes/fields/*.yml
-
-     <ModelName>.dump_new
-     客户new该资源时的结构，--> <app>/data/*.yml
-
-   常量的使用：
-     GlobalConst.ns_statuses[key_or_value]
-
-*4 配置项目的controllers和models
-4.1)在ApplicationController子类，如：
-class AddressesController < ApplicationController
-  ...
-  def model_class
-    #引用的模型类，是ActiveRecord::Base子类
-  end
-
-  ...
-end
+*2 为某资源生成有service支持的scaffold，命令行：
+   rake g ns:scaffold
 
-4.2)在ActiveRecord::Base子类中，如Customer
-class Customer < ActiveRecord::Base
-  ...
-  def self.get_map_value(k, v)
-    #定制各字段值的业务显示格式
-    #value mapping
-  end
-  ...
-end
+*3 提示：
+   常量的使用：GlobalConst.ns_statuses[key_or_value]
 
 == Contributing to ns_service_pack
  

data/VERSION

@@ -1 +1 @@
-0.0.21
+0.1.0

data/bin/{ns_service_pack → nsp}

@@ -13,7 +13,7 @@ class Cli < Thor
   method_options :force=>:boolean#, :aliases=>'-f'
   def install
     unless rails_root?
-      say("  Error: current #{cwd} is not a rails app root directory!", :red)
+      say("  Error: current directory:#{cwd} is not a rails app root!", :red)
       return
     end
     unless use_bundler?
@@ -81,7 +81,6 @@ gem 'ns_service_pack' #use our service pack
       [ 'config/code_hashes/code_hash.yml.sample',
         'config/initializers/ns_service_pack.rb',
         'config/initializers/oracle_db_config.rb',
-        'config/database.yml.sample',
         'config/ns_services.yml'
       ]
     end

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

@@ -1,12 +1,42 @@
 #encoding: utf-8
 require 'rails/generators/rails/scaffold/scaffold_generator'
+
+#Let this templates selected firstly! Just apply this default temmplate overriding to ns:scaffold 
+#Don't pollute the rails default generators in user's projects!
+Rails::Generators.templates_path.unshift File::expand_path('../templates', __FILE__)
+#默认设置如下选项 --no-migration --no-template_engine
+Rails::Generators.options[:active_record][:migration] = false
+Rails::Generators.options[:rails][:template_engine] = false
+#puts "====options: #{Rails::Generators.options.inspect}"
+
 class Ns::ScaffoldGenerator < Rails::Generators::ScaffoldGenerator
-  desc "dump field mapping ..."
+  #移除一些不必要的generator引用 
+  remove_hook_for :assets 
+  remove_hook_for :stylesheet_engine
+  remove_class_option :stylesheet_engine
+  remove_class_option :stylesheets
+
+  desc "Dump field mapping to a yml file..."
   def dump_field_mapping
-    say("  Generating fieldmapping for model: #{name}...", :green)
     the_model = Object.const_get(class_name)
     mapping_file = the_model.dump_mapping
-    say("  Generated field mapping for model: #{name}...", :green)
-    say("  You can configure it in #{mapping_file}.", :green)
+    say("   Generated field mapping for model: #{name}...", :green)
+    say("   You can configure it in #{mapping_file}.", :green)
   end
+  
+  desc "Modify the route to add some action support"
+  def interfaces
+    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
+      Doc
+    end
+  end 
 end

data/lib/generators/try/try_generator.rb

@@ -1,5 +1,4 @@
 #encoding: utf-8
-
 class TryGenerator < Rails::Generators::NamedBase
   #source_root File.expand_path("../templates", __FILE__)
   #def copy_test_file
@@ -12,6 +11,5 @@ class TryGenerator < Rails::Generators::NamedBase
     puts "plural_name:#{plural_name}, thor camel: #{Thor::Util.camel_case(name)}"
     puts "==get model info: #{Object.const_get(class_name).new.attributes}"
   end
-
 end
 

data/lib/ns_service_pack.rb

@@ -15,12 +15,3 @@ require 'ns_service_pack/controller_servicable'
 require 'ns_service_pack/client'
 require 'ns_service_pack/service_config'
 # TODO FOR optimize
-
-# 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 

data/lib/ns_service_pack/controller_servicable.rb

@@ -32,7 +32,7 @@ module Ns
       conds = model_class.db_hashize(params)
     end
 
-    #分页方法
+    #分页方法 # 加入文档说明
     def paginate(params = {})
       current_page = params[:current_page].to_i
       current_page = current_page < 1 ? 1 : current_page
@@ -78,20 +78,32 @@ module Ns
       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, keep here
-    def query_fields
+    #get a new buz obj with db default value
+    def new_buz_obj
       @_data = model_class.buz_hashize
-      render :json=>ResultPacker.data(:fields=>@_data)
+      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={})
+        (error_hash||{}).each{|k, v| error_hash[k] = v.join(', ') if v.is_a? Array }
+      end
   end
 end

data/lib/ns_service_pack/field_mapping.rb

@@ -2,7 +2,8 @@
 =begin
   字段映射，业务字段-数据库字段对应
 
-  TODO: 不需做字段转换的处理
+  TODO: 
+  将不需进行字段装换的功能玻璃出来
 =end
 require 'fileutils'
 module Ns
@@ -90,7 +91,7 @@ module Ns
       end
       
       #生成field mapping，dump到指定的yaml文件中
-      def dump_mapping(attr_prefix = nil, force = true, with_timestamp = false)
+      def dump_mapping(attr_prefix = nil, force = false, with_timestamp = false)
         file = nil
         if defined?(Rails)
           tstamp = with_timestamp ? ".#{Time.now.to_i}" : ""
@@ -99,7 +100,7 @@ module Ns
           FileUtils.mkpath(path) unless File.directory?(path)
           existed = File.exists?(file)
           if existed
-            puts "Warning: #{file} has existed! check it! Default override it!"
+            puts "Warning: #{file} has existed! check it!"
           end
           if !existed || force
             #获取数据库字段列表，屏蔽掉自动维护的created_at/updated_at，也可在生成的文件中配上

data/ns_service_pack.gemspec

@@ -5,14 +5,14 @@
 
 Gem::Specification.new do |s|
   s.name = "ns_service_pack"
-  s.version = "0.0.21"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Caory, Shang, Geogeous"]
-  s.date = "2011-11-29"
+  s.date = "2011-11-30"
   s.description = "abstract some common pattern to service pack"
   s.email = "cao7113@hotmail.com"
-  s.executables = ["ns_service_pack"]
+  s.executables = ["nsp"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
@@ -26,8 +26,10 @@ Gem::Specification.new do |s|
     "README.rdoc",
     "Rakefile",
     "VERSION",
-    "bin/ns_service_pack",
+    "bin/nsp",
     "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",
     "lib/generators/try/templates/test.rb",
     "lib/generators/try/try_generator.rb",
     "lib/ns_service_pack.rb",
@@ -42,13 +44,10 @@ Gem::Specification.new do |s|
     "lib/ns_service_pack/service_config.rb",
     "lib/ns_service_pack/util.rb",
     "lib/ns_service_pack/version.rb",
-    "lib/templates/active_record/model/model.rb",
     "lib/templates/config/code_hashes/code_hash.yml.sample",
-    "lib/templates/config/database.yml.sample",
     "lib/templates/config/initializers/ns_service_pack.rb",
     "lib/templates/config/initializers/oracle_db_config.rb",
     "lib/templates/config/ns_services.yml",
-    "lib/templates/rails/scaffold_controller/controller.rb",
     "ns_service_pack.gemspec",
     "test/helper.rb",
     "test/test_ns_service_pack.rb"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ns_service_pack
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-29 00:00:00.000000000Z
+date: 2011-11-30 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &86468680 !ruby/object:Gem::Requirement
+  requirement: &78640940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.6.7
   type: :runtime
   prerelease: false
-  version_requirements: *86468680
+  version_requirements: *78640940
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &86468440 !ruby/object:Gem::Requirement
+  requirement: &78640700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.14.6
   type: :runtime
   prerelease: false
-  version_requirements: *86468440
+  version_requirements: *78640700
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &86468200 !ruby/object:Gem::Requirement
+  requirement: &78640460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *86468200
+  version_requirements: *78640460
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &86467960 !ruby/object:Gem::Requirement
+  requirement: &78640220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *86467960
+  version_requirements: *78640220
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &86467720 !ruby/object:Gem::Requirement
+  requirement: &78639980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *86467720
+  version_requirements: *78639980
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &86467480 !ruby/object:Gem::Requirement
+  requirement: &78639740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,11 +76,11 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *86467480
+  version_requirements: *78639740
 description: abstract some common pattern to service pack
 email: cao7113@hotmail.com
 executables:
-- ns_service_pack
+- nsp
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
@@ -94,8 +94,10 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
-- bin/ns_service_pack
+- bin/nsp
 - 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
 - lib/generators/try/templates/test.rb
 - lib/generators/try/try_generator.rb
 - lib/ns_service_pack.rb
@@ -110,13 +112,10 @@ files:
 - lib/ns_service_pack/service_config.rb
 - lib/ns_service_pack/util.rb
 - lib/ns_service_pack/version.rb
-- lib/templates/active_record/model/model.rb
 - lib/templates/config/code_hashes/code_hash.yml.sample
-- lib/templates/config/database.yml.sample
 - lib/templates/config/initializers/ns_service_pack.rb
 - lib/templates/config/initializers/oracle_db_config.rb
 - lib/templates/config/ns_services.yml
-- lib/templates/rails/scaffold_controller/controller.rb
 - ns_service_pack.gemspec
 - test/helper.rb
 - test/test_ns_service_pack.rb
@@ -135,7 +134,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 777346227
+      hash: -733976717
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

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

@@ -1,44 +0,0 @@
-# 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