wallaby 5.1.5 → 5.1.6

data/app/controllers/wallaby/application_controller.rb

@@ -16,20 +16,33 @@ module Wallaby
     layout 'wallaby/application'
 
     # Not found page
+    # @param exception [Exception]
     def not_found(exception = nil)
       error_rendering(exception, __callee__)
     end
 
     # Bad request page
+    # @param exception [Exception]
     def bad_request(exception = nil)
       error_rendering(exception, __callee__)
     end
 
     # Unprocessable entity page
+    # @param exception [Exception]
     def unprocessable_entity(exception = nil)
       error_rendering(exception, __callee__)
     end
 
+    # @return [Wallaby::Configuration] global configuration
+    def self.configuration
+      ::Wallaby.configuration
+    end
+
+    # @return [Wallaby::Configuration] global configuration
+    def configuration
+      self.class.configuration
+    end
+
     protected
 
     # @see https://github.com/rails/rails/blob/5-0-stable/actionpack/lib/action_controller/metal/helpers.rb#L118
@@ -38,11 +51,9 @@ module Wallaby
       @helpers ||= defined?(super) ? super : view_context
     end
 
-    def configuration
-      ::Wallaby.configuration
-    end
-
     # capture exceptions and display the error using error layout and view
+    # @param exception [Exception]
+    # @param symbol [Symbol] http status symbol
     def error_rendering(exception, symbol)
       @exception = exception
       @symbol = symbol

data/app/controllers/wallaby/base_controller.rb

@@ -8,13 +8,11 @@ module Wallaby
 
     before_action :authenticate_user!, except: [:status]
 
-    # health check
+    # Health check page
     def healthy
       render plain: 'healthy'
     end
 
-    protected
-
     # @return [String] the resources name coming from params
     def current_resources_name
       @current_resources_name ||= params[:resources]

data/app/controllers/wallaby/secure_controller.rb

@@ -8,22 +8,23 @@ module Wallaby
     rescue_from ::CanCan::AccessDenied, with: :forbidden
 
     # Unauthorized page
+    # @param exception [Exception]
     def unauthorized(exception = nil)
       error_rendering(exception, __callee__)
     end
 
     # Forbidden page
+    # @param exception [Exception]
     def forbidden(exception = nil)
       error_rendering(exception, __callee__)
     end
 
-    protected
-
     # Precedence of current_user:
     # - [Security] @see Wallaby::SecureController#security_config
     # - super
     # - do nothing
     # @see Devise::Controllers::Helpers#define_helpers
+    # @return a user object
     def current_user
       @current_user ||=
         if security_config.current_user? || !defined? super
@@ -33,6 +34,13 @@ module Wallaby
         end
     end
 
+    # @return [Wallaby::Configuration::Security] security configuration
+    def security_config
+      configuration.security
+    end
+
+    protected
+
     # Precedence of authenticate_user!:
     # - [Security] @see Wallaby::SecureController#security_config
     # - super
@@ -48,9 +56,5 @@ module Wallaby
       raise NotAuthenticated unless authenticated
       true
     end
-
-    def security_config
-      configuration.security
-    end
   end
 end

data/app/security/ability.rb

@@ -1,3 +1,4 @@
+# @private
 # Defualt ability for wallaby
 # If main app has defined `ability.rb`, this file will not be loaded/used.
 class Ability

data/app/views/wallaby/resources/form/_float.html.erb

@@ -11,7 +11,7 @@ The following params are the variables that can be used in this partial.
   <%= form.label field_name, metadata[:label] %>
   <div class="row">
     <div class="col-xs-6 col-sm-4">
-      <%= form.number_field field_name, class: 'form-control' %>
+      <%= form.number_field field_name, class: 'form-control', options: metadata[:options] || { step: 0.1 } %>
     </div>
   </div>
   <%= form.error_messages field_name %>

data/config/locales/wallaby.en.yml

@@ -94,3 +94,8 @@ en:
     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.'
+
+  wallaby:
+    map:
+      model_class_mapper:
+        missing_model_class: "[WALLABY] Please define self.model_class for %{model} or set it as global.\n          @see Wallaby.configuration.mapping"

data/lib/adaptors/wallaby/active_record.rb

@@ -1,5 +1,5 @@
 module Wallaby
-  # Active Record mode
+  # ActiveRecord mode
   class ActiveRecord < Mode
   end
 end

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

@@ -1,6 +1,6 @@
 module Wallaby
   class ActiveRecord
-    # Modal decorator for Active Record
+    # Modal decorator for ActiveRecord
     class ModelDecorator < ::Wallaby::ModelDecorator
       # Data types to exclude for index page
       INDEX_EXCLUSIVE_DATA_TYPES =
@@ -9,9 +9,9 @@ module Wallaby
       # Data types to exclude for form page
       FORM_EXCLUSIVE_DATA_TYPES = %w(created_at updated_at).freeze
 
-      # Origin metadata coming from data source.
+      # Origin metadata directly coming from ActiveRecord.
       # It needs to be frozen so that we can keep the metadata integrity
-      # @return [Hash]
+      # @return [Hash] metadata
       #   example:
       #     {
       #       # general field
@@ -30,7 +30,7 @@ module Wallaby
       #     }
       def fields
         @fields ||= ::ActiveSupport::HashWithIndifferentAccess.new.tap do |hash|
-          # NOTE: There is a chance that people create Active Record class
+          # NOTE: There is a chance that people create ActiveRecord class
           # before they do the migration, so initialising the fields will raise
           # all kinds of error. Therefore, we need to check the table existence
           if @model_class.table_exists?
@@ -41,26 +41,25 @@ module Wallaby
         end.freeze
       end
 
-      # A copy of all the fields for index page
-      # @return [Hash]
+      # A copy of `fields` for index page
+      # @return [Hash] metadata
       def index_fields
         @index_fields ||= Utils.clone fields
       end
 
-      # A copy of all the fields for show page
-      # @return [Hash]
+      # A copy of `fields` for show page
+      # @return [Hash] metadata
       def show_fields
         @show_fields  ||= Utils.clone fields
       end
 
-      # A copy of all the fields for form page
-      # @return [Hash]
+      # A copy of `fields` for form (new/edit) page
+      # @return [Hash] metadata
       def form_fields
         @form_fields  ||= Utils.clone fields
       end
 
-      # Fields name for index page
-      # @return [Array]
+      # @return [Array<String>] a list of field names for index page
       def index_field_names
         @index_field_names ||= begin
           index_fields.reject do |_field_name, metadata|
@@ -70,8 +69,7 @@ module Wallaby
         end
       end
 
-      # Fields name for form page
-      # @return [Array]
+      # @return [Array<String>] a list of field names for form (new/edit) page
       def form_field_names
         @form_field_names ||= begin
           form_fields.reject do |field_name, metadata|
@@ -82,22 +80,22 @@ module Wallaby
         end
       end
 
-      # Errors for resource
-      # @return [ActiveModel::Errors]
+      # @return [ActiveModel::Errors] errors for resource
       def form_active_errors(resource)
         resource.errors
       end
 
-      # Primary key for the resource
-      # @return [String]
+      # @return [String] primary key for the resource
       def primary_key
         @model_class.primary_key
       end
 
       # To guess the title for resource.
+      #
       # It will go through the fields and try to find out the one that looks
       # like a name or text to represent this resource. Otherwise, it will fall
       # back to primary key.
+      #
       # @param resource [Object]
       # @return [String] the title of given resource
       def guess_title(resource)
@@ -121,7 +119,7 @@ module Wallaby
 
       # Find out all the foreign keys for a list of fields
       # @param fields [Hash] metadata of fields
-      # @return [Array] a list of foreign keys
+      # @return [Array<String>] a list of foreign keys
       def foreign_keys_from_associations(fields = association_fields)
         fields.each_with_object([]) do |(_field_name, metadata), keys|
           keys << metadata[:foreign_key] if metadata[:foreign_key]

data/lib/adaptors/wallaby/active_record/model_decorator/fields_builder.rb

@@ -1,12 +1,15 @@
 module Wallaby
   class ActiveRecord
     class ModelDecorator
+      # @private
       # To search and build the metadata for fields
       class FieldsBuilder
+        # @param model_class [Class] model class
         def initialize(model_class)
           @model_class = model_class
         end
 
+        # @return [Hash<String, Hash>] a hash for general fields
         def general_fields
           @model_class.columns.each_with_object({}) do |column, fields|
             metadata = {
@@ -19,6 +22,7 @@ module Wallaby
           end
         end
 
+        # @return [Hash<String, Hash>] a hash for general fields
         def association_fields
           @model_class.reflections.each_with_object({}) do |(name, ref), fields|
             metadata = {
@@ -33,14 +37,17 @@ module Wallaby
 
         protected
 
+        # @see Wallaby::ActiveRecord::ModelDecorator::StiBuilder
         def sti_builder
           @sti_builder ||= StiBuilder.new(@model_class)
         end
 
+        # @see Wallaby::ActiveRecord::ModelDecorator::AssociationBuilder
         def association_builder
           @association_builder ||= AssociationBuilder.new
         end
 
+        # @see Wallaby::ActiveRecord::ModelDecorator::PolymorphicBuilder
         def polymorphic_builder
           @polymorphic_builder ||= PolymorphicBuilder.new
         end

data/lib/adaptors/wallaby/active_record/model_decorator/fields_builder/association_builder.rb

@@ -2,8 +2,12 @@ module Wallaby
   class ActiveRecord
     class ModelDecorator
       class FieldsBuilder
+        # @private
         # To build the metadata for associations
         class AssociationBuilder
+          # Update the metadata
+          # @param metadata [Hash]
+          # @param reflection [ActiveRecord::Reflection]
           def update(metadata, reflection)
             type = reflection.macro
             metadata[:is_association] = true
@@ -14,6 +18,9 @@ module Wallaby
 
           private
 
+          # @param reflection [ActiveRecord::Reflection]
+          # @param type [Symbol]
+          # @return [String] foreign key
           def foreign_key_for(reflection, type)
             if type == :belongs_to || reflection.polymorphic?
               reflection.foreign_key
@@ -25,10 +32,14 @@ module Wallaby
             end
           end
 
+          # @param reflection [ActiveRecord::Reflection]
+          # @return [Boolean] whether it's a through relation
           def through?(reflection)
             reflection.is_a? ::ActiveRecord::Reflection::ThroughReflection
           end
 
+          # @param reflection [ActiveRecord::Reflection]
+          # @return [Boolean] whether it has scope
           def scope?(reflection)
             reflection.scope.present?
           end

data/lib/adaptors/wallaby/active_record/model_decorator/fields_builder/polymorphic_builder.rb

@@ -2,8 +2,12 @@ module Wallaby
   class ActiveRecord
     class ModelDecorator
       class FieldsBuilder
+        # @private
         # To build the metadata for polymorphic
         class PolymorphicBuilder
+          # update the metadata
+          # @param metadata [Hash]
+          # @param reflection [ActiveRecord::Reflection]
           def update(metadata, reflection)
             if reflection.polymorphic?
               metadata[:is_polymorphic] = true
@@ -16,21 +20,26 @@ module Wallaby
 
           private
 
+          # @param reflection [ActiveRecord::Reflection]
+          # @return [Array<Class>] a list of classes for this polymorphism
           def polymorphic_list_for(reflection)
             all_model_class.each_with_object([]) do |model_class, list|
-              # TODO: need to check the class as well
               if polymorphic_defined? model_class, reflection.name
                 list << model_class
               end
             end
           end
 
+          # @return [Array<Class>] a list of all ActiveRecord classes
           def all_model_class
             Map
               .mode_map
               .select { |_, mode| mode == ::Wallaby::ActiveRecord }.keys
           end
 
+          # @param model_class [Class] model class
+          # @param polymorphic_name [String] polymorphic name
+          # @return [Boolean] if polymorphism defined?
           def polymorphic_defined?(model_class, polymorphic_name)
             polymorphic_name_sym = polymorphic_name.try(:to_sym)
             model_class.reflections.any? do |_field_name, reflection|

data/lib/adaptors/wallaby/active_record/model_decorator/fields_builder/sti_builder.rb

@@ -2,12 +2,17 @@ module Wallaby
   class ActiveRecord
     class ModelDecorator
       class FieldsBuilder
+        # @private
         # To build the metadata for sti column
         class StiBuilder
+          # @param model_class [Class] model class
           def initialize(model_class)
             @model_class = model_class
           end
 
+          # update the metadata
+          # @param metadata [Hash]
+          # @param column [ActiveRecord::ConnectionAdapters::Column]
           def update(metadata, column)
             return unless @model_class.inheritance_column == column.name
             metadata[:type] = 'sti'.freeze
@@ -16,21 +21,23 @@ module Wallaby
 
           private
 
+          # @param klass [Class]
+          # @return [Array<Class>] a list of STI classes for this model
           def sti_list(klass)
-            list = klass
-                   .descendants
-                   .each_with_object([klass]) do |child, result|
-                     result << child
-                   end
+            list = klass.descendants << klass
             list.sort_by(&:name)
           end
 
-          def find_parent_of(model_class)
-            parent = model_class
+          # @param klass [Class]
+          # @return [Class] the top parent class in the STI hierarchy
+          def find_parent_of(klass)
+            parent = klass
             parent = parent.superclass until top_parent?(parent.superclass)
             parent
           end
 
+          # @param klass [Class]
+          # @return [Boolean] whether the class is ActiveRecord base class
           def top_parent?(klass)
             klass == ModelFinder.base ||
               klass.respond_to?(:abstract_class?) && klass.abstract_class?

data/lib/adaptors/wallaby/active_record/model_decorator/title_field_finder.rb

@@ -1,16 +1,20 @@
 module Wallaby
   class ActiveRecord
     class ModelDecorator
+      # @private
       # Try to find the field that can be used as title
       class TitleFieldFinder
         TITLE_FIELD_TYPES = %w(string).freeze
         TITLE_NAMES = %w(name title string text).freeze
 
+        # @param model_class [Class] model class
+        # @param fields [Hash] fields metadata
         def initialize(model_class, fields)
           @model_class  = model_class
           @fields       = fields
         end
 
+        # @return [String] field name that can be used as title
         def find
           possible_title_fields = @fields.select do |_field_name, metadata|
             TITLE_FIELD_TYPES.include? metadata[:type]