card 1.96.8 → 1.97.0

data/lib/card/format.rb

@@ -1,9 +1,14 @@
 # -*- 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_.
+  # _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_.
   #
-  # However, Deck-coders (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
+  # However, Deck-coders (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:
   #
@@ -11,7 +16,8 @@ class Card
   #       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:
+  # 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 }
@@ -19,7 +25,9 @@ class Card
   #
   #     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.
+  # 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
@@ -27,14 +35,18 @@ class Card
   #       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.
+  # 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.
+  # * :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).
+  # 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
   #
@@ -63,8 +75,8 @@ class Card
       send "#{accessor_name}=", {}
     end
 
-    attr_reader :card, :parent, :main_opts
-    attr_accessor :form, :error_status
+    attr_reader :card, :parent, :main_opts, :modal_opts
+    attr_accessor :form, :error_status, :rendered
 
     def self.view_caching?
       true
@@ -80,6 +92,7 @@ class Card
 
     def require_card_to_initialize!
       return if @card
+
       msg = I18n.t :exception_init_without_card, scope: "lib.card.format"
       raise Card::Error, msg
     end

data/lib/card/format/content.rb

@@ -14,9 +14,15 @@ class Card
       # (as opposed to a direct API nest)
       def content_nest opts={}
         return opts[:comment] if opts.key? :comment # commented nest
+
         nest_name = opts[:nest_name]
-        return main_nest(opts) if main_nest?(nest_name)
-        nest nest_name, opts
+        # return voo.render_layouts if main_nest?(nest_name)
+        # return main_nest(opts, &main_nest_block) if main_nest?(nest_name)
+        if main_nest?(nest_name) && @nest_mode != :template
+          wrap_main { main.rendered || main_nest(opts) }
+        else
+          nest nest_name, opts
+        end
       end
 
       def format_date date, include_time=true
@@ -35,6 +41,7 @@ class Card
 
       def add_class options, klass
         return if klass.blank?
+
         options[:class] = css_classes options[:class], klass
       end
 
@@ -50,6 +57,7 @@ class Card
 
       def id_counter
         return @parent.id_counter if @parent
+
         @id_counter ||= 0
         @id_counter += 1
       end

data/lib/card/format/context_names.rb

@@ -13,18 +13,20 @@ class Card
 
       def relevant_context_names
         part_keys = @card.name.part_names.map(&:key)
-        yield.reject { |n| !part_keys.include? n.key }
+        yield.select { |n| part_keys.include? n.key }
       end
 
       # "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))
+
         name_list.to_s.split(",").map(&:to_name)
       end
 
       def context_names_to_params
         return if context_names.empty?
+
         context_names.join(",")
       end
 
@@ -36,7 +38,7 @@ class Card
       def title_in_context title=nil
         keep_safe = title&.html_safe?
         title = title ? title.to_name.absolute_name(card.name) : card.name
-        newtitle = title.from *context_names
+        newtitle = title.from(*context_names)
         keep_safe ? newtitle.html_safe : newtitle
       end
     end

data/lib/card/format/error.rb

@@ -33,7 +33,7 @@ class Card
         if exception.is_a? Card::Error::UserError
           exception.message
         else
-          tr :error_rendering, scope: [:lib, :card, :format, :error],
+          tr :error_rendering, scope: %i[lib card format error],
                                cardname: error_cardname(exception), view: view
         end
       end

data/lib/card/format/nest.rb

@@ -27,7 +27,7 @@ class Card
         view_opts[:nest_name] ||= card.name
         @view ||= prepare_view
         # TODO: handle in closed / edit view definitions
-        view_opts[:home_view] ||= [:closed, :edit].member?(view) ? :open : view
+        view_opts[:home_view] ||= %i[closed edit].member?(view) ? :open : view
       end
 
       def prepare_view
@@ -40,6 +40,7 @@ class Card
       # @return [Format] subformat object
       def prepare_subformat
         return format if reuse_format?
+
         sub = format.subformat card, format_opts
         sub.main! if view_opts[:main]
         sub
@@ -63,8 +64,8 @@ class Card
 
       def content_view?
         # TODO: this should be specified in view definition
-        [
-          :core, :content, :titled, :open, :closed, :open_content
+        %i[
+          core content titled open closed open_content
         ].member? @view.to_sym
       end
     end

data/lib/card/format/nesting.rb

@@ -11,6 +11,7 @@ class Card
       # @param format_opts [Hash] opts will be passed on to subformat
       def nest cardish, view_opts={}, format_opts={}
         return "" if nest_invisible?
+
         nest = Card::Format::Nest.new self, cardish, view_opts, format_opts
         nest.prepare do |subformat, view|
           rendered = count_chars { subformat.render view, view_opts }
@@ -53,6 +54,7 @@ class Card
       def count_chars
         result = yield
         return result unless nest_mode == :closed && result
+
         @char_count ||= 0
         @char_count += result.length
         result

data/lib/card/format/nesting/main.rb

@@ -7,20 +7,23 @@ class Card
           yield # no wrapping in base format
         end
 
-        def main_nest opts
-          wrap_main do
-            with_nest_mode :normal do
+        def main_nest opts={}
+          with_nest_mode :normal do
+            if block_given?
+              block.call
+            else
               nest root.card, opts.merge(main_view: true, main: true)
             end
           end
         end
 
         def main_nest? nest_name
-          nest_name == "_main" && !root.already_mained?
+          nest_name == "_main" # && !root.already_mained?
         end
 
         def already_mained?
           return true if @main || @already_main
+
           @already_main = true
           false
         end
@@ -29,8 +32,9 @@ class Card
           @main = true
         end
 
+        # view=edit&items=closed
         def main_nest_options
-          opts = root.main_opts || {}
+          opts = inherit(:main_opts) || {}
           main_nest_size_opt opts
           main_nest_items_opt opts
           opts
@@ -41,12 +45,14 @@ class Card
         def main_nest_size_opt opts
           val = params[:size]
           return unless val.present?
+
           opts[:size] = val.to_sym
         end
 
         def main_nest_items_opt opts
           val = params[:item]
           return unless val.present?
+
           opts[:items] ||= {}
           opts[:items][:view] = val.to_sym
         end

data/lib/card/format/nesting/mode.rb

@@ -79,6 +79,7 @@ class Card
         def configured_view_in_closed_mode view
           closed_config = Card::Format.closed[view]
           return view if closed_config == true
+
           closed_config
         end
       end

data/lib/card/format/nesting/subformat.rb

@@ -15,10 +15,22 @@ class Card
           @root ||= parent ? parent.root : self
         end
 
+        def main
+          if main?
+            self
+          elsif !root?
+            parent.main
+          end
+        end
+
         def depth
           @depth ||= parent ? (parent.depth + 1) : 0
         end
 
+        def root?
+          depth.zero?
+        end
+
         # is format's card the format of the main card on a page?
         def main?
           depth.zero?

data/lib/card/format/permission.rb

@@ -3,6 +3,7 @@ class Card
     module Permission
       def ok_view view, skip_perms=false
         raise Card::Error::UserError, tr(:too_deep) if subformats_nested_too_deeply?
+
         approved_view = check_view view, skip_perms
         handle_view_denial view, approved_view
         approved_view
@@ -10,6 +11,7 @@ class Card
 
       def handle_view_denial view, approved_view
         return if approved_view == view
+
         @denied_view = view
       end
 
@@ -25,6 +27,7 @@ class Card
       def unknown_disqualifies_view? view
         # view can't handle unknown cards (and card is unknown)
         return false if tagged view, :unknown_ok
+
         card.unknown?
       end
 

data/lib/card/format/registration.rb

@@ -1,7 +1,6 @@
 class Card
   class Format
     module Registration
-
       def register format
         registered << format.to_s
       end
@@ -17,6 +16,7 @@ class Card
 
       def format_class opts
         return opts[:format_class] if opts[:format_class]
+
         format = opts[:format] || :html
         class_from_name format_class_name(format)
       end
@@ -30,6 +30,7 @@ class Card
 
       def format_sym format
         return format if format.is_a? Symbol
+
         match = format.to_s.match(/::(?<format>[^:]+)Format/)
         match ? match[:format].underscore.to_sym : :base
       end
@@ -42,20 +43,22 @@ class Card
       def extract_class_vars view, opts
         Card::Format::VIEW_VARS.each do |varname|
           next unless (value = opts.delete varname)
+
           send(varname)[view] = value
         end
       end
 
       def extract_view_tags view, tags
         return unless tags
+
         Array.wrap(tags).each do |tag|
           view_tags[view] ||= {}
           view_tags[view][tag] = true
         end
       end
 
-      def view_cache_setting_method view
-        "view_#{view}_cache_setting"
+      def view_setting_method_name view, setting_name
+        "view_#{view}_#{setting_name}_setting"
       end
 
       def class_from_name formatname
@@ -68,6 +71,7 @@ class Card
 
       def tagged view, tag
         return unless view && tag && (viewhash = view_tags[view.to_sym])
+
         viewhash[tag.to_sym]
       end
 

data/lib/card/format/render.rb

@@ -3,14 +3,15 @@ class Card
     # View rendering methods.
     #
     module Render
-      def render! view, args={}
-        voo = View.new self, view, args, @voo
+      # view=open&layout=simple
+      def render! view, view_options={}
+        voo = View.new self, view, view_options, @voo
         with_voo voo do
           voo.process do |final_view|
             final_render final_view
           end
         end
-      rescue => e
+      rescue StandardError => e
         rescue_view e, view
       end
 
@@ -22,12 +23,55 @@ class Card
         @voo = old_voo
       end
 
+      def with_wrapper
+        if voo.layout.present?
+          voo.wrap ||= []
+          layout = voo.layout.to_name.key
+          # don't wrap twice with modals or overlays
+          # this can happen if the view is wrapped with modal
+          # and is requested with layout=modal param
+          voo.wrap.push layout unless voo.wrap.include? layout.to_sym
+        end
+
+        @rendered = yield
+        wrap_with_wrapper
+      end
+
+      def wrap_with_wrapper
+        return @rendered unless voo.wrap.present?
+
+        voo.wrap.reverse.each do |wrapper, opts|
+          @rendered = render_with_wrapper(wrapper, opts) ||
+                      render_with_card_layout(wrapper) ||
+                      raise_wrap_error(wrapper)
+        end
+        @rendered
+      end
+
+      def render_with_wrapper wrapper, opts
+        try("wrap_with_#{wrapper}", opts) { @rendered }
+      end
+
+      def render_with_card_layout mark
+        return unless Card::Layout.card_layout? mark
+
+        Card::Layout::CardLayout.new(mark, self).render
+      end
+
+      def raise_wrap_error wrapper
+        if wrapper.is_a? String
+          raise Card::Error::UserError, "unknown layout card: #{wrapper}"
+        else
+          raise ArgumentError, "unknown wrapper: #{wrapper}"
+        end
+      end
+
       def before_view view
         try "_before_#{view}"
       end
 
       def voo
-        @voo
+        @voo ||= View.new self, nil, {}
       end
 
       def show_view? view, default_viz=:show
@@ -38,14 +82,21 @@ class Card
 
       def final_render view
         current_view(view) do
-          method = view_method view
-          rendered = method.call
-          add_debug_info view, method, rendered
+          with_wrapper do
+            method = view_method view
+            rendered = final_render_call method
+            add_debug_info view, method, rendered
+          end
         end
       end
 
+      def final_render_call method
+        method.call
+      end
+
       def add_debug_info view, method, rendered
         return rendered unless show_debug_info?
+
         <<-HTML
           <view-debug view='#{safe_name}##{view}' src='#{pretty_path method.source_location}' module='#{method.owner}'/>
           #{rendered}
@@ -57,17 +108,24 @@ class Card
       end
 
       def pretty_path source_location
-        source_location.first.gsub(%r{^.+mod\d+-([^/]+)}, '\1: ') + ':' +
+        source_location.first.gsub(%r{^.+mod\d+-([^/]+)}, '\1: ') + ":" +
           source_location.second.to_s
       end
 
       # setting (:alway, :never, :nested) designated in view definition
       def view_cache_setting view
-        method = self.class.view_cache_setting_method view
-        coded_setting = respond_to?(method) ? send(method) : :standard
+        coded_setting = view_setting(:cache, view) || :standard
+        # method = self.class.view_cache_setting_method view
+        # coded_setting = respond_to?(method) ? send(method) : :standard
         return :never if coded_setting == :never
+
         # seems unwise to override a hard-coded "never"
-        (voo && voo.cache) || coded_setting
+        (voo&.cache) || coded_setting
+      end
+
+      def view_setting setting_name, view
+        method = self.class.view_setting_method_name view, setting_name
+        try method
       end
 
       def stub_render cached_content
@@ -86,6 +144,7 @@ class Card
       def prepare_stub_nest stub_hash
         stub_card = Card.fetch_from_cast stub_hash[:cast]
         view_opts = stub_hash[:view_opts]
+        voo.normalize_special_options! view_opts
         if stub_card&.key.present? && stub_card.key == card.key
           view_opts[:nest_name] ||= "_self"
         end
@@ -113,15 +172,12 @@ class Card
         unless supports_view? view
           raise Card::Error::UserError, unsupported_view_error_message(view)
         end
-        method view_method_name(view)
-      end
 
-      def supports_view? view
-        respond_to? view_method_name(view)
+        method Card::Set::Format.view_method_name(view)
       end
 
-      def view_method_name view
-        "_view_#{view}"
+      def supports_view? view
+        respond_to? Card::Set::Format.view_method_name(view)
       end
 
       def current_view view