gmi2html 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae673cf5c85980e03af885f8da0c40ed224fbac8eac0fdc5fb7d83695ed30d7c
+  data.tar.gz: 790e59d74edf8769df5ebd6551245417539536c3308626429a87415d506a6b4d
+SHA512:
+  metadata.gz: e9160a96d69dc21b3a9a9918ab0438889e5ab07d9e93dec730a01f0103de781918d2d92de52f82c3d116565302ef7b3773e85db24f174e0a5da2f365e77e12a1
+  data.tar.gz: f3cf8b3d11b3e5190fdc86727262549f366fd7d676757949dd2e6fae7aeb46cbfaaf80d024a60e9e058f039bd8bd2e541e85dc740e9791faffae7d1b9b093c0c

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*.{css,erb,js,json,rb,ruby,scss,sh,yml}]
+indent_size = 2
+indent_style = space
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.coverage
+.yardoc
+Gemfile.lock
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+bin

data/.rubocop.yml

@@ -0,0 +1,16 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Metrics/BlockLength:
+  IgnoredMethods: ['describe']
+
+Style/Documentation:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.7.2

data/.yardoopts

@@ -0,0 +1 @@
+--api public --hide-void-return --markup markdown

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+ruby RUBY_VERSION
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2021 Jeremy Wilkins
+
+MIT License
+
+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.gmi

@@ -0,0 +1,46 @@
+# Gmi2html
+
+This is a pure ruby Gemtext to HTML convertor, relying on the gemtext gem
+
+## Gemini
+
+Gemtext is a simple plain text format, similar to Markdown but simpler. It is the official format for pages within Gemini capsules.
+
+For more information on Gemini see the official page
+
+=> //gemini.circumlunar.space Gemini official page
+=> //gemini.circumlunar.space/docs/specification.gmi Gemini specification
+
+## Using Gmi2html
+
+To convert a Gemtext string to an html string
+
+```
+require 'gmi2html'
+
+html_string = Gmi2html::Document.new(my_gemtext_string).to_html
+```
+
+To convert a Gemtext file to an html string
+
+```
+require 'gmi2html'
+
+html_string = File.open('capsule/my_gemtext.gmi', 'r') do |f|
+  Gmi2html::Document.new(f).to_html
+end
+```
+
+## Status
+
+First release but should be feature complete
+
+### Supported
+
+* Paragraphs
+* Headings
+* Quotes
+* Whitespace
+* List items
+* Preformatted text
+* Syntax highlighted preformatted text

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+desc 'Run all examples'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+end
+
+task default: :spec

data/gmi2html.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gmi2html/version'
+
+Gem::Specification.new do |gem|
+  gem.name        = 'gmi2html'
+  gem.version     = Gmi2html::VERSION
+  gem.summary     = 'Gemini to HTML convertor'
+  gem.description = <<~DESCRIPTION
+    Simple pure ruby Gemini to HTML convertor
+  DESCRIPTION
+  gem.authors     = ['Jeremy Wilkins']
+  gem.email       = ['jeb@jdwilkins.co.uk']
+  gem.homepage    = 'https://github.com/jebw/gmi2html'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = %w[lib]
+  gem.required_ruby_version = '>= 2.5.0'
+
+  gem.add_dependency 'gemtext', '~> 1.0'
+
+  gem.add_development_dependency 'bundler', '~> 2.2'
+  gem.add_development_dependency 'byebug', '~> 11.1'
+  gem.add_development_dependency 'rake', '~> 13.0'
+  gem.add_development_dependency 'rspec', '~> 3.10'
+  gem.add_development_dependency 'rubocop', '~> 1.23'
+  gem.add_development_dependency 'rubocop-rake', '~> 0.6'
+  gem.add_development_dependency 'rubocop-rspec', '~> 2.6'
+  gem.add_development_dependency 'simplecov', '~> 0.21'
+  gem.add_development_dependency 'yard', '~> 0.9.26'
+end

data/lib/gmi2html/document.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'gemtext'
+
+module Gmi2html
+  class Document
+    def initialize(doc)
+      @document_io = wrap_document(doc)
+      @gemtext = parse_gemtext
+    end
+
+    def to_html
+      renderer.to_html
+    end
+
+    private
+
+    def wrap_document(doc)
+      doc.is_a?(String) ? StringIO.new(doc) : doc
+    end
+
+    def parse_gemtext
+      ::Gemtext::Parser.new(@document_io).parse
+    end
+
+    def renderer
+      Renderer.new @gemtext.nodes
+    end
+  end
+end

data/lib/gmi2html/extensions.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Gemtext::Preformatted.class_eval do
+  attr_reader :caption
+end

data/lib/gmi2html/node_renderers/base.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'cgi'
+
+module Gmi2html
+  module NodeRenderers
+    class NotGemtextNode < RuntimeError
+      def initialize
+        super 'Supplied object does not inherit from Gemtext::Node'
+      end
+    end
+
+    class Base
+      class << self
+        def for_gemtext(gemtext_node)
+          klass_for_gemtext_node(gemtext_node).new gemtext_node
+        end
+
+        private
+
+        def klass_for_gemtext_node(node)
+          raise NotGemtextNode unless node.is_a? Gemtext::Node
+
+          node_type = node.class.to_s.split('::').last
+          Gmi2html::NodeRenderers.const_get node_type
+        end
+      end
+
+      def initialize(node)
+        @node = node
+      end
+
+      def render(_prev_node = nil, _next_node = nil)
+        "<#{tag}>#{escaped_content}</#{tag}>\n"
+      end
+
+      def to_s
+        render
+      end
+
+      def content
+        @node.content
+      end
+
+      def escaped_content
+        CGI.escapeHTML(content)
+      end
+    end
+  end
+end

data/lib/gmi2html/node_renderers/heading.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Gmi2html
+  module NodeRenderers
+    class Heading < Base
+      def tag
+        'h1'
+      end
+    end
+  end
+end

data/lib/gmi2html/node_renderers/link.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Gmi2html
+  module NodeRenderers
+    class Link < Base
+      def tag
+        'a'
+      end
+
+      def wrapping_tag
+        'p'
+      end
+
+      def escaped_link
+        CGI.escapeHTML(@node.target)
+      end
+
+      def escaped_description
+        CGI.escapeHTML(@node.description)
+      end
+
+      def rendered_link_tag
+        %(<#{tag} href="#{escaped_link}">#{escaped_description}</#{tag}>\n)
+      end
+
+      def render(_prev_node = nil, _next_node = nil)
+        prefix = "<#{wrapping_tag}>\n"
+        suffix = "</#{wrapping_tag}>\n"
+
+        "#{prefix}#{rendered_link_tag}#{suffix}"
+      end
+    end
+  end
+end

data/lib/gmi2html/node_renderers/list_item.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Gmi2html
+  module NodeRenderers
+    class ListItem < Base
+      def tag
+        'li'
+      end
+
+      def wrapping_tag
+        'ul'
+      end
+
+      def render(prev_node = nil, next_node = nil)
+        prefix = prev_node.is_a?(Gemtext::ListItem) ? '' : "<#{wrapping_tag}>\n"
+        suffix = next_node.is_a?(Gemtext::ListItem) ? '' : "</#{wrapping_tag}>\n"
+
+        "#{prefix}#{super}#{suffix}"
+      end
+    end
+  end
+end

data/lib/gmi2html/node_renderers/preformatted.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Gmi2html
+  module NodeRenderers
+    class Preformatted < Base
+      def tag
+        'pre'
+      end
+
+      def escaped_link
+        CGI.escapeHTML(@node.target)
+      end
+
+      def escaped_alt_text
+        CGI.escapeHTML(@node.caption)
+      end
+
+      def escaped_code
+        return escaped_content unless @node.caption
+
+        %(<code class="language-#{escaped_alt_text}">#{escaped_content}</code>)
+      end
+
+      def render(_prev_node = nil, _next_node = nil)
+        %(<#{tag}>#{escaped_code}</#{tag}>\n)
+      end
+    end
+  end
+end

data/lib/gmi2html/node_renderers/quote.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Gmi2html
+  module NodeRenderers
+    class Quote < Base
+      def tag
+        'blockquote'
+      end
+    end
+  end
+end

data/lib/gmi2html/node_renderers/sub_heading.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Gmi2html
+  module NodeRenderers
+    class SubHeading < Base
+      def tag
+        'h2'
+      end
+    end
+  end
+end

data/lib/gmi2html/node_renderers/sub_sub_heading.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Gmi2html
+  module NodeRenderers
+    class SubSubHeading < Base
+      def tag
+        'h3'
+      end
+    end
+  end
+end

data/lib/gmi2html/node_renderers/text.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Gmi2html
+  module NodeRenderers
+    class Text < Base
+      def tag
+        'p'
+      end
+    end
+  end
+end

data/lib/gmi2html/node_renderers/whitespace.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Gmi2html
+  module NodeRenderers
+    class Whitespace < Base
+      def render(prev_node = nil, _next_node = nil)
+        # Skip the first whitespace node except at start of document
+        return if prev_node && !prev_node.is_a?(Gemtext::Whitespace)
+
+        "<br />\n"
+      end
+    end
+  end
+end

data/lib/gmi2html/renderer.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Gmi2html
+  class Renderer
+    attr_reader :nodes
+
+    def initialize(nodes)
+      @nodes = nodes
+    end
+
+    def to_html
+      rendered_nodes.compact.join
+    end
+
+    private
+
+    def rendered_nodes
+      nodes.map.with_index do |node, index|
+        prev_node = index >= 0 ? nodes[index - 1] : nil
+        next_node = nodes[index + 1]
+
+        node_renderer = NodeRenderers::Base.for_gemtext(node)
+        node_renderer.render(prev_node, next_node)
+      end
+    end
+  end
+end

data/lib/gmi2html/version.rb

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

data/lib/gmi2html.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'gmi2html/document'
+require 'gmi2html/node_renderers/base'
+require 'gmi2html/node_renderers/heading'
+require 'gmi2html/node_renderers/sub_heading'
+require 'gmi2html/node_renderers/sub_sub_heading'
+require 'gmi2html/node_renderers/text'
+require 'gmi2html/node_renderers/quote'
+require 'gmi2html/node_renderers/link'
+require 'gmi2html/node_renderers/list_item'
+require 'gmi2html/node_renderers/whitespace'
+require 'gmi2html/node_renderers/preformatted'
+require 'gmi2html/renderer'
+require 'gmi2html/version'
+require 'gmi2html/extensions'
+
+module Gmi2html
+end

data/spec/fixtures/complex.gmi

@@ -0,0 +1,19 @@
+# Hello world
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+## Some bullets
+
+* First
+* Second
+* Third
+
+### Third level heading
+
+This is some more text
+
+```
+This is a pre-formatted text block
+```

data/spec/fixtures/complex.html

@@ -0,0 +1,12 @@
+<h1>Hello world</h1>
+<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
+<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>
+<h2>Some bullets</h2>
+<ul>
+<li>First</li>
+<li>Second</li>
+<li>Third</li>
+</ul>
+<h3>Third level heading</h3>
+<p>This is some more text</p>
+<pre>This is a pre-formatted text block</pre>

data/spec/fixtures/simple.gmi

@@ -0,0 +1,3 @@
+# Heading
+
+This is some sample body content

data/spec/fixtures/simple.html

@@ -0,0 +1,2 @@
+<h1>Heading</h1>
+<p>This is some sample body content</p>

data/spec/gmi2html/document_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gmi2html::Document do
+  describe '#new' do
+    context 'with open file' do
+      subject { described_class.new StringIO.new("# Title\n\nBody content") }
+
+      it { is_expected.to be_instance_of described_class }
+    end
+
+    context 'with gemini content' do
+      subject { described_class.new "# Title\n\nBody content" }
+
+      it { is_expected.to be_instance_of described_class }
+    end
+
+    context 'without gemini content' do
+      let(:instance) { described_class.new }
+
+      it { expect { instance }.to raise_exception ArgumentError }
+    end
+  end
+
+  describe '#to_html' do
+    subject { instance.to_html }
+
+    let(:instance) { described_class.new File.read(gemtext_file) }
+
+    shared_examples 'a converted gemtext file' do |filename|
+      let(:gemtext_file) { "spec/fixtures/#{filename}.gmi" }
+      let(:expected_html_output) { File.read "spec/fixtures/#{filename}.html" }
+
+      it { is_expected.to eql expected_html_output }
+    end
+
+    it_behaves_like 'a converted gemtext file', 'simple'
+    it_behaves_like 'a converted gemtext file', 'complex'
+  end
+end

data/spec/gmi2html/node_renderers/base_spec.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gmi2html::NodeRenderers::Base do
+  let(:content) { 'Hello, world!' }
+  let(:instance) { test_node_renderer.new Gemtext::Node.new(content) }
+
+  let :test_node_renderer do
+    Class.new(described_class) do
+      def tag
+        'test'
+      end
+    end
+  end
+
+  describe '.for_gemtext' do
+    let(:node) { Gemtext::Text.new content }
+    let(:instance) { described_class.for_gemtext node }
+
+    it 'will return a Gmi2html::NodeRenderers::Text' do
+      expect(instance).to be_kind_of Gmi2html::NodeRenderers::Text
+    end
+
+    it 'will assign the content' do
+      expect(instance.content).to eq node.content
+    end
+  end
+
+  describe '#render' do
+    it 'will generate a <test> html element' do
+      expect(instance.render).to match %r{\A<test>[^<]+</test>}
+    end
+
+    it 'will include the content' do
+      expect(instance.render).to match %r{>Hello, world!<}
+    end
+
+    it 'will end with a newline' do
+      expect(instance.render).to match %r{</test>\n\z}
+    end
+
+    context 'with html tags in' do
+      let(:content) { '<p>Hello</p>' }
+
+      it 'will escape the content' do
+        expect(instance.render).to eql "<test>&lt;p&gt;Hello&lt;/p&gt;</test>\n"
+      end
+    end
+
+    context 'with html special chars' do
+      let(:content) { 'Hello & world' }
+
+      it 'will escape the content' do
+        expect(instance.render).to eql "<test>Hello &amp; world</test>\n"
+      end
+    end
+  end
+
+  describe '#to_s' do
+    it 'will generate a <test> html element' do
+      expect(instance.render).to match %r{\A<test>[^<]+</test>}
+    end
+  end
+end

data/spec/gmi2html/node_renderers/heading_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gmi2html::NodeRenderers::Heading do
+  let(:instance) { described_class.new Gemtext::Heading.new('Heading') }
+
+  describe '#render' do
+    subject { instance.render }
+
+    it { is_expected.to eq "<h1>Heading</h1>\n" }
+  end
+end

data/spec/gmi2html/node_renderers/link_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gmi2html::NodeRenderers::Link do
+  let(:instance) { described_class.new link }
+
+  describe '#render' do
+    subject(:rendered) { instance.render }
+
+    let(:link) { Gemtext::Link.new '/my-capsule my capsule' }
+
+    context 'when only list item' do
+      it 'will render opening and closing p tags in addition to the a tag' do
+        expect(rendered).to eql \
+          %(<p>\n<a href="/my-capsule">my capsule</a>\n</p>\n)
+      end
+    end
+  end
+end

data/spec/gmi2html/node_renderers/list_item_spec.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gmi2html::NodeRenderers::ListItem do
+  let(:instance) { described_class.new list_item }
+
+  describe '#render' do
+    subject(:rendered) { instance.render(prev_node, next_node) }
+
+    let(:other_node) { Gemtext::Node.new('Hello, world!') }
+    let(:list_item) { Gemtext::ListItem.new 'first item' }
+
+    context 'when only list item' do
+      let(:prev_node) { other_node }
+      let(:next_node) { other_node }
+
+      it 'will render opening and closing ul tags in addition to the li tags' do
+        expect(rendered).to eql "<ul>\n<li>first item</li>\n</ul>\n"
+      end
+    end
+
+    context 'when first list item' do
+      let(:prev_node) { other_node }
+      let(:next_node) { list_item }
+
+      it 'will render opening ul tag as well as li tags' do
+        expect(rendered).to eql "<ul>\n<li>first item</li>\n"
+      end
+    end
+
+    context 'when last list item' do
+      let(:prev_node) { list_item }
+      let(:next_node) { nil }
+
+      it 'will render li tags plus closing ul tag' do
+        expect(rendered).to eql "<li>first item</li>\n</ul>\n"
+      end
+    end
+
+    context 'when in the middle of list items' do
+      let(:prev_node) { list_item }
+      let(:next_node) { list_item }
+
+      it 'will render only the li tags' do
+        expect(rendered).to eql "<li>first item</li>\n"
+      end
+    end
+  end
+end

data/spec/gmi2html/node_renderers/preformatted_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gmi2html::NodeRenderers::Preformatted do
+  let(:instance) { described_class.new preformatted }
+  let(:preformatted) { Gemtext::Preformatted.new("Some text\n\n\tIndented") }
+
+  describe '#render' do
+    subject(:rendered) { instance.render }
+
+    it { is_expected.to eq "<pre>Some text\n\n\tIndented</pre>\n" }
+
+    context 'with a specified language' do
+      let(:preformatted) { Gemtext::Preformatted.new('puts "Hello matz"', 'ruby') }
+
+      it 'includes the language class' do
+        expect(rendered).to eq \
+          %(<pre><code class="language-ruby">puts &quot;Hello matz&quot;</code></pre>\n)
+      end
+    end
+  end
+end

data/spec/gmi2html/node_renderers/quote_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gmi2html::NodeRenderers::Quote do
+  let(:instance) { described_class.new Gemtext::Quote.new('Quote') }
+
+  describe '#render' do
+    subject { instance.render }
+
+    it { is_expected.to eq "<blockquote>Quote</blockquote>\n" }
+  end
+end

data/spec/gmi2html/node_renderers/sub_heading_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gmi2html::NodeRenderers::SubHeading do
+  let(:instance) { described_class.new Gemtext::SubHeading.new('Heading 2') }
+
+  describe '#render' do
+    subject { instance.render }
+
+    it { is_expected.to eq "<h2>Heading 2</h2>\n" }
+  end
+end

data/spec/gmi2html/node_renderers/sub_sub_heading_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gmi2html::NodeRenderers::SubSubHeading do
+  let(:instance) { described_class.new Gemtext::SubSubHeading.new('Heading 3') }
+
+  describe '#render' do
+    subject { instance.render }
+
+    it { is_expected.to eq "<h3>Heading 3</h3>\n" }
+  end
+end

data/spec/gmi2html/node_renderers/text_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gmi2html::NodeRenderers::Text do
+  let(:instance) { described_class.new Gemtext::Text.new('Hello') }
+
+  describe '#render' do
+    subject { instance.render }
+
+    it { is_expected.to eq "<p>Hello</p>\n" }
+  end
+end

data/spec/gmi2html/node_renderers/whitespace_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gmi2html::NodeRenderers::Whitespace do
+  let(:instance) { described_class.new Gemtext::Whitespace.new }
+
+  describe '#render' do
+    subject { instance.render }
+
+    let(:other_node) { Gemtext::Node.new('Hello, world!') }
+    let(:whitespace_node) { Gemtext::Whitespace.new }
+
+    it { is_expected.to eq "<br />\n" }
+
+    context 'when first node in document' do
+      subject { instance.render(nil, other_node) }
+
+      it('will render a break tag') { is_expected.to eq "<br />\n" }
+    end
+
+    context 'when first node in sequence of whitespace nodes' do
+      subject { instance.render(other_node, whitespace_node) }
+
+      it('will not render a break tag') { is_expected.to be_nil }
+    end
+
+    context 'when later node in sequence of whitespace nodes' do
+      subject { instance.render(whitespace_node, other_node) }
+
+      it('will render a break tag') { is_expected.to eq "<br />\n" }
+    end
+  end
+end

data/spec/gmi2html/renderer_spec.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gmi2html::Renderer do
+  subject(:renderer) { described_class.new(nodes) }
+
+  let(:node) { Gemtext::Text.new('Hello, world!') }
+  let(:heading) { Gemtext::Heading.new('Heading') }
+  let(:heading_renderer) { Gmi2html::NodeRenderers::Heading.new(heading) }
+  let(:nodes) { [heading, node, node] }
+
+  describe '#to_html' do
+    subject(:rendered) { renderer.to_html }
+
+    before do
+      allow(Gmi2html::NodeRenderers::Base).to \
+        receive(:for_gemtext).and_call_original
+
+      allow(Gmi2html::NodeRenderers::Base).to \
+        receive(:for_gemtext).with(heading).and_return(heading_renderer)
+    end
+
+    it 'will combine the nodes' do
+      expect(rendered).to eql \
+        "<h1>Heading</h1>\n<p>Hello, world!</p>\n<p>Hello, world!</p>\n"
+    end
+
+    context 'with nodes which render a nil response' do
+      before { allow(heading_renderer).to receive(:render).and_return(nil) }
+
+      it 'will skip those nodes' do
+        expect(rendered).to eql("<p>Hello, world!</p>\n<p>Hello, world!</p>\n")
+      end
+    end
+
+    context 'with multiple nodes' do
+      let(:nodes) { [node, heading, node] }
+
+      before { allow(heading_renderer).to receive(:render).and_call_original }
+
+      it 'will pass surrounding nodes for context into NodeRenderer#render' do
+        renderer.to_html
+        expect(heading_renderer).to have_received(:render).with(node, node)
+      end
+    end
+  end
+end

data/spec/gmi2html_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gmi2html do
+  describe 'VERSION' do
+    subject { described_class::VERSION }
+
+    it { is_expected.to eql '0.1.0' }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'byebug'
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+require 'gmi2html'
+
+RSpec.configure do |config|
+  config.filter_run_when_matching :focus
+
+  config.disable_monkey_patching!
+
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+
+  Kernel.srand config.seed
+
+  config.raise_errors_for_deprecations!
+end

metadata

@@ -0,0 +1,246 @@
+--- !ruby/object:Gem::Specification
+name: gmi2html
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Wilkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gemtext
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.23'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.26
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.26
+description: 'Simple pure ruby Gemini to HTML convertor
+
+'
+email:
+- jeb@jdwilkins.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".yardoopts"
+- Gemfile
+- LICENSE.txt
+- README.gmi
+- Rakefile
+- gmi2html.gemspec
+- lib/gmi2html.rb
+- lib/gmi2html/document.rb
+- lib/gmi2html/extensions.rb
+- lib/gmi2html/node_renderers/base.rb
+- lib/gmi2html/node_renderers/heading.rb
+- lib/gmi2html/node_renderers/link.rb
+- lib/gmi2html/node_renderers/list_item.rb
+- lib/gmi2html/node_renderers/preformatted.rb
+- lib/gmi2html/node_renderers/quote.rb
+- lib/gmi2html/node_renderers/sub_heading.rb
+- lib/gmi2html/node_renderers/sub_sub_heading.rb
+- lib/gmi2html/node_renderers/text.rb
+- lib/gmi2html/node_renderers/whitespace.rb
+- lib/gmi2html/renderer.rb
+- lib/gmi2html/version.rb
+- spec/fixtures/complex.gmi
+- spec/fixtures/complex.html
+- spec/fixtures/simple.gmi
+- spec/fixtures/simple.html
+- spec/gmi2html/document_spec.rb
+- spec/gmi2html/node_renderers/base_spec.rb
+- spec/gmi2html/node_renderers/heading_spec.rb
+- spec/gmi2html/node_renderers/link_spec.rb
+- spec/gmi2html/node_renderers/list_item_spec.rb
+- spec/gmi2html/node_renderers/preformatted_spec.rb
+- spec/gmi2html/node_renderers/quote_spec.rb
+- spec/gmi2html/node_renderers/sub_heading_spec.rb
+- spec/gmi2html/node_renderers/sub_sub_heading_spec.rb
+- spec/gmi2html/node_renderers/text_spec.rb
+- spec/gmi2html/node_renderers/whitespace_spec.rb
+- spec/gmi2html/renderer_spec.rb
+- spec/gmi2html_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jebw/gmi2html
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Gemini to HTML convertor
+test_files:
+- spec/fixtures/complex.gmi
+- spec/fixtures/complex.html
+- spec/fixtures/simple.gmi
+- spec/fixtures/simple.html
+- spec/gmi2html/document_spec.rb
+- spec/gmi2html/node_renderers/base_spec.rb
+- spec/gmi2html/node_renderers/heading_spec.rb
+- spec/gmi2html/node_renderers/link_spec.rb
+- spec/gmi2html/node_renderers/list_item_spec.rb
+- spec/gmi2html/node_renderers/preformatted_spec.rb
+- spec/gmi2html/node_renderers/quote_spec.rb
+- spec/gmi2html/node_renderers/sub_heading_spec.rb
+- spec/gmi2html/node_renderers/sub_sub_heading_spec.rb
+- spec/gmi2html/node_renderers/text_spec.rb
+- spec/gmi2html/node_renderers/whitespace_spec.rb
+- spec/gmi2html/renderer_spec.rb
+- spec/gmi2html_spec.rb
+- spec/spec_helper.rb