jekyll-gemtext 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cbf4a6d4f46044b025ad50dfb8020749c1b5104aa3e47966135ca9ef9775d49c
+  data.tar.gz: fcffa30a2667a787498172e3a22f3266799bb57e2073f8c26e6cb617a8f24c8b
+SHA512:
+  metadata.gz: 15e36bd16854b5a6792addabe08cf1fc1b9f1aa172e4804284e56e59b43ffefbcc689d5bd104ba3ff3363b47ffe710e976468973f074830a56bdcd963a2eeaba
+  data.tar.gz: d5dba9f3564e6572d9cb47fad34c085f9246ad484aa8b35de35d299bcac919a869ee63f7cb695901e58a702acc02ad7d6574ebc8e1384109da68eb24a5962c46

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/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,34 @@
+# Jekyll Gemtext
+
+Gemtext convertor for the Jekyll static site generator
+Supports `*.gmi`, `*.gmni` and `*.gemini` files
+
+## Installation
+
+Add the gem to your Gemfile
+
+```ruby
+# Gemfile
+
+gem 'jekyll-gemtext'
+```
+
+Then install the gems,
+
+```bash
+bundle install
+```
+
+Then you can create `*.gmi` posts in `_posts`, and `bundle exec jekyll build` to convert to HTML
+
+## FAQ
+
+Q: Why use Gemtext over Markdown
+A: If you're also publishing to Gemini, it allows you to use the same Gemtext files for your static website and you Gemini capsule
+
+## Links
+
+=> https://gemini.circumlunar.space/docs/gemtext.gmi Gemtext docs
+=> https://gemini.circumlunar.space/ About Gemini
+
+

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/jekyll-gemtext.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'jekyll-gemtext'
+  gem.version     = '0.1.0'
+  gem.summary     = 'Gemtext extension for the Jekyll static site generator'
+  gem.description = <<~DESCRIPTION
+    Use Gemtext source files (*.gmi and *.gemini) files in the Jekyll static site generator
+  DESCRIPTION
+  gem.authors     = ['Jeremy Wilkins']
+  gem.email       = ['jeb@jdwilkins.co.uk']
+  gem.homepage    = 'https://github.com/jebw/jekyll-gemtext'
+  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 'gmi2html', '~> 0.1'
+
+  gem.add_development_dependency 'bundler', '~> 2.2'
+  gem.add_development_dependency 'byebug', '~> 11.1'
+  gem.add_development_dependency "jekyll", ">= 3.7", "< 5.0"
+  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/jekyll-gemtext.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'jekyll_gemtext'

data/lib/jekyll_gemtext.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'gmi2html'
+
+class JekyllGemtext < Jekyll::Converter
+  def matches(ext)
+    extname_list.include?(ext.downcase)
+  end
+
+  def output_ext(_ext)
+    '.html'
+  end
+
+  def extname_list
+    %w[.gemini .gmni .gmi]
+  end
+
+  def convert(content)
+    ::Gmi2html::Document.new(content).to_html
+  end
+end

data/spec/jekyll_gemtext_spec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe JekyllGemtext do
+  describe '#convert' do
+    subject { described_class.new.convert gemtext }
+
+    let(:gemtext) { "# Title\nParagraph content" }
+    let(:html) { "<h1>Title</h1>\n<p>Paragraph content</p>\n" }
+
+    it { is_expected.to eq html }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+require 'jekyll'
+require 'jekyll-gemtext'
+
+Jekyll.logger.log_level = :info
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = :random
+  Kernel.srand config.seed
+  config.disable_monkey_patching!
+  config.raise_errors_for_deprecations!
+
+  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
+
+  def capture_stdout(level = :debug)
+    buffer = StringIO.new
+    Jekyll.logger = Logger.new(buffer)
+    Jekyll.logger.log_level = level
+    result = yield
+    buffer.rewind
+    [result, buffer.string.to_s]
+  ensure
+    Jekyll.logger = Logger.new(StringIO.new, :error)
+  end
+end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-gemtext
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Wilkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gmi2html
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !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: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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: 'Use Gemtext source files (*.gmi and *.gemini) files in the Jekyll static
+  site generator
+
+'
+email:
+- jeb@jdwilkins.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.gmi
+- Rakefile
+- jekyll-gemtext.gemspec
+- lib/jekyll-gemtext.rb
+- lib/jekyll_gemtext.rb
+- spec/jekyll_gemtext_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jebw/jekyll-gemtext
+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: Gemtext extension for the Jekyll static site generator
+test_files:
+- spec/jekyll_gemtext_spec.rb
+- spec/spec_helper.rb