gitlab-glfm-markdown 0.0.7-aarch64-linux

data/LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2011-present GitLab B.V.
+
+Portions of this software are licensed as follows:
+
+* All content residing under the "doc/" directory of this repository is licensed under "Creative Commons: CC BY-SA 4.0 license".
+* All content that resides under the "ee/" directory of this repository, if that directory exists, is licensed under the license defined in "ee/LICENSE".
+* All content that resides under the "jh/" directory of this repository, if that directory exists, is licensed under the license defined in "jh/LICENSE".
+* All client-side JavaScript (when served directly or after being compiled, arranged, augmented, or combined), is licensed under the "MIT Expat" license.
+* All third party components incorporated into the GitLab Software are licensed under the original license provided by the owner of the applicable component.
+* Content outside of the above mentioned directories or restrictions above is available under the "MIT Expat" license as defined below.
+
+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/README.md

@@ -0,0 +1,64 @@
+# GitLab Flavored Markdown
+
+[![Pipeline status](https://gitlab.com/gitlab-org/ruby/gems/gitlab-glfm-markdown/badges/main/pipeline.svg)](https://gitlab.com/gitlab-org/ruby/gems/gitlab-glfm-markdown/-/commits/main)
+[![Latest Release](https://gitlab.com/gitlab-org/ruby/gems/gitlab-glfm-markdown/-/badges/release.svg)](https://gitlab.com/gitlab-org/ruby/gems/gitlab-glfm-markdown/-/releases)
+
+Implements GLFM (as used by GitLab) using a Rust-based markdown parser.
+
+This project is currently EXPLORATORY, so anything and everything will change.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add gitlab-glfm-markdown
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install gitlab-glfm-markdown
+
+## Usage
+
+Try on command line:
+
+```
+rake compile
+bin/console
+
+GLFMMarkdown.to_html('# header', options: {sourcepos: true})
+```
+
+## Development
+
+A command line executable can be built for debugging.
+
+```
+cd ext/glfm_markdown
+cargo run --bin glfm_markdown -- --sourcepos
+```
+
+There is a VSCode workspace that allows you to `Debug executable`
+
+When developing another project locally and using `gitlab-glfm-markdown` by linking
+directly to the gem's source directory, make sure that you're using the same version
+of Ruby for the project and the gem. Otherwise you can see unexplained errors when
+calling into the gem.
+
+### Releasing a new version
+
+To release a new version:
+
+1. Update `lib/glfm_markdown/version.rb` with the version number.
+1. Update `CHANGELOG.md` with the changes in the release.
+1. Create a merge request and merge it to `master`.
+1. Push a new tag to the repository.
+
+The new version with precompiled, native gems will automatically be
+published to [RubyGems](https://rubygems.org/gems/gitlab-glfm-markdown) when the
+pipeline for the tag completes.
+
+## Contributing
+
+Bug reports and merge requests are welcome on GitLab at https://gitlab.com/gitlab-org/ruby/gems/gitlab-glfm-markdown.
+
+Please refer to [CONTRIBUTING](CONTRIBUTING.md) for more details.

data/ext/glfm_markdown/Cargo.toml

@@ -0,0 +1,19 @@
+[package]
+name = "glfm_markdown"
+version = "0.0.3"
+edition = "2021"
+authors = ["digitalmoksha <bwalker@gitlab.com>"]
+publish = false
+
+[lib]
+crate-type = ["cdylib"]
+
+[[bin]]
+name = "glfm_markdown"
+
+[dependencies]
+magnus = { version = "0.5" }
+rb-sys = { version = "0.9.82", default-features = false, features = ["stable-api-compiled-fallback"] }
+argparse = { version = ">= 0.2.1" }
+comrak = { version = "0.19.0" }
+anstream = { version = "0.4" } # TODO keep until we upgrade to rustc 1.70.0 or newer

data/ext/glfm_markdown/extconf.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'mkmf'
+require 'rb_sys/mkmf'
+
+create_rust_makefile('glfm_markdown')

data/ext/glfm_markdown/src/glfm.rs

@@ -0,0 +1,30 @@
+#[derive(Debug)]
+pub struct RenderOptions {
+    pub sourcepos: bool,
+    pub debug: bool,
+}
+
+pub fn render(text: String, options: RenderOptions) -> String {
+    render_comrak(text, options)
+}
+
+fn render_comrak(text: String, options: RenderOptions) -> String {
+    let mut comrak_options = comrak::ComrakOptions::default();
+
+    comrak_options.extension.strikethrough = true;
+    comrak_options.extension.table = true;
+    comrak_options.extension.autolink = true;
+    comrak_options.extension.tasklist = false;
+    comrak_options.extension.footnotes = true;
+
+    comrak_options.render.unsafe_ = true;
+    comrak_options.render.github_pre_lang = true;
+    comrak_options.render.full_info_string = true;
+    comrak_options.render.hardbreaks = false;
+    comrak_options.render.sourcepos = options.sourcepos;
+
+    comrak_options.parse.smart = false;
+    comrak_options.parse.relaxed_autolinks = false;
+
+    comrak::markdown_to_html(&text, &comrak_options)
+}

data/ext/glfm_markdown/src/lib.rs

@@ -0,0 +1,21 @@
+use magnus::{define_module, function, prelude::*, Error, RHash, Symbol};
+
+mod glfm;
+use glfm::{render, RenderOptions};
+
+pub fn render_to_html_rs(text: String, options: RHash) -> String {
+    let sourcepos: bool = options.lookup::<_, bool>(Symbol::new("sourcepos")).unwrap();
+    let debug: bool = options.lookup::<_, bool>(Symbol::new("debug")).unwrap();
+    let render_options = RenderOptions { sourcepos, debug };
+
+    render(text, render_options)
+}
+
+#[magnus::init]
+fn init() -> Result<(), Error> {
+    let module = define_module("GLFMMarkdown")?;
+
+    module.define_singleton_method("render_to_html_rs", function!(render_to_html_rs, 2))?;
+
+    Ok(())
+}

data/ext/glfm_markdown/src/main.rs

@@ -0,0 +1,54 @@
+mod glfm;
+use glfm::{render, RenderOptions};
+use std::io::Read;
+use std::io::Write;
+
+fn main() {
+    let mut input = "-".to_owned();
+    let mut output = "-".to_owned();
+    let mut sourcepos = false;
+    let mut debug = false;
+
+    {
+        // this block limits scope of borrows by cli.refer() method
+        let mut cli = argparse::ArgumentParser::new();
+
+        cli.set_description("Gitlab Flavored Markdown. Experimental.");
+
+        cli.refer(&mut input)
+            .add_argument("file", argparse::Store, "File to read");
+        cli.refer(&mut output)
+            .add_option(&["-o", "--output"], argparse::Store, "File to write");
+        cli.refer(&mut sourcepos).add_option(
+            &["--sourcepos"],
+            argparse::StoreTrue,
+            "Include source mappings in HTML attributes.",
+        );
+        cli.refer(&mut debug).add_option(
+            &["--debug"],
+            argparse::StoreTrue,
+            "Show debug information",
+        );
+
+        cli.parse_args_or_exit();
+    }
+
+    let vec = if input == "-" {
+        let mut vec = Vec::new();
+        std::io::stdin().read_to_end(&mut vec).unwrap();
+        vec
+    } else {
+        std::fs::read(input).unwrap()
+    };
+
+    let source = String::from_utf8_lossy(&vec);
+    let options = RenderOptions { sourcepos, debug };
+
+    let result = render(source.to_string(), options);
+
+    if output == "-" {
+        std::io::stdout().write_all(result.as_bytes()).unwrap();
+    } else {
+        std::fs::write(output, &result).unwrap();
+    }
+}

data/lib/glfm_markdown/loader.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+def load_rust_extension
+  ruby_version = /(\d+\.\d+)/.match(RUBY_VERSION)
+  require_relative "./#{ruby_version}/glfm_markdown"
+rescue LoadError
+  require 'glfm_markdown/glfm_markdown'
+end

data/lib/glfm_markdown/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GLFMMarkdown
+  VERSION = '0.0.7'
+end

data/lib/glfm_markdown.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'glfm_markdown/version'
+require_relative 'glfm_markdown/loader'
+
+load_rust_extension
+
+DEFAULT_OPTIONS = { sourcepos: true, debug: false }.freeze
+
+module GLFMMarkdown
+  class << self
+    def to_html(markdown, options: {})
+      raise TypeError, 'markdown must be a String' unless markdown.is_a?(String)
+      raise TypeError, 'markdown must be UTF-8 encoded' unless markdown.encoding.name == "UTF-8"
+      raise TypeError, 'options must be a Hash' unless options.is_a?(Hash)
+
+      render_to_html_rs(markdown, DEFAULT_OPTIONS.merge(options))
+    end
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: gitlab-glfm-markdown
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+platform: aarch64-linux
+authors:
+- Brett Walker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rb_sys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler-dock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: Markdown processing for GitLab Flavored Markdown
+email:
+- bwalker@gitlab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Cargo.lock
+- LICENSE
+- README.md
+- ext/glfm_markdown/Cargo.toml
+- ext/glfm_markdown/extconf.rb
+- ext/glfm_markdown/src/glfm.rs
+- ext/glfm_markdown/src/lib.rs
+- ext/glfm_markdown/src/main.rs
+- lib/glfm_markdown.rb
+- lib/glfm_markdown/2.7/glfm_markdown.so
+- lib/glfm_markdown/3.0/glfm_markdown.so
+- lib/glfm_markdown/3.1/glfm_markdown.so
+- lib/glfm_markdown/3.2/glfm_markdown.so
+- lib/glfm_markdown/loader.rb
+- lib/glfm_markdown/version.rb
+homepage: https://gitlab.com/gitlab-org/ruby/gems/gitlab-glfm-markdown
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/gitlab-org/ruby/gems/gitlab-glfm-markdown
+  source_code_uri: https://gitlab.com/gitlab-org/ruby/gems/gitlab-glfm-markdown
+  changelog_uri: https://gitlab.com/gitlab-org/ruby/gems/gitlab-glfm-markdown/-/releases
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.3.dev
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.4
+signing_key: 
+specification_version: 4
+summary: GLFM Markdown
+test_files: []