repubmark 0.0.0

data/lib/repubmark/elems/special.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Repubmark
+  module Elems
+    # TODO: maybe don't allow mdash everywhere
+    class Special < Base
+      parents :Joint
+
+      HTML = {
+        ellipsis: '&hellip;',
+        mdash: '&mdash;',
+      }.freeze
+
+      UNICODE = {
+        ellipsis: '…',
+        mdash: '—',
+      }.freeze
+
+      def initialize(parent, name)
+        super parent
+        name = String(name).to_sym.freeze
+        HTML.fetch name
+        @name = name
+      end
+
+      #################
+      # Basic methods #
+      #################
+
+      def to_summary_plain = UNICODE.fetch @name
+
+      def to_html = HTML.fetch @name
+
+      def to_gemtext = UNICODE.fetch @name
+    end
+  end
+end

data/lib/repubmark/elems/text.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Repubmark
+  module Elems
+    class Text < Base
+      parents :Joint
+
+      def initialize(parent, str, bold: false, italic: false)
+        super parent
+
+        self.str = str
+
+        @bold   = !!bold
+        @italic = !!italic
+      end
+
+      #################
+      # Basic methods #
+      #################
+
+      def word_count = count_words @str
+
+      def to_summary_plain = @str
+
+      def to_html = str_to_html
+
+      def to_gemtext = @str
+
+    private
+
+      def str=(str)
+        @str = String(str).split.join(' ').freeze
+      end
+
+      def str_to_html
+        result = @str
+        result = "<em>#{result}</em>"         if @italic
+        result = "<strong>#{result}</strong>" if @bold
+        result.freeze
+      end
+    end
+  end
+end

data/lib/repubmark/highlight.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Repubmark
+  class Highlight
+    NO_SYNTAX = 'txt'
+
+    NO_LINE_NUMBERS = %i[sh_hist].freeze
+
+    SYNTAXES = {
+      certbot: 'ini',
+      css: 'css',
+      hjson: nil,
+      html: 'html',
+      ini: 'ini',
+      knockd: nil,
+      nginx: 'nginx',
+      openssh: nil,
+      ruby: 'ruby',
+      sh_hist: nil,
+      sysctl: nil,
+      torrc: nil,
+      wireguard: 'ini',
+      yggdrasil: nil, # Hjson
+    }.freeze
+
+    private_class_method :new
+
+    def self.call(...) = new(...).call
+
+    attr_reader :syntax, :str
+
+    def initialize(syntax, str)
+      self.syntax = syntax
+      self.str = str
+    end
+
+    def call
+      Open3.popen2(*cmdline) do |stdin, stdout, wait_thr|
+        stdin.write str
+        stdin.close
+        result = stdout.read.freeze
+        raise 'Highlight error' unless wait_thr.value.success?
+
+        "<pre><code>#{result}</code></pre>\n".freeze
+      end
+    end
+
+  private
+
+    def syntax=(syntax)
+      return @syntax = nil if syntax.nil?
+
+      unless syntax.instance_of? Symbol
+        raise TypeError, "Expected #{Symbol}, got #{syntax.class}"
+      end
+
+      SYNTAXES.fetch syntax
+
+      @syntax = syntax
+    end
+
+    def str=(str)
+      str = String(str).strip.freeze
+      raise 'Expected non-empty string' if str.empty?
+
+      @str = str
+    end
+
+    def cmdline
+      @cmdline ||= [
+        'highlight',
+        '--stdout',
+        '--fragment',
+        '--out-format',
+        'html',
+        '--syntax',
+        SYNTAXES[syntax] || NO_SYNTAX,
+      ].tap do |cmdline|
+        unless syntax.nil? || NO_LINE_NUMBERS.include?(syntax)
+          cmdline << '--line-numbers'
+        end
+      end.freeze
+    end
+  end
+end

data/lib/repubmark/titled_ref.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Repubmark
+  class TitledRef
+    attr_reader :url, :title
+
+    def initialize(url, title)
+      self.url = url
+      self.title = title
+    end
+
+  private
+
+    attr_writer :url, :title
+  end
+end

data/lib/repubmark/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Repubmark
+  # Gem version.
+  VERSION = '0.0.0'
+end

data/lib/repubmark.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'cgi'
+require 'date'
+require 'forwardable'
+require 'open3'
+require 'pathname'
+require 'uri'
+require 'yaml'
+
+require 'addressable'
+
+require_relative 'repubmark/config'
+require_relative 'repubmark/highlight'
+require_relative 'repubmark/titled_ref'
+
+require_relative 'repubmark/elems/base'
+
+# Top-level element
+require_relative 'repubmark/elems/article'
+
+# Always inside Article
+require_relative 'repubmark/elems/annotation'
+require_relative 'repubmark/elems/footnotes_category'
+# Always inside Article, Chapter
+require_relative 'repubmark/elems/chapter'
+# Always inside Annotation, Blockquote, Chapter
+require_relative 'repubmark/elems/canvas'
+
+# Always inside Canvas
+require_relative 'repubmark/elems/blockquote'
+require_relative 'repubmark/elems/code_block'
+require_relative 'repubmark/elems/figures'
+require_relative 'repubmark/elems/iframe'
+require_relative 'repubmark/elems/paragraph'
+require_relative 'repubmark/elems/separator'
+
+# Always inside Canvas, Figures
+require_relative 'repubmark/elems/figure'
+# Always inside Canvas, ListItem
+require_relative 'repubmark/elems/list'
+# Always inside List
+require_relative 'repubmark/elems/list_item'
+
+# Always inside Caption, Quote
+require_relative 'repubmark/elems/joint'
+# Always inside Blockquote, Figure, Footnote, ListItem, Paragraph
+require_relative 'repubmark/elems/caption'
+# Always inside Caption, Joint, Quote
+require_relative 'repubmark/elems/quote'
+
+# Always inside Joint
+require_relative 'repubmark/elems/abbrev'
+require_relative 'repubmark/elems/code_inline'
+require_relative 'repubmark/elems/fraction'
+require_relative 'repubmark/elems/note'
+require_relative 'repubmark/elems/section'
+require_relative 'repubmark/elems/special'
+require_relative 'repubmark/elems/text'
+require_relative 'repubmark/elems/link'
+require_relative 'repubmark/elems/power'
+
+# Always inside FootnotesCategory
+require_relative 'repubmark/elems/footnote'
+
+##
+# A Markdown-inspired markup language that can be compiled into HTML and
+# Gemtext.
+#
+module Repubmark
+  FORMATS = %i[chapters gemtext html summary_plain word_count].freeze
+
+  SLUG_RE = /\A[[:word:]]+(-[[:word:]]+)*\z/
+
+  UNICODE_SUPS = {
+    '0' => '⁰',
+    '1' => '¹',
+    '2' => '²',
+    '3' => '³',
+    '4' => '⁴',
+    '5' => '⁵',
+    '6' => '⁶',
+    '7' => '⁷',
+    '8' => '⁸',
+    '9' => '⁹',
+    '+' => '⁺',
+    '-' => '⁻',
+    '=' => '⁼',
+    '(' => '⁽',
+    ')' => '⁾',
+  }.freeze
+
+  UNICODE_SUBS = {
+    '0' => '₀',
+    '1' => '₁',
+    '2' => '₂',
+    '3' => '₃',
+    '4' => '₄',
+    '5' => '₅',
+    '6' => '₆',
+    '7' => '₇',
+    '8' => '₈',
+    '9' => '₉',
+    '+' => '₊',
+    '-' => '₋',
+    '=' => '₌',
+    '(' => '₍',
+    ')' => '₎',
+  }.freeze
+
+  def self.validate_slug!(slug)
+    slug = String(slug).freeze
+    raise 'Invalid slug' unless SLUG_RE.match? slug
+
+    slug
+  end
+
+  def self.unicode_sup(val)
+    String(val).each_char.map { |chr| UNICODE_SUPS.fetch chr }.join.freeze
+  end
+
+  def self.unicode_sub(val)
+    String(val).each_char.map { |chr| UNICODE_SUBS.fetch chr }.join.freeze
+  end
+end

data/tests/examples.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'open3'
+
+ROOT = File.expand_path('..', __dir__).freeze
+
+EXE           = File.expand_path('exe/repubmark',       ROOT).freeze
+EXAMPLES      = File.expand_path('examples',            ROOT).freeze
+EXAMPLES_GLOB = File.expand_path('examples/*.repub',    ROOT).freeze
+CONFIG        = File.expand_path('examples/config.yml', ROOT).freeze
+
+PROFILES = [
+  %w[summary_plain summary.txt],
+  %w[http html],
+  %w[gemini gmi],
+  %w[chapters chapters.json],
+].map(&:freeze).freeze
+
+Dir[EXAMPLES_GLOB].each do |example_filename|
+  example = File.read example_filename
+  PROFILES.each do |profile_name, expected_ext|
+    expected_filename = "#{example_filename[...-6]}.#{expected_ext}"
+    expected = File.read expected_filename
+
+    puts '=' * 80
+    puts "Config:   #{CONFIG}"
+    puts "Example:  #{example_filename}"
+    puts "Profile:  #{profile_name}"
+    puts "Expected: #{expected_filename}"
+    puts '-' * 80
+    puts example.strip
+    puts '-' * 80
+    puts expected.strip
+
+    stdin, stdout, wait_thr = Open3.popen2 EXE, CONFIG, profile_name
+    stdin.puts example
+    stdin.close
+    result = stdout.read
+    stdout.close
+    raise 'Template engine error' unless wait_thr.value.success?
+    next if result == expected
+
+    puts '-' * 80
+    puts result.strip
+    puts '=' * 80
+    raise 'Invalid output'
+  end
+end
+
+puts '=' * 80

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: repubmark
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Alex Kotov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+description: A Markdown-inspired markup language that can be compiled into HTML and
+  Gemtext
+email:
+- me+repubmark@kotovalexarian.com
+executables:
+- repubmark
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".yardopts"
+- LICENSE
+- README.md
+- Rakefile
+- examples/config.yml
+- examples/full.chapters.json
+- examples/full.gmi
+- examples/full.html
+- examples/full.repub
+- examples/full.summary.txt
+- examples/hello.chapters.json
+- examples/hello.gmi
+- examples/hello.html
+- examples/hello.repub
+- examples/hello.summary.txt
+- exe/repubmark
+- lib/repubmark.rb
+- lib/repubmark/config.rb
+- lib/repubmark/elems/abbrev.rb
+- lib/repubmark/elems/annotation.rb
+- lib/repubmark/elems/article.rb
+- lib/repubmark/elems/base.rb
+- lib/repubmark/elems/blockquote.rb
+- lib/repubmark/elems/canvas.rb
+- lib/repubmark/elems/caption.rb
+- lib/repubmark/elems/chapter.rb
+- lib/repubmark/elems/code_block.rb
+- lib/repubmark/elems/code_inline.rb
+- lib/repubmark/elems/figure.rb
+- lib/repubmark/elems/figures.rb
+- lib/repubmark/elems/footnote.rb
+- lib/repubmark/elems/footnotes_category.rb
+- lib/repubmark/elems/fraction.rb
+- lib/repubmark/elems/iframe.rb
+- lib/repubmark/elems/joint.rb
+- lib/repubmark/elems/link.rb
+- lib/repubmark/elems/list.rb
+- lib/repubmark/elems/list_item.rb
+- lib/repubmark/elems/note.rb
+- lib/repubmark/elems/paragraph.rb
+- lib/repubmark/elems/power.rb
+- lib/repubmark/elems/quote.rb
+- lib/repubmark/elems/section.rb
+- lib/repubmark/elems/separator.rb
+- lib/repubmark/elems/special.rb
+- lib/repubmark/elems/text.rb
+- lib/repubmark/highlight.rb
+- lib/repubmark/titled_ref.rb
+- lib/repubmark/version.rb
+- tests/examples.rb
+homepage: https://git.causa-arcana.com/causa-arcana/repubmark
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://git.causa-arcana.com/causa-arcana/repubmark
+  source_code_uri: https://git.causa-arcana.com/causa-arcana/repubmark
+  documentation_uri: https://www.rubydoc.info/gems/repubmark/0.0.0
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: A Markdown-inspired markup language that can be compiled into HTML and Gemtext
+test_files: []