ftr_ruby 0.1.9 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fad967881ddfedcde26bbeb0866164d3648ddb01f79f5deb7ab011fc5d12ffb
-  data.tar.gz: d8a29cba7c2b4eff908fdf878826c31a54f73c6375a8561d3074906ddd8efa46
+  metadata.gz: be4cb2cd61574feb95c0359b6d3c1534ae2bd13090c9cc77c874e7efeda209f2
+  data.tar.gz: 1b20953f8acffa00d4ef3b6af4658a5eb05e657728f3c55bdf7230311ecccd9d
 SHA512:
-  metadata.gz: 7e28a1b1e8c3a4b66e2a263e8111747bd42c739fb3169f754d07de3e51ca5d3bbf01bcc264e9d10331584525014d1b2cfd41a1f4d231432ddc5cd7f692e6f3bd
-  data.tar.gz: c0ba5c7ee46a2355008283e977f2284103cd25ccda4feb6d0bf0117b8489d5bcb7d32d6337be30d8530a9622a628ec1962d9a919e7c78f16ecd3690c6a7abb46
+  metadata.gz: '0983e92af3a5199f1ba54a9023edb50bacbde94cb46805ae1c913a9110beabdc2c9da6d2a2968677b506f2cde1c7c41171f9143b1689fa3222c4b43f70f6d932'
+  data.tar.gz: 3f2853d3956422992ca5d640c92113b34eb0336633724e039f2f70689d79758a32f5e46e7841ee6ee7ba12e14b6f74ebcb9ce34ed08f7687fee1b14ff75e07a5

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## [Unreleased]
 
+## [0.1.11] - 2026-05-26
+
+### Changed
+- `TestInfra#get_tests_metrics` now fetches all test metrics in parallel using Ruby threads, significantly reducing latency when querying 40+ tests
+- Refactored `TestInfra` internals into focused private helpers (`fetch_metric`, `fetch_metric_url`, `load_metric_graph`, `query_metric_graph`)
+- `test_infrastructure.rb` now explicitly requires `jsonpath` rather than relying on transitive loading
+
+### Added
+- RSpec tests for `TestInfra#get_tests_metrics` and `#fetch_metric_url` covering happy path, missing metadata, RDF load failures, and empty input
+
 ## [0.1.0] - 2026-03-28
 
 - Initial release

data/lib/ftr_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FtrRuby
-  VERSION = "0.1.9"
+  VERSION = "0.1.11"
 end

data/lib/openapi.rb

@@ -1,10 +1,26 @@
 module FtrRuby
+  # Generates a valid OpenAPI 3.0 YAML document describing a single FAIR test endpoint.
+  #
+  # The document is built from metadata supplied by the test author (title, description,
+  # contact info, etc.) and is served as a machine-readable API specification that client
+  # UIs fetch to dynamically build submission forms.
+  #
+  # Key concern: author-supplied text (especially +description+) may contain arbitrary
+  # Markdown, including blank lines and heading markers (##).  YAML block scalars require
+  # every continuation line to be indented at least as deeply as the first content line;
+  # raw multi-line strings break this rule.  All free-text fields are therefore passed
+  # through +yaml_block_indent+ before interpolation.
   class OpenAPI
     attr_accessor :title, :metric, :description, :indicator, :testid,
                   :organization, :org_url, :version, :creator,
                   :responsible_developer, :email, :developer_ORCiD, :protocol,
                   :host, :basePath, :path, :response_description, :schemas, :endpointpath
 
+    # Initialises the OpenAPI document from a metadata hash.
+    #
+    # @param meta [Hash] keys: :testid, :testname, :testversion, :metric, :description,
+    #   :indicators, :organization, :org_url, :responsible_developer, :email, :creator,
+    #   :host, :protocol, :basePath, :response_description, :schemas
     def initialize(meta:)
       indics = [meta[:indicators]] unless meta[:indicators].is_a? Array
       @testid = meta[:testid]
@@ -30,7 +46,14 @@ module FtrRuby
       # @end_url = "#{protocol}://#{host}#{basePath}/#{endpointpath}/#{testid}" # basepath starts with /
     end
 
+    # Returns the complete OpenAPI 3.0 YAML document as a String.
+    #
+    # Free-text fields that may contain Markdown (description, response_description) are
+    # pre-processed with +yaml_block_indent+ so that embedded newlines do not escape the
+    # YAML block scalar — see that method for details.
     def get_api
+      safe_desc = yaml_block_indent(description, 4)
+      safe_resp = yaml_block_indent(response_description, 12)
       <<~"EOF_EOF"
 
         openapi: 3.0.0
@@ -39,7 +62,7 @@ module FtrRuby
           title: "#{title}"
           x-tests_metric: "#{metric}"
           description: >-
-            #{description}
+            #{safe_desc}
           x-applies_to_principle: "#{indicator}"
           contact:
             x-organization: "#{organization}"
@@ -60,7 +83,7 @@ module FtrRuby
               responses:
                 "200":
                   description:  >-
-                    #{response_description}
+                    #{safe_resp}
         servers:
           - url: "#{protocol}://#{host}#{basePath}/#{endpointpath}"
         components:
@@ -75,5 +98,29 @@ module FtrRuby
 
       EOF_EOF
     end
+
+    private
+
+    # Ensures a multi-line string is safe for use inside a YAML block scalar (>- or |).
+    #
+    # YAML block scalars determine their indentation level from the first content line.
+    # Any subsequent line that is indented less than that level terminates the scalar,
+    # which causes parse errors when the text contains blank lines followed by
+    # unindented content (a common pattern in Markdown).
+    #
+    # This method leaves the first line untouched (the heredoc template already places
+    # it at the correct column) and prepends +spaces+ spaces to every non-empty
+    # continuation line so they remain inside the block scalar.  Blank lines are left
+    # blank intentionally — YAML allows empty lines within a block scalar without
+    # requiring indentation.
+    #
+    # @param text   [String]  the raw author-supplied text
+    # @param spaces [Integer] number of spaces matching the block scalar's indentation
+    #   in the rendered YAML (4 for +description+, 12 for +response_description+)
+    # @return [String]
+    def yaml_block_indent(text, spaces)
+      indent = " " * spaces
+      text.split("\n").map.with_index { |line, i| i.zero? || line.empty? ? line : "#{indent}#{line}" }.join("\n")
+    end
   end
 end

data/lib/test_infrastructure.rb

@@ -1,3 +1,5 @@
+require "jsonpath"
+
 module FtrRuby
   class TestInfra
     attr_accessor :test_protocol, :test_host, :basepath
@@ -8,46 +10,57 @@ module FtrRuby
       @basepath = basepath
     end
 
-    # there is a need to map between a test and its registered Metric in FS.  This will return the label for the test
-    # in principle, we cojuld return a more complex object, but all I need now is the label
+    # there is a need to map between a test and its registered Metric in FS.
+    # This will return the label for the test
+    # in principle, we cojuld return a more complex object,
+    # but all I need now is the label
     def get_tests_metrics(tests:)
+      threads = tests.map { |testid| Thread.new(testid) { |tid| fetch_metric(tid) } }
+
       labels = {}
       landingpages = {}
-      tests.each do |testid|
-        warn "getting dcat for #{testid}    #{test_protocol}://#{test_host}/#{basepath}/#{testid}"
-        dcat = RestClient::Request.execute({
-                                             method: :get,
-                                             url: "#{test_protocol}://#{test_host}/#{basepath}/#{testid}",
-                                             headers: { "Accept" => "application/json" }
-                                           }).body
-        parseddcat = JSON.parse(dcat)
-        # this next line should probably be done with SPARQL
-        # # TODO TODO TODO
-        jpath = JsonPath.new('[0]["http://semanticscience.org/resource/SIO_000233"][0]["@id"]') # is implementation of
-        metricurl = jpath.on(parseddcat).first
-
-        begin
-          g = RDF::Graph.load(metricurl, format: :turtle)
-        rescue StandardError => e
-          warn "DCAT Metric loading failed #{e.inspect}"
-          g = RDF::Graph.new
-        end
-
-        title = g.query([nil, RDF::Vocab::DC.title, nil])&.first&.object&.to_s
-        lp = g.query([nil, RDF::Vocab::DCAT.landingPage, nil])&.first&.object&.to_s
-
-        labels[testid] = if title != ""
-                           title
-                         else
-                           "Metric label not available"
-                         end
-        landingpages[testid] = if lp != ""
-                                 lp
-                               else
-                                 ""
-                               end
+      threads.each do |t|
+        tid, label, lpage = t.value
+        labels[tid] = label
+        landingpages[tid] = lpage
       end
       [labels, landingpages]
     end
+
+    private
+
+    def fetch_metric(testid)
+      metricurl = fetch_metric_url(testid)
+      g = load_metric_graph(metricurl)
+      title, lp = query_metric_graph(g)
+      label = title.to_s != "" ? title : "Metric label not available"
+      [testid, label, lp.to_s]
+    end
+
+    def fetch_metric_url(testid)
+      warn "getting dcat for #{testid}    #{test_protocol}://#{test_host}/#{basepath}/#{testid}"
+      dcat = RestClient::Request.execute({
+                                           method: :get,
+                                           url: "#{test_protocol}://#{test_host}/#{basepath}/#{testid}",
+                                           headers: { "Accept" => "application/json" }
+                                         }).body
+      parseddcat = JSON.parse(dcat)
+      # TODO: this should probably be done with SPARQL
+      jpath = JsonPath.new('[0]["http://semanticscience.org/resource/SIO_000233"][0]["@id"]') # is implementation of
+      jpath.on(parseddcat).first
+    end
+
+    def load_metric_graph(metricurl)
+      RDF::Graph.load(metricurl, format: :turtle)
+    rescue StandardError => e
+      warn "DCAT Metric loading failed #{e.inspect}"
+      RDF::Graph.new
+    end
+
+    def query_metric_graph(graph)
+      title = graph.query([nil, RDF::Vocab::DC.title, nil])&.first&.object&.to_s
+      lp = graph.query([nil, RDF::Vocab::DCAT.landingPage, nil])&.first&.object&.to_s
+      [title, lp]
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ftr_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.11
 platform: ruby
 authors:
 - markwilkinson