repubmark 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2c0aaf7101907ec701d795d02c812760f17fd8e0140bea9c5c2eea31911140ea
+  data.tar.gz: a66dc10e8f729b5bbb49435c9dd76c58efa01cbee71d38dd158b7b2005a8902a
+SHA512:
+  metadata.gz: 207ff26689078a17ff150c3ceb3fea702cb5ad7280a7095319d71c648b3501c4cfaf15677b74e244a35598a710d253a21f195be92a37092706ce7654f3f29870
+  data.tar.gz: 171f8cd206a169b57a014698f8e5bd0c2bd1e174d3744ebe5393336bb999fa14d49f96a04e1d8c969f51701394926bd36d1bea2761af8fabeeda4eecdd0de244

data/.rubocop.yml

@@ -0,0 +1,46 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.2
+  DisplayCopNames: true
+  NewCops: enable
+
+Layout/AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+Layout/LineLength:
+  Max: 80
+
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: false
+
+Lint/ReturnInVoidContext:
+  Enabled: false
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/DoubleNegation:
+  Enabled: false
+
+Style/HashAsLastArrayItem:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/VariableInterpolation:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,129 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-10-18 14:41:13 UTC using RuboCop version 1.67.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: with_first_argument, with_fixed_indentation
+Layout/ArgumentAlignment:
+  Exclude:
+    - 'Rakefile'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Exclude:
+    - 'lib/repubmark/elems/footnote.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: present?, blank?, presence, try, try!, in?
+Lint/SafeNavigationChain:
+  Exclude:
+    - 'lib/repubmark/elems/article.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 35
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 104
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Offense count: 5
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 33
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 11
+
+# Offense count: 2
+Performance/MapMethodChain:
+  Exclude:
+    - 'lib/repubmark/elems/footnotes_category.rb'
+
+# Offense count: 14
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowOnlyRestArgument, UseAnonymousForwarding, RedundantRestArgumentNames, RedundantKeywordRestArgumentNames, RedundantBlockArgumentNames.
+# RedundantRestArgumentNames: args, arguments
+# RedundantKeywordRestArgumentNames: kwargs, options, opts
+# RedundantBlockArgumentNames: blk, block, proc
+Style/ArgumentsForwarding:
+  Exclude:
+    - 'lib/repubmark/elems/canvas.rb'
+    - 'lib/repubmark/elems/footnotes_category.rb'
+    - 'lib/repubmark/elems/joint.rb'
+    - 'lib/repubmark/elems/link.rb'
+
+# Offense count: 34
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 7
+# Configuration parameters: AllowedVariables.
+Style/GlobalVars:
+  Exclude:
+    - 'exe/repubmark'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowIfModifier.
+Style/IfInsideElse:
+  Exclude:
+    - 'lib/repubmark/elems/footnote.rb'
+
+# Offense count: 4
+# This cop supports safe autocorrection (--autocorrect).
+Style/RedundantFreeze:
+  Exclude:
+    - 'lib/repubmark/elems/fraction.rb'
+    - 'lib/repubmark/elems/power.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+Style/RedundantStringEscape:
+  Exclude:
+    - 'lib/repubmark/elems/footnote.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowModifier.
+Style/SoleNestedConditional:
+  Exclude:
+    - 'lib/repubmark/elems/footnote.rb'
+
+# Offense count: 7
+# This cop supports safe autocorrection (--autocorrect).
+Style/SuperArguments:
+  Exclude:
+    - 'lib/repubmark/elems/annotation.rb'
+    - 'lib/repubmark/elems/blockquote.rb'
+    - 'lib/repubmark/elems/canvas.rb'
+    - 'lib/repubmark/elems/caption.rb'
+    - 'lib/repubmark/elems/figures.rb'
+    - 'lib/repubmark/elems/joint.rb'
+    - 'lib/repubmark/elems/paragraph.rb'
+
+# Offense count: 24
+# This cop supports safe autocorrection (--autocorrect).
+Style/SuperWithArgsParentheses:
+  Enabled: false

data/.yardopts

@@ -0,0 +1,4 @@
+--markup markdown
+--readme README.md
+--protected
+--private

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-2024 Alex Kotov
+
+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,21 @@
+Repubmark
+=========
+
+A Markdown-inspired markup language that can be compiled into HTML and Gemtext.
+
+
+
+Examples
+--------
+
+* `./exe/repubmark examples/config.yml word_count    < examples/hello.repub`
+* `./exe/repubmark examples/config.yml summary_plain < examples/hello.repub`
+* `./exe/repubmark examples/config.yml http          < examples/hello.repub`
+* `./exe/repubmark examples/config.yml gemini        < examples/hello.repub`
+* `./exe/repubmark examples/config.yml rss           < examples/hello.repub`
+
+* `./exe/repubmark examples/config.yml word_count    < examples/full.repub`
+* `./exe/repubmark examples/config.yml summary_plain < examples/full.repub`
+* `./exe/repubmark examples/config.yml http          < examples/full.repub`
+* `./exe/repubmark examples/config.yml gemini        < examples/full.repub`
+* `./exe/repubmark examples/config.yml rss           < examples/full.repub`

data/Rakefile

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+CLEAN << '.yardoc'
+CLEAN << 'coverage'
+CLEAN << 'doc'
+
+desc 'Run default checks'
+task default: %i[test lint]
+
+desc 'Run tests'
+task test: :tests
+
+desc 'Run code analysis tools'
+task lint: %i[rubocop yard:cov]
+
+desc 'Fix code style (rubocop --auto-correct)'
+task fix: 'rubocop:auto_correct'
+
+Rake::Task['release'].prereqs.unshift 'default'
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue LoadError
+  nil
+end
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  nil
+end
+
+desc 'Open development console'
+task :console do
+  sh 'bundle', 'exec',
+    File.expand_path(File.join('bin', 'console'), __dir__)
+end
+
+desc 'Run tests'
+task :tests do
+  sh 'bundle', 'exec',
+    File.expand_path(File.join('tests', 'examples.rb'), __dir__)
+end
+
+namespace :yard do
+  desc 'Measure documentation coverage'
+  task :cov do
+    result = `bundle exec yard stats`.lines.last.strip.freeze
+    m = result.match(/\A(\d+(\.\d+)?)% documented\z/)
+    raise 'Invalid result' if m.nil?
+
+    coverage = m[1].to_f.round(2)
+    puts "Documentation coverage: #{coverage}%"
+    raise 'Not fully documented!' if coverage < 38.32
+  end
+end

data/examples/config.yml

@@ -0,0 +1,71 @@
+---
+##########
+# Shared #
+##########
+
+common:
+  footnotes:
+    - category: self
+      links: true
+      title:
+        en: Related articles
+        pl: Powiązane artykuły
+        tu: Связанные статьи
+    - category: link
+      links: true
+      title:
+        en: Links
+        pl: Odnośniki
+        ru: Ссылки
+    - category: book
+      links: false
+      title:
+        en: Literature
+        pl: Literature
+        ru: Литература
+
+paths: &paths
+  current_path: '/xxxxx.xxx'
+  images_prefix: '/assets/images'
+
+css_classes: &css_classes
+  css_class_annotation: 'nice-annotation'
+  css_class_blockquote_figure: 'nice-blockquote'
+  css_class_figure_self: 'nice-figure'
+  css_class_figure_wrap: 'd-flex justify-content-center'
+  css_class_figures_left: 'col-xl-6'
+  css_class_figures_right: 'col-xl-6'
+  css_class_figures_wrap: 'row'
+  css_class_iframe_wrap: 'ratio ratio-16x9'
+
+############
+# Profiles #
+############
+
+word_count:
+  format: word_count
+
+chapters:
+  format: chapters
+
+summary_plain:
+  format: summary_plain
+
+gemini:
+  <<: *paths
+  format: gemtext
+  relative_urls: true
+
+http:
+  <<: *paths
+  <<: *css_classes
+  format: html
+  relative_urls: true
+  chapter_anchor_prefix: 'chapter'
+
+rss:
+  <<: *paths
+  <<: *css_classes
+  format: html
+  relative_urls: false
+  base_url: 'https://example.com'

data/examples/full.chapters.json

@@ -0,0 +1,22 @@
+[
+  {
+    "slug": "1-юникод",
+    "title": "Chapter 1",
+    "chapters": [
+
+    ]
+  },
+  {
+    "slug": "2",
+    "title": "Chapter 2",
+    "chapters": [
+      {
+        "slug": "2--nested",
+        "title": "Chapter 2.1",
+        "chapters": [
+
+        ]
+      }
+    ]
+  }
+]

data/examples/full.gmi

@@ -0,0 +1,44 @@
+Annotation paragraph text
+
+
+
+> Blockquote paragraph text
+Blockquote caption text
+
+```
+[[:foo, 1], [:bar, 2], [:car, 3]].each do |str, num|
+  puts str
+  puts num**2
+end
+```
+
+=> https://example.com Example.com
+
+=> assets/images/foo.jpg The Foo
+
+=> assets/images/qwe.jpg The Qwe
+=> assets/images/rty.jpg The Rty
+
+## Chapter 1
+
+Chapter 1 paragraph text
+
+## Chapter 2
+
+Chapter 2 paragraph text
+
+### Chapter 2.1
+
+Chapter 2.1 paragraph text
+
+
+
+## Related articles
+
+=> ./foo-bar 1) 2024-09-12 Foo Bar — Baz Car Cdr Qwe Rty
+
+
+
+## Links
+
+=> https://example.com 2) Example Domain — This domain is for use in illustrative examples in documents

data/examples/full.html

@@ -0,0 +1,114 @@
+<div class="nice-annotation">
+<p>
+<span>
+Annotation paragraph text
+</span>
+</p>
+</div>
+<figure class="nice-blockquote">
+<blockquote>
+<p>
+<span>
+Blockquote paragraph text
+</span>
+</p>
+</blockquote>
+<figcaption>
+<span>
+Blockquote caption text
+</span>
+</figcaption>
+</figure>
+<pre><code><span class="hl lin">    1 </span><span class="hl opt">[[</span><span class="hl kwc">:foo</span><span class="hl opt">,</span> <span class="hl num">1</span><span class="hl opt">], [</span><span class="hl kwc">:bar</span><span class="hl opt">,</span> <span class="hl num">2</span><span class="hl opt">], [</span><span class="hl kwc">:car</span><span class="hl opt">,</span> <span class="hl num">3</span><span class="hl opt">]].</span>each <span class="hl kwa">do</span> <span class="hl opt">|</span>str<span class="hl opt">,</span> num<span class="hl opt">|</span>
+<span class="hl lin">    2 </span>  puts str
+<span class="hl lin">    3 </span>  puts num<span class="hl opt">**</span><span class="hl num">2</span>
+<span class="hl lin">    4 </span><span class="hl kwa">end</span>
+</code></pre>
+<div class="ratio ratio-16x9">
+<iframe
+title="Example.com"
+src="https://example.com"
+allowfullscreen=""
+frameborder="0"
+sandbox="allow-same-origin allow-scripts allow-popups"
+></iframe>
+</div>
+<div class="d-flex justify-content-center">
+<figure class="nice-figure">
+<img src="assets/images/foo.jpg" alt="The Foo"/>
+<figcaption>
+The Foo
+</figcaption>
+</figure>
+</div>
+<div class="row">
+<div class="col-xl-6">
+<div class="d-flex justify-content-center">
+<figure class="nice-figure">
+<img src="assets/images/qwe.jpg" alt="The Qwe"/>
+<figcaption>
+The Qwe
+</figcaption>
+</figure>
+</div>
+</div>
+<div class="col-xl-6">
+<div class="d-flex justify-content-center">
+<figure class="nice-figure">
+<img src="assets/images/rty.jpg" alt="The Rty"/>
+<figcaption>
+The Rty
+</figcaption>
+</figure>
+</div>
+</div>
+</div>
+<h2 id="chapter--1-юникод">Chapter 1</h2>
+<p>
+<span>
+Chapter 1 paragraph text
+</span>
+</p>
+<h2 id="chapter--2">Chapter 2</h2>
+<p>
+<span>
+Chapter 2 paragraph text
+</span>
+</p>
+<h3 id="chapter--2--nested">Chapter 2.1</h3>
+<p>
+<span>
+Chapter 2.1 paragraph text
+</span>
+</p>
+<div>
+<hr/>
+<h2>Related articles</h2>
+
+<ol>
+<li id="self-foo-bar" value="1" class="fragment-highlight">
+<span class="text-muted">
+<time datetime="2024-09-12">
+September 12, 2024
+</time>
+</span>
+<a href="./foo-bar">Foo Bar</a>
+<span>
+&mdash;
+Baz Car Cdr Qwe Rty
+</span>
+</li>
+</ol>
+<h2>Links</h2>
+
+<ol>
+<li id="link-example-com" value="2" class="fragment-highlight">
+<a href="https://example.com">Example Domain</a>
+<span>
+&mdash;
+This domain is for use in illustrative examples in documents
+</span>
+(<a href="https://web.archive.org/arch/example.com">web.archive.org</a>)
+</li>
+</ol>
+</div>

data/examples/full.repub

@@ -0,0 +1,91 @@
+article.annotation do |annotation|
+  annotation.paragraph do |paragraph|
+    paragraph.text 'Annotation paragraph text'
+  end
+end
+
+
+
+article.blockquote do |blockquote|
+  blockquote.paragraph do |paragraph|
+    paragraph.text 'Blockquote paragraph text'
+  end
+  blockquote.caption do |caption|
+    caption.text 'Blockquote caption text'
+  end
+end
+
+article.code_block :ruby, <<~CODE
+[[:foo, 1], [:bar, 2], [:car, 3]].each do |str, num|
+  puts str
+  puts num**2
+end
+CODE
+
+article.iframe 'Example.com', 'https://example.com'
+
+article.nice_figure 'foo.jpg', 'The Foo'
+
+article.nice_figures do |figures|
+  figures.figure 'qwe.jpg', 'The Qwe'
+  figures.figure 'rty.jpg', 'The Rty'
+end
+
+
+
+article.chapter '1-юникод', 'Chapter 1' do |chapter|
+  chapter.paragraph do |paragraph|
+    paragraph.text 'Chapter 1 paragraph text'
+  end
+end
+
+
+
+article.chapter '2', 'Chapter 2' do |chapter|
+  chapter.paragraph do |paragraph|
+    paragraph.text 'Chapter 2 paragraph text'
+  end
+
+
+
+  chapter.chapter 'nested', 'Chapter 2.1' do |chapter|
+    chapter.paragraph do |paragraph|
+      paragraph.text 'Chapter 2.1 paragraph text'
+    end
+  end
+end
+
+
+
+article.footnotes_category 'Related articles' do |category|
+  category.footnote(
+    category: :self,
+    slug: 'foo-bar',
+    index: 1,
+    url: './foo-bar',
+    link_text: 'Foo Bar',
+    date: '2024-09-12',
+  ) do |footnote|
+    footnote.mdash
+    footnote.text 'Baz Car Cdr Qwe Rty'
+  end
+end
+
+article.footnotes_category 'Links' do |category|
+  category.footnote(
+    category: :link,
+    slug: 'example-com',
+    index: 2,
+    url: 'https://example.com',
+    link_text: 'Example Domain',
+    alt_urls: [
+      {
+        name: 'web.archive.org',
+        url: 'https://web.archive.org/arch/example.com',
+      },
+    ],
+  ) do |footnote|
+    footnote.mdash
+    footnote.text 'This domain is for use in illustrative examples in documents'
+  end
+end

data/examples/full.summary.txt

@@ -0,0 +1,2 @@
+Annotation paragraph text Chapter 1 Chapter 1 paragraph text Chapter 2
+Chapter 2 paragraph text Chapter 2.1 Chapter 2.1 paragraph text

data/examples/hello.chapters.json

@@ -0,0 +1,3 @@
+[
+
+]

data/examples/hello.gmi

@@ -0,0 +1 @@
+Hello, World!

data/examples/hello.html

@@ -0,0 +1,5 @@
+<p>
+<span>
+Hello, World!
+</span>
+</p>

data/examples/hello.repub

@@ -0,0 +1,3 @@
+article.paragraph do |paragraph|
+  paragraph.text 'Hello, World!'
+end

data/examples/hello.summary.txt

@@ -0,0 +1 @@
+Hello, World!