parklife 0.6.1 → 0.8.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c94649aadc5cc8fe79a9215950b461adfdf658ec56c396c42d3e69e9e6082d3
-  data.tar.gz: 54c2b0b8c4f8a8a5149d10b5f649d0009e9c9f32201d85acc8960bb595ea1e9c
+  metadata.gz: 5fee28b7e4a5dd221a56dc23db922173062e06b22888b2daf3a8bc05136525e2
+  data.tar.gz: '02408d7f687ea75db42814178c9ae168595f43d16e287ce30e558baa0abb5d9a'
 SHA512:
-  metadata.gz: 3e77cf82affdd32b75f747c2a9a4bc7aaf8df14d0b847470b241b1fb34e3f98b8aea13fdb55430caff5a420e28a5ba0dc6e80d32505e315428317fb42a5fd9d6
-  data.tar.gz: d80856454fb213de0ef217f18518d42bed3f0a4e57b870f22d2e8eaa72b1cec45123e0c84b38f875b6cd85a62f543381437c8e8200cff87a31f3b2683671f94e
+  metadata.gz: c6d913ec8bb296a0ad792b75dd4460a65cb94bf07a47d02db3f0db5c4ec5070de63033a8c4333eda08dfa1655c743f67bc615eef89ee5804d08502df75524ddb
+  data.tar.gz: 10fd0665002537622e0229dd0c366cd3ff32ad6234f18a0da80a8fda4cfc64c296d106346193e3ec1ef4aad1c0bd66eff17373a0a402dcffa33842a19d459ec5

data/.github/workflows/examples.yml

@@ -18,21 +18,6 @@ jobs:
     - run: test -f build/index.html
       working-directory: examples/rack
 
-  rails:
-    runs-on: ubuntu-latest
-    name: Rails example
-    steps:
-    - uses: actions/checkout@v3
-    - uses: ruby/setup-ruby@v1
-      with:
-        bundler-cache: true
-        ruby-version: '3.2'
-        working-directory: examples/rails
-    - run: bin/static-build
-      working-directory: examples/rails
-    - run: test -f build/index.html
-      working-directory: examples/rails
-
   roda:
     runs-on: ubuntu-latest
     name: Roda example
@@ -56,9 +41,9 @@ jobs:
     - uses: ruby/setup-ruby@v1
       with:
         bundler-cache: true
-        ruby-version: '2.7'
+        ruby-version: '3.4'
         working-directory: examples/sinatra
-    - run: bundle exec parklife build
+    - run: bin/static-build
       working-directory: examples/sinatra
     - run: test -f build/index.html
       working-directory: examples/sinatra

data/.github/workflows/tests.yml

@@ -6,6 +6,7 @@ jobs:
   rspec:
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
         ruby:
           - '2.7'
@@ -13,22 +14,50 @@ jobs:
           - '3.1'
           - '3.2'
           - '3.3'
-    name: Ruby ${{ matrix.ruby }} RSpec
+          - '3.4'
+    name: RSpec (Ruby ${{ matrix.ruby }})
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         bundler-cache: true
         ruby-version: ${{ matrix.ruby }}
-    - run: bundle exec rspec
+    - run: bundle exec rspec --exclude-pattern "spec/**/*sinatra*"
 
   rubocop:
     runs-on: ubuntu-latest
     name: RuboCop
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         bundler-cache: true
         ruby-version: '3.2'
     - run: bundle exec rubocop
+
+  sinatra:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
+          - '3.4'
+        sinatra:
+          - '3.x'
+          - '4.0'
+          - '4.1'
+    env:
+      BUNDLE_GEMFILE: gemfiles/sinatra_${{ matrix.sinatra }}.gemfile
+    name: Ruby ${{ matrix.ruby }} / Sinatra ${{ matrix.sinatra }}
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+        ruby-version: ${{ matrix.ruby }}
+    - run: bundle exec rspec --pattern "spec/**/*sinatra*"

data/.gitignore

@@ -4,6 +4,7 @@
 /_yardoc/
 /coverage/
 /doc/
+/gemfiles/*.gemfile.lock
 /pkg/
 /spec/examples.txt
 /spec/reports/

data/.rubocop.yml

@@ -2,6 +2,7 @@ AllCops:
   NewCops: enable
   Exclude:
     - examples/**/*
+    - gemfiles/*
     - vendor/**/*
   SuggestExtensions: false
   TargetRubyVersion: 2.5

data/Appraisals

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+appraise 'sinatra_3.x' do
+  gem 'sinatra', '~> 3.0'
+end
+
+appraise 'sinatra_4.0' do
+  gem 'sinatra', '~> 4.0.0'
+end
+
+appraise 'sinatra_4.1' do
+  gem 'sinatra', '~> 4.1.0'
+end

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## Unreleased
+
+## Version 0.8.0.beta1 - 2025-08-10
+
+- Remove out-of-the-box Rails integration in preparation for a separate gem. <https://github.com/benpickles/parklife/pull/131>
+- Include the port when automatically assigning the base from Rails `default_url_options`. <https://github.com/benpickles/parklife/pull/130>
+- Improve the HTTP redirect error message to include the request's full URL and redirect location. <https://github.com/benpickles/parklife/pull/129>
+- Empty the build directory instead of deleting it. <https://github.com/benpickles/parklife/pull/125>
+- Resurrect build callbacks (`before_build`/`after_build`). <https://github.com/benpickles/parklife/pull/124>
+
+## Version 0.7.0 - 2025-02-03
+
+- Add support for Rails 8 and add test infrastructure to ensure future compatibility with Rails 7.0, 7.1, and 8.0. <https://github.com/benpickles/parklife/pull/115>, <https://github.com/benpickles/parklife/pull/117>, <https://github.com/benpickles/parklife/pull/121>
+- Improve out-of-the-box compatibility with Rails by reading `default_url_options`, `relative_url_root`, and `force_ssl` settings on boot and applying them to Parklife's `config.base` (`force_ssl` has been set to `true` in `production.rb` since Rails 7.1). <https://github.com/benpickles/parklife/pull/118>
+- Improve out-of-the-box compatibility with Sinatra 4.1 which has host authorisation middleware enabled by default in development mode and would otherwise respond to Parklife requests with a 403 status. Additionally the generated Sinatra production build script now sets the environment variable `APP_ENV=production` to enable production mode. <https://github.com/benpickles/parklife/pull/123>, <https://github.com/benpickles/parklife/pull/122>
+- When discovering HTML links ignore `<a>` elements without an `href`. <https://github.com/benpickles/parklife/pull/107>
+
 ## Version 0.6.1 - 2024-08-23
 
 - Don't error when the public directory doesn't exist <https://github.com/benpickles/parklife/pull/105>

data/Gemfile

@@ -7,8 +7,8 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 # Specify your gem's dependencies in parklife.gemspec
 gemspec
 
+gem 'appraisal'
 gem 'bundler'
-gem 'rails'
 gem 'rake'
 gem 'rspec'
 gem 'rubocop'

data/README.md

@@ -110,7 +110,7 @@ Parklife.application.config.nested_index = false
 
 ### Changing the build output directory
 
-The build directory shouldn't exist and is destroyed and recreated before each build. Defaults to `build`.
+The build directory's contents are removed before each build. Defaults to `build`.
 
 ```ruby
 Parklife.application.config.build_dir = 'my/build/dir'

data/gemfiles/sinatra_3.x.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "bundler"
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "sinatra", "~> 3.0"
+
+gemspec path: "../"

data/gemfiles/sinatra_4.0.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "bundler"
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "sinatra", "~> 4.0.0"
+
+gemspec path: "../"

data/gemfiles/sinatra_4.1.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "bundler"
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "sinatra", "~> 4.1.0"
+
+gemspec path: "../"

data/lib/parklife/application.rb

@@ -13,16 +13,37 @@ module Parklife
     def initialize
       @config = Config.new
       @route_set = RouteSet.new
+      @after_build_callbacks = []
+      @before_build_callbacks = []
+    end
+
+    def after_build(&block)
+      @after_build_callbacks << block
+    end
+
+    def before_build(&block)
+      @before_build_callbacks << block
     end
 
     def build
       raise BuildDirNotDefinedError if config.build_dir.nil?
       raise RackAppNotDefinedError if config.app.nil?
 
-      FileUtils.rm_rf(config.build_dir)
-      Dir.mkdir(config.build_dir)
+      if Dir.exist?(config.build_dir)
+        FileUtils.rm_rf(Pathname.new(config.build_dir).children)
+      else
+        Dir.mkdir(config.build_dir)
+      end
+
+      @before_build_callbacks.each do |callback|
+        callback.call(self)
+      end
 
       crawler.start
+
+      @after_build_callbacks.each do |callback|
+        callback.call(self)
+      end
     end
 
     def configure

data/lib/parklife/browser.rb

@@ -18,6 +18,10 @@ module Parklife
       session.get(path, nil, env)
     end
 
+    def uri_for(path)
+      base.dup.tap { |uri| uri.path = path }
+    end
+
     private
       def set_env
         @env = {

data/lib/parklife/cli.rb

@@ -26,6 +26,7 @@ module Parklife
         ['nested_index', application.config.nested_index],
         ['on_404', application.config.on_404.inspect],
         ['parklife/rails', defined?(::Parklife::Railtie) ? 'enabled' : '-'],
+        ['parklife/sinatra', defined?(::Parklife::Sinatra) ? 'enabled' : '-'],
         ['reporter', reporter == $stdout ? '$stdout' : reporter],
       ])
     end

data/lib/parklife/crawler.rb

@@ -51,6 +51,12 @@ module Parklife
         case response.status
         when 200
           # Continue processing the route.
+        when 301, 302
+          raise HTTPRedirectError.new(
+            response.status,
+            browser.uri_for(route.path),
+            response.headers['location']
+          )
         when 404
           case config.on_404
           when :warn

data/lib/parklife/errors.rb

@@ -11,6 +11,12 @@ module Parklife
     end
   end
 
+  class HTTPRedirectError < Error
+    def initialize(status, from, to)
+      super %Q(#{status} redirect from "#{from}" to "#{to}")
+    end
+  end
+
   class ParkfileLoadError < Error
     def initialize(path)
       super %Q(Cannot load Parkfile "#{path}")

data/lib/parklife/sinatra.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'sinatra/base'
+
+module Parklife
+  module Sinatra
+    def self.registered(app)
+      # Disable Rack::Protection::HostAuthorization middleware so that fetching
+      # a page with Parklife works in development. It's safe to do here because
+      # it will only be executed when this file is explicitly required in a
+      # Parkfile and not in general when the app is running in a web server.
+      if app.settings.respond_to?(:host_authorization)
+        app.set(:host_authorization, permitted_hosts: [])
+      end
+    end
+  end
+end
+
+Sinatra.register Parklife::Sinatra

data/lib/parklife/templates/Parkfile.erb

@@ -2,7 +2,11 @@
 require 'parklife/rails'
 require_relative 'config/environment'
 <% else -%>
-# Assuming your Rack app lives in ./app.rb:
+<% if options[:sinatra] -%>
+require 'parklife/sinatra'
+
+<% end -%>
+# Assuming your <%= options[:sinatra] ? 'Sinatra' : 'Rack' %> app lives in ./app.rb:
 require_relative 'app'
 <% end -%>
 
@@ -11,8 +15,9 @@ Parklife.application.configure do |config|
   # For a Sinatra "classic" app:
   config.app = Sinatra::Application
   #
-  # Or for Sinatra modular style:
+  # For a modular-style Sinatra app the Parklife extension must be explicitly registered:
   # config.app = App
+  # App.register Parklife::Sinatra
 
 <% elsif !options[:rails] -%>
   config.app = App

data/lib/parklife/templates/github_pages.yml

@@ -15,11 +15,11 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         bundler-cache: true
-    - uses: actions/configure-pages@v3
+    - uses: actions/configure-pages@v5
       id: pages
 
       # Build with Parklife and use its GitHub Pages URL (either its custom
@@ -27,7 +27,7 @@ jobs:
     - run: bin/static-build --base "${{ steps.pages.outputs.base_url }}"
 
     - name: Upload artifact
-      uses: actions/upload-pages-artifact@v1
+      uses: actions/upload-pages-artifact@v3
       if: github.ref == 'refs/heads/main' # Only upload on main branch.
       with:
         path: build/
@@ -45,4 +45,4 @@ jobs:
     steps:
     - name: Deploy to GitHub Pages
       id: deployment
-      uses: actions/deploy-pages@v1
+      uses: actions/deploy-pages@v4

data/lib/parklife/templates/static_build.erb

@@ -3,8 +3,7 @@
 set -eu
 
 <% if options[:rails] -%>
-# You probably need to run the app in production mode to ensure the correct
-# asset URLs are referenced.
+# Run the app in production mode to ensure correct asset URLs are generated etc.
 export RAILS_ENV=production
 export SECRET_KEY_BASE=dummy
 
@@ -17,6 +16,10 @@ export SECRET_KEY_BASE=dummy
 # missing assets in production.
 bundle exec rails assets:precompile
 
+<% elsif options[:sinatra] -%>
+# Run the app in production mode.
+export APP_ENV=production
+
 <% end -%>
 # Build with Parklife - and forward arguments sent to this script.
 bundle exec parklife build "$@"

data/lib/parklife/utils.rb

@@ -39,7 +39,7 @@ module Parklife
 
     def scan_for_links(html)
       doc = Nokogiri::HTML.parse(html)
-      doc.css('a').each do |a|
+      doc.css('a[href]').each do |a|
         uri = URI.parse(a[:href])
 
         # Don't visit a URL that belongs to a different domain - for now this is

data/lib/parklife/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Parklife
-  VERSION = '0.6.1'
+  VERSION = '0.8.0.beta1'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: parklife
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.8.0.beta1
 platform: ruby
 authors:
 - Ben Pickles
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-23 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -52,7 +51,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - spideryoung@gmail.com
 executables:
@@ -65,6 +63,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -74,6 +73,9 @@ files:
 - bin/console
 - bin/setup
 - exe/parklife
+- gemfiles/sinatra_3.x.gemfile
+- gemfiles/sinatra_4.0.gemfile
+- gemfiles/sinatra_4.1.gemfile
 - lib/parklife.rb
 - lib/parklife/application.rb
 - lib/parklife/browser.rb
@@ -81,9 +83,9 @@ files:
 - lib/parklife/config.rb
 - lib/parklife/crawler.rb
 - lib/parklife/errors.rb
-- lib/parklife/rails.rb
 - lib/parklife/route.rb
 - lib/parklife/route_set.rb
+- lib/parklife/sinatra.rb
 - lib/parklife/templates/Parkfile.erb
 - lib/parklife/templates/github_pages.yml
 - lib/parklife/templates/static_build.erb
@@ -98,7 +100,6 @@ metadata:
   homepage_uri: https://parklife.dev
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/benpickles/parklife
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,8 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
-signing_key:
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Convert a Rack app into a static HTML site.
 test_files: []

data/lib/parklife/rails.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails'
-
-module Parklife
-  module RailsConfigRefinements
-    # When setting Parklife's base also configure the Rails app's
-    # default_url_options and relative_url_root to match.
-    def base=(value)
-      super.tap { |uri|
-        Rails.application.default_url_options = {
-          host: Utils.host_with_port(uri),
-          protocol: uri.scheme,
-        }
-
-        base_path = !uri.path.empty? && uri.path != '/' ? uri.path : nil
-        ActionController::Base.relative_url_root = base_path
-      }
-    end
-  end
-
-  class Railtie < Rails::Railtie
-    initializer 'parklife.disable_host_authorization' do |app|
-      # The offending middleware is included in Rails (6+) development mode and
-      # rejects a request with a 403 response if its host isn't present in the
-      # allowlist (a security feature). This prevents Parklife from working in
-      # a Rails app out of the box unless you manually add the expected
-      # Parklife base to the hosts allowlist or set it to nil to disable it -
-      # both of which aren't great because they disable the security feature
-      # whenever the development server is booted.
-      #
-      # https://guides.rubyonrails.org/configuring.html#actiondispatch-hostauthorization
-      #
-      # However it's safe to remove the middleware at this point because it
-      # won't be executed in the normal Rails development flow, only via a
-      # Parkfile when parklife/rails is required.
-      if defined?(ActionDispatch::HostAuthorization)
-        app.middleware.delete(ActionDispatch::HostAuthorization)
-      end
-    end
-
-    config.after_initialize do
-      Parklife.application.config.app = Rails.application
-
-      # Allow use of the Rails application's route helpers when defining
-      # Parklife routes in the block form.
-      Parklife.application.routes.singleton_class.include(Rails.application.routes.url_helpers)
-
-      Parklife.application.config.extend(RailsConfigRefinements)
-    end
-  end
-end