isomorfeus-ferret 0.14.4 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2edd7c4bc27bf507a9003988136eaaa475fed8943eb4fe6a083995d02a9015c1
-  data.tar.gz: d779442eb4d5c2ce83490c0a0a425230701d21fd535f4f9b30970752557888ac
+  metadata.gz: dc82aa85a233a1eb67ae971fbd6e5704b1f6b14660ed5673f9292a3021f34837
+  data.tar.gz: dea91e29a2a3c14381067d05177c455d8953b74f0187e9b7610997c4a1bc68ae
 SHA512:
-  metadata.gz: a3ac194cc68b44fe0600ed79a9016e1dbab3b511d6b341a48c8cee27610d95683488fc5dc6ee10ebe5ed537a7eba4a3f18aaa31c8d27b84d16efc51e4525724d
-  data.tar.gz: 5fc5ffae4692e5f710ff7c01ab8a5b0f465db7d03b6a1ce2bd5d0f6db6c6699fcdb52034c5143cb91699234fc1028140f3bd4d4b07d1f41de80ebf9836f1b4e2
+  metadata.gz: '064940571edfbb380795a71031274f6489010cdc28da4c26a64c769eee924593df069d72939a4f6e5e56b8b94398108e6e039c00526a250dbb5f51068a10880e'
+  data.tar.gz: 76edc3b5f07bd779498fe92d8630ec5f651e05eae82982fcedc853b9086fd7af84e827407ee0b2316456dc07bb7f508b63ded855278ff4ca38af18398ee7cc1e

data/LICENSE

@@ -28,14 +28,14 @@ Copyright (c) 2005-2006 David Balmain
 MIT License as above
 
 
-brotli_* files in ext/isomorfeus_ferret originally taken from https://github.com/google/brotli:
+brotli_* files in ext/isomorfeus_ferret_ext originally taken from https://github.com/google/brotli:
 
 Copyright (c) 2009, 2010, 2013-2016 by the Brotli Authors.
 
 MIT License as above
 
 
-bzlib* files in ext/isomorfeus_ferret originally taken from git://sourceware.org/git/bzip2.git:
+bzlib* files in ext/isomorfeus_ferret_ext originally taken from git://sourceware.org/git/bzip2.git:
 
 This program, "bzip2", the associated library "libbzip2", and all
 documentation, are copyright (C) 1996-2019 Julian R Seward.  All
@@ -76,7 +76,7 @@ Julian Seward, jseward@acm.org
 bzip2/libbzip2 version 1.0.8 of 13 July 2019
 
 
-lz4* files in ext/isomorfeus_ferret originally taken from https://github.com/lz4/lz4/tree/dev/lib:
+lz4* files in ext/isomorfeus_ferret_ext originally taken from https://github.com/lz4/lz4/tree/dev/lib:
 
 Copyright (C) 2011-2020, Yann Collet.
 
@@ -107,7 +107,7 @@ You can contact the author at:
 - LZ4 source repository : https://github.com/lz4/lz4
 
 
-stem* and libstemmer* files in ext/isomorfeus_ferret originally taken from https://snowballstem.org/:
+stem* and libstemmer* files in ext/isomorfeus_ferret_ext originally taken from https://snowballstem.org/:
 
 Copyright (c) 2001, Dr Martin Porter
 Copyright (c) 2004,2005, Richard Boulton
@@ -139,11 +139,62 @@ ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
+mdbx* files in ext/isomorfeus_ferret_ext originally taken from https://gitflic.ru/project/erthink/libmdbx:
+
+The OpenLDAP Public License
+  Version 2.8, 17 August 2003
+
+Redistribution and use of this software and associated documentation
+("Software"), with or without modification, are permitted provided
+that the following conditions are met:
+
+1. Redistributions in source form must retain copyright statements
+   and notices,
+
+2. Redistributions in binary form must reproduce applicable copyright
+   statements and notices, this list of conditions, and the following
+   disclaimer in the documentation and/or other materials provided
+   with the distribution, and
+
+3. Redistributions must contain a verbatim copy of this document.
+
+The OpenLDAP Foundation may revise this license from time to time.
+Each revision is distinguished by a version number.  You may use
+this Software under terms of this license revision or under the
+terms of any subsequent revision of the license.
+
+THIS SOFTWARE IS PROVIDED BY THE OPENLDAP FOUNDATION AND ITS
+CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT
+SHALL THE OPENLDAP FOUNDATION, ITS CONTRIBUTORS, OR THE AUTHOR(S)
+OR OWNER(S) OF THE SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
+The names of the authors and copyright holders must not be used in
+advertising or otherwise to promote the sale, use or other dealing
+in this Software without specific, written prior permission.  Title
+to copyright in this Software shall at all times remain with copyright
+holders.
+
+OpenLDAP is a registered trademark of the OpenLDAP Foundation.
+
+Copyright 1999-2003 The OpenLDAP Foundation, Redwood City,
+California, USA.  All Rights Reserved.  Permission to copy and
+distribute verbatim copies of this document is granted.
+
+
 The following licenses apply to files, which are distributed within the repo
 but not distributed with the gem and not used at runtime:
 
 
-For the Reuter-21578 files in the misc/ferret_vs_others directory (corpus, etc.),
+For the Reuters-21578 files in the misc/ferret_vs_others directory (reuters-corpus, etc.),
 used for research for developing search engine technology:
 
    The copyright for the text of newswire articles and Reuters
@@ -158,7 +209,6 @@ the data set (see "Availability & Questions").
 
 Apache Lucene jars in  the misc/ferret_vs_others directory:
 
-
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/

data/ext/isomorfeus_ferret_ext/extconf.rb

@@ -1,5 +1,23 @@
 require 'mkmf'
 
-$CFLAGS << ' -O2 -Wall -Wno-sizeof-pointer-div'
+WIN_PATTERNS = [
+  /bccwin/i,
+  /cygwin/i,
+  /djgpp/i,
+  /mingw/i,
+  /mswin/i,
+  /wince/i,
+].freeze
+
+def win_platform?
+  ruby_platform = RbConfig::CONFIG['host_os']
+  !!WIN_PATTERNS.find {|r| ruby_platform =~ r }
+end
+
+$CFLAGS << ' -O2 -DMDBX_BUILD_FLAGS=\"-O2\" -Wall -Wno-sizeof-pointer-div'
+
+if win_platform?
+  $LDFLAGS << ' -lntdll '
+end
 
 create_makefile('isomorfeus_ferret_ext')

data/ext/isomorfeus_ferret_ext/frb_analysis.c

@@ -2075,10 +2075,6 @@ static void Init_RegExpAnalyzer(void) {
     rb_define_method(cRegExpAnalyzer, "token_stream", frb_re_analyzer_token_stream, 2);
 }
 
-/* rdoc hack
-extern VALUE mFerret = rb_define_module("Ferret");
-*/
-
 /*
  *  Document-module: Ferret::Analysis
  *

data/ext/isomorfeus_ferret_ext/frb_index.c

@@ -2811,10 +2811,6 @@ void Init_IndexReader(void) {
     rb_define_method(cIndexReader, "to_enum",        frb_ir_to_enum,       0);
 }
 
-/* rdoc hack
-extern VALUE mFerret = rb_define_module("Ferret");
-*/
-
 /*
  *  Document-module: Ferret::Index
  *

data/ext/isomorfeus_ferret_ext/frb_lazy_doc.c

@@ -177,6 +177,7 @@ static VALUE frb_ld_lt(VALUE self, VALUE other) {
     rLazyDoc *other_rld;
     TypedData_Get_Struct(other, rLazyDoc, &frb_ld_t, other_rld);
     other_h = frb_ld_to_h(other);
+    (void)other_rld;
   }
   VALUE self_h = frb_ld_to_h(self);
   return rb_funcall(self_h, id_lt, 1, other_h);
@@ -190,6 +191,7 @@ static VALUE frb_ld_le(VALUE self, VALUE other) {
     rLazyDoc *other_rld;
     TypedData_Get_Struct(other, rLazyDoc, &frb_ld_t, other_rld);
     other_h = frb_ld_to_h(other);
+    (void)other_rld;
   }
   VALUE self_h = frb_ld_to_h(self);
   return rb_funcall(self_h, id_le, 1, other_h);
@@ -223,6 +225,7 @@ static VALUE frb_ld_gt(VALUE self, VALUE other) {
     rLazyDoc *other_rld;
     TypedData_Get_Struct(other, rLazyDoc, &frb_ld_t, other_rld);
     other_h = frb_ld_to_h(other);
+    (void)other_rld;
   }
   VALUE self_h = frb_ld_to_h(self);
   return rb_funcall(self_h, id_gt, 1, other_h);
@@ -236,6 +239,7 @@ static VALUE frb_ld_ge(VALUE self, VALUE other) {
     rLazyDoc *other_rld;
     TypedData_Get_Struct(other, rLazyDoc, &frb_ld_t, other_rld);
     other_h = frb_ld_to_h(other);
+    (void)other_rld;
   }
   VALUE self_h = frb_ld_to_h(self);
   return rb_funcall(self_h, id_ge, 1, other_h);

data/ext/isomorfeus_ferret_ext/frb_qparser.c

@@ -374,11 +374,6 @@ static VALUE frb_qp_set_tkz_fields(VALUE self, VALUE rfields) {
  *
  ****************************************************************************/
 
-/* rdoc hack
-extern VALUE mFerret = rb_define_module("Ferret");
-extern VALUE cQueryParser = rb_define_module_under(mFerret, "QueryParser");
-*/
-
 /*
  *  Document-class: Ferret::QueryParser::QueryParseException
  *
@@ -410,7 +405,7 @@ void Init_QueryParseException(void) {
  *
  *  If you want to use one of these characters in one of your terms you need
  *  to escape it with a \ character. \ escapes itself. The exception to this
- *  rule is within Phrases which a strings surrounded by double quotes (and
+ *  rule is within Phrases which are strings surrounded by double quotes (and
  *  will be explained further bellow in the section on PhraseQueries). In
  *  Phrases, only ", | and <> have special meaning and need to be escaped if
  *  you want the literal value. <> is escaped \<\>.

data/ext/isomorfeus_ferret_ext/frb_search.c

@@ -4593,11 +4593,6 @@ static void Init_SpanNotQuery(void) {
     rb_define_method(cSpanNotQuery, "initialize", frb_spanxq_init, 2);
 }
 
-/* rdoc hack
-extern VALUE mFerret = rb_define_module("Ferret");
-extern VALUE mSearch = rb_define_module_under(mFerret, "Search");
-*/
-
 /*
  *  Document-module: Ferret::Search::Spans
  *

data/ext/isomorfeus_ferret_ext/frb_store.c

@@ -10,6 +10,7 @@ VALUE cLockError;
 VALUE cDirectory;
 VALUE cRAMDirectory;
 VALUE cFSDirectory;
+VALUE cMDBXDirectory;
 
 /****************************************************************************
  * Lock Methods
@@ -418,6 +419,55 @@ static VALUE frb_fsdir_new(int argc, VALUE *argv, VALUE klass) {
     return self;
 }
 
+
+/****************************************************************************
+ *
+ * MDBXDirectory Methods
+ *
+ ****************************************************************************/
+
+/*
+ *  call-seq:
+ *     MDBXDirectory.new(/path/to/env/, create = false)
+ *
+ *  Create a new MDBXDirectory at +/path/to/env/+ which must be a valid path
+ *  on your file system. If it doesn't exist it will be created. You can also
+ *  specify the +create+ parameter. If +create+ is true the FSDirectory will
+ *  be refreshed as new. That is to say, any existing files in the directory
+ *  will be deleted. The default value for +create+ is false.
+ *
+ *  path::   path to index directory. Must be a valid path on your system
+ *  create:: set to true if you want any existing files in the directory to be
+ *           deleted
+ */
+static VALUE frb_mdbxdir_new(int argc, VALUE *argv, VALUE klass) {
+    VALUE self, rpath, rcreate;
+    FrtStore *store;
+    bool create;
+
+    rb_scan_args(argc, argv, "11", &rpath, &rcreate);
+    StringValue(rpath);
+    create = RTEST(rcreate);
+    if (create) {
+        frb_create_dir(rpath);
+    }
+    if (!rb_funcall(rb_cFile, id_is_directory, 1, rpath)) {
+        rb_raise(cFileNotFoundError, "No directory <%s> found. Use :create => true to create one.", rs2s(rpath));
+    }
+    store = frt_open_mdbx_store(rs2s(rpath));
+    if (create) store->clear_all(store);
+    self = store->rstore;
+    if (self == Qnil || DATA_PTR(self) == NULL) {
+        self = TypedData_Wrap_Struct(klass, &frb_store_t, store);
+        store->rstore = self;
+        rb_ivar_set(self, id_ref_cnt, INT2FIX(0));
+    } else {
+        int ref_cnt = FIX2INT(rb_ivar_get(self, id_ref_cnt)) + 1;
+        rb_ivar_set(self, id_ref_cnt, INT2FIX(ref_cnt));
+    }
+    return self;
+}
+
 /****************************************************************************
  *
  * Init Function
@@ -504,7 +554,7 @@ void Init_RAMDirectory(void) {
 }
 
 /*
- *  Document-class: Ferret::Store::RAMDirectory
+ *  Document-class: Ferret::Store::FSDirectory
  *
  *  File-system resident Directory implementation. The FSDirectory will use a
  *  single directory to store all of it's files. You should not otherwise
@@ -518,9 +568,20 @@ void Init_FSDirectory(void) {
     rb_define_singleton_method(cFSDirectory, "new", frb_fsdir_new, -1);
 }
 
-/* rdoc hack
-extern VALUE mFerret = rb_define_module("Ferret");
-*/
+/*
+ *  Document-class: Ferret::Store::MDBXDirectory
+ *
+ *  MDBX resident Directory implementation. The MDBXDirectory will use a
+ *  single MDBX database to store all of it's files. You should not otherwise
+ *  touch this ddatabase. Modifying the database will corrupt the index.
+ *  The one exception to this rule is you may need to delete stale
+ *  lock files which have a ".lck" extension.
+ */
+void Init_MDBXDirectory(void) {
+    cMDBXDirectory = rb_define_class_under(mStore, "MDBXDirectory", cDirectory);
+    rb_define_alloc_func(cMDBXDirectory, frb_store_alloc);
+    rb_define_singleton_method(cMDBXDirectory, "new", frb_mdbxdir_new, -1);
+}
 
 /*
  *  Document-module: Ferret::Store
@@ -539,4 +600,5 @@ void Init_Store(void) {
     Init_Lock();
     Init_RAMDirectory();
     Init_FSDirectory();
+    Init_MDBXDirectory();
 }

data/ext/isomorfeus_ferret_ext/frb_utils.c

@@ -1051,10 +1051,6 @@ static void Init_PriorityQueue(void) {
     rb_define_method(cPriorityQueue, "adjust", frb_pq_adjust, 0);
 }
 
-/* rdoc hack
-extern VALUE mFerret = rb_define_module("Ferret");
-*/
-
 /*
  *  Document-module: Ferret::Utils
  *

data/ext/isomorfeus_ferret_ext/frt_compound_io.c

@@ -142,21 +142,21 @@ static FrtInStream *cmpd_open_input(FrtStore *store, const char *file_name) {
     FrtCompoundStore *cmpd = store->dir.cmpd;
     FrtInStream *is;
 
-    frt_mutex_lock(&store->mutex);
+    pthread_mutex_lock(&store->mutex);
     if (cmpd->stream == NULL) {
-        frt_mutex_unlock(&store->mutex);
+        pthread_mutex_unlock(&store->mutex);
         FRT_RAISE(FRT_IO_ERROR, "Can't open compound file input stream. Parent "
               "stream is closed.");
     }
 
     entry = (FileEntry *)frt_h_get(cmpd->entries, file_name);
     if (entry == NULL) {
-        frt_mutex_unlock(&store->mutex);
+        pthread_mutex_unlock(&store->mutex);
         FRT_RAISE(FRT_IO_ERROR, "File %s does not exist: ", file_name);
     }
 
     is = cmpd_create_input(cmpd->stream, entry->offset, entry->length);
-    frt_mutex_unlock(&store->mutex);
+    pthread_mutex_unlock(&store->mutex);
 
     return is;
 }

data/ext/isomorfeus_ferret_ext/frt_except.c

@@ -29,19 +29,19 @@ char frt_xmsg_buffer[FRT_XMSG_BUFFER_SIZE];
 char frt_xmsg_buffer_final[FRT_XMSG_BUFFER_FINAL_SIZE];
 
 static frt_thread_key_t exception_stack_key;
-static frt_thread_once_t exception_stack_key_once = FRT_THREAD_ONCE_INIT;
+static pthread_once_t exception_stack_key_once = PTHREAD_ONCE_INIT;
 
 static void exception_stack_alloc(void) {
-    frt_thread_key_create(&exception_stack_key, NULL);
-    frt_thread_setspecific(exception_stack_key, NULL);
+    frb_thread_key_create(&exception_stack_key, NULL);
+    frb_thread_setspecific(exception_stack_key, NULL);
 }
 
 void frt_xpush_context(frt_xcontext_t *context) {
     frt_xcontext_t *top_context;
-    frt_thread_once(&exception_stack_key_once, *exception_stack_alloc);
-    top_context = (frt_xcontext_t *)frt_thread_getspecific(exception_stack_key);
+    pthread_once(&exception_stack_key_once, *exception_stack_alloc);
+    top_context = (frt_xcontext_t *)frb_thread_getspecific(exception_stack_key);
     context->next = top_context;
-    frt_thread_setspecific(exception_stack_key, context);
+    frb_thread_setspecific(exception_stack_key, context);
     context->handled = true;
     context->in_finally = false;
 }
@@ -55,8 +55,8 @@ static void frt_xraise_context(frt_xcontext_t *context, volatile int excode, con
 
 void frt_xraise(int excode, const char *const msg) {
     frt_xcontext_t *top_context;
-    frt_thread_once(&exception_stack_key_once, *exception_stack_alloc);
-    top_context = (frt_xcontext_t *)frt_thread_getspecific(exception_stack_key);
+    pthread_once(&exception_stack_key_once, *exception_stack_alloc);
+    top_context = (frt_xcontext_t *)frb_thread_getspecific(exception_stack_key);
 
     if (!top_context) {
         FRT_XEXIT(ERROR_TYPES[excode], msg);
@@ -73,10 +73,10 @@ void frt_xraise(int excode, const char *const msg) {
 
 void frt_xpop_context(void) {
     frt_xcontext_t *top_cxt, *context;
-    frt_thread_once(&exception_stack_key_once, *exception_stack_alloc);
-    top_cxt = (frt_xcontext_t *)frt_thread_getspecific(exception_stack_key);
+    pthread_once(&exception_stack_key_once, *exception_stack_alloc);
+    top_cxt = (frt_xcontext_t *)frb_thread_getspecific(exception_stack_key);
     context = top_cxt->next;
-    frt_thread_setspecific(exception_stack_key, context);
+    frb_thread_setspecific(exception_stack_key, context);
     if (!top_cxt->handled) {
         if (context) {
             frt_xraise_context(context, top_cxt->excode, top_cxt->msg);