parklife 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a0e894c4cba14f5f3d7dc614df86e5430dded896ddf5466048bd2b7eb224791
-  data.tar.gz: 684afeeb534d59bb1139e5df34c3a5ff93a4c9e2c491b69b2a2a66feeba54c3c
+  metadata.gz: 6a1770a5f09524a3c16e3becb527d6d6fc0fdb723095b3365ee583a0a91722a4
+  data.tar.gz: 0be599051686b0dab89aba57dfe72813de074c694c31de876f66b9c8aeb61223
 SHA512:
-  metadata.gz: 8e0edd657e0b2d82e17b2eb143748cd22612b72b99851ef1ad331f9641f310e09859f537dc95798e255a5868cabed63599089fe19003991d8cce86c36dba8978
-  data.tar.gz: d82d26729d3206e07ed39b84215d9243c789066f3be32a64a9173356d70a8e588ffc60672832bb77038821249621dd2de7745cf6448f118916fbbffe3d6ee64e
+  metadata.gz: 4c473fd98d0162b43ff8b09399e05f827fd478b30bf33d563a21f463dcc873366c56e72ae91c3c236da5823f44154dc6f59e2ddb49f4526b1691e636fda7bcf9
+  data.tar.gz: 466f130fb18b8fea3deb6ff126c767009b2e9341d04deb5c0f8ee8c4705e3987d734094976a33886dd0f152cfd4ba2c1ac4c4941859ef11e703a63195b5e8bc4

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## Version 0.6.0 - 2023-03-26
+
+- Allow assigning a URI object to config.base <https://github.com/benpickles/parklife/pull/98>
+
+- Add a `parklife config` command to output the full Parklife config <https://github.com/benpickles/parklife/pull/97>
+
+- Improved Rails integration <https://github.com/benpickles/parklife/pull/96>
+
+  Parklife now integrates with Rails via Railties and can therefore hook into the app's configuration before it's initialised. This allows Parklife to remove the host authorisation middleware that's present in development and otherwise causes Parklife requests to receive a 403 response.
+
+  **Upgrading**: For an existing Parklife+Rails integration move requiring `parklife/rails` above requiring `config/environment` in the Parkfile.
+
+- Prevent `Encoding::UndefinedConversionError` error when writing a binary response <https://github.com/benpickles/parklife/pull/94>
+
 ## Version 0.5.1 - 2023-03-22
 
 - Ensure the generated static-build script is executable. <https://github.com/benpickles/parklife/pull/89>

data/Gemfile

@@ -8,6 +8,7 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 gemspec
 
 gem 'bundler'
+gem 'rails'
 gem 'rake'
 gem 'rspec'
 gem 'rubocop'

data/README.md

@@ -23,14 +23,14 @@ $ bundle exec parklife init
 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'
 
-# Load Parklife and some Rails-specific settings allowing you to use URL
-# helpers within the `routes` block below.
-require 'parklife/rails'
-
 Parkfile.application.routes do
   # Start from the homepage and crawl all links.
   root crawl: true
@@ -76,7 +76,7 @@ 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/parklife-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, see the [Rails example's full build script](examples/rails/bin/static-build) for how you might do this.
 
 ## More examples
 

data/lib/parklife/cli.rb

@@ -15,6 +15,21 @@ module Parklife
       application.build
     end
 
+    desc 'config', 'Output the full Parklife config'
+    def config
+      reporter = application.config.reporter
+
+      shell.print_table([
+        ['app', application.config.app.inspect],
+        ['base', application.config.base.to_s],
+        ['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' : '-'],
+        ['reporter', reporter == $stdout ? '$stdout' : reporter],
+      ])
+    end
+
     desc 'get PATH', 'Fetch PATH from the app and output its contents'
     def get(path)
       puts application.crawler.get(path).body

data/lib/parklife/config.rb

@@ -20,7 +20,7 @@ module Parklife
     end
 
     def base=(value)
-      uri = URI.parse(value || '')
+      uri = URI === value ? value : URI.parse(value || '')
       uri.host ||= DEFAULT_HOST
       uri.scheme ||= DEFAULT_SCHEME
       @base = uri

data/lib/parklife/errors.rb

@@ -16,10 +16,4 @@ module Parklife
       super %Q(Cannot load Parkfile "#{path}")
     end
   end
-
-  class RailsNotDefinedError < Error
-    def initialize(msg = 'Expected Rails to be defined, require config/environment before parklife')
-      super
-    end
-  end
 end

data/lib/parklife/rails.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-raise Parklife::RailsNotDefinedError unless defined?(Rails)
+require 'rails'
 
 module Parklife
   module RailsConfigRefinements
@@ -18,12 +18,35 @@ module Parklife
       }
     end
   end
-end
 
-Parklife.application.config.app = Rails.application
+  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)
+      # 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)
+      Parklife.application.config.extend(RailsConfigRefinements)
+    end
+  end
+end

data/lib/parklife/templates/Parkfile.erb

@@ -1,6 +1,6 @@
 <% if options[:rails] -%>
-require_relative 'config/environment'
 require 'parklife/rails'
+require_relative 'config/environment'
 <% else -%>
 # Assuming your Rack app lives in ./app.rb:
 require_relative 'app'

data/lib/parklife/utils.rb

@@ -34,7 +34,7 @@ module Parklife
         build_path_for(path, index: config.nested_index)
       )
       FileUtils.mkdir_p(File.dirname(build_path))
-      File.write(build_path, content)
+      File.write(build_path, content, mode: 'wb')
     end
 
     def scan_for_links(html)

data/lib/parklife/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parklife
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Ben Pickles
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-22 00:00:00.000000000 Z
+date: 2023-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri