wallaby-core 0.2.11 → 0.3.0.beta1

data/lib/generators/wallaby/engine/controller/templates/controller.rb.erb

@@ -0,0 +1,130 @@
+# @see https://github.com/wallaby-rails/wallaby/blob/master/docs/controller.md
+class <%= base_class %> < <%= parent_base_class %>
+  # Specify the model class if Wallaby doesn't get it right
+  # self.model_class = <%= model_name %>
+
+  # Specify the resource decorator if Wallaby doesn't get it right
+  # self.resource_decorator = <%= model_name %>Decorator
+
+  # Specify the model servicer if Wallaby doesn't get it right
+  # self.model_servicer = <%= model_name %>Servicer
+
+  # Specify the model authorizer if Wallaby doesn't get it right
+  # self.model_authorizer = <%= model_name %>Authorizer
+
+  # Specify the model paginator if Wallaby doesn't get it right
+  # self.model_paginator = <%= model_name %>Paginator
+
+  # Specify the max number of characters to truncate for index page
+  # self.max_text_length = 20
+
+  # Specify the default page size for pagination on index page
+  # config.page_size = 20
+
+  # Specify the sorting strategy to use. Valid values are:
+  #   :multiple - default value, sorting is allowed on multiple columns
+  #   :single - sorting is allowed on only one column
+  # config.sorting_strategy = :single
+
+  # Customize index page
+  # def index
+  #   # do something before the original action
+  #   index!(
+  #     location: nil # where to redirect when successful
+  #   ) do |format| # `respond_with` block
+  #     # do something here before rendering
+  #   end
+  # end
+
+  # Customize new page
+  # def new
+  #   # do something before the original action
+  #   new!(
+  #     location: nil # where to redirect when successful
+  #   ) do |format| # `respond_with` block
+  #     # do something here before rendering
+  #   end
+  # end
+
+  # Customize create action
+  # def create
+  #   # do something before the original action
+  #   create!(
+  #     params: nil, # params to use for the servicer
+  #     location: nil # where to redirect when successful
+  #   ) do |format| # `respond_with` block
+  #     # do something here before rendering
+  #   end
+  # end
+
+  # Customize show page
+  # def show
+  #   # do something before the original action
+  #   show!(
+  #     location: nil # where to redirect when successful
+  #   ) do |format| # `respond_with` block
+  #     # do something here before rendering
+  #   end
+  # end
+
+  # Customize edit page
+  # def edit
+  #   # do something before the original action
+  #   edit!(
+  #     location: nil # where to redirect when successful
+  #   ) do |format| # `respond_with` block
+  #     # do something here before rendering
+  #   end
+  # end
+
+  # Customize update action
+  # def update
+  #   # do something before the original action
+  #   update!(
+  #     params: nil, # params to use for the servicer
+  #     location: nil # where to redirect when successful
+  #   ) do |format| # `respond_with` block
+  #     # do something here before rendering
+  #   end
+  # end
+
+  # Customize destroy action
+  # def destroy
+  #   # do something before the original action
+  #   destroy!(
+  #     params: nil, # params to use for the servicer
+  #     location: nil # where to redirect when successful
+  #   ) do |format| # `respond_with` block
+  #     # do something here before rendering
+  #   end
+  # end
+
+  # Customize what parameters to be white-listed for mass assignment
+  # def resource_params
+  #   super # do something for all the subclasses
+  # end
+
+  # Customize how to return a collection
+  # def collection
+  #   collection!(
+  #     params: nil, # params to use for the servicer
+  #     paginate: true # whether to paginate the collection
+  #   ) do |records|
+  #     # do something here after original query is completed
+  #     # but before `@collection` instance variable is set
+  #     records
+  #   end
+  # end
+
+  # Customize how to return a resource
+  # def resource
+  #   resource!(
+  #     find_params: nil, # params/options for servicer's `find` action
+  #     new_params: nil # params/options for servicer's `new` action
+  #   ) do |record|
+  #     # do something here after original query is completed
+  #     # but before `@resource` instance variable is set
+  #     record
+  #   end
+  # end
+end

data/lib/generators/wallaby/engine/decorator/USAGE

@@ -0,0 +1,20 @@
+Description:
+    Generate decorator for Wallaby Engine usage by given NAME.
+    It also takes the PARENT name and makes the generated decorator inherit from the PARENT.
+
+    For example, if 'apple' is provided as the NAME, this generator will carry out the following items:
+    - Generate AppleDecorator that inherits from Wallaby Engine's application decorator.
+
+Example:
+    rails generate wallaby:engine:decorator admin/user
+
+    This will create:
+    - app/decorators/admin/user_decorator.rb
+
+Example:
+    rails generate wallaby:engine:decorator admin/user admin/application
+
+    This will create:
+    - app/decorators/admin/user_decorator.rb
+
+    And it makes Admin::UserDecorator class inherit from Admin::ApplicationDecorator

data/lib/generators/wallaby/engine/decorator/decorator_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../application_generator'
+
+module Wallaby
+  class Engine
+    # `wallaby:engine:decorator` generator
+    # @see https://github.com/wallaby-rails/wallaby-core/blob/master/lib/generators/wallaby/engine/decorator/USAGE
+    class DecoratorGenerator < ApplicationGenerator
+      source_root File.expand_path('templates', __dir__)
+
+      protected
+
+      def base_name
+        'decorator'
+      end
+    end
+  end
+end

data/lib/generators/wallaby/engine/decorator/templates/decorator.rb.erb

@@ -0,0 +1,5 @@
+# @see https://github.com/wallaby-rails/wallaby/blob/master/docs/decorator.md
+class <%= base_class %> < <%= parent_base_class %>
+  # Specify the model class if Wallaby doesn't get it right
+  # self.model_class = <%= model_name %>
+end

data/lib/generators/wallaby/engine/install/USAGE

@@ -0,0 +1,19 @@
+Description:
+    Install Wallaby Engine at the given NAME (default to 'admin').
+
+    For example, if 'admin' is provided as the NAME, this generator will carry out the following items:
+    - Mounting Wallaby Engine to `/admin` in `config/routes.rb`.
+    - Create initializer file `config/initializers/wallaby.rb`.
+    - Create basic application controller/decorator/servicer under camelized namespace `Admin`.
+    - Optionally, application authorizer and paginator can be created as well.
+
+Example:
+    rails generate wallaby:engine:install admin --include-authorizer --include-paginator
+
+    This will create:
+    - config/initializer/wallaby.rb
+    - app/controllers/admin/application_controller.rb
+    - app/decorators/admin/application_decorator.rb
+    - app/servicers/admin/application_servicer.rb
+    - app/authorizers/admin/application_authorizer.rb
+    - app/paginators/admin/application_paginator.rb

data/lib/generators/wallaby/engine/install/install_generator.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Wallaby
+  class Engine
+    # `wallaby:engine:install` generator
+    class InstallGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+      argument :name, type: :string, default: 'admin'
+
+      class_option \
+        :mount_only,
+        type: :boolean, default: false,
+        aliases: :'-m',
+        desc: 'Only mount Wallaby to given name.'
+
+      class_option \
+        :include_authorizer,
+        aliases: :'-a',
+        type: :boolean, default: false,
+        desc: 'Include to generate application authorizer.'
+
+      class_option \
+        :include_paginator,
+        aliases: :'-g',
+        type: :boolean, default: false,
+        desc: 'Include to generate application paginator.'
+
+      class_option \
+        :include_partials,
+        aliases: :'-v',
+        type: :string, default: nil,
+        desc: 'Include to generate application partials'
+
+      # @see https://github.com/wallaby-rails/wallaby-core/blob/master/lib/generators/wallaby/engine/install/USAGE
+      def install
+        mount_wallaby_to_given_name
+        return if options[:mount_only]
+
+        create_wallaby_initializer_file
+        create_application_files
+      end
+
+      protected
+
+      # Helper method for the template to comment out a line
+      def commenting
+        (file_name == self.class.arguments.first.default && '# ') || ''
+      end
+
+      def mount_wallaby_to_given_name # :nodoc:
+        route %(wallaby_mount at: '/#{file_name}')
+      rescue StandardError => e
+        Rails.logger.error "WARNING: #{e.message}"
+      end
+
+      def create_wallaby_initializer_file # :nodoc:
+        template 'initializer.rb.erb', 'config/initializers/wallaby.rb'
+      end
+
+      def create_application_files # :nodoc:
+        create_basic_files
+        create_application_authorizer if options[:include_authorizer]
+        create_application_paginator if options[:include_paginator]
+        create_application_partials if options[:include_partials]
+      end
+
+      def create_basic_files # :nodoc:
+        template 'application_controller.rb.erb', "app/controllers/#{file_name}/application_controller.rb"
+        template 'application_decorator.rb.erb', "app/decorators/#{file_name}/application_decorator.rb"
+        template 'application_servicer.rb.erb', "app/servicers/#{file_name}/application_servicer.rb"
+      end
+
+      def create_application_authorizer # :nodoc:
+        template 'application_authorizer.rb.erb', "app/authorizers/#{file_name}/application_authorizer.rb"
+      end
+
+      def create_application_paginator # :nodoc:
+        template 'application_paginator.rb.erb', "app/paginators/#{file_name}/application_paginator.rb"
+      end
+
+      def create_application_partials # :nodoc:
+        task =
+          case options[:include_partials]
+          when 'include_partials', true then 'wallaby:engine:partials'
+          else options[:include_partials]
+          end
+        invoke task, [name]
+      end
+    end
+  end
+end

data/lib/generators/wallaby/engine/install/templates/application_authorizer.rb.erb

@@ -0,0 +1,37 @@
+module <%= class_name %>
+  # @see https://github.com/wallaby-rails/wallaby/blob/master/docs/authorizer.md
+  class ApplicationAuthorizer < Wallaby::ModelAuthorizer
+    # Mark current class as base/abstract
+    base_class!
+
+    # Specify which provider (:cancancan, :pundit or :default) to use.
+    # :default means no authorization will be in use.
+    # self.provider_name = :cancancan
+
+    # Check user's permission for given action on given subject.
+    # Raise Wallaby::Forbidden if user doesn't have permission
+    # def authorize(action, subject)
+    #   super # do something for all the subclasses
+    # end
+
+    # Check and see if user is allowed to perform an action on given subject.
+    # def authorized?(action, subject)
+    #   super # do something for all the subclasses
+    # end
+
+    # Filter the scope based on user's permission.
+    # def accessible_for(action, scope)
+    #   super # do something for all the subclasses
+    # end
+
+    # Assign the values based on user's permission.
+    # def attributes_for(action, subject)
+    #   super # do something for all the subclasses
+    # end
+
+    # Allowlist the parameters based on user's permission.
+    # def permit_params(action, subject)
+    #   super # do something for all the subclasses
+    # end
+  end
+end

data/lib/generators/wallaby/engine/install/templates/application_controller.rb.erb

@@ -0,0 +1,173 @@
+module <%= class_name %>
+  # @see https://github.com/wallaby-rails/wallaby/blob/master/docs/controller.md
+  class ApplicationController < Wallaby::ResourcesController
+    # Mark current class as base/abstract
+    base_class!
+
+    # Specify the responder
+    # self.responder = Wallaby::ResourcesResponder
+
+    # Specify the theme_name
+    # self.theme_name = '<%= file_name %>/application'
+
+    # Specify the engine name.
+    # It should be the same as the option `:as` for mounting Wallaby::Engine
+    # self.engine_name = 'wallaby_engine'
+
+    # Specify the application/base decorator
+    # self.application_decorator = <%= class_name %>::ApplicationDecorator
+
+    # Specify the application/base servicer
+    # self.application_servicer = <%= class_name %>::ApplicationServicer
+
+    # Specify the application/base authorizer
+    # self.application_authorizer = <%= class_name %>::ApplicationAuthorizer
+
+    # Specify the application/base paginator
+    # self.application_paginator = <%= class_name %>::ApplicationPaginator
+
+    # Specify the models that Wallaby should handle.
+    # NOTE: Once this is set, Wallaby will ignore `models_to_exclude` configuration
+    # self.models = User
+
+    # Specify the models that Wallaby should exclude. It's used by the models navigation in the header.
+    # self.models_to_exclude = ::ActiveRecord::SchemaMigration
+
+    # Specify the logout url helper method name that Wallaby uses to log user out
+    # self.logout_path = :logout_path
+
+    # Specify the HTTP verb for logging out a user
+    # self.logout_method = :delete
+
+    # Specify the method name that Wallaby uses to retrieve email from for user portrait display using gravatar.
+    # self.email_method = :email
+
+    # Specify the max number of characters to truncate for index page
+    # self.max_text_length = 20
+
+    # Specify the default page size for pagination on index page
+    # config.page_size = 20
+
+    # Specify the sorting strategy to use. Valid values are:
+    #   :multiple - default value, sorting is allowed on multiple columns
+    #   :single - sorting is allowed on only one column
+    # config.sorting_strategy = :single
+
+    # Customize how to authenticate a user. If a user is not authenticated, redirect them to the sign in page.
+    # def authenticate_wallaby_user!
+    #   super # do something for all the subclasses
+    # end
+
+    # Customize how to return user record
+    # def wallaby_user
+    #   super # do something for all the subclasses
+    # end
+
+    # Customize landing page
+    # def home
+    #   super # do something for all the subclasses
+    # end
+
+    # Customize index page
+    # def index
+    #   # do something before the original action
+    #   index!(
+    #     location: nil # where to redirect when successful
+    #   ) do |format| # `respond_with` block
+    #     # do something here before rendering
+    #   end
+    # end
+
+    # Customize new page
+    # def new
+    #   # do something before the original action
+    #   new!(
+    #     location: nil # where to redirect when successful
+    #   ) do |format| # `respond_with` block
+    #     # do something here before rendering
+    #   end
+    # end
+
+    # Customize create action
+    # def create
+    #   # do something before the original action
+    #   create!(
+    #     params: nil, # params to use for the servicer
+    #     location: nil # where to redirect when successful
+    #   ) do |format| # `respond_with` block
+    #     # do something here before rendering
+    #   end
+    # end
+
+    # Customize show page
+    # def show
+    #   # do something before the original action
+    #   show!(
+    #     location: nil # where to redirect when successful
+    #   ) do |format| # `respond_with` block
+    #     # do something here before rendering
+    #   end
+    # end
+
+    # Customize edit page
+    # def edit
+    #   # do something before the original action
+    #   edit!(
+    #     location: nil # where to redirect when successful
+    #   ) do |format| # `respond_with` block
+    #     # do something here before rendering
+    #   end
+    # end
+
+    # Customize update action
+    # def update
+    #   # do something before the original action
+    #   update!(
+    #     params: nil, # params to use for the servicer
+    #     location: nil # where to redirect when successful
+    #   ) do |format| # `respond_with` block
+    #     # do something here before rendering
+    #   end
+    # end
+
+    # Customize destroy action
+    # def destroy
+    #   # do something before the original action
+    #   destroy!(
+    #     params: nil, # params to use for the servicer
+    #     location: nil # where to redirect when successful
+    #   ) do |format| # `respond_with` block
+    #     # do something here before rendering
+    #   end
+    # end
+
+    # Customize what parameters to be white-listed for mass assignment
+    # def resource_params
+    #   super # do something for all the subclasses
+    # end
+
+    # Customize how to return a collection
+    # def collection
+    #   collection!(
+    #     params: nil, # params to use for the servicer
+    #     paginate: true # whether to paginate the collection
+    #   ) do |records|
+    #     # do something here after original query is completed
+    #     # but before `@collection` instance variable is set
+    #     records
+    #   end
+    # end
+
+    # Customize how to return a resource
+    # def resource
+    #   resource!(
+    #     find_params: nil, # params/options for servicer's `find` action
+    #     new_params: nil # params/options for servicer's `new` action
+    #   ) do |record|
+    #     # do something here after original query is completed
+    #     # but before `@resource` instance variable is set
+    #     record
+    #   end
+    # end
+  end
+end

data/lib/generators/wallaby/engine/install/templates/application_decorator.rb.erb

@@ -0,0 +1,7 @@
+module <%= class_name %>
+  # @see https://github.com/wallaby-rails/wallaby/blob/master/docs/decorator.md
+  class ApplicationDecorator < Wallaby::ResourceDecorator
+    # Mark current class as base/abstract
+    base_class!
+  end
+end

data/lib/generators/wallaby/engine/install/templates/application_paginator.rb.erb

@@ -0,0 +1,27 @@
+module <%= class_name %>
+  # @see https://github.com/wallaby-rails/wallaby/blob/master/docs/paginator.md
+  class ApplicationPaginator < Wallaby::ModelPaginator
+    # Mark current class as base/abstract
+    base_class!
+
+    # Check if the collection can be paginated
+    # def paginatable?
+    #   super # do something for all the subclasses
+    # end
+
+    # Total count of the collection
+    # def total
+    #   super # do something for all the subclasses
+    # end
+
+    # Page size
+    # def page_size
+    #   super # do something for all the subclasses
+    # end
+
+    # Page number
+    # def page_number
+    #   super # do something for all the subclasses
+    # end
+  end
+end

data/lib/generators/wallaby/engine/install/templates/application_servicer.rb.erb

@@ -0,0 +1,47 @@
+module <%= class_name %>
+  # @see https://github.com/wallaby-rails/wallaby/blob/master/docs/servicer.md
+  class ApplicationServicer < Wallaby::ModelServicer
+    # Mark current class as base/abstract
+    base_class!
+
+    # Allowlist parameters for mass assignment
+    # def permit(params, action)
+    #   super # do something for all the subclasses
+    # end
+
+    # Fetch collection by given params
+    # def collection(params)
+    #   super # do something for all the subclasses
+    # end
+
+    # Paginate the collection
+    # def paginate(query, params)
+    #   super # do something for all the subclasses
+    # end
+
+    # Initialize the model class using given params
+    # def new(params)
+    #   super # do something for all the subclasses
+    # end
+
+    # Find a resource using id
+    # def find(id, params)
+    #   super # do something for all the subclasses
+    # end
+
+    # Save the newly initialized resource
+    # def create(resource, params)
+    #   super # do something for all the subclasses
+    # end
+
+    # Update the persisted resource
+    # def update(resource, params)
+    #   super # do something for all the subclasses
+    # end
+
+    # Destroy the given resource
+    # def destroy(resource, params)
+    #   super # do something for all the subclasses
+    # end
+  end
+end

data/lib/generators/wallaby/engine/install/templates/initializer.rb.erb

@@ -0,0 +1,16 @@
+Wallaby.config do |config|
+  # Specify the relative folders where model resides.
+  # Please checkout `Rails.configuration.eager_load_paths` for the folders that can be set.
+  # config.model_paths = %w(app/models)
+
+  # Specify the base controller class that Wallaby::ResourcesController should inherit from.
+  # config.base_controller = ::ApplicationController
+
+  # Specify admin application controller for Wallaby::Engine
+  <%= commenting %>config.resources_controller = <%= class_name %>::ApplicationController
+
+  # Specify the non ActiveModel-like (ActiveRecord/Her) models that Wallaby should treat as Custom.
+  # Once it's set, you will need to implement an servicer for the Custom models.
+  # @see https://github.com/wallaby-rails/wallaby/blob/master/docs/custom.md#customization
+  # config.custom_models = [Array]
+end

data/lib/generators/wallaby/engine/paginator/USAGE

@@ -0,0 +1,20 @@
+Description:
+    Generate paginator for Wallaby Engine usage by given NAME.
+    It also takes the PARENT name and makes the generated paginator inherit from the PARENT.
+
+    For example, if 'apple' is provided as the NAME, this generator will carry out the following items:
+    - Generate ApplePaginator that inherits from Wallaby Engine's application paginator.
+
+Example:
+    rails generate wallaby:engine:paginator admin/user
+
+    This will create:
+    - app/paginators/admin/user_paginator.rb
+
+Example:
+    rails generate wallaby:engine:paginator admin/user admin/application
+
+    This will create:
+    - app/paginators/admin/user_paginator.rb
+
+    And it makes Admin::UserPaginator class inherit from Admin::ApplicationPaginator

data/lib/generators/wallaby/engine/paginator/paginator_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../application_generator'
+
+module Wallaby
+  class Engine
+    # `wallaby:engine:paginator` generator
+    # @see https://github.com/wallaby-rails/wallaby-core/blob/master/lib/generators/wallaby/engine/paginator/USAGE
+    class PaginatorGenerator < ApplicationGenerator
+      source_root File.expand_path('templates', __dir__)
+
+      protected
+
+      def base_name
+        'paginator'
+      end
+    end
+  end
+end

data/lib/generators/wallaby/engine/paginator/templates/paginator.rb.erb

@@ -0,0 +1,25 @@
+# @see https://github.com/wallaby-rails/wallaby/blob/master/docs/paginator.md
+class <%= base_class %> < <%= parent_base_class %>
+  # Specify the model class if Wallaby doesn't get it right
+  # self.model_class = <%= model_name %>
+
+  # Check if the collection can be paginated
+  # def paginatable?
+  #   super # do something for all the subclasses
+  # end
+
+  # Total count of the collection
+  # def total
+  #   super # do something for all the subclasses
+  # end
+
+  # Page size
+  # def page_size
+  #   super # do something for all the subclasses
+  # end
+
+  # Page number
+  # def page_number
+  #   super # do something for all the subclasses
+  # end
+end