dynamic_sunspot_search 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2b8d46b882af75b7e5a0aa53143658cd7b7a317
-  data.tar.gz: 234e61077f907f6ab306f752f3fa71356c61aa3f
+  metadata.gz: 057d51285b3fcce265bf19561a6d04cb41b63eef
+  data.tar.gz: d5cde668784329378f7e5f3c93d1d712d0cce417
 SHA512:
-  metadata.gz: 19722ee4d4f3dbf96774e7645ffa2ddd423a6a59eca3d22d21b63672e446f15e7aaade5b6576317f10b810c8371a0b26d573cf1bf33a06e237c81aecccd8a1d2
-  data.tar.gz: 6963b39e069378a04e96819bc736b31c9c7d242b6ab335530d667bdadff822880d60a50333730139f59b3de5ccc4316d6d1ca542b004e6fa108063b36dd19e0c
+  metadata.gz: 62524c3fe09f6b10b23fdbe455e9bd8951db44a0c850c96c0e28d3c3aa149a9a05f9979e565f166baa23989ed1a8101dded0a8bbaaa190b623981bc26a2801cc
+  data.tar.gz: 6856caf7f073660ef89d39e074711b5a88b3777c418009572c7ae4c9d6e0fa97dc24f42483a3d837626220d67457387776a382f528e89d22c8c057e7edc68916

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dynamic_sunspot_search (0.1.0)
+    dynamic_sunspot_search (0.1.3)
       activesupport
 
 GEM
@@ -188,4 +188,4 @@ DEPENDENCIES
   sunspot_solr
 
 BUNDLED WITH
-   1.16.0
+   1.16.1

data/README.md

@@ -650,6 +650,71 @@ Post.dynamic_search({
 })
 ```
 
+#### Boost By Recency
+
+By default, Sunspot orders results by "score": the Solr-determined
+relevancy metric. This score can be weighted based on the documents recency by
+defining a field as type trie:
+
+```ruby
+class Post
+  searchable do
+    # ...
+    time :published_at, trie: true
+    # ...
+  end
+```
+
+Then by using the `boost_receny` method, where half_life defines the half life
+period of the exponential decay function:
+
+```ruby
+# Posts that were published 5 day ago will have their scores cut in half
+Post.dynamic_search({
+  fulltext: 'pizza',
+  boost_recency: {
+    field: :published_at,
+    half_life: {
+      days: 5,
+    },
+  },
+})
+
+# Posts that were published 1 year ago will have their scores cut in half
+Post.dynamic_search({
+  fulltext: 'pizza',
+  boost_recency: {
+    field: :published_at,
+    half_life: {
+      year: 1,
+    },
+  },
+})
+
+# Posts that were published 37 minutes and 10 seconds ago will have their scores cut in half
+Post.dynamic_search({
+  fulltext: 'pizza',
+  boost_recency: {
+    field: :published_at,
+    half_life: {
+      minutes: 37,
+      seconds: 10,
+    },
+  },
+})
+
+# Posts that were published 29.5 months ago will have their scores cut in half
+Post.dynamic_search({
+  fulltext: 'pizza',
+  boost_recency: {
+    field: :published_at,
+    half_life: {
+      months: 29.5,
+    },
+  },
+})
+```
+
 ### Geospatial
 
 **Sunspot 2.0 only**

data/lib/dynamic_sunspot_search/translator.rb

@@ -1,3 +1,4 @@
+require 'dynamic_sunspot_search/translator/boost_recency'
 require 'dynamic_sunspot_search/translator/facet'
 require 'dynamic_sunspot_search/translator/field_list'
 require 'dynamic_sunspot_search/translator/order_by'
@@ -18,6 +19,7 @@ module DynamicSunspotSearch
         OrderByFunction.apply(search, query.delete(:order_by_function))
         Paginate.apply(search, query.delete(:paginate))
         Facet.apply(search, query.delete(:facet))
+        BoostRecency.apply(search, query.delete(:boost_recency))
         raise ArgumentError.new("Unknown keys detected: #{query.keys}") unless query.blank?
       end
     end

data/lib/dynamic_sunspot_search/translator/boost_recency.rb

@@ -0,0 +1,41 @@
+require 'bigdecimal'
+
+module DynamicSunspotSearch
+  module Translator
+    module BoostRecency
+      # Boost by recency: https://wiki.apache.org/solr/FunctionQuery#Date_Boosting
+      def self.apply(query_object, options)
+        return unless options.present?
+        query_object.tap do |search|
+          Array.wrap(options).each do |recency_boost|
+            apply_recency_boost(query_object, recency_boost)
+          end
+        end
+      end
+
+      def self.apply_recency_boost(query_object, recency_boost)
+        return unless recency_boost.present?
+        field = recency_boost.delete(:field)
+        half_life = recency_boost.delete(:half_life)
+        query_object.tap do |search|
+          search.adjust_solr_params do |sunspot_params|
+            sunspot_params[:defType] = 'edismax'
+            sunspot_params[:boost] = build_boost_string(field, half_life)
+          end
+        end
+      end
+
+      def self.build_boost_string(field, half_life)
+        half_life_ms = calculate_half_life_ms(half_life)
+        half_life_recip = BigDecimal((1.0/(half_life_ms)).to_s).to_s('E').downcase
+        "recip(ms(NOW,#{field.to_s}_dt),#{half_life_recip},100,1)"
+      end
+
+      def self.calculate_half_life_ms(options)
+        options.reduce(0) do |half_life_ms, (period, value)|
+          half_life_ms += value.to_f.send(period.to_sym).to_i*1000
+        end
+      end
+    end
+  end
+end

data/lib/dynamic_sunspot_search/version.rb

@@ -1,3 +1,3 @@
 module DynamicSunspotSearch
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamic_sunspot_search
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Will Bryant
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-05 00:00:00.000000000 Z
+date: 2018-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -235,6 +235,7 @@ files:
 - lib/dynamic_sunspot_search/translator/all_of.rb
 - lib/dynamic_sunspot_search/translator/any.rb
 - lib/dynamic_sunspot_search/translator/any_of.rb
+- lib/dynamic_sunspot_search/translator/boost_recency.rb
 - lib/dynamic_sunspot_search/translator/facet.rb
 - lib/dynamic_sunspot_search/translator/field_list.rb
 - lib/dynamic_sunspot_search/translator/fulltext.rb