coradoc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1808574d50d22e93126d258859b0a7156015dae5e1830332b70a705643c3ab50
+  data.tar.gz: e1593143645bd24b419ad84f5961335de1351599fc9e9363d40c49ddb5a1d1b9
+SHA512:
+  metadata.gz: a40e182cf07edd62e2af114fdbc752e759aef7b44a693cab17a6fba93869f999a5b2532f25e80146f30ed19b997414061b333836e4165045826e5c3853474403
+  data.tar.gz: 51c085c1a3437ea76897568b318a10ed7cc42f3998448903c0337500455fc4712ca869cc50ce1355bcb707461fef16c825f8c5a206fd86050f8b0295e82d198c

data/.docker/Dockerfile

@@ -0,0 +1,19 @@
+ARG RUBY_IMAGE=ruby:3.1.2-slim
+
+FROM ${RUBY_IMAGE}
+
+RUN apt-get update \
+    && apt-get install -y build-essential git \
+    && apt-get clean && rm -rf /var/lib/apt/lists/*
+
+# install latest bundler
+RUN gem install bundler
+
+# Create app directory
+WORKDIR /workspace
+
+# Set bundle path
+ENV BUNDLE_PATH /bundle
+
+# Default to console
+CMD ["bin/console"]

data/.docker/Makefile

@@ -0,0 +1,35 @@
+export SPEC ?= spec
+SPEC_FILE = $(subst ../,, $(SPEC))
+export RUBY_IMAGE ?= ruby:3.1.2-slim
+
+.PHONY: up
+up:
+	docker-compose up
+
+.PHONY: down
+down:
+	docker-compose down
+
+.PHONY: test
+test: rspec
+
+.PHONY: ssh
+ssh:
+	docker-compose run lib bash
+
+.PHONY: install
+install:
+	docker-compose run lib bin/setup
+
+.PHONY: console
+console:
+	docker-compose run lib bin/console
+
+.PHONY: rspec
+rspec:
+	docker-compose run lib bin/rspec ${SPEC_FILE}
+
+.PHONY: setup
+setup:
+	docker-compose build --build-arg RUBY_IMAGE=${RUBY_IMAGE}
+	docker-compose run lib bin/setup

data/.docker/docker-compose.yml

@@ -0,0 +1,14 @@
+version: "3"
+
+services:
+  lib:
+    build:
+      context: .
+      dockerfile: ./.docker/Dockerfile
+
+    volumes:
+      - .:/workspace
+      - bundle:/bundle
+
+volumes:
+  bundle:

data/.docker/readme.md

@@ -0,0 +1,61 @@
+## Docker
+
+This directory is only meant to be used for development, and contains some
+necessary setup to spin up docker containers with multiple ruby environment.
+
+### Setup
+
+Before doing anything, you might want to create a symlink to the docker file and
+Makefile. This would allow you to avoid some of the unnecessary work related to
+the file paths To do that run the following from the root of the project.
+
+```
+ln -sf .docker/Makefile .
+ln -sf .docker/docker-compose.yml .
+```
+
+By default it usages the most recent ruby version for docker environment, but if
+you want to run it in any specific version then you can set it up by exporting
+`RUBY_IMAGE` environment variable in your shell:
+
+```sh
+export RUBY_IMAGE=ruby:3.0-buster
+```
+
+Once everything is set then you would need to build the development images for
+the first time and you can do that using:
+
+```sh
+make setup
+```
+
+The setup process will install all dependencies and it will also setup a volume
+to speed up the repeated gem installation.
+
+### Playground
+
+The `Makefile` contains two target for tests, and you can run the tests using
+any of the following commands:
+
+```sh
+make test
+
+# or
+make rspec
+```
+
+If you need more control, and you want to do some development on the go then you
+can get into the container using:
+
+```sh
+make ssh
+```
+
+### Cleanup
+
+Once you are done with your experiment then you can cleanup the docker
+environment using the following command.
+
+```sh
+make down
+```

data/.hound.yml

@@ -0,0 +1,5 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+
+# local repo-specific modifications
+# ...
+
+AllCops:
+  TargetRubyVersion: 2.5

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-01-08
+
+- Initial release

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 abunashir@gmail.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,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Abu Nashir
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Makefile

@@ -0,0 +1 @@
+.docker/Makefile

data/README.md

@@ -0,0 +1,69 @@
+# Coradoc
+
+Coradoc is a modern Parser for Asciidoc document. It defines a grammar for
+AsciiDoc, and then build the Parser for that grammar.
+
+Once the document is parsed, it provides a pure ruby object `Coradoc::Document`,
+which can used to customize the document in easiest way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "coradoc"
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+Or install it yourself as:
+
+```sh
+gem install coradoc
+```
+
+## Development
+
+We are following Sandi Metz's Rules for this gem, you can read the
+[description of the rules here][sandi-metz] All new code should follow these
+rules. If you make changes in a pre-existing file that violates these rules you
+should fix the violations as part of your contribution.
+
+### Setup
+
+Clone the repository.
+
+```sh
+git clone https://github.com/metanorma/coradoc.git
+```
+
+Setup your environment in docker
+
+```sh
+make setup
+```
+
+Run the test suite
+
+```sh
+make test
+```
+
+
+## Usages
+
+### Parsing a document
+
+To parse any AsciiDoc, we can use the following:
+
+```ruby
+Coradoc::Parser.parse(sample_asciidoc)
+```
+
+This interface will return the abstract syntax tree.
+
+[sandi-metz]: http://robots.thoughtbot.com/post/50655960596/sandi-metz-rules-for-developers

data/Rakefile

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

data/coradoc.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/coradoc/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "coradoc"
+  spec.version = Coradoc::VERSION
+  spec.authors = ["Ribose Inc.", "Abu Nashir"]
+  spec.email = ["open.source@ribose.com", "abunashir@gmail.com"]
+
+  spec.license = "MIT"
+  spec.homepage = "https://www.metanorma.org"
+  spec.summary = "AsciiDoc parser for metanorma"
+  spec.description = "Experimental AsciiDoc parser for metanorma"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/metanorma/coradoc"
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.add_dependency "parslet"
+  spec.add_dependency "oscal", "~> 0.1.1"
+
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
+end

data/docker-compose.yml

@@ -0,0 +1 @@
+.docker/docker-compose.yml

data/lib/coradoc/document/admonition.rb

@@ -0,0 +1,11 @@
+module Coradoc
+  class Document::Admonition
+    attr_reader :type, :content, :line_break
+
+    def initialize(content, type, options = {})
+      @content = content
+      @type = type.downcase.to_sym
+      @line_break = options.fetch(:line_break, "")
+    end
+  end
+end

data/lib/coradoc/document/attribute.rb

@@ -0,0 +1,27 @@
+module Coradoc
+  module Document
+    class Attribute
+      attr_reader :key, :value
+
+      def initialize(key, value, _options = {})
+        @key = key.to_s
+        @value = build_values(value.to_s)
+      end
+
+      private
+
+      def build_values(value)
+        values = value.split(",").map(&:strip)
+        values.length > 1 ? values : values.first
+      end
+    end
+
+    class Glossaries
+      attr_reader :items
+
+      def initialize(items)
+        @items = items
+      end
+    end
+  end
+end

data/lib/coradoc/document/author.rb

@@ -0,0 +1,11 @@
+module Coradoc
+  class Document::Author
+    attr_reader :email, :last_name, :first_name
+
+    def initialize(first_name, last_name, email)
+      @email = email
+      @last_name = last_name
+      @first_name = first_name
+    end
+  end
+end

data/lib/coradoc/document/base.rb

@@ -0,0 +1,17 @@
+module Coradoc
+  module Document
+    class Base
+      attr_reader :bibdata
+
+      def initialize(asciidoc)
+        @bibdata = extract_bibdata(asciidoc)
+      end
+
+      private
+
+      def extract_bibdata(asciidoc)
+        @bibdata ||= BibData.new(asciidoc.attributes)
+      end
+    end
+  end
+end

data/lib/coradoc/document/bibdata.rb

@@ -0,0 +1,24 @@
+module Coradoc
+  module Document
+    class Bibdata
+      attr_reader :data
+
+      def initialize(bibdata, options = {})
+        @bibdata = bibdata
+        @options = options
+      end
+
+      def data
+        @data ||= @bibdata
+      end
+
+      def to_hash
+        Hash.new.tap do |hash|
+          data.each do |attribute|
+            hash[attribute.key.to_s] = attribute.value.to_s.gsub("'", "")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/document/block.rb

@@ -0,0 +1,34 @@
+module Coradoc
+  class Document::Block
+    attr_reader :title, :lines, :attributes
+
+    def initialize(title, options = {})
+      @title = title
+      @lines = options.fetch(:lines, [])
+      @type_str = options.fetch(:type, nil)
+      @delimiter = options.fetch(:delimiter, "")
+      @attributes = options.fetch(:attributes, {})
+    end
+
+    def type
+      @type ||= defined_type || type_from_delimiter
+    end
+
+    private
+
+    def defined_type
+      if @type_str
+        @type_str.to_s.to_sym
+      end
+    end
+
+    def type_from_delimiter
+      case @delimiter
+      when "____" then :quote
+      when "****" then :side
+      when "----" then :source
+      when "====" then :example
+      else nil end
+    end
+  end
+end

data/lib/coradoc/document/header.rb

@@ -0,0 +1,11 @@
+module Coradoc
+  class Document::Header
+    attr_reader :title, :author, :revision
+
+    def initialize(title, options = {})
+      @title = title
+      @author = options.fetch(:author, nil)
+      @revision = options.fetch(:revision, nil)
+    end
+  end
+end

data/lib/coradoc/document/list.rb

@@ -0,0 +1,14 @@
+module Coradoc
+  module Document
+    class List
+      attr_reader :items
+
+      def initialize(items)
+        @items = items
+      end
+
+      class Unnumbered < List
+      end
+    end
+  end
+end

data/lib/coradoc/document/paragraph.rb

@@ -0,0 +1,19 @@
+module Coradoc
+  module Document
+    class Paragraph
+      attr_reader :content
+
+      def initialize(content, _options = {})
+        @content = content
+      end
+
+      def id
+        content&.first&.id&.to_s
+      end
+
+      def texts
+        content.map(&:content)
+      end
+    end
+  end
+end

data/lib/coradoc/document/revision.rb

@@ -0,0 +1,11 @@
+module Coradoc
+  class Document::Revision
+    attr_reader :number, :date, :remark
+
+    def initialize(number, options = {})
+      @number = number
+      @date = options.fetch(:date, nil)
+      @remark = options.fetch(:remark, nil)
+    end
+  end
+end

data/lib/coradoc/document/section.rb

@@ -0,0 +1,28 @@
+module Coradoc
+  class Document::Section
+    attr_reader :id, :title, :contents, :sections
+
+    def initialize(title, options = {})
+      @title = title
+      @id = options.fetch(:id, nil).to_s
+      @contents = options.fetch(:contents, [])
+      @sections = options.fetch(:sections, [])
+    end
+
+    def glossaries
+      @glossaries ||= extract_glossaries
+    end
+
+    def content
+      if contents.count == 1 && contents.first.is_a?(Coradoc::Document::Paragraph)
+        contents.first
+      end
+    end
+
+    private
+
+    def extract_glossaries
+      contents.select {|c| c if c.is_a?(Coradoc::Document::Glossaries) }.first
+    end
+  end
+end

data/lib/coradoc/document/table.rb

@@ -0,0 +1,20 @@
+module Coradoc
+  module Document
+    class Table
+      attr_reader :title, :rows
+
+      def initialize(title, rows)
+        @rows = rows
+        @title = title
+      end
+
+      class Row
+        attr_reader :columns
+
+        def initialize(columns)
+          @columns = columns
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/document/text_element.rb

@@ -0,0 +1,22 @@
+module Coradoc
+  class Document::TextElement
+    attr_reader :id, :content, :line_break
+
+    def initialize(content, options = {})
+      @content = content.to_s
+      @id = options.fetch(:id, nil)
+      @line_break = options.fetch(:line_break, "")
+    end
+  end
+
+  class Document::LineBreak
+    attr_reader :line_break
+
+    def initialize(line_break)
+      @line_break = line_break
+    end
+  end
+
+  class Document::Highlight < Document::TextElement
+  end
+end