parklife-sinatra 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f8fd65347eb1d8299aabdd1c8dbdaaf3c568b3a28a2399aa49bb5105e9f3c13
+  data.tar.gz: 1b8cb1e5e36b3de325a45d86d8f5aba9bf20c81a69bc46327ad5c9a857607f58
+SHA512:
+  metadata.gz: 1142f2dd06751a189e4712115748ae0bc9c29d4d28dbc2b23bf4d396d9dbad428683dbdc17c6c09c4d5ccd479f62242f1e5a6d0e4618a573b8b44776a3ad5608
+  data.tar.gz: 1ba39d822b5cf03756dfa94d0248cc13e9aafafe77c43b04ce83c47ad38d329ba304d587d2311eb335589b79fd5c372723bb7d67b7ff6088cb9165cd6f08adfc

data/Appraisals

@@ -0,0 +1,17 @@
+# 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
+
+appraise 'sinatra_4.2' do
+  gem 'sinatra', '~> 4.2.0'
+end

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## Unreleased
+
+## 0.2.0 - 2025-12-21
+
+- Initial release extracted from Parklife 0.8.0.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"parklife-sinatra" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["spideryoung@gmail.com"](mailto:"spideryoung@gmail.com").

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Ben Pickles
+
+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,89 @@
+# Parklife::Sinatra
+
+[![Ruby](https://github.com/benpickles/parklife-sinatra/actions/workflows/main.yml/badge.svg)](https://github.com/benpickles/parklife-sinatra/actions/workflows/main.yml)
+
+Parklife's Sinatra integration ensures Sinatra's host authorization is disabled during a `parklife` build.
+
+## Getting started
+
+Add the gem to your application's `Gemfile`:
+
+```bash
+gem 'parklife-sinatra'
+```
+
+Parklife is configured with a file called `Parkfile` in the root of your project, here's an example `Parkfile` for an imaginary Sinatra app:
+
+```ruby
+# Assuming your Sinatra app lives in ./app.rb:
+require_relative 'app'
+
+Parklife.application.configure do |config|
+  # For a Sinatra "classic" app:
+  config.app = Sinatra::Application
+
+  # Or for Sinatra modular style:
+  # config.app = App
+  #
+  # The Parklife extension must be registered for a modular style Sinatra app:
+  # App.register Parklife::Sinatra
+end
+
+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.atom'
+  get '/sitemap.xml'
+
+  # A couple more hidden pages.
+  get '/easter_egg', crawl: true
+
+  # Services typically allow a custom 404 page.
+  get '/404.html'
+end
+```
+
+Listing the routes included in the above Parklife application with `parklife routes` would output the following:
+
+```
+$ bundle exec parklife routes
+/             crawl=true
+/feed.atom
+/sitemap.xml
+/easter_egg   crawl=true
+/404.html
+```
+
+Now you can run `parklife build` which will fetch all the routes and save them to the `build` directory ready to be served as a static site. Inspecting the build directory might look like this:
+
+```
+$ find build -type f
+build/404.html
+build/about/index.html
+build/blog/index.html
+build/blog/2019/03/07/developers-developers-developers/index.html
+build/blog/2019/04/21/modern-life-is-rubbish/index.html
+build/blog/2019/05/15/introducing-parklife/index.html
+build/easter_egg/index.html
+build/easter_egg/surprise/index.html
+build/index.html
+build/location/index.html
+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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/benpickles/parklife-sinatra>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/benpickles/parklife-sinatra/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Parklife::Sinatra project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/benpickles/parklife-sinatra/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+task default: :test

data/gemfiles/sinatra_3.x.gemfile

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

data/gemfiles/sinatra_4.0.gemfile

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

data/gemfiles/sinatra_4.1.gemfile

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

data/gemfiles/sinatra_4.2.gemfile

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

data/lib/parklife/sinatra/build_integration.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'sinatra/base'
+
+module Parklife
+  module Sinatra
+    module BuildIntegration
+      def self.registered(app)
+        # Disable Rack::Protection::HostAuthorization middleware so that
+        # fetching a page with Parklife works in development without manual
+        # intervention.
+        #
+        # It's safe to disable this security feature at this point because it's
+        # only included when running a `parklife` command.
+        if app.settings.respond_to?(:host_authorization)
+          app.set(:host_authorization, permitted_hosts: [])
+        end
+      end
+    end
+  end
+end
+
+Sinatra.register Parklife::Sinatra::BuildIntegration

data/lib/parklife/sinatra/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Parklife
+  module Sinatra
+    VERSION = '0.2.0'
+  end
+end

data/lib/parklife/sinatra.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# Only require the build integration when running from a Parklife CLI command.
+#
+# This means that the gem can safely be included in the app's Gemfile without
+# applying any of its build-time tweaks.
+if defined?(Parklife::CLI)
+  require_relative 'sinatra/build_integration'
+end

data/lib/parklife-sinatra.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require_relative 'parklife/sinatra'

data/test/parklife/sinatra_test.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+require 'minitest/autorun'
+require 'minitest/pride'
+
+describe 'Parklife/Sinatra integration' do
+  def build_dir
+    'example-app/build'
+  end
+
+  def build_paths
+    Dir.glob('**/*', base: build_dir).select { |path|
+      File.file?(File.join(build_dir, path))
+    }.sort
+  end
+
+  def parklife(cmd)
+    Dir.chdir('example-app') do
+      capture_subprocess_io do
+        system("bundle exec parklife #{cmd}")
+      end
+    end
+  end
+
+  it 'host authorization middleware is disabled by default (i.e. it works)' do
+    parklife 'build'
+
+    assert_equal(
+      [
+        'index.html',
+        'hello/bar/index.html',
+        'hello/baz/index.html',
+        'hello/foo/index.html',
+      ].sort,
+      build_paths
+    )
+  end
+
+  it 'a custom base is interpreted correctly' do
+    parklife 'build --base /custom'
+    content = File.read(File.join(build_dir, 'index.html'))
+    assert_match %r{<a href="/custom/hello/foo">foo</a>}, content
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: parklife-sinatra
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Ben Pickles
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parklife
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+email:
+- spideryoung@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Appraisals
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/sinatra_3.x.gemfile
+- gemfiles/sinatra_4.0.gemfile
+- gemfiles/sinatra_4.1.gemfile
+- gemfiles/sinatra_4.2.gemfile
+- lib/parklife-sinatra.rb
+- lib/parklife/sinatra.rb
+- lib/parklife/sinatra/build_integration.rb
+- lib/parklife/sinatra/version.rb
+- test/parklife/sinatra_test.rb
+homepage: https://parklife.dev/sinatra
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/benpickles/parklife-sinatra/blob/main/CHANGELOG.md
+  homepage_uri: https://parklife.dev/sinatra
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/benpickles/parklife-sinatra
+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.6.9
+specification_version: 4
+summary: Sinatra integration for Parklife
+test_files: []