needle_in_a_haystack 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4866e9ea873340add03eadd30959c1394cd0168c03ebeeb7e28c37047d4eff29
-  data.tar.gz: 1764b64f7a33a738335b446faa2340887d95ad9e0d1c12ddc208eadee921f6c1
+  metadata.gz: 7e365c25451da6fb9d1ab929ece76bfea7e5753544818eb5e8650642ed5d10b6
+  data.tar.gz: d926c7e2ad775dc46d5c38a48b352dfd1ffd369196f3c3aab7aabe40c915d142
 SHA512:
-  metadata.gz: e535c31af08738c6064e8bb3c818080ebf4dae98add9a4aa35b19d6485051b2aee6ed8cc474446007773d557f7f2870b9e85963115b6d342c7ad8af101a35c9d
-  data.tar.gz: 68baca7aacb408a164a8c020c8beda399f9d86955aef9d857a5f6d67ac300943047c21e37732b94130e64efc83bf18689c054488f5da2418fc5ef5f858479a66
+  metadata.gz: 6cfd26955113913e7ef3f5f24435485f45d83dac53f54b92d10cc7199f6c48358c1aa8072cdd911bc4e700acbd184ccdab808a987775addd438654e88218c363
+  data.tar.gz: 20f66d4f920165380f95fd2f981207131034f96a14b86d6019e62f9c77cc83127669bae046ef02c599a7dd210c716d9a6510582d4f6157fb5b34317e0bd40796

data/config/initializers/config.rb

@@ -1,5 +1,5 @@
 ENABLE_SENTRY_RAVEN ||= true
-SERVER_URL ||= "http://localhost"
+SERVER_URL ||= "http://localhost".freeze
 SERVER_PORT ||= 3000
-USERNAME ||= "admin"
-PASSWORD ||= "password"
+USERNAME ||= "admin".freeze
+PASSWORD ||= "password".freeze

data/config/initializers/redis.rb

@@ -1,2 +1,2 @@
 require "connection_pool"
-Redis::Objects.redis = ConnectionPool.new(size: 8, timeout: 5) { Redis.new(path: "/tmp/redis.sock")}
+Redis::Objects.redis = ConnectionPool.new(size: 8, timeout: 5) { Redis.new(path: "/tmp/redis.sock") }

data/config/locales/en.yml

@@ -1,33 +1,2 @@
-# Files in the config/locales directory are used for internationalization
-# and are automatically loaded by Rails. If you want to use locales other
-# than English, add the necessary files in this directory.
-#
-# To use the locales, use `I18n.t`:
-#
-#     I18n.t 'hello'
-#
-# In views, this is aliased to just `t`:
-#
-#     <%= t('hello') %>
-#
-# To use a different locale, set it with `I18n.locale`:
-#
-#     I18n.locale = :es
-#
-# This would use the information in config/locales/es.yml.
-#
-# The following keys must be escaped otherwise they will not be retrieved by
-# the default I18n backend:
-#
-# true, false, on, off, yes, no
-#
-# Instead, surround them with single quotes.
-#
-# en:
-#   'true': 'foo'
-#
-# To learn more, please read the Rails Internationalization guide
-# available at https://guides.rubyonrails.org/i18n.html.
-
 en:
-  hello: "Hello world"
+  circular_reference: Circular reference detected

data/lib/needle_in_a_haystack/application_record.rb

@@ -1,5 +1,3 @@
-module NeedleInAHaystack
-  class ApplicationRecord < ActiveRecord::Base
-    self.abstract_class = true
-  end
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
 end

data/lib/needle_in_a_haystack/configuration.rb

@@ -1,9 +1,15 @@
-module NeedleInAHaystack
-  class Configuration
-    attr_accessor :taggable_models
+class Configuration
+  attr_accessor :taggable_models
 
-    def initialize
-      @taggable_models = []
-    end
+  def initialize
+    @taggable_models = []
   end
 end
+
+def self.configuration
+  @configuration ||= Configuration.new
+end
+
+def self.configure
+  yield(configuration)
+end

data/lib/needle_in_a_haystack/engine.rb

@@ -1,11 +1,8 @@
-module NeedleInAHaystack
-  class Engine < ::Rails::Engine
-    isolate_namespace NeedleInAHaystack
-  end
+class Engine < ::Rails::Engine
+end
 
-  raise "Gem 'needle_in_a_haystack' is not loaded" unless Gem.loaded_specs["needle_in_a_haystack"]
+raise "Gem 'needle_in_a_haystack' is not loaded" unless Gem.loaded_specs["needle_in_a_haystack"]
 
-  Gem.loaded_specs["needle_in_a_haystack"].dependencies.each do |d|
-    require d.name
-  end
+Gem.loaded_specs["needle_in_a_haystack"].dependencies.each do |d|
+  require d.name
 end

data/lib/needle_in_a_haystack/haystack_ontology.rb

@@ -1,68 +1,66 @@
-module NeedleInAHaystack
-  class HaystackOntology < ApplicationRecord
-    def self.tags
-      @tags ||= YAML.load_file(Rails.root.join("config/haystack_ontology.yml"))
-    end
-
-    def self.find_tag(path)
-      return nil if path.nil?
-
-      path.include?(".") ? find_tag_in_hierarchy(tags, path.split(".").last) : find_tag_in_hierarchy(tags, path)
-    end
-
-    def self.find_tag_in_hierarchy(current_hash, target_key, path = [])
-      return nil unless current_hash.is_a?(Hash)
+class HaystackOntology < ApplicationRecord
+  def self.tags
+    @tags ||= YAML.load_file(Rails.root.join("config/haystack_ontology.yml"))
+  end
 
-      result = current_hash[target_key]
-      return result.is_a?(Hash) ? result.merge("path" => path.push(target_key).join(".")) : result if result
+  def self.find_tag(path)
+    return nil if path.nil?
 
-      children = current_hash["children"]
-      if children.is_a?(Hash)
-        children.each do |key, value|
-          new_path = path + [key]
-          return value.merge("path" => new_path.join(".")) if key == target_key
+    path.include?(".") ? find_tag_in_hierarchy(tags, path.split(".").last) : find_tag_in_hierarchy(tags, path)
+  end
 
-          result = find_tag_in_hierarchy(value, target_key, new_path)
-          return result if result
-        end
-      end
+  def self.find_tag_in_hierarchy(current_hash, target_key, path = [])
+    return nil unless current_hash.is_a?(Hash)
 
-      current_hash.each do |key, value|
-        next if %w[description children].include?(key) || !value.is_a?(Hash)
+    result = current_hash[target_key]
+    return result.is_a?(Hash) ? result.merge("path" => path.push(target_key).join(".")) : result if result
 
+    children = current_hash["children"]
+    if children.is_a?(Hash)
+      children.each do |key, value|
         new_path = path + [key]
+        return value.merge("path" => new_path.join(".")) if key == target_key
+
         result = find_tag_in_hierarchy(value, target_key, new_path)
         return result if result
       end
-
-      nil
     end
 
-    def self.create_tags
-      create_tag_hierarchy(tags)
+    current_hash.each do |key, value|
+      next if %w[description children].include?(key) || !value.is_a?(Hash)
+
+      new_path = path + [key]
+      result = find_tag_in_hierarchy(value, target_key, new_path)
+      return result if result
     end
 
-    def self.create_tag_hierarchy(tag_hash, parent_tag = nil)
-      tag_hash.each do |name, data|
-        next if %w[description children].include?(name)
+    nil
+  end
 
-        tag = HaystackTag.find_or_create_by(name: name.to_s)
-        tag.update(description: data["description"], parent_tag_id: parent_tag&.id, haystack_marker: data["marker"])
+  def self.create_tags
+    create_tag_hierarchy(tags)
+  end
 
-        Rails.logger.info("Created tag: #{tag.name}, Parent: #{parent_tag&.name}")
+  def self.create_tag_hierarchy(tag_hash, parent_tag = nil)
+    tag_hash.each do |name, data|
+      next if %w[description children].include?(name)
 
-        create_tag_hierarchy(data["children"], tag) if data["children"]
-      end
-    end
+      tag = HaystackTag.find_or_create_by(name: name.to_s)
+      tag.update(description: data["description"], parent_tag_id: parent_tag&.id, haystack_marker: data["marker"])
 
-    def self.find_or_create_tag(name)
-      tag_data = find_tag(name)
-      return nil if tag_data.nil?
+      Rails.logger.info("Created tag: #{tag.name}, Parent: #{parent_tag&.name}")
 
-      tag = HaystackTag.find_or_create_by(name: name)
-      tag.update(description: tag_data["description"], haystack_marker: tag_data["marker"])
-      Rails.logger.info("Tag aangemaakt of gevonden: #{tag.name}")
-      tag
+      create_tag_hierarchy(data["children"], tag) if data["children"]
     end
   end
+
+  def self.find_or_create_tag(name)
+    tag_data = find_tag(name)
+    return nil if tag_data.nil?
+
+    tag = HaystackTag.find_or_create_by(name: name)
+    tag.update(description: tag_data["description"], haystack_marker: tag_data["marker"])
+    Rails.logger.info("Tag aangemaakt of gevonden: #{tag.name}")
+    tag
+  end
 end

data/lib/needle_in_a_haystack/haystack_tag.rb

@@ -1,69 +1,63 @@
-module NeedleInAHaystack
-  class HaystackTag < ApplicationRecord
-    self.table_name = "haystack_tags"
+class HaystackTag < ApplicationRecord
+  belongs_to :parent_tag, class_name: "NeedleInAHaystack::HaystackTag", optional: true
+  has_many :children, class_name: "NeedleInAHaystack::HaystackTag", foreign_key: "parent_tag_id", dependent: :destroy, inverse_of: :parent_tag
+  has_many :haystack_taggings, dependent: :destroy
+  has_many :taggables, through: :haystack_taggings
 
-    belongs_to :parent_tag, class_name: "NeedleInAHaystack::HaystackTag", optional: true
-    has_many :children, class_name: "NeedleInAHaystack::HaystackTag", foreign_key: "parent_tag_id", dependent: :destroy, inverse_of: :parent_tag
-    has_many :haystack_taggings, dependent: :destroy
-    has_many :taggables, through: :haystack_taggings
-
-    if NeedleInAHaystack.respond_to?(:configuration) && NeedleInAHaystack.configuration.taggable_models
-      NeedleInAHaystack.configuration.taggable_models.each do |model|
-        has_many "taggable_#{model.name.underscore.pluralize}".to_sym, through: :haystack_taggings, source: :taggable, source_type: model.name
-      end
+  if NeedleInAHaystack.respond_to?(:configuration) && NeedleInAHaystack.configuration&.taggable_models
+    NeedleInAHaystack.configuration.taggable_models.each do |model|
+      has_many "taggable_#{model.name.underscore.pluralize}".to_sym, through: :haystack_taggings, source: :taggable, source_type: model.name
     end
+  end
 
-    validates :name, presence: true, uniqueness: true
-    validates :description, presence: true
-    validate :prevent_circular_reference
-
-    def ancestors
-      ancestors = []
-      current = self
-      while current.parent_tag
-        ancestors << current.parent_tag
-        current = current.parent_tag
-      end
-      ancestors
-    end
+  validates :name, presence: true
+  validates :description, presence: true
+  validate :prevent_circular_reference
 
-    def self.find_by_path(path)
-      keys = path.split(".")
-      current = nil
-      keys.each do |key|
-        current = current ? current.child_tags.find_by(name: key) : find_by(name: key)
-        return nil unless current
-      end
-      current
+  def ancestors
+    ancestors = []
+    current_tag = self
+    while current_tag.parent_tag
+      ancestors << current_tag.parent_tag
+      current_tag = current_tag.parent_tag
     end
+    ancestors
+  end
 
-    def descendants
-      children = child_tags
-      children + children.flat_map(&:descendants)
+  def self.find_by_path(path)
+    keys = path.split(".")
+    current = nil
+    keys.each do |key|
+      current = current ? current.child_tags.find_by(name: key) : find_by(name: key)
+      return nil unless current
     end
+    current
+  end
 
-    def siblings
-      parent_tag ? parent_tag.child_tags.where.not(id: id) : self.class.where(parent_tag_id: nil).where.not(id: id)
-    end
+  def descendants
+    children = child_tags
+    children + children.flat_map(&:descendants)
+  end
 
-    def root?
-      parent_tag.nil?
-    end
+  def siblings
+    parent_tag ? parent_tag.child_tags.where.not(id: id) : self.class.where(parent_tag_id: nil).where.not(id: id)
+  end
 
-    def leaf?
-      child_tags.empty?
-    end
+  def root?
+    parent_tag.nil?
+  end
 
-    def depth
-      ancestors.size
-    end
+  def leaf?
+    child_tags.empty?
+  end
 
-    private
+  def depth
+    ancestors.size
+  end
 
-    def prevent_circular_reference
-      return unless parent_tag == self || ancestors.include?(self)
+  def prevent_circular_reference
+    return unless parent_tag == self || ancestors.include?(self)
 
-      errors.add(:parent_tag, "kan geen circulaire referentie bevatten")
-    end
+    errors.add(:parent_tag, "kan geen circulaire referentie bevatten")
   end
 end

data/lib/needle_in_a_haystack/haystack_tagging.rb

@@ -1,8 +1,4 @@
-module NeedleInAHaystack
-  class HaystackTagging < ApplicationRecord
-    self.table_name = "haystack_taggings"
-
-    belongs_to :haystack_tag
-    belongs_to :taggable, polymorphic: true
-  end
+class HaystackTagging < ApplicationRecord
+  belongs_to :haystack_tag
+  belongs_to :taggable, polymorphic: true
 end

data/lib/needle_in_a_haystack/version.rb

@@ -1,3 +1 @@
-module NeedleInAHaystack
-  VERSION = "1.0.0".freeze
-end
+VERSION = "1.0.1".freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: needle_in_a_haystack
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Frans Verberne
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-27 00:00:00.000000000 Z
+date: 2024-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt_pbkdf
@@ -270,14 +270,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Rakefile
-- config/initializers/application_controller_renderer.rb
-- config/initializers/backtrace_silencers.rb
 - config/initializers/config.rb
-- config/initializers/cors.rb
 - config/initializers/filter_parameter_logging.rb
-- config/initializers/inflections.rb
-- config/initializers/lograge.rb
-- config/initializers/mime_types.rb
 - config/initializers/redis.rb
 - config/initializers/wrap_parameters.rb
 - config/locales/en.yml

data/config/initializers/application_controller_renderer.rb

@@ -1,8 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# ActiveSupport::Reloader.to_prepare do
-#   ApplicationController.renderer.defaults.merge!(
-#     http_host: 'example.org',
-#     https: false
-#   )
-# end

data/config/initializers/backtrace_silencers.rb

@@ -1,7 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
-# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
-
-# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
-# Rails.backtrace_cleaner.remove_silencers!

data/config/initializers/cors.rb

@@ -1,16 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# Avoid CORS issues when API is called from the frontend app.
-# Handle Cross-Origin Resource Sharing (CORS) in order to accept cross-origin AJAX requests.
-
-# Read more: https://github.com/cyu/rack-cors
-
-# Rails.application.config.middleware.insert_before 0, Rack::Cors do
-#   allow do
-#     origins 'example.com'
-#
-#     resource '*',
-#       headers: :any,
-#       methods: [:get, :post, :put, :patch, :delete, :options, :head]
-#   end
-# end

data/config/initializers/inflections.rb

@@ -1,16 +0,0 @@
-# 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/mime_types.rb

@@ -1,4 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# Add new mime types for use in respond_to blocks:
-# Mime::Type.register "text/richtext", :rtf