feat: JSON-LD files in zip format

.gitignore

@@ -25,7 +25,8 @@ db/schema.rb
 public/export
 public/uploads
 coverage/*
-activity-list/validated_activity_list.jsonld
 
 # Ignore application configuration
 /config/application.yml
+
+bash_history.txt

Gemfile

@@ -47,6 +47,7 @@ gem 'carrierwave'
 gem 'autoprefixer-rails', '~> 6.5.1.1'
 gem 'daemons'
 gem "octokit", "~> 4.0"
+gem 'rubyzip', '~> 2.0'
 
 # database adapters
 # comment out those you do don't need or use a different Gemfile

Gemfile.lock

@@ -344,6 +344,7 @@ GEM
     request_store (1.5.0)
       rack (>= 1.4)
     rexml (3.2.5)
+    rubyzip (2.3.2)
     sass (3.7.4)
       sass-listen (~> 4.0.0)
     sass-listen (4.0.0)
@@ -470,6 +471,7 @@ DEPENDENCIES
   rails_12factor
   rails_autolink
   rdf-vocab
+  rubyzip (~> 2.0)
   sass-rails (~> 5.0.0)
   simplecov
   sqlite3 (~> 1.3.0)

README.md

@@ -1,8 +1,8 @@
-# Activity List Editor 
+# SKOS Vocabulary Editor 
 
 ## Coding framework: iQvoc
 
-The Activity List Editor is a fork of iQvoc, a vocabulary management tool that combines easy-to-use human interfaces
+The OpenActive SKOS Vocabulary Editor is a fork of iQvoc, a vocabulary management tool that combines easy-to-use human interfaces
 with Semantic Web interoperability. For more information about iQvoc, including setup and configuration, please see the [iQvoc GitHub repository](https://github.com/innoq/iqvoc).
 
 ## Using the Editor

app.json

@@ -24,8 +24,10 @@
     "VOCAB_HELP_URL": "https://developer.openactive.io/publishing-data/activity-list-references",
     "VOCAB_IDENTIFIER": "activity-list",
     "VOCAB_PROPERTY": "activity",
+    "VOCAB_DRAFT": "false",
+    "VOCAB_EXPORT_RELATED_MATCHES": "facility-types:facilityType;activity-list:activity",
     "VOCAB_NAME": "Activity List",
-    "VOCAB_SUGGESTIONS_FORM": "https://docs.google.com/forms/d/e/1FAIpQLSfaKgMC-dySy8G7Lvv_9Uh-o48Db37B3BwHSHANyPlEpiEmFA/viewform",
+    "VOCAB_SUGGESTIONS_LINK": "https://docs.google.com/forms/d/e/1FAIpQLSfaKgMC-dySy8G7Lvv_9Uh-o48Db37B3BwHSHANyPlEpiEmFA/viewform",
     "VOCAB_WORKFLOW_GH_ACCESS_TOKEN": {
       "required": true
     },

app/controllers/concepts/openactive_controller.rb

@@ -14,6 +14,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'zip'
+
 #Derived from hierarchy_controller.rb
 class Concepts::OpenactiveController < ConceptsController
 
@@ -37,114 +39,181 @@ def index
     #        Iqvoc::Concept.base_class.default_includes + [])
 
     @concepts.to_a.sort_by! {|c| c.pref_label }
-
+        
     respond_to do |format|
-      format.jsonld do
+      format.zip do
+        # Create in-memory zip file
+        buffer = Zip::OutputStream.write_buffer do |zip|
+          # Adding <skos-vocabulary-identifier>.jsonld to the ZIP
+          concepts_json = generate_concepts_json(@concepts) # This method encapsulates the JSON generation logic
+          zip.put_next_entry("#{ENV['VOCAB_IDENTIFIER']}.jsonld")
+          zip.write(concepts_json)
+
+          # Generate and add collections JSON files
+          @collections.select { |c| can? :read, c }.each do |collection|
+            collection_json = generate_collection_json(collection) # This method encapsulates the JSON generation logic
+            zip.put_next_entry("collections/#{collection.origin[1..-1]}.jsonld")
+            zip.write(collection_json)
+          end
+        end
 
-        # Create main unvalidated_activity_list.jsonld file (which is then validated by CI within the activity-list repo)
+        # Rewind the buffer to allow for reading
+        buffer.rewind
 
-        concepts = @concepts.select { |c| can? :read, c }.map do |c|
-          url = "https://openactive.io/activity-list##{c.origin[1..-1]}"
-    #      definition = c.notes_for_class(Note::SKOS::Definition).empty? ? "" : c.notes_for_class(Note::SKOS::Definition).first.value
-          broader = []
-          c.broader_relations.each do |rel|
-            broader << "https://openactive.io/activity-list##{rel.target.origin[1..-1]}"
-          end
-          narrower = []
-          c.narrower_relations.each do |rel|
-            narrower << "https://openactive.io/activity-list##{rel.target.origin[1..-1]}"
-          end
-          klass = Iqvoc::Concept.further_relation_classes.first # XXX: arbitrary; bad heuristic?
-          only_published = params[:published] != "0"
-          related = []
-          c.related_concepts_for_relation_class(klass, only_published).each do |related_concept|
-            related << "https://openactive.io/activity-list##{related_concept.origin[1..-1]}"
-          end
-          concept = {
-              id: url,
-              identifier: c.origin[1..-1],
-              type: "Concept",
-              prefLabel: c.pref_label.to_s
-          }
-          concept[:broader] = broader if broader.any?
-          concept[:narrower] = narrower if narrower.any?
-          concept[:related] = related if related.any?
-          c.notes_for_class(Note::SKOS::Definition).each do |n|
-            concept[:definition] = n.value
-          end
-          c.notations.each do |n|
-            concept[:notation] = n.value
-          end
+        # Send the data to the client as a file download
+        send_data(buffer.read, filename: "#{ENV['VOCAB_IDENTIFIER']}.zip", type: 'application/zip')
+      end
+    end
+  end
 
-          concept[:topConceptOf] = "https://openactive.io/activity-list" if c.top_term?
-          c.alt_labels.each do |l|
-            concept[:altLabel] ||= []
-            concept[:altLabel] << l.value
-          end
-          concept
+  def confirm_export
+    # This action will render a view asking for confirmation
+  end
+
+  def trigger_export
+    if params[:confirm] == 'yes'
+      client = Octokit::Client.new(:login => ENV['VOCAB_WORKFLOW_GH_UID'], :password => ENV['VOCAB_WORKFLOW_GH_ACCESS_TOKEN'])
+      repo = "openactive/#{ENV['VOCAB_IDENTIFIER']}"
+      workflow_id = 'create-and-merge-pr.yaml'
+      ref = 'main'
+
+      release_timestamp = params[:release_timestamp]
+
+      # Check if the chosen release date/time is today
+      if release_timestamp.present?  
+        if Date.parse(release_timestamp) == Date.today
+          release_timestamp = ''
+        else
+          release_timestamp = DateTime.parse(release_timestamp).strftime("%Y-%m-%d_%H-%M-%S")
         end
-        raw_hash = {
-            "@context": "https://openactive.io/",
-            id: "https://openactive.io/activity-list",
-            title: "OpenActive Activity List",
-            description: "This document describes the OpenActive standard activity list.",
-            type: "ConceptScheme",
-            license: "https://creativecommons.org/licenses/by/4.0/",
-            concept: concepts
+      end
+
+      options = {
+        'inputs' => {
+          'publisher' => current_user.name,
+          'timestamp' => release_timestamp || ''
         }
-        render json: raw_hash
-        pretty_json = JSON.pretty_generate(raw_hash)
-
-        client = Octokit::Client.new(:login => ENV["GIT_UID"], :password => ENV["GIT_PSW"])
-        orig_file = client.contents("openactive/activity-list", :path => 'unvalidated_activity_list.jsonld')
-        sha = orig_file[:sha]
-        client.create_contents("openactive/activity-list",
-                 "unvalidated_activity_list.jsonld",
-                 "Adding unvalidated content",
-                 pretty_json,
-                 :branch => "master",
-                 :sha => sha
-                 )
-
-        # Create collections jsonld files (which are not validated)
-
-        collections = @collections.select { |c| can? :read, c }.each do |c|
-          collectionname = c.origin[1..-1]
-          filename = "collections/#{collectionname}.jsonld"
-          url = "https://openactive.io/activity-list/#{filename}"
-          members = []
-          c.concepts.each do |rel|
-            members << "https://openactive.io/activity-list##{rel.origin[1..-1]}"
-          end
-          collection = {
-              "@context": "https://openactive.io/",
-              "@type": "ConceptCollection",
-              "@id": url,
-              prefLabel: c.pref_label.to_s,
-              inScheme: "https://openactive.io/activity-list",
-              license: "https://creativecommons.org/licenses/by/4.0/"
-          }
-          c.alt_labels.each do |l|
-            collection[:altLabel] ||= []
-            collection[:altLabel] << l.value
-          end
-          c.notes_for_class(Note::SKOS::Definition).each do |n|
-            collection[:definition] = n.value
+      }
+
+      client.workflow_dispatch(repo, workflow_id, ref, options)
+    else
+      redirect_to confirm_export_path
+    end
+
+  end
+
+  private
+
+  # Define the methods to generate JSON for concepts and collections
+  def generate_concepts_json(input_concepts)
+    concepts = input_concepts.select { |c| can? :read, c }.map do |c|
+      url = "https://openactive.io/#{ENV['VOCAB_IDENTIFIER']}##{c.origin[1..-1]}"
+#      definition = c.notes_for_class(Note::SKOS::Definition).empty? ? "" : c.notes_for_class(Note::SKOS::Definition).first.value
+      broader = []
+      c.broader_relations.each do |rel|
+        broader << "https://openactive.io/#{ENV['VOCAB_IDENTIFIER']}##{rel.target.origin[1..-1]}"
+      end
+      narrower = []
+      c.narrower_relations.each do |rel|
+        narrower << "https://openactive.io/#{ENV['VOCAB_IDENTIFIER']}##{rel.target.origin[1..-1]}"
+      end
+      related = []
+      c.related_concepts_for_relation_class(Concept::Relation::SKOS::Related).each do |related_concept|
+        related << "https://openactive.io/#{ENV['VOCAB_IDENTIFIER']}##{related_concept.origin[1..-1]}"
+      end
+
+      # Parse the VOCAB_EXPORT_RELATED_MATCHES environment variable (e.g. "facility-types:facilityType;activity-list:activity")
+      export_related_matches = ENV['VOCAB_EXPORT_RELATED_MATCHES']
+      match_mappings = {}
+      if export_related_matches
+        export_related_matches.split(';').each do |mapping|
+          vocab_identifier, property = mapping.split(':')
+          match_mappings[vocab_identifier] = property.to_sym
+        end
+      end
+
+      # Hashmap to collect matches for each property
+      matches = []
+      additional_match_properties = Hash.new { |hash, key| hash[key] = [] }
+
+      matches = []
+      c.matches_for_class(Match::SKOS::RelatedMatch).each do |match|
+        # Transform format from e.g. https://facility-types.openactive.io/_93927309-8e8a-460d-9a55-2a9a4844a7c0 to https://openactive.io/facility-types#93927309-8e8a-460d-9a55-2a9a4844a7c0
+        if match.value =~ %r{https://([^.]+)\.openactive\.io/_([0-9a-f-]+)$}
+          match_vocab_identifier = $1
+          match_id = $2
+          if match_mappings.key?(match_vocab_identifier)
+            additional_match_properties[match_mappings[match_vocab_identifier]] << "https://openactive.io/#{match_vocab_identifier}##{match_id}"
           end
-          collection[:member] = members if members.any?
-          collection_pretty_json = JSON.pretty_generate(collection)
-
-          orig_file = client.contents("openactive/activity-list", :path => filename)
-          sha = orig_file[:sha]
-          client.create_contents("openactive/activity-list",
-                   filename,
-                   "Updating collection #{collectionname}",
-                   collection_pretty_json,
-                   :branch => "master",
-                   :sha => sha
-                   )
         end
       end
+
+      concept = {
+          id: url,
+          identifier: c.origin[1..-1],
+          type: "Concept",
+          prefLabel: c.pref_label.to_s
+      }
+      concept[:broader] = broader if broader.any?
+      concept[:narrower] = narrower if narrower.any?
+      concept[:related] = related if related.any?
+
+      # Add additional properties based on matches
+      additional_match_properties.each do |property, urls|
+        concept[property] = urls if urls.any?
+      end
+
+      c.notes_for_class(Note::SKOS::Definition).each do |n|
+        concept[:definition] = n.value
+      end
+      c.notations.each do |n|
+        concept[:notation] = n.value
+      end
+
+      concept[:topConceptOf] = "https://openactive.io/#{ENV['VOCAB_IDENTIFIER']}" if c.top_term?
+      c.alt_labels.each do |l|
+        concept[:altLabel] ||= []
+        concept[:altLabel] << l.value
+      end
+      concept
+    end
+    raw_hash = {
+        "@context": "https://openactive.io/",
+        id: "https://openactive.io/#{ENV['VOCAB_IDENTIFIER']}",
+        title: "OpenActive #{ENV['VOCAB_NAME']}",
+        description: "#{ENV['VOCAB_DESCRIPTION']}",
+        type: "ConceptScheme",
+        license: "https://creativecommons.org/licenses/by/4.0/",
+        concept: concepts
+    }
+    JSON.pretty_generate(raw_hash)
+  end
+
+  def generate_collection_json(c)
+    collectionname = c.origin[1..-1]
+    filename = "collections/#{collectionname}.jsonld"
+    url = "https://openactive.io/#{ENV['VOCAB_IDENTIFIER']}/#{filename}"
+    members = []
+    c.concepts.each do |rel|
+      members << "https://openactive.io/#{ENV['VOCAB_IDENTIFIER']}##{rel.origin[1..-1]}"
+    end
+    collection = {
+        "@context": "https://openactive.io/",
+        "@type": "ConceptCollection",
+        "@id": url,
+        prefLabel: c.pref_label.to_s,
+        inScheme: "https://openactive.io/#{ENV['VOCAB_IDENTIFIER']}",
+        license: "https://creativecommons.org/licenses/by/4.0/"
+    }
+    c.alt_labels.each do |l|
+      collection[:altLabel] ||= []
+      collection[:altLabel] << l.value
+    end
+    c.notes_for_class(Note::SKOS::Definition).each do |n|
+      collection[:definition] = n.value
     end
+    collection[:member] = members if members.any?
+
+    JSON.pretty_generate(collection)
   end
 end

app/controllers/pages_controller.rb

@@ -32,10 +32,6 @@ def version
   def intro
   end
 
-  def changelog
-#    authorize! :read, :version
-  end
-
   def instructions
 #    authorize! :read, :version
   end

app/helpers/link_helper.rb

@@ -11,4 +11,23 @@ def link_to_object(object, name, html_options = nil, &block)
 
     link_to name, path, html_options, &block
   end
+
+  def render_skos_id(url)
+    if url =~ %r{^https://([^.]+)\.openactive\.io/_([0-9a-f-]+)$}
+      vocab_identifier = $1
+      id = $2
+      "https://openactive.io/#{vocab_identifier}##{id}"
+    else
+      url
+    end
+  end
+
+  def render_property_url(property_name)
+    if property_name =~ %r{^beta:(.+)$}
+      property = $1
+      "https://openactive.io/ns-beta/#" + property
+    else
+      property_name
+    end
+  end
 end