mippin 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3f967bec91c709dda8dc7a3f2b5e5d6d1ef0fb2c5cff77c2cb02fbf42fc7954b
+  data.tar.gz: ae815ccf55d05894c2a305590043769a8912fa81aca2584e4e75142935b8e4aa
+SHA512:
+  metadata.gz: 39fd0d4a3b0fb2504611e65bcf87b723ceca82f9de6afa741edc972a4c372aa0d4699c3462e43be8712631d2b95b532e6cd7eb4a9ed3f65284c4da4627827d64
+  data.tar.gz: 58f2c235d42e6454c669068f6cf3a03b14d1a3fe076318dd52d34253648263f9a055d101a679eb69ac62ee78dd595731a54460bfa7c930b035a48e34244a6842

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+  SuggestExtensions: false
+
+Metrics/BlockLength:
+  Max: 1024
+
+Metrics/MethodLength:
+  Max: 1024
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,114 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a
+Changelog](https://keepachangelog.com/en/1.1.0/), and this project
+adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+Versions 0.6.0 and above were released by Rory D. under the [mippin
+gem](https://rubygems.org/gems/mippin)(https://git.grovest.io/rory/mippin).
+
+Versions 0.5.0 and under were realesed by [Marcus Stollsteimer] under
+the [lanyon
+gem](https://rubygems.org/gems/lanyon)(https://github.com/stomar/lanyon).
+
+This file used to be called `History.md`.
+
+## [0.6.0] - 2025-04-09
+
+### Added
+
+- Support for the latest versions of
+  [rack](https://rubygems.org/gems/rack).
+
+### Fixed
+
+- A failing test, that was expecting 'application/javascript' instead of
+  'text/javascript'.
+- Various linter errors.
+
+### Changed
+
+- Forked mippin (https://rubygems.org/gems/mippin,
+  https://git.grovest.io/rory/mippin) from lanyon
+  (https://rubygems.org/gems/lanyon, https://github.com/stomar/lanyon).
+  See README.md for more details.
+- Updated any references from Lanyon/lanyon to Mippin/mippin.
+
+## 0.5.0
+
+- Require Ruby 3.1 or newer.
+- Improve code style.
+- Update README.
+
+## 0.4.4
+
+- Improve code style.
+- Update README.
+- Add CI workflow.
+- Move development dependencies from gemspec to Gemfile.
+- Add WEBrick as development dependency (for Ruby 3.0).
+
+## 0.4.3
+
+- Use Rack::ContentLength middleware to fix missing.
+  Content-Length headers for rack 2.1.0 and later.
+- Update development dependencies.
+
+## 0.4.2
+
+- Avoid deprecation warnings for minitest expectations.
+- Improve code style.
+
+## 0.4.1
+
+- Drop pessimistic constraint on Jekyll version.
+- Remove Jekyll cache directory after tests.
+- Let "clean" task remove Jekyll cache directory.
+- Add Jekyll cache directory to .gitignore.
+- Add magic comments for frozen string literals.
+
+## 0.4.0
+
+- Support .html extension stripping.
+
+## 0.3.4
+
+- Allow Rack 2.
+- Use Rack::Utils.unescape_path with Rack 2.
+- Update development dependencies.
+
+## 0.3.3
+
+- Use a nicer progress output format.
+
+## 0.3.2
+
+- Flush progress output before starting build.
+
+## 0.3.1
+
+- Do not set a Cache-Control header.
+
+## 0.3.0
+
+- Use ETag instead of Last-Modified for caching.
+- Allow Jekyll 3.
+- Provide a Lanyon.build method.
+
+## 0.2.3
+
+- Handle URLs with percent-encoded characters.
+
+## 0.2.2
+
+- Prevent CRLF conversion for served files by using File.binread.
+
+## 0.2.1
+
+- Sanitize path info to properly handle directory traversal.
+
+## 0.2.0
+
+- First gem release.

data/LICENSE

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2024 Marcus Stollsteimer
+Copyright (c) 2025 Rory Dudley
+
+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,70 @@
+# mippin
+
+Serve your [Jekyll](https://jekyllrb.com/) site as a
+[rack](https://github.com/rack/rack) application.
+
+This is a soft fork of [lanyon](https://github.com/stomar/lanyon), as
+that gem is, seemingly, no longer maintained (see:
+https://github.com/stomar/lanyon/issues/5). 
+
+A huge thank you to [Marcus Stollsteimer](https://github.com/stomar) for
+creating all the code underpinning this fork!
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add mippin
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install mippin
+```
+
+## Usage
+
+Once the the gem is installed in your Jekyll project, create a rackup
+file (`config.ru`) in the root of your project directory with the
+following:
+
+```ruby
+require "mippin"
+run Mippin.application
+```
+
+Now, build the site with:
+
+```shell
+jekyll build
+```
+
+Finally run the folling to start serving your site via rack:
+
+```shell
+bundle exec rackup config.ru
+```
+
+For more info, take a look at the demo site, inside the `demo/`
+directory of this repository. You can also use `rake demo` to serve the
+demo site (and `rake rm` in order to remove the files that `rake demo`
+generates).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake` to run the tests and linter. 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).
+
+## Contributing
+
+Please email your diffs inline to `rory AT mailbox DOT cat`.

data/Rakefile

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+require "fileutils"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]
+
+desc "Serve the demo site"
+task :demo do
+  Dir.chdir("demo") do
+    sh "rackup -p 4000 -I ../lib"
+  end
+end
+
+desc "Remove files generated by 'rake demo'"
+task :rm do
+  FileUtils.rm_rf("demo/_site")
+  FileUtils.rm_rf("demo/.jekyll-cache")
+end

data/demo/404.md

@@ -0,0 +1,11 @@
+---
+layout: default
+title:  "404: Not Found"
+permalink: 404.html
+---
+
+# 404: Not Found
+
+The requested page does not exist.
+
+[Go back to home page](/)

data/demo/_config.yml

@@ -0,0 +1,5 @@
+markdown:  kramdown
+permalink: pretty
+
+exclude:
+  - config.ru

data/demo/_layouts/default.html

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <link rel="stylesheet" type="text/css" href="/css/site.css">
+  {% if page.title != null %}
+  <title>{{ page.title }}</title>
+  {% else %}
+  <title>mippin demo</title>
+  {% endif %}
+</head>
+<body>
+  {{ content }}
+</body>
+</html>

data/demo/_layouts/post.html

@@ -0,0 +1,7 @@
+---
+layout: default
+---
+
+{{ content }}
+
+<p><a href="/">go back to home page</a></p>

data/demo/_posts/2015-11-05-hello-world.md

@@ -0,0 +1,8 @@
+---
+layout: post
+title:  hello world
+---
+
+# hello world!
+
+a demo blog post for mippin

data/demo/about/index.md

@@ -0,0 +1,10 @@
+---
+layout: default
+title:  about mippin
+---
+
+# about mippin
+
+mippin serves your Jekyll site as a rack application
+
+[go back to home page](/)

data/demo/config.ru

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "mippin"
+run Mippin.application

data/demo/css/site.css

@@ -0,0 +1,6 @@
+body {
+  background-color: #f0f0f0;
+  font-family: sans-serif;
+}
+
+.date { color: #808080; }

data/demo/index.md

@@ -0,0 +1,18 @@
+---
+layout: default
+---
+
+# mippin demo
+
+demo page for the mippin gem [read more...](about/)
+
+blog posts:
+
+<ul>
+  {% for post in site.posts %}
+  <li>
+    <span class="date">{{ post.date | date_to_string }}:</span>
+    <a href="{{ post.url }}">{{ post.title }}</a>
+  </li>
+  {% endfor %}
+</ul>

data/lib/mippin/application.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require "rack/mime"
+require "rack/request"
+require "rack/response"
+require "time"
+
+module Mippin
+  # Rack application that serves the Jekyll site.
+  #
+  # Not to be instantiated directly, use Mippin.application instead.
+  class Application
+    attr_reader :router
+
+    def initialize(router)
+      @router = router
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      endpoint = router.endpoint(request.path_info)
+
+      case endpoint
+      when :not_found
+        not_found_response
+      when :must_redirect
+        redirect_to_dir_response(request.path_info)
+      else
+        case request.request_method
+        when "HEAD", "GET"
+          response(endpoint)
+        when "OPTIONS"
+          [200, { "Allow" => "GET,HEAD,OPTIONS", "Content-Length" => "0" }, []]
+        else
+          not_allowed_response
+        end
+      end
+    end
+
+    private
+
+    def response(filename) # :nodoc:
+      response = Rack::Response.new(File.binread(filename))
+      response["Content-Type"] = media_type(filename)
+
+      response.finish
+    end
+
+    def html_response(body, status, headers = {}) # :nodoc:
+      response = Rack::Response.new(body, status, headers)
+      response["Content-Type"] = "text/html"
+
+      response.finish
+    end
+
+    def media_type(filename) # :nodoc:
+      extension = ::File.extname(filename)
+
+      Rack::Mime.mime_type(extension)
+    end
+
+    def html_wrap(title, content) # :nodoc:
+      <<~DOCUMENT
+        <!DOCTYPE html>
+        <html lang="en">
+        <head>
+          <meta charset="utf-8">
+          <title>#{title}</title></head>
+        <body>
+          #{content}
+        </body>
+        </html>
+      DOCUMENT
+    end
+
+    def default_404_body # :nodoc:
+      html_wrap("Error", "<p>404: Not Found</p>")
+    end
+
+    def custom_404_body # :nodoc:
+      router.custom_404_body
+    end
+
+    def not_found_response # :nodoc:
+      body = custom_404_body || default_404_body
+
+      html_response(body, 404)
+    end
+
+    def not_allowed_response # :nodoc:
+      body = html_wrap("Error", "<p>405: Method Not Allowed</p>")
+
+      html_response(body, 405)
+    end
+
+    def redirect_body(to_path) # :nodoc:
+      message = %(<p>Redirecting to <a href="#{to_path}">#{to_path}</a>.</p>)
+
+      html_wrap("Redirection", message)
+    end
+
+    def redirect_to_dir_response(from_path) # :nodoc:
+      location = from_path.dup
+      location << "/" unless location.end_with?("/")
+
+      cache_time = 3600
+
+      body = redirect_body(location)
+      headers = {
+        "Location" => location,
+        "Cache-Control" => "max-age=#{cache_time}, must-revalidate",
+        "Expires" => (Time.now + cache_time).httpdate
+      }
+
+      html_response(body, 301, headers)
+    end
+  end
+end

data/lib/mippin/backports.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module Mippin # :nodoc:
+  module Backports # :nodoc:
+    class Router
+      # Backport for Rack 1.x
+      module UnescapePath
+        def unescape_path(path)
+          URI::Parser.new.unescape(path)
+        end
+      end
+    end
+  end
+
+  Router.prepend Backports::Router::UnescapePath if Rack.release.start_with?("1.")
+end

data/lib/mippin/router.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "rack/utils"
+
+module Mippin
+  # Router class for Mippin applications.
+  class Router
+    attr_reader :root
+
+    # Creates a Router for the given root directory.
+    def initialize(root)
+      @root = File.expand_path(root)
+    end
+
+    # Returns the full file system path of the file corresponding to
+    # the given URL +path+, or
+    #
+    # - +:must_redirect+ if the request must be redirected to +path/+,
+    # - +:not_found+ if no corresponding file exists.
+    #
+    # The return value is found as follows:
+    #
+    # 1. a +path/+ with a trailing slash is changed to +path/index.html+,
+    # 2. then, the method checks for an exactly corresponding file,
+    # 3. when +path+ does not exist but +path/index.html+ does,
+    #    a redirect will be indicated,
+    # 4. finally, when no exactly corresponding file or redirect
+    #    can be found, +path.html+ is tried.
+    def endpoint(path)
+      normalized = normalize_path_info(path)
+      fullpath = File.join(@root, normalized)
+
+      if FileTest.file?(fullpath)
+        fullpath
+      elsif needs_redirect_to_dir?(fullpath)
+        :must_redirect
+      elsif FileTest.file?(fullpath_html = "#{fullpath}.html")
+        fullpath_html
+      else
+        :not_found
+      end
+    end
+
+    # Returns the body of the custom 404 page or +nil+ if none exists.
+    def custom_404_body
+      filename = File.join(root, "404.html")
+
+      File.exist?(filename) ? File.binread(filename) : nil
+    end
+
+    private
+
+    def needs_redirect_to_dir?(fullpath) # :nodoc:
+      !fullpath.end_with?("/") && FileTest.file?("#{fullpath}/index.html")
+    end
+
+    def unescape_path(path) # :nodoc:
+      Rack::Utils.unescape_path(path)
+    end
+
+    def normalize_path_info(path_info) # :nodoc:
+      path = unescape_path(path_info)
+
+      path << "index.html" if path.end_with?("/")
+
+      Rack::Utils.clean_path_info(path)
+    end
+  end
+end

data/lib/mippin/version.rb

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

data/lib/mippin.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+# = mippin.rb
+#
+# See Mippin module for documentation.
+
+require "jekyll"
+require "rack"
+
+require "mippin/application"
+require "mippin/router"
+require "mippin/version"
+require "mippin/backports"
+
+# Mippin serves your Jekyll site as a Rack application.
+#
+# See Mippin.application for available initialization options.
+#
+# Further information on the Mippin library is available in the README file
+# or on the project home page: <https://git.grovest.io/rory/mippin>.
+#
+# This project is a soft fork of <https://github.com/stomar/lanyon>. I
+# have taken it over, because, seemingly, it is no longer maintained
+# (and there are issues with the allowed dependency versions with the
+# latest Jekyll updates). I would like to thank Marcus Stollsteimer for
+# their efforts, as they contributed basically all the code in this
+# repository. If Marcus ever comes back to update the package, I will
+# likely abandon this fork.
+#
+# https://github.com/stomar/lanyon/issues/5
+#
+# The only things I have done are:
+#   - update the name Lanyon/lanyon to Mippin/mippin,
+#   - bump the allowed versions for the rack dependency,
+#   - fix various linting errors,
+#   - fix a broken test case,
+#   - and, added this comment.
+module Mippin
+  # Builds the Jekyll site, prepares the middleware stack,
+  # and returns the Rack application.
+  #
+  # Options:
+  #
+  # +:config+::      use given config file (default: "_config.yml")
+  #
+  # +:skip_build+::  whether to skip site generation at startup
+  #                  (default: +false+)
+  #
+  # Other options are passed on to Jekyll::Site.
+  #
+  # Returns a Rack application.
+  def self.application(options = {})
+    skip_build = options.fetch(:skip_build, default_options[:skip_build])
+
+    config = jekyll_config(options)
+
+    if skip_build
+      puts skip_build_warning
+    else
+      process(config)
+    end
+
+    destination = config["destination"]
+    router = Router.new(destination)
+
+    Rack::Builder.new do
+      use Rack::Head
+      use Rack::ContentLength
+      use Rack::ConditionalGet
+      use Rack::ETag, nil, nil
+
+      run Application.new(router)
+    end
+  end
+
+  # Builds the Jekyll site.
+  #
+  # Accepts the same options as ::application,
+  # except for the +:skip_build+ option which is ignored.
+  def self.build(options = {})
+    config = jekyll_config(options)
+
+    process(config)
+  end
+
+  # @private
+  def self.default_options # :nodoc:
+    { skip_build: false }
+  end
+
+  # @private
+  def self.jekyll_config(overrides = {}) # :nodoc:
+    overrides = overrides.dup
+    default_options.each_key { |key| overrides.delete(key) }
+
+    ::Jekyll.configuration(overrides)
+  end
+
+  # @private
+  def self.skip_build_warning # :nodoc:
+    "Build warning: Skipping the initial build."
+  end
+
+  # @private
+  #
+  # Wraps Jekyll::Site's process method that builds the site.
+  #
+  # Takes a Jekyll configuration hash as argument.
+  def self.process(config) # :nodoc:
+    site = ::Jekyll::Site.new(config)
+    puts "            Source: #{site.source}"
+    puts "       Destination: #{site.dest}"
+    puts " Generating site..."
+    $stdout.flush
+    site.process
+    puts "                    done."
+    $stdout.flush
+  end
+end

data/sig/mippin.rbs

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

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: mippin
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- Rory Dudley
+bindir: exe
+cert_chain: []
+date: 2025-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: |-
+  This is a fork of
+      https://rubygems.org/gems/lanyon, since it looks like it is no
+      longer being maintained.
+email:
+- rory@netc.lu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- demo/404.md
+- demo/_config.yml
+- demo/_layouts/default.html
+- demo/_layouts/post.html
+- demo/_posts/2015-11-05-hello-world.md
+- demo/about/index.md
+- demo/config.ru
+- demo/css/site.css
+- demo/index.md
+- lib/mippin.rb
+- lib/mippin/application.rb
+- lib/mippin/backports.rb
+- lib/mippin/router.rb
+- lib/mippin/version.rb
+- sig/mippin.rbs
+homepage: https://git.grovest.io/rory/mippin
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://git.grovest.io/rory/mippin
+  source_code_uri: https://git.grovest.io/rory/mippin
+  changelog_uri: https://git.grovest.io/rory/mippin/src/branch/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+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.6.2
+specification_version: 4
+summary: Serve your Jekyll site as a rack application
+test_files: []