wallaby-core 0.2.0 → 0.2.4

data/config/locales/wallaby.en.yml

@@ -1,140 +1,104 @@
-# Files in the config/locales directory are used for internationalization
-# and are automatically loaded by Rails. If you want to use locales other
-# than English, add the necessary files in this directory.
-#
-# To use the locales, use `I18n.t`:
-#
-#     I18n.t 'hello'
-#
-# In views, this is aliased to just `t`:
-#
-#     <%= t('hello') %>
-#
-# To use a different locale, set it with `I18n.locale`:
-#
-#     I18n.locale = :es
-#
-# This would use the information in config/locales/es.yml.
-#
-# To learn more, please read the Rails Internationalization guide
-# available at http://guides.rubyonrails.org/i18n.html.
-
 en:
-  labels:
-    count: 'Count: '
-    auto_select_hint: 'Type to select...'
-    upload: 'Upload'
-    empty: 'null'
-    na: 'n/a'
-    edit: 'Edit # %{id}'
-    create: 'Create a %{model}'
+  wallaby:
+    labels:
+      count: 'Count: '
+      auto_select_hint: 'Type to select...'
+      upload: 'Upload'
+      empty: 'null'
+      na: 'n/a'
+      edit: 'Edit # %{id}'
+      create: 'Create a %{model}'
 
-  buttons:
-    save: 'Save'
+    buttons:
+      save: 'Save'
 
-  links:
-    new: 'Create %{model}'
-    show: 'Show'
-    edit: 'Edit'
-    delete: 'Delete'
-    cancel: 'Cancel'
-    confirm:
-      delete: 'Please confirm to delete'
-    export: 'Export as %{ext}'
+    links:
+      new: 'Create %{model}'
+      show: 'Show'
+      edit: 'Edit'
+      delete: 'Delete'
+      cancel: 'Cancel'
+      confirm:
+        delete: 'Please confirm to delete'
+      export: 'Export as %{ext}'
 
-  http_errors:
-    report_error_html: 'And report the error <a href="https://github.com/reinteractive/wallaby/issues/new" target="_blank">here</a>.'
-    not_implemented: 'Not implemented.'
-    internal_server_error: 'Hope you feel better.'
-    bad_request: 'Your request is not supported.'
-    not_found: 'Not found.'
-    unprocessable_entity: 'Your request cannot be processed.'
-    unauthorized: 'You need to sign in to access this page.'
-    forbidden: 'You need permission to access this page.'
+    http_errors:
+      report_error_html: 'And report the error <a href="https://github.com/reinteractive/wallaby/issues/new" target="_blank">here</a>.'
+      not_implemented: 'Not implemented.'
+      internal_server_error: 'Hope you feel better.'
+      bad_request: 'Your request is not supported.'
+      not_found: 'Not found.'
+      unprocessable_entity: 'Your request cannot be processed.'
+      unauthorized: 'You need to sign in to access this page.'
+      forbidden: 'You need permission to access this page.'
 
-  json_errors:
-    not_implemented: 'Not implemented.'
-    internal_server_error: 'Internal server error.'
-    bad_request: 'Your request is not supported.'
-    not_found: 'Not found.'
-    unprocessable_entity: 'Your request cannot be processed.'
-    unauthorized: 'You need to sign in to access this page.'
-    forbidden: 'You need permission to access this page.'
+    json_errors:
+      not_implemented: 'Not implemented.'
+      internal_server_error: 'Internal server error.'
+      bad_request: 'Your request is not supported.'
+      not_found: 'Not found.'
+      unprocessable_entity: 'Your request cannot be processed.'
+      unauthorized: 'You need to sign in to access this page.'
+      forbidden: 'You need permission to access this page.'
 
-  errors:
-    invalid:
-      models: '%{models} are invalid models.'
-      inheritance: '%{klass} does not inherit from %{parent}.'
-      type_required: 'Type is required for %{field_name}.'
-    not_found:
-      collection: 'Records cannot be found. Click + button to add one.'
-      model: 'Model %{model} cannot be found.'
-      resource: 'Record %{resource} cannot be found.'
-    unprocessable_entity:
-      keyword_search: 'Unable to perform keyword search when no text fields can be used.'
-      field_colon_search: 'Unable to perform field colon search for %{invalid_fields}.'
-      model: 'Unable to handle model %{model}.'
-    unauthorized: 'User %{user} is trying to perform %{action} on %{subject}'
-    pundit:
+    errors:
+      invalid:
+        models: '%{models} are invalid models.'
+        inheritance: '%{klass} does not inherit from %{parent}.'
+        type_required: 'Type is required for %{field_name}.'
       not_found:
-        scope_policy: 'Cannot find scope policy for %{scope}.'
-        attributes_for: 'Cannot find attributes for %{subject}.'
-    activerecord:
-      paginatable: '%{collection} is not paginatable.'
-    required: '%{subject} is required.'
-    not_implemented:
-      model_servicer: 'Custom model servicer method `%{method_name}` is not implemented'
-
-  pagination:
-    prev: 'Prev'
-    next: 'Next'
-    from_to: '%{from} to %{to}'
-    of: ' of '
-    total_count: '%{total}'
-    pers: 'Page Size'
-    pages: 'Page Number'
+        collection: 'Records cannot be found. Click + button to add one.'
+        model: 'Model %{model} cannot be found.'
+        resource: 'Record %{resource} cannot be found.'
+      unprocessable_entity:
+        keyword_search: 'Unable to perform keyword search when no text fields can be used.'
+        field_colon_search: 'Unable to perform field colon search for %{invalid_fields}.'
+        model: 'Unable to handle model %{model}.'
+      unauthorized: 'User %{user} is trying to perform %{action} on %{subject}'
+      pundit:
+        not_found:
+          scope_policy: 'Cannot find scope policy for %{scope}.'
+          attributes_for: 'Cannot find attributes for %{subject}.'
+      required: '%{subject} is required.'
+      not_implemented:
+        model_servicer: 'Custom model servicer method `%{method_name}` is not implemented'
 
-  filters:
-    title: 'Filters'
-    all: 'All'
+    pagination:
+      prev: 'Prev'
+      next: 'Next'
+      from_to: '%{from} to %{to}'
+      of: ' of '
+      total_count: '%{total}'
+      pers: 'Page Size'
+      pages: 'Page Number'
 
-  search:
-    hint: 'Press enter to search.'
+    filters:
+      title: 'Filters'
+      all: 'All'
 
-  hints:
-    box_html: 'Format: <code>(x1, y1), (x2, y2)</code> where <i>(x1,y1)</i> and <i>(x2,y2)</i> are any two opposite corners of the box.'
-    cidr_html: 'Example: <code>192.168.1.1/24</code> which holds an IPv4 or IPv6 network specification.'
-    circle_html: 'Format: <code><(x, y), r></code> where <i>(x,y)</i> is the center point and <i>r</i> is the radius of the circle.'
-    hstore_html: 'Format: <code>"Key1" => "Value1", "Key2" => "Value2"</code> is used for input and output, includes zero or more <i>key => value</i> pairs separated by commas.'
-    inet_html: 'Example: <code>192.168.1.1/24</code> which holds an IPv4 or IPv6 network specification.'
-    line_html: 'Format: <code>{ A, B, C }</code> which are represented by the linear equation <i>Ax + By + C = 0</i>.'
-    lseg_html: 'Format: <code>[(x1, y1), (x2, y2)]</code> where <i>(x1,y1)</i> and <i>(x2,y2)</i> are the end points of the line segment.'
-    ltree_html: 'Example: <code>Top.Countries.Europe.Russia</code> which is a sequence of zero or more labels separated by dots.'
-    macaddr_html: 'Example: <code>08:00:2b:01:02:03</code> which stores MAC addresses.'
-    path_html: 'Format: <code>((x1, y1) , ... , (xn, yn))</code> where the points are the end points of the line segments comprising the path.'
-    polygon_html: 'Format: <code>((x1, y1) , ... , (xn, yn))</code> where the points are the end points of the line segments comprising the boundary of the polygon.'
+    search:
+      hint: 'Press enter to search.'
 
-  deprecation:
-    authorizer: "[DEPRECATION] `authorizer` will be removed from 5.3.*. Please use `current_authorizer` instead.\n(called from %{from})"
-    current_model_service: "[DEPRECATION] `current_model_service` will be removed from 5.3.*. Please use `current_servicer` instead.\n(called from %{from})"
-    find_filter_name: "[DEPRECATION] `Wallaby::Utils.find_filter_name` will be removed from 5.3.*. Please use `Wallaby::FilterUtils.filter_name_by` instead.\n(called from %{from})"
-    form_type_partial_render: "[DEPRECATION] `form_type_partial_render` will be removed from 5.3.*. Please use `type_render` instead.\n(called from %{from})"
-    index_params: "[DEPRECATION] `index_params` will be removed from 5.3.*.\n(called from %{from})"
-    paginator_of: "[DEPRECATION] `paginator_of` will be removed from 5.3.*. Please use `current_paginator` instead.\n(called from %{from})"
-    resource_paginator_inheirtance: "[DEPRECATION] `Wallaby::ResourcePaginator` will be removed from 5.3.*. Please inherit from `Wallaby::ModelPaginator` instead.\n(called from %{from})"
-    resource_paginator=: "[DEPRECATION] `resource_paginator=` will be removed from 5.3.*. Please use `model_paginator=` instead.\n(called from %{from})"
-    type_partial_render: "[DEPRECATION] `type_partial_render` will be removed from 5.3.*. Please use `type_render` instead.\n(called from %{from})"
+    hints:
+      box_html: 'Format: <code>(x1, y1), (x2, y2)</code> where <i>(x1,y1)</i> and <i>(x2,y2)</i> are any two opposite corners of the box.'
+      cidr_html: 'Example: <code>192.168.1.1/24</code> which holds an IPv4 or IPv6 network specification.'
+      circle_html: 'Format: <code><(x, y), r></code> where <i>(x,y)</i> is the center point and <i>r</i> is the radius of the circle.'
+      hstore_html: 'Format: <code>"Key1" => "Value1", "Key2" => "Value2"</code> is used for input and output, includes zero or more <i>key => value</i> pairs separated by commas.'
+      inet_html: 'Example: <code>192.168.1.1/24</code> which holds an IPv4 or IPv6 network specification.'
+      line_html: 'Format: <code>{ A, B, C }</code> which are represented by the linear equation <i>Ax + By + C = 0</i>.'
+      lseg_html: 'Format: <code>[(x1, y1), (x2, y2)]</code> where <i>(x1,y1)</i> and <i>(x2,y2)</i> are the end points of the line segment.'
+      ltree_html: 'Example: <code>Top.Countries.Europe.Russia</code> which is a sequence of zero or more labels separated by dots.'
+      macaddr_html: 'Example: <code>08:00:2b:01:02:03</code> which stores MAC addresses.'
+      path_html: 'Format: <code>((x1, y1) , ... , (xn, yn))</code> where the points are the end points of the line segments comprising the path.'
+      polygon_html: 'Format: <code>((x1, y1) , ... , (xn, yn))</code> where the points are the end points of the line segments comprising the boundary of the polygon.'
 
-  fa:
-    # map fa 5's icon name to version 4
-    # @see this fa migration document https://fontawesome.com/how-to-use/on-the-web/setup/upgrading-from-version-4
-    v4:
-      clock: 'clock-o'
-      bars: 'navicon'
-      calendar: 'calendar-o'
-      check-square: 'check-square-o'
-      square: 'square-o'
-      link: 'chain'
-      user: 'user-o'
-    v5:
-      no-need: 'no-need'
+    deprecation:
+      authorizer: "[DEPRECATION] `authorizer` will be removed from 5.3.*. Please use `current_authorizer` instead.\n(called from %{from})"
+      current_model_service: "[DEPRECATION] `current_model_service` will be removed from 5.3.*. Please use `current_servicer` instead.\n(called from %{from})"
+      find_filter_name: "[DEPRECATION] `Wallaby::Utils.find_filter_name` will be removed from 5.3.*. Please use `Wallaby::FilterUtils.filter_name_by` instead.\n(called from %{from})"
+      form_type_partial_render: "[DEPRECATION] `form_type_partial_render` will be removed from 5.3.*. Please use `type_render` instead.\n(called from %{from})"
+      index_params: "[DEPRECATION] `index_params` will be removed from 5.3.*.\n(called from %{from})"
+      paginator_of: "[DEPRECATION] `paginator_of` will be removed from 5.3.*. Please use `current_paginator` instead.\n(called from %{from})"
+      resource_paginator_inheirtance: "[DEPRECATION] `Wallaby::ResourcePaginator` will be removed from 5.3.*. Please inherit from `Wallaby::ModelPaginator` instead.\n(called from %{from})"
+      resource_paginator=: "[DEPRECATION] `resource_paginator=` will be removed from 5.3.*. Please use `model_paginator=` instead.\n(called from %{from})"
+      type_partial_render: "[DEPRECATION] `type_partial_render` will be removed from 5.3.*. Please use `type_render` instead.\n(called from %{from})"

data/config/locales/wallaby_class.en.yml

@@ -1,30 +1,9 @@
-# Files in the config/locales directory are used for internationalization
-# and are automatically loaded by Rails. If you want to use locales other
-# than English, add the necessary files in this directory.
-#
-# To use the locales, use `I18n.t`:
-#
-#     I18n.t 'hello'
-#
-# In views, this is aliased to just `t`:
-#
-#     <%= t('hello') %>
-#
-# To use a different locale, set it with `I18n.locale`:
-#
-#     I18n.locale = :es
-#
-# This would use the information in config/locales/es.yml.
-#
-# To learn more, please read the Rails Internationalization guide
-# available at http://guides.rubyonrails.org/i18n.html.
-
 en:
   wallaby:
     map:
-      missing_mode_for_model_class: "[WALLABY] Don't know how to handle this model %{model}."
+      missing_mode_for_model_class: "Don't know how to handle this model %{model}."
       model_class_mapper:
-        missing_model_class: "[WALLABY] Please define self.model_class for %{model} or set it as global.\n          @see Wallaby.configuration.mapping"
+        missing_model_class: "Please define self.model_class for %{model} or set it as global.\n          @see Wallaby.configuration.mapping"
 
     mode:
       inherit_required: '%{klass} must inherit from %{parent}.'

data/lib/adaptors/wallaby/custom/default_provider.rb

@@ -2,7 +2,7 @@
 
 module Wallaby
   class Custom
-    # Default provider for custom mode
+    # Default authorization provider for {Wallaby::Custom} mode that whitelists everything.
     class DefaultProvider < DefaultAuthorizationProvider
     end
   end

data/lib/adaptors/wallaby/custom/model_decorator.rb

@@ -2,7 +2,7 @@
 
 module Wallaby
   class Custom
-    # Custom modal decorator
+    # {Wallaby::Custom} mode decorator that only pulls out all the attributes from setter/getter methods.
     class ModelDecorator < ::Wallaby::ModelDecorator
       # Assume that attributes come from the setter/getter, e.g. `name=`/`name`
       # @return [ActiveSupport::HashWithIndifferentAccess] metadata
@@ -11,8 +11,7 @@ module Wallaby
           ::ActiveSupport::HashWithIndifferentAccess.new.tap do |hash|
             methods = model_class.public_instance_methods(false).map(&:to_s)
             methods
-              .grep(/[^=]$/)
-              .select { |method_id| methods.include? "#{method_id}=" }
+              .grep(/[^=]$/).select { |method_id| methods.include? "#{method_id}=" }
               .each { |attribute| hash[attribute] = { label: attribute.humanize, type: 'string' } }
           end.freeze
       end
@@ -50,21 +49,23 @@ module Wallaby
         @form_field_names ||= form_fields.keys - [primary_key.to_s]
       end
 
+      # @param resource [Object]
       # @return [ActiveModel::Errors]
       def form_active_errors(resource)
         @form_active_errors ||= ActiveModel::Errors.new resource
       end
 
-      # @return [String, Symbole] primary key name
+      # @return [String, Symbole] default to `:id`
       def primary_key
         @primary_key ||= :id
       end
 
       # @param resource [Object]
-      # @return [String]
+      # @return [String, nil]
       def guess_title(resource)
-        field_name = FieldUtils.first_field_by({ name: /name|title|subject/ }, fields)
-        ModuleUtils.try_to resource, field_name
+        FieldUtils
+          .first_field_by({ name: /name|title|subject/ }, fields)
+          .try { |field_name| resource.try field_name }
       end
     end
   end

data/lib/adaptors/wallaby/custom/model_finder.rb

@@ -2,9 +2,10 @@
 
 module Wallaby
   class Custom
-    # Model finder
+    # Model finder for {Wallaby::Custom} mode that returns the list of model set by
+    # {Wallaby::Configuration#custom_models}
     class ModelFinder < ::Wallaby::ModelFinder
-      # @return [Array<Class>] a list of classes
+      # @return [Wallaby::ClashArray] a list of classes
       def all
         Wallaby.configuration.custom_models.presence
       end

data/lib/adaptors/wallaby/custom/model_pagination_provider.rb

@@ -2,7 +2,7 @@
 
 module Wallaby
   class Custom
-    # Model pagination provider
+    # Model pagination provider for {Wallaby::Custom} mode
     class ModelPaginationProvider < ::Wallaby::ModelPaginationProvider
       # By default, it doesn't support pagination
       # @return [false]

data/lib/adaptors/wallaby/custom/model_service_provider.rb

@@ -2,47 +2,8 @@
 
 module Wallaby
   class Custom
-    # Model service provider
+    # Model service provider for {Wallaby::Custom} mode
     class ModelServiceProvider < ::Wallaby::ModelServiceProvider
-      # @raise [Wallaby::NotImplemented]
-      def permit(*)
-        raise Wallaby::NotImplemented, I18n.t('errors.not_implemented.model_servicer', method_name: __callee__)
-      end
-
-      # @raise [Wallaby::NotImplemented]
-      def collection(*)
-        raise Wallaby::NotImplemented, I18n.t('errors.not_implemented.model_servicer', method_name: __callee__)
-      end
-
-      # @raise [Wallaby::NotImplemented]
-      def paginate(*)
-        raise Wallaby::NotImplemented, I18n.t('errors.not_implemented.model_servicer', method_name: __callee__)
-      end
-
-      # @raise [Wallaby::NotImplemented]
-      def new(*)
-        raise Wallaby::NotImplemented, I18n.t('errors.not_implemented.model_servicer', method_name: __callee__)
-      end
-
-      # @raise [Wallaby::NotImplemented]
-      def find(*)
-        raise Wallaby::NotImplemented, I18n.t('errors.not_implemented.model_servicer', method_name: __callee__)
-      end
-
-      # @raise [Wallaby::NotImplemented]
-      def create(*)
-        raise Wallaby::NotImplemented, I18n.t('errors.not_implemented.model_servicer', method_name: __callee__)
-      end
-
-      # @raise [Wallaby::NotImplemented]
-      def update(*)
-        raise Wallaby::NotImplemented, I18n.t('errors.not_implemented.model_servicer', method_name: __callee__)
-      end
-
-      # @raise [Wallaby::NotImplemented]
-      def destroy(*)
-        raise Wallaby::NotImplemented, I18n.t('errors.not_implemented.model_servicer', method_name: __callee__)
-      end
     end
   end
 end

data/lib/authorizers/wallaby/cancancan_authorization_provider.rb

@@ -1,67 +1,73 @@
 # frozen_string_literal: true
 
 module Wallaby
-  # Cancancan base authorization provider
+  # @note This authorization provider DOES NOT use the existing
+  #   {https://www.rubydoc.info/github/CanCanCommunity/cancancan/CanCan%2FControllerAdditions:current_ability
+  #   current_ability} helper. It has its own version of {#ability} instance.
+  # {https://github.com/CanCanCommunity/cancancan CanCanCan} base authorization provider.
   class CancancanAuthorizationProvider < ModelAuthorizationProvider
-    # Detect and see if Cancancan is in use.
-    # @param context [ActionController::Base]
-    # @return [true] if Cancancan is in use.
-    # @return [false] if Cancancan is not in use.
+    # Detect and see if CanCanCan is in use.
+    # @param context [ActionController::Base, ActionView::Base]
+    # @return [true] if CanCanCan is in use
+    # @return [false] otherwise.
     def self.available?(context)
-      defined?(CanCanCan) && defined?(Ability) && context.respond_to?(:current_ability)
+      defined?(CanCanCan) && context.respond_to?(:current_ability)
     end
 
-    # This will pull out the args required for contruction from context
-    # @param context [ActionController::Base]
-    # @return [Hash] args for initialize
-    def self.args_from(context)
-      { ability: context.current_ability, user: ModuleUtils.try_to(context, :current_user) }
-    end
+    # @!attribute [w] ability
+    attr_writer :ability
 
     # @!attribute [r] ability
-    # @return [Ability]
-    attr_reader :ability
-
-    def initialize(ability:, user: nil)
-      @ability = ability
-      @user = user
+    # @return [Ability] the Ability instance for {#user #user} (which is a
+    #   {Wallaby::AuthenticationConcern#wallaby_user #wallaby_user})
+    def ability
+      # NOTE: use current_ability's class to create the ability instance.
+      # just in case that developer uses a different Ability class (e.g. UserAbility)
+      @ability ||= options[:ability] || Ability.new(user)
+    rescue ArgumentError, NameError
+      context.current_ability
     end
 
     # Check user's permission for an action on given subject.
-    # This method will be used in controller.
+    #
+    # This method will be mostly used in controller.
     # @param action [Symbol, String]
     # @param subject [Object, Class]
     # @raise [Wallaby::Forbidden] when user is not authorized to perform the action.
     def authorize(action, subject)
       ability.authorize! action, subject
     rescue ::CanCan::AccessDenied
-      Rails.logger.info I18n.t('errors.unauthorized', user: user, action: action, subject: subject)
+      Logger.error <<~MESSAGE
+        #{Utils.inspect user} is forbidden to perform #{action} on #{Utils.inspect subject}
+      MESSAGE
       raise Forbidden
     end
 
     # Check and see if user is allowed to perform an action on given subject.
     # @param action [Symbol, String]
     # @param subject [Object, Class]
-    # @return [Boolean]
+    # @return [true] if user is allowed to perform the action
+    # @return [false] otherwise
     def authorized?(action, subject)
       ability.can? action, subject
     end
 
-    # Restrict user to access certain scope.
+    # Restrict user to access certain scope/query.
     # @param action [Symbol, String]
     # @param scope [Object]
     # @return [Object]
     def accessible_for(action, scope)
-      ModuleUtils.try_to(scope, :accessible_by, ability, action) || scope
+      scope.try(:accessible_by, ability, action) || scope
     end
 
+    # @!method attributes_for(action, subject)
     # Restrict user to assign certain values.
     # @param action [Symbol, String]
     # @param subject [Object]
     # @return nil
     delegate :attributes_for, to: :ability
 
-    # Just return nil
+    # Simply return nil as CanCanCan doesn't provide such a feature.
     # @param action [Symbol, String]
     # @param subject [Object]
     # @return [nil]

data/lib/authorizers/wallaby/default_authorization_provider.rb

@@ -1,20 +1,13 @@
 # frozen_string_literal: true
 
 module Wallaby
-  # Default authorization provider
+  # Default authorization provider that whitelists everything.
   class DefaultAuthorizationProvider < ModelAuthorizationProvider
-    # Always available.
-    # @param _context [ActionController::Base]
-    # @return [true]
+    # It returns false so that it can be used as the last resort.
+    # @param _context [ActionController::Base, ActionView::Base]
+    # @return [false]
     def self.available?(_context)
-      true
-    end
-
-    # This will pull out the args required for contruction from context
-    # @param _context [ActionController::Base]
-    # @return [Hash] args for initialize
-    def self.args_from(_context)
-      {}
+      false
     end
 
     # Do nothing
@@ -47,7 +40,7 @@ module Wallaby
       {}
     end
 
-    # @note Please make sure to return nil when the authorization doesn't support this feature.
+    # @note Please make sure to return nil when the authorization provider doesn't support this feature.
     # @param _action [Symbol, String]
     # @param _subject [Object]
     # @return [nil]