card 1.19.6 → 1.20.0

data/lib/card/content/diff/result.rb

@@ -15,6 +15,10 @@ class Card
           @summary.rendered
         end
 
+        def summary_omits_content?
+          @summary.omits_content?
+        end
+
         def write_added_chunk text
           @adds_cnt += 1
           @complete << Card::Content::Diff.render_added_chunk(text)
@@ -45,6 +49,7 @@ class Card
 
             @summary = nil
             @chunks = []
+            @content_omitted = false
           end
 
           def rendered
@@ -52,6 +57,7 @@ class Card
               begin
                 truncate_overlap
                 @chunks.map do |chunk|
+                  @content_omitted ||= chunk[:action] == :ellipsis
                   render_chunk chunk[:action], chunk[:text]
                 end.join
               end
@@ -71,6 +77,10 @@ class Card
             end
           end
 
+          def omits_content?
+            @content_omitted || @remaining_chars < 0
+          end
+
           private
 
           def add_chunk text, action
@@ -105,6 +115,7 @@ class Card
           def process_ellipsis
             return unless @chunks.last[:action] == :ellipsis
             @chunks.pop
+            @content_omitted = true
             @remaining_chars += @joint.size
           end
 

data/lib/card/env/success.rb

@@ -116,6 +116,10 @@ class Card
         @params.marshal_dump
       end
 
+      def raw_params
+        @params
+      end
+
       def to_url name_context=@name_context
         case (target = target(name_context))
         when Card

data/lib/card/error.rb

@@ -45,6 +45,8 @@ class Card
 
     class << self
       def exception_view card, exception
+        Card::Error.current = exception
+
         case exception
         ## arguably the view and status should be defined in the error class;
         ## some are redundantly defined in view

data/lib/card/format.rb

@@ -32,7 +32,6 @@ class Card
     include Content
     include Error
 
-    extend Nest::ClassMethods
     extend Registration
 
     # FIXME: should be set in views
@@ -45,28 +44,30 @@ class Card
       send "#{accessor_name}=", {}
     end
 
-    attr_reader :card, :root, :parent, :main_opts
-    attr_accessor :form, :error_status, :nest_opts
+    attr_reader :card, :root, :parent, :main_opts, :mode
+    attr_accessor :form, :error_status
 
     def initialize card, opts={}
-      unless (@card = card)
-        msg = I18n.t :exception_init_without_card, scope: "lib.card.format"
-        raise Card::Error, msg
-      end
+      @card = card
+      require_card_to_initialize!
 
-      opts.each do |key, value|
-        instance_variable_set "@#{key}", value
-      end
+      opts.each { |key, value| instance_variable_set "@#{key}", value }
 
       @mode ||= :normal
       @root ||= self
       @depth ||= 0
 
-      @context_names = initialize_context_names
+      @context_names = initial_context_names
       include_set_format_modules
       self
     end
 
+    def require_card_to_initialize!
+      return if @card
+      msg = I18n.t :exception_init_without_card, scope: "lib.card.format"
+      raise Card::Error, msg
+    end
+
     def include_set_format_modules
       self.class.format_ancestry.reverse_each do |klass|
         card.set_format_modules(klass).each do |m|
@@ -98,11 +99,7 @@ class Card
     end
 
     def focal? # meaning the current card is the requested card
-      if Env.ajax?
-        @depth.zero?
-      else
-        main?
-      end
+      @depth.zero?
     end
 
     def template
@@ -116,7 +113,7 @@ class Card
 
     def method_missing method, *opts, &proc
       if method =~ /(_)?(optional_)?render(_(\w+))?/
-        render_api Regexp.last_match, opts
+        api_render Regexp.last_match, opts
       else
         pass_method_to_template_object(method, opts, proc) { yield }
       end

data/lib/card/format/content.rb

@@ -5,7 +5,7 @@ class Card
         content = override_content || render_raw || ""
         content_object = get_content_object content, opts
         content_object.process_each_chunk do |chunk_opts|
-          prepare_nest chunk_opts.merge(opts)
+          content_nest chunk_opts.merge(opts)
         end
         content_object.to_s
       end
@@ -33,7 +33,17 @@ class Card
       end
 
       def add_class options, klass
-        options[:class] = [options[:class], klass].flatten.uniq.compact * " "
+        options[:class] = css_classes options[:class], klass
+      end
+
+      alias_method :append_class, :add_class
+
+      def prepend_class options, klass
+        options[:class] = css_classes klass, options[:class]
+      end
+
+      def css_classes *array
+        array.flatten.uniq.compact * " "
       end
 
       def id_counter
@@ -43,14 +53,12 @@ class Card
       end
 
       def unique_id
-        "#{card.key}-#{id_counter}"
+        "#{card.cardname.safe_key}-#{id_counter}"
       end
 
-      def output content
-        case content
-        when String then content
-        when Array then content.compact.join "\n"
-        end
+      def output *content
+        content ||= yield
+        Array.wrap(content).flatten.compact.join "\n"
       end
     end
   end

data/lib/card/format/error.rb

@@ -3,14 +3,12 @@ class Card
     module Error
       def rescue_view e, view
         raise e if Rails.env =~ /^cucumber|test$/
-        Card::Error.current = e
-        card.notable_exception_raised
+        error_view = Card::Error.exception_view @card, e
+        # TODO: consider rendering dynamic error view here.
         rendering_error e, view
       end
 
-      def debug_error e, view
-        Rails.logger.info "#{rendering_error e, view}:\n" \
-                          "#{e.class} : #{e.message}"
+      def debug_error e
         debug = Card[:debugger]
         raise e if debug && debug.content == "on"
       end

data/lib/card/format/names.rb

@@ -1,14 +1,15 @@
 class Card
   class Format
     module Names
-      def initialize_context_names
-        if @context_names
-          context_names_minus_irrelevants
-        elsif params[:slot]
-          context_names_from_params
-        else
-          []
-        end
+      def initial_context_names
+        @initial_context_names ||=
+          if @context_names
+            context_names_minus_irrelevants
+          elsif params[:slot]
+            context_names_from_params
+          else
+            []
+          end
       end
 
       def context_names_minus_irrelevants
@@ -21,23 +22,28 @@ class Card
         context_name_list.split(",").map(&:to_name)
       end
 
+      def context_names_to_params
+        return unless @context_names
+        @context_names.join(",")
+      end
+
       def add_name_context name=nil
         name ||= card.name
         @context_names += name.to_name.part_names
         @context_names.uniq!
       end
 
-      def with_name_context name
-        old_context = @context_names
-        add_name_context name
-        result = yield
-        @context_names = old_context
-        result
-      end
+      # def with_name_context name
+      #   old_context = @context_names
+      #   add_name_context name
+      #   result = yield
+      #   @context_names = old_context
+      #   result
+      # end
 
       def showname title=nil
         if title
-          title.to_name.to_absolute_name(card.cardname).to_show(*@context_names)
+          card.cardname.title title, @context_names
         else
           @showname ||= card.cardname.to_show(*@context_names)
         end

data/lib/card/format/nest.rb

@@ -6,80 +6,84 @@ class Card
       include Subformat
       include View
 
-      def nest name_or_card_or_opts, opts={}
-        nested_card = fetch_nested_card name_or_card_or_opts, opts
-        opts = name_or_card_or_opts if name_or_card_or_opts.is_a? Hash
-        opts[:inc_name] ||= nested_card.name
-        nest_card nested_card, opts
+      # nested by another card's content
+      # (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
       end
 
-      # Main difference compared to #nest is that you can use
-      # codename symbols to get nested fields
-      # @example
-      #   home = Card['home'].format
-      #   home.nest :self         # => nest for '*self'
-      #   home.field_nest :self   # => nest for 'Home+*self'
-      def field_nest field, opts={}
-        if field.is_a?(Card)
-          nest_card field, opts
-        else
-          prepare_nest opts.merge(inc_name: card.cardname.field(field))
-        end
+      def nest cardish, options={}, &block
+        return "" if nest_invisible?
+        nested_card = fetch_nested_card cardish, options
+        view, options = interpret_nest_options nested_card, options
+        nest_render nested_card, view, options, &block
       end
 
-      def process_nest opts
-        opts ||= {}
-
-        if opts.key?(:comment)
-          # commented nest
-          opts[:comment]
-        elsif content_out_of_view?
-          ""
-        elsif main_nest_within_layout? opts
-          main_nest opts
-        else
-          # standard nest
-          count_chars { nest opts }
-        end
+      def interpret_nest_options nested_card, options
+        options[:nest_name] ||= nested_card.name
+        view = options[:view] || implicit_nest_view
+        view = Card::View.canonicalize view
+
+        # FIXME: should handle in closed / edit view definitions
+        options[:home_view] ||= [:closed, :edit].member?(view) ? :open : view
+
+        [view, options]
       end
 
-      # deprecated, use process_nest
-      alias_method :prepare_nest, :process_nest
+      def implicit_nest_view
+        view = voo_items_view || default_nest_view
+        Card::View.canonicalize view
+      end
 
-      def nest_card nested_card, opts={}
-        # ActiveSupport::Notifications.instrument('card', message:
-        # "nest: #{nested_card.name}, #{opts}") do
-        opts.delete_if { |_k, v| v.nil? }
-        opts.reverse_merge! nest_defaults(nested_card)
+      def default_nest_view
+        :name
+      end
 
-        subformat = nest_subformat nested_card, opts
-        view = canonicalize_view opts.delete :view
-        opts[:home_view] = [:closed, :edit].member?(view) ? :open : view
-        # FIXME: special views should be represented in view definitions
-        subformat.nest_render view, opts
+      def nest_render nested_card, view, options
+        subformat = nest_subformat nested_card, options, view
+        view = subformat.modal_nest_view view
+        rendered = count_chars { subformat.optional_render view, options }
+        block_given? ? yield(rendered, view) : rendered
       end
 
-      def nest_defaults nested_card
-        @nest_defaults ||= begin
-          defaults = get_nest_defaults(nested_card).clone
-          defaults.merge! @nest_opts if @nest_opts
-          defaults
-        end
+      def nest_subformat nested_card, opts, view
+        return self if reuse_format? opts, view
+        sub = subformat nested_card
+        sub.main! if opts[:main]
+        sub
       end
 
-      def get_nest_defaults _nested_card
-        { view: :name }
+      def reuse_format? opts, view
+        return false unless opts[:nest_name] =~ /^_(self)?$/
+        !content_view? view
       end
 
-      private
+      def content_view? view
+        # TODO: this should be specified in view definition
+        [:core, :content, :titled, :open, :closed].member? view.to_sym
+      end
 
-      def content_out_of_view?
-        @mode == :closed && @char_count &&
-          @char_count > Card.config.max_char_count
+      # Main difference compared to #nest is that you can use
+      # codename symbols to get nested fields
+      # @example
+      #   home = Card['home'].format
+      #   home.nest :self         # => nest for '*self'
+      #   home.field_nest :self   # => nest for 'Home+*self'
+      def field_nest field, opts={}
+        field = card.cardname.field(field) unless field.is_a? Card
+        nest field, opts
       end
 
-      def main_nest_within_layout? opts
-        opts[:inc_name] == "_main" && show_layout? && @depth.zero?
+      # opts[:home_view] = [:closed, :edit].member?(view) ? :open : view
+      # FIXME: special views should be represented in view definitions
+
+      private
+
+      def nest_invisible?
+        @mode == :closed && @char_count && @char_count > max_char_count
       end
 
       def count_chars
@@ -90,10 +94,12 @@ class Card
         result
       end
 
-      module ClassMethods
-        def max_depth
-          Card.config.max_depth
-        end
+      def max_depth
+        Card.config.max_depth
+      end
+
+      def max_char_count
+        Card.config.max_char_count
       end
     end
   end

data/lib/card/format/nest/fetch.rb

@@ -3,49 +3,56 @@ class Card
     module Nest
       # Fetch card for a nest
       module Fetch
-        def fetch_nested_card name_or_card_or_opts, opts={}
-          case name_or_card_or_opts
-          when Card
-            name_or_card_or_opts
-          when Hash
-            opts = name_or_card_or_opts
-            Card.fetch(opts[:inc_name], new: nest_new_args(opts))
-          when Symbol
-            Card.fetch(name_or_card_or_opts)
+        def fetch_nested_card cardish, opts={}
+          case cardish
+          when Card            then cardish
+          when Symbol, Integer then Card.fetch cardish
           else
-            opts[:inc_name] = name_or_card_or_opts.to_s
-            Card.fetch name_or_card_or_opts, new: nest_new_args(opts)
+            opts[:nest_name] = cardish.to_s
+            Card.fetch cardish, new: nest_new_args(opts)
           end
         end
 
         private
 
-        def nest_content cardname
-          content = params[cardname.to_s.tr("+", "_")]
+        def nest_new_args nest_opts
+          nest_name = nest_opts[:nest_name].to_s
+          new_args = { name: nest_name, type: nest_opts[:type] }
 
-          # CLEANME This is a hack so plus cards re-populate on failed signups
-          p = params["subcards"]
-          if p && (card_params = p[cardname.to_s])
-            content = card_params["content"]
-          end
-          content if content.present? # returns nil for empty string
+          new_args[:supercard] = card unless nest_name.strip.blank?
+          # special case.  gets absolutized incorrectly. fix in smartname?
+
+          nest_new_main_args new_args if nest_name =~ /^_main\+/
+          nest_new_content_args new_args, nest_name
+          new_args
         end
 
-        def nest_new_args opts
-          args = { name: opts[:inc_name], type: opts[:type], supercard: card }
-          args.delete(:supercard) if opts[:inc_name].strip.blank?
-          # special case.  gets absolutized incorrectly. fix in smartname?
-          if opts[:inc_name] =~ /^_main\+/
-            # FIXME: this is a rather hacky (and untested) way to get @superleft
-            # to work on new cards named _main+whatever
-            args[:name] = args[:name].gsub(/^_main\+/, "+")
-            args[:supercard] = root.card
-          end
-          if (content = nest_content opts[:inc_name])
-            args[:content] = content
-          end
-          args
+        def nest_new_main_args new_args
+          # FIXME: this is a rather hacky way to get @superleft
+          # to work on new cards named _main+whatever
+          new_args[:name] = new_args[:name].gsub(/^_main\+/, "+")
+          new_args[:supercard] = root.card
         end
+
+        def nest_new_content_args new_args, nest_name
+          content = nest_content_from_shorthand_param(nest_name) ||
+                    nest_content_from_subcard_params(nest_name)
+          new_args[:content] = content if content.present?
+        end
+
+        def nest_content_from_shorthand_param nest_name
+          shorthand_param = nest_name.tr "+", "_"
+          # FIXME: this is a lame shorthand; could be another card's key
+          # should be more robust and managed by Card::Name
+          params[shorthand_param]
+        end
+
+        def nest_content_from_subcard_params nest_name
+          return unless (subcard_params = params["subcards"])
+          return unless (nestcard_params = subcard_params[nest_name])
+          nestcard_params["content"]
+        end
+
       end
     end
   end