solr_cursorstream 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e3d3cf7d36d2e1feb41469bd02fef47e283a628b405372b1f7ffff6f0f93ab5
-  data.tar.gz: 7058429a718019ee62d773abf7aa0142fab23c2473178929b89734125d188161
+  metadata.gz: '08b5d39809682e6bfae46ebfcfe294db8c6a8b3cc695b7ca63bc6087e2b017b7'
+  data.tar.gz: e378fbe72fb508093a034d23c90993f22ad8a58499e03d4650d3b19a75a3f440
 SHA512:
-  metadata.gz: 8a215e2969745c1bd62011e30f8fa21940fb60998553372127bd0f8b17c6371a8b7e83b31805df3ada851dd3185bcbb53b58813301b26aad9658bf2a289bdc4a
-  data.tar.gz: fff3c6c476750aca864700aab3e3c7e6569234d3f6d74f0bbed780f8ef7c06de6df57ff26c7001e6ddf7de705ce181a71280f1c5f375d4f90c9bbc07a6005502
+  metadata.gz: 262f1eea0c32255672234c9530e2fbf5854e540758a590fd48dbe845e3e43f4410dd2617298a72ce8b9fb2659293d2c82b35907d066d5eb2e325cfaab6ae7c8f
+  data.tar.gz: 7669af73e388a007b1b3356bdb3ec6637872439b76d054be21372c3f3b2aade6ca40b457929e7a8d43f14612682f29571e4eb7c7af7aaa6ce813a4f5e96a7c9d

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+# [0.2.0] - 2022-08-05
+
+Remove "@private" annotation from `default_params`
+
 ## [0.1.0] - 2022-06-21
  * Initial release
  * See bottom of README.md for todo list

data/README.md

@@ -18,11 +18,13 @@ downloading large sets of data without the "deep paging"
 out-of-memory problems 
 associated with just using the `start` and `rows` parameters. 
 
-The only significant restrictions is that _the sort specification MUST 
+The only real restriction is that _the sort specification MUST 
 include the`uniqueKey` field_. If you're just downloading a whole dataset and 
 don't care about order, the default query of `*:*` and the default sort of `id asc`
-will be fine (assuming your uniqueKey is `id`). If you want to sort by
-another field/value, you must use the uniqueKey in a secondary sort (e.g., 
+will be fine (assuming your uniqueKey is `id`). 
+
+If you want to sort by
+another field/value, just include the uniqueKey in a secondary sort (e.g., 
 `sort: "score desc, id asc"`) to guarantee a stable sort. 
 
 NOTE that if you don't need the `score` (relevancy) field, 
@@ -81,11 +83,12 @@ end
 
 ## TODO
 
-[ ] Add a :limit option
-[ ] Add a `lucene_escape` utility function
-[ ] Change q/fq to take either a string (as current) or a {field => value} hash
-[ ] Actual error handling, or at least passing useful information along
-[ ] Figure out how to test without a live solr to bounce off of. Maybe use 
+* [ ] Add a `lucene_escape` utility function
+* [ ] Change q/fq to take either a string (as current) or a {field => value}
+ hash
+* [ ] Actual error handling for retries, or at least passing useful 
+  information along
+* [ ] Figure out how to test without a live solr to bounce off of. Maybe use 
 vcr or similar?
 
 ## Installation
@@ -94,6 +97,7 @@ Add this line to your application's Gemfile:
 
 ```ruby
 gem 'solr_cursorstream'
+# require with require "solr/cursorstream"
 ```
 
 And then execute:

data/lib/solr/cursorstream/version.rb

@@ -2,6 +2,6 @@
 
 module Solr
   class CursorStream
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/lib/solr/cursorstream.rb

@@ -93,7 +93,6 @@ module Solr
       resp
     end
 
-    # @private
     # @return [Hash] Default solr params derived from instance variables
     def default_params
       field_list = Array(fields).join(",")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solr_cursorstream
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Bill Dueber
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-21 00:00:00.000000000 Z
+date: 2022-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday