pg_fts 0.0.0 → 0.2.0

data/lib/pg/fts/naming.rb

@@ -0,0 +1,247 @@
+require 'digest/sha1'
+
+# rubocop:disable Metrics/ModuleLength
+module PG::FTS::Naming
+  private
+
+  # prefixes
+
+  def on_source_name
+    name ? name : "#{source}_to_#{document}"
+  end
+
+  def on_document_name
+    name ? name : "#{document}_from_#{source}"
+  end
+
+  def on_link_name
+    name ? name : "#{link}_to_#{document}_from_#{source}"
+  end
+
+  def on_source_prefix_unhashed
+    name ? suffix(name, :source) : on_source_name
+  end
+
+  def on_document_prefix_unhashed
+    name ? suffix(name, :document) : on_document_name
+  end
+
+  def on_link_prefix_unhashed
+    name ? suffix(name, :link) : on_link_name
+  end
+
+  def hash_name?
+    PG::FTS::Naming.hash_names?
+  end
+
+  def hashed(name)
+    'sha1_' << (Digest::SHA1.new.tap { |sha| sha << name }).hexdigest
+  end
+
+  # rubocop:disable Metrics/CyclomaticComplexity
+  def suffix(str, *types)
+    str = str.dup
+
+    types.each do |type|
+      case type
+      when :source   then str << '_src'
+      when :link     then str << '_lnk'
+      when :document then str << '_doc'
+      when :insert   then str << '_ins'
+      when :update   then str << '_upd'
+      when :delete   then str << '_del'
+      when :truncate then str << '_trn'
+      when :tsv      then str << '_tsv'
+      end
+    end
+
+    str
+  end
+  # rubocop:enable Metrics/CyclomaticComplexity
+
+  def on_source_prefix
+    if hash_name?
+      suffix(hashed(on_source_name), :source)
+    else
+      on_source_prefix_unhashed
+    end
+  end
+
+  def on_document_prefix
+    if hash_name?
+      suffix(hashed(on_document_name), :document)
+    else
+      on_document_prefix_unhashed
+    end
+  end
+
+  def on_link_prefix
+    if hash_name?
+      suffix(hashed(on_link_name), :link)
+    else
+      on_link_prefix_unhashed
+    end
+  end
+
+  # names
+
+  def on_source_insert_name
+    suffix(on_source_prefix, :insert, :tsv)
+  end
+
+  def on_source_update_name
+    suffix(on_source_prefix, :update, :tsv)
+  end
+
+  def on_source_delete_name
+    suffix(on_source_prefix, :delete, :tsv)
+  end
+
+  def on_source_truncate_name
+    suffix(on_source_prefix, :truncate, :tsv)
+  end
+
+  def on_document_insert_name
+    suffix(on_document_prefix, :insert, :tsv)
+  end
+
+  def on_document_update_name
+    suffix(on_document_prefix, :update, :tsv)
+  end
+
+  def on_document_delete_name
+    suffix(on_document_prefix, :delete, :tsv)
+  end
+
+  def on_document_truncate_name
+    suffix(on_document_prefix, :truncate, :tsv)
+  end
+
+  def on_link_insert_name
+    suffix(on_link_prefix, :insert, :tsv)
+  end
+
+  def on_link_update_name
+    suffix(on_link_prefix, :update, :tsv)
+  end
+
+  def on_link_delete_name
+    suffix(on_link_prefix, :delete, :tsv)
+  end
+
+  def on_link_truncate_name
+    suffix(on_link_prefix, :truncate, :tsv)
+  end
+
+  # procedure names
+
+  def on_source_insert_procedure_name
+    on_source_insert_name
+  end
+
+  def on_source_update_procedure_name
+    on_source_update_name
+  end
+
+  def on_source_delete_procedure_name
+    on_source_delete_name
+  end
+
+  def on_source_truncate_procedure_name
+    on_source_truncate_name
+  end
+
+  def on_document_insert_procedure_name
+    on_document_insert_name
+  end
+
+  def on_document_update_procedure_name
+    on_document_update_name
+  end
+
+  def on_document_delete_procedure_name
+    on_document_delete_name
+  end
+
+  def on_document_truncate_procedure_name
+    on_document_truncate_name
+  end
+
+  def on_link_insert_procedure_name
+    on_link_insert_name
+  end
+
+  def on_link_update_procedure_name
+    on_link_update_name
+  end
+
+  def on_link_delete_procedure_name
+    on_link_delete_name
+  end
+
+  def on_link_truncate_procedure_name
+    on_link_truncate_name
+  end
+
+  # trigger names
+
+  def on_source_insert_trigger_name
+    on_source_insert_procedure_name
+  end
+
+  def on_source_update_trigger_name
+    on_source_update_procedure_name
+  end
+
+  def on_source_delete_trigger_name
+    on_source_delete_procedure_name
+  end
+
+  def on_source_truncate_trigger_name
+    on_source_truncate_procedure_name
+  end
+
+  def on_document_insert_trigger_name
+    on_document_insert_procedure_name
+  end
+
+  def on_document_update_trigger_name
+    on_document_update_procedure_name
+  end
+
+  def on_document_delete_trigger_name
+    on_document_delete_procedure_name
+  end
+
+  def on_document_truncate_trigger_name
+    on_document_truncate_procedure_name
+  end
+
+  def on_link_insert_trigger_name
+    on_link_insert_procedure_name
+  end
+
+  def on_link_update_trigger_name
+    on_link_update_procedure_name
+  end
+
+  def on_link_delete_trigger_name
+    on_link_delete_procedure_name
+  end
+
+  def on_link_truncate_trigger_name
+    on_link_truncate_procedure_name
+  end
+
+  module_function
+
+  @hash_names = false
+
+  def hash_names?
+    @hash_names
+  end
+
+  def hash_names!
+    @hash_names = true
+  end
+end

data/lib/pg/fts/ts_vector.rb

@@ -0,0 +1,9 @@
+module PG::FTS::TSVector
+  def ts_vector(record = 'NEW')
+    record = %("#{record}") unless %w(NEW OLD).include?(record)
+
+    fields.map do |field|
+      %(to_tsvector('#{catalog}', COALESCE(#{record}."#{field}", '')))
+    end.join(' || ')
+  end
+end

data/lib/pg/fts.rb

@@ -0,0 +1,70 @@
+module PG::FTS
+  module_function
+
+  def table
+    'fts'
+  end
+
+  def catalog
+    'pg_catalog.simple'
+  end
+
+  def create_table_query
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE TABLE "#{PG::FTS.table}" (
+      "id" SERIAL,
+      "document_table" VARCHAR(255),
+      "document_id" INT,
+      "source_table" VARCHAR(255),
+      "source_id" INT,
+      "tsv" TSVECTOR);
+    SQL
+  end
+
+  def create_key_index_query
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE UNIQUE INDEX "#{PG::FTS.table}_idx"
+    ON "#{PG::FTS.table}" (
+      "document_table",
+      "document_id",
+      "source_table",
+      "source_id");
+    SQL
+  end
+
+  def create_tsv_index_query
+    <<-SQL.gsub(/^ {4}/, '')
+    CREATE INDEX "#{PG::FTS.table}_tsv_idx"
+    ON "#{PG::FTS.table}"
+    USING GIN ("tsv");
+    SQL
+  end
+
+  def drop_table_query
+    <<-SQL.gsub(/^ {4}/, '')
+    DROP TABLE "#{PG::FTS.table}"
+    SQL
+  end
+
+  def truncate_table_query
+    <<-SQL.gsub(/^ {4}/, '')
+    TRUNCATE "#{PG::FTS.table}";
+    SQL
+  end
+
+  def create
+    yield(create_table_query)
+    yield(create_key_index_query)
+    yield(create_tsv_index_query)
+  end
+
+  def drop
+    yield(drop_table_query)
+  end
+
+  def clear
+    yield(truncate_table_query)
+  end
+end
+
+require 'pg/fts/index'

data/lib/pg_fts.rb

@@ -1,3 +1,2 @@
-module PG
-  module FTS; end
-end
+require 'pg'
+require 'pg/fts'

metadata

@@ -1,28 +1,91 @@
 --- !ruby/object:Gem::Specification
 name: pg_fts
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.2.0
 platform: ruby
 authors:
-- ADHOC-GTI
+- Loic Nageleisen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-02 00:00:00.000000000 Z
-dependencies: []
-description: |2
-        Relation-aware synchronous full text search index for PostgreSQL using
-        PL/pgSQL triggers described in and generated via ORM-agnostic Ruby.
-email: foss@adhoc-gti.com
+date: 2018-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.8.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.36.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.36.0
+description: "  Relation-aware synchronous full text search index for PostgreSQL using
+  PL/pgSQL triggers described in and generated via ORM-agnostic Ruby.\n"
+email: l.nageleisen@adhoc-gti.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
+- lib/pg/fts.rb
+- lib/pg/fts/index.rb
+- lib/pg/fts/index/many_to_one.rb
+- lib/pg/fts/index/momo.rb
+- lib/pg/fts/index/ommo.rb
+- lib/pg/fts/index/one_to_many.rb
+- lib/pg/fts/index/self.rb
+- lib/pg/fts/naming.rb
+- lib/pg/fts/ts_vector.rb
 - lib/pg_fts.rb
-homepage: https://github.com/adhoc-gti/pg_fts
+homepage: https://gitlab.adhoc-gti.com/lnageleisen/pg-fts
 licenses:
-- BSD-3-Clause
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -43,5 +106,5 @@ rubyforge_project:
 rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
-summary: Synchronous full-text search index
+summary: Postgres real-time full text search engine
 test_files: []

data/LICENSE

@@ -1,24 +0,0 @@
-Copyright (c) 2015, ADHOC-GTI
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-    * Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-    * 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.
-    * Neither the name of the copyright holders nor the
-      names of its contributors 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.