roda 3.103.0 → 3.104.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9809241399d00f1fc975608188f61e99c76c5818d7775a4fe8f0b7eeb9715e3
-  data.tar.gz: e04d8e54e041a4f96e998ebdd0431aada5e6d201fb1b6acc4b8c2a3fab50ea79
+  metadata.gz: 7ea3b3c7c8ffcfffa22412e123d09e718e876c13bdfcddbfae461daa813d81bd
+  data.tar.gz: 275d90d97fa2893654e368316c1233092ae5fcd60ac7e76ac026a45d2200582b
 SHA512:
-  metadata.gz: 19235fd38195015a2b7392ebbf97d34d2f7bda2977c6d45c42fd3b2fd86b1cdee5eff2b65bccf485157955ad474994567ae1b99e93c9459a3a9601df65800f6c
-  data.tar.gz: 628a775ff0bbb503e18d3cc1989ddfb8dcafec407b890b96adf30684674f5ca749cc6ae6fdc9c4ff9ec59e7779f878f55ae37e76c0e52c26da4e8127a5a0f0f9
+  metadata.gz: 546ee3b7cb9d6c8eac9eb6bbc40272a1a5760f522bbe94b38bb78afa3f552a61dd23496d2dfcf4e65fe490b1cad67b229fed4c31ac22b9d25409e501f6bb5c82
+  data.tar.gz: f9e94f7612706155c60db6f9a14bb9b130386875f1c86e6a65bc29bf9fdb789719c08f5398f58708ac862ab8b3ec41fb34f11b21d7454878be4364fceb50ce91

data/lib/roda/plugins/hash_public.rb

@@ -1,7 +1,5 @@
 # frozen-string-literal: true
 
-require 'digest/sha2'
-
 class Roda
   module RodaPlugins
     # The hash_public plugin adds a +hash_path+ method for constructing
@@ -26,7 +24,9 @@ class Roda
     # This plugin caches the digest of file content on first read. That means
     # if you change the file after that, it will continue to show the old hash.
     # This can cause problems in development mode if you are modifying the
-    # content of files served by the plugin.
+    # content of files served by the plugin. You can use the hash_public_cache
+    # plugin to scan the public directory in and store the digests in a file,
+    # avoiding the need for the process to read files to calculate the digest.
     #
     # Examples:
     #
@@ -48,6 +48,20 @@ class Roda
     #     end
     #   end
     module HashPublic
+      Digest = begin
+        require 'openssl'
+        ::OpenSSL::Digest
+      # :nocov:
+      rescue LoadError
+        require 'digest/sha2'
+        ::Digest
+      # :nocov:
+      end
+
+      def self.load_dependencies(app, opts = OPTS)
+        app.plugin :public, opts
+      end
+
       # Use options given to setup content-hash-based file serving.  The
       # following options are recognized by the plugin:
       #
@@ -57,23 +71,20 @@ class Roda
       #
       # The options given are also passed to the public plugin.
       def self.configure(app, opts = {})
-        app.plugin :public, opts
         app.opts[:hash_public_prefix] = (opts[:prefix] || app.opts[:hash_public_prefix] || 'static').dup.freeze
         app.opts[:hash_public_length] = opts[:length] || app.opts[:hash_public_length]
         app.opts[:hash_public_mutex] ||= Mutex.new
         app.opts[:hash_public_cache] ||= {}
       end
 
-      module InstanceMethods
-        # Return a path to the static file that could be served by r.hash_public.
-        # This does not check the file is inside the directory for performance
-        # reasons, so this should not be called with untrusted input.
-        def hash_path(file)
+      module ClassMethods
+        # The digest for the given file to use in hash_path.
+        def hash_path_digest(file)
           opts = self.opts
           cache = opts[:hash_public_cache]
           mutex = opts[:hash_public_mutex]
           unless digest = mutex.synchronize{cache[file]}
-            digest = ::Digest::SHA256.file(File.join(opts[:public_root], file)).base64digest
+            digest = Digest::SHA256.file(File.join(opts[:public_root], file)).base64digest
             digest.chomp!("=")
             digest.tr!("+/", "-_")
             if length = opts[:hash_public_length]
@@ -82,7 +93,16 @@ class Roda
             digest.freeze
             mutex.synchronize{cache[file] = digest}
           end
-          "/#{opts[:hash_public_prefix]}/#{digest}/#{file}"
+          digest
+        end
+      end
+
+      module InstanceMethods
+        # Return a path to the static file that could be served by r.hash_public.
+        # This does not check the file is inside the directory for performance
+        # reasons, so this should not be called with untrusted input.
+        def hash_path(file)
+          "/#{opts[:hash_public_prefix]}/#{self.class.hash_path_digest(file)}/#{file}"
         end
       end
 

data/lib/roda/plugins/hash_public_cache.rb

@@ -0,0 +1,91 @@
+# frozen-string-literal: true
+
+require 'json'
+require 'find'
+
+class Roda
+  module RodaPlugins
+    # The hash_public_cache plugin builds on top of the hash_public plugin and
+    # adds the ability to store the digests for the public files in a json file,
+    # and load that file at startup, which avoids the need for the process to
+    # read the public file in order to compute the digest.
+    #
+    # Examples:
+    #
+    #   # Load the plugin. Options given will be passed to public and hash_public.
+    #   plugin :hash_public_cache, "path/to/cache_file.json"
+    #
+    #   # When rebuilding the cache:
+    #   #
+    #   # * Scan the public directory for files, calculate the digest on each.
+    #   # * Write the hash public cache to a file.
+    #   #
+    #   # This is split into separate steps in case you want to modify the cache
+    #   # manually after the scan.
+    #   scan_hash_public_cache_dir
+    #   dump_hash_public_cache_file 
+    #
+    #   # To load the cache at application startup (if the file exists):
+    #   load_hash_public_cache_file
+    module HashPublicCache
+      def self.load_dependencies(app, _cache_file, opts = OPTS)
+        app.plugin :hash_public, opts
+      end
+
+      # Specify the location of the hash public cache file.
+      #
+      # The options given are passed to the hash_public plugin.
+      def self.configure(app, cache_file, opts = OPTS)
+        app.opts[:hash_public_cache_file] = cache_file
+      end
+
+      module ClassMethods
+        # Load the hash public cache file, if it exists. This replaces the hash
+        # public cache with the values from the file.
+        def load_hash_public_cache_file
+          file = opts[:hash_public_cache_file]
+          return unless File.file?(file)
+
+          cache = opts[:hash_public_cache] = (opts[:json_parser] || ::JSON.method(:parse)).call(::File.read(file))
+          cache.each_value(&:freeze)
+          nil
+        end
+
+        # Scan the public directory for files, computing the hash public digest
+        # for each. This will not rescan files that already have digest values.
+        # If a block is given, it will only calculate the digest for the file
+        # if the block returns truthy.
+        def scan_hash_public_cache_dir
+          cache = opts[:hash_public_cache]
+
+          # Public root doesn't have trailing slash even if given, as
+          # File.expand_path removes it.
+          root = opts[:public_root] + File::SEPARATOR
+
+          Find.find(opts[:public_root]) do |file|
+            if File.file?(file)
+              file = file.sub(root, '')
+              next if cache[file]
+
+              if defined?(yield)
+                next unless yield file
+              end
+
+              cache[file] = hash_path_digest(file)
+            end
+          end
+
+          nil
+        end
+
+        # Write the current hash public cache to the cache file.
+        def dump_hash_public_cache_file
+          File.write(opts[:hash_public_cache_file], (opts[:json_serializer] || :to_json.to_proc).call(opts[:hash_public_cache]))
+          nil
+        end
+      end
+    end
+
+    register_plugin(:hash_public_cache, HashPublicCache)
+  end
+end

data/lib/roda/plugins/json.rb

@@ -56,10 +56,12 @@ class Roda
     # This plugin depends on the custom_block_results plugin, and therefore does
     # not support treating String, FalseClass, or NilClass values as JSON.
     module Json
-      # Set the classes to automatically convert to JSON, and the serializer to use.
-      def self.configure(app, opts=OPTS)
+      def self.load_dependencies(app, opts=OPTS)
         app.plugin :custom_block_results
+      end
 
+      # Set the classes to automatically convert to JSON, and the serializer to use.
+      def self.configure(app, opts=OPTS)
         classes = opts[:classes] || [Array, Hash]
         app.opts[:json_result_classes] ||= []
         app.opts[:json_result_classes] += classes

data/lib/roda/plugins/timestamp_public.rb

@@ -35,14 +35,17 @@ class Roda
     #     end
     #   end
     module TimestampPublic
+      def self.load_dependencies(app, opts=OPTS)
+        app.plugin :public, opts
+      end
+
       # Use options given to setup timestamped file serving.  The following option is
       # recognized by the plugin:
       #
       # :prefix :: The prefix for paths, before the timestamp segment
       #
       # The options given are also passed to the public plugin.
-      def self.configure(app, opts={})
-        app.plugin :public, opts
+      def self.configure(app, opts=OPTS)
         app.opts[:timestamp_public_prefix] = (opts[:prefix] || app.opts[:timestamp_public_prefix] || "static").dup.freeze
       end
 

data/lib/roda/version.rb

@@ -4,7 +4,7 @@ class Roda
   RodaMajorVersion = 3
 
   # The minor version of Roda, updated for new feature releases of Roda.
-  RodaMinorVersion = 103
+  RodaMinorVersion = 104
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.103.0
+  version: 3.104.0
 platform: ruby
 authors:
 - Jeremy Evans
@@ -219,6 +219,7 @@ files:
 - lib/roda/plugins/hash_matcher.rb
 - lib/roda/plugins/hash_paths.rb
 - lib/roda/plugins/hash_public.rb
+- lib/roda/plugins/hash_public_cache.rb
 - lib/roda/plugins/hash_routes.rb
 - lib/roda/plugins/head.rb
 - lib/roda/plugins/header_matchers.rb
@@ -337,7 +338,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Routing tree web toolkit
 test_files: []