capsium 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e89423acb8bc50c9e1fc53ad06ad472114f379159cf66f49d90f92f08a22c907
+  data.tar.gz: 70e5bcdcfcbf17028102da8c6dd45a4b9d5fe58a0618f048214f278fc212516b
+SHA512:
+  metadata.gz: 98aa164541a7fdb7678baaa084cad87bccb9f5673913a521d91ed19747153c119bccdbaeb7771c2312f131270d066412fcf1972c43cc7ac38dc4b3016e1f96b8
+  data.tar.gz: e3d043c1c4c1692160811fbefdce727c2c0d606e65ad934de9474b41af88a3e621bd51b9620581f186dd257800e3386661f125ab94921277a4bd5a7b1e801a49

data/.github/workflows/rake.yml

@@ -0,0 +1,18 @@
+# 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:
+
+permissions:
+  contents: write
+
+jobs:
+  rake:
+    uses: metanorma/ci/.github/workflows/libreoffice-rake.yml@main
+    secrets:
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.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: metanorma/ci/.github/workflows/rubygems-release.yml@main
+    with:
+      next_version: ${{ github.event.inputs.next_version }}
+    secrets:
+      rubygems-api-key: ${{ secrets.METANORMA_CI_RUBYGEMS_API_KEY }}
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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, 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 e-mail 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 ronald.tse@ribose.com. 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.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

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

data/README.adoc

@@ -0,0 +1,258 @@
+= Capsium
+
+Capsium: Common architecture for portable secure information interchange and
+unified management.
+
+Capsium is designed to facilitate the creation, management and deployment of
+content packages with ease.
+
+This gem provides a structured way to handle content, data, and metadata for
+various applications.
+
+
+== Testing out how it works
+
+Download the mn-samples-iso built site: https://github.com/metanorma/mn-samples-iso/actions/runs/8862815829/artifacts/1453746303[mn-samples-iso-Linux].
+
+Then run these commands:
+
+[source,bash]
+----
+$ unzip mn-samples-iso-Linux.zip
+$ cd mn-samples-iso-Linux
+$ mkdir content
+$ mv index.html documents.xml documents content
+$ echo '{"name": "mn-samples-iso","version":"0.1.0"}' > metadata.json
+$ cd ..
+$ bundle exec capsium package pack -f mn-samples-iso-Linux
+Package created: mn-samples-iso-0.1.0.cap
+$ bundle exec capsium reactor serve mn-samples-iso-0.1.0.cap
+Starting server on http://localhost:8864
+[2024-06-05 14:56:41] INFO  WEBrick::HTTPServer#start: pid=8234 port=8864
+...
+----
+
+== Installation
+
+To install the Capsium gem, add it to your Gemfile:
+
+[source,ruby]
+----
+gem 'capsium'
+----
+
+Then, run the following command to install it:
+
+[source,bash]
+----
+bundle install
+----
+
+Alternatively, you can install the gem directly using:
+
+[source,bash]
+----
+gem install capsium
+----
+
+== What is a Capsium package?
+
+A Capsium package is a structured collection of content, data, metadata, and routing information. It is designed to encapsulate all resources needed for a particular application or service in a well-organized format. A package typically includes:
+
+* **Content**: Static files like HTML, CSS, and JavaScript.
+* **Data**: Structured data files, such as YAML or JSON.
+* **Metadata**: Descriptive information about the package, such as its name, version, and dependencies.
+* **Routes**: Mapping of URLs to content or data endpoints.
+* **Storage**: Definitions for datasets and their sources, formats, and schemas.
+
+== What is a Capsium reactor?
+
+A Capsium reactor is a runtime environment that serves Capsium packages. It reads the package configuration and starts a server that can handle HTTP requests according to the routes defined in the package. The reactor ensures that the content and data within the package are served correctly, allowing for easy integration and deployment of packaged applications.
+
+== CLI: Package
+
+To pack a package, you need to define the content, data, metadata, routes, and storage configurations. Once defined, you can use the Capsium command-line interface (CLI) to create and manage your packages.
+
+Capsium provides a CLI to help you pack and manage your packages. Here are some common commands:
+
+[source,bash]
+----
+# TODO: Create a new package
+# Full command
+capsium package new my_package
+# Shorthand
+capsium package my_package
+
+# TODO: Add content to the package
+capsium package add content example.html example.css example.js
+
+# TODO: Add data to the package
+capsium package add data animals.yaml
+
+# TODO: Add metadata to the package
+capsium package add metadata name=sample_package version=0.1.0
+
+# TODO: Define routes for the package
+capsium package add route /=example.html /index=index.html /api/v1/data/animals={type:dataset,name:animals}
+
+# TODO: Define storage for the package
+capsium package add storage datasets=[{name:animals,source:data/animals.yaml,format:yaml,schema:data/animals_schema.yaml}]
+----
+
+=== Packing a package
+
+To pack an existing Capsium package directory, use the following command:
+
+[source,bash]
+----
+capsium package pack [--force/-f] path-to-package
+----
+
+This command will pack your package into a single file with the
+filename:
+
+* `{package-name}-{package-version}.cap`
+* where the name and version both come from `{package-path}/metadata.json`
+
+.Sample `pack` command
+====
+[source,bash]
+----
+capsium package pack -f spec/fixtures/bare_package
+----
+====
+
+
+
+== CLI: Reactor
+
+=== Starting a reactor on your package
+
+To start a Capsium reactor on your package, use the following command:
+
+[source,bash]
+----
+capsium reactor serve my_package.cap
+----
+
+
+== Programmatically managing packages
+
+You can also create, load, and use packages programmatically within your Ruby application.
+
+=== Creating packages
+
+[source,ruby]
+----
+require 'capsium'
+
+package = Capsium::Package.new(
+  name: 'sample_package',
+  version: '0.1.0',
+  content: {
+    'example.html' => 'text/html',
+    'example.css' => 'text/css',
+    'example.js' => 'application/javascript'
+  },
+  data: {
+    'animals.yaml' => {
+      'animals' => [
+        { 'name' => 'Lion', 'type' => 'Mammal', 'habitat' => 'Savannah' },
+        { 'name' => 'Eagle', 'type' => 'Bird', 'habitat' => 'Mountains' },
+        { 'name' => 'Shark', 'type' => 'Fish', 'habitat' => 'Ocean' }
+      ]
+    }
+  },
+  metadata: {
+    'name' => 'sample_package',
+    'version' => '0.1.0',
+    'dependencies' => []
+  },
+  routes: {
+    '/' => 'example.html',
+    '/index' => 'index.html',
+    '/index.html' => 'index.html',
+    '/example.css' => 'example.css',
+    '/example.js' => 'example.js',
+    '/api/v1/data/animals' => { 'type' => 'dataset', 'name' => 'animals' }
+  },
+  storage: {
+    'datasets' => [
+      {
+        'name' => 'animals',
+        'source' => 'data/animals.yaml',
+        'format' => 'yaml',
+        'schema' => 'data/animals_schema.yaml'
+      }
+    ]
+  }
+)
+
+# Save the package to a file
+File.write('my_package.json', package.to_json(pretty: true))
+----
+
+=== Loading packages
+
+To load an existing package from a JSON file, you can use the `Capsium::Package.new(path)` method:
+
+[source,ruby]
+----
+require 'capsium'
+
+# Read the package file or folder
+package = Capsium::Package.new(path)
+
+# Inspect the loaded package
+puts package.inspect
+----
+
+=== Using packages in your program
+
+Once you have created or loaded a package, you can use it within your Ruby application to access its content, data, and other properties.
+
+[source,ruby]
+----
+# Accessing package metadata
+puts "Package Name: #{package.metadata['name']}"
+puts "Package Version: #{package.metadata['version']}"
+
+# Accessing content
+package.content.each do |filename, content_type|
+  puts "Content File: #{filename}, Content Type: #{content_type}"
+end
+
+# Accessing data
+animals_data = package.data['animals.yaml']
+puts "Animals Data: #{animals_data.inspect}"
+
+# Accessing routes
+package.routes.each do |route, destination|
+  puts "Route: #{route}, Destination: #{destination}"
+end
+
+# Accessing storage definitions
+package.storage['datasets'].each do |dataset|
+  puts "Dataset Name: #{dataset['name']}, Source: #{dataset['source']}, Format: #{dataset['format']}"
+end
+----
+
+== Contributing
+
+We welcome contributions to the Capsium gem. If you would like to contribute, please fork the repository and submit a pull request.
+
+=== Running tests
+
+To run the tests, use the following command:
+
+[source,bash]
+----
+rspec
+----
+
+== License
+
+Copyright Ribose.
+
+Capsium is released under the MIT License. See the LICENSE file for more details.
+

data/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]

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "capsium"
+
+# 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__)

data/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

data/capsium.gemspec

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative "lib/capsium/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "capsium"
+  spec.version = Capsium::VERSION
+  spec.authors = ["Ribose Inc."]
+  spec.email = ["open.source@ribose.com'"]
+
+  spec.summary = "Capsium"
+  spec.description = "Capsium"
+  spec.homepage = "https://github.com/metanorma/capsium"
+  spec.license = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/metanorma/capsium/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem
+  # that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`
+      .split("\x0")
+      .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.add_dependency "cssminify"
+  spec.add_dependency "csv"
+  spec.add_dependency "htmlcompressor"
+  spec.add_dependency "html-proofer"
+  spec.add_dependency "json"
+  spec.add_dependency "listen"
+  spec.add_dependency "marcel"
+  spec.add_dependency "rubyzip", "~>2.3.2"
+  spec.add_dependency "scss_lint"
+  spec.add_dependency "shale"
+  spec.add_dependency "sqlite3"
+  spec.add_dependency "thor"
+  spec.add_dependency "uglifier"
+  spec.add_dependency "webrick"
+  spec.add_dependency "yaml"
+
+  spec.add_development_dependency "pry", "~> 0.12.2"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.11"
+  spec.add_development_dependency "rubocop", "~> 1.58"
+end

data/exe/capsium

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "capsium/cli"
+
+Capsium::Cli.start(ARGV)

data/lib/capsium/cli.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+# lib/capsium/cli.rb
+require "thor"
+require_relative "package"
+require_relative "reactor"
+require_relative "thor_ext"
+require_relative "converters/jekyll"
+
+module Capsium
+  class Cli < Thor
+    extend ThorExt::Start
+
+    class Package < Thor
+      extend ThorExt::Start
+
+      desc "info PACKAGE_PATH", "Display information about the package"
+      def info(path_to_package)
+        package = Capsium::Package.new(path_to_package)
+        puts "Package Path: #{package.path}"
+        puts "Routes: #{package.routes.as_json}"
+        puts "Manifest: #{package.manifest.as_json}"
+      end
+
+      desc "manifest PATH_TO_PACKAGE", "Show the manifest content of the package"
+      def manifest(path_to_package)
+        package = Capsium::Package.new(path_to_package)
+        puts JSON.pretty_generate(package.manifest.as_json)
+      end
+
+      desc "storage PATH_TO_PACKAGE", "Show the storage datasets of the package"
+      def storage(path_to_package)
+        package = Capsium::Package.new(path_to_package)
+        puts JSON.pretty_generate(package.storage.as_json)
+      end
+
+      desc "routes PATH_TO_PACKAGE", "Show the routes of the package"
+      def routes(path_to_package)
+        package = Capsium::Package.new(path_to_package)
+        puts JSON.pretty_generate(package.routes.as_json)
+      end
+
+      desc "metadata PATH_TO_PACKAGE", "Show the metadata of the package"
+      def metadata(path_to_package)
+        package = Capsium::Package.new(path_to_package)
+        puts JSON.pretty_generate(package.metadata.as_json)
+      end
+
+      desc "pack PATH_TO_PACKAGE_FOLDER", "Package the files into the package"
+      option :force, type: :boolean, default: false, aliases: "-f"
+      def pack(path_to_package)
+        package = Capsium::Package.new(path_to_package)
+        packager = Capsium::Packager.new
+        packager.pack(package, options)
+      rescue StandardError => e
+        puts e
+        puts e.inspect
+        puts e.backtrace
+      end
+    end
+
+    class Reactor < Thor
+      extend ThorExt::Start
+      desc "serve PACKAGE_PATH", "Start the Capsium reactor to serve the package"
+      def serve(path_to_package)
+        package = Capsium::Package.new(path_to_package)
+        reactor = Capsium::Reactor.new(package)
+        reactor.serve
+      rescue StandardError => e
+        puts e
+        puts e.inspect
+        puts e.backtrace
+      ensure
+        package.cleanup
+      end
+    end
+
+    class Convert < Thor
+      extend ThorExt::Start
+      desc "jekyll SITE_DIRECTORY OUTPUT_DIRECTORY", "Convert a Jekyll site directory to a Capsium package"
+      def jekyll(site_directory, output_directory)
+        converter = Capsium::Converters::Jekyll.new(site_directory, output_directory)
+        converter.convert
+      end
+    end
+
+    desc "package SUBCOMMAND ...ARGS", "Manage packages"
+    subcommand "package", Capsium::Cli::Package
+
+    desc "reactor SUBCOMMAND ...ARGS", "Manage the reactor"
+    subcommand "reactor", Capsium::Cli::Reactor
+
+    desc "converter SUBCOMMAND ...ARGS", "Convert from another format"
+    subcommand "converter", Capsium::Cli::Convert
+  end
+end