wallaby 5.1.5 → 5.1.6

data/lib/interfaces/wallaby/model_decorator/field_helpers.rb

@@ -1,64 +1,74 @@
 module Wallaby
-  # @private
   class ModelDecorator
-    # @private
     # Field helper for model decorator
     module FieldHelpers
+      # @param field_name [String, Symbol] field name
       # @return [Hash] metadata information for a given field
       def metadata_of(field_name)
         fields[field_name] || {}
       end
 
+      # @param field_name [String, Symbol] field name
       # @return [String] label for a given field
       def label_of(field_name)
         metadata_of(field_name)[:label]
       end
 
+      # @param field_name [String, Symbol] field name
       # @return [String, Symbol] type for a given field
       def type_of(field_name)
         validate_presence_of field_name, metadata_of(field_name)[:type]
       end
 
+      # @param field_name [String, Symbol] field name
       # @return [Hash] index metadata information for a given field
       def index_metadata_of(field_name)
         index_fields[field_name] || {}
       end
 
+      # @param field_name [String, Symbol] field name
       # @return [String] index label for a given field
       def index_label_of(field_name)
         index_metadata_of(field_name)[:label]
       end
 
+      # @param field_name [String, Symbol] field name
       # @return [String, Symbol] index type for a given field
       def index_type_of(field_name)
         validate_presence_of field_name, index_metadata_of(field_name)[:type]
       end
 
+      # @param field_name [String, Symbol] field name
       # @return [Hash] show metadata information for a given field
       def show_metadata_of(field_name)
         show_fields[field_name] || {}
       end
 
+      # @param field_name [String, Symbol] field name
       # @return [String] show label for a given field
       def show_label_of(field_name)
         show_metadata_of(field_name)[:label]
       end
 
+      # @param field_name [String, Symbol] field name
       # @return [String, Symbol] show type for a given field
       def show_type_of(field_name)
         validate_presence_of field_name, show_metadata_of(field_name)[:type]
       end
 
+      # @param field_name [String, Symbol] field name
       # @return [Hash] form metadata information for a given field
       def form_metadata_of(field_name)
         form_fields[field_name] || {}
       end
 
+      # @param field_name [String, Symbol] field name
       # @return [String] form label for a given field
       def form_label_of(field_name)
         form_metadata_of(field_name)[:label]
       end
 
+      # @param field_name [String, Symbol] field name
       # @return [String, Symbol] form type for a given field
       def form_type_of(field_name)
         validate_presence_of field_name, form_metadata_of(field_name)[:type]

data/lib/interfaces/wallaby/model_finder.rb

@@ -2,6 +2,7 @@ module Wallaby
   # Model finder interface
   class ModelFinder
     # Need to implement this method to get all the available model for a mode
+    # @return [Array<Class>] a list of model class
     def all
       raise NotImplemented
     end

data/lib/interfaces/wallaby/model_pagination_provider.rb

@@ -1,7 +1,7 @@
 module Wallaby
   # Model pagination provider interface
   class ModelPaginationProvider
-    # @param collection
+    # @param collection [#to_a]
     # @param params [ActionController::Parameters]
     # @param options [Hash] options
     # @param model_decorator [Wallaby::ModelDecorator, nil]
@@ -13,30 +13,31 @@ module Wallaby
     end
 
     # If a collection has pagination feature
+    # @return [Boolean]
     def paginatable?
       raise NotImplemented
     end
 
     # Check and see if it's the first page
-    # @return boolean
+    # @return [Boolean]
     def first_page?
       page_number > first_page_number
     end
 
     # Check and see if it's the previous page
-    # @return boolean
+    # @return [Boolean]
     def prev_page?
       page_number > first_page_number
     end
 
     # Check and see if it's the last page
-    # @return boolean
+    # @return [Boolean]
     def last_page?
       page_number < last_page_number
     end
 
     # Check and see if it's the next page
-    # @return boolean
+    # @return [Boolean]
     def next_page?
       page_number < last_page_number
     end

data/lib/interfaces/wallaby/model_service_provider.rb

@@ -11,6 +11,7 @@ module Wallaby
 
     # To whitelist params for a model class
     # @param _params [ActionController::Parameters]
+    # @return [ActionController::Parameters] whitelisted params
     def permit(_params)
       raise NotImplemented
     end
@@ -18,13 +19,15 @@ module Wallaby
     # Fetch collection by params
     # @param _params [ActionController::Parameters]
     # @param _authorizer
+    # @return [#to_a]
     def collection(_params, _authorizer)
       raise NotImplemented
     end
 
-    # Paginate the records
+    # Paginate the resources
     # @param _query
     # @param _params [ActionController::Parameters]
+    # @return [#to_a]
     def paginate(_query, _params)
       raise NotImplemented
     end
@@ -32,14 +35,16 @@ module Wallaby
     # Initialize the model class using params
     # @param _params [ActionController::Parameters]
     # @param _authorizer
+    # @return a resource object
     def new(_params, _authorizer)
       raise NotImplemented
     end
 
-    # Find a record using id
+    # Find a resource using id
     # @param _id [Object]
     # @param _params [ActionController::Parameters]
     # @param _authorizer
+    # @return a resource object
     def find(_id, _params, _authorizer)
       raise NotImplemented
     end
@@ -48,6 +53,7 @@ module Wallaby
     # @param _resource [Object]
     # @param _params [ActionController::Parameters]
     # @param _authorizer
+    # @return a resource object
     def create(_resource, _params, _authorizer)
       raise NotImplemented
     end
@@ -56,6 +62,7 @@ module Wallaby
     # @param _resource [Object]
     # @param _params [ActionController::Parameters]
     # @param _authorizer
+    # @return a resource object
     def update(_resource, _params, _authorizer)
       raise NotImplemented
     end
@@ -64,6 +71,7 @@ module Wallaby
     # @param _resource [Object]
     # @param _params [ActionController::Parameters]
     # @param _authorizer
+    # @return a resource object
     def destroy(_resource, _params, _authorizer)
       raise NotImplemented
     end

data/lib/paginators/wallaby/abstract_resource_paginator.rb

@@ -1,8 +1,9 @@
 module Wallaby
   # Model paginator
   class AbstractResourcePaginator
+    # @return [Class] model class for paginator
     def self.model_class
-      return unless self < ::Wallaby::ResourcePaginator
+      return unless self < ::Wallaby.configuration.mapping.resource_paginator
       Map.model_class_map name.gsub('Paginator', EMPTY_STRING)
     end
 
@@ -11,6 +12,10 @@ module Wallaby
       ModelPaginationProvider.instance_methods - ::Object.instance_methods
     delegate(*instance_methods, to: :@provider)
 
+    # Paginator constructor
+    # @param model_class [Class] model class
+    # @param collection [#to_a] a collection of all the resources
+    # @param params [ActionController::Parameters] parameters
     def initialize(model_class, collection, params)
       @model_class = model_class || self.class.model_class
       raise ArgumentError, 'model class required' unless @model_class

data/lib/parsers/wallaby/parser.rb

@@ -1,4 +1,5 @@
 module Wallaby
+  # @private
   # a parser to handle colon query
   class Parser < Parslet::Parser
     root(:statement)

data/lib/responders/wallaby/abstract_responder.rb

@@ -1,10 +1,11 @@
 module Wallaby
-  # abstract responder for later usage
+  # Abstract responder
   class AbstractResponder < ActionController::Responder
     include ::Responders::FlashResponder
 
     delegate :params, :headers, to: :request
 
+    # @return [String] HTML
     def to_html
       set_flash_message
       if post? then create_action
@@ -14,12 +15,14 @@ module Wallaby
       end
     end
 
+    # @return [String] CSV
     def to_csv
       set_layout_to_none
       headers['Content-Disposition'] = "attachment; filename=\"#{file_name}\""
       default_render
     end
 
+    # @return [String] JSON
     def to_json
       set_layout_to_none
       return default_render unless post? || patch? || put? || delete?
@@ -31,6 +34,9 @@ module Wallaby
 
     private
 
+    # For create action
+    # - if has errors, render the form again
+    # - else redirect to show page
     def create_action
       if has_errors?
         render :new, options
@@ -39,6 +45,9 @@ module Wallaby
       end
     end
 
+    # For update action
+    # - if has errors, render the form again
+    # - else redirect to show page
     def update_action
       if has_errors?
         render :edit, options
@@ -47,21 +56,25 @@ module Wallaby
       end
     end
 
+    # For destroy action
+    # - redirect to show page
     def destroy_action
       redirect_to resource_location
     end
 
+    # @return [String] file name
     def file_name
       timestamp = Time.zone.now.to_s(:number)
       "#{params[:resources]}-exported-#{timestamp}.#{format}"
     end
 
+    # Set layout to nothing
     def set_layout_to_none
       options[:layout] = false
     end
 
+    # @see FlashResponder
     def set_flash_message
-      # @see FlashResponder
       set_flash_message! if set_flash_message?
     end
   end

data/lib/routes/wallaby/resources_router.rb

@@ -21,11 +21,15 @@ module Wallaby
 
     private
 
+    # @param resources_name [String] resource name in plural
+    # @return [Class] controller class
     def find_controller_by(resources_name)
       model_class = Map.model_class_map resources_name
       Map.controller_map model_class
     end
 
+    # @param params [ActionController::Parameters]
+    # @return [String, Symbol] action name
     def find_action_by(params)
       # Action name comes from either the defaults or :action param
       # @see Wallaby::Engine.routes

data/lib/servicers/wallaby/abstract_model_servicer.rb

@@ -1,11 +1,14 @@
 module Wallaby
-  # Model servicer
+  # Abstract model servicer
   class AbstractModelServicer
+    # @return [Class] model class that comes from its class name
     def self.model_class
       return unless self < ::Wallaby::ModelServicer
       Map.model_class_map name.gsub('Servicer', EMPTY_STRING)
     end
 
+    # @param model_class [Class, nil] model class
+    # @param authorizer [Ability]
     def initialize(model_class = nil, authorizer = nil)
       @model_class = model_class || self.class.model_class
       raise ArgumentError, 'model class required' unless @model_class
@@ -13,34 +16,55 @@ module Wallaby
       @provider = Map.service_provider_map @model_class
     end
 
+    # @param params [ActionController::Parameters]
+    # @return [ActionController::Parameters]
     def permit(params)
       @provider.permit params
     end
 
+    # @param params [ActionController::Parameters]
+    # @return [ActiveRecord::Relation]
     def collection(params)
       @provider.collection params, @authorizer
     end
 
+    # @param query [ActiveRecord::Relation]
+    # @param params [ActionController::Parameters]
+    # @return [ActiveRecord::Relation]
     def paginate(query, params)
       @provider.paginate query, params
     end
 
+    # @param params [ActionController::Parameters]
+    # @return [Object] initialized object
     def new(params)
       @provider.new params, @authorizer
     end
 
+    # @param id [Object]
+    # @param params [ActionController::Parameters]
+    # @return [Object] resource object
     def find(id, params)
       @provider.find id, params, @authorizer
     end
 
+    # @param resource [Object]
+    # @param params [ActionController::Parameters]
+    # @return [Object] resource object
     def create(resource, params)
       @provider.create resource, params, @authorizer
     end
 
+    # @param resource [Object]
+    # @param params [ActionController::Parameters]
+    # @return [Object] resource object
     def update(resource, params)
       @provider.update resource, params, @authorizer
     end
 
+    # @param resource [Object]
+    # @param params [ActionController::Parameters]
+    # @return [Object] resource object
     def destroy(resource, params)
       @provider.destroy resource, params, @authorizer
     end

data/lib/servicers/wallaby/model_servicer.rb

@@ -1,5 +1,6 @@
 module Wallaby
   # Model servicer
+  # @see Wallaby::AbstractModelServicer
   class ModelServicer < AbstractModelServicer
   end
 end

data/lib/services/wallaby/link_options_normalizer.rb

@@ -1,16 +1,20 @@
 module Wallaby
+  # @private
   # Link renderer
   class LinkOptionsNormalizer
-    class << self
-      def normalize(html_options, block, defaults)
-        block ||= defaults[:block]
-        html_options[:title] ||= defaults[:block].call
-        # allow empty class to be set
-        if !html_options.key?(:class) && defaults[:class]
-          html_options[:class] = defaults[:class]
-        end
-        [html_options, block]
+    # Normalize options for `link_to` to use
+    # @param html_options [Hash] html options
+    # @param block [Proc] a block
+    # @param defaults [Hash]
+    # @return [Array<Hash, Proc>] html_options and the block
+    def self.normalize(html_options, block, defaults)
+      block ||= defaults[:block]
+      html_options[:title] ||= defaults[:block].call
+      # allow empty class to be set
+      if !html_options.key?(:class) && defaults[:class]
+        html_options[:class] = defaults[:class]
       end
+      [html_options, block]
     end
   end
 end

data/lib/services/wallaby/lookup_context_wrapper.rb

@@ -1,17 +1,22 @@
 module Wallaby
   # Lookup context wrapper.
-  # This is to take care of missing template in production to return string
-  # template.
+  #
+  # This is to take care of missing template in production.
+  # It will return `string` template
+  # if it doesn't know how to handle the template.
   # @see Wallaby::PartialRenderer
   class LookupContextWrapper
     origin_methods = ::ActionView::LookupContext.instance_methods \
       - ::Object.instance_methods - %i(find_template)
     delegate(*origin_methods, to: :@lookup_context)
 
+    # @param lookup_context [ActionView::LookupContext]
     def initialize(lookup_context)
       @lookup_context = lookup_context
     end
 
+    # @see ActionView::LookupContext#find_template
+    # @param args [Array] a list of arguments
     def find_template(*args)
       @lookup_context.find_template(*args)
     rescue ::ActionView::MissingTemplate
@@ -25,8 +30,12 @@ module Wallaby
         super nil
       end
 
+      # @param args [Array] a list of arguments
+      # @return [nil]
       def render(*args); end
 
+      # @param args [Array] a list of arguments
+      # @return [nil]
       def virtual_path(*args); end
     end
   end