parklife 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97be6505f9a1ac2cf9b5b2f5864b6a73fbf110c173043b991a32b04892c8e865
-  data.tar.gz: edd6ec37ae40bc0250bbb43ddaa9020a88d6e0884d0957dcb0888a0ab15cb9d0
+  metadata.gz: 32db274b9f5ec6ce7c56203a391c30c2d541bb8f319bc1b4130b22a2ed85bcf3
+  data.tar.gz: dce6ff9a4911863acb4fdb19c134f822d729a4ced0df62799fc69853154e412f
 SHA512:
-  metadata.gz: 80877ef06ba4a6cde8dea7ea58f1bea6ee02a7bba095a26f3644454ecdfa7b567895a00d6b55b53fb0b3d1c365b3d93ee3c0fdca137130a85e0f612e15aea782
-  data.tar.gz: ce193737f065bcbb63d0350c5e01001c2b83a56e313d8fc2e3994ce653efd8937f7f83695589134d1f12f2cb2e0ce07df76601d102add3f911bfa313c608e7d2
+  metadata.gz: 434a2acf5bd27046330a6f4c954dcf7908e3672db1e9ce08e985b833f299273306b4535115093f8f18517210605da098e347bcd03a3481106e3c35958da5df5a
+  data.tar.gz: 43249f1f24c7f932da0fd3d949b9d2590274ae7360d86a4f70f268c2a566dde1cf946aa6ba665a89c9bd5bbb5d5b6ee3ef714edbb7f4acbd34000045ac72dff5

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## Version 0.4.0 - 2023-03-01
+
+- Add a `parklife --version` command.
+- No need to `require parklife` from the Parkfile.
+
 ## Version 0.3.0 - 2023-02-26
 
 - Allow overriding `config.base` from the CLI build command with the `--base` option.

data/examples/rack/Parkfile

@@ -1,4 +1,3 @@
-require 'parklife'
 require 'rack'
 
 app = Proc.new { |env|

data/examples/sinatra/Parkfile

@@ -1,4 +1,3 @@
-require 'parklife'
 require 'sinatra'
 
 get '/' do

data/lib/parklife/application.rb

@@ -23,12 +23,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/cli.rb

@@ -1,3 +1,4 @@
+require 'parklife'
 require 'thor'
 
 module Parklife
@@ -20,21 +21,22 @@ module Parklife
       end
     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
 
-      def discover_Parkfile(dir)
-        File.expand_path('Parkfile', dir)
+          # Reach inside the consuming app's directory to apply its Parklife
+          # config.
+          app.load_Parkfile(File.join(Dir.pwd, 'Parkfile'))
+        }
       end
   end
 end

data/lib/parklife/crawler.rb

@@ -48,14 +48,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

@@ -4,17 +4,24 @@ module Parklife
   RackAppNotDefinedError = Class.new(Error)
 
   class HTTPError < Error
-    def initialize(path:, status:)
-      @path = path
+    def initialize(status, path)
       @status = status
+      @path = path
     end
 
     def message
-      %Q(#{status} response from path "#{path}")
+      %Q(#{@status} response from path "#{@path}")
+    end
+  end
+
+  class ParkfileLoadError < Error
+    def initialize(path)
+      @path = path
     end
 
-    private
-      attr_reader :path, :status
+    def message
+      %Q(Cannot load Parkfile "#{@path}")
+    end
   end
 
   class RailsNotDefinedError < Error

data/lib/parklife/rails.rb

@@ -1,9 +1,5 @@
-require 'parklife/errors'
-
 raise Parklife::RailsNotDefinedError unless defined?(Rails)
 
-require 'parklife'
-
 # 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)

data/lib/parklife/version.rb

@@ -1,3 +1,3 @@
 module Parklife
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

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