geolexica-server 0.0.1.pre.beta.pre.32

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8361c5a39bae869d9c8983ea30621417cd4119c3b3ca4e6330ce58af407e6d7a
+  data.tar.gz: 8a997a1d670649b7f65b440ab095d603219edeb7540d56a87a1df8d589f1f19a
+SHA512:
+  metadata.gz: '04395338ba83b2ebf09e697247dc23372c40e3bd6f666b257756cbf870a60a8681e02869e51e1571235374982f901e45a96cea30599923db41a8f1b806125bac'
+  data.tar.gz: 7da8a18d04ce08c9843d1e0200acf2be42028ce2663e55b482f74a66d537c1ba5fe3790fc8703245da02c4ce079829b1cb617a622132e70d124faf40ca445dbf

data/Gemfile

@@ -0,0 +1,6 @@
+# (c) Copyright 2020 Ribose Inc.
+#
+
+source "https://rubygems.org"
+
+gemspec

data/README.adoc

@@ -0,0 +1,102 @@
+= ISO/TC 211 Geolexica Terminology Database
+
+image:https://github.com/ISO-TC211/geolexica.org/workflows/build/badge.svg["Build Status", link="https://github.com/ISO-TC211/geolexica.org/actions?workflow=build"]
+
+image:https://github.com/ISO-TC211/geolexica.org/workflows/deploy-master/badge.svg["Build Status", link="https://github.com/ISO-TC211/geolexica.org/actions?workflow=deploy-master"]
+
+image:https://github.com/ISO-TC211/geolexica.org/workflows/deploy-staging/badge.svg["Build Status", link="https://github.com/ISO-TC211/geolexica.org/actions?workflow=deploy-staging"]
+
+
+== Introduction
+
+Geolexica is the site name of the online version of the ISO/TC 211 Multi Lingual Glossary of Terms.
+
+This repository contains the source of the https://www.geolexica.org site.
+
+The site is managed by the ISO/TC 211 TMG together with Ribose.
+
+NOTE: This repository is only meant for internal consumption!
+
+
+== How to add/remove entries or suggest changes?
+
+For change suggestions, contact ISO/TC 211 TMG.
+
+This terminology database is managed by the ISO/TC 211 TMG, and it only considers
+requests from within ISO/TC 211. The database is not directly community-managed or community-sourced.
+
+
+== ISO/TC 211 MLGT component overview
+
+Components involved in ISO/TC 211 MLGT solution:
+
+. Geolexica.org: **this repository**.
+  Renders Geolexica database into HTML, JSON-LD and other Web-friendly formats.
+
+. Geolexica database:
+  see https://github.com/geolexica/geolexica-database[geolexica/geolexica-database].
+  Hosts all concept data in YAML;
+  bundles facilities for converting authoritative spreadsheet data into YAML.
+  Candidate to become authoritative source, contingent upon factual usage of Glossarist by TMG.
+
+. Manually managed XLST spreadsheets (1.0 workflow):
+  see https://github.com/ISO-TC211/mlgt-data[ISO-TC211/mlgt-data].
+  Currently the authoritative source in 1.0 workflow.
+  Will be phased out in favor of Geolexica database in 2.0.
+
+. Glossarist desktop application (2.0 workflow):
+  see https://github.com/geolexica/geolexica-desktop[geolexica/geolexica-desktop].
+  Will be used to manage the Geolexica database in 2.0 workflow.
+
+
+=== Change lifecycle (1.0, current)
+
+. Requested changes are directed to ISO/TC 211 TMG.
+
+. When a change is approved, TMG publishes a new version of ISO/TC 211 "`Multi-Lingual Glossary of Terms`".
+
+. TMG uploads the new MLGT version to mlgt-data repository.
+
+. From the updated mlgt-data, a new snapshot of the database is created in geolexica-database repository.
+
+. After new snapshot of the database is committed to geolexica-database,
+  ISO/TC 211’s Geolexica.org is deployed with the latest database version.
+
+
+=== Change lifecycle (2.0, near future)
+
+. Requested changes are directed to ISO/TC 211 TMG.
+
+. Adding, updating, approving concepts & terms in ISO/TC 211 Geolexica database
+  is done by TMG using the desktop application under development.
+
+. As changes are made, new versions of Geolexica database are created,
+  and ISO/TC 211’s Geolexica.org is deployed with the latest database version.
+
+
+== Internal operations
+
+NOTE: These steps are only intended for the internal operator of the site!
+
+
+=== Building the site
+
+. Ensure geolexica-database submodule is up-to-date.
+
+. Run ``make _site``
+
+
+=== Deployment
+
+Please push all changes to the `staging` branch, and changes will be automatically deployed and reflected on the staging site.
+
+If your changes are to be made public to the production site, please contact Ribose.
+
+
+=== Rendering of HTML
+
+Jekyll is used to render YAML into HTML.
+
+NOTE: Since Jekyll Collections have this flaw where YAML files can't be directly
+rendered, a hack is implemented in the Makefile `_concepts` target,
+so that every YAML file is converted into AsciiDoc by padding `---` at the end.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/exe/geolexica

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "mercenary"
+require "pry"
+require_relative "../lib/geolexica_server"
+
+Mercenary.program(:geolexica) do |p|
+  p.version GeolexicaServer::VERSION
+  p.syntax "geolexica <subcommand> [options]"
+
+  p.option "source", "-s", "--source [DIR]", "Source directory (defaults to ./)"
+  p.option "destination", "-d", "--destination [DIR]", "Destination directory (defaults to ./_site)"
+
+  Jekyll::Commands::Serve.init_with_program(p)
+  Jekyll::Commands::Build.init_with_program(p)
+
+  p.command(:generate_metadata) do |c|
+    c.syntax "generate-metadata [options]"
+    c.description "Creates a file containing metadata related to current repo"
+
+    c.action do |_args, options|
+      GeolexicaServer::Generator::Metadata.generate(options)
+    end
+  end
+
+  p.command(:generate_bibliography) do |c|
+    c.syntax "generate-bibliography [options]"
+    c.description "Creates a directory containing bibliography based on bibliography.yaml file"
+
+    c.action do |_args, options|
+      GeolexicaServer::Generator::Bibliography.generate(options)
+    end
+  end
+
+  p.action do |args, _options|
+    puts(p) if args.empty?
+  end
+end

data/geolexica-server.gemspec

@@ -0,0 +1,49 @@
+# (c) Copyright 2020 Ribose Inc.
+#
+
+require_relative "lib/geolexica_server/version"
+
+all_files_in_git = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0") }
+
+ribose_url = "https://open.ribose.com/"
+github_url = "https://github.com/geolexica/geolexica-server"
+
+Gem::Specification.new do |spec|
+  spec.name          = "geolexica-server"
+  spec.version       = GeolexicaServer::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "Server for Geolexica sites"
+  spec.homepage      = ribose_url
+  spec.license       = "MIT"
+
+  spec.metadata      = {
+    "bug_tracker_uri" => "#{github_url}/issues",
+    "homepage_uri" => ribose_url,
+    "source_code_uri" => github_url
+  }
+
+  spec.files = all_files_in_git.reject do |f|
+    [
+      f.match(%r{^(test|spec|features|.github)/}),
+      f.match(%r{^\.})
+    ].any?
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jekyll-geolexica"
+  spec.add_dependency "mercenary"
+  spec.add_dependency "relaton"
+
+  # Zeitwerk::Loader#push_dir supports :namespace argument from v. 2.4.
+  spec.add_runtime_dependency "zeitwerk", "~> 2.4"
+
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", ">= 10"
+  spec.add_development_dependency "rspec", "~> 3.9"
+end

data/lib/geolexica_server/generator/base.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module GeolexicaServer
+  module Generator
+    # Base class for generators in GeolexicaServer
+    class Base
+      def self.generate(*args)
+        new(*args).generate
+      end
+
+      def initialize(options = {})
+        config_file_path =
+          options["config_file_path"] ||
+          GeolexicaServer::DEFAULT_CONFIG_FILE_PATH
+
+        @config = YAML.load_file(config_file_path)
+
+        unless @config["geolexica"] && @config["geolexica"]["glossary_path"]
+          raise StandardError,
+                "geolexica.glossary_path is missing in config file."
+        end
+
+        @glossary_path = @config["geolexica"]["glossary_path"]
+      end
+    end
+  end
+end

data/lib/geolexica_server/generator/bibliography.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "relaton"
+
+module GeolexicaServer
+  module Generator
+    # Class for generating bibliography of the glossary
+    class Bibliography < Base
+      def initialize(options)
+        super
+
+        @input_file = "#{@glossary_path}/bibliography.yaml"
+        @output_dir = "bibliography"
+
+        @bibliography_map = YAML.load_file(@input_file)
+        @db = Relaton::Db.new(nil, nil)
+      end
+
+      def generate
+        Dir.mkdir(@output_dir) unless File.directory?(@output_dir)
+
+        @bibliography_map.each do |name, identifier|
+          bib =
+            @db.fetch(identifier["reference"]) ||
+            user_defined_bib(identifier)
+
+          file_path = "#{@output_dir}/#{name}.yaml"
+          File.write(file_path, bib.to_yaml)
+        end
+      end
+
+      private
+
+      def user_defined_bib(identifier)
+        {
+          "user_defined" => true,
+          "reference" => identifier["reference"],
+          "link" => identifier["link"],
+        }.compact
+      end
+    end
+  end
+end

data/lib/geolexica_server/generator/metadata.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module GeolexicaServer
+  module Generator
+    # Class for generating metadata of the glossary
+    class Metadata < Base
+      def initialize(options)
+        super
+
+        @concepts_dir = "#{@glossary_path}/concepts/*.yaml"
+        @output_file_name = "metadata.yaml"
+      end
+
+      def generate
+        terms = extract_terms
+
+        File.open(@output_file_name, "w") do |file|
+          file.write(metadata(terms).to_yaml)
+        end
+
+        puts "Done."
+      end
+
+      private
+
+      def extract_terms
+        terms = []
+
+        Dir[@concepts_dir].map do |yaml_file|
+          terms << YAML.safe_load(IO.read(yaml_file))
+          puts "Processing #{yaml_file}"
+        end
+
+        terms
+      end
+
+      def metadata(terms)
+        {
+          "concept_count" => terms.length,
+          "term_count" => terms.sum { |t| t.keys.length - 2 },
+          "version" => "20220530",
+        }
+      end
+    end
+  end
+end

data/lib/geolexica_server/generator.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module GeolexicaServer
+  module Generator
+  end
+end

data/lib/geolexica_server/version.rb

@@ -0,0 +1,6 @@
+# (c) Copyright 2020 Ribose Inc.
+#
+
+module GeolexicaServer
+  VERSION = "0.0.1-beta-32".freeze
+end

data/lib/geolexica_server.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module GeolexicaServer
+  # Loads Rake tasks which are provided in this gem.
+  #
+  # In order to load these tasks, following lines should be added to given
+  # site's Rakefile:
+  #
+  #   require "geolexica_server"
+  #   GeolexicaServer.load_tasks
+  def self.load_tasks
+    tasks_path = File.expand_path("../tasks", __dir__)
+    Rake.add_rakelib(tasks_path)
+  end
+
+  DEFAULT_CONFIG_FILE_PATH = "./_config.yaml"
+end

data/lib/tasks/deploy.rake

@@ -0,0 +1,44 @@
+# (c) Copyright 2020 Ribose Inc.
+#
+
+namespace :geolexica do
+
+  desc "Deploy site to S3"
+  task :s3_deploy do
+    s3sync_patterns_and_options = {
+      "*.html" => ["--content-type", "text/html; charset=utf-8"],
+      "*.json" => ["--content-type", "application/json; charset=utf-8"],
+      "*.jsonld" => ["--content-type", "application/ld+json; charset=utf-8"],
+      "*.tbx.xml" => ["--content-type", "application/xml; charset=utf-8"],
+      "*.ttl" => ["--content-type", "text/turtle; charset=utf-8"],
+      "*.yaml" => ["--content-type", "text/yaml; charset=utf-8"],
+    }
+
+    s3sync_patterns_and_options.each_pair do |pattern, options|
+      s3_sync "--exclude", "*", "--include", pattern, *options
+    end
+
+    # Remaining files
+    remaining_patterns = s3sync_patterns_and_options.keys
+    s3_sync "--include", "*", *remaining_patterns.flat_map { |k| ["--exclude", k] }
+
+    aws "configure", "set", "preview.cloudfront", "true"
+
+    aws "cloudfront", "create-invalidation",
+      "--distribution-id", ENV["CLOUDFRONT_DISTRIBUTION_ID"],
+      "--paths", "/*"
+  end
+
+  def s3_sync(*args)
+    source = "_site"
+    target = "s3://#{ENV["S3_BUCKET_NAME"]}"
+    common_options = ["--region", ENV["AWS_REGION"], "--delete", "--no-progress"]
+
+    aws "s3", "sync", source, target, *common_options, *args
+  end
+
+  def aws(*args)
+    system "aws", *args, exception: true
+  end
+
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: geolexica-server
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre.beta.pre.32
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll-geolexica
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mercenary
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: relaton
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description:
+email:
+- open.source@ribose.com
+executables:
+- geolexica
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.adoc
+- Rakefile
+- exe/geolexica
+- geolexica-server.gemspec
+- lib/geolexica_server.rb
+- lib/geolexica_server/generator.rb
+- lib/geolexica_server/generator/base.rb
+- lib/geolexica_server/generator/bibliography.rb
+- lib/geolexica_server/generator/metadata.rb
+- lib/geolexica_server/version.rb
+- lib/tasks/deploy.rake
+homepage: https://open.ribose.com/
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/geolexica/geolexica-server/issues
+  homepage_uri: https://open.ribose.com/
+  source_code_uri: https://github.com/geolexica/geolexica-server
+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.7
+signing_key:
+specification_version: 4
+summary: Server for Geolexica sites
+test_files: []