solrb 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ec22b8f3fb8d4af1362389b30173de437f3a66e0a56fd11189a66aa28c0a4f2
-  data.tar.gz: 36ae13f391bc00291bd4661c1ac910b6cdc2242f0c090a64d11c2385bca39274
+  metadata.gz: b9c229eff6ef2d2cef01522d3aac36ed852fcf37d2eddaebdf3545ede67cb7a1
+  data.tar.gz: 35b41eebe98c7d45cbaee285f19fe39a246ec9d3a250e4aa4a06a93b6733e543
 SHA512:
-  metadata.gz: ef11a6e93954a9b5245861b4753f722aa6f936f91fe2523ac4c31b685cf300cb37ae07247b24e70515914053d2e96330501bcb213c07aeef15cc6168c5540c71
-  data.tar.gz: 743961e7ae4540f4e67362554470bc3485ddab0ddfc557d4b0d27fd99b51c91b64c333e2a24a9a7839b9d87d7b514142e4302a701ba73f4a51be20a213f12c8c
+  metadata.gz: f364be89ae580d4b987c6bd097c9a4d68750c0c73cdc9ae15b8b263efff52bff65ed26f410fa9ffe42f958aee934cc932765af6d4d8128a519477b06d5835a9f
+  data.tar.gz: 8352cfffca004a27bc9105cdf020931e57967bd6ea512a5f0764bb91de65ee13c0111e721fa7bb7e361f697cb08570a2f9d5490f27056bca60daf5fea5c8a929

data/README.md

@@ -39,14 +39,14 @@ Object-Oriented approach to Solr in Ruby.
 Add `solrb` to your Gemfile:
 
 ```ruby
-gem solrb
+gem 'solrb'
 ```
 
 If you are going to use solrb with solr cloud:
 
 ```ruby
-gem zk # required for solrb solr-cloud integration
-gem solrb
+gem 'zk' # required for solrb solr-cloud integration
+gem 'solrb'
 ```
 
 # Configuration
@@ -362,8 +362,8 @@ Example of usage:
   ]
   request = Solr::Query::Request.new(search_term: 'term', fields: fields)
   # Solr::Query::Request will return only :id field by default.
-  # Specify additional return fields (fl param) by setting the request response_fields
-  request.response_fields = [:name, :category]
+  # Specify additional return fields (fl param) by setting the request field_list
+  request.field_list = [:name, :category]
   request.run(page: 1, page_size: 10)
 ```
 

data/lib/solr/document.rb

@@ -12,15 +12,16 @@ module Solr
       end
     end
 
-    attr_reader :id, :model_name, :score, :debug_info, :group
+    attr_reader :id, :model_name, :score, :debug_info, :group, :fields
 
     # TODO: model_name is specific for machinio
-    def initialize(id:, model_name: nil, score: nil, debug_info: nil, group: GroupInformation.empty)
+    def initialize(id:, model_name: nil, score: nil, debug_info: nil, group: GroupInformation.empty, fields: {})
       @id = id
       @model_name = model_name
       @score = score
       @debug_info = debug_info
       @group = group
+      @fields = fields
     end
   end
 end

data/lib/solr/query/request/edismax_adapter.rb

@@ -6,14 +6,15 @@ module Solr
         include Solr::Support::SchemaHelper
 
         EDISMAX_QUERY_FIELDS = :qf
-        EDISMAX_FILTER_QUERY = :fq
         EDISMAX_ADDITIVE_BOOST_FUNCTION = :bf
         EDISMAX_MULTIPLICATIVE_BOOST_FUNCTION = :boost
         EDISMAX_PHRASE_BOOST = :pf
         EDISMAX_PHRASE_SLOP = :ps
-        RESPONSE_FIELDS = :fl
+        FILTER_QUERY = :fq
+        FIELD_LIST = :fl
         RERANK_QUERY = :rq
         QUERY_OPERATOR = :'q.op'
+        JSON_FACET = :'json.facet'
 
         attr_reader :request
 
@@ -24,7 +25,7 @@ module Solr
         def to_h
           solr_params = { q: request.search_term, defType: :edismax }
           solr_params = add_query_fields(solr_params)
-          solr_params = add_response_fields(solr_params)
+          solr_params = add_field_list(solr_params)
           solr_params = add_filters(solr_params)
           solr_params = add_facets(solr_params)
           solr_params = add_boosting(solr_params)
@@ -41,20 +42,20 @@ module Solr
         private
 
         def add_query_fields(solr_params)
-          fields = request.fields.map(&:to_solr_s)
-          solr_params.merge(EDISMAX_QUERY_FIELDS => fields)
+          query_fields = request.query_fields.map(&:to_solr_s)
+          solr_params[EDISMAX_QUERY_FIELDS] = query_fields
+          solr_params
         end
 
         def add_filters(solr_params)
           filters = request.filters.map(&:to_solr_s)
-          solr_params.merge(EDISMAX_FILTER_QUERY => filters)
+          solr_params[FILTER_QUERY] = filters
+          solr_params
         end
-
+        
         def add_facets(solr_params)
           return solr_params if Array(request.facets).empty?
-
-          solr_params['json.facet'] = request.facets.map(&:to_solr_h).reduce(&:merge).to_json
-
+          solr_params[JSON_FACET] = request.facets.map(&:to_solr_h).reduce(&:merge).to_json
           solr_params
         end
 
@@ -68,16 +69,15 @@ module Solr
         def add_additive_boost_functions(solr_params)
           additive_boosts = request.boosting.additive_boost_functions.map(&:to_solr_s)
           if additive_boosts.any?
-            solr_params.merge(EDISMAX_ADDITIVE_BOOST_FUNCTION => additive_boosts)
-          else
-            solr_params
+            solr_params[EDISMAX_ADDITIVE_BOOST_FUNCTION] = additive_boosts
           end
+          solr_params
         end
 
         def add_multiplicative_boost_functions(solr_params)
           multiplicative_boosts = request.boosting.multiplicative_boost_functions.map(&:to_solr_s)
           if multiplicative_boosts.any?
-            solr_params = solr_params.merge(EDISMAX_MULTIPLICATIVE_BOOST_FUNCTION => multiplicative_boosts)
+            solr_params[EDISMAX_MULTIPLICATIVE_BOOST_FUNCTION] = multiplicative_boosts
             # https://stackoverflow.com/questions/47025453/
             maybe_add_spatial_fields(solr_params, request.boosting.spatial_boost)
           else
@@ -88,18 +88,16 @@ module Solr
         def add_phrase_boosts(solr_params)
           solr_phrase_boosts = request.boosting.phrase_boosts.map(&:to_solr_s)
           if solr_phrase_boosts.any?
-            solr_params.merge(EDISMAX_PHRASE_BOOST => solr_phrase_boosts)
-          else
-            solr_params
+            solr_params[EDISMAX_PHRASE_BOOST] = solr_phrase_boosts
           end
+          solr_params
         end
 
         def maybe_add_spatial_fields(solr_params, geodist_function)
           if geodist_function
-            solr_params.merge(pt: geodist_function.latlng, sfield: geodist_function.sfield)
-          else
-            solr_params
+            solr_params.merge!(pt: geodist_function.latlng, sfield: geodist_function.sfield)
           end
+          solr_params
         end
 
         def add_grouping(solr_params)
@@ -116,18 +114,20 @@ module Solr
         def add_sorting(solr_params)
           return solr_params if request.sorting.empty?
           solr_sorting = request.sorting.fields.map(&:to_solr_s).join(', ')
-          solr_params.merge(sort: solr_sorting)
+          solr_params[:sort] = solr_sorting
+          solr_params
         end
 
-        def add_response_fields(solr_params)
-          response_fields = 'id'
-          response_fields += ',score' if debug_mode?
-          response_fields += request.response_fields if request.response_fields
-          solr_params.merge(RESPONSE_FIELDS => response_fields)
+        def add_field_list(solr_params)
+          request.field_list.fields << :score if debug_mode?
+          field_list = request.field_list.to_solr_s
+          solr_params[FIELD_LIST] = field_list
+          solr_params
         end
 
         def add_debug(solr_params)
-          solr_params.merge(debug: debug_mode?)
+          solr_params[:debug] = debug_mode?
+          solr_params
         end
 
         def debug_mode?
@@ -141,17 +141,20 @@ module Solr
         def add_rerank_query(solr_params)
           return solr_params unless request.limit_docs_by_field
           rerank_query = request.limit_docs_by_field.to_solr_s
-          solr_params.merge(RERANK_QUERY => rerank_query)
+          solr_params[RERANK_QUERY] = rerank_query
+          solr_params
         end
 
         def add_phrase_slop(solr_params)
           return solr_params unless request.phrase_slop
-          solr_params.merge(EDISMAX_PHRASE_SLOP => request.phrase_slop)
+          solr_params[EDISMAX_PHRASE_SLOP] = request.phrase_slop
+          solr_params
         end
 
         def add_query_operator(solr_params)
           return solr_params unless request.query_operator
-          solr_params.merge(QUERY_OPERATOR => request.query_operator)
+          solr_params[QUERY_OPERATOR] = request.query_operator
+          solr_params
         end
       end
     end

data/lib/solr/query/request/field_list.rb

@@ -0,0 +1,25 @@
+module Solr
+  module Query
+    class Request
+      class FieldList
+        include Solr::Support::SchemaHelper
+
+        MANDATORY_FIELDS = %i[id].freeze
+
+        attr_accessor :fields
+
+        def initialize(fields: [])
+          @fields = fields
+        end
+
+        def empty?
+          fields.empty?
+        end
+
+        def to_solr_s
+          (MANDATORY_FIELDS + fields.map(&method(:solarize_field))).uniq.join(',')
+        end
+      end
+    end
+  end
+end

data/lib/solr/query/request.rb

@@ -7,6 +7,7 @@ require 'solr/query/request/edismax_adapter'
 require 'solr/query/request/grouping'
 require 'solr/query/request/boosting'
 require 'solr/query/request/spellcheck'
+require 'solr/query/request/field_list'
 require 'solr/query/request/sorting/field'
 require 'solr/query/request/sorting/function'
 require 'solr/query/request/field_with_boost'
@@ -18,13 +19,14 @@ module Solr
   module Query
     class Request
       attr_reader :search_term
-      attr_accessor :filters, :fields, :facets, :boosting, :debug_mode, :spellcheck,
-                    :limit_docs_by_field, :phrase_slop, :response_fields, :query_operator
+      attr_accessor :filters, :query_fields, :field_list, :facets, :boosting, :debug_mode, :spellcheck,
+                    :limit_docs_by_field, :phrase_slop, :query_operator
       attr_writer :grouping, :sorting
 
-      def initialize(search_term:, fields: [], filters: [])
+      def initialize(search_term:, query_fields: [], field_list: Solr::Query::Request::FieldList.new, filters: [])
         @search_term = search_term
-        @fields = fields
+        @query_fields = query_fields
+        @field_list = field_list
         @filters = filters
       end
 

data/lib/solr/query/response/parser.rb

@@ -72,7 +72,8 @@ module Solr
         def parse_regular_documents
           solr_response['response']['docs'].map do |d|
             debug_info = solr_response.dig('debug', 'explain', d['id'])
-            Document.new(id: d['id'], score: d['score'], debug_info: debug_info)
+            fields = d.dup.delete_if { |k, v| %w[id score].include?(k) }
+            Document.new(id: d['id'], score: d['score'], debug_info: debug_info, fields: fields)
           end
         end
 
@@ -82,8 +83,9 @@ module Solr
               next unless doc
               debug_info = solr_response.dig('debug', 'explain', doc['id'])
               group_information = Document::GroupInformation.new(key: solr_grouping_field, value: group['groupValue'])
+              fields = doc.dup.delete_if { |k, v| %w[id score].include?(k) }
               Document.new(id: doc['id'], score: doc['score'],
-                           debug_info: debug_info, group: group_information)
+                           debug_info: debug_info, group: group_information, fields: fields)
             end
           end.flatten.compact
         end

data/lib/solr/version.rb

@@ -1,3 +1,3 @@
 module Solr
-  VERSION = '0.1.9'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solrb
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Adriano Luz
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-07 00:00:00.000000000 Z
+date: 2019-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -220,6 +220,7 @@ files:
 - lib/solr/query/request/boosting/textual_field_value_match_boost_function.rb
 - lib/solr/query/request/edismax_adapter.rb
 - lib/solr/query/request/facet.rb
+- lib/solr/query/request/field_list.rb
 - lib/solr/query/request/field_with_boost.rb
 - lib/solr/query/request/filter.rb
 - lib/solr/query/request/geo_filter.rb
@@ -272,7 +273,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Solr Ruby client with a nice object-oriented API