rabl 0.17.0 → 0.19.0

data/lib/rabl/template_cache_key.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'digest/sha1'
+
+module Rabl
+  # Marks every cache key rabl reads or writes. Bump it when a release changes rendered output so
+  # that entries cached by earlier versions would be wrong: the keys change once, so no entry
+  # cached by an earlier version, which lacks that release's output fixes, is served.
+  # Keys before 0.18.0 had no marker ("rabl/", and "rabl_build/" in old releases); 2 is 0.18.0.
+  # The README's caching example shows the resulting prefix: update it when this changes.
+  CACHE_KEY_VERSION = 2
+
+  # Builds the parts of template cache keys. These are module functions rather than
+  # Engine methods so that they never shadow helpers a template calls.
+  module TemplateCacheKey
+    module_function
+
+    # Returns the key rabl reads and writes in the cache engine for the given parts. Earlier
+    # versions put their keys under "rabl/", so no key built here can be one of theirs.
+    # TemplateCacheKey.expand([user, "json"]) => "rabl-v2/users/1/json"
+    def expand(parts)
+      ActiveSupport::Cache.expand_cache_key(parts, "rabl-v#{CACHE_KEY_VERSION}")
+    end
+
+    # Returns a digest of the given parts
+    # TemplateCacheKey.digest(["app/views/show.rabl", "object @user"]) => "4a1b..."
+    def digest(parts)
+      digest = Digest::SHA1.new
+      Array(parts).flatten.each { |part| digest << part.to_s << "\0" }
+      digest.hexdigest
+    end
+
+    # Returns a path that stays the same when the application moves: relative to the
+    # working directory when inside it, and nil for "(eval)" locations (the identity of
+    # the parent template tells evaluated sources apart).
+    # ceiling: paths outside the working directory stay absolute, so moving them changes
+    # the keys; a configurable root would let those move too.
+    # TemplateCacheKey.path("/app/views/show.rabl", "/app/") => "views/show.rabl"
+    def path(path, root = self.root)
+      path = path.to_s.dup.force_encoding(Encoding::BINARY) # paths may differ in encoding
+      return if path.empty? || path.start_with?("(eval")
+
+      root && path.start_with?(root) ? path.byteslice(root.bytesize..-1) : path
+    end
+
+    # Returns the column a block starts at, which tells apart blocks on one line, or nil when
+    # the runtime doesn't expose it.
+    # ceiling: without RubyVM::InstructionSequence (e.g. on JRuby), blocks that start on the
+    # same line of a template share an identity; put them on separate lines, or give them
+    # distinct cache keys.
+    def column(block)
+      return unless defined?(RubyVM::InstructionSequence)
+
+      iseq = RubyVM::InstructionSequence.of(block)
+      iseq && iseq.to_a[4][:code_location][1]
+    rescue StandardError
+      nil
+    end
+
+    # Returns the working directory with a trailing separator, as bytes, or nil if it is gone
+    def root
+      File.join(Dir.pwd, "").force_encoding(Encoding::BINARY)
+    rescue SystemCallError
+      nil
+    end
+
+    # Returns the options that change the shape of a rendering. A nested (hash format)
+    # rendering gets its root options from its parent; for other formats only root
+    # options given explicitly are added, so default keys have none. The format `extends`
+    # and `partial` look templates up in (lookup_format) is added when it isn't the one
+    # rendered, a hash counting as JSON: a nested rendering is a hash for every format.
+    # TemplateCacheKey.shape({ :format => "hash", :root => true }, "json") => ["root", "no_child_root"]
+    # TemplateCacheKey.shape({ :format => "hash", :child_root => true }, "xml") => ["lookup_format=xml"]
+    # TemplateCacheKey.shape({ :format => "json", :except => :b }, "json") => ["except=:b"]
+    def shape(options, lookup_format)
+      shape = []
+      format = options[:format].to_s
+
+      if format == "hash"
+        shape << "root" if options[:root]
+        shape << "no_child_root" unless options[:child_root]
+        shape << "object_root=#{options[:object_root_name].inspect}" if options[:object_root_name]
+      else
+        shape << "root=#{options[:root].inspect}" if options.key?(:root)
+        shape << "child_root=#{options[:child_root].inspect}" if options.key?(:child_root)
+      end
+
+      shape << "except=#{Array(options[:except]).map { |name| name.inspect }.join(',')}" if options[:except]
+      shape << "lookup_format=#{lookup_format}" unless lookup_format == (format == "hash" ? "json" : format)
+      shape
+    end
+  end
+end

data/lib/rabl/tracker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rabl
   # DependencyTracker for ActionView to support cache digest
   class Tracker

data/lib/rabl/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rabl
-  VERSION = "0.17.0"
+  VERSION = "0.19.0"
 end

data/lib/rabl.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'active_support'
+require 'active_support/core_ext/array/extract_options'
 require 'active_support/core_ext/string/inflections'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/hash/reverse_merge'
@@ -15,11 +18,12 @@ require 'rabl/multi_builder'
 require 'rabl/configuration'
 require 'rabl/renderer'
 require 'rabl/cache_engine'
+require 'rabl/template_cache_key'
 
 if defined?(Rails) && Rails.respond_to?(:version)
-  require 'rabl/tracker'  if Rails.version =~ /^[45678]/
-  require 'rabl/digestor' if Rails.version =~ /^[45678]/
-  require 'rabl/railtie'  if Rails.version =~ /^[345678]/
+  require 'rabl/tracker'
+  require 'rabl/digestor'
+  require 'rabl/railtie'
 end
 
 # Rabl.register!
@@ -54,16 +58,18 @@ module Rabl
     end
 
     # Fetches from the source_cache, stores block result in cache if nil
-    # Used to cache the contents and paths to various rabl templates
-    # source_cache("users/index", "path/to/view") { "/full/path/to/template/users/index" }
-    def source_cache(file, view_path, &block)
+    # Used to cache the contents and paths to various rabl templates, keyed by
+    # everything the lookup depends on (the file, the view path and the lookup details)
+    # source_cache("users/index", ["path/to/view"], [:json]) { "/full/path/to/template/users/index" }
+    def source_cache(file, view_path, lookup = nil)
       return yield unless Rabl.configuration.cache_sources
 
-      cache_key = [file, view_path].compact.join(":")
-
       @_source_cache ||= {}
 
-      @_source_cache[cache_key] ||= yield
+      # stores a frozen copy of the key, so later changes to the caller's strings don't reach it
+      @_source_cache.fetch([file, view_path, lookup]) do
+        @_source_cache[frozen_copy([file, view_path, lookup])] = yield
+      end
     end
 
     # Resets the RABL source cache
@@ -71,6 +77,16 @@ module Rabl
       @_source_cache = {}
     end
 
+    # Returns a copy of value whose Strings and Arrays are frozen, for cache keys that
+    # must not change when the caller's objects do
+    def frozen_copy(value)
+      case value
+      when Array  then value.map { |item| frozen_copy(item) }.freeze
+      when String then value.frozen? ? value : value.dup.freeze
+      else value
+      end
+    end
+
     # Renders an object using a specified template within an application.
     # render(@post, 'posts/show', :view_path => "/path/to/app/views")
     def render(object, source, options = {})
@@ -83,6 +99,4 @@ end
 if defined?(Padrino)
   require 'padrino-core'
   Padrino.after_load { Rabl.register! }
-elsif defined?(Rails.version) && Rails.version =~ /^2/
-  Rabl.register!
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rabl
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Nathan Esquenazi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-26 00:00:00.000000000 Z
+date: 2026-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.14
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.14
+        version: '6.1'
 description: General ruby templating with json, bson, xml and msgpack support
 email:
 - nesquena@gmail.com
@@ -35,14 +35,12 @@ files:
 - CONTRIBUTING.md
 - MIT-LICENSE
 - README.md
+- SECURITY.md
 - lib/rabl.rb
 - lib/rabl/builder.rb
 - lib/rabl/cache_engine.rb
 - lib/rabl/configuration.rb
 - lib/rabl/digestor.rb
-- lib/rabl/digestor/rails3.rb
-- lib/rabl/digestor/rails41.rb
-- lib/rabl/digestor/rails5.rb
 - lib/rabl/engine.rb
 - lib/rabl/helpers.rb
 - lib/rabl/multi_builder.rb
@@ -51,12 +49,17 @@ files:
 - lib/rabl/renderer.rb
 - lib/rabl/sources.rb
 - lib/rabl/template.rb
+- lib/rabl/template_cache_key.rb
 - lib/rabl/tracker.rb
 - lib/rabl/version.rb
 homepage: https://github.com/nesquena/rabl
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/nesquena/rabl/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/nesquena/rabl
+  bug_tracker_uri: https://github.com/nesquena/rabl/issues
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -65,7 +68,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/rabl/digestor/rails3.rb

@@ -1,12 +0,0 @@
-require 'action_view'
-
-module Rabl
-  class Digestor < ActionView::Digestor
-    def self.digest(name, format, finder, options = {})
-      cache_key = [name, format] + Array.wrap(options[:dependencies])
-      @@cache[cache_key.join('.')] ||= begin
-        Digestor.new(name, format, finder, options).digest
-      end
-    end
-  end
-end

data/lib/rabl/digestor/rails41.rb

@@ -1,12 +0,0 @@
-require 'action_view'
-
-module Rabl
-  class Digestor < ActionView::Digestor
-    def self.digest(options = {})
-      cache_key = [options[:name]] + Array.wrap(options[:dependencies])
-      @@cache[cache_key.join('.')] ||= begin
-        Digestor.new({ :name => options[:name], :finder => options[:finder] }.merge!(options)).digest
-      end
-    end
-  end
-end

data/lib/rabl/digestor/rails5.rb

@@ -1,6 +0,0 @@
-require 'action_view'
-
-module Rabl
-  class Digestor < ActionView::Digestor
-  end
-end