croods 0.3.0 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abd8dafdfb10c2b936a894dcb6da1057c6bfe3646f6e6d5af0f58d59d0be7bab
-  data.tar.gz: 8da5a9b8c82bacefae7d736610d7ba4e0e3305ecf832a602dd61cff0edc1b53c
+  metadata.gz: '05196570cc7a53898c790d3ab24038629f2e8a909df92fb9642b0c95d6f7ab14'
+  data.tar.gz: beecd504fcdb6cc2b824b6403e873b5b8dc6c0993717cec6ed2fcec50f25b6d2
 SHA512:
-  metadata.gz: deac1ff6c8763d738b8ccd20149632df9be2425690a1550d57172e3a922a1b685f484d848f39fa5f3a8a29b3bd596c4c8c27e6f7356dbd4d56d40ff0abf879a2
-  data.tar.gz: 7a7342dba26327dc7e1422b26adf56b08747a20a3062d1c1090b941c6d3cf4030f2953975fceb770fb1127cc15097e7398ee35ec0ca017c1a4a6b18ba3a78a4a
+  metadata.gz: 9a0c38196bcef7a198497d7fab1254f3e5e2924dd3a411d1016745dbcd828c000ecbb47f04324d33f2d4b4e20b893ea28f83d312c7aa792e09dcf36f784a6cd3
+  data.tar.gz: afdfc76c66c79e6f9c7e49ab9f21582f377a89e4c024f7e715af380e620fe08f6a5c9c259288c4a38f8be9de6a0534c78574cf1319d47231e798b4a12870812d

data/lib/croods.rb

@@ -6,11 +6,14 @@ 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

@@ -9,15 +9,58 @@ module Croods
         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 collection
-        list = resource
-          .apply_filters(policy_scope(model), params)
-          .order(resource.sort_by)
+      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
+        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

data/lib/croods/resource.rb

@@ -14,6 +14,7 @@ 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
@@ -35,6 +36,7 @@ module Croods
       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

@@ -36,7 +36,10 @@ module Croods
             def properties(resource)
               properties = {}
 
-              resource.pagination_params.each do |attribute|
+              params = resource.pagination_params + resource.order_params +
+                       resource.search_params
+
+              params.each do |attribute|
                 properties[attribute.name] = definition(attribute)
               end
 

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/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.3.0'
+  VERSION = '0.3.5'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: croods
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.5
 platform: ruby
 authors:
 - Daniel Weinmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-13 00:00:00.000000000 Z
+date: 2021-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: api-pagination
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.8.2
 - !ruby/object:Gem::Dependency
   name: committee
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +56,30 @@ dependencies:
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        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
@@ -86,14 +100,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.4.3
+        version: 5.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.4.3
+        version: 5.2.6
 - !ruby/object:Gem::Dependency
   name: schema_associations
   requirement: !ruby/object:Gem::Requirement
@@ -327,6 +341,7 @@ files:
 - 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