parklife 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 716fff5f3d7ad38f43c2fd071de3a69dc58363b05fb7fd3d997311855a207f04
-  data.tar.gz: b153dc13fb74648185401f3a512c34eee2f0ad62659723937c0354d9c7547ecd
+  metadata.gz: c83a66e0d3fcb43a7687e99ed43267ac8998df9c6cb36cc066bdbce3128538ff
+  data.tar.gz: 0f2e982d4fc88b1389c26ae5335c5922744f3a86f100a3e0fe40a8883dcd06e7
 SHA512:
-  metadata.gz: 7a1a022c68a6a7c77277440c926cd430ebf857a7757f42eab76b8233af84bdc4dd9407952a9465720a6a74e43d7706b8acb41a25705ebb3d0e34c9a75a11b441
-  data.tar.gz: 80af344c3209f6a57f147714c789d6c3d21a42cd3131186e9dbebb0e267d19258cdb297f13f273baefdb4bbd4bcba955c2c1e726ee9e218d8febaf50ec4c26c8
+  metadata.gz: b7537ae0c2cf63a37d3710f2a70db51302c21f8ce117521f695165e4dd2874bff65d9522baacbe7b6f49397594aa4f889f2dab6a9b36415bffcee490f84dab1b
+  data.tar.gz: 71c26e2e286af0d8653b1e2166b2d00abbb52f16d4d3d582c3c7f799b9d5e92676d955877dd885df30f2e661063a53bf81dcddf0ef12d374daac78e2aa070b0b

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: benpickles

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

data/.github/workflows/tests.yml

@@ -3,52 +3,6 @@ name: Tests
 on: push
 
 jobs:
-  rails:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        rails:
-          - '7.0'
-          - '7.1'
-          - '7.2'
-          - '8.0'
-        ruby:
-          - '2.7'
-          - '3.0'
-          - '3.1'
-          - '3.2'
-          - '3.3'
-          - '3.4'
-        exclude:
-          # Rails 8.0 requires Ruby 3.2.
-          - rails: '8.0'
-            ruby: '3.1'
-          - rails: '8.0'
-            ruby: '3.0'
-          - rails: '8.0'
-            ruby: '2.7'
-
-          # Rails 7.2 requires Ruby 3.1.
-          - rails: '7.2'
-            ruby: '3.0'
-          - rails: '7.2'
-            ruby: '2.7'
-
-          # Rails 7.0 doesn't work out of the box with Ruby 3.4.
-          - rails: '7.0'
-            ruby: '3.4'
-    env:
-      BUNDLE_GEMFILE: gemfiles/rails_${{ matrix.rails }}.gemfile
-    name: Rails (Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }})
-    steps:
-    - uses: actions/checkout@v4
-    - uses: ruby/setup-ruby@v1
-      with:
-        bundler-cache: true
-        ruby-version: ${{ matrix.ruby }}
-    - run: bundle exec rspec --pattern "spec/**/*rails*"
-
   rspec:
     runs-on: ubuntu-latest
     strategy:
@@ -68,7 +22,7 @@ jobs:
       with:
         bundler-cache: true
         ruby-version: ${{ matrix.ruby }}
-    - run: bundle exec rspec --exclude-pattern "spec/**/*rails*,spec/**/*sinatra*"
+    - run: bundle exec rspec --exclude-pattern "spec/**/*sinatra*"
 
   rubocop:
     runs-on: ubuntu-latest
@@ -99,7 +53,7 @@ jobs:
           - '4.1'
     env:
       BUNDLE_GEMFILE: gemfiles/sinatra_${{ matrix.sinatra }}.gemfile
-    name: Rails (Ruby ${{ matrix.ruby }} / Sinatra ${{ matrix.sinatra }})
+    name: Ruby ${{ matrix.ruby }} / Sinatra ${{ matrix.sinatra }}
     steps:
     - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1

data/Appraisals

@@ -1,22 +1,5 @@
 # frozen_string_literal: true
 
-appraise 'rails_7.0' do
-  gem 'concurrent-ruby', '< 1.3.5'
-  gem 'rails', '~> 7.0.0'
-end
-
-appraise 'rails_7.1' do
-  gem 'rails', '~> 7.1.0'
-end
-
-appraise 'rails_7.2' do
-  gem 'rails', '~> 7.2.0'
-end
-
-appraise 'rails_8.0' do
-  gem 'rails', '~> 8.0.0'
-end
-
 appraise 'sinatra_3.x' do
   gem 'sinatra', '~> 3.0'
 end

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## Unreleased
+
+## Version 0.8.0 - 2025-09-08
+
+Note that **Parklife's Rails integration has been moved into a separate gem** with some additional functionality, [see the `parklife-rails` repo for more information](https://github.com/benpickles/parklife-rails).
+
+## 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>

data/README.md

@@ -12,38 +12,36 @@ Add Parklife to your application's Gemfile and run bundle install.
 gem 'parklife'
 ```
 
-Now generate a Parkfile configuration file and build script. Include some Rails- or Sinatra-specific settings by passing `--rails` or `--sinatra`, create a GitHub Actions workflow to generate your Parklife build and push it to GitHub Pages by passing `--github-pages`.
+Now generate a Parkfile configuration file and build script. Include some Rails- or Sinatra-specific settings by passing `--rails` or `--sinatra`, create a GitHub Actions workflow to generate your Parklife build and deploy it to GitHub Pages by passing `--github-pages`.
 
 ```
 $ bundle exec parklife init
 ```
 
-## How to use Parklife with Rails
+## How to use Parklife
+
+> [!NOTE]
+> See the [`parklife-rails` repository](https://github.com/benpickles/parklife-rails) for how to use Parklife with Rails.
 
 Parklife is configured with a file called `Parkfile` in the root of your project, here's an example `Parkfile` for an imaginary Rails app:
 
 ```ruby
-# Load Parklife's Rails-specific integration which, among other things, allows
-# you to use URL helpers within the `routes` block below.
-require 'parklife/rails'
-
-# Load the Rails application, this gives you full access to the application's
-# environment from this file - using models for example.
-require_relative 'config/environment'
+# Assuming your Rack app lives in ./app.rb:
+require_relative 'app'
 
 Parkfile.application.routes do
   # Start from the homepage and crawl all links.
   root crawl: true
 
   # Some extra paths that aren't discovered while crawling.
-  get feed_path(format: :atom)
-  get sitemap_path(format: :xml)
+  get '/feed.atom'
+  get '/sitemap.xml'
 
   # A couple more hidden pages.
-  get easter_egg_path, crawl: true
+  get '/easter_egg', crawl: true
 
   # Services typically allow a custom 404 page.
-  get '404.html'
+  get '/404.html'
 end
 ```
 
@@ -76,11 +74,11 @@ build/feed.atom
 build/sitemap.xml
 ```
 
-Parklife doesn't know about assets (images, CSS, etc) so you likely also need to generate those and copy them to the build directory, see the [Rails example's full build script](examples/rails/bin/static-build) for how you might do this.
+Parklife doesn't know about assets (images, CSS, etc) so you likely also need to generate those and copy them to the build directory.
 
 ## More examples
 
-Take a look at the [Rails](examples/rails/Parkfile), [Rack](examples/rack/Parkfile) and [Sinatra](examples/sinatra/Parkfile) working examples within this repository.
+Take a look at the [`parklife-rails` example app](https://github.com/benpickles/parklife-rails/tree/main/example-app), and the [Rack](examples/rack/Parkfile) and [Sinatra](examples/sinatra/Parkfile) working examples within this repository.
 
 ## Configuration
 
@@ -110,7 +108,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/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

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

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/templates/Parkfile.erb

@@ -1,5 +1,6 @@
 <% if options[:rails] -%>
-require 'parklife/rails'
+# Load your application, this activates the Parklife/Rails integration and gives
+# you access to route helpers and models in this file.
 require_relative 'config/environment'
 <% else -%>
 <% if options[:sinatra] -%>

data/lib/parklife/templates/static_build.erb

@@ -3,9 +3,15 @@
 set -eu
 
 <% if options[:rails] -%>
-# Run the app in production mode to ensure correct asset URLs are generated etc.
+# Run the app in production mode to ensure correct asset URLs are generated.
 export RAILS_ENV=production
+
+# Prevent most logs from outputting to stdout during a build.
+export RAILS_LOG_LEVEL=warn
+
+# Enable precompiling assets.
 export SECRET_KEY_BASE=dummy
+export SECRET_KEY_BASE_DUMMY=1
 
 # If your Rails app uses ActiveRecord then this is a good point to create and
 # seed the database from db/seeds.rb.

data/lib/parklife/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: parklife
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Ben Pickles
 bindir: exe
 cert_chain: []
-date: 2025-02-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -58,6 +58,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".github/workflows/examples.yml"
 - ".github/workflows/tests.yml"
 - ".gitignore"
@@ -73,10 +74,6 @@ files:
 - bin/console
 - bin/setup
 - exe/parklife
-- gemfiles/rails_7.0.gemfile
-- gemfiles/rails_7.1.gemfile
-- gemfiles/rails_7.2.gemfile
-- gemfiles/rails_8.0.gemfile
 - gemfiles/sinatra_3.x.gemfile
 - gemfiles/sinatra_4.0.gemfile
 - gemfiles/sinatra_4.1.gemfile
@@ -87,7 +84,6 @@ 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
@@ -119,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Convert a Rack app into a static HTML site.
 test_files: []

data/gemfiles/rails_7.0.gemfile

@@ -1,13 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "appraisal"
-gem "bundler"
-gem "rake"
-gem "rspec"
-gem "rubocop"
-gem "concurrent-ruby", "< 1.3.5"
-gem "rails", "~> 7.0.0"
-
-gemspec path: "../"

data/gemfiles/rails_7.1.gemfile

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

data/gemfiles/rails_7.2.gemfile

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

data/gemfiles/rails_8.0.gemfile

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

data/lib/parklife/rails.rb

@@ -1,69 +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|
-        app.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
-
-  module RailsRouteSetRefinements
-    def default_url_options
-      Rails.application.default_url_options
-    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
-
-      Parklife.application.config.app = app
-
-      # Allow use of the Rails application's route helpers when defining
-      # Parklife routes in the block form.
-      Parklife.application.routes.singleton_class.include(RailsRouteSetRefinements)
-      Parklife.application.routes.singleton_class.include(app.routes.url_helpers)
-
-      Parklife.application.config.extend(RailsConfigRefinements)
-    end
-
-    config.after_initialize do |app|
-      # Read the Rails app's URL config and apply it to Parklife's so that the
-      # Rails config can be used as the single source of truth.
-      host, protocol = app.default_url_options.values_at(:host, :protocol)
-      protocol = 'https' if app.config.force_ssl
-      path = ActionController::Base.relative_url_root
-
-      Parklife.application.config.base.scheme = protocol if protocol
-      Parklife.application.config.base.host = host if host
-      Parklife.application.config.base.path = path if path
-    end
-  end
-end