croods 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9fa939ee66088adb051cc63ee6f9cfc1206da7674dd6f2c48c524ea0ca8b931
-  data.tar.gz: 9e9722e961a8b24760106965a385a5aad1a89d9b85369243d3497c2c3fc33784
+  metadata.gz: 63c99f117704edaa49eb759248b862eb75611b3cf97d0d539a70b946c94478fe
+  data.tar.gz: 377f6b1e1ba4619fb1004b31c9c23339fbaa47144f76dde57f58a6a09d4cf06e
 SHA512:
-  metadata.gz: 65565603371e3e5d46d3c8f412af157bd4e50ca2c1f6afc57a3577f4dd77f294bd63624c7f02585973214ff978d7312367d520916f7497c4f29f49f582b28f1b
-  data.tar.gz: 3d0f2872653a07a3edb49cdb3cc368e34eb153826a5066099ed250400000613ea128bbbf5dac4cc3563fffe87f67b94ac82d2854a8a30004010d4f6d200b9be5
+  metadata.gz: 7e16d6d4fdbab8d49a19f24561dc8018c91244373c5bd89de7667147c3186f55c29f183c90beb9a92164ef76392a2be1315db3f4ac0f4d7ef7d513f6c43b65d7
+  data.tar.gz: a01538c937bec85378379476e9d7948dfc87af86f5d952980875dea965e4352e2f14a0a94eae92145ed7730157523b544f12fefc16e44f5607407abfd3a305f7

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,10 +9,24 @@ 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 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 sort(list)
         if list.respond_to? resource.sort_by
           list.public_send(resource.sort_by, params[:order_by], params[:order])
@@ -23,6 +37,7 @@ module Croods
 
       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?
 

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/json_schema/links/collection.rb

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

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/version.rb

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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: croods
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Daniel Weinmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-14 00:00:00.000000000 Z
+date: 2020-10-23 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.4.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.4.3
+        version: 5.2.4.4
 - !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