clindex 1.2.1 → 2.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f19c672983f0cb3dca28cc030abb2b67629f254f0c1f7ff9d28eed1d4e5a6658
+  data.tar.gz: 600dc6c4592d6ba37123f2e4f6335100c6fff84b4389cc090678567ffe5f9e8d
+SHA512:
+  metadata.gz: ff793d34f4cc2e549319c224bd92dee260742a9e99190212a4a557bb95429eadc1225b571490da4e8eb7f9543b18c9fc0f2ce935cb588088ffdf7cfd58f99dc5
+  data.tar.gz: 5e2e63bfbc5ccc279b7e7b06b429b51857f953d19eaab327e5c799a8a52354270ecca671e337191764327bb77e63e24049eb901795853fb37cf70caaeba7b99c

data/src/index.rb

@@ -1,47 +1,12 @@
-# $Id: index.rb,v 1.14 2003/05/28 22:57:28 chrismo Exp $
-=begin
-----------------------------------------------------------------------------
-Copyright (c) 2002, Chris Morris
-All rights reserved.
+# frozen_string_literal: true
 
-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.
-
-3. Neither the names Chris Morris, cLabs nor the names of contributors to
-this software may be used to endorse or promote products derived from this
-software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT HOLDERS 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.
-----------------------------------------------------------------------------
-(based on BSD Open Source License)
-=end
-
-require 'thread'
 require 'drb'
 require 'rubygems'
 gem 'clutil'
 require 'cl/util/console'
 
-# create a batch_add method? This would allow a whole
-# page full of terms to be queued and the index
-# locked for the duration to prevent a concurrent
+# TODO: create a batch_add method? This would allow a whole page full of terms
+# to be queued and the index locked for the duration to prevent a concurrent
 # query from getting a partial result
 class ClIndex
   attr_accessor :index
@@ -49,10 +14,10 @@ class ClIndex
   WAIT = true
   NO_WAIT = false
 
-  def initialize(verboseServer=false)
+  def initialize(verbose_server = false)
     @index = {}
-    @lockMgr = ClIndexLockMgr.new
-    @verboseServer = verboseServer
+    @lock_mgr = ClIndexLockMgr.new
+    @verbose_server = verbose_server
   end
 
   def assign(src)
@@ -62,16 +27,16 @@ class ClIndex
   # refactor with do_read?
   def do_edit(wait)
     locked = lock(ClIndexLockMgr::EDIT, wait)
-    if locked
-      begin
-        yield if block_given?
-      ensure
-        unlock(ClIndexLockMgr::EDIT)
-      end
+    return unless locked
+
+    begin
+      yield if block_given?
+    ensure
+      unlock(ClIndexLockMgr::EDIT)
     end
   end
 
-  def add(term, reference, wait=NO_WAIT)
+  def add(term, reference, wait = NO_WAIT)
     success = false
     do_edit(wait) {
       @index[term] = [] if @index[term].nil?
@@ -82,11 +47,11 @@ class ClIndex
     success
   end
 
-  def remove(reference, wait=NO_WAIT)
+  def remove(reference, wait = NO_WAIT)
     success = false
     do_edit(wait) {
-      @index.each_pair do |term, refArray|
-        @index[term].delete(reference) if refArray.include?(reference)
+      @index.each_pair do |term, ref_array|
+        @index[term].delete(reference) if ref_array.include?(reference)
         @index.delete(term) if @index[term].empty?
       end
       success = true
@@ -98,12 +63,12 @@ class ClIndex
   # wait (defaults to false). If wait is false and a blocking action
   # is preventing saving, the call returns immediately. If wait is true,
   # save waits for the blocking action to complete before continuing.
-  def save(filename='index.dat', wait=NO_WAIT)
+  def save(filename = 'index.dat', wait = NO_WAIT)
     locked = lock(ClIndexLockMgr::SAVE, wait)
     if locked
       begin
-        File.open(filename, File::CREAT|File::TRUNC|File::RDWR) do |f|
-          Marshal.dump(self, f)
+        File.open(filename, File::CREAT | File::TRUNC | File::RDWR) do |f|
+          Marshal.dump(@index, f)
         end
       ensure
         unlock(ClIndexLockMgr::SAVE)
@@ -112,15 +77,13 @@ class ClIndex
     locked
   end
 
-  def load(filename='index.dat', wait=NO_WAIT)
+  def load(filename = 'index.dat', wait = NO_WAIT)
     locked = lock(ClIndexLockMgr::LOAD, wait)
     if locked
       begin
-        src = nil
         File.open(filename) do |f|
-          src = Marshal.load(f)
+          @index = Marshal.load(f)
         end
-        assign(src)
       ensure
         unlock(ClIndexLockMgr::LOAD)
       end
@@ -128,14 +91,14 @@ class ClIndex
     locked
   end
 
-  def search(term, hits, wait=NO_WAIT)
-    puts 'searching...' if @verboseServer
+  def search(term, hits, wait = NO_WAIT)
+    puts 'searching...' if @verbose_server
     success = false
     do_read(wait) {
       success = true
       terms = @index.keys.grep(/#{term}/i)
-      terms.each do |thisTerm|
-        hits << @index[thisTerm]
+      terms.each do |this_term|
+        hits << @index[this_term]
       end
       hits = hits.flatten.uniq.sort
     }
@@ -144,30 +107,30 @@ class ClIndex
 
   def do_read(wait)
     locked = lock(ClIndexLockMgr::READ, wait)
-    if locked
-      begin
-        yield if block_given?
-      ensure
-        unlock(ClIndexLockMgr::READ)
-      end
+    return unless locked
+
+    begin
+      yield if block_given?
+    ensure
+      unlock(ClIndexLockMgr::READ)
     end
   end
 
-  def all_terms(reference, wait=NO_WAIT)
+  def all_terms(reference, wait = NO_WAIT)
     all = []
     do_read(wait) {
-      @index.each do |term, refArray|
-        all << term if refArray.include?(reference)
+      @index.each do |term, ref_array|
+        all << term if ref_array.include?(reference)
       end
     }
     all
   end
 
-  def reference_exists?(reference, wait=NO_WAIT)
+  def reference_exists?(reference, wait = NO_WAIT)
     exists = false
     do_read(wait) {
-      @index.each do |term, refArray|
-        if refArray.include? reference
+      @index.each do |_, ref_array|
+        if ref_array.include? reference
           exists = true
           break
         end
@@ -176,36 +139,36 @@ class ClIndex
     exists
   end
 
-  def term_exists?(term, wait=NO_WAIT)
+  def term_exists?(term, wait = NO_WAIT)
     exists = false
     do_read(wait) {
-      exists = @index.keys.include?(term)
+      exists = @index.key?(term)
     }
     exists
   end
 
-  def lock(lockType, wait=NO_WAIT)
-    @lockMgr.lock(lockType, wait)
+  def lock(lock_type, wait = NO_WAIT)
+    @lock_mgr.lock(lock_type, wait)
   end
 
-  def unlock(lockType)
-    @lockMgr.unlock(lockType)
+  def unlock(lock_type)
+    @lock_mgr.unlock(lock_type)
   end
 end
 
 class ThreadSafeArray
   def initialize
     @mutex = Mutex.new
-    @internalArray = []
+    @internal_array = []
   end
 
   def to_ary
-    @internalArray
+    @internal_array
   end
 
   def method_missing(method, *args, &block)
     @mutex.synchronize do
-      @internalArray.send(method, *args, &block)
+      @internal_array.send(method, *args, &block)
     end
   end
 end
@@ -229,42 +192,44 @@ class ClIndexLockMgr
     @mutex = Mutex.new
   end
 
-  def lock_approved(lockType)
+  def lock_approved(lock_type)
     result = true
     @allowable.each_pair do |locked, allowable|
-      if @current.include?(locked) && !allowable.include?(lockType)
+      if @current.include?(locked) && !allowable.include?(lock_type)
         result = false
       end
-      break if !result
+      break unless result
     end
     result
   end
 
-  def lock(lockType, wait=false)
+  def lock(lock_type, wait = false)
+    approved = nil
     if wait
-      begin
-        approved = lock_approved(lockType)
-      end until approved
+      loop do
+        approved = lock_approved(lock_type)
+        break if approved
+      end
     else
-      approved = lock_approved(lockType)
+      approved = lock_approved(lock_type)
     end
-    @current << lockType if approved
+    @current << lock_type if approved
     approved
   end
 
-  def unlock(lockType)
-    @current.delete(lockType)
+  def unlock(lock_type)
+    @current.delete(lock_type)
   end
 end
 
-def launch_server(port='9110')
-  idxServer = ClIndex.new(true)
+def launch_server(port = '9110')
+  idx_server = ClIndex.new(true)
   puts "ClIndex launching on localhost:#{port}..."
-  DRb.start_service("druby://localhost:#{port}", idxServer)
+  DRb.start_service("druby://localhost:#{port}", idx_server)
   DRb.thread.join
 end
 
-if __FILE__ == $0
+if $0 == __FILE__
   if if_switch('-s')
     port = get_switch('-p')
     if port

metadata

@@ -1,32 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: clindex
 version: !ruby/object:Gem::Version
-  version: 1.2.1
-  prerelease: 
+  version: 2.0.1
 platform: ruby
 authors:
 - chrismo
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-12-20 00:00:00.000000000 Z
+date: 2023-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clutil
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2011.138.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2011.138.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A generic index DRb server. The core index is a hash, each key is an
   individual term, each value is an array of references for that term. Searches the
   index with a simple regexp grep against the hash keys to return a single array of
@@ -41,26 +66,24 @@ files:
 - src/index.rb
 homepage: https://github.com/chrismo/clindex
 licenses: []
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - src
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.4
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.0.0
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.23
-signing_key: 
-specification_version: 3
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
 summary: cLabs Index
 test_files: []