parklife 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97be6505f9a1ac2cf9b5b2f5864b6a73fbf110c173043b991a32b04892c8e865
-  data.tar.gz: edd6ec37ae40bc0250bbb43ddaa9020a88d6e0884d0957dcb0888a0ab15cb9d0
+  metadata.gz: 6faa171e9fe5ae60f6285af884bbd5b19b96942dc5fefb106912c89137a2ff78
+  data.tar.gz: 8ffe432c9e9e5f374c61d4f3c3a6123532e699c9d4d9cfc5be87524d778e8008
 SHA512:
-  metadata.gz: 80877ef06ba4a6cde8dea7ea58f1bea6ee02a7bba095a26f3644454ecdfa7b567895a00d6b55b53fb0b3d1c365b3d93ee3c0fdca137130a85e0f612e15aea782
-  data.tar.gz: ce193737f065bcbb63d0350c5e01001c2b83a56e313d8fc2e3994ce653efd8937f7f83695589134d1f12f2cb2e0ce07df76601d102add3f911bfa313c608e7d2
+  metadata.gz: 48d14b37c34b2ed4c35fd73f7d53628962440ede84b0b64b65b33d1e02d3db787aa321ff45b637d4f9e3d80386c09ebaada5cd27fd78165beeaf09ce4c8a10ef
+  data.tar.gz: 6b30a2348133bd7ca05c19740f4cd73a8bf3de59b05f8a34d1c04d8008df79df3c2a8a42f5c66bf2376030c96413c5b99075e0ef17489685b229fdff6511436c

data/.github/workflows/tests.yml

@@ -26,9 +26,9 @@ jobs:
     - uses: ruby/setup-ruby@v1
       with:
         bundler-cache: true
-        ruby-version: '2.7'
+        ruby-version: '3.2'
         working-directory: examples/rails
-    - run: ./parklife-build
+    - run: bin/static-build
       working-directory: examples/rails
     - run: test -f build/index.html
       working-directory: examples/rails
@@ -65,3 +65,14 @@ jobs:
         bundler-cache: true
         ruby-version: ${{ matrix.ruby }}
     - run: bundle exec rspec
+
+  rubocop:
+    runs-on: ubuntu-latest
+    name: RuboCop
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+        ruby-version: '3.2'
+    - run: bundle exec rubocop

data/.rubocop.yml

@@ -0,0 +1,30 @@
+AllCops:
+  NewCops: enable
+  Exclude:
+    - examples/**/*
+    - vendor/**/*
+  SuggestExtensions: false
+  TargetRubyVersion: 2.5
+
+Layout:
+  Enabled: false
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Naming:
+  Enabled: false
+
+Style:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  Exclude:
+    - spec/**/*

data/CHANGELOG.md

@@ -1,20 +1,34 @@
+## Version 0.5.0 - 2023-03-12
+
+- RuboCop. <https://github.com/benpickles/parklife/pull/87>
+- Allow passing a --base to all `parklife` commands. <https://github.com/benpickles/parklife/pull/85>
+- Configure Rails default_url_options and relative_url_root when setting Parklife base. <https://github.com/benpickles/parklife/pull/85>
+- Add `parklife get PATH` command to fetch and output a path. <https://github.com/benpickles/parklife/pull/83>
+- Add a `parklife init` command to create a starter Parkfile and friends. <https://github.com/benpickles/parklife/pull/82>
+- Fix the HOST header for a non-standard port. <https://github.com/benpickles/parklife/pull/81>
+
+## Version 0.4.0 - 2023-03-01
+
+- Add a `parklife --version` command. <https://github.com/benpickles/parklife/pull/80>
+- No need to `require parklife` from the Parkfile. <https://github.com/benpickles/parklife/pull/79>
+
 ## Version 0.3.0 - 2023-02-26
 
-- Allow overriding `config.base` from the CLI build command with the `--base` option.
-- Support mounting the app at a path.
-- Remove Capybara and use Rack::Test directly.
-- Rename `config.rack_app` to `config.app`.
-- Don't save the response when `on_404=:skip`.
-- More accurate progress dots.
-- Default `build_dir` to `build`.
-- Fix build paths when `build_dir` isn't a full path.
-- Ignore pathless links - for instance #fragments and mailto.
+- Allow overriding `config.base` from the CLI build command with the `--base` option. <https://github.com/benpickles/parklife/pull/78>
+- Support mounting the app at a path. <https://github.com/benpickles/parklife/pull/78>
+- Remove Capybara and use Rack::Test directly. <https://github.com/benpickles/parklife/pull/78>
+- Rename `config.rack_app` to `config.app`. <https://github.com/benpickles/parklife/pull/78>
+- Don't save the response when `on_404=:skip`. <https://github.com/benpickles/parklife/pull/77>
+- More accurate progress dots. <https://github.com/benpickles/parklife/pull/75>
+- Default `build_dir` to `build`. <https://github.com/benpickles/parklife/pull/73>
+- Fix build paths when `build_dir` isn't a full path. <https://github.com/benpickles/parklife/pull/73>
+- Ignore pathless links - for instance #fragments and mailto. <https://github.com/benpickles/parklife/pull/72>
 
 ## Version 0.2.0 - 2023-02-21
 
 - First official version hosted on [RubyGems.org](https://rubygems.org/gems/parklife).
-- Provide alternatives to blowing up if a 404 is encountered.
-- Add the ability to crawl a route by adding `crawl: true` to it.
+- Provide alternatives to blowing up if a 404 is encountered. <https://github.com/benpickles/parklife/pull/70>
+- Add the ability to crawl a route by adding `crawl: true` to it. <https://github.com/benpickles/parklife/pull/65>
 
 ## Version 0.1.0 - 2019-04-26
 

data/Gemfile

@@ -1,6 +1,13 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in parklife.gemspec
 gemspec
+
+gem 'bundler'
+gem 'rake'
+gem 'rspec'
+gem 'rubocop'

data/README.md

@@ -4,7 +4,7 @@
 
 [Parklife](https://github.com/benpickles/parklife) is a Ruby library to render a Rack app (Rails/Sinatra/etc) to a static site so it can be served by [Netlify](https://www.netlify.com), [Now](https://zeit.co/now), [GitHub Pages](https://pages.github.com), S3, or another static server.
 
-## Installation
+## Getting started
 
 Add Parklife to your application's Gemfile and run bundle install.
 
@@ -12,6 +12,12 @@ 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`.
+
+```
+$ bundle exec parklife init
+```
+
 ## 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:
@@ -45,10 +51,10 @@ Listing the routes included in the above Parklife application with `parklife rou
 
 ```
 $ bundle exec parklife routes
-/	crawl=true
+/             crawl=true
 /feed.atom
 /sitemap.xml
-/easter_egg	crawl=true
+/easter_egg   crawl=true
 /404.html
 ```
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'parklife'

data/exe/parklife

@@ -1,3 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'parklife/cli'
 Parklife::CLI.start(ARGV)

data/lib/parklife/application.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'parklife/config'
 require 'parklife/crawler'
@@ -23,12 +25,17 @@ module Parklife
       crawler.start
     end
 
+    def configure
+      yield config
+    end
+
     def crawler
       @crawler ||= Crawler.new(config, @route_set)
     end
 
-    def configure
-      yield config
+    def load_Parkfile(path)
+      raise ParkfileLoadError.new(path) unless File.exist?(path)
+      load path
     end
 
     def routes(&block)

data/lib/parklife/browser.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require 'parklife/utils'
 require 'rack/test'
 
 module Parklife
@@ -7,16 +10,21 @@ module Parklife
     def initialize(app, base)
       @app = app
       @base = base
-      @env = {
-        'HTTP_HOST' => base.host,
-        'HTTPS' => base.scheme == 'https' ? 'on' : 'off',
-        script_name: base.path.chomp('/'),
-      }
       @session = Rack::Test::Session.new(app)
+      set_env
     end
 
     def get(path)
       session.get(path, nil, env)
     end
+
+    private
+      def set_env
+        @env = {
+          'HTTP_HOST' => Utils.host_with_port(base),
+          'HTTPS' => base.scheme == 'https' ? 'on' : 'off',
+          script_name: base.path.chomp('/'),
+        }
+      end
   end
 end

data/lib/parklife/cli.rb

@@ -1,40 +1,63 @@
+# frozen_string_literal: true
+
+require 'parklife'
 require 'thor'
 
 module Parklife
   class CLI < Thor
-    desc 'build', 'create a production build'
-    option :base, desc: 'set config.base at build-time - overrides the Parkfile setting'
-    def build
-      # Parkfile config overrides.
-      application.config.base = options[:base] if options[:base]
+    include Thor::Actions
+    source_root File.expand_path('templates', __dir__)
 
+    class_option :base, desc: 'Override config.base configured in the Parkfile'
+
+    desc 'build', 'Create a production build'
+    def build
       application.build
     end
 
-    desc 'routes', 'list all defined routes'
+    desc 'get PATH', 'Fetch PATH from the app and output its contents'
+    def get(path)
+      puts application.crawler.get(path).body
+    end
+
+    desc 'init', 'Generate a starter Parkfile and friends'
+    option :github_pages, desc: 'Generate a GitHub Actions workflow to deploy to GitHub Pages', type: :boolean
+    option :rails, desc: 'Include some Rails-specific settings', type: :boolean
+    option :sinatra, desc: 'Include some Sinatra-specific settings', type: :boolean
+    def init
+      template('Parkfile.erb', 'Parkfile')
+      template('static_build.erb', 'bin/static-build', mode: 0755)
+      copy_file('github_pages.yml', '.github/workflows/parklife.yml') if options[:github_pages]
+    end
+
+    desc 'routes', 'List all defined routes'
     def routes
-      application.routes.each do |route|
-        print route.path
-        print "\tcrawl=true" if route.crawl
-        puts
-      end
+      shell.print_table(
+        application.routes.map { |route|
+          [route.path, route.crawl ? "crawl=true" : nil]
+        }
+      )
+    end
+
+    map '--version' => :version
+    desc 'version', 'Output the current version of Parklife'
+    def version
+      puts Parklife::VERSION
     end
 
     private
       def application
-        @application ||= begin
-          # Reach inside the consuming app's directory to load Parklife and
-          # apply its config. It's only at this point that the
-          # Parklife::Application is defined.
-          load discover_Parkfile(Dir.pwd)
-
-          Parklife.application.config.reporter = $stdout
-          Parklife.application
-        end
-      end
+        @application ||= Parklife.application.tap { |app|
+          # Default output to stdout (can be overridden in the Parkfile).
+          app.config.reporter = $stdout
+
+          # Reach inside the consuming app's directory to apply its Parklife
+          # config.
+          app.load_Parkfile(File.join(Dir.pwd, 'Parkfile'))
 
-      def discover_Parkfile(dir)
-        File.expand_path('Parkfile', dir)
+          # Runtime overrides.
+          app.config.base = options[:base] if options[:base]
+        }
       end
   end
 end

data/lib/parklife/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'stringio'
 require 'uri'
 

data/lib/parklife/crawler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'parklife/browser'
 require 'parklife/route'
 require 'parklife/utils'
@@ -13,11 +15,15 @@ module Parklife
       @browser = Browser.new(config.app, config.base)
     end
 
+    def get(path)
+      browser.get(path)
+    end
+
     def start
       @routes = route_set.to_a
       @visited = Set.new
 
-      while route = @routes.shift
+      while (route = @routes.shift)
         processed = process_route(route)
         config.reporter.print('.') if processed
       end
@@ -40,7 +46,7 @@ module Parklife
 
         return false if already_processed
 
-        response = browser.get(route.path)
+        response = get(route.path)
 
         case response.status
         when 200
@@ -48,14 +54,14 @@ module Parklife
         when 404
           case config.on_404
           when :warn
-            $stderr.puts HTTPError.new(path: route.path, status: 404).message
+            $stderr.puts HTTPError.new(404, route.path).message
           when :skip
             return false
           else
-            raise HTTPError.new(path: route.path, status: 404)
+            raise HTTPError.new(404, route.path)
           end
         else
-          raise HTTPError.new(path: route.path, status: response.status)
+          raise HTTPError.new(response.status, route.path)
         end
 
         Utils.save_page(route.path, response.body, config)

data/lib/parklife/errors.rb

@@ -1,25 +1,25 @@
+# frozen_string_literal: true
+
 module Parklife
   Error = Class.new(StandardError)
   BuildDirNotDefinedError = Class.new(Error)
   RackAppNotDefinedError = Class.new(Error)
 
   class HTTPError < Error
-    def initialize(path:, status:)
-      @path = path
-      @status = status
+    def initialize(status, path)
+      super %Q(#{status} response from path "#{path}")
     end
+  end
 
-    def message
-      %Q(#{status} response from path "#{path}")
+  class ParkfileLoadError < Error
+    def initialize(path)
+      super %Q(Cannot load Parkfile "#{path}")
     end
-
-    private
-      attr_reader :path, :status
   end
 
   class RailsNotDefinedError < Error
-    def message
-      'Expected Rails to be defined, require config/environment before parklife.'
+    def initialize(msg = 'Expected Rails to be defined, require config/environment before parklife')
+      super
     end
   end
 end

data/lib/parklife/rails.rb

@@ -1,11 +1,29 @@
-require 'parklife/errors'
+# frozen_string_literal: true
 
 raise Parklife::RailsNotDefinedError unless defined?(Rails)
 
-require 'parklife'
+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,
+        }
 
-# Allow use of the consuming Rails application's route helpers from within the
-# block when defining Parklife routes.
-Parklife::RouteSet.include(Rails.application.routes.url_helpers)
+        base_path = !uri.path.empty? && uri.path != '/' ? uri.path : nil
+        ActionController::Base.relative_url_root = base_path
+      }
+    end
+  end
+end
 
 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(Parklife::RailsConfigRefinements)

data/lib/parklife/route.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Parklife
   class Route
     attr_reader :crawl, :path

data/lib/parklife/route_set.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 require_relative 'route'
 

data/lib/parklife/templates/Parkfile.erb

@@ -0,0 +1,48 @@
+<% if options[:rails] -%>
+require_relative 'config/environment'
+require 'parklife/rails'
+<% else -%>
+# Assuming your Rack app lives in ./app.rb:
+require_relative 'app'
+<% end -%>
+
+Parklife.application.configure do |config|
+<% if options[:sinatra] -%>
+  # For a Sinatra "classic" app:
+  config.app = Sinatra::Application
+  #
+  # Or for Sinatra modular style:
+  # config.app = App
+
+<% elsif !options[:rails] -%>
+  config.app = App
+
+<% end -%>
+<% if options[:github_pages] -%>
+  # Serve trailing slash-less URLs from GitHub Pages.
+  config.nested_index = false
+
+<% end -%>
+  # See configuration options here:
+  # https://github.com/benpickles/parklife#configuration
+end
+
+Parklife.application.routes do
+  root crawl: true
+
+<% if options[:rails] -%>
+  # Add further paths not discovered by crawling from the root - Parklife's
+  # Rails integration lets you use the app's route helpers:
+  #
+  # get hidden_pages_path, crawl: true
+  # get feed_path(format: :atom)
+<% else -%>
+  # Add further paths not discovered by crawling from the root:
+  #
+  # get '/hidden/pages', crawl: true
+  # get '/feed.atom'
+<% end -%>
+
+  # Services typically allow a custom 404 page.
+  # get '/404.html'
+end

data/lib/parklife/templates/github_pages.yml

@@ -0,0 +1,48 @@
+name: Parklife
+
+on:
+  # Run on every push.
+  push:
+  # Allow manually triggering a build.
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+    - uses: actions/configure-pages@v3
+      id: pages
+
+      # Build with Parklife and use its GitHub Pages URL (either its custom
+      # domain or username.github.io/repository).
+    - run: bin/static-build --base "${{ steps.pages.outputs.base_url }}"
+
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v1
+      if: github.ref == 'refs/heads/main' # Only upload on main branch.
+      with:
+        path: build/
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.ref == 'refs/heads/main' # Only deploy on main branch.
+    concurrency:
+      group: deploy
+      cancel-in-progress: true
+    steps:
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v1

data/lib/parklife/templates/static_build.erb

@@ -0,0 +1,28 @@
+#!/usr/bin/env sh
+
+set -eu
+
+<% if options[:rails] -%>
+# You probably need to run the app in production mode to ensure the correct
+# asset URLs are referenced.
+export RAILS_ENV=production
+export SECRET_KEY_BASE=dummy
+
+# If your Rails app uses ActiveRecord then this is a good point to create and
+# seed the database from db/seeds.rb.
+# bundle exec rails db:setup
+
+# Generate production-optimised assets with Sprockets and friends. This must be
+# done before generating the Parklife build as Rails will blow up if it detects
+# missing assets in production.
+bundle exec rails assets:precompile
+
+<% end -%>
+# Build with Parklife - and forward arguments sent to this script.
+bundle exec parklife build "$@"
+
+# Copy all public resources to ./build.
+cp -R public/* build
+
+# List all files in the build (useful for debugging).
+find build -type f | sort

data/lib/parklife/utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'nokogiri'
 
@@ -21,6 +23,11 @@ module Parklife
       end
     end
 
+    def host_with_port(uri)
+      default_port = uri.scheme == 'https' ? 443 : 80
+      uri.port == default_port ? uri.host : "#{uri.host}:#{uri.port}"
+    end
+
     def save_page(path, content, config)
       build_path = File.join(
         config.build_dir,

data/lib/parklife/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Parklife
-  VERSION = '0.3.0'
+  VERSION = '0.5.0'
 end

data/lib/parklife.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'parklife/application'
 require 'parklife/version'