jekyll-gemini 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76da48d0eea156a0c2a54c82335d76b5c1e8c11428ab9ca3df8f98320de60e4f
+  data.tar.gz: 799dda937000ef8e682e622d27bdc7bc59b42ec540d63c2af416d3259c1a8200
+SHA512:
+  metadata.gz: 3796c1f5d429dff9cb31e8f5f5f769ab05ce30dfe168c19c946017963d42f4741e25e3484cdf4a34924ed517d05118c432b55ebf2b3c880fa5943179ecb26249
+  data.tar.gz: 89bc9f0dbc170611ba8f2c00dc0f0b8b5c1597e6c1084dff5046d91a8b18832d38006d4b369cb210648e7dbcbc82df3ceff1eb86f1d7f924eddb2364ccaa4006

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,88 @@
+# Jekyll Gemini
+
+Plugin for Jekyll to allow publishing to both the Web and Geminispace from a single set of sources.
+
+This relies on the source files using Gemtext instead of Markdown, which are converted automatically via the Jekyll-Gemtext.
+
+Any Gemtext files will be converted to HTML in _site via the usual jekyll build command.
+
+A _capsule folder can also be generated by running jekyll gemini - only Static files and Gemtext source files are included - markdown Pages and Documents are ignored.
+
+The built _capsule folder can then be uploaded to a Geminispace hosting service.
+
+NOTE: This is the first release and very much still Alpha at the moment
+
+## Installation
+
+Add the gem to your Gemfile
+
+```ruby
+# Gemfile
+
+gem 'jekyll-gemini'
+```
+
+Then install the gems,
+
+```bash
+bundle install
+```
+
+## Layouts
+
+Next you need to add layouts for the Gemini capsule - these go in a _gemini_layouts folder, and need to be Gemtext equivalents of the HTML layouts you will already have, eg using liquid to embed content within the Gemtext layouts.
+
+These use liquid tags the same as html layouts but are likely to be very simple, eg, _gemini_layouts/default.gmi might be -:
+
+```gemtext
+# {{ site.title }}
+
+{{ content }}
+```
+
+## Pages
+
+Jekyll relies on HTML files with liquid tags embedded within to generate the index pages. There are two ways to extend this
+
+### Option 1 - use Gemtext for index pages
+
+If your requirements are simple you may be able to convert your index.html to index.gmi and use the same page for both Website and Capsule
+
+### Option 2 - separate index pages for Website and Capsule
+
+If you need to make fuller use of HTML features in your index.html, you can keep your existing index.html - this will be ignore when building the Geminispace capsule.
+
+You will need to add an index.gmi, but mark this to target just the Capsule (otherwise you'll end up with both index.html and index.gmi included in your website)
+
+```gemtext
+---
+layout: default
+target: capsule
+---
+{% for post in site.posts limit:1 %}
+# {{ post.title }}
+{{ post.date | date: "%b %-d, %Y" }}{% if post.author %} • {{ post.author }}{% endif %}{% if page.meta %} • {{ page.meta }}{% endif %}
+{{ post.content }}
+{% endfor %}
+{% for post in site.posts offset:1 %}
+=> {{ post.url }} {{ post.title }}
+## {{ post.title }}
+{{ post.date | date: "%b %-d, %Y" }}{% if post.author %} • {{ post.author }}{% endif %}{% if page.meta %} • {{ page.meta }}{% endif %}
+{{ post.excerpt }}
+=> {{ post.url }} Read More
+{% endfor %}
+```
+
+## Links
+
+=> https://gemini.circumlunar.space/docs/gemtext.gmi Gemtext docs
+=> https://gemini.circumlunar.space/ About Gemini
+
+## To do
+
+1. Add RSS/Atom generation - this seems common in Geminispace, currently generators are just disabled when building the Capsule
+2. Add specs
+
+## Problems
+
+Please raise an issue on GitHub - https://github.com/jebw/jekyll-gemini/issues

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-gemini.gemspec

@@ -0,0 +1,42 @@
+# 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-gemini'
+  gem.version     = '0.1.0'
+  gem.summary     = 'Jekyll plugin to publish to Geminispace'
+  gem.description = <<~DESCRIPTION
+    Plugin for Jekyll to publish your Jekyll site to both the Web and
+    Geminispace from the same set of source Pages and Posts
+  DESCRIPTION
+  gem.authors     = ['Jeremy Wilkins']
+  gem.email       = ['jeb@jdwilkins.co.uk']
+  gem.homepage    = 'https://github.com/jebw/jekyll-gemini'
+  gem.license     = 'MIT'
+  gem.metadata    = {
+    'rubygems_mfa_required' => 'true'
+  }
+
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR).reject do |f|
+                        f.match %r{^(\.|spec)}
+                      end
+  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 'jekyll', '>= 3.7', '< 5.0'
+  gem.add_dependency 'jekyll-gemtext', '~> 0.1'
+
+  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/jekyll-gemini.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'jekyll_gemini'
+require 'jekyll_gemini/command'
+require 'jekyll_gemini/configuration'
+require 'jekyll_gemini/capsule'
+require 'jekyll_gemini/converter'
+require 'jekyll_gemini/fixes'
+require 'jekyll_gemini/publisher'

data/lib/jekyll_gemini/capsule.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module JekyllGemini
+  class Capsule < Jekyll::Site
+    def setup
+      super
+
+      self.converters = [Converter.new(config)]
+      self.generators = []
+    end
+
+    def publisher
+      @publisher ||= Publisher.new(self)
+    end
+  end
+end

data/lib/jekyll_gemini/command.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module JekyllGemini
+  class Command < Jekyll::Command
+    class << self
+      def init_with_program(prog)
+        prog.command(:gemini) do |c|
+          c.syntax "gemini [options]"
+          c.description 'Build the Gemini capsule'
+
+          add_build_options(c)
+
+          c.action do |_, options|
+            options["serving"] = false
+            process_with_graceful_fail(c, options, self)
+          end
+        end
+
+        def process(options)
+          # Adjust verbosity quickly
+          Jekyll.logger.adjust_verbosity(options)
+
+          options = configuration_from_options(options)
+          capsule = Capsule.new(options)
+
+          if options.fetch("skip_initial_build", false)
+            Jekyll.logger.warn "Build Warning:", "Skipping the initial build." \
+                               " This may result in an out-of-date site."
+          else
+            build(capsule, options)
+          end
+        end
+
+        def build(site, options)
+          t = Time.now
+          source      = File.expand_path(options["source"])
+          destination = File.expand_path(options["destination"])
+          incremental = options["incremental"]
+          Jekyll.logger.info "Source:", source
+          Jekyll.logger.info "Destination:", destination
+          Jekyll.logger.info "Incremental build:",
+                             (incremental ? "enabled" : "disabled. Enable with --incremental")
+          Jekyll.logger.info "Generating..."
+          process_site(site)
+          Jekyll.logger.info "", "done in #{(Time.now - t).round(3)} seconds."
+        end
+
+        def configuration_from_options(options)
+          return options if options.is_a?(Jekyll::Configuration)
+
+          Configuration.build(options)
+        end
+      end
+    end
+  end
+end

data/lib/jekyll_gemini/configuration.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module JekyllGemini
+  class Configuration
+    CAPSULE_DEFAULTS = {
+      'layouts_dir' => '_gemini_layouts',
+      'destination' => File.join(Dir.pwd, '_capsule'),
+      'theme' => nil
+    }.freeze
+
+    CAPSULE_DEFAULT_EXCLUDES = %w[css js fonts].freeze
+
+    class << self
+      def build(override)
+        Jekyll.configuration(override)
+              .tap(&method(:add_capsule_defaults))
+              .tap(&method(:add_capsule_specific_keys))
+              .tap(&method(:add_capsule_excludes))
+      end
+
+      private
+
+      def add_capsule_defaults(config)
+        config.merge!(CAPSULE_DEFAULTS)
+      end
+
+      def add_capsule_specific_keys(config)
+        capsule_keys = (config['capsule'] || {}).dup
+        capsule_keys.delete('exclude')
+
+        config.merge!(capsule_keys)
+      end
+
+      def add_capsule_excludes(config)
+        excludes = (config['capsule'] || {})['exclude']
+        excludes ||= CAPSULE_DEFAULT_EXCLUDES
+
+        config['exclude'] ||= []
+        config['exclude'].concat(excludes).uniq!
+      end
+    end
+  end
+end

data/lib/jekyll_gemini/converter.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module JekyllGemini
+  class Converter
+    GEMTEXT_EXT = %w[.gmi .gmni .gemini].freeze
+
+    def initialize(_config); end
+
+    def matches(ext)
+      GEMTEXT_EXT.include?(ext)
+    end
+
+    def output_ext(_ext)
+      '.gmi'
+    end
+
+    # Passthrough without conversion
+    def convert(content)
+      content
+    end
+
+    def highlighter_prefix; end
+    def highlighter_suffix; end
+  end
+end

data/lib/jekyll_gemini/fixes.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module JekyllGemini
+  module Fixes
+    module Destination
+      def destination(*_args)
+        super.gsub(%r{/index.html\z}, "/index#{output_ext}")
+      end
+    end
+
+    module Publisher
+      def publisher
+        @publisher ||= ::JekyllGemini::Publisher.new(self)
+      end
+    end
+  end
+end
+
+Jekyll::Document.prepend JekyllGemini::Fixes::Destination
+Jekyll::Site.prepend JekyllGemini::Fixes::Publisher

data/lib/jekyll_gemini/publisher.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module JekyllGemini
+  class Publisher < ::Jekyll::Publisher
+    def publish?(item)
+      super && compatible_with_site?(item) && targetted_at_site?(item)
+    end
+
+    private
+
+    def compatible_with_site?(item)
+      @site.is_a?(Capsule) ? gemtext?(item) : true
+    end
+
+    def gemtext?(item)
+      Converter::GEMTEXT_EXT.include?(item.extname)
+    end
+
+    def targetted_at_site?(item)
+      case item.data.fetch('target', nil)
+      when 'capsule' then @site.is_a?(Capsule)
+      when 'site' then !@site.is_a?(Capsule)
+      else true
+      end
+    end
+  end
+end

data/lib/jekyll_gemini.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'jekyll-gemtext'
+require 'jekyll_gemini/command'
+require 'jekyll_gemini/configuration'
+require 'jekyll_gemini/capsule'
+require 'jekyll_gemini/converter'
+require 'jekyll_gemini/fixes'
+require 'jekyll_gemini/publisher'

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-gemini
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Wilkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-12-28 00:00:00.000000000 Z
+dependencies:
+- !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: :runtime
+  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: jekyll-gemtext
+  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: 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: |
+  Plugin for Jekyll to publish your Jekyll site to both the Web and
+  Geminispace from the same set of source Pages and Posts
+email:
+- jeb@jdwilkins.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.gmi
+- Rakefile
+- jekyll-gemini.gemspec
+- lib/jekyll-gemini.rb
+- lib/jekyll_gemini.rb
+- lib/jekyll_gemini/capsule.rb
+- lib/jekyll_gemini/command.rb
+- lib/jekyll_gemini/configuration.rb
+- lib/jekyll_gemini/converter.rb
+- lib/jekyll_gemini/fixes.rb
+- lib/jekyll_gemini/publisher.rb
+homepage: https://github.com/jebw/jekyll-gemini
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+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: Jekyll plugin to publish to Geminispace
+test_files: []