repres-bootstrap 1.1 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 009f026957d47d559302d2f8808d85247d581af4
-  data.tar.gz: 69e13e0bafc68b16dd7d16f6b74fa9ebdd83efd3
+  metadata.gz: 390ec8fee400b93c2ce818b38fb703ff9da3df4f
+  data.tar.gz: ba1031a334964d10aaf38d9b17c219bd8bdc085d
 SHA512:
-  metadata.gz: 262509153624c6369b6bb388677222c1d46dd261b6367ea30fa53986b7d62319046ab293add1c0b671ba8c38936bbec28c814013e4d2b9ed613a91741a264c21
-  data.tar.gz: c9a78694fe944c60338f260e75df372d2c19dfd31d67124c87dbba4521a0e6f709e0dc79c1f1b6bcb10d2f0c18edda8946193579662a3925a066f358ca0a0edc
+  metadata.gz: 1a7972ff9a34818d87d243404e51ec56407f3e5f94db910b7ded5dd65b66b2294cc37880c6473652079c51b7ba4d92e60553bc5ec47880a4b74c8f15651b31d3
+  data.tar.gz: cd1ccae0fbd4599c0c41bbf075c2fa2eb64ee6046f5a0caf9d486601cf2935035a9134ed17cd98a6edae45b315c6623ac063af44234b3813fbfdee743a2373f8

data/README.md

@@ -24,6 +24,7 @@ gem 'repres-bootstrap'
 ## Include the Helper in your Application Controller before Render the Style or Script with the helper methods
 ```ruby
 include Repres::Bootstrap::ApplicationHelper
+include Repres::Bootstrap::FormHelper
 ```
 
 
@@ -202,3 +203,10 @@ Here are more options:
 - input_accept: The HTML 5 attribute for the file input tag.
 - input_data:   The HTML 5 Data attribute for the input tag.
 - error_hidden: Determines whether the error message block should be shown if the field has any error.
+
+- disabled:    the disabled attribute of a HTML input tag.
+- maxlength:   the maxlength attribute of a HTML input tag.
+- placeholder: the placeholder attribute of a HTML input tag.
+- readonly:    the readonly attribute of a HTML input tag.
+- required:    the required attribute of a HTML input tag.
+- rows:        the rows of a HTML Text Area

data/app/helpers/repres/bootstrap/application_helper.rb

@@ -1,10 +1,16 @@
 module Repres::Bootstrap::ApplicationHelper
 
+  #extend Repres::Bootstrap::FormHelper
+
   def bootstrap_form_field(options = {})
+    warn 'Repres::Bootstrap::ApplicationHelper#bootstrap_form_field is deprecated and will be removed in the future, please use Repres::Bootstrap::FormHelper#bootstrap_form_field instead.'
+    #super options
     render partial: 'repres/bootstrap/form_field', locals: { options: options }
   end
 
   def bootstrap_form_select_box(options = {})
+    warn 'Repres::Bootstrap::ApplicationHelper#bootstrap_form_select_box is deprecated and will be removed in the future, please use Repres::Bootstrap::FormHelper#bootstrap_form_select_box instead.'
+    #super options
     render partial: 'repres/bootstrap/form_select_box', locals: { options: options }
   end
 
@@ -16,4 +22,9 @@ module Repres::Bootstrap::ApplicationHelper
     render partial: 'repres/bootstrap/style', locals: { options: options }
   end
 
+  #class << self
+  #  deprecate bootstrap_form_field:      :'Repres::Bootstrap::ApplicationHelper.bootstrap_form_field',      deprecator: ActiveSupport::Deprecation.new('2.0', 'repres-bootstrap')
+  #  deprecate bootstrap_form_select_box: :'Repres::Bootstrap::ApplicationHelper.bootstrap_form_select_box', deprecator: ActiveSupport::Deprecation.new('2.0', 'repres-bootstrap')
+  #end
+
 end

data/app/helpers/repres/bootstrap/form_helper.rb

@@ -0,0 +1,11 @@
+module Repres::Bootstrap::FormHelper
+
+  def bootstrap_form_field(options = {})
+    render partial: 'repres/bootstrap/form_field', locals: { options: options }
+  end
+
+  def bootstrap_form_select_box(options = {})
+    render partial: 'repres/bootstrap/form_select_box', locals: { options: options }
+  end
+
+end

data/app/views/repres/bootstrap/_form_field.html.erb

@@ -38,6 +38,7 @@
       data:        input_data
     }
   input_options[:input_accept] = options[:input_accept] if options[:input_accept].present?
+  input_options[:rows]         = options[:rows]         if options[:rows].present?
 
   error_hidden = options[:error_hidden]
 %>

data/lib/generators/repres/bootstrap/platform/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate platform Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/repres/bootstrap/platform/platform_generator.rb

@@ -0,0 +1,320 @@
+# rails generate repres:bootstrap:platform administration --version 2
+
+class Repres::Bootstrap::PlatformGenerator < Rails::Generators::NamedBase
+
+  # https://github.com/erikhuda/thor/blob/master/lib/thor/base.rb#L273
+  class_option :version, type: :numeric, required: false, default: 1, desc: 'a positive integer, the default value is 1'
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  def generate_platform
+
+    puts "file_name  = #{file_name.inspect}"
+    puts "file_path  = #{file_path.inspect}"
+    puts "namespace  = #{namespace.inspect}"
+    puts "class_name = #{class_name.inspect}"
+    puts "class_path = #{class_path.inspect}"
+    puts "human_name = #{human_name.inspect}"
+    puts "options    = #{options.inspect}"
+
+    puts '---- ----'
+    puts "class_options = #{self.class.class_options.inspect}"
+
+    @platform_name  = file_name.downcase
+    @version_number = options['version'].to_i
+
+    #generate_route
+    #generate_concern
+    #generate_controller
+    #generate_layout_view
+    generate_shared_view
+
+  end
+
+  def define_namespace(content)
+    content.gsub! /PlatformModuleName/, platform_module_name
+    content.gsub! /VersionModuleName/,  version_module_name
+    content.gsub! /platform_name/,      platform_name
+    content.gsub! /version_name/,       version_name
+    content
+  end
+
+  # concern
+  #
+  #   app/controllers/concerns/priviledge_protection.rb
+  #
+  def generate_concern
+    copy_file 'app/controllers/concerns/priviledge_protection.rb'
+  end
+
+  # controller
+  #
+  #   app/controllers/platform/version/privileged_controller.rb
+  #   app/controllers/platform/version/dashboards_controller.rb
+  #
+  def generate_controller
+    copy_file('app/controllers/privileged_controller.rb', "app/controllers/#{platform_name}/#{version_name}/privileged_controller.rb") { |content| define_namespace content }
+    copy_file('app/controllers/dashboards_controller.rb', "app/controllers/#{platform_name}/#{version_name}/dashboards_controller.rb") { |content| define_namespace content }
+  end
+
+  # helper
+  #
+  #   app/helpers/administration/v1/helper.rb
+  #
+  def generate_helper
+  end
+
+  # layout_view
+  #
+  #   app/views/layouts/platform/version.html.erb
+  #
+  def generate_layout_view
+    copy_file('app/views/layouts/platform.html.erb', "app/views/layouts/#{platform_name}/#{version_name}.html.erb") { |content| define_namespace content }
+  end
+
+  # shared_view
+  #
+  #   app/views/shared/
+  #   app/views/platform/version/shared/_script.html.erb
+  #   app/views/platform/version/shared/_style.html.erb
+  #
+  def generate_shared_view
+    empty_directory 'app/views/shared'
+    copy_file('app/views/shared/_script.html.erb', "app/views/#{platform_name}/#{version_name}/shared/_script.html.erb") { |content| define_namespace content }
+    copy_file('app/views/shared/_style.html.erb',  "app/views/#{platform_name}/#{version_name}/shared/_style.html.erb")  { |content| define_namespace content }
+  end
+
+  # route
+  #
+  #   config/routes.rb
+  #
+  def generate_route
+    source = File.expand_path find_in_source_paths('config/routes.rb')
+    File.open(source, 'rb') do |f|
+      #route f.read.to_s.strip.gsub(/platform_name/, platform_name).gsub(/version_name/, version_name)
+      route define_namespace(f.read.to_s.strip)
+    end
+    #File.open(Pathname.new(self.class.source_root).join('config', 'routes.rb'), 'r') do |f|
+    #  route f.read.to_s.strip.gsub(/platform_name/, platform_name).gsub(/version_name/, version_name)
+    #end
+  end
+
+  # Administration
+  def platform_module_name
+    @platform_name.capitalize
+  end
+
+  # administration
+  def platform_name
+    @platform_name
+  end
+
+  # Administration::V1
+  def platform_version_module_name
+    "#{platform_module_name}::#{version_module_name}"
+  end
+
+  # V1
+  def version_module_name
+    "V#{version_number}"
+  end
+
+  # v1
+  def version_name
+    "v#{version_number}"
+  end
+
+  # 1
+  def version_number
+    @version_number
+  end
+
+  private :define_namespace, :generate_concern, :generate_controller,
+    :generate_helper, :generate_layout_view, :generate_shared_view, :generate_route,
+    :platform_module_name, :platform_name, :platform_version_module_name,
+    :version_module_name, :version_name, :version_number
+
+end
+
+
+=begin install or application
+
+    ROADMAP.md
+      # Picasso 线路图
+      ## v1.0
+
+    CHANGELOG.md
+      # Picasso 变更日志
+      ## v1.0
+
+    DEPLOYMENT.md
+# Picasso 发布手册
+
+
+
+## 环境变量
+
+### 基础安全钥匙
+引用文件： __config/secrets.yml__
+- __XXXXXX_SECRET_KEY_BASE__ 基础安全钥匙。开发和测试模式下，已经生成128个字符的随机字符串，生产环境则无缺省值，需要在Web服务器中配置。一旦Web应用上线，则不能修改。
+
+### 数据库
+引用文件： __config/database.yml__
+- __XXXXXX_DATABASE_HOST__ 数据库服务器的主机IP或域名。尽量用内网IP避免消耗公网流量。缺省为 'localhost'。
+- __XXXXXX_DATABASE_PORT__ 数据库服务器的端口号。缺省为 5432。
+- __XXXXXX_DATABASE_POOL__ 数据库服务器的连接池的数量。所有连接到同一台数据库服务器的连接池数量的总和，应比数据库服务器允许的最大连接数小 1。缺省为 200。
+- __XXXXXX_DATABASE_NAME__ 连接的数据库名称。缺省为 'xxxxxx' 。
+- __XXXXXX_DATABASE_ADAPTER__  连接数据库服务器的驱动名称。缺省为 'postgresql' 。
+- __XXXXXX_DATABASE_ENCODING__ 连接数据库服务器的字符编码集。缺省为 'unicode' 。
+- __XXXXXX_DATABASE_USERNAME__ 连接数据库服务器的用户名。缺省为 'developer' 。
+- __XXXXXX_DATABASE_PASSWORD__ 连接数据库服务器的密码。缺省为 'password' 。
+
+### 分页
+引用文件： __config/application.rb__
+- __XXXXXX_PER_PAGE__        Web UI 的列表的每页条数的缺省值，缺省值为10。
+- __XXXXXX_DOSSER_PER_PAGE__ Dosser API 的列表的每页条数的缺省值，缺省值为5。
+
+### Swagger Web API 文档
+引用文件： __config/initializers/swagger_engine.rb__
+- __XXXXXX_SWAGGER_USERNAME__ Swagger交互式文档系统的用户名，缺省值为 swagger。
+- __XXXXXX_SWAGGER_PASSWORD__ Swagger交互式文档系统的密码，缺省值为 xxxxxx。
+
+### 主服务
+引用文件： __config/application.rb__
+- __XXXXXX_PICASSO_ADMINISTRATION_PORTAL_DOSSER_LINK__ 位置跟踪微能力的系统管理平台的门户链接。缺省值为 http://xxxxxx.alpha/administration-api/v1/portals/~.json 。
+- __XXXXXX_PICASSO_GOVERNANCE_PORTAL_DOSSER_LINK__     位置跟踪微能力的行政管理平台的门户链接。缺省值为 http://xxxxxx.alpha/governance-api/v1/portals/~.json 。
+- __XXXXXX_PICASSO_PRACTITION_PORTAL_DOSSER_LINK__     位置跟踪微能力的从业人员平台的门户链接。缺省值为 http://xxxxxx.alpha/practition-api/v1/portals/~.json 。
+
+## 发布指令
+
+### v1.0
+1. bundle exec rake db:create
+2. bundle exec rake db:migrate
+3. bundle exec rake db:seed
+4. bundle exec rake assets:precompile
+
+=end
+
+
+
+=begin interface == bootstrap
+
+    route
+
+      namespace :administration do
+        namespace :v1 do
+          resources :dashboards, only: :show
+        end
+      end
+
+    concern
+
+?     app/controllers/concerns/priviledge_protection.rb
+
+    controller
+
+      app/controllers/administration/v1/privileged_controller.rb
+        class Administration::V1::PrivilegedController < ApplicationController
+          layout  'administration/v1'
+?         include PriviledgeProtection
+          helper  Administration::V1::Helper
+        end
+
+      app/controllers/administration/v1/dashboards_controller.rb
+        class Administration::V1::DashboardsController < Administration::V1::PrivilegedController
+          def show
+?           redirect_to administration_profiles_path(Unidom::Common::SELF)
+          end
+        end
+
+    layout_view
+
+      app/views/layouts/administration/v1.html.erb
+
+    shared_view
+
+      app/views/shared/
+      app/views/administration/v1/shared/
+      app/views/administration/v1/shared/_script.html.erb
+      app/views/administration/v1/shared/_style.html.erb
+
+    helper
+
+      app/helpers/administration/v1/helper.rb
+        module Administration::V1::Helper
+        end
+
+    image
+
+      app/assets/images/administration/v1/
+
+    shared_image
+
+      app/assets/images/shared/
+
+    style
+
+      app/assets/stylesheets/administration/v1/
+
+    shared_style
+
+      app/assets/stylesheets/shared/
+      app/assets/stylesheets/administration/v1/shared/
+
+    script
+
+      app/assets/javascripts/administration/v1/
+
+    shared_script
+
+      app/assets/javascripts/shared/
+      app/assets/javascripts/administration/v1/shared/
+
+=end
+
+
+
+=begin interface == swagger
+
+    gem
+
+      swagger
+
+    route
+
+      scope '/administration-api/v1', module: 'administration/dosser/v1', as: 'administration_dosser_v1' do
+        resources :portals, only: :show
+      end
+
+    controller
+
+      app/controllers/administration/dosser/v1/presentation_controller.rb
+        class Administration::Dosser::V1::PresentationController < ApplicationController
+          clear_helpers
+          include Repres::Dosser::Concerns::ResourcePresentation
+          layout  nil
+        end
+
+      app/controllers/administration/dosser/v1/portals_controller.rb
+        class Administration::Dosser::V1::::PortalsController < Administration::Dosser::V1::PresentationController
+          def show
+            self.criteria = { id: params[:id] }
+            render_ok collection: [
+              {
+                name:  'XX系统',
+                links: [
+                  { rel: 'self',                       href: administration_dosser_v1_portal_url(     Unidom::Common::SELF, format: request.format.symbol) },
+                  { rel: 'canonial',                   href: administration_dosser_v1_portal_url(     Unidom::Common::SELF, format: :json                ) },
+                  { rel: 'alternate',                  href: administration_dosser_v1_portal_url(     Unidom::Common::SELF, format: :xml                 ) },
+                  { rel: 'dosser/{action}/{resource}', href: administration_dosser_v1_{resources}_url(                      format: request.format.symbol) }
+                ]
+              }
+            ]
+          end
+        end
+
+    swagger
+
+      lib/swagger/administration_api_v1.json
+
+=end

data/lib/generators/repres/bootstrap/platform/templates/app/controllers/concerns/priviledge_protection.rb

@@ -0,0 +1,22 @@
+module PriviledgeProtection
+
+  extend ActiveSupport::Concern
+
+  included do |includer|
+
+    # include VisitorSession
+
+    before_action :protect_priviledge!
+
+    def protect_priviledge!
+
+      # The #legal_session? method & the #new_session_path method could be
+      # implemented in the Visitor Session concern or controller.
+      #
+      # redirect_to(new_session_path) and return unless legal_session?
+
+    end
+
+  end
+
+end

data/lib/generators/repres/bootstrap/platform/templates/app/controllers/dashboards_controller.rb

@@ -0,0 +1,7 @@
+class PlatformModuleName::VersionModuleName::DashboardsController < PlatformModuleName::VersionModuleName::PrivilegedController
+
+  def show
+    # redirect_to administration_profiles_path(Unidom::Common::SELF)
+  end
+
+end

data/lib/generators/repres/bootstrap/platform/templates/app/controllers/privileged_controller.rb

@@ -0,0 +1,9 @@
+class PlatformModuleName::VersionModuleName::PrivilegedController < ApplicationController
+
+  layout  'platform_name/version_name'
+
+  include PriviledgeProtection
+
+  helper  PlatformModuleName::VersionModuleName::Helper
+
+end

data/lib/generators/repres/bootstrap/platform/templates/app/views/layouts/platform.html.erb

@@ -0,0 +1,33 @@
+<!DOCTYPE html>
+
+<html lang='zh-CN'>
+<head>
+
+  <%= yield :meta %>
+
+  <title><%= yield :title %></title>
+
+  <%= hyper_text_style :'animate.css' => true, :buttons => true, :'font-awesome' => true %>
+  <%= bootstrap_style  :bootstrap => true, :'bootstrap-theme' => true, :'bootstrap-datepicker' => true, :'bootstrap-table' => true, :'bootstrap-fileinput' => true %>
+  <%= render partial: 'shared/style' %>
+  <%= render partial: 'platform_name/version_name/shared/style' %>
+
+  <%= yield :style %>
+
+  <%= csrf_meta_tags %>
+
+</head>
+<body>
+
+  <%= yield %>
+
+  <%= hyper_text_script jquery: true, modernizr: true %>
+  <%= bootstrap_script  :bootstrap => true, :'bootstrap-datepicker' => true, :'bootstrap-fileinput' => true, :'bootstrap-table' => true, :buttons => true %>
+  <%= render partial: 'shared/script' %>
+  <%= render partial: 'platform_name/version_name/shared/script' %>
+
+  <%= javascript_include_tag 'application' %>
+  <%= yield :script %>
+
+</body>
+</html>

data/lib/generators/repres/bootstrap/platform/templates/config/routes.rb

@@ -0,0 +1,5 @@
+  namespace :platform_name do
+    namespace :version_name do
+      resources :dashboards, only: :show
+    end
+  end

data/lib/repres/bootstrap/version.rb

@@ -1,5 +1,5 @@
 module Repres
   module Bootstrap
-    VERSION = '1.1'.freeze
+    VERSION = '1.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: repres-bootstrap
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: '1.2'
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-26 00:00:00.000000000 Z
+date: 2016-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -54,12 +54,22 @@ files:
 - app/assets/stylesheets/repres/bootstrap/application.css
 - app/controllers/repres/bootstrap/application_controller.rb
 - app/helpers/repres/bootstrap/application_helper.rb
+- app/helpers/repres/bootstrap/form_helper.rb
 - app/views/layouts/repres/bootstrap/application.html.erb
 - app/views/repres/bootstrap/_form_field.html.erb
 - app/views/repres/bootstrap/_form_select_box.html.erb
 - app/views/repres/bootstrap/_script.html.erb
 - app/views/repres/bootstrap/_style.html.erb
 - config/routes.rb
+- lib/generators/repres/bootstrap/platform/USAGE
+- lib/generators/repres/bootstrap/platform/platform_generator.rb
+- lib/generators/repres/bootstrap/platform/templates/app/controllers/concerns/priviledge_protection.rb
+- lib/generators/repres/bootstrap/platform/templates/app/controllers/dashboards_controller.rb
+- lib/generators/repres/bootstrap/platform/templates/app/controllers/privileged_controller.rb
+- lib/generators/repres/bootstrap/platform/templates/app/views/layouts/platform.html.erb
+- lib/generators/repres/bootstrap/platform/templates/app/views/shared/_script.html.erb
+- lib/generators/repres/bootstrap/platform/templates/app/views/shared/_style.html.erb
+- lib/generators/repres/bootstrap/platform/templates/config/routes.rb
 - lib/repres/bootstrap.rb
 - lib/repres/bootstrap/engine.rb
 - lib/repres/bootstrap/version.rb