capsium 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e89423acb8bc50c9e1fc53ad06ad472114f379159cf66f49d90f92f08a22c907
-  data.tar.gz: 70e5bcdcfcbf17028102da8c6dd45a4b9d5fe58a0618f048214f278fc212516b
+  metadata.gz: e2b954beb33b36d3300f8ff418f643a9afbbf688fad4e8333b195ccb76b38b41
+  data.tar.gz: b2ef9e049b70ce3eb111ef0c136befaaf7a2f6a4d233ed9fb41a9d27d9c39e2c
 SHA512:
-  metadata.gz: 98aa164541a7fdb7678baaa084cad87bccb9f5673913a521d91ed19747153c119bccdbaeb7771c2312f131270d066412fcf1972c43cc7ac38dc4b3016e1f96b8
-  data.tar.gz: e3d043c1c4c1692160811fbefdce727c2c0d606e65ad934de9474b41af88a3e621bd51b9620581f186dd257800e3386661f125ab94921277a4bd5a7b1e801a49
+  metadata.gz: e3c75b5ab47ef3b7fe5a8f20571a300c15b960951c032d9c8d01e3eff295a237c294288613449ed090c73e38df718986f412573deeafd0f33acd7a43ead76c41
+  data.tar.gz: 8bdb432b2b7efb4987d211608e8cb13828e2bf49d49cf921c3d9a7f7cc74f5a775ed6454e5bfd3e91a539a36fa0beb28395ff7910682d9d791f8c44db3eebe26

data/.github/workflows/rake.yml

@@ -8,11 +8,8 @@ on:
     tags: [ v* ]
   pull_request:
 
-permissions:
-  contents: write
-
 jobs:
   rake:
-    uses: metanorma/ci/.github/workflows/libreoffice-rake.yml@main
+    uses: metanorma/ci/.github/workflows/generic-rake.yml@main
     secrets:
       pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.github/workflows/release.yml

@@ -7,8 +7,7 @@ on:
     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
+          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
         required: true
         default: 'skip'
   repository_dispatch:

data/.rubocop.yml

@@ -1,8 +1,12 @@
-AllCops:
-  TargetRubyVersion: 3.0
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
+# local repo-specific modifications
+# ...
 
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  Exclude:
+    - 'lib/sts/mapper.rb'
+    - 'vendor/**/*'

data/Gemfile

@@ -4,9 +4,3 @@ 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/capsium.gemspec

@@ -6,20 +6,17 @@ Gem::Specification.new do |spec|
   spec.name = "capsium"
   spec.version = Capsium::VERSION
   spec.authors = ["Ribose Inc."]
-  spec.email = ["open.source@ribose.com'"]
+  spec.email = ["open.source@ribose.com"]
 
   spec.summary = "Capsium"
   spec.description = "Capsium"
-  spec.homepage = "https://github.com/metanorma/capsium"
+  spec.homepage = "https://github.com/capsiums/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"
+  spec.metadata["changelog_uri"] = "https://github.com/capsiums/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")
@@ -35,10 +32,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency "csv"
   spec.add_dependency "htmlcompressor"
   spec.add_dependency "html-proofer"
+  spec.add_dependency "jekyll"
   spec.add_dependency "json"
+  spec.add_dependency "json-schema"
   spec.add_dependency "listen"
   spec.add_dependency "marcel"
-  spec.add_dependency "rubyzip", "~>2.3.2"
+  spec.add_dependency "rubyzip", "~> 2.3.2"
   spec.add_dependency "scss_lint"
   spec.add_dependency "shale"
   spec.add_dependency "sqlite3"
@@ -47,8 +46,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "webrick"
   spec.add_dependency "yaml"
 
-  spec.add_development_dependency "pry", "~> 0.12.2"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rack-test"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.11"
   spec.add_development_dependency "rubocop", "~> 1.58"
+  spec.add_development_dependency "rubocop-performance"
 end

data/lib/capsium/cli.rb

@@ -15,6 +15,7 @@ module Capsium
       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}"
@@ -22,25 +23,30 @@ module Capsium
         puts "Manifest: #{package.manifest.as_json}"
       end
 
-      desc "manifest PATH_TO_PACKAGE", "Show the manifest content of the package"
+      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)
@@ -48,6 +54,7 @@ module Capsium
 
       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
@@ -61,25 +68,37 @@ module Capsium
 
     class Reactor < Thor
       extend ThorExt::Start
-      desc "serve PACKAGE_PATH", "Start the Capsium reactor to serve the package"
+
+      desc "serve PACKAGE_PATH",
+           "Start the Capsium reactor to serve the package"
+      option :port, type: :numeric, default: Capsium::Reactor::DEFAULT_PORT
+      option :do_not_listen, type: :boolean, default: false
+
       def serve(path_to_package)
-        package = Capsium::Package.new(path_to_package)
-        reactor = Capsium::Reactor.new(package)
+        reactor = Capsium::Reactor.new(
+          package: path_to_package,
+          port: options[:port],
+          do_not_listen: options[:do_not_listen],
+        )
         reactor.serve
       rescue StandardError => e
         puts e
         puts e.inspect
         puts e.backtrace
       ensure
-        package.cleanup
+        reactor.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)
+
+      desc "jekyll PACKAGE_FILE OUTPUT_DIRECTORY",
+           "Convert a Capsium package to a Jekyll site"
+
+      def jekyll(package_file, output_directory)
+        converter = Capsium::Converters::Jekyll.new(package_file,
+                                                    output_directory)
         converter.convert
       end
     end
@@ -90,7 +109,7 @@ module Capsium
     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
+    desc "convert SUBCOMMAND ...ARGS", "Convert from another format"
+    subcommand "convert", Capsium::Cli::Convert
   end
 end

data/lib/capsium/converters/jekyll.rb

@@ -1,58 +1,91 @@
 # frozen_string_literal: true
 
-# lib/capsium/converters/jekyll_to_capsium.rb
+# lib/capsium/converters/jekyll.rb
 require "fileutils"
 require "json"
-require "capsium/packager"
+require "capsium/package"
 
 module Capsium
   module Converters
     class Jekyll
-      def initialize(site_directory, output_directory)
-        @site_directory = site_directory
+      def initialize(package_file, output_directory)
+        @package_file = package_file
         @output_directory = output_directory
       end
 
       def convert
-        validate_site_directory
-        package_directory = prepare_package_directory
-        packager = Capsium::Packager.new(package_directory)
-        packager.pack
-        cleanup_package_directory(package_directory)
-      end
+        package = Capsium::Package.new(@package_file)
 
-      private
+        prepare_output_directory
 
-      def validate_site_directory
-        return if Dir.exist?(@site_directory) && File.exist?(File.join(@site_directory, "index.html"))
+        write_config_yml(package)
+        copy_content_files(package)
+        generate_index_html(package)
 
-        raise "Invalid Jekyll site directory: #{@site_directory}"
+        puts "Capsium package converted to Jekyll site at #{@output_directory}"
       end
 
-      def prepare_package_directory
-        package_directory = File.join(@output_directory, "capsium_package")
-        FileUtils.mkdir_p(package_directory)
+      private
 
-        FileUtils.cp_r(Dir.glob("#{@site_directory}/*"), package_directory)
+      def prepare_output_directory
+        FileUtils.mkdir_p(@output_directory)
+      end
 
-        create_manifest(package_directory)
+      def write_config_yml(package)
+        config = {
+          "title" => package.metadata.name || "Capsium Jekyll Site",
+          "description" => package.metadata.description || "Generated from Capsium package",
+          "baseurl" => "",
+          "url" => "",
+          "markdown" => "kramdown",
+          "theme" => "minima",
+        }
+        write_file("_config.yml", config.to_yaml)
+      end
 
-        package_directory
+      def write_file(relative_path, content)
+        output_path = File.join(@output_directory, relative_path)
+        FileUtils.mkdir_p(File.dirname(output_path))
+        File.write(output_path, content)
       end
 
-      def create_manifest(package_directory)
-        manifest = {
-          "name" => "jekyll_site",
-          "version" => "1.0.0",
-          "description" => "A Jekyll site converted to a Capsium package",
-          "files" => Dir.glob("#{package_directory}/**/*").map { |file| file.sub("#{package_directory}/", "") }
-        }
+      def copy_content_files(package)
+        package.content_files.each do |file_path|
+          relative_path = Pathname.new(file_path).relative_path_from(Pathname.new(package.instance_variable_get(:@path)))
+          output_path = File.join(@output_directory, relative_path)
+          FileUtils.mkdir_p(File.dirname(output_path))
+          FileUtils.cp(file_path, output_path)
+        end
+      end
 
-        File.write(File.join(package_directory, "manifest.json"), JSON.pretty_generate(manifest))
+      def generate_index_html(package)
+        root_route = package.routes.config.routes.find do |route|
+          route.path == "/"
+        end
+        if root_route
+          index_path = File.join(package.instance_variable_get(:@path),
+                                 root_route.target.file)
+          index_content = File.read(index_path)
+          write_file("index.html", index_content)
+        else
+          write_file("index.html", default_index_html(package))
+        end
       end
 
-      def cleanup_package_directory(package_directory)
-        FileUtils.rm_rf(package_directory)
+      def default_index_html(package)
+        <<~HTML
+          <!DOCTYPE html>
+          <html>
+          <head>
+            <meta charset="utf-8">
+            <title>#{package.metadata.name || 'Capsium Jekyll Site'}</title>
+          </head>
+          <body>
+            <h1>Welcome to #{package.metadata.name || 'Capsium Jekyll Site'}</h1>
+            <p>This site was generated from a Capsium package.</p>
+          </body>
+          </html>
+        HTML
       end
     end
   end

data/lib/capsium/package/dataset.rb

@@ -1,78 +1,65 @@
 # frozen_string_literal: true
 
-# lib/capsium/package/dataset.rb
 require "json"
 require "yaml"
 require "csv"
 require "sqlite3"
+require "shale"
+require "json-schema"
+require_relative "dataset_config"
 
 module Capsium
   class Package
-    class Dataset < Shale::Mapper
-      # {
-      #   "datasets": [
-      #     {
-      #       "name": "animals",
-      #       "source": "data/animals.yaml",
-      #       "format": "yaml",
-      #       "schema": "data/animals_schema.yaml"
-      #     }
-      #   ]
-      # }
-      attr_reader :name, :path, :type, :data
+    class Dataset
+      attr_reader :config, :data, :data_path
 
-      def initialize(path, data_path)
-        @path = path
-        @name = File.basename(@path, ".*")
-        @type = detect_type
-        @data_path = data_path
+      extend Forwardable
+
+      def_delegators :@config, :to_json
+
+      def initialize(config:, data_path: nil)
+        @config = config
+        @data_path = data_path || config.source
         @data = load_data
       end
 
-      def detect_type
-        case File.extname(@path).downcase
-        when /.ya?ml/ then :yaml
-        when ".json" then :json
-        when ".csv" then :csv
-        when ".tsv" then :tsv
-        when ".sqlite", ".db" then :sqlite
+      def load_data
+        case @config.format
+        when "yaml" then YAML.load_file(@data_path)
+        when "json" then JSON.parse(File.read(@data_path))
+        when "csv" then CSV.read(@data_path, headers: true)
+        when "tsv" then CSV.read(@data_path, col_sep: "\t", headers: true)
+        when "sqlite" then load_sqlite_data
         else
-          raise "Unsupported data file type: #{File.extname(@path)}"
+          raise "Unsupported data file type: #{@config.format}"
         end
       end
 
-      def load_data
-        case @type
-        when :yaml then YAML.load_file(@path)
-        when :json then JSON.parse(File.read(@path))
-        when :csv then CSV.read(@path, headers: true)
-        when :tsv then CSV.read(@path, col_sep: "\t", headers: true)
-        when :sqlite then load_sqlite_data
+      def validate
+        return unless @config.schema
+
+        schema_path = File.join(File.dirname(@data_path), @config.schema)
+        schema = YAML.load_file(schema_path) if @config.format == "yaml"
+        schema = JSON.parse(File.read(schema_path)) if @config.format == "json"
+
+        case @config.format
+        when "yaml" then YAML.load_file(@data_path)
+        when "json" then JSON.parse(File.read(@data_path))
         else
-          raise "Unsupported data file type: #{@type}"
+          raise "Validation is only supported for YAML and JSON formats"
         end
-      end
-
-      def as_json
-        {
-          name: name,
-          source: relative_path(path),
-          format: type.to_s
-        }
-      end
 
-      def to_json(*_args)
-        JSON.pretty_generate(as_json)
+        JSON::Validator.validate!(schema, @data.to_json)
       end
 
-      def relative_path(path)
-        Pathname.new(path).relative_path_from(@data_path).to_s
+      def save_to_file(output_path)
+        File.write(output_path, to_json)
       end
 
       private
 
       def load_sqlite_data
-        db = SQLite3::Database.new(@path)
+        db = SQLite3::Database.new(@data_path)
         tables = db.execute("SELECT name FROM sqlite_master WHERE type='table';")
         data = {}
         tables.each do |table|

data/lib/capsium/package/dataset_config.rb

@@ -0,0 +1,28 @@
+require "shale"
+
+module Capsium
+  class Package
+    class DatasetConfig < Shale::Mapper
+      attribute :name, Shale::Type::String
+      attribute :source, Shale::Type::String
+      attribute :format, Shale::Type::String
+      attribute :schema, Shale::Type::String
+
+      def to_dataset(data_path)
+        Dataset.new(config: self,
+                    data_path: File.join(
+                      File.dirname(data_path), source
+                    ))
+      end
+
+      def self.from_dataset(dataset)
+        new(
+          name: dataset.config.name,
+          source: dataset.config.source,
+          format: dataset.config.format,
+          schema: dataset.config.schema,
+        )
+      end
+    end
+  end
+end

data/lib/capsium/package/manifest.rb

@@ -4,24 +4,25 @@
 require "json"
 require "marcel"
 require "shale"
+require_relative "manifest_config"
 
 module Capsium
   class Package
     class Manifest
-      attr_accessor :path, :content_path, :data
+      extend Forwardable
+      attr_accessor :path, :content_path, :config
+
+      def_delegators :@config, :to_json
 
       def initialize(path)
         @path = path
-        # This is {package-name}/content
-        # or
-        # /tmp/../content
-        @content_path = File.join(File.dirname(@path), "content")
+        @content_path = File.join(File.dirname(@path), Package::CONTENT_DIR)
 
-        @data = if File.exist?(path)
-                  ManifestData.from_json(File.read(path))
-                else
-                  ManifestData.new(content: generate_manifest)
-                end
+        @config = if File.exist?(path)
+                    ManifestConfig.from_json(File.read(path))
+                  else
+                    ManifestConfig.new(content: generate_manifest)
+                  end
       end
 
       def generate_manifest
@@ -30,31 +31,28 @@ module Capsium
         end
 
         files.sort.map do |file_path|
-          ManifestDataItem.new(
+          ManifestConfigItem.new(
             file: relative_path(file_path),
-            mime: mime_from_path(file_path)
+            mime: mime_from_path(file_path),
           )
         end
       end
 
       def lookup(filename)
-        @data.content.detect do |data_item|
+        @config.content.detect do |data_item|
           data_item.file == filename
         end
       end
 
-      def to_json(*_args)
-        @data.to_json
-      end
-
       def save_to_file(output_path = @path)
-        File.open(output_path, "w") do |file|
-          file.write(to_json)
-        end
+        @config.content.sort_by!(&:file)
+        File.write(output_path, to_json)
       end
 
       def path_to_content_file(path)
-        Pathname.new(@content_path).join(path)
+        raise TypeError, "Path cannot be nil" if path.nil?
+
+        Pathname.new(File.dirname(@path)).join(path)
       end
 
       def content_file_exists?(path)
@@ -62,7 +60,7 @@ module Capsium
       end
 
       def relative_path(path)
-        Pathname.new(path).relative_path_from(@content_path).to_s
+        Pathname.new(path).relative_path_from(File.dirname(@path)).to_s
       end
 
       private
@@ -71,27 +69,9 @@ module Capsium
         Marcel::MimeType.for(
           Pathname.new(path),
           name: File.basename(path),
-          extension: File.extname(path)
+          extension: File.extname(path),
         )
       end
     end
-
-    class ManifestDataItem < Shale::Mapper
-      attribute :file, Shale::Type::String
-      attribute :mime, Shale::Type::String
-
-      # json do
-      #   map "file", to: :file
-      #   map "mime", to: :mime
-      # end
-    end
-
-    class ManifestData < Shale::Mapper
-      attribute :content, ManifestDataItem, collection: true
-
-      # json do
-      #   map "content", to: :content
-      # end
-    end
   end
 end

data/lib/capsium/package/manifest_config.rb

@@ -0,0 +1,19 @@
+require "shale"
+
+module Capsium
+  class Package
+    class ManifestConfigItem < Shale::Mapper
+      attribute :file, Shale::Type::String
+      attribute :mime, Shale::Type::String
+    end
+
+    class ManifestConfig < Shale::Mapper
+      attribute :content, ManifestConfigItem, collection: true
+
+      def sort!
+        @content.sort_by!(&:file)
+        self
+      end
+    end
+  end
+end