datafoodconsortium-connector 1.0.0.pre.alpha.8 → 1.0.0.pre.alpha.10

data/lib/datafoodconsortium/connector/{allergen_dimension.rb → quantity.rb}

@@ -20,15 +20,32 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require "datafoodconsortium/connector/characteristic_dimension"
+
 
 require "virtual_assembly/semantizer"
 
-class DataFoodConsortium::Connector::AllergenDimension < DataFoodConsortium::Connector::CharacteristicDimension
+class DataFoodConsortium::Connector::Quantity
+    include VirtualAssembly::Semantizer::SemanticObject
 
-	
+    SEMANTIC_TYPE = "dfc-b:Quantity".freeze
 
+	# @return [ISKOSConcept]
+	attr_accessor :unit
 
+	# @return [Real]
+	attr_accessor :value
+
+	# @param unit [ISKOSConcept]
+	# @param value [Real]
+	def initialize(unit: nil, value: 0.0)
+		super()
+		@unit = unit
+		@value = value
+		self.semanticType = "dfc-b:Quantity"
+		registerSemanticProperty("dfc-b:hasUnit", &method("unit")).valueSetter = method("unit=")
+		registerSemanticProperty("dfc-b:value", &method("value")).valueSetter = method("value=")
+	end
+	
 
 
 end

data/lib/datafoodconsortium/connector/sale_session.rb

@@ -0,0 +1,64 @@
+# MIT License
+# 
+# Copyright (c) 2023 Maxime Lecoq <maxime@lecoqlibre.fr>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+
+
+require "virtual_assembly/semantizer"
+
+class DataFoodConsortium::Connector::SaleSession
+    include VirtualAssembly::Semantizer::SemanticObject
+
+    SEMANTIC_TYPE = "dfc-b:SaleSession".freeze
+
+	# @return [String]
+	attr_accessor :beginDate
+
+	# @return [String]
+	attr_accessor :endDate
+
+	# @return [Real]
+	attr_accessor :quantity
+
+	# @return [IOffer]
+	attr_accessor :offers
+
+	# @param semanticId [String]
+	# @param beginDate [String]
+	# @param endDate [String]
+	# @param quantity [Real]
+	# @param offers [IOffer]
+	def initialize(semanticId, beginDate: "", endDate: "", quantity: 0.0, offers: [])
+		super(semanticId)
+		@beginDate = beginDate
+		@endDate = endDate
+		@quantity = quantity
+		@offers = offers
+		self.semanticType = "dfc-b:SaleSession"
+		registerSemanticProperty("dfc-b:beginDate", &method("beginDate")).valueSetter = method("beginDate=")
+		registerSemanticProperty("dfc-b:endDate", &method("endDate")).valueSetter = method("endDate=")
+		registerSemanticProperty("dfc-b:quantity", &method("quantity")).valueSetter = method("quantity=")
+		registerSemanticProperty("dfc-b:lists", &method("offers")).valueSetter = method("offers=")
+	end
+	
+
+
+end

data/lib/datafoodconsortium/connector/skos_concept.rb

@@ -24,10 +24,12 @@
 
 
 require "virtual_assembly/semantizer"
-
+require 'datafoodconsortium/connector/skos_helper'
 class DataFoodConsortium::Connector::SKOSConcept
+    include VirtualAssembly::Semantizer::SemanticObject
+    include DataFoodConsortium::Connector::SKOSHelper
 
-	include VirtualAssembly::Semantizer::SemanticObject
+    SEMANTIC_TYPE = "skos:Concept".freeze
 
 	# @return [ISKOSConcept]
 	attr_accessor :broaders
@@ -41,47 +43,25 @@ class DataFoodConsortium::Connector::SKOSConcept
 	# @return [ISKOSLabel]
 	attr_accessor :prefLabels
 
+	# @param semanticId [String]
 	# @param broaders [ISKOSConcept]
 	# @param schemes [ISKOSConceptScheme]
 	# @param narrowers [ISKOSConcept]
 	# @param prefLabels [ISKOSLabel]
-	def initialize(broaders: [], schemes: [], narrowers: [], prefLabels: [])
-		super()
+	def initialize(semanticId, broaders: [], schemes: [], narrowers: [], prefLabels: [])
+		super(semanticId)
 		@broaders = broaders
 		@schemes = schemes
 		@narrowers = narrowers
-		@prefLabels = prefLabels
-		self.semanticType = "http://www.w3.org/2004/02/skos/core#Concept"
-		registerSemanticProperty("http://www.w3.org/2004/02/skos/core#broader") { self.broaders }
-		registerSemanticProperty("http://www.w3.org/2004/02/skos/core#inScheme") { self.schemes }
-		registerSemanticProperty("http://www.w3.org/2004/02/skos/core#narrower") { self.narrowers }
-		registerSemanticProperty("http://www.w3.org/2004/02/skos/core#prefLabel") { self.prefLabels }
+		# Sort locale alphabetically
+		@prefLabels = prefLabels.sort.to_h
+		self.semanticType = "skos:Concept"
+		registerSemanticProperty("skos:broader", &method("broaders")).valueSetter = method("broaders=")
+		registerSemanticProperty("skos:inScheme", &method("schemes")).valueSetter = method("schemes=")
+		registerSemanticProperty("skos:narrower", &method("narrowers")).valueSetter = method("narrowers=")
+		registerSemanticProperty("skos:prefLabel", &method("prefLabels")).valueSetter = method("prefLabels=")
 	end
 	
 
-	
-	
-	
-	
-	
-	def removeBroader(broader)
-		raise "Not yet implemented."
-	end
-	
-	
-	def removeScheme(scheme)
-		raise "Not yet implemented."
-	end
-	
-	
-	def removeNarrower(narrower)
-		raise "Not yet implemented."
-	end
-	
-	
-	def removePrefLabel(prefLabel)
-		raise "Not yet implemented."
-	end
-	
 
 end

data/lib/datafoodconsortium/connector/skos_helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DataFoodConsortium::Connector::SKOSHelper
+  def addAttribute(name, value)
+    self.instance_variable_set("@#{name}", value)
+    self.define_singleton_method(name) do
+      instance_variable_get("@#{name}")
+    end
+  end
+
+  def hasAttribute(name)
+    self.methods.include?(:"#{name}")
+  end
+end

data/lib/datafoodconsortium/connector/skos_parser.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 # MIT License
-# 
+#
 # Copyright (c) 2023 Maxime Lecoq <maxime@lecoqlibre.fr>
-# 
+#
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
 # in the Software without restriction, including without limitation the rights
 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 # copies of the Software, and to permit persons to whom the Software is
 # furnished to do so, subject to the following conditions:
-# 
+#
 # The above copyright notice and this permission notice shall be included in all
 # copies or substantial portions of the Software.
-# 
+#
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -20,125 +22,145 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
+require 'datafoodconsortium/connector/skos_helper'
 require 'datafoodconsortium/connector/skos_concept'
 require 'datafoodconsortium/connector/skos_parser_element'
 
 class DataFoodConsortium::Connector::SKOSInstance
+  include DataFoodConsortium::Connector::SKOSHelper
 
-    def addAttribute(name, value)
-        self.instance_variable_set("@#{name}", value)
-        self.define_singleton_method(name) do
-            return instance_variable_get("@#{name}")
-        end
-    end
-
-    def hasAttribute(name)
-        return self.methods.include?(:"#{name}")
-    end
-    
+  # Return a list of singelton methods, ie the list of Concept available
+  def topConcepts
+    self.methods(false).sort
+  end
 end
 
 class DataFoodConsortium::Connector::SKOSParser
+  CONCEPT_SCHEMES = ["Facet", "productTypes"].freeze
+
+  def self.concepts
+    @concepts ||= {}
+  end
+
+  def initialize
+    @results = DataFoodConsortium::Connector::SKOSInstance.new
+    @skosConcepts = {}
+    @rootElements = []
+    @broaders = {}
+    # Flag used to tell the parser to use SkosConcept object when parsing data from Concept Scheme
+    # defined in CONCEPT_SCHEMES
+    @useSkosConcept = false
+  end
+
+  def parse(data)
+    init
+
+    data.each do |element|
+      current = DataFoodConsortium::Connector::SKOSParserElement.new(element)
+
+      setSkosConceptFlag(current)
+
+      if current.isConcept? || current.isCollection?
+        if !@skosConcepts.has_key?(current.id)
+          concept = createSKOSConcept(current)
+          @skosConcepts[current.id] = concept
+        end
 
-    def initialize()
-        @results = DataFoodConsortium::Connector::SKOSInstance.new
-        @skosConcepts = {}
-        @rootElements = []
-        @broaders = {}
-    end
-
-    def parse(data)
-        init()
-
-        data.each do |element|
-            current = DataFoodConsortium::Connector::SKOSParserElement.new(element)
-            
-            if (current.isConcept?() || current.isCollection?())
-                if (!@skosConcepts.has_key?(current.id))
-                    concept = createSKOSConcept(current)
-                    @skosConcepts[current.id] = concept
-                end
-                
-                if (current.hasBroader())
-                    current.broader.each do |broaderId|
-                        if (!@broaders.has_key?(broaderId))
-                            @broaders[broaderId] = []
-                        end
-
-                        @broaders[broaderId].push(current.id)
-                    end
-
-                # No broader, save the concept to the root
-                else 
-                    @rootElements.push(current.id)
-                end
+        if current.hasBroader
+          current.broader.each do |broaderId|
+            if !@broaders.has_key?(broaderId)
+              @broaders[broaderId] = []
             end
-        end
-        
-        @rootElements.each do |rootElementId|
-            setResults(@results, rootElementId)
-        end
 
-        return @results
+            @broaders[broaderId].push(current.id)
+          end
+        # No broader, save the concept to the root
+        else
+          @rootElements.push(current.id)
+        end
+      end
     end
 
-    protected
-    
-    def createSKOSConcept(element)
-        skosConcept = DataFoodConsortium::Connector::SKOSConcept.new
-        skosConcept.semanticId = element.id
-        skosConcept.semanticType = element.type
-        return skosConcept
+    @rootElements.each do |rootElementId|
+      setResults(@results, rootElementId)
     end
 
-    def getValueWithoutPrefix(property)
-        name = 'undefined'
-        
-        if (!property.include?('http') && property.include?(':'))
-            name = property.split(':')[1]
-        elsif (property.include?('#'))
-            name = property.split('#')[1]
-        end
+    @results
+  end
 
-        name = name.gsub('-', '_');
+  protected
 
-        # workaround to fix concepts starting with a number
-        # see https://github.com/datafoodconsortium/connector-ruby/issues/3
-        # see https://github.com/datafoodconsortium/ontology/issues/66
-        if (name.match?("^[0-9]"))
-            name = "_" + name
-        end
+  def createSKOSConcept(element)
+    skosConcept = DataFoodConsortium::Connector::SKOSConcept.new(
+      element.id, broaders: element.broader, narrowers: element.narrower, prefLabels: element.label
+    )
+    skosConcept.semanticType = element.type
+
+    self.class.concepts[element.id] = skosConcept
+
+    skosConcept
+  end
 
-        return name.upcase
+  def getValueWithoutPrefix(property)
+    name = 'undefined'
+
+    if !property.include?('http') && property.include?(':')
+      name = property.split(':')[1]
+    elsif property.include?('#')
+      name = property.split('#')[1]
     end
 
-    private 
-    
-    def init()
-        @results = DataFoodConsortium::Connector::SKOSInstance.new
-        @skosConcepts = {}
-        @rootElements = []
-        @broaders = {}
+    name = name.gsub('-', '_')
+
+    # workaround to fix concepts starting with a number
+    # see https://github.com/datafoodconsortium/connector-ruby/issues/3
+    # see https://github.com/datafoodconsortium/ontology/issues/66
+    name = "_" + name if name.match?("^[0-9]")
+
+    name.upcase
+  end
+
+  private
+
+  def init
+    @results = DataFoodConsortium::Connector::SKOSInstance.new
+    @skosConcepts = {}
+    @rootElements = []
+    @broaders = {}
+    @useSkosConcept = false
+  end
+
+  def setResults(parent, id)
+    name = getValueWithoutPrefix(id)
+
+    if !parent.hasAttribute(name)
+      if @useSkosConcept && @skosConcepts[id]
+        parent.addAttribute(name, @skosConcepts[id])
+      else
+        parent.addAttribute(name, DataFoodConsortium::Connector::SKOSInstance.new)
+      end
     end
 
-    def setResults(parent, id)
-        name = getValueWithoutPrefix(id)
+    # Leaf concepts, stop the process
+    if !@broaders.has_key?(id)
+      parent.instance_variable_set("@#{name}", @skosConcepts[id])
+      return
+    end
 
-        if (!parent.hasAttribute(name))
-            parent.addAttribute(name, DataFoodConsortium::Connector::SKOSInstance.new)
-        end
-        
-        # Leaf concepts, stop the process
-        if (!@broaders.has_key?(id))
-            parent.instance_variable_set("@#{name}", @skosConcepts[id])
-            return
-        end
+    @broaders[id].each do |narrower|
+      parentSkosInstance = parent.instance_variable_get("@#{name}")
 
-        @broaders[id].each do |narrower|
-            childName = getValueWithoutPrefix(narrower)
-            parentSkosInstance = parent.instance_variable_get("@#{name}")
-            setResults(parentSkosInstance, narrower) # recursive call
-        end
+      setResults(parentSkosInstance, narrower) # recursive call
     end
+  end
 
-end
+  def setSkosConceptFlag(current)
+    @useSkosConcept = true if current.isConceptScheme? && matchingConceptSchemes(current)
+  end
+
+  def matchingConceptSchemes(current)
+    regex = /#{CONCEPT_SCHEMES.join("|")}/
+
+    current.id =~ regex
+  end
+end

data/lib/datafoodconsortium/connector/skos_parser_element.rb

@@ -1,17 +1,19 @@
+# frozen_string_literal: true
+
 # MIT License
-# 
+#
 # Copyright (c) 2023 Maxime Lecoq <maxime@lecoqlibre.fr>
-# 
+#
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
 # in the Software without restriction, including without limitation the rights
 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 # copies of the Software, and to permit persons to whom the Software is
 # furnished to do so, subject to the following conditions:
-# 
+#
 # The above copyright notice and this permission notice shall be included in all
 # copies or substantial portions of the Software.
-# 
+#
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -22,57 +24,74 @@
 
 class DataFoodConsortium::Connector::SKOSParserElement
 
-    attr_reader :id
-    attr_reader :type
-    attr_reader :broader
-
-    def initialize(element)
-        @broader = []
-
-        if (element)
-            @id = element["@id"]
-
-            if (element["http://www.w3.org/1999/02/22-rdf-syntax-ns#type"])
-                @type = extractId(element["http://www.w3.org/1999/02/22-rdf-syntax-ns#type"])
-            elsif (element["@type"])
-                @type = extractId(element["@type"])
-            else 
-                @type = "undefined"
-            end
-
-            if (element["http://www.w3.org/2004/02/skos/core#broader"])
-                element["http://www.w3.org/2004/02/skos/core#broader"].each do |broader|
-                    @broader.push(broader["@id"])
-                end
-            end
-        else
-            @id = ""
-            @type = ""
+  attr_reader :id
+  attr_reader :type
+  attr_reader :broader
+  attr_reader :narrower
+  attr_reader :label
+
+  def initialize(element)
+    @broader = []
+    @narrower = []
+    @label = {}
+
+    if element
+      @id = element["@id"]
+
+      if element["http://www.w3.org/1999/02/22-rdf-syntax-ns#type"]
+        @type = extractId(element["http://www.w3.org/1999/02/22-rdf-syntax-ns#type"])
+      elsif element["@type"]
+        @type = extractId(element["@type"])
+      else
+        @type = "undefined"
+      end
+
+      if element["http://www.w3.org/2004/02/skos/core#broader"]
+        element["http://www.w3.org/2004/02/skos/core#broader"].each do |broader|
+          @broader.push(broader["@id"])
         end
-    end
-    
-    def hasBroader()
-        return @broader.count > 0
-    end
-    
-    def isConcept?()
-        return @type == "http://www.w3.org/2004/02/skos/core#Concept" || @type == "skos:Concept"
-    end
-    
-    def isCollection?()
-        return @type == "http://www.w3.org/2004/02/skos/core#Collection" || @type == "skos:Collection"
-    end
-    
-    private
-    
-    def extractId(data)
-        id = data[0]
-        
-        if (id["@id"])
-            return id["@id"]
+      end
+
+      if element["http://www.w3.org/2004/02/skos/core#narrower"]
+        element["http://www.w3.org/2004/02/skos/core#narrower"].each do |narrower|
+          @narrower.push(narrower["@id"])
         end
+      end
 
-        return id
+      if element["http://www.w3.org/2004/02/skos/core#prefLabel"]
+        element["http://www.w3.org/2004/02/skos/core#prefLabel"].each do |label|
+          @label[label["@language"].to_sym] = label["@value"]
+        end
+      end
+    else
+      @id = ""
+      @type = ""
     end
+  end
+
+  def hasBroader()
+    @broader.count > 0
+  end
+
+  def isConcept?()
+    @type == "http://www.w3.org/2004/02/skos/core#Concept" || @type == "skos:Concept"
+  end
+
+  def isCollection?()
+    @type == "http://www.w3.org/2004/02/skos/core#Collection" || @type == "skos:Collection"
+  end
+
+  def isConceptScheme?
+    @type == "http://www.w3.org/2004/02/skos/core#ConceptScheme"
+  end
+
+  private
+
+  def extractId(data)
+    id = data[0]
+
+    return id["@id"] if id["@id"]
 
-end
+    id
+  end
+end

data/lib/datafoodconsortium/connector/{certification.rb → social_media.rb}

@@ -20,15 +20,36 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-require "datafoodconsortium/connector/skos_concept"
 
 require "virtual_assembly/semantizer"
 
-class DataFoodConsortium::Connector::Certification < DataFoodConsortium::Connector::SKOSConcept
+class DataFoodConsortium::Connector::SocialMedia
+    include VirtualAssembly::Semantizer::SemanticObject
 
+    SEMANTIC_TYPE = "dfc-b:SocialMedia".freeze
+
+	# @return [String]
+	attr_accessor :name
+
+	# @return [String]
+	attr_accessor :url
+
+	# @param semanticId [String]
+	# @param name [String]
+	# @param url [String]
+	def initialize(semanticId, name: "", url: "")
+		super(semanticId)
+		@name = name
+		@url = url
+		self.semanticType = "dfc-b:SocialMedia"
+		registerSemanticProperty("dfc-b:name", &method("name")).valueSetter = method("name=")
+		registerSemanticProperty("dfc-b:URL", &method("url")).valueSetter = method("url=")
+	end
 	
 
+	
 
+	
 
 
 end