needle_in_a_haystack 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4866e9ea873340add03eadd30959c1394cd0168c03ebeeb7e28c37047d4eff29
+  data.tar.gz: 1764b64f7a33a738335b446faa2340887d95ad9e0d1c12ddc208eadee921f6c1
+SHA512:
+  metadata.gz: e535c31af08738c6064e8bb3c818080ebf4dae98add9a4aa35b19d6485051b2aee6ed8cc474446007773d557f7f2870b9e85963115b6d342c7ad8af101a35c9d
+  data.tar.gz: 68baca7aacb408a164a8c020c8beda399f9d86955aef9d857a5f6d67ac300943047c21e37732b94130e64efc83bf18689c054488f5da2418fc5ef5f858479a66

data/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative "config/application"
+
+Rails.application.load_tasks

data/config/initializers/application_controller_renderer.rb

@@ -0,0 +1,8 @@
+# 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

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

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

data/config/initializers/cors.rb

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

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

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/mime_types.rb

@@ -0,0 +1,4 @@
+# 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

data/config/initializers/redis.rb

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

data/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end
+
+# To enable root element in JSON for ActiveRecord objects.
+# ActiveSupport.on_load(:active_record) do
+#   self.include_root_in_json = true
+# end

data/config/locales/en.yml

@@ -0,0 +1,33 @@
+# 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"

data/lib/concerns/taggable.rb

@@ -0,0 +1,26 @@
+# app/models/concerns/taggable.rb
+module Taggable
+  extend ActiveSupport::Concern
+
+  included do
+    serialize :tags, JSON
+  end
+
+  def add_haystack_marker(marker)
+    self.tags ||= {}
+    self.tags[marker] = true
+    save!
+  end
+
+  def add_haystack_tag(key, value)
+    self.tags ||= {}
+    self.tags[key] = value
+    save!
+  end
+
+  def add_multiple_tags(tags_hash)
+    self.tags ||= {}
+    self.tags.merge!(tags_hash)
+    save!
+  end
+end

data/lib/needle_in_a_haystack/application_record.rb

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

data/lib/needle_in_a_haystack/configuration.rb

@@ -0,0 +1,9 @@
+module NeedleInAHaystack
+  class Configuration
+    attr_accessor :taggable_models
+
+    def initialize
+      @taggable_models = []
+    end
+  end
+end

data/lib/needle_in_a_haystack/engine.rb

@@ -0,0 +1,11 @@
+module NeedleInAHaystack
+  class Engine < ::Rails::Engine
+    isolate_namespace NeedleInAHaystack
+  end
+
+  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
+end

data/lib/needle_in_a_haystack/haystack_ontology.rb

@@ -0,0 +1,68 @@
+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)
+
+      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
+      end
+
+      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
+
+      nil
+    end
+
+    def self.create_tags
+      create_tag_hierarchy(tags)
+    end
+
+    def self.create_tag_hierarchy(tag_hash, parent_tag = nil)
+      tag_hash.each do |name, data|
+        next if %w[description children].include?(name)
+
+        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"])
+
+        Rails.logger.info("Created tag: #{tag.name}, Parent: #{parent_tag&.name}")
+
+        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
+end

data/lib/needle_in_a_haystack/haystack_tag.rb

@@ -0,0 +1,69 @@
+module NeedleInAHaystack
+  class HaystackTag < ApplicationRecord
+    self.table_name = "haystack_tags"
+
+    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
+    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
+
+    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 descendants
+      children = child_tags
+      children + children.flat_map(&:descendants)
+    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 root?
+      parent_tag.nil?
+    end
+
+    def leaf?
+      child_tags.empty?
+    end
+
+    def depth
+      ancestors.size
+    end
+
+    private
+
+    def prevent_circular_reference
+      return unless parent_tag == self || ancestors.include?(self)
+
+      errors.add(:parent_tag, "kan geen circulaire referentie bevatten")
+    end
+  end
+end

data/lib/needle_in_a_haystack/haystack_tagging.rb

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

data/lib/needle_in_a_haystack/version.rb

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

data/lib/needle_in_a_haystack.rb

@@ -0,0 +1,17 @@
+require "needle_in_a_haystack/version"
+require "needle_in_a_haystack/engine"
+require "needle_in_a_haystack/application_record"
+require "needle_in_a_haystack/configuration"
+require "needle_in_a_haystack/haystack_tag"
+require "needle_in_a_haystack/haystack_tagging"
+
+module NeedleInAHaystack
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+  end
+end

data/lib/tasks/location_create.rake

@@ -0,0 +1,7 @@
+namespace :locations do
+  desc "Interactive location creator"
+  task create: :environment do
+    load "app/services/location_creator.rb"
+    LocationCreator.start
+  end
+end

data/spec/factories/haystack_tags.rb

@@ -0,0 +1,16 @@
+FactoryBot.define do
+  factory :haystack_tag, class: "NeedleInAHaystack::HaystackTag" do
+    sequence(:name) { |n| "Tag #{n}" }
+    sequence(:description) { |n| "Description #{n}" }
+
+    trait :root do
+      name { "root" }
+      description { "Root tag" }
+      parent_tag { nil }
+    end
+
+    trait :child do
+      association :parent_tag, factory: :haystack_tag
+    end
+  end
+end

metadata

@@ -0,0 +1,319 @@
+--- !ruby/object:Gem::Specification
+name: needle_in_a_haystack
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Frans Verberne
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bcrypt_pbkdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capistrano-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hiredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kodachroma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: redis-objects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sentry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sentry-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sentry-sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+description: haystack ontology implementation for FourIQ projects.
+email:
+- frans.verberne@fouriq.nl
+executables: []
+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
+- lib/concerns/taggable.rb
+- lib/needle_in_a_haystack.rb
+- lib/needle_in_a_haystack/application_record.rb
+- lib/needle_in_a_haystack/configuration.rb
+- lib/needle_in_a_haystack/engine.rb
+- lib/needle_in_a_haystack/haystack_ontology.rb
+- lib/needle_in_a_haystack/haystack_tag.rb
+- lib/needle_in_a_haystack/haystack_tagging.rb
+- lib/needle_in_a_haystack/version.rb
+- lib/tasks/location_create.rake
+- spec/factories/haystack_tags.rb
+homepage: https://www.fouriq.nl
+licenses:
+- Nonstandard
+metadata:
+  homepage_uri: https://www.fouriq.nl
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Models and dependencies shared across our projects.
+test_files: []