card 1.97.0.1 → 1.98.0

data/lib/card/cache.rb

@@ -26,6 +26,8 @@ class Card
     cattr_reader :cache_by_class
 
     class << self
+      attr_accessor :no_renewal
+
       # create a new cache for the ruby class provided
       # @param klass [Class]
       # @return [{Card::Cache}]
@@ -50,6 +52,7 @@ class Card
       # clear the temporary caches and ensure we're using the latest stamp
       # on the persistent caches.
       def renew
+        return if no_renewal
         renew_persistent
         cache_by_class.each_value do |cache|
           cache.soft.reset
@@ -153,9 +156,7 @@ class Card
     # read and (if not there yet) write
     # @param key [String]
     def fetch key, &block
-      @soft.fetch(key) do
-        @hard ? @hard.fetch(key, &block) : yield
-      end
+      @soft.fetch(key) { @hard ? @hard.fetch(key, &block) : yield }
     end
 
     # delete specific cache entries by key

data/lib/card/codename.rb

@@ -26,7 +26,7 @@ class Card
   class Codename
     class << self
       # returns codename for id and id for codename
-      # @param key [Integer, Symbol, String, Card::Name]
+      # @param codename [Integer, Symbol, String, Card::Name]
       # @return [Symbol]
       def [] codename
         case codename

data/lib/card/content.rb

@@ -9,7 +9,7 @@ class Card
   # Content objects support the parsing of content strings into arrays that
   # contain semantically meaningful "chunks" like nests, links, urls, etc.
   #
-  # Each chunk has an object whose class inherits from {Card::Chunk::Abstract}
+  # Each chunk has an object whose class inherits from {Card::Content::Chunk::Abstract}
   #
   class Content < SimpleDelegator
     extend Card::Content::Clean
@@ -46,8 +46,16 @@ class Card
     end
 
     # sends &block to #process_chunk on each Chunk object
-    def process_each_chunk &block
-      each_chunk { |chunk| chunk.process_chunk(&block) }
+    def process_chunks &block
+      return custom_process_chunks(&block) if block_given?
+
+      each_chunk(&:process_chunk)
+    end
+
+    def custom_process_chunks
+      each_chunk do |chunk|
+        chunk.burn_after_reading yield(chunk)
+      end
     end
 
     def pieces
@@ -89,6 +97,19 @@ class Card
       "<#{__getobj__.class}:#{card}:#{self}>"
     end
 
+    def without_nests
+      nests = []
+      find_chunks(Card::Content::Chunk::Nest).each_with_index do |chunk, i|
+        nests << chunk.text
+        chunk.burn_after_reading "{{#{i}}}"
+      end
+
+      result = yield to_s
+      Chunk::Nest.gsub result do |nest_content|
+        nests[nest_content.to_i]
+      end
+    end
+
     private
 
     def resolve_format format_or_card

data/lib/card/content/chunk.rb

@@ -140,7 +140,22 @@ class Card
         end
 
         def result
-          @process_chunk || @processed || @text
+          burn_read || @process_chunk || @processed || @text
+        end
+
+        def burn_read
+          return unless @burn_read
+
+          tmp = @burn_read
+          @burn_read = nil
+          tmp
+        end
+
+        # Temporarily overrides the processed nest content for single-use
+        # After using the nest's result
+        # (for example via `to_s`) the original result is restored
+        def burn_after_reading text
+          @burn_read = text
         end
 
         def inspect
@@ -148,7 +163,7 @@ class Card
         end
 
         def as_json _options={}
-          @process_chunk || @processed ||
+          burn_read || @process_chunk || @processed ||
             "not rendered #{self.class}, #{card&.name}"
         end
       end

data/lib/card/env.rb

@@ -44,24 +44,25 @@ class Card
       def slot_opts
         # FIXME:  upgrade to safe parameters
         self[:slot_opts] ||= begin
-          opts = params[:slot] || {}
-          opts.merge shortcut_slot_opts
+          opts = params[:slot]&.clone || {}
           opts = opts.to_unsafe_h if opts.is_a? ActionController::Parameters
-          opts.deep_symbolize_keys
+          opts.merge! shortcut_slot_opts
+          opts.deep_symbolize_keys.slice(*Card::View::Options.slot_keys)
         end
       end
 
-      def shortcut_slot_opts
-        opts = {}
-        opts[:size] = params[:size].to_sym if params[:size]
-        opts[:items] = { view: params[:item].to_sym } if params[:item].present?
-        opts
-      end
-
       def session
         self[:session] ||= {}
       end
 
+      def reset_session
+        if session.is_a? Hash
+          self[:session] = {}
+        else
+          self[:controller]&.reset_session
+        end
+      end
+
       def success cardname=nil
         self[:success] ||= Env::Success.new(cardname, params[:success])
       end
@@ -117,6 +118,17 @@ class Card
         else super
         end
       end
+
+      def shortcut_slot_opts
+        opts = {}
+        opts[:size] = params[:size].to_sym if params[:size]
+        opts[:items] = { view: params[:item].to_sym } if slot_items_shortcut?
+        opts
+      end
+
+      def slot_items_shortcut?
+        params[:item].present? && !params.dig(:slot, :items, :view).present?
+      end
     end
   end
 end

data/lib/card/env/success.rb

@@ -4,7 +4,7 @@ class Card
     class Success
       include Card::Env::Location
 
-      attr_accessor :redirect, :name, :name_context
+      attr_accessor :redirect, :name, :name_context, :reload
       attr_writer :params, :card
       attr_reader :id
 
@@ -49,6 +49,10 @@ class Card
         @redirect == :soft
       end
 
+      def reload?
+        @reload == true || @reload == "true"
+      end
+
       # TODO: refactor to use cardish
       def mark= value
         case value

data/lib/card/error.rb

@@ -58,6 +58,11 @@ class Card
 
     # error whose message can be shown to any user
     class UserError < Error
+      cattr_accessor :user_error_classes
+      self.user_error_classes = [self,
+                                 ActiveRecord::RecordNotFound,
+                                 ActionController::MissingFile,
+                                 ActiveRecord::RecordInvalid]
     end
 
     # error in WQL query

data/lib/card/format.rb

@@ -1,64 +1,21 @@
 # -*- encoding : utf-8 -*-
 
 class Card
-  # _Views_ are the primary way users interact with cards. Card::Format and its subclasses
-  # ({Card::Format::HtmlFormat}, {Card::Format::JsonFormat}, {Card::Format::XmlFormat},
-  # etc) are responsible for defining and rendering _views_.
+  # Card::Format and its subclasses ({Card::Format::HtmlFormat},
+  # {Card::Format::JsonFormat}, {Card::Format::XmlFormat}, etc)
+  # are responsible for defining and rendering _views_.
   #
-  # However, Deck-coders (those who code in the Card/Decko framework) rarely write code
+  # However, monkeys (those who code in the Card/Decko framework) rarely write code
   # directly in these classes. Instead they organize their code using {Card::Mods mods}.
-  # The {Card::Mod} docs explain how to set up a mod. Once you've done that, you're ready
-  # to define a view.  These docs will introduce the basics of view definition and
   #
-  # Here is a very simple view that just defines a label for the card – its name:
-  #
-  #     view :label do
-  #       card.name
-  #     end
-  #
-  # If a format is not specified, the view is defined on the base format class,
-  # Card::Format. The following two definitions are equivalent to the definition above:
-  #
-  #     format do
-  #       view(:label) { card.name }
-  #     end
-  #
-  #     format(:base) { view(:label) { card.name } }
-  #
-  # But suppose you would like this view to appear differently in different output
-  # formats. For example, you'd like this label to have a tag with a class attribute HTML
-  # so that you can style it with CSS.
-  #
-  #     format :html do
-  #       view :label do
-  #         div(class: "my-label") { card.name }
-  #       end
-  #     end
-  #
-  # Note that in place of card.name, you could also use `super`, because this view is
-  # translated into a method on Card::Format::HtmlFormat, which inherits from
-  # Card::Format.
-  #
-  # ## Common arguments for view definitions
-  #
-  # * :perms - restricts view permissions. Value can be :create, :read, :update, :delete,
-  #            or a Proc.
-  # * :tags - tag view as needed.
-  #
-  # The most commmon tag is "unknown_ok," which indicates that a view can be rendered even
-  # if the card is "unknown" (not real or virtual).
-  #
-  # ## Rendering views
-  #
-  # To render our label view, you can use either of these:
-  #
-  #     render :label
-  #     render_label
+  # {Card::Mod} explains how to set up a mod.
+  # {Card::Set::Format} explains how to use this and other format classes within a mod.
+  # {Card::Set::Abstract::Format} introduces the view API, which is organized with these
+  # format classes.
   #
   class Format
     include Card::Env::Location
     include Nesting
-    include Permission
     include Render
     include ContextNames
     include Content
@@ -67,13 +24,9 @@ class Card
 
     extend Registration
 
-    cattr_accessor :registered
+    cattr_accessor :registered, :aliases
     self.registered = []
-    VIEW_VARS = %i[perms denial closed].freeze
-    (VIEW_VARS + %i[view_tags aliases]).each do |accessor_name|
-      cattr_accessor accessor_name
-      send "#{accessor_name}=", {}
-    end
+    self.aliases = {}
 
     attr_reader :card, :parent, :main_opts, :modal_opts
     attr_accessor :form, :error_status, :rendered
@@ -134,10 +87,6 @@ class Card
       end
     end
 
-    def tagged view, tag
-      self.class.tagged view, tag
-    end
-
     def mime_type
       "text/plain"
     end

data/lib/card/format/content.rb

@@ -1,13 +1,19 @@
 class Card
   class Format
     module Content
-      def process_content override_content=nil, content_opts=nil
-        content = override_content || render_raw || ""
-        content_object = get_content_object content, content_opts
-        content_object.process_each_chunk do |chunk_opts|
-          content_nest chunk_opts
-        end
-        content_object.to_s
+      def process_content override_content=nil, content_opts=nil, &block
+        content_obj = content_object override_content , content_opts
+        content_obj.process_chunks(&block)
+        content_obj.to_s
+      end
+
+      # Preserves the syntax in all nests. The content is yielded with placeholders
+      # for all nests. After executing the given block the original nests are put back in.
+      # Placeholders are numbers in double curly brackets like {{2}}.
+      def safe_process_content override_content=nil, content_opts=nil, &block
+        content_obj = content_object override_content, chunk_list: :nest_only
+        result = content_obj.without_nests(&block)
+        process_content result, content_opts
       end
 
       # nested by another card's content
@@ -69,13 +75,14 @@ class Card
 
       private
 
-      def get_content_object content, content_opts
-        if content.is_a? Card::Content
-          content
-        else
-          Card::Content.new content, self, (content_opts || voo&.content_opts)
-        end
+      def content_object content=nil, content_opts=voo&.content_opts
+        return content if content.is_a? Card::Content
+
+        content ||= render_raw || ""
+        Card::Content.new content, self, content_opts
       end
+
+
     end
   end
 end

data/lib/card/format/context_names.rb

@@ -1,6 +1,18 @@
 class Card
   class Format
+    # Contextual names make titles less noisy by not rendering redundant name parts
+    #
+    # For example, in the context of "Ball", "Ball+size" is rendered as just "+size"
     module ContextNames
+      def naming name=nil
+        result = yield
+        add_name_context name
+        result
+      end
+
+      # TODO: stop this lazy loading
+      # the combo of lazy loading + format ancestry navigation + caching is dangerous
+      # Long term, it would probably be smarter to handle this in the voo.
       def context_names
         @context_names ||= initial_context_names
       end
@@ -16,8 +28,7 @@ class Card
         yield.select { |n| part_keys.include? n.key }
       end
 
-      # "slot[name_context]" param is a string;
-      # @context_names is an array
+      # "slot[name_context]" param is a string; @context_names is an array
       def context_names_from_params
         return [] unless (name_list = Card::Env.slot_opts.delete(:name_context))
 

data/lib/card/format/error.rb

@@ -1,6 +1,40 @@
 class Card
   class Format
     module Error
+      def ok? task
+        task = :create if task == :update && card.new_card?
+        @ok ||= {}
+        @ok[task] = card.ok? task if @ok[task].nil?
+        @ok[task]
+      end
+
+      def anyone_can? task
+        return false unless task.is_a? Symbol
+        @anyone_can ||= {}
+        @anyone_can[task] = card.anyone_can? task if @anyone_can[task].nil?
+        @anyone_can[task]
+      end
+
+      def view_for_unknown _view
+        if main?
+          root.error_status = 404
+          :not_found
+        else
+          :missing
+        end
+      end
+
+      def view_for_denial view, task
+        @denied_task = task
+        root.error_status = 403 if focal? && voo.root?
+        view_setting(:denial, view) || :denial
+      end
+
+      def monitor_depth
+        raise Card::Error::UserError, tr(:too_deep) if depth >= Card.config.max_depth
+        yield
+      end
+
       def rescue_view e, view
         method = loud_error? ? :loud_error : :quiet_error
         send method, e, view

data/lib/card/format/nest.rb

@@ -34,7 +34,7 @@ class Card
         view = view_opts[:view] || format.implicit_nest_view
         # TODO: canonicalize view and modal_nest_view handling should be in Card::View,
         # not here. (Make sure processing only happens on nests/root views)
-        Card::View.canonicalize view
+        Card::View.normalize view
       end
 
       # @return [Format] subformat object
@@ -50,22 +50,30 @@ class Card
       # when nesting the same card. this reduces overhead and optimizes
       # caching
       def reuse_format?
-        view_opts[:nest_name] =~ /^_(self)?$/ &&
-          format.context_card == format.card &&
-          !nest_recursion_risk?
+        self_nest? && !nest_recursion_risk?
+      end
+
+      def self_nest?
+        self_nest = view_opts[:nest_name] =~ /^_(self)?$/ &&
+                    format.context_card == format.card
+
+        # self nest in focal format should add depth (to catch recursions) but
+        # remain focal
+        format_opts[:focal] = true if self_nest && format.focal?
+        self_nest
       end
 
       # don't reuse the format when there is a risk of recursion, because while nest
       # recursion is caught, view recursion is not.
       # TODO: catch view recursion and remove this. (Should be straightforward within voo)
       def nest_recursion_risk?
-        content_view? && format.voo&.structure
+        content_view? || format.voo&.structure
       end
 
       def content_view?
         # TODO: this should be specified in view definition
         %i[
-          core content titled open closed open_content
+          bar expanded_bar core content titled open closed open_content
         ].member? @view.to_sym
       end
     end