solr4r 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ced727a63a4c77e523f0ba3e3ba2f963969af13
-  data.tar.gz: 652f439816c4998089d16f715ad9cf5838d564a2
+  metadata.gz: 7622780508966d197a2ea3101266d7aa886102c1
+  data.tar.gz: 6082b84092d225e23467b28b90a780c5c8d00b01
 SHA512:
-  metadata.gz: 52668f7763f45cb4d3ff9f1fb6369e17877109bfc3d5b5a59c786d05299441b39d21960b8b6d4c5f68c4c29b8d641d5cd790b0118e83de952583862d6737f9a7
-  data.tar.gz: 6a034823bc56d31121bdf52b96564f8fb65dee4a9e7d9ad458093247788315924c3b07f73d21371e414f84840a46edd6a23304d4bdfe62595e9fd8c71a41fa0f
+  metadata.gz: 27012fe1c76d4dd9d52599c41375ae71bde7929548a84dc781a48d8dd27f508709c0a1a5c55007cd11da7a2fb1ce2a79d2e5223d9d74024444cd37277becf399
+  data.tar.gz: 004c2706c97fd115fe2300ea265c353ac2aca0b878eea57af8ea14a6aae23523bb744bdb8e97d6416fe21568ab7d1238532bc8e50ff7ef509a7f72e7fe7a4045

data/ChangeLog

@@ -2,6 +2,18 @@
 
 = Revision history for solr4r
 
+== 0.3.0 [2016-03-23]
+
+* Extended Solr4R::Result for
+  debugging[https://wiki.apache.org/solr/CommonQueryParameters#Debugging].
+* Extended Solr4R::Result for
+  highlighting[https://wiki.apache.org/solr/HighlightingParameters].
+* Extended Solr4R::Result for
+  spellchecking[https://wiki.apache.org/solr/SpellCheckComponent].
+* Added support for date-/time objects and ranges.
+* Refactored Solr4R::Client, Solr4R::Builder, Solr4R::Document,
+  Solr4R::Result.
+
 == 0.2.0 [2015-12-14]
 
 * Updated Solr4R::Client::Query#more_like_this_q for Solr 5.4.0.

data/README

@@ -2,12 +2,12 @@
 
 == VERSION
 
-This documentation refers to solr4r version 0.2.0
+This documentation refers to solr4r version 0.3.0
 
 
 == DESCRIPTION
 
-TODO
+Access the {Apache Solr}[http://lucene.apache.org/solr/] search server from Ruby.
 
 
 == LINKS
@@ -25,7 +25,7 @@ Travis CI::     https://travis-ci.org/blackwinter/solr4r
 
 == LICENSE AND COPYRIGHT
 
-Copyright (C) 2014-2015 Jens Wille
+Copyright (C) 2014-2016 Jens Wille
 
 solr4r is free software: you can redistribute it and/or modify it
 under the terms of the GNU Affero General Public License as published by

data/Rakefile

@@ -16,7 +16,7 @@ begin
 
       dependencies: { nokogiri: '~> 1.6', 'nuggets' => '~> 1.4' },
 
-      development_dependencies: { vcr: '~> 2.9', webmock: '~> 1.22' },
+      development_dependencies: { vcr: '~> 3.0', webmock: '~> 1.24' },
 
       required_ruby_version: '>= 2.0'
     }

data/lib/solr4r/batch.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+
+#--
+###############################################################################
+#                                                                             #
+# solr4r -- A Ruby client for Apache Solr                                     #
+#                                                                             #
+# Copyright (C) 2014-2016 Jens Wille                                          #
+#                                                                             #
+# solr4r is free software: you can redistribute it and/or modify it under the #
+# terms of the GNU Affero General Public License as published by the Free     #
+# Software Foundation, either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# solr4r is distributed in the hope that it will be useful, but WITHOUT ANY   #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   #
+# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for     #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with solr4r. If not, see <http://www.gnu.org/licenses/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+module Solr4R
+
+  class Batch
+
+    STEP = 10
+
+    DEFAULT_SIZE = STEP ** 3
+
+    def initialize(client, attributes = {},
+        params = {}, options = {}, size = DEFAULT_SIZE, &block)
+      @client, @args, @size, @block =
+        client, [attributes, params, options], size, block
+
+      reset
+    end
+
+    attr_reader :client
+
+    attr_accessor :size
+
+    def reset
+      @batch, @failed = [], []
+    end
+
+    def clear
+      @batch.clear
+    end
+
+    def add(*docs)
+      batch(docs)
+    end
+
+    alias_method :<<, :add
+
+    def batch(docs)
+      flush unless @batch.concat(docs).size < size
+    end
+
+    def flush
+      process
+      clear
+      @failed
+    end
+
+    def inspect
+      '#<%s:0x%x @size=%p, @count=%p, @failed=%p>' % [
+        self.class, object_id, size, @batch.size, @failed.size
+      ]
+    end
+
+    private
+
+    def process(docs = @batch, size = size())
+      next_size = size.fdiv(STEP).ceil
+
+      docs.each_slice(size) { |batch|
+        client.add(batch, *@args, &@block).success? ? nil :
+          size > 1 ? process(batch, next_size) : @failed.concat(batch)
+      }
+    end
+
+  end
+
+end

data/lib/solr4r/builder.rb

@@ -5,7 +5,7 @@
 #                                                                             #
 # solr4r -- A Ruby client for Apache Solr                                     #
 #                                                                             #
-# Copyright (C) 2014-2015 Jens Wille                                          #
+# Copyright (C) 2014-2016 Jens Wille                                          #
 #                                                                             #
 # solr4r is free software: you can redistribute it and/or modify it under the #
 # terms of the GNU Affero General Public License as published by the Free     #
@@ -24,6 +24,7 @@
 #++
 
 require 'nokogiri'
+require 'time'
 
 module Solr4R
 
@@ -43,95 +44,129 @@ module Solr4R
 
     ILLEGAL_CHAR_RE = /[\x00-\x08\x0B\x0C\x0E-\x1F]/
 
-    def initialize(client, options = client.options)
+    class << self
+
+      def convert_value(value)
+        case value
+          when Time     then value.getutc.xmlschema
+          when DateTime then convert_value(value.to_time)
+          when Date     then convert_value(value.to_datetime)
+          else               value
+        end
+      end
+
+    end
+
+    def initialize(client = Client, options = nil)
       raise ArgumentError,
         'block argument not supported, use options hash instead' if block_given?
 
       @client = client
 
-      @solr4r_opt = DEFAULT_OPTIONS.merge(options)
-      @solr4r_doc = Document.new; d = @solr4r_doc.document
+      @solr4r_doc = doc = Document.new
+      @solr4r_opt = opt = DEFAULT_OPTIONS.dup
+
+      options ||= client.respond_to?(:options) ? client.options : {}
+      options.each { |k, v| opt[k.to_sym] = v if doc.respond_to?("#{k}=") }
 
-      super(@solr4r_opt.delete_if { |k,| !d.respond_to?("#{k}=") }, @solr4r_doc)
+      super(@solr4r_opt, @solr4r_doc)
     end
 
     attr_reader :client
 
-    # See Schema[http://wiki.apache.org/solr/UpdateXmlMessages#add.2Freplace_documents].
+    # See Schema[https://wiki.apache.org/solr/UpdateXmlMessages#add.2Freplace_documents].
     #
-    # Examples:
+    # ==== Examples:
+    #
+    # ===== Single document
     #
-    #   # single document
     #   add(employeeId: '05991', office: 'Bridgewater', skills: %w[Perl Java])
     #
-    #     <?xml version="1.0" encoding="UTF-8"?>
-    #     <add>
-    #       <doc>
-    #         <field name="employeeId">05991</field>
-    #         <field name="office">Bridgewater</field>
-    #         <field name="skills">Perl</field>
-    #         <field name="skills">Java</field>
-    #       </doc>
-    #     </add>
-    #
-    #   # multiple documents
+    # Result:
+    #
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <add>
+    #     <doc>
+    #       <field name="employeeId">05991</field>
+    #       <field name="office">Bridgewater</field>
+    #       <field name="skills">Perl</field>
+    #       <field name="skills">Java</field>
+    #     </doc>
+    #   </add>
+    #
+    # ===== Multiple documents
+    #
     #   add([{ employeeId: '05992', office: 'Blackwater' }, { employeeId: '05993', skills: 'Ruby' }])
     #
-    #     <?xml version="1.0" encoding="UTF-8"?>
-    #     <add>
-    #       <doc>
-    #         <field name="employeeId">05992</field>
-    #         <field name="office">Blackwater</field>
-    #       </doc>
-    #       <doc>
-    #         <field name="employeeId">05993</field>
-    #         <field name="skills">Ruby</field>
-    #       </doc>
-    #     </add>
-    #
-    #   # add attributes
+    # Result:
+    #
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <add>
+    #     <doc>
+    #       <field name="employeeId">05992</field>
+    #       <field name="office">Blackwater</field>
+    #     </doc>
+    #     <doc>
+    #       <field name="employeeId">05993</field>
+    #       <field name="skills">Ruby</field>
+    #     </doc>
+    #   </add>
+    #
+    # ===== Add attributes
+    #
     #   add([id: 42, text: 'blah'], commitWithin: 23)
     #
-    #     <?xml version="1.0" encoding="UTF-8"?>
-    #     <add commitWithin="23">
-    #       <doc>
-    #         <field name="id">42</field>
-    #         <field name="text">blah</field>
-    #       </doc>
-    #     </add>
+    # Result:
+    #
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <add commitWithin="23">
+    #     <doc>
+    #       <field name="id">42</field>
+    #       <field name="text">blah</field>
+    #     </doc>
+    #   </add>
+    #
+    # ===== Document attributes
     #
-    #   # document attributes
     #   add([[{ id: 42, text: 'blah' }, boost: 10.0]])
     #
-    #     <?xml version="1.0" encoding="UTF-8"?>
-    #     <add>
-    #       <doc boost="10.0">
-    #         <field name="id">42</field>
-    #         <field name="text">blah</field>
-    #       </doc>
-    #     </add>
+    # Result:
+    #
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <add>
+    #     <doc boost="10.0">
+    #       <field name="id">42</field>
+    #       <field name="text">blah</field>
+    #     </doc>
+    #   </add>
+    #
+    # ===== Field attributes
     #
-    #   # field attributes
     #   add(id: 42, text: ['blah', boost: 2.0])
     #
-    #     <?xml version="1.0" encoding="UTF-8"?>
-    #     <add>
-    #       <doc>
-    #         <field name="id">42</field>
-    #         <field name="text" boost="2.0">blah</field>
-    #       </doc>
-    #     </add>
+    # Result:
+    #
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <add>
+    #     <doc>
+    #       <field name="id">42</field>
+    #       <field name="text" boost="2.0">blah</field>
+    #     </doc>
+    #   </add>
+    #
+    # ===== All attributes together
     #
-    #   # all attributes together
     #   add([[{ id: 42, text: ['blah', boost: 2.0] }, boost: 10.0]], commitWithin: 23)
     #
-    #     <?xml version="1.0" encoding="UTF-8"?>
-    #     <add commitWithin="23">
-    #       <doc boost="10.0">
-    #         <field name="id">42</field>
-    #         <field name="text" boost="2.0">blah</field>
-    #       </doc>
-    #     </add>
+    # Result:
+    #
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <add commitWithin="23">
+    #     <doc boost="10.0">
+    #       <field name="id">42</field>
+    #       <field name="text" boost="2.0">blah</field>
+    #     </doc>
+    #   </add>
     def add(doc, attributes = {})
       to_xml(:add, attributes) { |add_node| _each(doc) { |hash, doc_attributes|
         add_node.doc_(doc_attributes) { |doc_node| hash.each { |key, values|
@@ -141,137 +176,179 @@ module Solr4R
             field_attributes.update((values = values.dup).pop)
           end
 
-          _each(values) { |value| doc_node.field_(value, field_attributes) }
+          _each_value(values) { |value| doc_node.field_(value, field_attributes) }
         } }
       } }
     end
 
     alias_method :doc, :add
 
-    # See Schema[http://wiki.apache.org/solr/UpdateXmlMessages#A.22commit.22_and_.22optimize.22].
+    # See Schema[https://wiki.apache.org/solr/UpdateXmlMessages#A.22commit.22_and_.22optimize.22].
+    #
+    # ==== Examples:
     #
-    # Examples:
+    # ===== Without options
     #
     #   commit
     #
-    #     <?xml version="1.0" encoding="UTF-8"?>
-    #     <commit/>
+    # Result:
+    #
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <commit/>
+    #
+    # ===== With options
     #
     #   commit(softCommit: true)
     #
-    #     <?xml version="1.0" encoding="UTF-8"?>
-    #     <commit softCommit="true"/>
+    # Result:
+    #
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <commit softCommit="true"/>
     def commit(attributes = {})
       to_xml(:commit, attributes)
     end
 
-    # See Schema[http://wiki.apache.org/solr/UpdateXmlMessages#A.22commit.22_and_.22optimize.22].
+    # See Schema[https://wiki.apache.org/solr/UpdateXmlMessages#A.22commit.22_and_.22optimize.22].
     #
-    # Examples:
+    # ==== Examples:
+    #
+    # ===== Without options
     #
     #   optimize
     #
-    #     <?xml version="1.0" encoding="UTF-8"?>
-    #     <optimize/>
+    # Result:
+    #
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <optimize/>
+    #
+    # ===== With options
     #
     #   optimize(maxSegments: 42)
     #
-    #     <?xml version="1.0" encoding="UTF-8"?>
-    #     <optimize maxSegments="42"/>
+    # Result:
+    #
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <optimize maxSegments="42"/>
     def optimize(attributes = {})
       to_xml(:optimize, attributes)
     end
 
-    # See Schema[http://wiki.apache.org/solr/UpdateXmlMessages#A.22rollback.22].
+    # See Schema[https://wiki.apache.org/solr/UpdateXmlMessages#A.22rollback.22].
     #
-    # Example:
+    # ==== Example:
     #
     #   rollback
     #
-    #     <?xml version="1.0" encoding="UTF-8"?>
-    #     <rollback/>
+    # Result:
+    #
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <rollback/>
     def rollback
       to_xml(:rollback)
     end
 
-    # See Schema[http://wiki.apache.org/solr/UpdateXmlMessages#A.22delete.22_documents_by_ID_and_by_Query].
+    # See Schema[https://wiki.apache.org/solr/UpdateXmlMessages#A.22delete.22_documents_by_ID_and_by_Query].
+    #
+    # See Query#query_string for handling of query hashes (via +client.query_string+).
     #
-    # See Client.query_string for handling of query hashes.
+    # ==== Examples:
     #
-    # Examples:
+    # ===== Single ID
     #
-    #   # single ID
     #   delete(id: '05991')
     #
-    #     <?xml version="1.0" encoding="UTF-8"?>
-    #     <delete>
-    #       <id>05991</id>
-    #     </delete>
+    # Result:
+    #
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <delete>
+    #     <id>05991</id>
+    #   </delete>
+    #
+    # ===== Multiple IDs
     #
-    #   # multiple IDs
     #   delete(id: %w[05991 06000])
     #
-    #     <?xml version="1.0" encoding="UTF-8"?>
-    #     <delete>
-    #       <id>05991</id>
-    #       <id>06000</id>
-    #     </delete>
+    # Result:
+    #
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <delete>
+    #     <id>05991</id>
+    #     <id>06000</id>
+    #   </delete>
+    #
+    # ===== Single query
     #
-    #   # single query
     #   delete(query: 'office:Bridgewater')
     #
-    #     <?xml version="1.0" encoding="UTF-8"?>
-    #     <delete>
-    #       <query>office:Bridgewater</query>
-    #     </delete>
+    # Result:
+    #
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <delete>
+    #     <query>office:Bridgewater</query>
+    #   </delete>
+    #
+    # ===== Multiple queries
     #
-    #   # multiple queries
     #   delete(query: %w[office:Bridgewater office:Osaka])
     #
-    #     <?xml version="1.0" encoding="UTF-8"?>
-    #     <delete>
-    #       <query>office:Bridgewater</query>
-    #       <query>office:Osaka</query>
-    #     </delete>
+    # Result:
+    #
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <delete>
+    #     <query>office:Bridgewater</query>
+    #     <query>office:Osaka</query>
+    #   </delete>
+    #
+    # ===== Query hash
     #
-    #   # query hash
     #   delete(query: { office: 'Bridgewater', skills: 'Perl' })
     #
-    #     <?xml version="1.0" encoding="UTF-8"?>
-    #     <delete>
-    #       <query>office:Bridgewater skills:Perl</query>
-    #     </delete>
+    # Result:
+    #
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <delete>
+    #     <query>office:Bridgewater skills:Perl</query>
+    #   </delete>
+    #
+    # ===== Query hash with array
     #
-    #   # query hash with array
     #   delete(query: { office: %w[Bridgewater Osaka] })
     #
-    #     <?xml version="1.0" encoding="UTF-8"?>
-    #     <delete>
-    #       <query>office:Bridgewater office:Osaka</query>
-    #     </delete>
+    # Result:
+    #
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <delete>
+    #     <query>office:Bridgewater office:Osaka</query>
+    #   </delete>
+    #
+    # ===== Query hash with LocalParams[https://wiki.apache.org/solr/LocalParams]
     #
-    #   # query hash with LocalParams
     #   delete(query: { office: 'Bridgewater', _: { type: :edismax } })
     #
-    #     <?xml version="1.0" encoding="UTF-8"?>
-    #     <delete>
-    #       <query>{!type=edismax}office:Bridgewater</query>
-    #     </delete>
+    # Result:
+    #
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <delete>
+    #     <query>{!type=edismax}office:Bridgewater</query>
+    #   </delete>
+    #
+    # ===== Both IDs and queries
     #
-    #   # both IDs and queries
     #   delete(id: %w[05991 06000], query: { office: %w[Bridgewater Osaka] })
     #
-    #     <?xml version="1.0" encoding="UTF-8"?>
-    #     <delete>
-    #       <id>05991</id>
-    #       <id>06000</id>
-    #       <query>office:Bridgewater office:Osaka</query>
-    #     </delete>
+    # Result:
+    #
+    #   <?xml version="1.0" encoding="UTF-8"?>
+    #   <delete>
+    #     <id>05991</id>
+    #     <id>06000</id>
+    #     <query>office:Bridgewater office:Osaka</query>
+    #   </delete>
     def delete(hash)
       to_xml(:delete) { |delete_node| hash.each { |key, values|
         case key.to_s
-          when 'id'    then _each(values) { |value| delete_node.id_(value) }
-          when 'query' then _each(values) { |value| delete_node.query_(
+          when 'id'    then _each_value(values) { |value| delete_node.id_(value) }
+          when 'query' then _each_value(values) { |value| delete_node.query_(
             client.query_string(value, false)) }
           else raise ArgumentError, "`id' or `query' expected, got %p" % key
         end
@@ -295,7 +372,15 @@ module Solr4R
     end
 
     def _each(values, &block)
-      (values.is_a?(Array) ? values : [values]).each(&block)
+      (values.respond_to?(:to_ary) ? values : [values]).each(&block)
+    end
+
+    def _each_value(values)
+      _each(values) { |value| yield convert_value(value) }
+    end
+
+    def convert_value(value)
+      self.class.convert_value(value)
     end
 
   end

data/lib/solr4r/client/{admin.rb → admin_mixin.rb}

@@ -5,7 +5,7 @@
 #                                                                             #
 # solr4r -- A Ruby client for Apache Solr                                     #
 #                                                                             #
-# Copyright (C) 2014-2015 Jens Wille                                          #
+# Copyright (C) 2014-2016 Jens Wille                                          #
 #                                                                             #
 # solr4r is free software: you can redistribute it and/or modify it under the #
 # terms of the GNU Affero General Public License as published by the Free     #
@@ -34,7 +34,7 @@ module Solr4R
     DEFAULT_ANALYZE_DOCUMENT_PATH = 'analysis/document'
     DEFAULT_ANALYZE_FIELD_PATH    = 'analysis/field'
 
-    module Admin
+    module AdminMixin
 
       def solr_version(type = :spec,
           params = {}, options = {}, path = DEFAULT_SYSTEM_PATH, &block)
@@ -77,7 +77,7 @@ module Solr4R
 
     end
 
-    include Admin
+    include AdminMixin
 
   end