gmi2latex 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e5fec063b892c556ebb4b07be31b10a0bf81b9426f1ded16e17c985f807288e2
+  data.tar.gz: af496f8febb9a9fc9d985915e388eb484bd7a5196f7bf617a97d443e0aded68f
+SHA512:
+  metadata.gz: 1b96eb95d726d1d87ad1943ecd12dc42231898e696b8a3a2fec888395f6884ba1ba7f19f521b3d12d2d65b9f1a97ca8d01b944967cfbc232b6d1f179df00980a
+  data.tar.gz: '0058f166eac7815991d838eda3944caf26ff2d43a388b854efff5aa3cff31327643dbb3c09e2085fcd4e00485299d2fb630b3bd7006e08f58f03fd7e23929c4c'

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-06-15
+
+- Initial release

data/README.md

@@ -0,0 +1,37 @@
+# Gmi2LaTeX
+
+Gmi2LaTeX is a Gemtext (Gemini native text format) to LaTeX converter (renderer) library and command line tool.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add gmi2latex
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install gmi2latex
+
+## Usage
+
+See its usage with `gmi2latex --help`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake test` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Related works
+
+This gem uses [gemini gem][gemini] for parsing.
+There are [gmi2html gem][gmi2html], the Gemini to HTML converter.
+
+[gemini]: https://github.com/exastencil/gemtext "GitHub"
+[gmi2html]: https://github.com/jebw/gmi2html/ "GitHub"
+
+## Contributing
+
+Bug reports and pull requests are welcome.

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/exe/gmi2html

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require_relative "../lib/gmi2latex/command"
+Gmi2LaTeX::Command.run

data/lib/gmi2latex/command.rb

@@ -0,0 +1,29 @@
+require "gemtext"
+require "optparse"
+require_relative "renderer"
+
+module Gmi2LaTeX
+  class Command
+    def self.run
+      new.run
+    end
+
+    def run
+      header = <<~LaTeX
+        \\RequirePackage{plautopatch}
+        \\documentclass[a4paper,article,dvipdfmx]{jlreq}
+        \\usepackage{hyperref}
+        \\begin{document}
+      LaTeX
+      footer = "\\end{document}\n"
+
+      OptionParser.new do |parser|
+        parser.on("--header=SOURCE") { |source| header = source }
+        parser.on("--footer=SOURCE") { |source| footer = source }
+      end.parse!
+
+      doc = Gemtext::Parser.new($stdin).parse
+      Renderer.new(doc, header:, footer:).render
+    end
+  end
+end

data/lib/gmi2latex/gemtext_refinements.rb

@@ -0,0 +1,17 @@
+require "gemtext"
+
+module Gmi2LaTeX
+  module GemtextRefinements
+    refine Gemtext::Node do
+      def deconstruct_keys(*_keys)
+        { content: }
+      end
+    end
+
+    refine Gemtext::Link do
+      def deconstruct_keys(*_keys)
+        { **super, target:, description: }
+      end
+    end
+  end
+end

data/lib/gmi2latex/renderer.rb

@@ -0,0 +1,82 @@
+require_relative "gemtext_refinements"
+
+module Gmi2LaTeX
+  class Renderer
+    def initialize(document, header: nil, footer: nil)
+      @document = document
+      @header = header
+      @footer = footer
+    end
+
+    using Gmi2LaTeX::GemtextRefinements
+
+    def render
+      @header and print @header
+      @document.nodes.each do |node|
+        render_node(node)
+      end
+      end_itemize
+      @footer and print @footer
+    end
+
+    def render_node(node)
+      case node
+      in Gemtext::Heading[content:]
+        end_itemize
+        print "\\section{#{content}}\n"
+      in Gemtext::SubHeading[content:]
+        end_itemize
+        print "\\subsection{#{content}}\n"
+      in Gemtext::SubSubHeading[content:]
+        end_itemize
+        print "\\subsubsection{#{content}}\n"
+      in Gemtext::Whitespace
+        end_itemize
+        print "\n"
+      in Gemtext::Text[content:]
+        end_itemize
+        content.each_char do |char|
+          case char
+          in "_"
+            print "\\_"
+          else
+            print char
+          end
+        end
+        print "\n"
+      in Gemtext::Link[target:, description:]
+        end_itemize
+        print "#{description} (\\url{#{target}})\n"
+      in Gemtext::Preformatted[content:]
+        end_itemize
+        print <<~LaTeX
+          \\begin{verbatim}
+          #{content}
+          \\end{verbatim}
+        LaTeX
+      in Gemtext::ListItem[content:]
+        if @listing
+          print <<~LaTeX
+            \\item{}
+            #{content}
+          LaTeX
+        else
+          print <<~LaTeX
+            \\begin{itemize}
+            \\item{}
+            #{content}
+          LaTeX
+          @listing = true
+        end
+      else
+        raise node.inspect
+      end
+    end
+
+    def end_itemize
+      @listing or return
+      @listing = false
+      print "\\end{itemize}\n"
+    end
+  end
+end

data/lib/gmi2latex/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Gmi2LaTeX
+  VERSION = "0.1.0"
+end

data/lib/gmi2latex.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "gmi2latex/version"
+
+module Gmi2LaTeX
+  Error = Class.new(StandardError)
+end

data/manifest.scm

@@ -0,0 +1 @@
+(specifications->manifest (list "ruby@3.1" "ruby-gemtext" "ruby-rubocop"))

data/sig/gmi2latex.rbs

@@ -0,0 +1,4 @@
+module Gmi2latex
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: gmi2latex
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- gemmaro
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gemtext
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gmi2LaTeX is a Gemtext (Gemini naitive text format, suffix .gmi) to LaTeX
+  converter.
+email:
+- gemmaro.dev@gmail.com
+executables:
+- gmi2html
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- exe/gmi2html
+- lib/gmi2latex.rb
+- lib/gmi2latex/command.rb
+- lib/gmi2latex/gemtext_refinements.rb
+- lib/gmi2latex/renderer.rb
+- lib/gmi2latex/version.rb
+- manifest.scm
+- sig/gmi2latex.rbs
+homepage:
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Gemtext to LaTeX converter
+test_files: []