wallaby-core 0.1.0

data/app/controllers/wallaby/secure_controller.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Wallaby
+  # This is the controller with only authentication logics.
+  class SecureController < ::Wallaby::ApplicationController
+    helper SecureHelper
+    helper_method :current_user
+
+    rescue_from NotAuthenticated, with: :unauthorized
+    rescue_from Forbidden, with: :forbidden
+
+    # Unauthorized page.
+    # @param exception [Exception] exception comes from `rescue_from`
+    def unauthorized(exception = nil)
+      error_rendering exception, __callee__
+    end
+
+    # Forbidden page.
+    # @param exception [Exception] exception comes from `rescue_from`
+    def forbidden(exception = nil)
+      error_rendering exception, __callee__
+    end
+
+    # @note This is a template method that can be overridden by subclasses
+    # This {current_user} method will try to looking up the actual implementation from the following
+    # places from high precedence to low:
+    #
+    # - {Wallaby::Configuration::Security#current_user}
+    # - `super`
+    # - do nothing
+    #
+    # It can be replaced completely in subclasses:
+    #
+    # ```
+    # def current_user
+    #   # NOTE: please ensure `@current_user` is assigned, for instance:
+    #   @current_user ||= User.new params.slice(:email)
+    # end
+    # ```
+    # @return [Object] a user object
+    def current_user
+      @current_user ||=
+        if security.current_user? || !defined? super
+          instance_exec(&security.current_user)
+        else
+          super
+        end
+    end
+
+    # @note This is a template method that can be overridden by subclasses
+    # This {authenticate_user!} method will try to looking up the actual implementation from the following
+    # places from high precedence to low:
+    #
+    # - {Wallaby::Configuration::Security#authenticate}
+    # - `super`
+    # - do nothing
+    #
+    # It can be replaced completely in subclasses:
+    #
+    # ```
+    # def authenticate_user!
+    #   authenticate_or_request_with_http_basic do |username, password|
+    #     username == 'too_simple' && password == 'too_naive'
+    #   end
+    # end
+    # ```
+    # @return [true] when user is authenticated successfully
+    # @raise [Wallaby::NotAuthenticated] when user fails to authenticate
+    def authenticate_user!
+      authenticated =
+        if security.authenticate? || !defined? super
+          instance_exec(&security.authenticate)
+        else
+          super
+        end
+      raise NotAuthenticated unless authenticated
+
+      true
+    end
+  end
+end

data/app/security/ability.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# @!visibility private
+# Defualt ability for wallaby
+# If main app has defined `ability.rb`, this file will not be loaded/used.
+class Ability
+  include ::CanCan::Ability
+
+  # @param _user [Object]
+  def initialize(_user)
+    can :manage, :all
+  end
+end

data/config/locales/wallaby.en.yml

@@ -0,0 +1,140 @@
+# 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}'
+
+  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}'
+
+  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.'
+
+  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:
+      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'
+
+  filters:
+    title: 'Filters'
+    all: 'All'
+
+  search:
+    hint: 'Press enter to search.'
+
+  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.'
+
+  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})"
+
+  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'

data/config/locales/wallaby_class.en.yml

@@ -0,0 +1,30 @@
+# 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}."
+      model_class_mapper:
+        missing_model_class: "[WALLABY] 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/config/routes.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+Wallaby::Engine.routes.draw do
+  # NOTE: For health check if needed
+  # @see Wallaby::ApplicationController#healthy
+  get 'status', to: 'wallaby/resources#healthy'
+
+  with_options to: Wallaby::ResourcesRouter.new do |route|
+    # @see `home` action for more
+    route.root defaults: { action: 'home' }
+
+    # To generate error pages for all supported HTTP status
+    Wallaby::ERRORS.each do |status|
+      code = Rack::Utils::SYMBOL_TO_STATUS_CODE[status]
+      route.get status, defaults: { action: status }
+      route.get code.to_s, defaults: { action: status }
+    end
+
+    # To generate general CRUD resourceful routes
+    # @see Wallaby::ResourcesRouter
+    scope path: ':resources' do
+      # @see Wallaby::ResourcesController#index
+      route.get '', defaults: { action: 'index' }, as: :resources
+      # @see Wallaby::ResourcesController#new
+      route.get 'new', defaults: { action: 'new' }, as: :new_resource
+      # @see Wallaby::ResourcesController#edit
+      route.get ':id/edit', defaults: { action: 'edit' }, as: :edit_resource
+      # @see Wallaby::ResourcesController#show
+      route.get ':id', defaults: { action: 'show' }, as: :resource
+
+      # @see Wallaby::ResourcesController#create
+      route.post '', defaults: { action: 'create' }
+      # @see Wallaby::ResourcesController#update
+      route.match ':id', via: %i(patch put), defaults: { action: 'update' }
+      # @see Wallaby::ResourcesController#destroy
+      route.delete ':id', defaults: { action: 'destroy' }
+    end
+  end
+end

data/lib/adaptors/wallaby/custom.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Wallaby
+  # Custom mode
+  class Custom < Mode
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Wallaby
+  class Custom
+    # Default provider for custom mode
+    class DefaultProvider < DefaultAuthorizationProvider
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Wallaby
+  class Custom
+    # Custom modal decorator
+    class ModelDecorator < ::Wallaby::ModelDecorator
+      # Assume that attributes come from the setter/getter, e.g. `name=`/`name`
+      # @return [ActiveSupport::HashWithIndifferentAccess] metadata
+      def fields
+        @fields ||=
+          ::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}=" }
+              .each { |attribute| hash[attribute] = { label: attribute.humanize, type: 'string' } }
+          end.freeze
+      end
+
+      # A copy of {#fields} for index page
+      # @return [ActiveSupport::HashWithIndifferentAccess] metadata
+      def index_fields
+        @index_fields ||= Utils.clone fields
+      end
+
+      # A copy of {#fields} for show page
+      # @return [ActiveSupport::HashWithIndifferentAccess] metadata
+      def show_fields
+        @show_fields ||= Utils.clone fields
+      end
+
+      # A copy of {#fields} for form (new/edit) page
+      # @return [ActiveSupport::HashWithIndifferentAccess] metadata
+      def form_fields
+        @form_fields ||= Utils.clone fields
+      end
+
+      # @return [Array<String>] a list of field names for index page
+      def index_field_names
+        @index_field_names ||= reposition index_fields.keys, primary_key
+      end
+
+      # @return [Array<String>] a list of field names for show page
+      def show_field_names
+        @show_field_names ||= reposition show_fields.keys, primary_key
+      end
+
+      # @return [Array<String>] a list of field names for form (new/edit) page
+      def form_field_names
+        @form_field_names ||= form_fields.keys - [primary_key.to_s]
+      end
+
+      # @return [ActiveModel::Errors]
+      def form_active_errors(resource)
+        @form_active_errors ||= ActiveModel::Errors.new resource
+      end
+
+      # @return [String, Symbole] primary key name
+      def primary_key
+        @primary_key ||= :id
+      end
+
+      # @param resource [Object]
+      # @return [String]
+      def guess_title(resource)
+        field_name = FieldUtils.first_field_by({ name: /name|title|subject/ }, fields)
+        ModuleUtils.try_to resource, field_name
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Wallaby
+  class Custom
+    # Model finder
+    class ModelFinder < ::Wallaby::ModelFinder
+      # @return [Array<Class>] a list of classes
+      def all
+        Wallaby.configuration.custom_models.presence
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Wallaby
+  class Custom
+    # Model pagination provider
+    class ModelPaginationProvider < ::Wallaby::ModelPaginationProvider
+      # By default, it doesn't support pagination
+      # @return [false]
+      def paginatable?
+        false
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Wallaby
+  class Custom
+    # Model service provider
+    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