feat: initial commit

.github/workflows/rake.yml

@@ -0,0 +1,13 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  rake:
+    uses: relaton/support/.github/workflows/rake.yml@main

.github/workflows/release.yml

@@ -0,0 +1,24 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: release
+
+on:
+  workflow_dispatch:
+    inputs:
+      next_version:
+        description: |
+          Next release version. Possible values: x.y.z, major, minor, patch (or pre|rc|etc).
+          Also, you can pass 'skip' to skip 'git tag' and do 'gem push' for the current version
+        required: true
+        default: 'skip'
+  repository_dispatch:
+    types: [ do-release ]
+
+
+jobs:
+  release:
+    uses: relaton/support/.github/workflows/release.yml@main
+    with:
+      next_version: ${{ github.event.inputs.next_version }}
+    secrets:
+      rubygems-api-key: ${{ secrets.RELATON_CI_RUBYGEMS_API_KEY }}

.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in glossarist-agent.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

README.adoc

@@ -0,0 +1,149 @@
+= Glossarist Agent
+
+image:https://img.shields.io/gem/v/glossarist-agent.svg["Gem Version", link="https://rubygems.org/gems/glossarist-agent"]
+image:https://github.com/relaton/glossarist-agent/workflows/rake/badge.svg["Build Status", link="https://github.com/relaton/glossarist-agent/actions?workflow=rake"]
+image:https://codeclimate.com/github/relaton/glossarist-agent/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/relaton/glossarist-agent"]
+
+== Purpose
+
+The Glossarist Agent is a Ruby gem designed to retrieve remotely located concepts.
+
+Currently, it allows the bulk retrieval of the IHO S-32 Hydrographic Dictionary
+into the Glossarist format.
+
+
+== Installation
+
+Add this line to your application's `Gemfile`:
+
+[source,ruby]
+----
+gem 'glossarist-agent'
+----
+
+And then execute:
+
+[source,shell]
+----
+$ bundle install
+----
+
+Or install it yourself as:
+
+[source,shell]
+----
+$ gem install glossarist-agent
+----
+
+
+== Usage
+
+=== Downloading IHO S-32 Hydrographic Dictionary data
+
+==== General
+
+The Glossarist Agent can download and process IHO (International Hydrographic
+Organization) S-32 Hydrographic Dictionary data from available CSV files.
+
+The official site is located at:
+
+* http://iho-ohi.net/S32/
+
+Glossarist Agent uses a caching mechanism to efficiently manage downloads and
+reduce unnecessary network requests.
+
+To retrieve these concepts and generate a Glossarist dataset, use the following
+command:
+
+[source,shell]
+----
+$ glossarist-agent iho retrieve-concepts
+----
+
+This command performs the following actions:
+
+. Downloads the required CSV files from IHO sources.
+. Caches the downloaded files for future use.
+. Processes the CSV data to generate a Glossarist-compatible dataset.
+
+==== Command Options
+
+[source,shell]
+----
+$ glossarist-agent iho help retrieve-concepts
+Usage:
+  glossarist-agent iho retrieve-concepts
+
+Options:
+  -o, [--output=OUTPUT]                        # Directory to output generated files
+                                               # Default: ./output
+  -c, [--cache=CACHE]                          # Directory to store cached files
+                                               # Default: ~/.glossarist-agent/cache
+      [--fetch], [--no-fetch], [--skip-fetch]  # Fetch new data (default: true)
+                                               # Default: true
+
+Download IHO CSV files and generate concepts
+----
+
+`--output`:: Specifies the directory where the generated Glossarist dataset will be saved. Default is `./output`.
+`--cache`:: Sets the directory for storing cached files. Default is `~/.glossarist-agent/cache`.
+`--fetch`:: Controls whether to fetch new data or use existing cached data. Default is `true`.
+
+[example]
+====
+The following command saves the IHO S-32 Glossarist dataset at
+`./iho-s32-glossarist` and prioritizes using the existing cache without
+communicating with the server.
+
+[source,sh]
+----
+$ glossarist-agent iho retrieve-concepts --no-fetch -o iho-s32-glossarist
+----
+====
+
+
+=== Caching mechanism
+
+The Glossarist Agent employs a sophisticated caching system to optimize
+performance and reduce unnecessary downloads:
+
+. Downloaded files are stored in the specified cache directory.
+. Each cached file is associated with metadata, including the download time and ETag.
+. When fetching data, the agent checks:
+.. If the cached file exists and is within the expiry period (default 7 days).
+.. If the server's ETag matches the cached ETag.
+. If either condition is not met, the agent downloads a fresh copy of the file.
+
+This approach ensures that the agent always works with up-to-date data while minimizing network usage.
+
+=== Generating Glossarist Dataset
+
+After downloading and caching the IHO CSV files, the agent processes the data to generate a Glossarist-compatible dataset:
+
+. It parses the CSV files to extract concept information.
+. The extracted data is transformed into the Glossarist data model.
+. The resulting dataset is saved in the specified output directory.
+
+This generated dataset can then be used with other Glossarist tools for further processing or integration into concept management systems.
+
+== Features
+
+* Automated downloading and caching of IHO CSV files
+* ETag-based cache validation
+* Customizable cache expiry period
+* Generation of Glossarist-compatible datasets from IHO data
+* Command-line interface for easy integration into workflows
+
+== Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+
+== License
+
+Copyright Ribose.
+
+The gem is available as open source under the terms of the
+https://opensource.org/licenses/MIT[MIT License].

Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "glossarist/agent"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here