needle_in_a_haystack 1.0.4 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af267c9afbbd079edbdcb7ac293721697491a7e47dac4d19963ad9af83fbd60d
-  data.tar.gz: e100eff5dfe19e038ffb8c6e8086b96eb1a034f87d3de1b66861ac91a05493b6
+  metadata.gz: b329760e8ef018728c47465a1a0aacf1b83a3e89562f4a0e1ecfe703c01fc3e5
+  data.tar.gz: 2e6d30cdc898b73a9e05f7210b3dc3e5294bdb6bd844dbb7bbfeb5e02e0b4afc
 SHA512:
-  metadata.gz: d2870fbe87246fe0e39b6818fcd2ebffb5767af2a39a1d0b3636c2f93b8fc069ebdda4a4b0c7f15ae4af878fa5507571db6d29f367213510857a8f64d0d5f214
-  data.tar.gz: 6e49496b73f7d4bee5ee41e1bcc34e8e322eae66ac5af71419516c8532e7b79a2066827679dcce59680d3627cd9af4c2c968501cd9c14d07a299adb628fe72fa
+  metadata.gz: 429d11b80631e4b7a9cac61ad46f2c6655f74e599240d52f970cf83ac92269918756417bd58f2e2bb30cb0bc88eecf667395a82826599478b977b6765c6db034
+  data.tar.gz: ea62403765551a28022f267fc3d829fe86d0a28cc2afd5f9b43e4c049f1bcd8d497e41cc67b382c860dded4723c87786d3a94d5b2ce5208815dbee8e85ae0a0d

data/lib/haystack_ontology.yml

@@ -0,0 +1,255 @@
+site:
+  description: Een geografische locatie in de gebouwde omgeving
+  children:
+    building:
+      description: Een structuur op een site
+      children:
+        floor:
+          description: Een verdieping in een gebouw
+          children:
+            area:
+              description: Een driedimensionale ruimte in de gebouwde omgeving
+              children:
+                room:
+                  description: Een afgesloten ruimte binnen een gebouw
+                bathRoom:
+                  description: Een ruimte met sanitaire voorzieningen
+                kitchen:
+                  description: Een ruimte voor het bereiden van voedsel
+                bedRoom:
+                  description: Een slaapkamer
+                openSpace:
+                  description: Een open ruimte binnen een gebouw
+                corridor:
+                  description: Een gang die verschillende ruimtes verbindt
+                lobby:
+                  description: Een ontvangstruimte of hal in een gebouw
+                office:
+                  description: Een werkruimte binnen een gebouw
+                conferenceRoom:
+                  description: Een vergaderruimte binnen een gebouw
+                storage:
+                  description: Een opslagruimte binnen een gebouw
+                mechanicalRoom:
+                  description: Een ruimte voor mechanische apparatuur en installaties
+                electricalRoom:
+                  description: Een ruimte voor elektrische apparatuur en installaties
+
+equip:
+  description: Apparatuur asset
+  children:
+    meter:
+      description: Meetapparaat voor verbruik
+      children:
+        elecMeter:
+          description: Elektriciteitsmeter
+          children:
+            smartMeter:
+              description: Slimme meter voor elektriciteit
+            intervalMeter:
+              description: Intervalmeter voor elektriciteit
+            meterbeheer:
+              description: Meterbeheer elektriciteitsmeter
+            fudura:
+              description: Fudura elektriciteitsmeter
+        gasMeter:
+          description: Gasmeter
+          children:
+            smartMeter:
+              description: Slimme meter voor gas
+            intervalMeter:
+              description: Intervalmeter voor gas
+            meterbeheer:
+              description: Meterbeheer gasmeter
+            fudura:
+              description: Fudura gasmeter
+        waterMeter:
+          description: Watermeter
+        climateMeter:
+          description: Klimaatmeter
+          children:
+            tempMeter:
+              description: Temperatuurmeter
+            co2Meter:
+              description: CO2-meter
+            humidityMeter:
+              description: Luchtvochtigheidsmeter
+            loraMeter:
+              description: LoRa klimaatmeter voor temperatuur, luchtvochtigheid en CO2
+
+    weatherStation:
+      description: Weerstation voor meteorologische gegevens
+      children:
+        onlineWeather:
+          description: Online weerstation via api of website
+    hvac:
+      description: Verwarming, ventilatie en airconditioning
+      children:
+        ahu:
+          description: Luchtbehandelingskast
+        vav:
+          description: Variable Air Volume box
+        fcu:
+          description: Fan Coil Unit
+        chiller:
+          description: Koelmachine
+        boiler:
+          description: Verwarmingsketel
+        heatPump:
+          description: Warmtepomp
+    lighting:
+      description: Verlichtingssystemen
+      children:
+        luminaire:
+          description: Armatuur
+        lightSensor:
+          description: Lichtsensor
+        occupancySensor:
+          description: Aanwezigheidssensor
+    security:
+      description: Beveiligingssystemen
+      children:
+        accessControl:
+          description: Toegangscontrolesysteem
+        cctv:
+          description: Camerabewakingssysteem
+
+# Datapunten
+point:
+  description: Datapunt zoals een sensor of actuator
+  children:
+    sensor:
+      description: Meetpunt
+      children:
+        temp:
+          description: Temperatuursensor
+          children:
+            tempIndoor:
+              description: Binnentemperatuursensor
+            tempOutdoor:
+              description: Buitentemperatuursensor
+        co2:
+          description: CO2-sensor
+        humidity:
+          description: Luchtvochtigheidssensor
+        pressure:
+          description: Druksensor
+        flow:
+          description: Stromingssensor
+        power:
+          description: Vermogenssensor
+        energy:
+          description: Energiesensor
+        occupancy:
+          description: Bezettingssensor
+    cmd:
+      description: Commandopunt
+      children:
+        onOff:
+          description: Aan/uit commando
+        setpoint:
+          description: Instelpunt
+    sp:
+      description: Setpoint
+      children:
+        tempSp:
+          description: Temperatuur setpoint
+        humiditySp:
+          description: Luchtvochtigheid setpoint
+        pressureSp:
+          description: Druk setpoint
+    status:
+      description: Statuspunt
+      children:
+        alarm:
+          description: Alarmpunt
+        fault:
+          description: Foutpunt
+
+# Energiebronnen
+substance:
+  description: Energiebron of medium
+  children:
+    elec:
+      description: Elektriciteit
+    gas:
+      description: Gas
+    water:
+      description: Water
+    steam:
+      description: Stoom
+    oil:
+      description: Olie
+
+# Metingen en eenheden
+measurement:
+  description: Meetbare eigenschappen
+  children:
+    temp:
+      description: Temperatuur
+    humidity:
+      description: Luchtvochtigheid
+    co2:
+      description: Koolstofdioxide concentratie
+    pressure:
+      description: Druk
+    flow:
+      description: Stroming
+    power:
+      description: Vermogen
+    energy:
+      description: Energie
+    voltage:
+      description: Spanning
+    current:
+      description: Stroom
+    frequency:
+      description: Frequentie
+    luminosity:
+      description: Lichtsterkte
+
+# Tijdgerelateerde tags
+occupied:
+  description: Bezettingsstatus
+schedule:
+  description: Tijdschema
+timezone:
+  description: Tijdzone
+
+# Netwerkgerelateerde tags
+network:
+  description: Netwerkgerelateerde informatie
+  children:
+    protocol:
+      description: Communicatieprotocol
+      children:
+        bacnet:
+          description: BACnet protocol
+        modbus:
+          description: Modbus protocol
+        knx:
+          description: KNX protocol
+        lonworks:
+          description: LonWorks protocol
+    ipAddr:
+      description: IP-adres
+    mac:
+      description: MAC-adres
+
+# Metadata tags
+id:
+  description: Unieke identifier
+dis:
+  description: Weergavenaam
+area:
+  description: Oppervlakte
+vol:
+  description: Volume
+manufacturer:
+  description: Fabrikant
+model:
+  description: Model
+serialNum:
+  description: Serienummer
+installationDate:
+  description: Installatiedatum

data/lib/needle_in_a_haystack/concerns/taggable.rb

@@ -1,9 +1,6 @@
-module Taggable
-  extend ActiveSupport::Concern
-
-  included do
-    serialize :tags, JSON
-  end
+class Taggable < ApplicationRecord
+  has_many :haystack_taggings, as: :taggable, dependent: :destroy
+  has_many :haystack_tags, through: :haystack_taggings
 
   def add_haystack_marker(marker)
     self.tags ||= {}

data/lib/needle_in_a_haystack/factories/haystack_factory.rb

@@ -0,0 +1,39 @@
+class HaystackFactory < BaseFactory
+  attr_accessor :tag_strategy
+
+  def initialize(tag_strategy = DefaultTagStrategy.new)
+    super()
+    @tag_strategy = tag_strategy
+  end
+
+  def create_tag(name, description)
+    @tag_strategy.create_tag(name, description)
+  end
+
+  def create_tagging(tag, taggable)
+    HaystackTagging.create(haystack_tag: tag, taggable: taggable)
+  end
+
+  def find_or_create_tag(name, attributes = {})
+    tag = HaystackTag.find_or_create_by(name: name)
+    if tag.persisted?
+      @tag_strategy.update_tag(tag, attributes)
+    else
+      tag.update(attributes)
+    end
+    tag
+  end
+
+  def create_tags(tag_hash, parent_tag = nil)
+    tag_hash.each do |name, data|
+      next if %w[description children].include?(name)
+
+      tag = find_or_create_tag(name, description: data["description"], haystack_marker: data["marker"])
+      tag.update(parent_tag_id: parent_tag&.id)
+
+      Rails.logger.info("Created tag: #{tag.name}, Parent: #{parent_tag&.name}, Parent ID: #{parent_tag&.id}")
+
+      create_tags(data["children"], tag) if data["children"]
+    end
+  end
+end

data/lib/needle_in_a_haystack/models/haystack_ontology.rb

@@ -38,27 +38,12 @@ class HaystackOntology < ApplicationRecord
   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}, Parent ID: #{parent_tag&.id}")
-
-      if data["children"]
-        Rails.logger.info("Processing children for tag: #{tag.name}")
-        create_tag_hierarchy(data["children"], tag)
-      end
-    end
+    factory = HaystackFactory.new(OntologyTagStrategy.new)
+    factory.create_tags(tags)
   end
 
   def self.find_or_create_tag(name)
-    factory = HaystackFactory.new
+    factory = HaystackFactory.new(OntologyTagStrategy.new)
     tag_data = find_tag(name)
     return nil if tag_data.nil?
 

data/lib/needle_in_a_haystack/models/haystack_tag.rb

@@ -1,17 +1,24 @@
+require "yaml"
+
 class HaystackTag < BaseTag
   belongs_to :parent_tag, class_name: "HaystackTag", optional: true
   has_many :children, class_name: "HaystackTag", foreign_key: "parent_tag_id", dependent: :destroy, inverse_of: :parent_tag
   has_many :haystack_taggings, dependent: :destroy
-  has_many :taggables, through: :haystack_taggings
+  has_many :taggables, through: :haystack_taggings, source: :taggable, source_type: "Taggable"
 
-  validates :name, presence: true, uniqueness: true
+  validates :name, presence: true, uniqueness: { scope: :parent_tag_id, message: "Moet uniek zijn binnen dezelfde categorie" }
   validates :description, presence: true
   validate :prevent_circular_reference
+  validate :ensure_identity
+
+  CATEGORIES = YAML.load_file("lib/haystack_ontology.yml")
 
   def ancestors
     ancestors = []
     current = self
     while current.parent_tag
+      break if ancestors.include?(current.parent_tag) # Voorkom oneindige lus
+
       ancestors << current.parent_tag
       current = current.parent_tag
     end
@@ -19,7 +26,7 @@ class HaystackTag < BaseTag
   end
 
   def full_path
-    ancestors.reverse.map(&:name).join(" > ") + " > " + name
+    "#{ancestors.reverse.map(&:name).join(' > ')} > #{name}"
   end
 
   def self.find_by_path(path)
@@ -52,9 +59,24 @@ class HaystackTag < BaseTag
     ancestors.size
   end
 
+  def category
+    ancestors.empty? ? name : parent_tag.category
+  end
+
+  private
+
   def prevent_circular_reference
     return unless parent_tag == self || ancestors.include?(self)
 
-    errors.add(:parent_tag, "cannot contain a circular reference")
+    errors.add(:parent_tag, "Kan geen circulaire referentie bevatten")
+  end
+
+  def ensure_identity
+    return if root? && name == category
+
+    return unless HaystackTag.where(name: name).any? { |tag| tag.category == category }
+
+    Rails.logger.error("Duplicate tag found: #{name} within category: #{category}")
+    errors.add(:name, "Moet uniek zijn binnen dezelfde categorie")
   end
 end

data/lib/needle_in_a_haystack/strategies/default_tag_strategy.rb

@@ -0,0 +1,9 @@
+class DefaultTagStrategy < TagStrategy
+  def create_tag(name, description)
+    HaystackTag.create(name: name, description: description)
+  end
+
+  def update_tag(tag, attributes)
+    tag.update(attributes)
+  end
+end

data/lib/needle_in_a_haystack/strategies/find_by_tags_strategy.rb

@@ -0,0 +1,11 @@
+class FindByTagsStrategy < QueryStrategy
+  def initialize(model, tags)
+    super()
+    @model = model
+    @tags = tags
+  end
+
+  def execute
+    @model.joins(:haystack_tags).where(haystack_tags: { id: @tags.map(&:id) })
+  end
+end

data/lib/needle_in_a_haystack/strategies/find_point_by_tag_strategy.rb

@@ -0,0 +1,11 @@
+class FindPointsWithTagStrategy < QueryStrategy
+  def initialize(model, tag)
+    super()
+    @model = model
+    @tag = tag
+  end
+
+  def execute
+    @model.joins(:haystack_tags).where(haystack_tags: { id: @tag.id })
+  end
+end

data/lib/needle_in_a_haystack/strategies/find_points_with_multiple_tags_strategy.rb

@@ -0,0 +1,14 @@
+class FindPointsWithMultipleTagsStrategy < QueryStrategy
+  def initialize(model, tags)
+    super()
+    @model = model
+    @tags = tags
+  end
+
+  def execute
+    @model.joins(:haystack_tags)
+          .where(haystack_tags: { id: @tags.map(&:id) })
+          .group("#{@model.table_name}.id")
+          .having("COUNT(haystack_tags.id) = ?", @tags.size)
+  end
+end

data/lib/needle_in_a_haystack/strategies/ontology_tag_strategy.rb

@@ -0,0 +1,11 @@
+class OntologyTagStrategy < TagStrategy
+  def create_tag(name, description)
+    HaystackTag.find_or_create_by(name: name).tap do |tag|
+      tag.update(description: description)
+    end
+  end
+
+  def update_tag(tag, attributes)
+    tag.update(attributes)
+  end
+end

data/lib/needle_in_a_haystack/strategies/query_context.rb

@@ -0,0 +1,9 @@
+class QueryContext
+  def initialize(strategy)
+    @strategy = strategy
+  end
+
+  def execute
+    @strategy.execute
+  end
+end

data/lib/needle_in_a_haystack/strategies/query_strategy.rb

@@ -0,0 +1,5 @@
+class QueryStrategy
+  def execute
+    raise NotImplementedError, "Subclasses must implement the execute method"
+  end
+end

data/lib/needle_in_a_haystack/strategies/tag_strategy.rb

@@ -0,0 +1,9 @@
+class TagStrategy
+  def create_tag(name, description)
+    raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+  end
+
+  def update_tag(tag, attributes)
+    raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
+  end
+end

data/lib/needle_in_a_haystack/version.rb

@@ -1 +1 @@
-VERSION = "1.0.4".freeze
+VERSION = "1.0.6".freeze

data/lib/needle_in_a_haystack.rb

@@ -4,12 +4,21 @@ require "needle_in_a_haystack/application_record"
 require "needle_in_a_haystack/configuration"
 require "needle_in_a_haystack/concerns/base_tagging"
 require "needle_in_a_haystack/concerns/base_tag"
-require "needle_in_a_haystack/concerns/base_factory"
+require "needle_in_a_haystack/factories/base_factory"
 
 require "needle_in_a_haystack/models/haystack_ontology"
+require "needle_in_a_haystack/concerns/taggable"
 require "needle_in_a_haystack/models/haystack_tag"
 require "needle_in_a_haystack/models/haystack_tagging"
-require "needle_in_a_haystack/services/haystack_factory"
+require "needle_in_a_haystack/factories/haystack_factory"
+require "needle_in_a_haystack/strategies/query_context"
+require "needle_in_a_haystack/strategies/query_strategy"
+require "needle_in_a_haystack/strategies/find_by_tags_strategy"
+require "needle_in_a_haystack/strategies/find_point_by_tag_strategy"
+require "needle_in_a_haystack/strategies/find_points_with_multiple_tags_strategy"
+require "needle_in_a_haystack/strategies/tag_strategy"
+require "needle_in_a_haystack/strategies/default_tag_strategy"
+require "needle_in_a_haystack/strategies/ontology_tag_strategy"
 
 module NeedleInAHaystack
   class << self

data/spec/factories/haystack_tags.rb

@@ -1,5 +1,5 @@
 FactoryBot.define do
-  factory :haystack_tag, class: "NeedleInAHaystack::HaystackTag" do
+  factory :haystack_tag, class: "HaystackTag" do
     sequence(:name) { |n| "Tag #{n}" }
     sequence(:description) { |n| "Description #{n}" }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: needle_in_a_haystack
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.6
 platform: ruby
 authors:
 - Frans Verberne
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-28 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt_pbkdf
@@ -275,18 +275,27 @@ files:
 - config/initializers/redis.rb
 - config/initializers/wrap_parameters.rb
 - config/locales/en.yml
+- lib/haystack_ontology.yml
 - lib/needle_in_a_haystack.rb
 - lib/needle_in_a_haystack/application_record.rb
-- lib/needle_in_a_haystack/concerns/base_factory.rb
 - lib/needle_in_a_haystack/concerns/base_tag.rb
 - lib/needle_in_a_haystack/concerns/base_tagging.rb
 - lib/needle_in_a_haystack/concerns/taggable.rb
 - lib/needle_in_a_haystack/configuration.rb
 - lib/needle_in_a_haystack/engine.rb
+- lib/needle_in_a_haystack/factories/base_factory.rb
+- lib/needle_in_a_haystack/factories/haystack_factory.rb
 - lib/needle_in_a_haystack/models/haystack_ontology.rb
 - lib/needle_in_a_haystack/models/haystack_tag.rb
 - lib/needle_in_a_haystack/models/haystack_tagging.rb
-- lib/needle_in_a_haystack/services/haystack_factory.rb
+- lib/needle_in_a_haystack/strategies/default_tag_strategy.rb
+- lib/needle_in_a_haystack/strategies/find_by_tags_strategy.rb
+- lib/needle_in_a_haystack/strategies/find_point_by_tag_strategy.rb
+- lib/needle_in_a_haystack/strategies/find_points_with_multiple_tags_strategy.rb
+- lib/needle_in_a_haystack/strategies/ontology_tag_strategy.rb
+- lib/needle_in_a_haystack/strategies/query_context.rb
+- lib/needle_in_a_haystack/strategies/query_strategy.rb
+- lib/needle_in_a_haystack/strategies/tag_strategy.rb
 - lib/needle_in_a_haystack/version.rb
 - lib/tasks/location_create.rake
 - spec/factories/haystack_tags.rb
@@ -310,7 +319,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: Models and dependencies shared across our projects.

data/lib/needle_in_a_haystack/services/haystack_factory.rb

@@ -1,15 +0,0 @@
-class HaystackFactory < BaseFactory
-  def create_tag(name, description)
-    HaystackTag.create(name: name, description: description)
-  end
-
-  def create_tagging(tag, taggable)
-    HaystackTagging.create(haystack_tag: tag, taggable: taggable)
-  end
-
-  def find_or_create_tag(name, attributes = {})
-  tag = HaystackTag.find_or_create_by(name: name)
-  tag.update(attributes)
-  tag
-  end
-end