isomorfeus-ferret 0.13.2 → 0.13.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1a8509c12f5d180d38944adb53291958a9f8327a8b1706def9fecd7f9c60e73
-  data.tar.gz: fbbd38e08dd1992cd93663b1b04cc4b666b6a6dc59104414b75515bc2ec4d54d
+  metadata.gz: 1f2a4a6ea097a25d4d32a958c730fffca81ded61133f37ef4c86ca5b78ecef77
+  data.tar.gz: 7be1f98b64559be5f02e39d7a74894476046fef3fdd46d1e69ee3079c74c9681
 SHA512:
-  metadata.gz: 7158cdc3f7a0624d35b668b31287d489ee3d389f17a2ab1b58235a7c2be639b6a7bbb3a8c0efee6d168804128fa5c0d7955c00f860b653a76f23d6421fc84c5d
-  data.tar.gz: 60c62db42081291a52e66be4b7e1b4c46eb12a458b0838f3d8793ffaeb013aff27a37aca06ab4831157d1dd65330395bfdaa2fa7924a278261f1187295592042
+  metadata.gz: d173777ee520433e8df0e1a07853f92b65aa350427668baea67a957a28a8cadc05790396d8d5167282c4c83fb1e874eec3316c226e8c961f9f3161f3bf3ecb79
+  data.tar.gz: c64a96813a4b2546e21825cb4a6310c9384a8090bafe51e9c65c49d8c2b8bc69ab3deed82780e6df09089b6a915d6b7e7418bcac30f3d9770c1358800aa2286d

data/LICENSE

@@ -139,32 +139,6 @@ ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
-lib/isomorfeus/ferret/monitor.rb originally taken from the gem 'monitor':
-
-Copyright (C) 1993-2013 Yukihiro Matsumoto. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-
-  1. Redistributions of source code must retain the above copyright notice,
-     this list of conditions and the following disclaimer.
-  2. Redistributions in binary form must reproduce the above copyright notice,
-     this list of conditions and the following disclaimer in the documentation
-     and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS 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 AUTHOR OR CONTRIBUTORS 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 following licenses apply to files, which are distributed within the repo
 but not distributed with the gem and not used at runtime:
 

data/README.md

@@ -26,7 +26,7 @@ It should work on *nixes, *nuxes, *BSDs and also works on Windows.
 - The :store option no longer accepts :compress, compression must now be specified by the separate :compress options (see below).
 - The ASCII-specific Tokenizers and Analyzers have been removed
 
-### Sring Encoding support
+### String Encoding support
 
 #### Input strings and stored fields
 
@@ -37,12 +37,13 @@ All Ruby string encodings are supported.
 When fields are stored, they are now stored with the encoding, so that when they are retrieved again, they
 retain the original encoding with positions matching the string in its original encoding.
 
-#### Tokens and Filters
+#### Tokens, Terms, Filters and Queries
 
 Tokens are internally converted to UTF-8, which may change their length compared to their original encoding,
-yet they retain position information according to the source in its original encoding.
-The benefit is, that Filters, Stemmers or anything else working with Tokens only needs to support UTF-8 encoding,
-greatly simplifying things and ensuring consistent query results.
+yet they retain position information according to the source in its original encoding. Terms are likewise stored in UTF-8 encoding.
+Queries are converted to UTF-8 encoding too.
+The benefit is, that Filters, Stemmers or anything else working with Tokens and Terms only needs to support UTF-8 encoding,
+greatly simplifying things and ensuring consistent query results, independent of source encoding.
 
 ### Compression
 

data/ext/isomorfeus_ferret_ext/benchmark.c

@@ -117,13 +117,13 @@ static void bm_single_run(BenchMarkUnit *unit, BenchMarkTimes *bm_times)
     struct rusage ru_before, ru_after;
 
     if (gettimeofday(&tv_before, NULL) == -1)
-        FRT_RAISE(FRT_UNSUPPORTED_ERROR, "gettimeofday failed\n");
+        rb_raise(rb_eRuntimeError, "gettimeofday failed\n");
     getrusage(RUSAGE_SELF, &ru_before);
 
     unit->run();
 
     if (gettimeofday(&tv_after, NULL) == -1)
-        FRT_RAISE(FRT_UNSUPPORTED_ERROR, "gettimeofday failed\n");
+        rb_raise(rb_eRuntimeError, "gettimeofday failed\n");
     getrusage(RUSAGE_SELF, &ru_after);
 
     bm_times->rtime = TVAL_TO_SEC(tv_before, tv_after);

data/ext/isomorfeus_ferret_ext/frb_index.c

@@ -182,8 +182,9 @@ static VALUE frb_get_field_info(FrtFieldInfo *fi) {
             fi->rfi = TypedData_Wrap_Struct(cFieldInfo, &frb_field_info_t, fi);
             FRT_REF(fi);
         }
+        return fi->rfi;
     }
-    return fi->rfi;
+    return Qnil;
 }
 
 /*
@@ -412,8 +413,9 @@ static VALUE frb_get_field_infos(FrtFieldInfos *fis) {
             fis->rfis = TypedData_Wrap_Struct(cFieldInfos, &frb_field_infos_t, fis);
             FRT_REF(fis);
         }
+        return fis->rfis;
     }
-    return fis->rfis;
+    return Qnil;
 }
 
 /*
@@ -497,11 +499,6 @@ static VALUE frb_fis_get(VALUE self, VALUE ridx) {
         case T_STRING:
             rfi = frb_get_field_info(frt_fis_get_field(fis, frb_field(ridx)));
             break;
-            /*
-        case T_STRING:
-            rfi = frb_get_field_info(frt_fis_get_field(fis, StringValuePtr(ridx)));
-            break;
-            */
         default:
             rb_raise(rb_eArgError, "Can't index FieldInfos with %s",
                      rs2s(rb_obj_as_string(ridx)));
@@ -1274,11 +1271,11 @@ void frb_iw_free(void *p) {
 
 void frb_iw_mark(void *p) {
     FrtIndexWriter *iw = (FrtIndexWriter *)p;
-    if (iw->analyzer->ranalyzer)
+    if (iw->analyzer && iw->analyzer->ranalyzer)
         rb_gc_mark(iw->analyzer->ranalyzer);
-    if (iw->store->rstore)
+    if (iw->store && iw->store->rstore)
         rb_gc_mark(iw->store->rstore);
-    if (iw->fis->rfis)
+    if (iw->fis && iw->fis->rfis)
         rb_gc_mark(iw->fis->rfis);
 }
 
@@ -1699,10 +1696,9 @@ frb_iw_delete(VALUE self, VALUE rfield, VALUE rterm)
  *  Get the FieldInfos object for this FrtIndexWriter. This is useful if you need
  *  to dynamically add new fields to the index with specific properties.
  */
-static VALUE
-frb_iw_field_infos(VALUE self)
-{
-    FrtIndexWriter *iw = (FrtIndexWriter *)DATA_PTR(self);
+static VALUE frb_iw_field_infos(VALUE self) {
+    FrtIndexWriter *iw;
+    TypedData_Get_Struct(self, FrtIndexWriter, &frb_index_writer_t, iw);
     return frb_get_field_infos(iw->fis);
 }
 
@@ -2717,10 +2713,9 @@ frb_ir_fields(VALUE self)
  *
  *  Get the FieldInfos object for this IndexReader.
  */
-static VALUE
-frb_ir_field_infos(VALUE self)
-{
-    FrtIndexReader *ir = (FrtIndexReader *)DATA_PTR(self);
+static VALUE frb_ir_field_infos(VALUE self) {
+    FrtIndexReader *ir;
+    TypedData_Get_Struct(self, FrtIndexReader, &frb_index_reader_t, ir);
     return frb_get_field_infos(ir->fis);
 }
 

data/ext/isomorfeus_ferret_ext/frt_except.c

@@ -19,7 +19,6 @@ const char *const ERROR_TYPES[] = {
     "Lock Error"
 };
 
-bool frt_x_do_logging = false;
 bool frt_x_abort_on_exception = true;
 bool frt_x_has_aborted = false;
 FILE *frt_x_exception_stream = NULL;

data/ext/isomorfeus_ferret_ext/frt_fs_store.c

@@ -418,9 +418,7 @@ static void fs_close_lock_i(FrtLock *lock)
 
 static FrtHash *stores = NULL;
 
-#ifndef UNTHREADED
 static frt_mutex_t stores_mutex = FRT_MUTEX_INITIALIZER;
-#endif
 
 static void fs_close_i(FrtStore *store)
 {

data/ext/isomorfeus_ferret_ext/frt_global.h

@@ -266,13 +266,6 @@ extern FILE *frt_x_exception_stream;
 #define EXCEPTION 2
 #define EXCEPTION_STREAM (frt_x_exception_stream ? frt_x_exception_stream : stderr)
 
-#ifdef DEBUG
-extern bool frt_x_do_logging;
-#define xlog if (frt_x_do_logging) printf
-#else
-#define xlog()
-#endif
-
 extern void frt_init(int arc, const char *const argv[]);
 extern void frt_micro_sleep(const int micro_seconds);
 

data/ext/isomorfeus_ferret_ext/frt_lang.c

@@ -43,7 +43,14 @@ void *frt_erealloc(void *ptr, size_t size)
     return p;
 }
 
-/* void micro_sleep(const int micro_seconds)
+
+struct timeval rb_time_interval _((VALUE));
+
+extern void frt_micro_sleep(const int micro_seconds) {
+    rb_thread_wait_for(rb_time_interval(rb_float_new((double)micro_seconds/1000000.0)));
+}
+
+/* void frt_micro_sleep(const int micro_seconds)
 {
 #if (defined POSH_OS_WIN32 || defined POSH_OS_WIN64) && !defined __MINGW32__
     Sleep(micro_seconds / 1000);

data/ext/isomorfeus_ferret_ext/frt_store.h

@@ -5,7 +5,7 @@
 #include "frt_global.h"
 #include "frt_hash.h"
 #include "frt_hashset.h"
-#include "frb_threading.h"
+#include "frt_threading.h"
 
 #define FRT_LOCK_PREFIX "ferret-"
 #define FRT_LOCK_EXT ".lck"

data/ext/isomorfeus_ferret_ext/isomorfeus_ferret.c

@@ -4,8 +4,8 @@
 #include "frt_except.h"
 #include "frt_hash.h"
 #include "frt_hashset.h"
-#include "frb_threading.h"
-#include "frb_lang.h"
+#include "frt_threading.h"
+#include "ruby.h"
 
 /* IDs */
 ID id_new;

data/ext/isomorfeus_ferret_ext/isomorfeus_ferret.h

@@ -1,10 +1,9 @@
 #ifndef __FERRET_H_
 #define __FERRET_H_
-#include <ruby.h>
 #include "frt_global.h"
 #include "frt_hashset.h"
 #include "frt_document.h"
-#include "frb_lang.h"
+#include <ruby.h>
 
 /* IDs */
 extern ID id_new;

data/ext/isomorfeus_ferret_ext/test_threading.c

@@ -175,7 +175,7 @@ TestSuite *ts_threading(TestSuite *suite)
 
     tst_run_test(suite, test_number_to_str, NULL);
     tst_run_test(suite, test_threading_test, index);
-    // tst_run_test(suite, test_threading, index);
+    tst_run_test(suite, test_threading, index);
 
     frt_index_destroy(index);
 

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

@@ -4,7 +4,7 @@ module Isomorfeus
       # This is a simplified interface to the index. See the TUTORIAL for more
       # information on how to use this class.
       class Index
-        include Isomorfeus::Ferret::MonitorMixin
+        include MonitorMixin
         include Isomorfeus::Ferret::Store
         include Isomorfeus::Ferret::Search
 

data/lib/isomorfeus/ferret/version.rb

@@ -1,5 +1,5 @@
 module Isomorfeus
   module Ferret
-    VERSION = '0.13.2'
+    VERSION = '0.13.5'
   end
 end

data/lib/isomorfeus-ferret.rb

@@ -2,7 +2,7 @@ require 'isomorfeus_ferret_ext'
 require 'isomorfeus/ferret/version'
 require 'isomorfeus/ferret/field_symbol'
 require 'isomorfeus/ferret/stdlib_patches'
-require 'isomorfeus/ferret/monitor'
+require 'monitor'
 require 'isomorfeus/ferret/index/field_infos'
 require 'isomorfeus/ferret/index/index'
 require 'isomorfeus/ferret/document'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isomorfeus-ferret
 version: !ruby/object:Gem::Version
-  version: 0.13.2
+  version: 0.13.5
 platform: ruby
 authors:
 - Jan Biedermann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-18 00:00:00.000000000 Z
+date: 2022-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -167,12 +167,9 @@ files:
 - ext/isomorfeus_ferret_ext/fio_tmpfile.h
 - ext/isomorfeus_ferret_ext/frb_analysis.c
 - ext/isomorfeus_ferret_ext/frb_index.c
-- ext/isomorfeus_ferret_ext/frb_lang.c
-- ext/isomorfeus_ferret_ext/frb_lang.h
 - ext/isomorfeus_ferret_ext/frb_qparser.c
 - ext/isomorfeus_ferret_ext/frb_search.c
 - ext/isomorfeus_ferret_ext/frb_store.c
-- ext/isomorfeus_ferret_ext/frb_threading.h
 - ext/isomorfeus_ferret_ext/frb_utils.c
 - ext/isomorfeus_ferret_ext/frt_analysis.c
 - ext/isomorfeus_ferret_ext/frt_analysis.h
@@ -360,7 +357,6 @@ files:
 - lib/isomorfeus/ferret/field_symbol.rb
 - lib/isomorfeus/ferret/index/field_infos.rb
 - lib/isomorfeus/ferret/index/index.rb
-- lib/isomorfeus/ferret/monitor.rb
 - lib/isomorfeus/ferret/stdlib_patches.rb
 - lib/isomorfeus/ferret/version.rb
 homepage: https://isomorfeus.com

data/ext/isomorfeus_ferret_ext/frb_lang.c

@@ -1,9 +0,0 @@
-#include "frt_except.h"
-#include "frb_lang.h"
-
-struct timeval rb_time_interval _((VALUE));
-
-extern void frt_micro_sleep(const int micro_seconds)
-{
-    rb_thread_wait_for(rb_time_interval(rb_float_new((double)micro_seconds/1000000.0)));
-}

data/ext/isomorfeus_ferret_ext/frb_lang.h

@@ -1,17 +0,0 @@
-#ifndef FRT_LANG_H
-#define FRT_LANG_H
-
-#define RUBY_BINDINGS 1
-
-#include <stdarg.h>
-#include <ruby.h>
-
-#undef close
-#undef rename
-#undef read
-
-#define frt_emalloc xmalloc
-#define frt_ecalloc(n) xcalloc(n, 1)
-#define frt_erealloc xrealloc
-
-#endif

data/ext/isomorfeus_ferret_ext/frb_threading.h

@@ -1,29 +0,0 @@
-#ifndef FRT_THREADING_H
-#define FRT_THREADING_H
-
-#include "frt_hash.h"
-#define UNTHREADED 1
-
-typedef void * frt_mutex_t;
-typedef struct FrtHash *frt_thread_key_t;
-typedef int frt_thread_once_t;
-#define FRT_MUTEX_INITIALIZER NULL
-#define FRT_THREAD_ONCE_INIT 1;
-#define frt_mutex_init(a, b)
-#define frt_mutex_lock(a)
-#define frt_mutex_trylock(a)
-#define frt_mutex_unlock(a)
-#define frt_mutex_destroy(a)
-#define frt_thread_key_create(a, b) frb_thread_key_create(a, b)
-#define frt_thread_key_delete(a) frb_thread_key_delete(a)
-#define frt_thread_setspecific(a, b) frb_thread_setspecific(a, b)
-#define frt_thread_getspecific(a) frb_thread_getspecific(a)
-#define frt_thread_once(a, b) frb_thread_once(a, b)
-
-void frb_thread_once(int *once_control, void (*init_routine)(void));
-void frb_thread_key_create(frt_thread_key_t *key, frt_free_ft destroy);
-void frb_thread_key_delete(frt_thread_key_t key);
-void frb_thread_setspecific(frt_thread_key_t key, const void *pointer);
-void *frb_thread_getspecific(frt_thread_key_t key);
-
-#endif

data/lib/isomorfeus/ferret/monitor.rb

@@ -1,323 +0,0 @@
-# frozen_string_literal: false
-# = monitor.rb
-#
-# Copyright (C) 2001  Shugo Maeda <shugo@ruby-lang.org>
-#
-# This library is distributed under the terms of the Ruby license.
-# You can freely distribute/modify this library.
-#
-
-#
-# In concurrent programming, a monitor is an object or module intended to be
-# used safely by more than one thread.  The defining characteristic of a
-# monitor is that its methods are executed with mutual exclusion.  That is, at
-# each point in time, at most one thread may be executing any of its methods.
-# This mutual exclusion greatly simplifies reasoning about the implementation
-# of monitors compared to reasoning about parallel code that updates a data
-# structure.
-#
-# You can read more about the general principles on the Wikipedia page for
-# Monitors[http://en.wikipedia.org/wiki/Monitor_%28synchronization%29]
-#
-# == Examples
-#
-# === Simple object.extend
-#
-#   require 'monitor.rb'
-#
-#   buf = []
-#   buf.extend(MonitorMixin)
-#   empty_cond = buf.new_cond
-#
-#   # consumer
-#   Thread.start do
-#     loop do
-#       buf.synchronize do
-#         empty_cond.wait_while { buf.empty? }
-#         print buf.shift
-#       end
-#     end
-#   end
-#
-#   # producer
-#   while line = ARGF.gets
-#     buf.synchronize do
-#       buf.push(line)
-#       empty_cond.signal
-#     end
-#   end
-#
-# The consumer thread waits for the producer thread to push a line to buf
-# while <tt>buf.empty?</tt>.  The producer thread (main thread) reads a
-# line from ARGF and pushes it into buf then calls <tt>empty_cond.signal</tt>
-# to notify the consumer thread of new data.
-#
-# === Simple Class include
-#
-#   require 'monitor'
-#
-#   class SynchronizedArray < Array
-#
-#     include MonitorMixin
-#
-#     def initialize(*args)
-#       super(*args)
-#     end
-#
-#     alias :old_shift :shift
-#     alias :old_unshift :unshift
-#
-#     def shift(n=1)
-#       self.synchronize do
-#         self.old_shift(n)
-#       end
-#     end
-#
-#     def unshift(item)
-#       self.synchronize do
-#         self.old_unshift(item)
-#       end
-#     end
-#
-#     # other methods ...
-#   end
-#
-# +SynchronizedArray+ implements an Array with synchronized access to items.
-# This Class is implemented as subclass of Array which includes the
-# MonitorMixin module.
-#
-module Isomorfeus
-  module Ferret
-    module MonitorMixin
-      #
-      # FIXME: This isn't documented in Nutshell.
-      #
-      # Since MonitorMixin.new_cond returns a ConditionVariable, and the example
-      # above calls while_wait and signal, this class should be documented.
-      #
-      class ConditionVariable
-        class Timeout < Exception; end
-
-        #
-        # Releases the lock held in the associated monitor and waits; reacquires the lock on wakeup.
-        #
-        # If +timeout+ is given, this method returns after +timeout+ seconds passed,
-        # even if no other thread doesn't signal.
-        #
-        def wait(timeout = nil)
-          Thread.handle_interrupt(Exception => :never) do
-            @monitor.__send__(:mon_check_owner)
-            count = @monitor.__send__(:mon_exit_for_cond)
-            begin
-              Thread.handle_interrupt(Exception => :immediate) do
-                @cond.wait(@monitor.instance_variable_get(:@mon_mutex), timeout)
-              end
-              return true
-            ensure
-              @monitor.__send__(:mon_enter_for_cond, count)
-            end
-          end
-        end
-
-        #
-        # Calls wait repeatedly while the given block yields a truthy value.
-        #
-        def wait_while
-          while yield
-            wait
-          end
-        end
-
-        #
-        # Calls wait repeatedly until the given block yields a truthy value.
-        #
-        def wait_until
-          until yield
-            wait
-          end
-        end
-
-        #
-        # Wakes up the first thread in line waiting for this lock.
-        #
-        def signal
-          @monitor.__send__(:mon_check_owner)
-          @cond.signal
-        end
-
-        #
-        # Wakes up all threads waiting for this lock.
-        #
-        def broadcast
-          @monitor.__send__(:mon_check_owner)
-          @cond.broadcast
-        end
-
-        private
-
-        def initialize(monitor)
-          @monitor = monitor
-          @cond = Thread::ConditionVariable.new
-        end
-      end
-
-      def self.extend_object(obj)
-        super(obj)
-        obj.__send__(:mon_initialize)
-      end
-
-      #
-      # Attempts to enter exclusive section.  Returns +false+ if lock fails.
-      #
-      def mon_try_enter
-        if @mon_owner != Thread.current
-          unless @mon_mutex.try_lock
-            return false
-          end
-          @mon_owner = Thread.current
-          @mon_count = 0
-        end
-        @mon_count += 1
-        return true
-      end
-      # For backward compatibility
-      alias try_mon_enter mon_try_enter
-
-      #
-      # Enters exclusive section.
-      #
-      def mon_enter
-        if @mon_owner != Thread.current
-          @mon_mutex.lock
-          @mon_owner = Thread.current
-          @mon_count = 0
-        end
-        @mon_count += 1
-      end
-
-      #
-      # Leaves exclusive section.
-      #
-      def mon_exit
-        mon_check_owner
-        @mon_count -=1
-        if @mon_count == 0
-          @mon_owner = nil
-          @mon_mutex.unlock
-        end
-      end
-
-      #
-      # Returns true if this monitor is locked by any thread
-      #
-      def mon_locked?
-        @mon_mutex.locked?
-      end
-
-      #
-      # Returns true if this monitor is locked by current thread.
-      #
-      def mon_owned?
-        @mon_mutex.locked? && @mon_owner == Thread.current
-      end
-
-      #
-      # Enters exclusive section and executes the block.  Leaves the exclusive
-      # section automatically when the block exits.  See example under
-      # +MonitorMixin+.
-      #
-      def mon_synchronize
-        # Prevent interrupt on handling interrupts; for example timeout errors
-        # it may break locking state.
-        Thread.handle_interrupt(Exception => :never){ mon_enter }
-        begin
-          yield
-        ensure
-          Thread.handle_interrupt(Exception => :never){ mon_exit }
-        end
-      end
-      alias synchronize mon_synchronize
-
-      #
-      # Creates a new MonitorMixin::ConditionVariable associated with the
-      # receiver.
-      #
-      def new_cond
-        return ConditionVariable.new(self)
-      end
-
-      private
-
-      # Use <tt>extend MonitorMixin</tt> or <tt>include MonitorMixin</tt> instead
-      # of this constructor.  Have look at the examples above to understand how to
-      # use this module.
-      def initialize(*args)
-        super
-        mon_initialize
-      end
-
-      # Initializes the MonitorMixin after being included in a class or when an
-      # object has been extended with the MonitorMixin
-      def mon_initialize
-        if defined?(@mon_mutex) && @mon_mutex_owner_object_id == object_id
-          raise ThreadError, "already initialized"
-        end
-        @mon_mutex = Thread::Mutex.new
-        @mon_mutex_owner_object_id = object_id
-        @mon_owner = nil
-        @mon_count = 0
-      end
-
-      def mon_check_owner
-        if @mon_owner != Thread.current
-          raise ThreadError, "current thread not owner"
-        end
-      end
-
-      def mon_enter_for_cond(count)
-        @mon_owner = Thread.current
-        @mon_count = count
-      end
-
-      def mon_exit_for_cond
-        count = @mon_count
-        @mon_owner = nil
-        @mon_count = 0
-        return count
-      end
-    end
-
-    # Use the Monitor class when you want to have a lock object for blocks with
-    # mutual exclusion.
-    #
-    #   require 'monitor'
-    #
-    #   lock = Monitor.new
-    #   lock.synchronize do
-    #     # exclusive access
-    #   end
-    #
-    class Monitor
-      include MonitorMixin
-      alias try_enter try_mon_enter
-      alias enter mon_enter
-      alias exit mon_exit
-    end
-  end
-end
-
-# Documentation comments:
-#  - All documentation comes from Nutshell.
-#  - MonitorMixin.new_cond appears in the example, but is not documented in
-#    Nutshell.
-#  - All the internals (internal modules Accessible and Initializable, class
-#    ConditionVariable) appear in RDoc.  It might be good to hide them, by
-#    making them private, or marking them :nodoc:, etc.
-#  - RDoc doesn't recognise aliases, so we have mon_synchronize documented, but
-#    not synchronize.
-#  - mon_owner is in Nutshell, but appears as an accessor in a separate module
-#    here, so is hard/impossible to RDoc.  Some other useful accessors
-#    (mon_count and some queue stuff) are also in this module, and don't appear
-#    directly in the RDoc output.
-#  - in short, it may be worth changing the code layout in this file to make the
-#    documentation easier