implement all of jonas' feedback so far

Author: pascalwengerter

lib/generators/matestack_app/USAGE

@@ -1,11 +1,21 @@
 Description:
-    This generator scaffolds a matestack app for your Rails application!
-    Mandatory input: NAME
-    Optional input to add an app controller: controller
+    Stubs out a new matestack app. Pass the app name under_scored.
 
-Examples:
-    rails generate matestack_app example_app (--controller)
+    If you want so, pass the option '--all_inclusive' to also create
+    a corresponding matestack example_page, a controller, its action
+    and the route in 'config/routes.rb'.
+
+Example 1:
+    `rails generate matestack_app example_app`
+
+    This will create:
+        app/matestack/apps/example_app.rb
+
+Example 2:
+`rails generate matestack_app example_app --all_inclusive`
 
     This will create:
         app/matestack/apps/example_app.rb
-        (app/controllers/example_app_controller.rb)
+        app/matestack/pages/example_app/example_page.rb
+        app/controllers/example_app_controller.rb
+        route  get 'example_app/example_page', to: 'example_app#example_page'

lib/generators/matestack_app/matestack_app_generator.rb

@@ -1,21 +1,26 @@
 class MatestackAppGenerator < Rails::Generators::NamedBase
   source_root File.expand_path('templates', __dir__)
 
-  class_option :controller, type: :boolean, default: false
+  class_option :all_inclusive, type: :boolean, default: false
 
   def create_matestack_app
 
     generator_path = "app/matestack/apps/#{file_name}.rb"
 
     template 'matestack_app.erb', generator_path
 
-    create_matestack_app_controller if options[:controller] == true 
+    if options[:all_inclusive] == true
+      controller_path = "app/controllers/#{file_name}_controller.rb"
+      template 'matestack_app_controller.erb', controller_path
 
-  end
+      route %{get '#{file_name}/example_page', to: '#{file_name}\#example_page'}
+
+      generate "matestack_page example_page --app_name #{file_name} --called_by_app_generator=true"
+
+      puts "You can visit your new matestack apps' example page under http://localhost:3000/#{file_name}/example_page"
+
+    end
 
-  def create_matestack_app_controller
-    controller_path = "app/controllers/#{file_name}_controller.rb"
-    template 'matestack_app_controller.erb', controller_path
   end
 
 end

lib/generators/matestack_app/templates/matestack_app.erb

@@ -14,7 +14,7 @@ end
 
 # OPTIONAL: Use partials to render stuff like layout components
 # def partial_one
-#   components {
+#   partial {
 #     # your components go here
 #   }
 # end

lib/generators/matestack_app/templates/matestack_app_controller.erb

@@ -1,8 +1,6 @@
 class <%= class_name %>Controller < ApplicationController
 
-  # This is what the controller action for an ExamplePage for
-  # your <%= class_name %> matestack app looks like
-  def show
+  def example_page
     responder_for(Pages::<%= class_name %>::ExamplePage)
   end
 

lib/generators/matestack_component/USAGE

@@ -1,11 +1,20 @@
 Description:
-    Generates matestack components to app/matestack/components
+    Stubs out a new matestack component. Pass the component name, under_scored.
 
-Example:
-    rails generate matestack_component NAME --(no-)dynamic --(no-)haml --(no-)scss
+    To create a dynamic component, specify it using the --dynamic option.
+
+    To place this component within a namespace, specify the namespace name under_scored and it
+    will get generated into 'app/matestack/components/namespace/*'.
+
+Example 1:
+    `rails generate matestack_component NAME`
 
     This will create:
         app/matestack/components/NAME.rb
-        (app/matestack/components/NAME.js if --dynamic)
-        (app/matestack/components/NAME.haml if --haml)
-        (app/matestack/components/NAME.scss if --scss)
+
+Example 2:
+    `rails generate matestack_component NAME --dynamic --namespace sample_namespace`
+
+    This will create:
+        app/matestack/components/sample_namespace/NAME.rb
+        app/matestack/components/sample_namespace/NAME.js

lib/generators/matestack_page/USAGE

@@ -1,10 +1,16 @@
 Description:
-    This generator scaffolds a matestack page for your Rails application!
-    Mandatory input: NAME and APP_NAME
-    Optional input to specify routing: controller_action
+    Stubs out a new matestack page and its route. Pass the page name and --app-name, both under_scored.
+
+    To place the page within a namespace, specify the namespace name under_scored and it
+    will get generated into 'app/matestack/pages/namespace/*'.
+
+    To create a custom controller#action to use in the created route, specify it as
+    under_scored_controller#under_scored_action
+
+    This generates a matestack page class in app/matestack/pages/ and adds a route to config/routes.rb
 
 Example 1:
-    rails generate matestack_page example_page example_app
+    `rails generate matestack_page example_page --app_name example_app`
 
     This will create:
         app/matestack/pages/example_app/example_page.rb
@@ -13,7 +19,7 @@ Example 1:
         get 'example_app/example_page', to: 'example_app#example_page'
 
 Example 2:
-    rails generate matestack_page example_page example_app --controller_action=static#second
+    `rails generate matestack_page example_page --app_name example_app --controller_action=static#second`
 
     This will create:
         app/matestack/pages/example_app/example_page.rb

lib/generators/matestack_page/matestack_page_generator.rb

@@ -1,37 +1,41 @@
 class MatestackPageGenerator < Rails::Generators::NamedBase
   source_root File.expand_path('templates', __dir__)
 
-  argument :app_name, type: :string, required: true
-
+  class_option :app_name, type: :string, required: true
+  class_option :namespace, type: :string
   class_option :controller_action, type: :string
+  class_option :called_by_app_generator, type: :boolean, default: false
 
   def create_matestack_page
-    @app_name = app_name
+    @app_name = options[:app_name]
+    @namespace = options[:namespace]
 
     if options[:controller_action].nil?
       @controller_action = "#{@app_name}\##{file_name}"
     else
       @controller_action = options[:controller_action]
     end
 
-    matestack_page_dir_path = "app/matestack/pages/#{@app_name}"
+    matestack_page_dir_path = "app/matestack/pages"
+    matestack_page_dir_path << "/#{@app_name}" unless @app_name.nil?
+    matestack_page_dir_path << "/#{@namespace}" unless @namespace.nil?
 
     generator_path = matestack_page_dir_path + "/#{file_name}.rb"
 
     template "matestack_page.erb", generator_path
 
-    route %{get '#{@app_name}/#{file_name}', to: '#{@controller_action}'}
-
-    puts "Make sure to add responder_for(Pages::#{@app_name.camelize}::#{file_name.camelize}) to #{@controller_action}"
+    unless options[:called_by_app_generator]
+      route %{get '#{@app_name}/#{@namespace}/#{file_name}', to: '#{@controller_action}'} unless @namespace.nil?
+      route %{get '#{@app_name}/#{file_name}', to: '#{@controller_action}'} if @namespace.nil?
+      puts "Page created! Make sure to modify"
+      puts ""
+      puts "def controller_action"
+      puts "  responder_for(Pages::#{@app_name.camelize}::#{@namespace.camelize}::#{file_name.camelize})" unless @namespace.nil?
+      puts "  responder_for(Pages::#{@app_name.camelize}::#{file_name.camelize})" if @namespace.nil?
+      puts "end"
+      puts ""
+      puts "and add it to the desired controller!"
+    end
 
-    # todo
-    # swap app and page input order
-    # - scaffold failing rspec test cases per default via options[:rspec]
-    # - check if spec/ folder exists in host system => if not, puts 'rspec test suite not found'
-    # - how-to https://relishapp.com/rspec/rspec-rails/docs/generators
-    # talk to jonas: do pages always belong to apps?
-    # - if yes: generate corresponding app if it does not exist
-    # - if yes: invoce `generate matestack_app` with ARGS => should create controller_action and view aswell
-    # generate "scaffold", "forums title:string description:text"
   end
 end

lib/generators/matestack_page/templates/matestack_page.erb

@@ -1,4 +1,4 @@
-class Pages::<% if @app_name.present? %><%= @app_name.camelize %>::<% end %><%= class_name %> < Matestack::Ui::Page
+class Pages::<% unless @namespace.nil? %><%= @namespace.camelize %>::<% end %><% unless @app_name.nil? %><%= @app_name.camelize %>::<% end %><%= class_name %> < Matestack::Ui::Page
 
 # OPTIONAL: Prepare data for the response method
 # def prepare
@@ -14,7 +14,7 @@ end
 
 # OPTIONAL: Partials come after the response
 # def partial_one
-#   components {
+#   partial {
 #     # your components go here
 #   }
 # end