trestle-search 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6e66c7976251e2847893227f257d2d71928c01ec
-  data.tar.gz: 806335714fe6464a0d15f8787d8752b8e49dbf82
+SHA256:
+  metadata.gz: 3b0d81acc19c8af1130e82598e8a8c6692ea1d303874f9ddc4b44a91b816447b
+  data.tar.gz: c806a1734cd63cebc00e78c19f2191da54ef56675eb11ca7e50fac1b55039d19
 SHA512:
-  metadata.gz: 598078f2d1171666b33708e3cc8b3258006307234f5acc6b32c0b803e93aeafad702c63953da1dfb5f0dbb98d61e8148a8003ba1c957f552136cb1cab52f61ea
-  data.tar.gz: 8dccd48ea03cfdadaa8cddb29d4bb4c3a673804423922135aa9d775091b9c5a4a9e481b6dbd7e3ae2b182e173611aca035430db3441bf6b895f97b2e1540edf6
+  metadata.gz: 36f4856d6b27759116fd98f589fff5101e283c9f2d66d7525791424df9678cd2496cccab3fdc5eb2ac2a4936eda31b63d601094201e623a965f9e208314e4824
+  data.tar.gz: 91022be5e6490aad23d6c9adc8cc751a5e3d5bf599550160e18c1b9e8c7832685539928a0924d6c3506e26b818b5656dbe0fb90620d0a5bfc6e352f00e82e8bd

data/README.md

@@ -17,17 +17,19 @@ To enable search capabilities within an admin resource, define a `search` block:
 
 ```ruby
 Trestle.resource(:articles) do
-  search do |q|
-    Article.where("title ILIKE ?", "%#{q}%")
+  search do |query|
+    if query
+      Article.where("title ILIKE ?", "%#{query}%")
+    else
+      Article.all
+    end
   end
 end
 ```
 
-The search block accepts one or two parameters; the first is the string value of the search query. The second, optional parameter is the full `params` hash.
-
-The search block will be called instead of the default (or custom) `collection` block when the `q` query parameter is present (i.e. when a search query has been entered). It must return a chainable scope.
+The search block accepts one or two parameters; the first is the string value of the search query. The second, optional parameter is the full `params` hash. The block should return a chainable scope.
 
-The original collection block can be called to avoid redefining scopes. For example:
+The search block overrides the default (or custom) `collection` block. However the original collection block can be called to avoid redefining scopes. For example:
 
 ```ruby
 Trestle.resource(:articles) do
@@ -36,12 +38,20 @@ Trestle.resource(:articles) do
   end
 
   search do |q|
-    collection.where("title ILIKE ?", "%#{q}%")
+    q ? collection.where("title ILIKE ?", "%#{q}%") : collection
   end
 end
 ```
 
 
+## Integration Examples
+
+1. [ActiveRecord (ILIKE)](https://github.com/TrestleAdmin/trestle-search/wiki/Integration-with-ActiveRecord-(ILIKE))
+2. [PgSearch](https://github.com/TrestleAdmin/trestle-search/wiki/Integration-with-PgSearch)
+3. [Chewy](https://github.com/TrestleAdmin/trestle-search/wiki/Integration-with-Chewy)
+4. [Sunspot](https://github.com/TrestleAdmin/trestle-search/wiki/Integration-with-Sunspot)
+
+
 ## License
 
 The gem is available as open source under the terms of the [LGPLv3 License](https://opensource.org/licenses/LGPL-3.0).

data/config/locale/en.yml

@@ -1,5 +1,5 @@
 en:
   admin:
     search:
-      placeholder: Search
-      results: Search Results
+      placeholder: "Search"
+      results: "Search Results"

data/config/locale/pl.yml

@@ -0,0 +1,5 @@
+pl:
+  admin:
+    search:
+      placeholder: "Szukaj"
+      results: "Wyniki wyszukiwania"

data/config/locale/pt-BR.yml

@@ -0,0 +1,5 @@
+pt-BR:
+  admin:
+    search:
+      placeholder: "Pesquisar"
+      results: "Resultados da Pesquisa"

data/lib/trestle/search.rb

@@ -1,5 +1,7 @@
 require "trestle/search/version"
 
+require "trestle"
+
 module Trestle
   module Search
     extend ActiveSupport::Autoload
@@ -7,6 +9,11 @@ module Trestle
     autoload :Builder
     autoload :Controller
     autoload :Resource
+
+    autoload_under "adapters" do
+      autoload :ChewyAdapter
+      autoload :SunspotAdapter
+    end
   end
 end
 

data/lib/trestle/search/adapters/chewy_adapter.rb

@@ -0,0 +1,9 @@
+module Trestle
+  module Search
+    module ChewyAdapter
+      def finalize_collection(query)
+        query.records
+      end
+    end
+  end
+end

data/lib/trestle/search/adapters/sunspot_adapter.rb

@@ -0,0 +1,29 @@
+module Trestle
+  module Search
+    module SunspotAdapter
+      def merge_scopes(scope, other)
+        other
+      end
+
+      def count(search)
+        search.execute.hits.total_count
+      end
+
+      def sort(search, field, order)
+        search.build do
+          order_by(field, order)
+        end
+      end
+
+      def paginate(search, params)
+        search.build do
+          paginate(page: params[:page], per_page: 25)
+        end
+      end
+
+      def finalize_collection(search)
+        search.execute.results
+      end
+    end
+  end
+end

data/lib/trestle/search/resource.rb

@@ -4,17 +4,15 @@ module Trestle
       attr_writer :search
 
       def initialize_collection(params)
-        query_param = params[:q]
-
-        if searchable? && query_param.present?
-          search(query_param, params)
+        if searchable?
+          search(params[:q], params)
         else
           super(params)
         end
       end
 
       def search(query, params)
-        instance_exec(query, params, &@search)
+        instance_exec(query.presence, params, &@search)
       end
 
       def searchable?

data/lib/trestle/search/version.rb

@@ -1,5 +1,5 @@
 module Trestle
   module Search
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

data/trestle-search.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "trestle", "~> 0.8"
+  spec.add_dependency "trestle", "~> 0.8", ">= 0.8.7"
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trestle-search
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Sam Pohlenz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-31 00:00:00.000000000 Z
+date: 2018-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trestle
@@ -17,6 +17,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -84,7 +90,11 @@ files:
 - app/views/trestle/search/_search.html.erb
 - config/initializers/trestle.rb
 - config/locale/en.yml
+- config/locale/pl.yml
+- config/locale/pt-BR.yml
 - lib/trestle/search.rb
+- lib/trestle/search/adapters/chewy_adapter.rb
+- lib/trestle/search/adapters/sunspot_adapter.rb
 - lib/trestle/search/builder.rb
 - lib/trestle/search/controller.rb
 - lib/trestle/search/engine.rb
@@ -111,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Search plugin for the Trestle admin framework