isomorfeus-ferret 0.17.3 → 0.17.4

data/ext/isomorfeus_ferret_ext/test_index.c

@@ -435,7 +435,6 @@ static void test_segment_term_doc_enum(TestCase *tc, void *data) {
     tde_reader->close(tde_reader);
     tde_skip_to->close(tde_skip_to);
 
-
     tde = frt_stpe_new(tir, frq_in, prx_in, bv, skip_interval);
     tde_skip_to = frt_stpe_new(tir, frq_in, prx_in, bv, skip_interval);
 
@@ -1033,7 +1032,7 @@ static void test_iw_del_terms(TestCase *tc, void *data) {
 
     ir = frt_ir_open(NULL, store);
     Aiequal(BOOK_LIST_LENGTH, ir->num_docs(ir));
-    Aiequal(BOOK_LIST_LENGTH, ir->max_doc(ir));
+    Aiequal(BOOK_LIST_LENGTH, ir->max_doc_num(ir));
     frt_ir_close(ir);
 
     iw = frt_iw_open(NULL, store, frt_whitespace_analyzer_new(false), &config);
@@ -1042,7 +1041,7 @@ static void test_iw_del_terms(TestCase *tc, void *data) {
 
     ir = frt_ir_open(NULL, store);
     Aiequal(BOOK_LIST_LENGTH - 1, ir->num_docs(ir));
-    Aiequal(BOOK_LIST_LENGTH, ir->max_doc(ir));
+    Aiequal(BOOK_LIST_LENGTH, ir->max_doc_num(ir));
     frt_ir_close(ir);
 
     /* test deleting multiple Terms */
@@ -1057,7 +1056,7 @@ static void test_iw_del_terms(TestCase *tc, void *data) {
 
     ir = frt_ir_open(NULL, store);
     Aiequal(BOOK_LIST_LENGTH - 17, ir->num_docs(ir));
-    Aiequal(BOOK_LIST_LENGTH, ir->max_doc(ir));
+    Aiequal(BOOK_LIST_LENGTH, ir->max_doc_num(ir));
     Atrue(!ir->is_deleted(ir, 0));
     Atrue(ir->is_deleted(ir, 1));
     Atrue(ir->is_deleted(ir, 2));
@@ -1089,7 +1088,7 @@ static void test_iw_del_terms(TestCase *tc, void *data) {
 
     ir = frt_ir_open(NULL, store);
     Aiequal(BOOK_LIST_LENGTH - 17, ir->num_docs(ir));
-    Aiequal(BOOK_LIST_LENGTH - 17, ir->max_doc(ir));
+    Aiequal(BOOK_LIST_LENGTH - 17, ir->max_doc_num(ir));
     frt_ir_close(ir);
 }
 
@@ -1268,7 +1267,7 @@ static void test_ir_open_empty_index(TestCase *tc, void *data) {
 static void test_ir_basic_ops(TestCase *tc, void *data) {
     FrtIndexReader *ir = (FrtIndexReader *)data;
     Aiequal(IR_TEST_DOC_CNT, ir->num_docs(ir));
-    Aiequal(IR_TEST_DOC_CNT, ir->max_doc(ir));
+    Aiequal(IR_TEST_DOC_CNT, ir->max_doc_num(ir));
 
     Aiequal(4, ir->doc_freq(ir, frt_fis_get_field(ir->fis, body)->number, "Wally"));
     Atrue(frt_ir_is_latest(ir));
@@ -1361,7 +1360,7 @@ static void test_ir_term_doc_enum(TestCase *tc, void *data) {
 
     FrtTermDocEnum *tde;
     FrtDocument *doc = frt_ir_get_doc_with_term(ir, tag, "id_test");
-    int docs[3], expected_docs[3];
+    int doc_nums[3], expected_doc_nums[3];
     int freqs[3], expected_freqs[3];
 
     Apnotnull(doc);
@@ -1391,34 +1390,33 @@ static void test_ir_term_doc_enum(TestCase *tc, void *data) {
 
     /* test fast read. Use a small array to exercise repeat read */
     tde->seek(tde, frt_fis_get_field(ir->fis, body)->number, "read");
-    Aiequal(3, tde->read(tde, docs, freqs, 3));
+    Aiequal(3, tde->read(tde, doc_nums, freqs, 3));
     AA3(expected_freqs, 1, 2, 4);
-    AA3(expected_docs, 1, 2, 6);
-    Aaiequal(expected_docs, docs, 3);
+    AA3(expected_doc_nums, 1, 2, 6);
+    Aaiequal(expected_doc_nums, doc_nums, 3);
     Aaiequal(expected_freqs, freqs, 3);
 
-    Aiequal(3, tde->read(tde, docs, freqs, 3));
-    AA3(expected_docs, 9, 10, 15);
+    Aiequal(3, tde->read(tde, doc_nums, freqs, 3));
+    AA3(expected_doc_nums, 9, 10, 15);
     AA3(expected_freqs, 3, 1, 1);
-    Aaiequal(expected_docs, docs, 3);
+    Aaiequal(expected_doc_nums, doc_nums, 3);
     Aaiequal(expected_freqs, freqs, 3);
 
-    Aiequal(3, tde->read(tde, docs, freqs, 3));
-    AA3(expected_docs, 16, 17, 20);
+    Aiequal(3, tde->read(tde, doc_nums, freqs, 3));
+    AA3(expected_doc_nums, 16, 17, 20);
     AA3(expected_freqs, 2, 1, 1);
-    Aaiequal(expected_docs, docs, 3);
+    Aaiequal(expected_doc_nums, doc_nums, 3);
     Aaiequal(expected_freqs, freqs, 3);
 
-    Aiequal(1, tde->read(tde, docs, freqs, 3));
-    expected_docs[0] = 21;
+    Aiequal(1, tde->read(tde, doc_nums, freqs, 3));
+    expected_doc_nums[0] = 21;
     expected_freqs[0] = 6;
-    Aaiequal(expected_docs, docs, 1);
+    Aaiequal(expected_doc_nums, doc_nums, 1);
     Aaiequal(expected_freqs, freqs, 1);
 
-    Aiequal(0, tde->read(tde, docs, freqs, 3));
+    Aiequal(0, tde->read(tde, doc_nums, freqs, 3));
 
-    test_ir_term_docpos_enum_skip_to(tc, tde,
-                                     frt_fis_get_field(ir->fis, text)->number);
+    test_ir_term_docpos_enum_skip_to(tc, tde, frt_fis_get_field(ir->fis, text)->number);
     tde->close(tde);
 
     /* test term positions */
@@ -1787,37 +1785,37 @@ static void test_ir_delete(TestCase *tc, void *data) {
     ir2 = reader_test_env_ir_open(rte);
 
     Aiequal(false, ir->has_deletions(ir));
-    Aiequal(IR_TEST_DOC_CNT, ir->max_doc(ir));
+    Aiequal(IR_TEST_DOC_CNT, ir->max_doc_num(ir));
     Aiequal(IR_TEST_DOC_CNT, ir->num_docs(ir));
     Aiequal(false, ir->is_deleted(ir, 10));
 
     frt_ir_delete_doc(ir, 10);
     Aiequal(true, ir->has_deletions(ir));
-    Aiequal(IR_TEST_DOC_CNT, ir->max_doc(ir));
+    Aiequal(IR_TEST_DOC_CNT, ir->max_doc_num(ir));
     Aiequal(IR_TEST_DOC_CNT - 1, ir->num_docs(ir));
     Aiequal(true, ir->is_deleted(ir, 10));
 
     frt_ir_delete_doc(ir, 10);
     Aiequal(true, ir->has_deletions(ir));
-    Aiequal(IR_TEST_DOC_CNT, ir->max_doc(ir));
+    Aiequal(IR_TEST_DOC_CNT, ir->max_doc_num(ir));
     Aiequal(IR_TEST_DOC_CNT - 1, ir->num_docs(ir));
     Aiequal(true, ir->is_deleted(ir, 10));
 
     frt_ir_delete_doc(ir, IR_TEST_DOC_CNT - 1);
     Aiequal(true, ir->has_deletions(ir));
-    Aiequal(IR_TEST_DOC_CNT, ir->max_doc(ir));
+    Aiequal(IR_TEST_DOC_CNT, ir->max_doc_num(ir));
     Aiequal(IR_TEST_DOC_CNT - 2, ir->num_docs(ir));
     Aiequal(true, ir->is_deleted(ir, IR_TEST_DOC_CNT - 1));
 
     frt_ir_delete_doc(ir, IR_TEST_DOC_CNT - 2);
     Aiequal(true, ir->has_deletions(ir));
-    Aiequal(IR_TEST_DOC_CNT, ir->max_doc(ir));
+    Aiequal(IR_TEST_DOC_CNT, ir->max_doc_num(ir));
     Aiequal(IR_TEST_DOC_CNT - 3, ir->num_docs(ir));
     Aiequal(true, ir->is_deleted(ir, IR_TEST_DOC_CNT - 2));
 
     frt_ir_undelete_all(ir);
     Aiequal(false, ir->has_deletions(ir));
-    Aiequal(IR_TEST_DOC_CNT, ir->max_doc(ir));
+    Aiequal(IR_TEST_DOC_CNT, ir->max_doc_num(ir));
     Aiequal(IR_TEST_DOC_CNT, ir->num_docs(ir));
     Aiequal(false, ir->is_deleted(ir, 10));
     Aiequal(false, ir->is_deleted(ir, IR_TEST_DOC_CNT - 2));
@@ -1830,7 +1828,7 @@ static void test_ir_delete(TestCase *tc, void *data) {
     frt_ir_delete_doc(ir, 50);
     frt_ir_delete_doc(ir, IR_TEST_DOC_CNT - 1);
     Aiequal(true, ir->has_deletions(ir));
-    Aiequal(IR_TEST_DOC_CNT, ir->max_doc(ir));
+    Aiequal(IR_TEST_DOC_CNT, ir->max_doc_num(ir));
     Aiequal(IR_TEST_DOC_CNT - 6, ir->num_docs(ir));
 
     frt_ir_close(ir);
@@ -1838,7 +1836,7 @@ static void test_ir_delete(TestCase *tc, void *data) {
     ir = reader_test_env_ir_open(rte);
 
     Aiequal(true, ir->has_deletions(ir));
-    Aiequal(IR_TEST_DOC_CNT, ir->max_doc(ir));
+    Aiequal(IR_TEST_DOC_CNT, ir->max_doc_num(ir));
     Aiequal(IR_TEST_DOC_CNT - 6, ir->num_docs(ir));
     Aiequal(true, ir->is_deleted(ir, 10));
     Aiequal(true, ir->is_deleted(ir, 20));
@@ -1849,7 +1847,7 @@ static void test_ir_delete(TestCase *tc, void *data) {
 
     frt_ir_undelete_all(ir);
     Aiequal(false, ir->has_deletions(ir));
-    Aiequal(IR_TEST_DOC_CNT, ir->max_doc(ir));
+    Aiequal(IR_TEST_DOC_CNT, ir->max_doc_num(ir));
     Aiequal(IR_TEST_DOC_CNT, ir->num_docs(ir));
     Aiequal(false, ir->is_deleted(ir, 10));
     Aiequal(false, ir->is_deleted(ir, 20));
@@ -1876,7 +1874,7 @@ static void test_ir_delete(TestCase *tc, void *data) {
     ir = reader_test_env_ir_open(rte);
 
     Aiequal(false, ir->has_deletions(ir));
-    Aiequal(IR_TEST_DOC_CNT - 6, ir->max_doc(ir));
+    Aiequal(IR_TEST_DOC_CNT - 6, ir->max_doc_num(ir));
     Aiequal(IR_TEST_DOC_CNT - 6, ir->num_docs(ir));
 
     Atrue(frt_ir_is_latest(ir));

data/ext/isomorfeus_ferret_ext/test_search.c

@@ -25,7 +25,7 @@ static int my_doc_freq(FrtSearcher *searcher, ID field, const char *term) {
     return 9;
 }
 
-static int my_max_doc(FrtSearcher *searcher) {
+static int my_max_doc_num(FrtSearcher *searcher) {
     (void)searcher;
     return 10;
 }
@@ -89,7 +89,7 @@ static void test_default_similarity(TestCase *tc, void *data) {
     Afequal(1.0, frt_sim_idf(dsim, 9, 10));
     Afequal(4.0, frt_sim_coord(dsim, 12, 3));
     searcher.doc_freq = &my_doc_freq;
-    searcher.max_doc = &my_max_doc;
+    searcher.max_doc_num = &my_max_doc_num;
     Afequal(1.0, frt_sim_idf_term(dsim, field, positions[0].terms[0], &searcher));
     Afequal(12.0, frt_sim_idf_phrase(dsim, field, positions, 4, &searcher));
 
@@ -262,7 +262,7 @@ void tst_check_hits(TestCase *tc, FrtSearcher *searcher, FrtQuery *query, const
         }
         Tmsg_nf("\n\tseen docs:\n\t    ");
         for (i = 0; i < top_docs->size; i++) {
-            Tmsg_nf("%d ", top_docs->hits[i]->doc);
+            Tmsg_nf("%d ", top_docs->hits[i]->doc_num);
         }
         Tmsg_nf("\n");
     }
@@ -273,19 +273,19 @@ void tst_check_hits(TestCase *tc, FrtSearcher *searcher, FrtQuery *query, const
     */
 
     if ((top >= 0) && top_docs->size)
-        Aiequal(top, top_docs->hits[0]->doc);
+        Aiequal(top, top_docs->hits[0]->doc_num);
     for (i = 0; i < top_docs->size; i++) {
         FrtHit *hit = top_docs->hits[i];
         float normalized_score = hit->score / top_docs->max_score;
         Assert(0.0 < normalized_score && normalized_score <= 1.0, "hit->score <%f> is out of range (0.0..1.0]", normalized_score);
-        Assert(frt_ary_includes(num_array, total_hits, hit->doc), "doc %d was found unexpectedly", hit->doc);
+        Assert(frt_ary_includes(num_array, total_hits, hit->doc_num), "doc %d was found unexpectedly", hit->doc_num);
         /* only check the explanation if we got the correct docs. Obviously we
          * might want to remove this to visually check the explanations */
         if (!tc->failed && total_hits == top_docs->total_hits) {
-            FrtExplanation *e = frt_searcher_explain(searcher, query, hit->doc);
+            FrtExplanation *e = frt_searcher_explain(searcher, query, hit->doc_num);
             if (! Afequal(hit->score, e->value)) {
                char *t;
-               Tmsg("\n\"\"\"\n%d>>\n%f\n%s\n\"\"\"\n", hit->doc, hit->score, t = frt_expl_to_s(e));
+               Tmsg("\n\"\"\"\n%d>>\n%f\n%s\n\"\"\"\n", hit->doc_num, hit->score, t = frt_expl_to_s(e));
                free(t);
             }
             frt_expl_destroy(e);

data/ext/isomorfeus_ferret_ext/test_sort.c

@@ -97,7 +97,7 @@ static void do_test_top_docs(TestCase *tc, FrtSearcher *searcher, FrtQuery *quer
         if (false && sort && searcher->doc_freq != frt_isea_doc_freq) {
             FrtFieldDoc *fd = (FrtFieldDoc *)hit;
             int j;
-            printf("%d == %d:%f ", num_array[i], hit->doc, hit->score);
+            printf("%d == %d:%f ", num_array[i], hit->doc_num, hit->score);
             for (j = 0; j < fd->size; j++) {
                 switch (fd->comparables[j].type) {
                     case FRT_SORT_TYPE_SCORE:
@@ -116,7 +116,7 @@ static void do_test_top_docs(TestCase *tc, FrtSearcher *searcher, FrtQuery *quer
             }
             printf("\n");
         }
-        Aiequal(num_array[i], hit->doc);
+        Aiequal(num_array[i], hit->doc_num);
     }
     frt_td_destroy(top_docs);
 
@@ -124,7 +124,7 @@ static void do_test_top_docs(TestCase *tc, FrtSearcher *searcher, FrtQuery *quer
         top_docs = frt_searcher_search(searcher, query, R_START, R_END - R_START, NULL, sort, NULL);
         for (i = R_START; i < R_END; i++) {
             FrtHit *hit = top_docs->hits[i - R_START];
-            Aiequal(num_array[i], hit->doc);
+            Aiequal(num_array[i], hit->doc_num);
             /*
             printf("%d == %d\n", num_array[i], hit->doc);
             */

data/ext/isomorfeus_ferret_ext/test_threading.c

@@ -82,7 +82,7 @@ static void do_search(FrtIndex *index) {
     free(query);
     for (i = 0; i < td->size; i++) {
         FrtHit *hit = td->hits[i];
-        FrtDocument *doc = frt_index_get_doc(index, hit->doc);
+        FrtDocument *doc = frt_index_get_doc(index, hit->doc_num);
         tlog("Hit for %d: %s - %f\n", hit->doc, frt_doc_get_field(doc, id)->data[0], hit->score);
         frt_doc_destroy(doc);
     }

data/lib/isomorfeus/ferret/index/index.rb

@@ -164,8 +164,8 @@ module Isomorfeus
         end
 
         # Returns an array of strings with the matches highlighted. The +query+ can
-        # either a query String or a Ferret::Search::Query object. The doc_id is
-        # the id of the document you want to highlight (usually returned by the
+        # either a query String or a Ferret::Search::Query object. The doc_num is
+        # the number of the document you want to highlight (usually returned by the
         # search methods). There are also a number of options you can pass;
         #
         # === Options
@@ -190,11 +190,11 @@ module Isomorfeus
         #                    excerpt hits the start or end of the field.
         #                    Alternatively you may want to use the HTML entity
         #                    … or the UTF-8 string "\342\200\246".
-        def highlight(query, doc_id, options = {})
+        def highlight(query, doc_num, options = {})
           @dir.synchronize do
             ensure_searcher_open()
             @searcher.highlight(do_process_query(query),
-                                doc_id,
+                                doc_num,
                                 options[:field]||@options[:default_field],
                                 options)
           end
@@ -327,7 +327,7 @@ module Isomorfeus
         #               to specify a fields type to sort it correctly. For more
         #               on this, see the documentation for SortField
         # filter::      a Filter object to filter the search results with
-        # filter_proc:: a filter Proc is a Proc which takes the doc_id, the score
+        # filter_proc:: a filter Proc is a Proc which takes the doc_num, the score
         #               and the Searcher object as its parameters and returns a
         #               Boolean value specifying whether the result should be
         #               included in the result set.
@@ -342,7 +342,7 @@ module Isomorfeus
         # query string that can be validly parsed by the Ferret::QueryParser. The
         # Searcher#search_each method yields the internal document id (used to
         # reference documents in the Searcher object like this;
-        # +searcher[doc_id]+) and the search score for that document. It is
+        # +searcher[doc_num]+) and the search score for that document. It is
         # possible for the score to be greater than 1.0 for some queries and
         # taking boosts into account. This method will also normalize scores to
         # the range 0.0..1.0 when the max-score is greater than 1.0. Here are the
@@ -370,7 +370,7 @@ module Isomorfeus
         #               to specify a fields type to sort it correctly. For more
         #               on this, see the documentation for SortField
         # filter::      a Filter object to filter the search results with
-        # filter_proc:: a filter Proc is a Proc which takes the doc_id, the score
+        # filter_proc:: a filter Proc is a Proc which takes the doc_num, the score
         #               and the Searcher object as its parameters and returns a
         #               Boolean value specifying whether the result should be
         #               included in the result set.

data/lib/isomorfeus/ferret/version.rb

@@ -1,5 +1,5 @@
 module Isomorfeus
   module Ferret
-    VERSION = '0.17.3'
+    VERSION = '0.17.4'
   end
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: isomorfeus-ferret
 version: !ruby/object:Gem::Version
-  version: 0.17.3
+  version: 0.17.4
 platform: ruby
 authors:
 - Jan Biedermann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-30 00:00:00.000000000 Z
+date: 2023-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.13.23
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.13.23
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.15.0
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement
@@ -413,7 +419,7 @@ metadata:
   source_code_uri: https://github.com/isomorfeus/isomorfeus-ferret
 post_install_message: |2+
 
-  isomorfeus-ferret 0.17.3:
+  isomorfeus-ferret 0.17.4:
 
   Development in progress:
   - It may eat all your files, when hungry!
@@ -434,7 +440,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Indexed document store for Isomorfeus.