repres-bootstrap 1.2 → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 390ec8fee400b93c2ce818b38fb703ff9da3df4f
-  data.tar.gz: ba1031a334964d10aaf38d9b17c219bd8bdc085d
+  metadata.gz: bf0d2aaf347c6aacf1c84fa71d47bf1796eb9d28
+  data.tar.gz: 76b475f28a6cb559c4119e52c731af05902287f0
 SHA512:
-  metadata.gz: 1a7972ff9a34818d87d243404e51ec56407f3e5f94db910b7ded5dd65b66b2294cc37880c6473652079c51b7ba4d92e60553bc5ec47880a4b74c8f15651b31d3
-  data.tar.gz: cd1ccae0fbd4599c0c41bbf075c2fa2eb64ee6046f5a0caf9d486601cf2935035a9134ed17cd98a6edae45b315c6623ac063af44234b3813fbfdee743a2373f8
+  metadata.gz: 3c3c5b510474d7bd30b3fa84e2f8a8bb6ec187b8b1e7287a345b46831bd2b3dfb4a62e5c8b3c74fce6405558e0dcee32af9a65872eefb18d4340e7b0506d26bc
+  data.tar.gz: 780b260280b843fbbb0db4c8366713e2005bc86d3590816e21c287138ef07227ffbf6523f6ad5977d2c032f8effd410c73a7364b48588bd67dd96a4f9cc1e271

data/README.md

@@ -210,3 +210,43 @@ Here are more options:
 - 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
+
+
+
+## Generators
+
+### Platform generator
+The platform generator generates a platform with a version number. The platform name is administration in the following example.
+```shell
+rails generate repres:bootstrap:platform administration --version 4
+```
+
+This will insert the following routings into the config/routes.rb file:
+```ruby
+namespace :administration do
+  namespace :v3 do
+    resources :dashboards, only: :show
+  end
+end
+```
+
+This will create the following files:
+```shell
+app/assets/images/administration/v4/.keep
+app/assets/images/shared/.keep
+app/assets/images/administration/v4/shared/.keep
+app/assets/javascripts/administration/v4/.keep
+app/assets/javascripts/shared/.keep
+app/assets/javascripts/administration/v4/shared/.keep
+app/assets/stylesheets/administration/v4/.keep
+app/assets/stylesheets/shared/.keep
+app/assets/stylesheets/administration/v4/shared/.keep
+app/controllers/concerns/priviledge_protection.rb
+app/controllers/administration/v4/privileged_controller.rb
+app/controllers/administration/v4/dashboards_controller.rb
+app/helpers/administration/v4/application_helper.rb
+app/views/layouts/administration/v4.html.erb
+app/views/shared/.keep
+app/views/administration/v4/shared/_script.html.erb
+app/views/administration/v4/shared/_style.html.erb
+```

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

@@ -1,8 +1,35 @@
 Description:
-    Explain the generator
+
+    Generate the platform scaffold for the Bootstrap framework.
 
 Example:
-    rails generate platform Thing
 
-    This will create:
-        what/will/it/create
+    rails generate repres:bootstrap:platform administration --version 4
+
+    This will insert the following routing into the config/routes.rb:
+
+        namespace :administration do
+          namespace :v4 do
+            resources :dashboards, only: :show
+          end
+        end
+
+    This will create the following files:
+
+        app/assets/images/administration/v4/.keep
+        app/assets/images/shared/.keep
+        app/assets/images/administration/v4/shared/.keep
+        app/assets/javascripts/administration/v4/.keep
+        app/assets/javascripts/shared/.keep
+        app/assets/javascripts/administration/v4/shared/.keep
+        app/assets/stylesheets/administration/v4/.keep
+        app/assets/stylesheets/shared/.keep
+        app/assets/stylesheets/administration/v4/shared/.keep
+        app/controllers/concerns/priviledge_protection.rb
+        app/controllers/administration/v4/privileged_controller.rb
+        app/controllers/administration/v4/dashboards_controller.rb
+        app/helpers/administration/v4/application_helper.rb
+        app/views/layouts/administration/v4.html.erb
+        app/views/shared/.keep
+        app/views/administration/v4/shared/_script.html.erb
+        app/views/administration/v4/shared/_style.html.erb

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

@@ -7,8 +7,9 @@ class Repres::Bootstrap::PlatformGenerator < Rails::Generators::NamedBase
 
   source_root File.expand_path('../templates', __FILE__)
 
-  def generate_platform
+  def produce
 
+=begin
     puts "file_name  = #{file_name.inspect}"
     puts "file_path  = #{file_path.inspect}"
     puts "namespace  = #{namespace.inspect}"
@@ -19,15 +20,27 @@ class Repres::Bootstrap::PlatformGenerator < Rails::Generators::NamedBase
 
     puts '---- ----'
     puts "class_options = #{self.class.class_options.inspect}"
+=end
 
     @platform_name  = file_name.downcase
     @version_number = options['version'].to_i
 
-    #generate_route
-    #generate_concern
-    #generate_controller
-    #generate_layout_view
-    generate_shared_view
+    generate_asset_image
+    generate_asset_image_shared
+    generate_asset_script
+    generate_asset_script_shared
+    generate_asset_style
+    generate_asset_style_shared
+
+    generate_concern
+    generate_controller
+
+    generate_helper
+
+    generate_view_layout
+    generate_view_shared
+
+    generate_route
 
   end
 
@@ -39,6 +52,67 @@ class Repres::Bootstrap::PlatformGenerator < Rails::Generators::NamedBase
     content
   end
 
+  # image
+  #
+  #   app/assets/images/platform/version/
+  #
+  def generate_asset_image
+    copy_file '.keep', "app/assets/images/#{platform_name}/#{version_name}/.keep"
+    #empty_directory "app/assets/images/#{platform_name}/#{version_name}"
+  end
+
+  # image_shared
+  #
+  #   app/assets/images/shared/
+  #
+  def generate_asset_image_shared
+    copy_file '.keep', 'app/assets/images/shared/.keep'
+    copy_file '.keep', "app/assets/images/#{platform_name}/#{version_name}/shared/.keep"
+    #empty_directory "app/assets/images/shared"
+  end
+
+  # script
+  #
+  #   app/assets/javascripts/platform/version/
+  #
+  def generate_asset_script
+    copy_file '.keep', "app/assets/javascripts/#{platform_name}/#{version_name}/.keep"
+    #empty_directory "app/assets/javascripts/#{platform_name}/#{version_name}"
+  end
+
+  # script_shared
+  #
+  #   app/assets/javascripts/shared/
+  #   app/assets/javascripts/platform/version/shared/
+  #
+  def generate_asset_script_shared
+    copy_file '.keep', 'app/assets/javascripts/shared/.keep'
+    copy_file '.keep', "app/assets/javascripts/#{platform_name}/#{version_name}/shared/.keep"
+    #empty_directory "app/assets/javascripts/shared"
+    #empty_directory "app/assets/javascripts/#{platform_name}/#{version_name}/shared"
+  end
+
+  # style
+  #
+  #   app/assets/stylesheets/platform/version/
+  #
+  def generate_asset_style
+    copy_file '.keep', "app/assets/stylesheets/#{platform_name}/#{version_name}/.keep"
+    #empty_directory "app/assets/stylesheets/#{platform_name}/#{version_name}"
+  end
+
+  # style_shared
+  #
+  #   app/assets/stylesheets/shared/
+  #   app/assets/stylesheets/platform/version/shared/
+  #
+  def generate_asset_style_shared
+    copy_file '.keep', 'app/assets/stylesheets/shared/.keep'
+    copy_file '.keep', "app/assets/stylesheets/#{platform_name}/#{version_name}/shared/.keep"
+    #empty_directory "app/assets/stylesheets/shared"
+    #empty_directory "app/assets/stylesheets/#{platform_name}/#{version_name}/shared"
+  end
+
   # concern
   #
   #   app/controllers/concerns/priviledge_protection.rb
@@ -59,49 +133,46 @@ class Repres::Bootstrap::PlatformGenerator < Rails::Generators::NamedBase
 
   # helper
   #
-  #   app/helpers/administration/v1/helper.rb
+  #   app/helpers/platform/version/helper.rb
   #
   def generate_helper
+    copy_file('app/helpers/platform_helper.rb', "app/helpers/#{platform_name}/#{version_name}/application_helper.rb") { |content| define_namespace content }
   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
+  # view_shared
   #
   #   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'
+  def generate_view_shared
+    #empty_directory 'app/views/shared'
+    copy_file '.keep', 'app/views/shared/.keep'
     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
 
+  # view_layout
+  #
+  #   app/views/layouts/platform/version.html.erb
+  #
+  def generate_view_layout
+    copy_file('app/views/layouts/platform.html.erb', "app/views/layouts/#{platform_name}/#{version_name}.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
+    File.open(source, 'rb') { |f| route define_namespace(f.read.to_s.strip) }
   end
 
   # Administration
   def platform_module_name
-    @platform_name.capitalize
+    #@platform_name.capitalize
+    @platform_name.camelize
   end
 
   # administration
@@ -129,10 +200,15 @@ class Repres::Bootstrap::PlatformGenerator < Rails::Generators::NamedBase
     @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
+  private :define_namespace,
+    :generate_asset_image,  :generate_asset_image_shared,
+    :generate_asset_script, :generate_asset_script_shared,
+    :generate_asset_style,  :generate_asset_style_shared,
+    :generate_concern,      :generate_controller,          :generate_helper,
+    :generate_view_layout,  :generate_view_shared,
+    :generate_route,
+    :platform_module_name,  :platform_name, :platform_version_module_name,
+    :version_module_name,   :version_name,  :version_number
 
 end
 
@@ -196,125 +272,3 @@ end
 =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/helpers/platform_helper.rb

@@ -0,0 +1,6 @@
+module PlatformModuleName::VersionModuleName::ApplicationHelper
+
+  # def helper_method
+  # end
+
+end

data/lib/repres/bootstrap/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: repres-bootstrap
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: '1.3'
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-30 00:00:00.000000000 Z
+date: 2016-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,6 +66,7 @@ files:
 - 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/helpers/platform_helper.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