iqvoc_similar_terms 0.8.0 → 2.11.3

data/config/environment.rb

@@ -1,5 +1,5 @@
-# Load the Rails application
-require File.expand_path('../application', __FILE__)
+# Load the Rails application.
+require_relative "application"
 
-# Initialize the Rails application
-Iqvoc::SimilarTerms::Application.initialize!
+# Initialize the Rails application.
+Rails.application.initialize!

data/config/environments/development.rb

@@ -1,4 +1,3 @@
-require 'debug'
 require 'iqvoc/environments/development'
 
 if Iqvoc::SimilarTerms.const_defined?(:Application)

data/config/environments/test.rb

@@ -1,4 +1,3 @@
-require 'debug'
 require 'iqvoc/environments/test'
 
 if Iqvoc::SimilarTerms.const_defined?(:Application)

data/config/initializers/apipie.rb

@@ -0,0 +1,5 @@
+Apipie.configure do |config|
+  config.api_controllers_matcher += [
+    "#{IqvocSimilarTerms.root}/app/controllers/*.rb"
+  ]
+end

data/config/initializers/content_security_policy.rb

@@ -0,0 +1,25 @@
+# Be sure to restart your server when you modify this file.
+
+# Define an application-wide content security policy.
+# See the Securing Rails Applications Guide for more information:
+# https://guides.rubyonrails.org/security.html#content-security-policy-header
+
+# Rails.application.configure do
+#   config.content_security_policy do |policy|
+#     policy.default_src :self, :https
+#     policy.font_src    :self, :https, :data
+#     policy.img_src     :self, :https, :data
+#     policy.object_src  :none
+#     policy.script_src  :self, :https
+#     policy.style_src   :self, :https
+#     # Specify URI for violation reports
+#     # policy.report_uri "/csp-violation-report-endpoint"
+#   end
+#
+#   # Generate session nonces for permitted importmap and inline scripts
+#   config.content_security_policy_nonce_generator = ->(request) { request.session.id.to_s }
+#   config.content_security_policy_nonce_directives = %w(script-src)
+#
+#   # Report violations without enforcing the policy.
+#   # config.content_security_policy_report_only = true
+# end

data/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure parameters to be filtered from the log file. Use this to limit dissemination of
+# sensitive information. See the ActiveSupport::ParameterFilter documentation for supported
+# notations and behaviors.
+Rails.application.config.filter_parameters += [
+  :passw, :secret, :token, :_key, :crypt, :salt, :certificate, :otp, :ssn
+]

data/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, "\\1en"
+#   inflect.singular /^(ox)en/i, "\\1"
+#   inflect.irregular "person", "people"
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym "RESTful"
+# end

data/config/initializers/iqvoc.rb

@@ -1,6 +1,8 @@
 Iqvoc.config.register_setting("title", "iQvoc Similar Terms")
 
-Iqvoc.navigation_items.insert(-6, { # in front of search, users, configuration, help and about
-  :content => proc { link_to "Similar Terms", similar_path }, # TODO: i18n
-  :controller => "similar_terms"
-})
+Iqvoc::Configuration::Navigation.add_grouped(
+  {
+    text: proc { t("txt.views.similar_terms.title") },
+    href: proc { new_similar_path },
+    controller: "similar_terms"
+}, -3)

data/config/initializers/new_framework_defaults_6_1.rb

@@ -0,0 +1,67 @@
+# Be sure to restart your server when you modify this file.
+#
+# This file contains migration options to ease your Rails 6.1 upgrade.
+#
+# Once upgraded flip defaults one by one to migrate to the new default.
+#
+# Read the Guide for Upgrading Ruby on Rails for more info on each option.
+
+# Support for inversing belongs_to -> has_many Active Record associations.
+# Rails.application.config.active_record.has_many_inversing = true
+
+# Track Active Storage variants in the database.
+# Rails.application.config.active_storage.track_variants = true
+
+# Apply random variation to the delay when retrying failed jobs.
+# Rails.application.config.active_job.retry_jitter = 0.15
+
+# Stop executing `after_enqueue`/`after_perform` callbacks if
+# `before_enqueue`/`before_perform` respectively halts with `throw :abort`.
+# Rails.application.config.active_job.skip_after_callbacks_if_terminated = true
+
+# Specify cookies SameSite protection level: either :none, :lax, or :strict.
+#
+# This change is not backwards compatible with earlier Rails versions.
+# It's best enabled when your entire app is migrated and stable on 6.1.
+# Rails.application.config.action_dispatch.cookies_same_site_protection = :lax
+
+# Generate CSRF tokens that are encoded in URL-safe Base64.
+#
+# This change is not backwards compatible with earlier Rails versions.
+# It's best enabled when your entire app is migrated and stable on 6.1.
+# Rails.application.config.action_controller.urlsafe_csrf_tokens = true
+
+# Specify whether `ActiveSupport::TimeZone.utc_to_local` returns a time with an
+# UTC offset or a UTC time.
+# ActiveSupport.utc_to_local_returns_utc_offset_times = true
+
+# Change the default HTTP status code to `308` when redirecting non-GET/HEAD
+# requests to HTTPS in `ActionDispatch::SSL` middleware.
+# Rails.application.config.action_dispatch.ssl_default_redirect_status = 308
+
+# Use new connection handling API. For most applications this won't have any
+# effect. For applications using multiple databases, this new API provides
+# support for granular connection swapping.
+# Rails.application.config.active_record.legacy_connection_handling = false
+
+# Make `form_with` generate non-remote forms by default.
+# Rails.application.config.action_view.form_with_generates_remote_forms = false
+
+# Set the default queue name for the analysis job to the queue adapter default.
+# Rails.application.config.active_storage.queues.analysis = nil
+
+# Set the default queue name for the purge job to the queue adapter default.
+# Rails.application.config.active_storage.queues.purge = nil
+
+# Set the default queue name for the incineration job to the queue adapter default.
+# Rails.application.config.action_mailbox.queues.incineration = nil
+
+# Set the default queue name for the routing job to the queue adapter default.
+# Rails.application.config.action_mailbox.queues.routing = nil
+
+# Set the default queue name for the mail deliver job to the queue adapter default.
+# Rails.application.config.action_mailer.deliver_later_queue_name = nil
+
+# Generate a `Link` header that gives a hint to modern browsers about
+# preloading assets when using `javascript_include_tag` and `stylesheet_link_tag`.
+# Rails.application.config.action_view.preload_links_header = true

data/config/initializers/permissions_policy.rb

@@ -0,0 +1,11 @@
+# Define an application-wide HTTP permissions policy. For further
+# information see https://developers.google.com/web/updates/2018/06/feature-policy
+#
+# Rails.application.config.permissions_policy do |f|
+#   f.camera      :none
+#   f.gyroscope   :none
+#   f.microphone  :none
+#   f.usb         :none
+#   f.fullscreen  :self
+#   f.payment     :self, "https://secure.example.com"
+# end

data/config/locales/de.yml

@@ -0,0 +1,12 @@
+de:
+  txt:
+    views:
+      similar_terms:
+        no_results: Keine Ergebnisse
+        title: Ähnliche Begriffe
+        results_heading: ähnliche Begriffe für '%{terms}'
+        results: Ihre Suche nach <span class="text-primary">%{terms}</span> ergab %{count} Treffer
+        synonyms_only: Nur Synonyme anzeigen
+        about:
+          title: Der Dienst Ähnliche Begriffe
+          description: Zum Suchwort werden eine Auswahl semantisch passender Begriffe aus dem Wortgut vorgeschlagen. Neben Begriffen mit Schlagwortfunktion enthält die Auflistung auch die deutschen alternativen Benennungen zum Suchwort.

data/config/locales/en.yml

@@ -0,0 +1,12 @@
+en:
+  txt:
+    views:
+      similar_terms:
+        no_results: No results
+        title: Similar Terms
+        results_heading: similar terms for '%{terms}'
+        results: Your search <span class="text-primary">%{terms}</span> yielded %{results_size} results
+        synonyms_only: Show synonyms only
+        about:
+          title: About similar terms
+          description: "The Similar Terms service supports users in generating search queries. It suggest semantically similar words from the vocabulary for the entered search term. This service can be used to semantically extend search queries and improve search results.\n\nSemantically similar is understood to mean synonyms (alternative labels) and terms with a semantic-associative relationship to the search term (related terms)."

data/config/routes.rb

@@ -1,9 +1,6 @@
-Iqvoc.localized_routes << lambda do |routing|
-  # XXX: adjective as resource
-  routing.get "similar" => "similar_terms#show"
-  routing.post "similar" => "similar_terms#query"
-end
-
 Rails.application.routes.draw do
-  # see above
+  scope ":lang", :constraints => Iqvoc.routing_constraint do
+    get "similar/new" => "similar_terms#new", as: 'new_similar'
+    get "similar" => "similar_terms#create"
+  end
 end

data/config/secrets.yml

@@ -0,0 +1,8 @@
+development:
+  secret_key_base: development
+
+test:
+  secret_key_base: test
+
+production:
+  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>

data/config/storage.yml

@@ -0,0 +1,34 @@
+test:
+  service: Disk
+  root: <%= Rails.root.join("tmp/storage") %>
+
+local:
+  service: Disk
+  root: <%= Rails.root.join("storage") %>
+
+# Use rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key)
+# amazon:
+#   service: S3
+#   access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
+#   secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
+#   region: us-east-1
+#   bucket: your_own_bucket
+
+# Remember not to checkin your GCS keyfile to a repository
+# google:
+#   service: GCS
+#   project: your_project
+#   credentials: <%= Rails.root.join("path/to/gcs.keyfile") %>
+#   bucket: your_own_bucket
+
+# Use rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key)
+# microsoft:
+#   service: AzureStorage
+#   storage_account_name: your_account_name
+#   storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %>
+#   container: your_container_name
+
+# mirror:
+#   service: Mirror
+#   primary: local
+#   mirrors: [ amazon, google, microsoft ]

data/config.ru

@@ -1,4 +1,6 @@
 # This file is used by Rack-based servers to start the application.
 
-require ::File.expand_path('../config/environment',  __FILE__)
-run Iqvoc::SimilarTerms::Application
+require_relative "config/environment"
+
+run Rails.application
+Rails.application.load_server

data/faucet.config.js

@@ -0,0 +1,46 @@
+module.exports = {
+  js: [
+    {
+      source: "./node_modules/jquery/dist/jquery.js",
+      target: "./public/assets/javascripts/jquery.js",
+      exports: "jQuery",
+      compact: "mangle"
+    },
+    {
+      source: "./app/assets/javascripts/manifest.js",
+      target: "./public/assets/javascripts/manifest.js",
+      externals:  { jquery: "jQuery" },
+    },
+    {
+      source: "./node_modules/bootstrap/dist/js/bootstrap.bundle.min.js",
+      target: "./public/assets/javascripts/bootstrap.bundle.min.js",
+      externals:  { jquery: "jQuery" },
+      compact: "minify"
+    }
+  ],
+  sass: [{
+    source: "./app/assets/stylesheets/manifest.scss",
+    target: "./public/assets/stylesheets/manifest.css"
+  }],
+  static: [
+  {
+    source: "./node_modules/iqvoc/app/assets/images",
+    target: "./public/assets/images"
+  },
+  {
+    source: "./node_modules/iqvoc/app/assets/fonts",
+    target: "./public/assets/fonts"
+  },
+  {
+    source: "./node_modules/font-awesome/fonts",
+    target: "./public/assets/fonts",
+    fingerprint: false
+  }
+],
+  manifest: {
+    target: "./public/assets/manifest.json",
+    key: "short",
+    webRoot: "./public"
+  },
+  watchDirs: ["./app/assets"]
+};

data/iqvoc_similar_terms.gemspec

@@ -15,10 +15,9 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "iqvoc_similar_terms"
 
-  s.add_dependency "iqvoc", "~> 4.1.0"
+  s.add_dependency "iqvoc", "~> 4.14.4"
 
   s.files = `git ls-files`.split("\n")
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 end

data/lib/iqvoc/similar_terms/version.rb

@@ -1,5 +1,5 @@
 module Iqvoc
   module SimilarTerms
-    VERSION = "0.8.0"
+    VERSION = "2.11.3"
   end
 end

data/lib/iqvoc/similar_terms.rb

@@ -1,83 +1,24 @@
 module Iqvoc
   module SimilarTerms # TODO: make language constraints optional
 
-    WEIGHTINGS = { # XXX: hard-coded - should be read from configuration -- XXX: unused/deprecated
-      "Labeling::SKOS::PrefLabel"     => 5,
-      "Labeling::SKOS::AltLabel"      => 2,
-      "Labeling::SKOS::HiddenLabel"   => 1,
+    @@weightings = {
+      'Labeling::SKOS::PrefLabel'     => 5,
+      'Labeling::SKOS::AltLabel'      => 2,
+      'Labeling::SKOS::HiddenLabel'   => 0,
       # SKOS-XL
-      "Labeling::SKOSXL::PrefLabel"   => 5,
-      "Labeling::SKOSXL::AltLabel"    => 2,
-      "Labeling::SKOSXL::HiddenLabel" => 1
+      'Labeling::SKOSXL::PrefLabel'   => 5,
+      'Labeling::SKOSXL::AltLabel'    => 2,
+      'Labeling::SKOSXL::HiddenLabel' => 0
     }
 
-    # returns an array of label/concepts pairs, sorted descendingly by weighting -- XXX: unused/deprecated
-    def self.ranked(lang, *terms) # TODO: rename
-      weighted(lang, *terms).sort_by { |label, data| data[0] }.reverse.
-          map { |label, data| [label] + data[1..-1] } # drop weighting
-    end
-
-    # returns a hash of label/weighting+concepts pairs -- XXX: unused/deprecated
-    def self.weighted(lang, *terms) # TODO: rename
-      concepts = terms_to_concepts(lang, *terms).
-          includes(:labelings => [:owner, :target]).
-          where("labels.language" => lang) # applies language constraint to results
-      return terms.inject({}) do |memo, term|
-        concepts.each do |concept|
-          concept.labelings.each do |ln|
-            concept = ln.owner
-            label = ln.target
-            weight = WEIGHTINGS[ln.class.name]
-
-            memo[label] ||= []
-            # weighting
-            memo[label][0] ||= 0
-            memo[label][0] += weight
-            # associated concepts
-            memo[label] << concept
-            memo[label].uniq! # XXX: inefficient!? can't easily use Set here though
-          end
-        end
-        memo
+    def self.register_weighting(klass_str, value)
+      Mutex.new.synchronize do
+        @@weightings[klass_str] = value
       end
     end
 
-    # returns a list of labels, sorted alphabetically
-    def self.alphabetical(lang, *terms)
-      concepts = terms_to_concepts(lang, *terms).
-          includes(:labelings => [:owner, :target]).
-          where("labels.language" => lang) # applies language constraint to results
-      return concepts.map do |concept|
-        concept.labelings.map { |ln| ln.target }
-      end.flatten.sort_by { |label| label.value }
-    end
-
-    def self.terms_to_concepts(lang, *terms)
-      concept_ids = terms_to_labels(lang, *terms).includes(:labelings).
-          map { |label| label.labelings.map(&:owner_id) }.flatten.uniq
-      return Iqvoc::Concept.base_class.where(:id => concept_ids)
+    def self.weightings
+      @@weightings
     end
-
-    # NB: case-insensitive only when inflectionals are available
-    def self.terms_to_labels(lang, *terms)
-      # efficiency enhancement to turn `IN` into `=` queries where possible
-      reduce = lambda { |arr| arr.length < 2 ? arr[0] : arr }
-
-      if Iqvoc.const_defined?(:Inflectionals)
-        # use normalized form for case-insensitivity (and performance)
-        hashes = terms.map { |term| Inflectional::Base.normalize(term) }
-        label_ids = Inflectional::Base.select([:label_id]).
-            where(:normal_hash => reduce.call(hashes)).map(&:label_id)
-        return Iqvoc::XLLabel.base_class.where(:language => lang,
-            :id => reduce.call(label_ids))
-      elsif Iqvoc.const_defined?(:XLLabel)
-        return Iqvoc::XLLabel.base_class.where(:language => lang,
-            :value => reduce.call(terms))
-      else
-        return Iqvoc::Label.base_class.where(:language => lang,
-            :value => reduce.call(terms))
-      end
-    end
-
   end
 end

data/lib/iqvoc_similar_terms.rb

@@ -1,10 +1,23 @@
 # encoding: UTF-8
 
+require 'iqvoc/similar_terms'
 require 'iqvoc/similar_terms/version'
 
 module IqvocSimilarTerms
 
-  unless Iqvoc.const_defined?(:SimilarTerms) && Iqvoc::SimilarTerms.const_defined?(:Application)
+  def self.app?
+    Iqvoc.const_defined?(:SimilarTerms) && Iqvoc::SimilarTerms.const_defined?(:Application)
+  end
+
+  def self.root
+    if app?
+      Rails.root
+    else
+      Iqvoc::SimilarTerms::Engine.root
+    end
+  end
+
+  unless app?
     require File.join(File.dirname(__FILE__), '../config/engine')
   end