croods 0.2.10 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47184f50917d2e0f8d4c16826c1d056b783813bfc6c54a0831bc8fb333155ba8
-  data.tar.gz: 38f8082f8019604ac318d7308b87c5bf167eb85b2b3c85b1e58795a46e2a4895
+  metadata.gz: 80ba62d306db9fbfaaef4c51506e3424a6ee78237fe60a02914d468dcf36a1e7
+  data.tar.gz: ddbd60c3e43de63e14a2ea06384429d8d5248b232945fe1f9089c861063ba7a3
 SHA512:
-  metadata.gz: 7bac77110662f6d9cbf664c3d59bb02a82f7a486cafc36a1ffa0e392772aff15ef78085b5e5f1f1ff60dd8a3235dba5e6a4c10cabb76ee70ce3364f5a1eaecbe
-  data.tar.gz: b7f08e87e4e51aa32067b805853f5fef004d4f8bd3b0163f63fec3abb7f797806cadf58da24b28a77709b8fb9b2c988aa7e606764ee702afd03a5aecf968e94a
+  metadata.gz: b5b393de7b8eec8efe3e2b7fe3250f768afd5f442324371d27f8f8a3bb54557c0eb707f84c850483292f7a5e062ce3a842ec41f8e2646a914d4e1c095d7d7a6c
+  data.tar.gz: 5610da27ba4a5cc4b5b9c73e7a7e955c8f0c363596631f92ac65fd23d96b3f812b026c3bcd967302587283e5b71c5f2b55502e0fd5356eda24f05e4a1778648a

data/lib/croods.rb

@@ -4,11 +4,16 @@ require 'rack/cors'
 require 'committee'
 require 'devise'
 require 'devise_token_auth'
+require 'kaminari'
+require 'api-pagination'
+require 'pg_search'
 require 'pundit'
 require 'schema_associations'
 require 'schema_auto_foreign_keys'
 require 'schema_validations'
 
+load 'pg_search/tasks.rb'
+
 module Croods
   cattr_accessor :namespaces, :json_schema, :multi_tenancy_by
 

data/lib/croods/controller/collection.rb

@@ -5,10 +5,65 @@ module Croods
     module Collection
       protected
 
+      def page_param
+        params[resource.page_attribute_name]
+      end
+
+      def search_param
+        params[resource.search_attribute_name]
+      end
+
+      def paginate_collection(list)
+        paginate(list.send(resource.page_method_name, page_param))
+      end
+
+      def search_collection(list)
+        return list unless search_param.present?
+
+        if resource.search_block.present?
+          list.instance_exec(search_param, &resource.search_block)
+        else
+          list.public_send resource.search_method_name, search_param
+        end
+      end
+
+      def order_by
+        params[:order_by].presence
+      end
+
+      def order
+        params[:order].presence
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      def sort_by_method(list)
+        if order_by && order
+          list.public_send(resource.sort_by, order_by, order)
+        elsif order_by
+          list.public_send(resource.sort_by, order_by)
+        elsif order
+          list.public_send(resource.sort_by, order)
+        else
+          list.public_send(resource.sort_by)
+        end
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      def sort(list)
+        if resource.sort_by_method?
+          sort_by_method(list)
+        else
+          list.order(resource.sort_by)
+        end
+      end
+
       def collection
-        resource
-          .apply_filters(policy_scope(model), params)
-          .order(resource.sort_by)
+        list = resource.apply_filters(policy_scope(model), params)
+        list = search_collection(list) unless resource.skip_search?
+        list = sort(list)
+        list = paginate_collection(list) if page_param.present?
+
+        list
       end
     end
   end

data/lib/croods/resource.rb

@@ -12,7 +12,9 @@ require_relative 'resource/json_schema'
 require_relative 'resource/authentication'
 require_relative 'resource/authorization'
 require_relative 'resource/filters'
+require_relative 'resource/pagination'
 require_relative 'resource/sorting'
+require_relative 'resource/search'
 require_relative 'resource/services'
 
 module Croods
@@ -32,7 +34,9 @@ module Croods
       include Authentication
       include Authorization
       include Filters
+      include Pagination
       include Sorting
+      include Search
       include Services
     end
   end

data/lib/croods/resource/attributes.rb

@@ -43,6 +43,10 @@ module Croods
         merged_attributes(self, model.columns_hash)
       end
 
+      def attribute_names
+        attributes.map { |key, _| key }
+      end
+
       def definitions
         attributes
           .merge(request_instance.additional_attributes)

data/lib/croods/resource/json_schema/links/collection.rb

@@ -33,6 +33,19 @@ module Croods
               filters
             end
 
+            def properties(resource)
+              properties = {}
+
+              params = resource.pagination_params + resource.order_params +
+                       resource.search_params
+
+              params.each do |attribute|
+                properties[attribute.name] = definition(attribute)
+              end
+
+              properties.merge(filters(resource))
+            end
+
             def definition(attribute)
               definition = Definition.schema(attribute)
 
@@ -42,13 +55,16 @@ module Croods
             end
 
             def required(resource)
-              resource.filters.reject(&:null).map(&:name)
+              collection_properties = resource.filters +
+                                      resource.pagination_params
+
+              collection_properties.reject(&:null).map(&:name)
             end
 
             def schema(resource)
               {
                 additionalProperties: false,
-                properties: filters(resource),
+                properties: properties(resource),
                 required: required(resource),
                 type: ['object']
               }

data/lib/croods/resource/model.rb

@@ -17,9 +17,20 @@ module Croods
         model_name.constantize
       end
 
+      def configure_search
+        return unless table_exists?
+
+        model.send(:include, PgSearch::Model)
+        model.send(:pg_search_scope,
+                   search_method_name,
+                   search_options)
+      end
+
       def create_model!
         Object.const_set(model_name, Class.new(Croods::Model))
 
+        configure_search unless model.resource.skip_search?
+
         model_blocks.each do |block|
           model.instance_eval(&block)
         end

data/lib/croods/resource/pagination.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module Pagination
+      def page_attribute
+        @page_attribute ||= Croods::Attribute.new(
+          Kaminari.config.param_name, :string, null: true
+        )
+      end
+
+      def per_page_attribute
+        @per_page_attribute ||= Croods::Attribute.new(
+          'per_page', :string, null: true
+        )
+      end
+
+      def pagination_params
+        @pagination_params ||= [page_attribute, per_page_attribute]
+      end
+
+      def page_attribute_name
+        @page_attribute.name
+      end
+
+      def page_method_name
+        @page_method_name ||= Kaminari.config.page_method_name
+      end
+    end
+  end
+end

data/lib/croods/resource/search.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module Search
+      def search_attribute
+        return if skip_search?
+
+        @search_attribute ||= Croods::Attribute.new(
+          'query', :string, null: true
+        )
+      end
+
+      def search_params
+        return [] if skip_search?
+
+        @search_params ||= [search_attribute]
+      end
+
+      def search_attribute_name
+        return if skip_search?
+
+        @search_attribute.name
+      end
+
+      def search_method_name
+        @search_method_name ||= :search
+      end
+
+      def default_search_options
+        searchable = []
+
+        attributes.each do |key, value|
+          searchable << key if value.type.in? %i[string text]
+        end
+
+        {
+          against: searchable
+        }
+      end
+
+      def search_options
+        @search_options ||= default_search_options
+      end
+
+      def search_block
+        @search_block
+      end
+
+      def skip_search?
+        @skip_search
+      end
+
+      def skip_search
+        @skip_search ||= true
+      end
+
+      def search_by(name, options = {}, &block)
+        @search_method_name = name
+        @search_options = options
+        @search_block = block
+      end
+    end
+  end
+end

data/lib/croods/resource/sorting.rb

@@ -3,10 +3,31 @@
 module Croods
   module Resource
     module Sorting
-      def sort_by(attribute = nil)
-        return @sort_by ||= :created_at unless attribute
+      def order_by_attribute
+        @order_by_attribute ||= Croods::Attribute.new(
+          'order_by', :string, null: true
+        )
+      end
+
+      def order_attribute
+        @order_attribute ||= Croods::Attribute.new(
+          'order', :string, null: true
+        )
+      end
+
+      def order_params
+        @order_params ||= [order_by_attribute, order_attribute]
+      end
+
+      def sort_by_method?
+        sort_by.is_a?(Symbol) && !sort_by.to_s.in?(attribute_names) &&
+          model.respond_to?(sort_by)
+      end
+
+      def sort_by(sort = nil)
+        return @sort_by ||= :created_at unless sort
 
-        @sort_by = attribute
+        @sort_by ||= sort
       end
     end
   end

data/lib/croods/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Croods
-  VERSION = '0.2.10'
+  VERSION = '0.3.4'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: croods
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.3.4
 platform: ruby
 authors:
 - Daniel Weinmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-22 00:00:00.000000000 Z
+date: 2021-04-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: api-pagination
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.8.2
 - !ruby/object:Gem::Dependency
   name: committee
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: pg_search
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.4
 - !ruby/object:Gem::Dependency
   name: pundit
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +100,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.4.3
+        version: 5.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.4.3
+        version: 5.2.5
 - !ruby/object:Gem::Dependency
   name: schema_associations
   requirement: !ruby/object:Gem::Requirement
@@ -296,8 +338,10 @@ files:
 - lib/croods/resource/json_schema/required.rb
 - lib/croods/resource/model.rb
 - lib/croods/resource/names.rb
+- lib/croods/resource/pagination.rb
 - lib/croods/resource/paths.rb
 - lib/croods/resource/policy.rb
+- lib/croods/resource/search.rb
 - lib/croods/resource/services.rb
 - lib/croods/resource/sorting.rb
 - lib/croods/routes.rb