datafoodconsortium-connector 1.0.0.pre.alpha

data/lib/datafoodconsortium/connector/skos_concept.rb

@@ -0,0 +1,85 @@
+# 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::SKOSConcept
+
+	include VirtualAssembly::Semantizer::SemanticObject
+
+	attr_accessor :broaders
+	attr_accessor :schemes
+	attr_accessor :narrowers
+	attr_accessor :prefLabels
+
+	def initialize()
+		super()
+		self.semanticType = "http://www.w3.org/2004/02/skos/core#Concept"
+		
+		self.broaders = []
+		self.schemes = []
+		self.narrowers = []
+		self.prefLabels = []
+		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 }
+	end
+	
+
+	def addBroader(broader)
+		self.broaders.push(broader)
+	end
+	
+	def addScheme(scheme)
+		self.schemes.push(scheme)
+	end
+	
+	def addNarrower(narrower)
+		self.narrowers.push(narrower)
+	end
+	
+	def addPrefLabel(prefLabel)
+		self.prefLabels.push(prefLabel)
+	end
+	
+	def removeBroader(broader)
+		raise "Not implemented"
+	end
+	
+	def removeScheme(scheme)
+		raise "Not implemented"
+	end
+	
+	def removeNarrower(narrower)
+		raise "Not implemented"
+	end
+	
+	def removePrefLabel(prefLabel)
+		raise "Not implemented"
+	end
+	
+
+end

data/lib/datafoodconsortium/connector/skos_parser.rb

@@ -0,0 +1,133 @@
+# 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 'datafoodconsortium/connector/skos_concept'
+require 'datafoodconsortium/connector/skos_parser_element'
+
+class DataFoodConsortium::Connector::SKOSInstance
+
+    def addAttribute(name, value)
+        instance_variable_set("@#{name}", value)
+        self.class.send(:attr_reader, name)
+    end
+
+    def hasAttribute(name)
+        return self.methods.include?(:"#{name}")
+    end
+    
+end
+
+class DataFoodConsortium::Connector::SKOSParser
+
+    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
+            end
+        end
+        
+        @rootElements.each do |rootElementId|
+            setResults(@results, rootElementId)
+        end
+
+        return @results
+    end
+
+    protected
+    
+    def createSKOSConcept(element)
+        skosConcept = DataFoodConsortium::Connector::SKOSConcept.new
+        skosConcept.semanticId = element.id
+        skosConcept.semanticType = element.type
+        return skosConcept
+    end
+
+    def getValueWithoutPrefix(property)
+        name = 'undefined'
+        
+        if (!property.include?('http') && property.include?(':'))
+            name = property.split(':')[1]
+        elsif (property.include?('#'))
+            name = property.split('#')[1]
+        end
+
+        return name.gsub('-', '_').upcase
+    end
+
+    private 
+    
+    def init()
+        @results = DataFoodConsortium::Connector::SKOSInstance.new
+        @skosConcepts = {}
+        @rootElements = []
+        @broaders = {}
+    end
+
+    def setResults(parent, id)
+        name = getValueWithoutPrefix(id)
+
+        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|
+            childName = getValueWithoutPrefix(narrower)
+            parentSkosInstance = parent.instance_variable_get("@#{name}")
+            setResults(parentSkosInstance, narrower) # recursive call
+        end
+    end
+
+end

data/lib/datafoodconsortium/connector/skos_parser_element.rb

@@ -0,0 +1,78 @@
+# 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.
+
+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 = ""
+        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
+
+        return id
+    end
+
+end

data/lib/datafoodconsortium/connector/supplied_product.rb

@@ -0,0 +1,41 @@
+# 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 "datafoodconsortium/connector/defined_product"
+require "virtual_assembly/semantizer"
+
+class DataFoodConsortium::Connector::SuppliedProduct < DataFoodConsortium::Connector::DefinedProduct
+
+	
+
+
+	def initialize(name, description)
+		super(name, description)
+		self.semanticType = "http://static.datafoodconsortium.org/ontologies/DFC_BusinessOntology.owl#SuppliedProduct"
+		
+		
+		
+	end
+	
+
+
+end

data/lib/datafoodconsortium/connector/unit.rb

@@ -0,0 +1,34 @@
+# 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 "datafoodconsortium/connector/skos_concept"
+
+require "virtual_assembly/semantizer"
+
+class DataFoodConsortium::Connector::Unit < DataFoodConsortium::Connector::SKOSConcept
+
+	
+
+
+
+
+end

data/lib/datafoodconsortium/connector.rb

@@ -0,0 +1,34 @@
+module DataFoodConsortium
+	module Connector
+		require 'datafoodconsortium/connector/connector'
+		require 'datafoodconsortium/connector/json_ld_serializer'
+		require 'datafoodconsortium/connector/skos_parser_element'
+		require 'datafoodconsortium/connector/skos_parser'
+		require 'datafoodconsortium/connector/agent.rb'
+		require 'datafoodconsortium/connector/enterprise.rb'
+		require 'datafoodconsortium/connector/customer_category.rb'
+		require 'datafoodconsortium/connector/person.rb'
+		require 'datafoodconsortium/connector/repository.rb'
+		require 'datafoodconsortium/connector/catalog_item.rb'
+		require 'datafoodconsortium/connector/order.rb'
+		require 'datafoodconsortium/connector/offer.rb'
+		require 'datafoodconsortium/connector/order_line.rb'
+		require 'datafoodconsortium/connector/address.rb'
+		require 'datafoodconsortium/connector/geographical_origin.rb'
+		require 'datafoodconsortium/connector/physical_characteristic.rb'
+		require 'datafoodconsortium/connector/allergen_dimension.rb'
+		require 'datafoodconsortium/connector/allergen_characteristic.rb'
+		require 'datafoodconsortium/connector/nutrient_characteristic.rb'
+		require 'datafoodconsortium/connector/characteristic.rb'
+		require 'datafoodconsortium/connector/product_type.rb'
+		require 'datafoodconsortium/connector/part_origin.rb'
+		require 'datafoodconsortium/connector/quantitative_value.rb'
+		require 'datafoodconsortium/connector/unit.rb'
+		require 'datafoodconsortium/connector/certification.rb'
+		require 'datafoodconsortium/connector/characteristic_dimension.rb'
+		require 'datafoodconsortium/connector/nature_origin.rb'
+		require 'datafoodconsortium/connector/defined_product.rb'
+		require 'datafoodconsortium/connector/supplied_product.rb'
+		require 'datafoodconsortium/connector/skos_concept.rb'
+	end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: datafoodconsortium-connector
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.alpha
+platform: ruby
+authors:
+- Maxime Lecoq
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-12 00:00:00.000000000 Z
+dependencies: []
+description: A library to easily integrate the DFC standard within your application.
+email: maxime@lecoqlibre.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/datafoodconsortium/connector.rb
+- lib/datafoodconsortium/connector/address.rb
+- lib/datafoodconsortium/connector/agent.rb
+- lib/datafoodconsortium/connector/allergen_characteristic.rb
+- lib/datafoodconsortium/connector/allergen_dimension.rb
+- lib/datafoodconsortium/connector/catalog_item.rb
+- lib/datafoodconsortium/connector/certification.rb
+- lib/datafoodconsortium/connector/characteristic.rb
+- lib/datafoodconsortium/connector/characteristic_dimension.rb
+- lib/datafoodconsortium/connector/connector.rb
+- lib/datafoodconsortium/connector/customer_category.rb
+- lib/datafoodconsortium/connector/defined_product.rb
+- lib/datafoodconsortium/connector/enterprise.rb
+- lib/datafoodconsortium/connector/geographical_origin.rb
+- lib/datafoodconsortium/connector/json_ld_serializer.rb
+- lib/datafoodconsortium/connector/nature_origin.rb
+- lib/datafoodconsortium/connector/nutrient_characteristic.rb
+- lib/datafoodconsortium/connector/offer.rb
+- lib/datafoodconsortium/connector/order.rb
+- lib/datafoodconsortium/connector/order_line.rb
+- lib/datafoodconsortium/connector/part_origin.rb
+- lib/datafoodconsortium/connector/person.rb
+- lib/datafoodconsortium/connector/physical_characteristic.rb
+- lib/datafoodconsortium/connector/product_type.rb
+- lib/datafoodconsortium/connector/quantitative_value.rb
+- lib/datafoodconsortium/connector/repository.rb
+- lib/datafoodconsortium/connector/skos_concept.rb
+- lib/datafoodconsortium/connector/skos_parser.rb
+- lib/datafoodconsortium/connector/skos_parser_element.rb
+- lib/datafoodconsortium/connector/supplied_product.rb
+- lib/datafoodconsortium/connector/unit.rb
+homepage: https://github.com/datafoodconsortium/connector-ruby/
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.3.25
+signing_key:
+specification_version: 4
+summary: Data Food Consortium connector
+test_files: []