card-mod-solid_cache 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b322e3029fa67070e6c4cba4bfe4713367188fc3b3322010df453960776d2b8
+  data.tar.gz: 5ec067371aac1ce2ee721bd011a788f93f5aa790c5bdd0689f284dc040fe9e2c
+SHA512:
+  metadata.gz: f6feb7d1863300120d5980f60fac939b3c2b83da0b20169afdc5cc156d31f81494a5351797f5161fbf4ef506b518a1f13d571266ff36e8d979f9f696e2886cef
+  data.tar.gz: 31e92670dcb54408bbd6b1d828fe0c12496b5a22378314bc6d1c028327eec22d196d3a8207e85faf5a474195345a9bbdba4cadbe87c8f1d8575c79f4d8752855

data/README.md

@@ -0,0 +1,36 @@
+<!--
+# @title README - mod: solid cache
+-->
+
+# Solid Cache mod (experimental)
+
+This mod supports caching rendered card content in the database.
+
+## Why
+
+Decko has a powerful caching system that handles caching code objects
+(especially cards) and rendered views. The view caching is smart about nests and
+generally caches nested content separately from the content that nests it, so
+that you don't have to expire the cache of the nesting content so frequently. In
+most cases, this is a fast and efficient way to handle content.
+
+However, there are cases where a deeper and more permanent cache is appropriate.
+Sometimes it's more important that a very complex page be fast than perfectly up
+to date, for example. This mod can be helpful in such cases.
+
+## How
+
+If you include `Abstract::SolidCache` in a set, then anything that renders the
+`:core` view of a card in that set will trigger the generation of a
+`+:solid_cache` card. That raw content (db_content) of that new cache card will
+contain the rendered core view of the original card. Any further rendering of
+the core view will use that cached view until the cache is explicitly cleared or
+updated.
+
+To clear or update the cache, you will need to call one of the following methods
+to the set of a card that should clear/update the cache when changed.
+
+- `#cache_update_trigger`
+- `#cache_expire_trigger`
+
+See {Card::Set::Abstract::SolidCache} for more on those methods.

data/set/abstract/solid_cache.rb

@@ -0,0 +1,114 @@
+# -*- encoding : utf-8 -*-
+
+# A card that includes Abstract::SolidCache has its "core" view fully rendered
+# and stored in a '+*solid cache' card.
+# If that card exists the core view returns its content as rendered view.
+# If it doesn't exist the usual core view is rendered and saved in that card.
+#
+# The cache expiration can be controlled with the cache_update_trigger and
+# cache_expire_trigger methods.
+
+card_accessor :solid_cache, type: HtmlID
+
+class << self
+  def included host_class
+    host_class.format(host_class.try(:cached_format) || :base) do
+      view :core, cache: :never do
+        return super() if voo.hide? :solid_cache
+        _render_solid_cache
+      end
+
+      view :solid_cache, cache: :never do
+        card.with_solid_cache do |cache_card|
+          subformat(cache_card)._render_core
+        end
+      end
+    end
+  end
+end
+
+module ClassMethods
+  # If a card of the set given by 'set_of_changed_card' is changed
+  # the given block is executed. It is supposed to return an array of
+  # cards whose solid caches are expired because of the change.
+  # @param set_of_changed_card [set constant] a set of cards that triggers
+  #   a cache update
+  # @param args [Hash]
+  # @option args [Symbol, Array<Symbol>] :on the action(s)
+  #   (:create, :update, or :delete) on which the cache update
+  #   should be triggered. Default is all actions.
+  # @option args [Stage] :in_stage the stage when the update is executed.
+  #   Default is :integrate
+  # @yield return a card or an array of cards with solid cache that need to be
+  #   updated
+  def cache_update_trigger set_of_changed_card, args={}, &block
+    define_event_to_update_expired_cached_cards(
+      set_of_changed_card, args, :update_solid_cache, &block
+    )
+  end
+
+  # Same as 'cache_update_trigger' but expires instead of updates the
+  # outdated solid caches
+  def cache_expire_trigger set_of_changed_card, args={}, &block
+    define_event_to_update_expired_cached_cards(
+      set_of_changed_card, args, :expire_solid_cache, &block
+    )
+  end
+
+  private
+
+  def define_event_to_update_expired_cached_cards set_of_changed_card, args,
+                                                  method_name
+    args[:on] ||= %i[create update delete]
+    name = event_name set_of_changed_card, args
+    stage = args[:in_stage] || :integrate
+    Card::Set.register_set set_of_changed_card
+    set_of_changed_card.event name, stage, args do
+      Array.wrap(yield(self)).compact.each do |expired_cache_card|
+        next unless expired_cache_card.solid_cache?
+        expired_cache_card.send method_name
+      end
+    end
+  end
+
+  def event_name set, args
+    changed_card_set = set.underscore
+    solid_cache_set = underscore + "__solid_cache"
+    actions = Array.wrap(args[:on]).join("_")
+    ["update", solid_cache_set,
+     "changed_by", changed_card_set,
+     "on", actions].join("___").to_sym
+  end
+end
+
+def solid_cache?
+  true
+end
+
+def with_solid_cache
+  update_solid_cache if solid_cache_card.new?
+  yield solid_cache_card
+end
+
+def expire_solid_cache _changed_card=nil
+  return unless solid_cache? && solid_cache_card.real?
+  Auth.as_bot do
+    solid_cache_card.delete!
+  end
+end
+
+def update_solid_cache
+  return unless solid_cache?
+  new_content = generate_content_for_cache
+  write_to_solid_cache new_content
+  new_content
+end
+
+def generate_content_for_cache
+  format_type = try(:cached_format) || :base
+  format(format_type)._render_core hide: :solid_cache
+end
+
+def write_to_solid_cache new_content
+  solid_cache_card.write! new_content
+end

data/set/all/solid_cache.rb

@@ -0,0 +1,15 @@
+# for override
+def solid_cache?
+  false
+end
+
+module ClassMethods
+  def clear_solid_cache
+    Auth.as_bot do
+      Card.search(right: { codename: "solid_cache" }).each do |card|
+        card.update_columns trash: true
+        card.expire
+      end
+    end
+  end
+end

data/set/right/solid_cache.rb

@@ -0,0 +1,48 @@
+include_set Abstract::Lock
+
+def ok_to_read
+  left.ok_to_read
+end
+
+def followable?
+  false
+end
+
+def history?
+  false
+end
+
+def clean_html?
+  false
+end
+
+def write! new_content
+  lock do
+    if new_card?
+      update! content: new_content
+    elsif new_content != solid_cache_card.content
+      update_column :db_content, new_content
+      expire
+    end
+  end
+end
+
+format :html do
+  view :core, cache: :never do
+    return super() unless card.new_card?
+    @denied_view = :core
+    _render_unknown
+  end
+
+  view :unknown, cache: :never do
+    if @card.new_card? && (l = @card.left) && l.solid_cache?
+      l.update_solid_cache
+      @card = Card.fetch card.name
+      render! @denied_view
+    else
+      super()
+    end
+  end
+
+  view :new, :unknown
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: card-mod-solid_cache
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Philipp Kühl
+- Ethan McCutchen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: card
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- info@decko.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- set/abstract/solid_cache.rb
+- set/all/solid_cache.rb
+- set/right/solid_cache.rb
+homepage: http://decko.org
+licenses:
+- GPL-3.0
+metadata:
+  card-mod: solid_cache
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.28
+signing_key:
+specification_version: 4
+summary: solid cache
+test_files: []