wallaby-core 0.2.0 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52359ec55f58d6479a497e4d8bb412d2ff4e2a22781abb034721a580d6321a87
-  data.tar.gz: 14009b74724c111574addf3869e4f2bc5b96eae721a40a61c9885773bfb7eb05
+  metadata.gz: 549512f63ab75eb29715ca2842daba07744482836896ddbf8d58ee873eeda983
+  data.tar.gz: 7997ba9973a504145d363673a5ea222013358673601cb0304bdf6d22a74b927e
 SHA512:
-  metadata.gz: 7e772e4457e4892ad725f6d0e65de0854f7cafeaa163c00fb3c4f3c9d88c44e25623bfe5b26fca01454e1bf2facf5d4f904c65a2bdf278ff3a22945679c0054b
-  data.tar.gz: a0a7fa9c558e05e8e62b4570265d4e2d1f063960550bf06148535be0cbb7aa571d416e932419cd0493b209e21c0ab249766de1299105eedbb62e5c3d416e902d
+  metadata.gz: 2eaff56ae4c69091a6de82f5ae4e067b65490aec8b76a54ff602b6714957e4ccf90b6ddec573032868941d5868bccde3c000ee038cb19dfe8d0cfc5fa12cf08e
+  data.tar.gz: 55c273983a048eb454248efe777b2abb9fb72e4a969792b3d33483b5b4944740ca1555e98fb41b25c558188420cb5a27fbd9c3aa5094786ee623fc6b81a3522f

data/README.md

@@ -7,7 +7,7 @@
 [![Test Coverage](https://api.codeclimate.com/v1/badges/f16f8d87553424c1aacc/test_coverage)](https://codeclimate.com/github/wallaby-rails/wallaby-core/test_coverage)
 [![Inch CI](https://inch-ci.org/github/wallaby-rails/wallaby-core.svg?branch=master)](https://inch-ci.org/github/wallaby-rails/wallaby-core)
 
-Wallaby::Core contains all the core interfaces that [Wallaby](https://github.com/wallaby-rails/wallaby) gem is built upon.
+**Wallaby::Core** holds all the core interfaces that [Wallaby](https://github.com/wallaby-rails/wallaby) gem is built upon.
 
 ## Install
 
@@ -28,6 +28,47 @@ bundle install
 - [API Reference](https://www.rubydoc.info/gems/wallaby-core)
 - [Change Logs](https://github.com/wallaby-rails/wallaby-core/blob/master/CHANGELOG.md)
 
+## Build, test and update document
+
+To set up local development environment:
+
+- git clone this repo
+- install Ruby (2.4 ~ 3.0)
+- install gems
+
+  ```shell
+  bundle install
+  ```
+
+- install both MySQL and PostgreSQL
+- create databases
+
+  ```shell
+  bundle exec rake db:create
+  ```
+
+- start developing
+
+  Make sure to pass the following checks and tests before putting up a PR:
+
+  - rubocop analysis and format check
+
+    ```shell
+    bundle exec rubocop -a
+    ```
+
+  - rspec test suites and 100% test coverage
+
+    ```shell
+    RAILS_ENV=test bundle exec rake --trace spec
+    ```
+
+  - update the comments and build the yardoc
+
+    ```shell
+    yardoc
+    ```
+
 ## Want to contribute?
 
 Raise an [issue](https://github.com/wallaby-rails/wallaby-core/issues/new), discuss and resolve!

data/app/controllers/wallaby/resources_controller.rb

@@ -1,382 +1,22 @@
 # frozen_string_literal: true
 
 module Wallaby
+  ResourcesController = Class.new configuration.base_controller
+
   # Resources controller, superclass for all customization controllers.
-  # It contains CRUD template action methods (`index`/`new`/`create`/`edit`/`update`/`destroy`)
+  # It contains CRUD template action methods
+  # ({Wallaby::ResourcesConcern#index #index} / {Wallaby::ResourcesConcern#new #new}
+  # / {Wallaby::ResourcesConcern#create #create} / {Wallaby::ResourcesConcern#edit #edit}
+  # / {Wallaby::ResourcesConcern#update #update} / {Wallaby::ResourcesConcern#destroy #destroy})
   # that allow subclasses to override.
-  class ResourcesController < ::Wallaby::SecureController
-    extend Authorizable::ClassMethods
-    extend Baseable::ClassMethods
-    extend Decoratable::ClassMethods
-    extend Paginatable::ClassMethods
-    extend Resourcable::ClassMethods
-    extend Servicable::ClassMethods
-
-    include View
-    prepend Prefixable
-
-    include Authorizable
-    include Decoratable
-    include Defaultable
-    include Paginatable
-    include Resourcable
-    include Servicable
-
-    self.responder = ResourcesResponder
-    respond_to :html
-    respond_to :json
-    respond_to :csv, only: :index
-    helper ResourcesHelper
-    before_action :authenticate_user!
-
-    # @note This is a template method that can be overridden by subclasses.
-    # This is an action for landing page display. It does nothing more than rendering `home` template.
-    #
-    # It can be replaced completely in subclasses as below:
-    #
-    # ```
-    # def home
-    #   generate_dashboard_report
-    # end
-    # ```
-    def home
-      # do nothing
-    end
-
-    # @note This is a template method that can be overridden by subclasses.
-    # This is a resourceful action to list records that user can access.
-    #
-    # It can be customized as below in subclasses:
-    #
-    # `WARN: Please keep in mind that Wallaby User Interface requires **index**
-    # action to respond to **csv** and **json** format as well.`
-    #
-    # ```
-    # def index
-    #   # do something before the origin action
-    #   options = {} # NOTE: see `options` parameter for more details
-    #   index!(options) do |format| # NOTE: this is better than using `super`
-    #     # NOTE: this block is for `respond_with` which works similar to `respond_to`
-    #     # customize response behaviour, or do something before the request is rendered
-    #   end
-    # end
-    # ```
-    #
-    # Otherwise, it can be replaced completely in subclasses:
-    #
-    # `WARN: Please keep in mind that Wallaby User Interface requires **index**
-    # action to respond to **csv** and **json** format as well.`
-    #
-    # ```
-    # def index
-    #   # NOTE: `@collection` will be used by the view, please ensure it is assigned, for example:
-    #   @collection = Product.all
-    #   respond_with @collection
-    # end
-    # ```
-    # @param options [Hash] (since 5.2.0) options for
-    #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
-    #   respond_with}
-    # @yield [format] block for
-    #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
-    #   respond_with}
-    #   to customize response behaviour.
-    # @raise [Wallaby::Forbidden] if user has no access
-    def index(options = {}, &block)
-      current_authorizer.authorize :index, current_model_class
-      respond_with collection, options, &block
-    end
-
-    alias index! index
-
-    # @note This is a template method that can be overridden by subclasses.
-    # This is a resourceful action to show the form to create record that user is allowed to.
-    #
-    # It can be customized as below in subclasses:
-    #
-    # ```
-    # def new
-    #   # do something before the origin action
-    #   options = {} # NOTE: see `options` parameter for more details
-    #   new!(options) do |format| # NOTE: this is better than using `super`
-    #     # NOTE: this block is for `respond_with` which works similar to `respond_to`
-    #     # customize response behaviour, or do something before the request is rendered
-    #   end
-    # end
-    # ```
-    #
-    # Otherwise, it can be replaced completely in subclasses:
-    #
-    # ```
-    # def new
-    #   # NOTE: `@resource` will be used by the view, please ensure it is assigned, for example:
-    #   @resource = Product.new new_arrival: true
-    # end
-    # ```
-    # @param options [Hash] (since 5.2.0) options for
-    #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
-    #   respond_with}
-    # @yield [format] block for
-    #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
-    #   respond_with}
-    #   to customize response behaviour.
-    # @raise [Wallaby::Forbidden] if user has no access
-    def new(options = {}, &block)
-      current_authorizer.authorize :new, resource
-      respond_with resource, options, &block
-    end
-
-    alias new! new
-
-    # @note This is a template method that can be overridden by subclasses.
-    # This is a resourceful action to create a record that user is allowed to.
-    #
-    # If record is created successfully, user will be navigated to the record show page.
-    # Otherwise, the form will be shown again with error messages.
-    #
-    # It can be customized as below in subclasses:
-    #
-    # ```
-    # def create
-    #   # do something before the origin action
-    #   options = {} # NOTE: see `options` parameter for more details
-    #   create!(options) do |format| # NOTE: this is better than using `super`
-    #     # NOTE: this block is for `respond_with` which works similar to `respond_to`
-    #     # customize response behaviour, or do something before the request is rendered
-    #   end
-    # end
-    # ```
-    #
-    # Otherwise, it can be replaced completely in subclasses:
-    #
-    # ```
-    # def create
-    #   # NOTE: `@resource` will be used by the view, please ensure it is assigned, for example:
-    #   @resource = Product.new resource_params.merge(new_arrival: true)
-    #   if @resource.save
-    #     redirect_to helper.index_path(current_model_class)
-    #   else
-    #     render :new
-    #   end
-    # end
-    # ```
-    # @param options [Hash] (since 5.2.0) options for
-    #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
-    #   respond_with}. In addition, options `:params` is supported, see below
-    # @option options [ActionController::Parameters, Hash] :params
-    #   permitted parameters for servicer to create the record. _(defaults to: {#resource_params})_
-    # @yield [format] block for
-    #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
-    #   respond_with}
-    #   to customize response behaviour.
-    # @raise [Wallaby::Forbidden] if user has no access
-    def create(options = {}, &block)
-      set_defaults_for :create, options
-      current_authorizer.authorize :create, resource
-      current_servicer.create resource, options.delete(:params)
-      respond_with resource, options, &block
-    end
-
-    alias create! create
-
-    # @note This is a template method that can be overridden by subclasses.
-    # This is a resourceful action to display the record details that user is allowed to.
-    #
-    # It can be customized as below in subclasses:
-    #
-    # ```
-    # def show
-    #   # do something before the origin action
-    #   options = {} # NOTE: see `options` parameter for more details
-    #   show!(options) do |format| # NOTE: this is better than using `super`
-    #     # NOTE: this block is for `respond_with` which works similar to `respond_to`
-    #     # customize response behaviour, or do something before the request is rendered
-    #   end
-    # end
-    # ```
-    #
-    # Otherwise, it can be replaced completely in subclasses:
-    #
-    # ```
-    # def show
-    #   # NOTE: `@resource` will be used by the view, please ensure it is assigned, for example:
-    #   @resource = Product.find_by_slug params[:id]
-    # end
-    # ```
-    # @param options [Hash] (since 5.2.0) options for
-    #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
-    #   respond_with}
-    # @yield [format] block for
-    #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
-    #   respond_with}
-    #   to customize response behaviour.
-    # @raise [Wallaby::Forbidden] if user has no access
-    def show(options = {}, &block)
-      current_authorizer.authorize :show, resource
-      respond_with resource, options, &block
-    end
-
-    alias show! show
-
-    # @note This is a template method that can be overridden by subclasses.
-    # This is a resourceful action to show the form to edit record that user is allowed to.
-    #
-    # It can be customized as below in subclasses:
-    #
-    # ```
-    # def edit
-    #   # do something before the origin action
-    #   options = {} # NOTE: see `options` parameter for more details
-    #   edit!(options) do |format| # NOTE: this is better than using `super`
-    #     # NOTE: this block is for `respond_with` which works similar to `respond_to`
-    #     # customize response behaviour, or do something before the request is rendered
-    #   end
-    # end
-    # ```
-    #
-    # Otherwise, it can be replaced completely in subclasses:
-    #
-    # ```
-    # def edit
-    #   # NOTE: `@resource` will be used by the view, please ensure it is assigned, for example:
-    #   @resource = Product.find_by_slug params[:id]
-    # end
-    # ```
-    # @param options [Hash] (since 5.2.0) options for
-    #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
-    #   respond_with}
-    # @yield [format] block for
-    #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
-    #   respond_with}
-    #   to customize response behaviour.
-    # @raise [Wallaby::Forbidden] if user has no access
-    def edit(options = {}, &block)
-      current_authorizer.authorize :edit, resource
-      respond_with resource, options, &block
-    end
-
-    alias edit! edit
-
-    # @note This is a template method that can be overridden by subclasses.
-    # This is a resourceful action to update the record that user is allowed to.
-    #
-    # If record is updated successfully, user will be navigated to the record show page.
-    # Otherwise, the form will be shown again with error messages.
-    #
-    # It can be customized as below in subclasses:
-    #
-    # ```
-    # def update
-    #   # do something before the origin action
-    #   options = {} # NOTE: see `options` parameter for more details
-    #   update!(options) do |format| # NOTE: this is better than using `super`
-    #     # NOTE: this block is for `respond_with` which works similar to `respond_to`
-    #     # customize response behaviour, or do something before the request is rendered
-    #   end
-    # end
-    # ```
-    #
-    # Otherwise, it can be replaced completely in subclasses:
-    #
-    # ```
-    # def update
-    #   # NOTE: `@resource` will be used by the view, please ensure it is assigned, for example:
-    #   @resource = Product.find_by_slug params[:id]
-    #   @resource.assign_attributes resource_params.merge(new_arrival: true)
-    #   if @resource.save
-    #     redirect_to helper.index_path(current_model_class)
-    #   else
-    #     render :new
-    #   end
-    # end
-    # ```
-    # @param options [Hash] (since 5.2.0) options for
-    #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
-    #   respond_with}. In addition, options `:params` is supported, see below
-    # @option options [ActionController::Parameters, Hash] :params
-    #   permitted parameters for servicer to update the record. _(defaults to: {#resource_params})_
-    # @yield [format] block for
-    #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
-    #   respond_with}
-    #   to customize response behaviour.
-    # @raise [Wallaby::Forbidden] if user has no access
-    def update(options = {}, &block)
-      set_defaults_for :update, options
-      current_authorizer.authorize :update, resource
-      current_servicer.update resource, options.delete(:params)
-      respond_with resource, options, &block
-    end
-
-    alias update! update
-
-    # @note This is a template method that can be overridden by subclasses.
-    # This is a resourceful action to delete the record that user is allowed to.
-    #
-    # It can be customized as below in subclasses:
-    #
-    # ```
-    # def destroy
-    #   # do something before the origin action
-    #   options = {} # NOTE: see `options` parameter for more details
-    #   destroy!(options) do |format| # NOTE: this is better than using `super`
-    #     # NOTE: this block is for `respond_with` which works similar to `respond_to`
-    #     # customize response behaviour, or do something before the request is rendered
-    #   end
-    # end
-    # ```
-    #
-    # Otherwise, it can be replaced completely in subclasses:
-    #
-    # ```
-    # def destroy
-    #   # NOTE: `@resource` will be used by the view, please ensure it is assigned, for example:
-    #   @resource = Product.find_by_slug params[:id]
-    #   @resource.destroy
-    #   redirect_to helper.index_path(current_model_class)
-    # end
-    # ```
-    # @param options [Hash] (since 5.2.0) options for
-    #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
-    #   respond_with}. In addition, options `:params` is supported, see below
-    # @option options [ActionController::Parameters, Hash] :params
-    #   permitted parameters for servicer to destroy the record. _(defaults to: {#resource_params})_
-    # @yield [format] block for
-    #   {https://www.rubydoc.info/gems/responders/ActionController/RespondWith#respond_with-instance_method
-    #   respond_with}
-    #   to customize response behaviour.
-    # @raise [Wallaby::Forbidden] if user has no access
-    def destroy(options = {}, &block)
-      set_defaults_for :destroy, options
-      current_authorizer.authorize :destroy, resource
-      current_servicer.destroy resource, options.delete(:params)
-      respond_with resource, options, &block
-    end
-
-    alias destroy! destroy
-
-    # @note This is a template method that can be overridden by subclasses.
-    # To whitelist the params for {#create} and {#update} actions.
-    #
-    # If Wallaby cannot generate the correct strong parameters, it can be replaced, for example:
-    #
-    # ```
-    # def resource_params
-    #   params.fetch(:product, {}).permit(:name, :sku)
-    # end
-    # ```
-    # @return [ActionController::Parameters] whitelisted params
-    def resource_params
-      @resource_params ||= current_servicer.permit params, action_name
-    end
-
-    # @!method collection(options = {}, &block)
-    #   (see Wallaby::Resourcable#collection)
-    #   @see Wallaby::Resourcable#collection
-    alias collection! collection
-
-    # @!method resource(options = {}, &block)
-    #   (see Wallaby::Resourcable#resource)
-    #   @see Wallaby::Resourcable#resource
-    alias resource! resource
+  #
+  # For better practice, please create an application controller class (see example)
+  # to better control the functions shared between different resource controllers.
+  # @example Create an application class for Admin Interface usage
+  #   class Admin::ApplicationController < Wallaby::ResourcesController
+  #     base_class!
+  #   end
+  class ResourcesController
+    include ResourcesConcern
   end
 end

data/app/security/ability.rb

@@ -4,7 +4,7 @@
 # Defualt ability for wallaby
 # If main app has defined `ability.rb`, this file will not be loaded/used.
 class Ability
-  include ::CanCan::Ability
+  include ::CanCan::Ability if defined?(::CanCan)
 
   # @param _user [Object]
   def initialize(_user)