wallaby-active_record 0.2.2 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93579d0cc4c2a81356d19acc3a24a7cac7160406f4c09c829de95f10d3db1020
-  data.tar.gz: d591a516f5c2fc04d7b6f46af992498e093d5d3f706d03c639a77a11eeeba339
+  metadata.gz: 55cc61191c3d68eabf0bb98b4977d10c7d5063736e95cba4b4cb446bf1ecebb7
+  data.tar.gz: 8d03e8a115f52bd386e87bd6ba2a8a95fdec39743a1a040396f8f1b06ac1c0fe
 SHA512:
-  metadata.gz: 9197ae20142ea0190ed68314ef6eb5c7ec4915febe072f62f0144bb6f42dddbada38adadf05b83eba0ed9744d2c3bc050f2836b25a46c394ab553decaa4f0dee
-  data.tar.gz: 0a59dcd809acb177822b3665b576b18eefdb0ef55b4fdcfdc6a3cf9344ce73fa1ddc4cb608c47de4d630b6149d0f1a36569eee8c63253830ddad92aae3c3f514
+  metadata.gz: '0685f26c6acf1c511be09cfe68258bce7ca3cd01263047205fcdbfc2e81da7ca1239af3f0725510401d02f6a2c2629003e79a41760a8e672acaa710cd566d8db'
+  data.tar.gz: fa1497666790dba1d421f1194ce3e3ffc4851e3425a7a2da5701af9f5d4573d1df9bbf3a9ee656aa3490f81ed363af4a6758121d6c3cbd761f3d52707f84f6bb

data/README.md

@@ -7,7 +7,8 @@
 [![Test Coverage](https://api.codeclimate.com/v1/badges/9ba0a610043a2e1a9e74/test_coverage)](https://codeclimate.com/github/wallaby-rails/wallaby-active_record/test_coverage)
 [![Inch CI](https://inch-ci.org/github/wallaby-rails/wallaby-active_record.svg?branch=master)](https://inch-ci.org/github/wallaby-rails/wallaby-active_record)
 
-Wallaby::ActiveRecord is the ActiveRecord adapter for [Wallaby::Core](https://github.com/wallaby-rails/wallaby-core).
+Wallaby::ActiveRecord is the ActiveRecord adapter that implements the [Wallaby::Core](https://github.com/wallaby-rails/wallaby-core)
+interfaces to handle ActiveRecord model/instance(s) in all the CRUD/authorization/pagination operations.
 
 ## Install
 

data/lib/adapters/wallaby/active_record/cancancan_provider.rb

@@ -2,7 +2,7 @@
 
 module Wallaby
   class ActiveRecord
-    # Cancancan provider for ActiveRecord
+    # Cancancan provider for {Wallaby::ActiveRecord}
     class CancancanProvider < CancancanAuthorizationProvider
     end
   end

data/lib/adapters/wallaby/active_record/default_provider.rb

@@ -2,7 +2,7 @@
 
 module Wallaby
   class ActiveRecord
-    # Default provider for ActiveRecord
+    # Default provider for {Wallaby::ActiveRecord}
     class DefaultProvider < DefaultAuthorizationProvider
     end
   end

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

@@ -4,7 +4,7 @@ module Wallaby
   class ActiveRecord
     class ModelDecorator
       class FieldsBuilder
-        # To build the metadata for associations
+        # To build the metadata for associations fields
         class AssociationBuilder
           # Update the metadata
           # @param metadata [Hash]
@@ -18,7 +18,7 @@ module Wallaby
             metadata[:foreign_key] = foreign_key_for(reflection, type)
           end
 
-          private
+          protected
 
           # @param reflection [ActiveRecord::Reflection]
           # @param type [Symbol]
@@ -35,13 +35,15 @@ module Wallaby
           end
 
           # @param reflection [ActiveRecord::Reflection]
-          # @return [Boolean] whether it's a through relation
+          # @return [true] if it's a through relation
+          # @return [false] otherwise
           def through?(reflection)
             reflection.is_a? ::ActiveRecord::Reflection::ThroughReflection
           end
 
           # @param reflection [ActiveRecord::Reflection]
-          # @return [Boolean] whether it has scope
+          # @return [true] if it has scope
+          # @return [false] otherwise
           def scope?(reflection)
             reflection.scope.present?
           end

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

@@ -19,7 +19,7 @@ module Wallaby
             end
           end
 
-          private
+          protected
 
           # @param reflection [ActiveRecord::Reflection]
           # @return [Array<Class>] a list of classes for this polymorphism
@@ -38,7 +38,8 @@ module Wallaby
 
           # @param model_class [Class]
           # @param polymorphic_name [String] polymorphic name
-          # @return [Boolean] if polymorphism defined?
+          # @return [true] if polymorphism defined?
+          # @return [false] otherwise
           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/adapters/wallaby/active_record/model_decorator/fields_builder/sti_builder.rb

@@ -4,44 +4,48 @@ module Wallaby
   class ActiveRecord
     class ModelDecorator
       class FieldsBuilder
-        # To build the metadata for sti column
+        # This class updates the field metadata's value of **type** and **sti_class_list**
+        # for STI (Single Table Inheritance) model
         class StiBuilder
           # @param model_class [Class]
           def initialize(model_class)
             @model_class = model_class
           end
 
-          # update the metadata
+          # Update the field metadata's value for **type** and **sti_class_list**
           # @param metadata [Hash]
           # @param column [ActiveRecord::ConnectionAdapters::Column]
           def update(metadata, column)
             return unless @model_class.inheritance_column == column.name
 
             metadata[:type] = 'sti'
-            metadata[:sti_class_list] = sti_list(find_parent_of(@model_class))
+            metadata[:sti_class_list] = sti_list(find_sti_parent_of(@model_class))
           end
 
-          private
+          protected
 
+          # Return the alphabet-order STI list
+          # by traversing the inheritance tree for given model.
           # @param klass [Class]
-          # @return [Array<Class>] a list of STI classes for this model
+          # @return [Array<Class>]
           def sti_list(klass)
-            list = klass.descendants << klass
-            list.sort_by(&:name)
+            (klass.descendants << klass).sort_by(&:name)
           end
 
+          # Find out which parent is the one that can give us the STI list.
           # @param klass [Class]
-          # @return [Class] the top parent class in the STI hierarchy
-          def find_parent_of(klass)
+          # @return [Class]
+          def find_sti_parent_of(klass)
             parent = klass
-            parent = parent.superclass until top_parent?(parent.superclass)
+            parent = parent.superclass until not_sti_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.try(:abstract_class?)
+          # @return [true] if klass is ActiveRecord::Base or abstract
+          # @return [false] otherwise
+          def not_sti_parent?(klass)
+            klass == ::ActiveRecord::Base || klass.try(:abstract_class?)
           end
         end
       end

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

@@ -3,7 +3,7 @@
 module Wallaby
   class ActiveRecord
     class ModelDecorator
-      # To search and build the metadata for fields
+      # To build the metadata for fields
       class FieldsBuilder
         # @param model_class [Class]
         def initialize(model_class)
@@ -22,7 +22,8 @@ module Wallaby
           end
         end
 
-        # @return [Hash<String, Hash>] a hash for general fields
+        # @return [Hash<String, Hash>] a hash for association fields
+        #   (e.g. belongs_to / has_one / has_many / has_and_belongs_to_many)
         def association_fields
           @model_class.reflections.each_with_object({}) do |(name, ref), fields|
             metadata = {

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

@@ -16,15 +16,12 @@ module Wallaby
 
         # @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]
-          end
-          target_field = possible_title_fields.keys.find do |field_name|
-            TITLE_NAMES.any? { |v| field_name.to_s.index v }
-          end
-          target_field \
-            || possible_title_fields.keys.first \
-            || @model_class.primary_key
+          FieldUtils.first_field_by(
+            {
+              name: /title|name|label|string/,
+              type: 'string'
+            }, @fields
+          ) || @model_class.primary_key
         end
       end
     end

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

@@ -2,24 +2,25 @@
 
 module Wallaby
   class ActiveRecord
-    # Modal decorator for ActiveRecord
+    # Modal decorator for {Wallaby::ActiveRecord}
     class ModelDecorator < ::Wallaby::ModelDecorator
-      # Data types to exclude for index page
-      INDEX_EXCLUSIVE_DATA_TYPES =
-        (['', 'medium', 'long'] * 2)
-        .zip(%w(blob text) * 3).map(&:join)
-        .concat(%w(binary citext hstore json jsonb tsvector xml)).freeze
+      # Data types to exclude for {#index_field_names}
+      INDEX_EXCLUSIVE_DATA_TYPES = %w(
+        binary citext hstore json jsonb tsvector xml
+        blob mediumblob longblob text mediumtext longtext
+      ).freeze
 
-      # Class to exclude for show page
+      # Classes to exclude for {#show_field_names}
       SHOW_EXCLUSIVE_CLASS_NAMES = %w(ActiveStorage::Attachment ActiveStorage::Blob).freeze
 
-      # Data types to exclude for form page
+      # Fields to exclude for {#form_field_names}
       FORM_EXCLUSIVE_DATA_TYPES = %w(created_at updated_at).freeze
 
-      # Origin metadata directly coming from ActiveRecord.
+      # Original metadata information of the primative and association fields
+      # pulling out from the ActiveRecord model.
       #
-      # It needs to be frozen so that we can keep the metadata integrity
-      # @example sample fields:
+      # It needs to be frozen so that we can keep the metadata intact.
+      # @example sample fields metadata:
       #   model_decorator.fields
       #   # =>
       #   {
@@ -27,28 +28,29 @@ module Wallaby
       #     id: { name: 'id', type: 'integer', label: 'Id' },
       #     # association field
       #     category: {
-      #       'name' => 'category',
-      #       'type' => 'belongs_to',
-      #       'label' => 'Category',
-      #       'is_association' => true,
-      #       'is_through' => false,
-      #       'has_scope' => false,
-      #       'foreign_key' => 'category_id',
-      #       'class' => Category
+      #       name: 'category',
+      #       type: 'belongs_to',
+      #       label: 'Category',
+      #       is_association: true,
+      #       is_through: false,
+      #       has_scope: false,
+      #       foreign_key: 'category_id',
+      #       class: Category
       #     }
       #   }
       # @return [ActiveSupport::HashWithIndifferentAccess] metadata
       def fields
+        # NOTE: Need to check the database and table's existence before building up the metadata
+        # so that the database creation and migration related task can be executed.
         @fields ||= ::ActiveSupport::HashWithIndifferentAccess.new.tap do |hash|
-          # NOTE: Need to check database and table's existence
-          # before pulling out the metadata from model.
-          # So that the database and migration related task can be executed.
-          next unless ::ActiveRecord::Base.connected? && @model_class.table_exists?
+          next hash.default = {} unless @model_class.table_exists?
 
           hash.merge! general_fields
           hash.merge! association_fields
           hash.except!(*foreign_keys_from_associations)
         end.freeze
+      rescue ::ActiveRecord::NoDatabaseError
+        Hash.new({}).with_indifferent_access
       end
 
       # A copy of {#fields} for index page
@@ -86,7 +88,8 @@ module Wallaby
           end.keys
       end
 
-      # @return [Array<String>] a list of field names for form (new/edit) page (note: complex fields are excluded).
+      # @return [Array<String>] a list of field names for form (new/edit) page
+      #   (note: timestamps fields (e.g. created_at/updated_at) and complex relation fields are excluded).
       def form_field_names
         @form_field_names ||=
           form_fields.reject do |field_name, metadata|
@@ -109,9 +112,8 @@ module Wallaby
       # 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
+      # like a name or text representing this resource. Otherwise, it will fall
       # back to primary key.
-      #
       # @param resource [Object]
       # @return [String] the title of given resource
       def guess_title(resource)

data/lib/adapters/wallaby/active_record/model_finder.rb

@@ -2,43 +2,41 @@
 
 module Wallaby
   class ActiveRecord
-    # Model finder
+    # Finder to return all the appropriate ActiveRecord models.
     class ModelFinder < ::Wallaby::ModelFinder
-      # @return [Array<Class>] a list of ActiveRecord subclasses
+      # Return a list of ActiveRecord::Base subclasses that aren't one of the following types:
+      #
+      # 1. abstract class
+      # 2. anonymous class
+      # 3. the HABTM relation class
+      # @return [Array<Class>]
       def all
-        self.class.base.descendants.reject do |model_class|
-          abstract?(model_class) || anonymous?(model_class) || habtm?(model_class)
+        ::ActiveRecord::Base.descendants.reject do |model_class|
+          defined?(::ApplicationRecord) && model_class == ::ApplicationRecord ||
+            model_class.abstract_class? ||
+            anonymous?(model_class) ||
+            model_class.name.index('HABTM') ||
+            invalid_class_name?(model_class)
         end.sort_by(&:to_s)
       end
 
-      # This is only for ActiveRecord
-      # @return [ApplicationRecord, ActiveRecord::Base] base ActiveRecord class
-      def self.base
-        return ::ApplicationRecord if defined? ::ApplicationRecord
+      protected
 
-        ::ActiveRecord::Base
-      end
-
-      private
-
-      # Is model class abstract?
       # @param model_class [Class]
-      # @return [Boolean]
-      def abstract?(model_class)
-        model_class.abstract_class?
-      end
-
       # @see Wallaby::ModuleUtils.anonymous_class?
       def anonymous?(model_class)
-        ModuleUtils.anonymous_class? model_class
+        ModuleUtils.anonymous_class?(model_class).tap do |result|
+          Logger.warn "Anonymous class is detected for table #{model_class.try :table_name}" if result
+        end
       end
 
-      # Check and see if given model class is intermediate class that generated
-      # for has and belongs to many assocation
+      # To exclude classes that have invalid class name, e.g. **primary::SchemaMigration** from Rails test
       # @param model_class [Class]
-      # @return [Boolean]
-      def habtm?(model_class)
-        model_class.name.index('HABTM')
+      def invalid_class_name?(model_class)
+        model_class.name.constantize
+        false
+      rescue NameError
+        true
       end
     end
   end

data/lib/adapters/wallaby/active_record/model_pagination_provider.rb

@@ -8,25 +8,17 @@ module Wallaby
       # @return [true] if paginatable
       # @return [false] if not paginatable
       def paginatable?
-        paginatable =
-          # kaminari
-          @collection.respond_to?(:total_count) || \
-          @collection.respond_to?(:total_entries) # will_paginate
-        Rails.logger.warn "#{@collection.inspect} is not paginatable.\nfrom #{__FILE__}:#{__LINE__}" unless paginatable
-
-        paginatable
+        (@collection.respond_to?(:unscope) && @collection.respond_to?(:count)).tap do |paginatable|
+          Logger.warn "#{@collection} is not paginatable." unless paginatable
+        end
       end
 
       # @return [Integer] total count for the collection
       def total
-        # kaminari
-        @collection.try(:total_count) || \
-          @collection.try(:total_entries) # will_paginate
+        @collection.unscope(:offset, :limit).count
       end
 
-      # @return [Integer] page size from parameters or
-      #   {https://rubydoc.info/gems/wallaby-core/Wallaby/Configuration/Pagination#page_size-instance_method page_size}
-      #   Wallaby configuration
+      # @return [Integer] page size from parameters or Wallaby configuration
       def page_size
         (@params[:per] || Wallaby.configuration.pagination.page_size).to_i
       end

data/lib/adapters/wallaby/active_record/model_service_provider/permitter.rb

@@ -3,7 +3,7 @@
 module Wallaby
   class ActiveRecord
     class ModelServiceProvider
-      # Filter the params
+      # Whitelist the params for mass-assignment
       class Permitter
         # @param model_decorator [Wallaby::ModelDecorator]
         def initialize(model_decorator)

data/lib/adapters/wallaby/active_record/model_service_provider/querier/escaper.rb

@@ -11,6 +11,14 @@ module Wallaby
           PCT = '%' # :nodoc:
 
           class << self
+            # @example Return the escaped keyword if the first/last char of the keyword is `%`/`_`
+            #   Wallaby::ActiveRecord::ModelServiceProvider::Querier::Escaper.execute('%something_else%')
+            #   # => '%something\_else%'
+            # @example Return the escaped keyword wrapped with `%` if the first/last char of the keyword is NOT `%`/`_`
+            #   Wallaby::ActiveRecord::ModelServiceProvider::Querier::Escaper.execute('keyword')
+            #   # => '%keyword%'
+            # @param keyword [String]
+            # @return [String] escaped string for LIKE query
             def execute(keyword)
               first = keyword.first
               last = keyword.last
@@ -23,6 +31,12 @@ module Wallaby
               "#{starting}#{escaped}#{ending}"
             end
 
+            protected
+
+            # @param first_condition [Boolean] first condition
+            # @param first_char [Boolean] first char
+            # @param second_condition [nil, String] second condition
+            # @param default_sign [String]
             def sign(
               first_condition, first_char, second_condition, default_sign = PCT
             )

data/lib/adapters/wallaby/active_record/model_service_provider/querier/transformer.rb

@@ -34,9 +34,21 @@ module Wallaby
             ':!()' => :not_between
           }.freeze
 
+          SEQUENCE_JOIN_OPERATORS = { # :nodoc:
+            ':' => :or,
+            ':=' => :or,
+            ':!' => :and,
+            ':!=' => :and,
+            ':<>' => :and
+          }.freeze
+
+          BETWEEN_OPERATORS = { # :nodoc:
+            ':()' => true,
+            ':!()' => true
+          }.freeze
+
           # For single null
           rule null: simple(:value)
-          rule null: sequence(:value)
 
           # For single boolean
           rule(boolean: simple(:value)) { /true/i.match? value }
@@ -51,8 +63,7 @@ module Wallaby
           rule left: simple(:left), op: simple(:op), right: simple(:right) do
             oped = op.try :to_str
             operator = SIMPLE_OPERATORS[oped]
-            # skip if the operator is unknown
-            next unless operator
+            next Transformer.warn "Unknown operator #{oped} for %<exp>s", instance_values unless operator
 
             lefted = left.try :to_str
             convert =
@@ -68,24 +79,45 @@ module Wallaby
           rule left: simple(:left), op: simple(:op), right: sequence(:right) do
             oped = op.try :to_str
             operator = SEQUENCE_OPERATORS[oped]
-            next unless operator
+            next Transformer.warn "Unknown operator #{oped} for %<exp>s", instance_values unless operator
 
             exps = Wrapper.new
             lefted = left.try :to_str
-            if right.include? nil
-              nil_operator = SIMPLE_OPERATORS[oped]
-              next unless nil_operator
+            if BETWEEN_OPERATORS[oped] # BETWEEN related operators
+              next Transformer.warn 'Invalid values for %<exp>s', instance_values unless right.first && right.second
 
-              exps.push left: lefted, op: nil_operator, right: right.delete(nil)
+              convert = Range.new right.first, right.second
+              exps.push left: lefted, op: operator, right: convert
+            else
+              join = SEQUENCE_JOIN_OPERATORS[oped]
+              if right.include? nil
+                exps.push left: lefted, op: SIMPLE_OPERATORS[oped], right: right.delete(nil), join: join
+              end
+              exps.push left: lefted, op: operator, right: right, join: join
             end
-            convert = Range.new right.try(:first), right.try(:second) if %w(:() :!()).include?(oped)
-            exps.push left: lefted, op: operator, right: convert || right
             exps
           end
 
-          def transform(query_string)
-            result = apply Parser.new.parse(query_string || EMPTY_STRING)
-            result.is_a?(Array) ? result : [result]
+          class << self
+            # @param query_string [String]
+            # @return [Array]
+            def execute(query_string)
+              result = new.apply Parser.new.parse(query_string || EMPTY_STRING)
+              result.is_a?(Array) ? result : [result]
+            end
+
+            # @param message [String]
+            # @param exp [Hash,nil] transformed expression
+            # @return [nil]
+            def warn(message, exp = nil)
+              Logger.warn message, exp: to_origin(exp), sourcing: 2
+            end
+
+            # @param exp [Hash,nil] transformed expression
+            # @return [String] origin expression
+            def to_origin(exp)
+              "'#{exp['left']}#{exp['op']}#{exp['right']}'"
+            end
           end
         end
       end

data/lib/adapters/wallaby/active_record/model_service_provider/querier/wrapper.rb

@@ -4,18 +4,20 @@ module Wallaby
   class ActiveRecord
     class ModelServiceProvider
       class Querier
-        # Build up query using the results
+        # Wrapper for the {Wallaby::ActiveRecord::ModelServiceProvider::Querier::Transformer} result.
+        # It's only used by {Wallaby::ActiveRecord::ModelServiceProvider::Querier} to tell it apart
+        # with non-{Wallaby::ActiveRecord::ModelServiceProvider::Querier::Transformer} result
         class Wrapper
           attr_reader :list
-          delegate :push, :each, to: :list
+          delegate :push, to: :list
+          delegate :each, to: :list
+          delegate :last, to: :list
+          delegate :[], to: :last
 
+          # @param list [Array]
           def initialize(list = [])
             @list = list
           end
-
-          def [](key)
-            list.last[key]
-          end
         end
       end
     end

data/lib/adapters/wallaby/active_record/model_service_provider/querier.rb

@@ -26,7 +26,7 @@ module Wallaby
           scope.where query
         end
 
-        private
+        protected
 
         # @return [Arel::Table] arel table
         def table
@@ -36,7 +36,7 @@ module Wallaby
         # @param params [ActionController::Parameters]
         # @return [Array<String, Array, Array>] filter_name, keywords, field_queries
         def extract(params)
-          expressions = Transformer.new.transform params[:q]
+          expressions = Transformer.execute params[:q]
           keywords = expressions.select { |v| v.is_a? String }
           field_queries = expressions.select { |v| v.is_a? Wrapper }
           filter_name = params[:filter]
@@ -149,7 +149,7 @@ module Wallaby
           query = nil
           exps.each do |exp|
             sub = table[exp[:left]].try(exp[:op], exp[:right])
-            query = query.try(:or, sub) || sub
+            query = query.try(exp[:join], sub) || sub
           end
           query
         end

data/lib/adapters/wallaby/active_record/model_service_provider/validator.rb

@@ -3,7 +3,7 @@
 module Wallaby
   class ActiveRecord
     class ModelServiceProvider
-      # Validator
+      # Validate values for record create / update
       class Validator
         # @param model_decorator [Wallaby::ModelDecorator]
         def initialize(model_decorator)
@@ -11,7 +11,8 @@ module Wallaby
         end
 
         # @param resource [Object] resource object
-        # @return [Boolean] whether the resource object is valid
+        # @return [true] if the resource object is valid
+        # @return [false] otherwise
         def valid?(resource)
           resource.attributes.each do |field_name, values|
             metadata = @model_decorator.fields[field_name]
@@ -22,10 +23,11 @@ module Wallaby
           resource.errors.blank?
         end
 
-        private
+        protected
 
         # @param values [Array]
-        # @return [Boolean] whether the values are valid range values
+        # @return [true] if the values are valid range values
+        # @return [false] otherwise
         def valid_range_type?(values, metadata)
           !metadata \
             || !%w(daterange tsrange tstzrange).include?(metadata[:type]) \

data/lib/adapters/wallaby/active_record/model_service_provider.rb

@@ -8,7 +8,6 @@ module Wallaby
       # @param action [String, Symbol]
       # @param authorizer
       # @return [ActionController::Parameters] whitelisted parameters
-      # @see Wallaby::ModelServiceProvider#permit
       def permit(params, action, authorizer)
         authorized_fields = authorizer.permit_params action, @model_class
         params.require(param_key).permit(authorized_fields || permitted_fields)
@@ -18,7 +17,6 @@ module Wallaby
       # @param params [ActionController::Parameters]
       # @param authorizer [Ability] for now
       # @return [ActiveRecord::Relation] relation
-      # @see Wallaby::ModelServiceProvider#collection
       def collection(params, authorizer)
         query = querier.search params
         query = query.order params[:sort] if params[:sort].present?
@@ -28,19 +26,15 @@ module Wallaby
       # @param query [ActiveRecord::Relation]
       # @param params [ActionController::Parameters]
       # @return [ActiveRecord::Relation] paginated query
-      # @see Wallaby::ModelServiceProvider#paginate
       def paginate(query, params)
-        # NOTE: do not take out the `.to_i` as will_paginate requires an integer `per_page`
         per = (params[:per] || Wallaby.configuration.pagination.page_size).to_i
-        query = query.page params[:page] if query.respond_to? :page
-        query = query.per per if query.respond_to? :per # kaminari
-        query = query.per_page per if query.respond_to? :per_page # will_paginate
+        page = [params[:page].to_i, 1].max # starting from page 1
+        query = query.offset((page - 1) * per).limit(per)
         query
       end
 
       # @note No mass assignment happens here!
       # @return [Object] new resource object
-      # @see Wallaby::ModelServiceProvider#new
       def new(_params, _authorizer)
         @model_class.new
       end
@@ -50,7 +44,6 @@ module Wallaby
       # @param id [Integer, String]
       # @return [Object] persisted resource object
       # @raise [Wallaby::ResourceNotFound] when record is not found
-      # @see Wallaby::ModelServiceProvider#find
       def find(id, _params, _authorizer)
         @model_class.find id
       rescue ::ActiveRecord::RecordNotFound
@@ -61,7 +54,6 @@ module Wallaby
       # @param resource [Object]
       # @param params [ActionController::Parameters]
       # @param authorizer [Wallaby::ModelAuthorizer]
-      # @see Wallaby::ModelServiceProvider#create
       def create(resource, params, authorizer)
         save __callee__, resource, params, authorizer
       end
@@ -70,14 +62,12 @@ module Wallaby
       # @param resource [Object]
       # @param params [ActionController::Parameters]
       # @param authorizer [Wallaby::ModelAuthorizer]
-      # @see Wallaby::ModelServiceProvider#update
       def update(resource, params, authorizer)
         save __callee__, resource, params, authorizer
       end
 
       # Remove a record from database
       # @param resource [Object]
-      # @see Wallaby::ModelServiceProvider#destroy
       def destroy(resource, _params, _authorizer)
         resource.destroy
       end
@@ -109,7 +99,8 @@ module Wallaby
 
       # See if a resource is valid
       # @param resource [Object]
-      # @return [Boolean]
+      # @return [true] if valid
+      # @return [false] otherwise
       def valid?(resource)
         validator.valid? resource
       end
@@ -137,22 +128,22 @@ module Wallaby
           permitter.simple_field_names << permitter.compound_hashed_fields
       end
 
-      # @see Wallaby::ModelServiceProvider::Permitter
+      # @return [Wallaby::ActiveRecord::ModelServiceProvider::Permitter]
       def permitter
         @permitter ||= Permitter.new @model_decorator
       end
 
-      # @see Wallaby::ModelServiceProvider::Querier
+      # @return [Wallaby::ActiveRecord::ModelServiceProvider::Querier]
       def querier
         @querier ||= Querier.new @model_decorator
       end
 
-      # @see Wallaby::ModelServiceProvider::Normalizer
+      # @return [Wallaby::ActiveRecord::ModelServiceProvider::Normalizer]
       def normalizer
         @normalizer ||= Normalizer.new @model_decorator
       end
 
-      # @see Wallaby::ModelServiceProvider::Validator
+      # @return [Wallaby::ActiveRecord::ModelServiceProvider::Validator]
       def validator
         @validator ||= Validator.new @model_decorator
       end

data/lib/adapters/wallaby/active_record/pundit_provider.rb

@@ -2,7 +2,7 @@
 
 module Wallaby
   class ActiveRecord
-    # Pundit provider for ActiveRecord
+    # Pundit provider for {Wallaby::ActiveRecord}
     class PunditProvider < PunditAuthorizationProvider
       # Filter a scope
       # @param _action [Symbol, String]
@@ -11,7 +11,7 @@ module Wallaby
       def accessible_for(_action, scope)
         Pundit.policy_scope! user, scope
       rescue Pundit::NotDefinedError
-        Rails.logger.warn "Cannot find scope policy for #{scope.inspect}.\nfrom #{__FILE__}:#{__LINE__}"
+        Logger.warn "Cannot find scope policy for `#{scope}`."
         scope
       end
     end

data/lib/adapters/wallaby/active_record.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 module Wallaby
-  # ActiveRecord mode
+  # The Wallaby::ActiveRecord mode that implements the {Wallaby::Core} interfaces
+  # to handle ActiveRecord model/instance in all CRUD operations
   class ActiveRecord < Mode
   end
 end

data/lib/wallaby/active_record/version.rb

@@ -2,6 +2,6 @@
 
 module Wallaby
   module ActiveRecordGem
-    VERSION = '0.2.2' # :nodoc:
+    VERSION = '0.2.7' # :nodoc:
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wallaby-active_record
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.7
 platform: ruby
 authors:
 - Tian Chen
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-19 00:00:00.000000000 Z
+date: 2022-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.3
 - !ruby/object:Gem::Dependency
   name: cancancan
   requirement: !ruby/object:Gem::Requirement
@@ -132,7 +132,7 @@ metadata:
   homepage_uri: https://github.com/wallaby-rails/wallaby-active_record
   source_code_uri: https://github.com/wallaby-rails/wallaby-active_record
   changelog_uri: https://github.com/wallaby-rails/wallaby-active_record/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -147,8 +147,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Wallaby's ActiveRecord ORM adapter
 test_files: []