card 1.91 → 1.92

data/lib/card/format/context_names.rb

@@ -0,0 +1,40 @@
+class Card
+  class Format
+    module ContextNames
+
+      def context_names
+        @context_names ||= initial_context_names
+      end
+
+      def initial_context_names
+        @initial_context_names ||=
+          parent ? context_names_from_parent : context_names_from_params
+      end
+
+      def context_names_from_parent
+        part_keys = @card.cardname.part_names.map(&:key)
+        parent.context_names.reject { |n| !part_keys.include? n.key }
+      end
+
+      def context_names_from_params
+        return [] unless (name_list = Card::Env.slot_opts[: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
+
+      def add_name_context name=nil
+        name ||= card.name
+        @context_names = (context_names + name.to_name.part_names).uniq
+      end
+
+      def title_in_context title=nil
+        title = title ? title.to_name.absolute_name(card.cardname) : card.cardname
+        title.from *context_names
+      end
+    end
+  end
+end

data/lib/card/format/error.rb

@@ -9,16 +9,20 @@ class Card
       end
 
       def debug_error e
-        debug = Card[:debugger]
-        raise e if debug && debug.content == "on"
+        raise e if Card[:debugger]&.content == "on"
       end
 
       def error_cardname
-        card && card.name.present? ? card.name : "unknown card"
+        if card&.name.present?
+          card.name
+        else
+          I18n.t :no_cardname, scope: [:lib, :card, :format, :error]
+        end
       end
 
       def rendering_error _exception, view
-        "Error rendering: #{error_cardname} (#{view} view)"
+        I18n.t :error_rendering, scope: [:lib, :card, :format, :error],
+               cardname: error_cardname, view: view
       end
     end
   end

data/lib/card/format/nest.rb

@@ -4,7 +4,7 @@ class Card
       include Fetch
       include Main
       include Subformat
-      include View
+      include Mode
 
       # nested by another card's content
       # (as opposed to a direct API nest)
@@ -15,11 +15,11 @@ class Card
         nest nest_name, opts
       end
 
-      def nest cardish, options={}, &block
+      def nest cardish, options={}, override=true, &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
+        nest_render nested_card, view, options, override, &block
       end
 
       def interpret_nest_options nested_card, options
@@ -42,9 +42,9 @@ class Card
         :name
       end
 
-      def nest_render nested_card, view, options
+      def nest_render nested_card, view, options, override
         subformat = nest_subformat nested_card, options, view
-        view = subformat.modal_nest_view view
+        view = subformat.modal_nest_view view if override
         rendered = count_chars { subformat.optional_render view, options }
         block_given? ? yield(rendered, view) : rendered
       end
@@ -90,12 +90,12 @@ class Card
       private
 
       def nest_invisible?
-        @mode == :closed && @char_count && @char_count > max_char_count
+        nest_mode == :closed && @char_count && (@char_count > max_char_count)
       end
 
       def count_chars
         result = yield
-        return result unless @mode == :closed && result
+        return result unless nest_mode == :closed && result
         @char_count ||= 0
         @char_count += result.length
         result

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

@@ -21,7 +21,7 @@ class Card
           new_args = { name: nest_name, type: nest_opts[:type] }
 
           new_args[:supercard] = card.context_card unless nest_name.strip.blank?
-          # special case.  gets absolutized incorrectly. fix in smartname?
+          # special case.  gets absolutized incorrectly. fix in cardname?
 
           nest_new_main_args new_args if nest_name =~ /^_main\+/
           nest_new_content_args new_args, nest_name

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

@@ -0,0 +1,75 @@
+class Card
+  class Format
+    module Nest
+      module Mode
+        # A nest can be rendered in one of four modes: normal, closed, edit, or template.
+
+        # In _normal_ mode nests are rendered in the requested view without alteration.
+        # In _closed_ mode nest rendering is altered to fit within a single line
+        # In _edit_ mode, a nest's view is replaced (where applicable) with a form element to edit content
+        # In _template_ mode, the view is replaced with a link to a nest editor to edit rules and options for that nest
+
+        # current nest mode
+        # @return [Symbol] :normal, :closed, :edit, or :template
+        def nest_mode
+          @nest_mode ||= parent ? parent.nest_mode : :normal
+        end
+
+        # run block with new_mode as nest_mode, then return to prior mode
+        # @param new_mode [Symbol] :normal, :closed, :edit, or :template
+        # @return block result
+        def with_nest_mode new_mode
+          old_mode = nest_mode
+          @nest_mode = new_mode
+          result = yield
+          @nest_mode = old_mode
+          result
+        end
+
+        # view to be rendered in current mode
+        # @param view [Symbol]
+        # @return [Symbol] viewname
+        def modal_nest_view view
+          # Note: the subformat always has the same nest_mode as its parent format
+          case nest_mode
+          when :edit     then view_in_edit_mode(view)
+          when :template then :template_rule
+          when :closed   then view_in_closed_mode(view)
+          else view
+          end
+        end
+
+        # Returns the view that the card should use when nested in edit mode
+        # @param view [Symbol]
+        # @return [Symbol] viewname
+        def view_in_edit_mode view
+          hide_view_in_edit_mode?(view) ? :blank : :edit_in_form
+        end
+
+        # @param view [Symbol]
+        # @return [True/False]
+        def hide_view_in_edit_mode? view
+          Card::Format.perms[view] == :none || # view never edited
+            card.structure                  || # not yet nesting structures
+            card.key.blank?                    # eg {{_self|type}} on new cards
+        end
+
+        # the view that should be used when nested in closed mode
+        # @param view [Symbol]
+        # @return [Symbol] viewname
+        def view_in_closed_mode view
+          configured_view_in_closed_mode(view) || (card.known? ? :closed_content : :closed_missing)
+        end
+
+        # the view configured in view definition for use when nested in closed mode
+        # @param view [Symbol]
+        # @return [Symbol] viewname
+        def configured_view_in_closed_mode view
+          closed_config = Card::Format.closed[view]
+          return view if closed_config == true || Card::Format.error_code[view]
+          closed_config
+        end
+      end
+    end
+  end
+end

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

@@ -3,11 +3,24 @@ class Card
     module Nest
       module Subformat
         def subformat subcard
-          subcard = Card.fetch(subcard, new: {}) if subcard.is_a?(String)
-          self.class.new subcard, root: @root, parent: self, depth: @depth + 1,
-                                  form: @form,
-                                  mode: @mode,
-                                  context_names: @context_names
+          subcard = Card.fetch(subcard, new: {}) unless subcard.is_a?(Card)
+          self.class.new subcard, parent: self, format_class: self.class, form: @form
+        end
+
+        def root
+          @root ||= parent ? parent.root : self
+        end
+
+        def depth
+          @depth ||= parent ? (parent.depth + 1) : 0
+        end
+
+        def main?
+          depth.zero?
+        end
+
+        def focal? # meaning the current card is the requested card
+          depth.zero?
         end
 
         def field_subformat field

data/lib/card/format/permission.rb

@@ -38,7 +38,7 @@ class Card
 
       def subformats_nested_too_deeply?
         # prevent recursion
-        @depth >= Card.config.max_depth
+        depth >= Card.config.max_depth
       end
 
       def view_always_permitted? view

data/lib/card/format/registration.rb

@@ -1,10 +1,26 @@
 class Card
   class Format
     module Registration
+
       def register format
         registered << format.to_s
       end
 
+      def new card, opts={}
+        if self != Format
+          super
+        else
+          klass = format_class opts
+          self == klass ? super : klass.new(card, opts)
+        end
+      end
+
+      def format_class opts
+        return opts[:format_class] if opts[:format_class]
+        format = opts[:format] || :html
+        class_from_name format_class_name(format)
+      end
+
       def format_class_name format
         format = format.to_s
         format = "" if format == "base"
@@ -15,7 +31,7 @@ class Card
       def format_sym format
         return format if format.is_a? Symbol
         match = format.to_s.match(/::(?<format>[^:]+)Format/)
-        match ? match[:format] : :base
+        match ? match[:format].underscore.to_sym : :base
       end
 
       def interpret_view_opts view, opts
@@ -24,7 +40,7 @@ class Card
       end
 
       def extract_class_vars view, opts
-        [:perms, :error_code, :denial, :closed].each do |varname|
+        Card::Format::VIEW_VARS.each do |varname|
           next unless (value = opts.delete varname)
           send(varname)[view] = value
         end
@@ -42,16 +58,6 @@ class Card
         "view_#{view}_cache_setting"
       end
 
-      def new card, opts={}
-        if self != Format
-          super
-        else
-          format = opts[:format] || :html
-          klass = class_from_name format_class_name(format)
-          self == klass ? super : klass.new(card, opts)
-        end
-      end
-
       def class_from_name formatname
         if formatname == "Format"
           Card::Format

data/lib/card/format/render.rb

@@ -40,11 +40,9 @@ class Card
 
       def final_render view, args
         current_view(view) do
-          with_nest_mode view do
-            method = view_method view
-            rendered = method.arity.zero? ? method.call : method.call(args)
-            add_debug_info view, method, rendered
-          end
+          method = view_method view
+          rendered = method.arity.zero? ? method.call : method.call(args)
+          add_debug_info view, method, rendered
         end
       end
 
@@ -65,6 +63,10 @@ class Card
           source_location.second.to_s
       end
 
+      def view_caching?
+        true
+      end
+
       # setting (:alway, :never, :nested) designated in view definition
       def view_cache_setting view
         method = self.class.view_cache_setting_method view
@@ -75,10 +77,9 @@ class Card
       end
 
       def stub_render cached_content
-        return cached_content unless cached_content.is_a? String
         expand_stubs cached_content do |stub_hash|
-          prepare_stub_nest(stub_hash) do |stub_card, mode, options|
-            with_nest_mode(mode) { nest stub_card, options }
+          prepare_stub_nest(stub_hash) do |stub_card, mode, options, override|
+            with_nest_mode(mode) { nest stub_card, options, override }
           end
         end
       end
@@ -89,15 +90,24 @@ class Card
         if stub_card.key.present? && stub_card.key == card.key
           stub_options[:nest_name] ||= "_self"
         end
-        yield stub_card, stub_hash[:mode], stub_options
+        yield stub_card, stub_hash[:mode], stub_options, stub_hash[:override]
       end
 
       def expand_stubs cached_content
+        return cached_content unless cached_content.is_a? String
+
         conto = Card::Content.new cached_content, self, chunk_list: :stub
         conto.process_each_chunk do |stub_hash|
-          yield(stub_hash).to_s
+          yield(stub_hash)
+        end
+
+        if conto.pieces.size == 1
+          # for stubs in json format this converts a single stub back
+          # to it's original type (e.g. a hash)
+          conto.pieces.first.to_s
+        else
+          conto.to_s
         end
-        conto.to_s
       end
 
       def api_render match, opts
@@ -135,6 +145,7 @@ class Card
       ensure
         @current_view = old_view
       end
+
     end
   end
 end

data/lib/card/migration.rb

@@ -1,6 +1,6 @@
 # -*- encoding : utf-8 -*-
 
-class Card::Migration < ActiveRecord::Migration
+class Card::Migration < ActiveRecord::Migration[4.2]
   include Card::Model::SaveHelper
   @type = :deck_cards
 

data/lib/card/mod.rb

@@ -0,0 +1,63 @@
+require_dependency "card/mod/loader"
+require_dependency "card/mod/dirs"
+
+class Card
+  # A Card Mod (short for "module" or "modification") is a discrete piece of Decko functionality. Mods are how the Decko community develops and shares code. If you want to customize a deck in a way that can't be done on the site itself, try a mod.
+  #
+  # The simplest way to add a mod is in the `mod` directory of your deck, eg:
+  #
+  #     DECKNAME/mod/MODNAME
+  #
+  # In most mods, the focal point is the set modules.
+  #
+  # ## Set Modules
+  #
+  # Set modules define methods for a given set of cards and their format objects. They are defined in a mod's _set_ directory. For example, suppose you've created a mod that called *biz*, your deck has Company cards, and you want to extend the behavior of those cards.
+  #
+  # You can add a set module like so:
+  #
+  #       card generate set biz type company
+  #
+  # This will create the following two files:
+  #
+  #       mod/biz/set/type/company.rb
+  #       mod/biz/spec/set/type/company.rb
+  #
+  # If you would like to break this code into smaller files, you can extend this pattern into another directory, eg:
+  #
+  #       mod/biz/set/type/company/foo.rb
+  #       mod/biz/set/type/company/bar.rb
+  #
+  # The general pattern can be expressed as follows:
+  #
+  #       DECKNAME/mod/MODNAME/set/SET_PATTERN/ANCHOR[/FREENAME].rb
+  #
+  # Learn more:
+  #   - {Card} introduces card objects
+  #   - {Card::Set} provides an overview of the set module API
+  #   - {Card::View} explains the basics of the view API
+  #
+  # ## Other Directories
+  #
+  # Other ways your mod can extend Decko functionality include:
+  #   - **set_pattern** for additional {Card::Set::Pattern set patterns}, or types of sets.
+  #   - **format** for creating new formats
+  #   - **chunk** provides tools for finding new patterns in card content
+  #   - **layouts** can contain hardcoded layouts (layouts are more typically stored in content)
+  #   - **lib** for ruby libraries
+  #   - **file** for any other supporting files
+  #
+
+module Mod
+    class << self
+      def load
+        Loader.load_mods
+      end
+
+      # @return an array of Rails::Path objects
+      def dirs
+        @dirs ||= Dirs.new(Card.paths["mod"].existent)
+      end
+    end
+  end
+end