card 1.97.0.1 → 1.98.0

data/lib/card/format/nesting.rb

@@ -7,7 +7,7 @@ class Card
       include Mode
 
       # @param cardish card mark
-      # @param view_opts [Hash] opts will be passed on to render (and then voo)
+      # @param view_opts [Hash] {Card/View/Options view options}, passed on to render.
       # @param format_opts [Hash] opts will be passed on to subformat
       def nest cardish, view_opts={}, format_opts={}
         return "" if nest_invisible?
@@ -25,8 +25,9 @@ class Card
       #   home.nest :self         # => nest for '*self'
       #   home.field_nest :self   # => nest for 'Home+*self'
       def field_nest field, opts={}
-        field = card.name.field(field) unless field.is_a? Card
-        nest field, opts
+        fullname = card.name.field(field) unless field.is_a? Card
+        opts[:title] ||= Card.fetch_name(field).vary("capitalized")
+        nest fullname, opts
       end
 
       # create a path for a nest with respect to the nest options
@@ -36,7 +37,8 @@ class Card
         path path_opts
       end
 
-      # frequently overridden
+      # view used if unspecified in nest.
+      # frequently overridden in other formats
       def default_nest_view
         :name
       end

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

@@ -40,27 +40,7 @@ class Card
 
         # view=edit&items=closed
         def main_nest_options
-          opts = inherit(:main_opts) || {}
-          main_nest_size_opt opts
-          main_nest_items_opt opts
-          opts
-        end
-
-        protected
-
-        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
+          inherit(:main_opts) || {}
         end
       end
     end

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

@@ -22,10 +22,10 @@ class Card
         # @param new_mode [Symbol] :normal, :closed, :edit, or :template
         # @return block result
         def with_nest_mode new_mode, &block
-          if new_mode
-            with_altered_nest_mode new_mode, &block
-          else
+          if new_mode == @nest_mode
             yield
+          else
+            with_altered_nest_mode new_mode, &block
           end
         end
 
@@ -39,7 +39,7 @@ class Card
 
         # view to be rendered in current mode
         # @param view [Symbol]
-        # @return [Symbol] viewname
+        # @return [Symbol ] viewname
         def modal_nest_view view
           # Note: the subformat always has the same nest_mode as its parent format
           case nest_mode
@@ -60,9 +60,9 @@ class Card
         # @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
+          view_setting(: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
@@ -77,7 +77,7 @@ class Card
         # @param view [Symbol]
         # @return [Symbol] viewname
         def configured_view_in_closed_mode view
-          closed_config = Card::Format.closed[view]
+          closed_config = view_setting(:closed, view)
           return view if closed_config == true
 
           closed_config

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

@@ -39,7 +39,7 @@ class Card
         # is format's card the format of the requested card?
         # (can be different from main in certain formats, see override in HtmlFormat)
         def focal?
-          depth.zero?
+          @focal ||= depth.zero?
         end
 
         def field_subformat field

data/lib/card/format/registration.rb

@@ -35,32 +35,6 @@ class Card
         match ? match[:format].underscore.to_sym : :base
       end
 
-      def interpret_view_opts view, opts
-        extract_class_vars view, opts
-        extract_view_tags view, opts.delete(:tags)
-      end
-
-      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_setting_method_name view, setting_name
-        "view_#{view}_#{setting_name}_setting"
-      end
-
       def class_from_name formatname
         if formatname == "Format"
           Card::Format
@@ -69,12 +43,6 @@ class Card
         end
       end
 
-      def tagged view, tag
-        return unless view && tag && (viewhash = view_tags[view.to_sym])
-
-        viewhash[tag.to_sym]
-      end
-
       def format_ancestry
         ancestry = [self]
         ancestry += superclass.format_ancestry unless self == Card::Format

data/lib/card/format/render.rb

@@ -75,7 +75,7 @@ class Card
       end
 
       def show_view? view, default_viz=:show
-        voo.process_visibility_options # trigger viz processing
+        voo.process_visibility # trigger viz processing
         visibility = voo.viz_hash[view] || default_viz
         visibility == :show
       end
@@ -112,30 +112,25 @@ class Card
           source_location.second.to_s
       end
 
-      # setting (:alway, :never, :nested) designated in view definition
+      # :standard, :always, :never
       def view_cache_setting view
-        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&.cache) || coded_setting
+        voo&.cache || view_setting(:cache, view) || :standard
       end
 
       def view_setting setting_name, view
-        method = self.class.view_setting_method_name view, setting_name
-        try method
+        try Card::Set::Format.view_setting_method_name(view, setting_name)
       end
 
       def stub_render cached_content
-        result = expand_stubs cached_content do |stub_hash|
-          prepare_stub_nest(stub_hash) do |stub_card, view_opts|
-            nest stub_card, view_opts, stub_hash[:format_opts]
-          end
+        stub_debugging do
+          expand_stubs cached_content
         end
-        if result =~ /stub/
-          Rails.logger.info "STUB IN RENDERED VIEW: #{card.name}: " \
+      end
+
+      def stub_debugging
+        result = yield
+        if Rails.env.development? && result =~ /stub/
+          Rails.logger.debug "STUB IN RENDERED VIEW: #{card.name}: " \
                             "#{voo.ok_view}\n#{result}"
         end
         result
@@ -155,9 +150,7 @@ class Card
         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)
-        end
+        conto.process_chunks
 
         if conto.pieces.size == 1
           # for stubs in json format this converts a single stub back
@@ -187,6 +180,12 @@ class Card
       ensure
         @current_view = old_view
       end
+
+      def stub_nest stub_hash
+        prepare_stub_nest(stub_hash) do |stub_card, view_opts|
+          nest stub_card, view_opts, stub_hash[:format_opts]
+        end
+      end
     end
   end
 end

data/lib/card/migration.rb

@@ -102,6 +102,13 @@ class Card
       Card::Migration::Import.new(data_path).merge only: names_or_keys
     end
 
+    def merge_pristine_cards names_or_keys
+      names_or_keys = Array(names_or_keys)
+
+      pristine = names_or_keys.select { |n| !Card.exists?(n) || Card.fetch(n)&.pristine? }
+      merge_cards pristine
+    end
+
     def read_json filename
       raw_json = File.read data_path(filename)
       json = JSON.parse raw_json

data/lib/card/mod.rb

@@ -11,7 +11,7 @@ class Card
   #
   #     decko generate card:mod MOD_NAME
   #
-  # This will create the follow directories:
+  # This will create the following directories:
   #
   #     DECK_NAME/mod/MOD_NAME
   #     DECK_NAME/mod/MOD_NAME/lib
@@ -52,7 +52,8 @@ class Card
   # Learn more:
   #   - {Card} introduces card objects
   #   - {Card::Set} provides an overview of how set modules work
-  #   - {Card::Format} explains the basics of the view API
+  #   - {Card::Set::Format} explains the basics of the format API
+  #   - {Card::Set::Format::AbstractFormat} explains the basics of the view definition API
   #   - {Card::Set::Event} explains the basics of the event API
   #
   # ## Other Directories

data/lib/card/mod/load_strategy.rb

@@ -21,6 +21,10 @@ class Card
         @loader = loader
       end
 
+      def clean_comments?
+        false
+      end
+
       private
 
       def module_type

data/lib/card/mod/load_strategy/eval.rb

@@ -6,7 +6,7 @@ class Card
       class Eval < LoadStrategy
         def load_modules
           each_file do |abs_path, module_names|
-            template = module_template.new module_names, abs_path
+            template = module_template.new module_names, abs_path, self
             template.build
           end
         end

data/lib/card/mod/load_strategy/pattern_tmp_files.rb

@@ -5,21 +5,21 @@ class Card
       class PatternTmpFiles < TmpFiles
         private
 
-        def load_tmp_files
-          load_dir tmp_dir
-        end
-
         def generate_tmp_files
           prepare_tmp_dir "tmp/set_pattern"
           seq = 100
           each_file do |abs_path, const_parts|
-            pattern = const_parts.first
+            pattern = const_parts.first.underscore
             to_file = "#{tmp_dir}/#{seq}-#{pattern}.rb"
             write_tmp_file abs_path, to_file, const_parts
             seq += 1
           end
         end
 
+        def load_tmp_files
+          Loader.load_dir tmp_dir
+        end
+
         def tmp_dir
           Card.paths["tmp/set_pattern"].first
         end

data/lib/card/mod/load_strategy/set_tmp_files.rb

@@ -14,6 +14,7 @@ class Card
               rel_path = abs_path.sub "#{mod_dir}/", ""
               tmp_filename = File.join mod_tmp_dir, rel_path
               const_parts = parts_from_path rel_path
+              # puts "write_tmp_file #{abs_path}, #{tmp_filename}, #{const_parts}"
               write_tmp_file abs_path, tmp_filename, const_parts
             end
           end

data/lib/card/mod/load_strategy/tmp_files.rb

@@ -6,7 +6,11 @@ class Card
       class TmpFiles < LoadStrategy
         def load_modules
           generate_tmp_files if rewrite_tmp_files?
-          load_temp_files
+          load_tmp_files
+        end
+
+        def clean_comments?
+          true
         end
 
         private
@@ -30,7 +34,7 @@ class Card
 
         def write_tmp_file from_file, to_file, const_parts
           FileUtils.mkdir_p File.dirname(to_file)
-          mt = module_template.new const_parts, from_file
+          mt = module_template.new const_parts, from_file, self
           File.write to_file, mt.to_s
         end
       end

data/lib/card/mod/loader.rb

@@ -17,7 +17,8 @@ class Card
     # The mods are given by a Mod::Dirs object.
     # SetLoader can use three different strategies to load the set modules.
     class Loader
-      def initialize load_strategy=:eval, mod_dirs=nil
+      def initialize load_strategy=nil, mod_dirs=nil
+        load_strategy ||= Cardio.config.load_strategy
         mod_dirs ||= Mod.dirs
         klass = load_strategy_class load_strategy
         @load_strategy = klass.new mod_dirs, self
@@ -57,7 +58,7 @@ class Card
           const_get :Template
         end
 
-        private
+        # private
 
         def load_initializers
           Card.config.paths["mod/config/initializers"].existent.sort.each do |initializer|

data/lib/card/mod/loader/set_loader.rb

@@ -25,7 +25,7 @@ class Card
         end
 
         class Template < ModuleTemplate
-          def initialize modules, content_path
+          def initialize modules, content_path, strategy
             super
             @modules.pop if helper_module?
           end
@@ -33,15 +33,37 @@ class Card
           def to_const
             return Object if simple_load?
 
-            pattern_klass = Card::Set.const_get_or_set(@pattern.camelize) { Class.new }
-
-            @modules.inject(pattern_klass) do |const, name_part|
+            @modules.inject(pattern_class) do |const, name_part|
               const.const_get_or_set name_part do
                 Module.new
               end
             end
           end
 
+          def processed_content
+            add_explicit_format_modules if @strategy.clean_comments?
+            super
+          end
+
+          def add_explicit_format_modules
+            @content.gsub!(/^ *format +:?(\w+)? *do *$/) do
+              format_name = $1.blank? ? nil : $1.to_sym
+              "module #{module_name format_name}; " \
+              "parent.send :register_set_format, #{format_class format_name}, self; "\
+              "extend Card::Set::AbstractFormat"
+            end
+          end
+
+          def module_name format_name
+            Card::Format.format_class_name format_name
+          end
+
+          def format_class format_name
+            klass = ["Card::Format"]
+            klass << module_name(format_name) if format_name
+            klass.join "::"
+          end
+
           def helper_module?
             if @is_helper_module.nil?
               @is_helper_module = @content =~ /\A#!\s?not? set module/
@@ -52,30 +74,75 @@ class Card
 
           # correct line number for error messages
           def offset
-            # One line for the module chain and one line for the source_location method
-            # The template changes so rarely that doesn't seem worth it to count
-            # it during runtime
-            helper_module? ? -4 : -5
+            -5
           end
 
           private
 
           def submodule_chain
-            @modules.map { |m| "module #{m};" }.join " "
+            @modules.map { |m| "module #{m};" }
           end
 
           def module_chain
-            "class Card; module Set; class #{@pattern.camelize}; #{submodule_chain}"
+            @module_chain ||=
+              ["class Card", "module Set", "class #{@pattern.camelize}"] + submodule_chain
+          end
+
+          def preamble_bits
+            capture_last_module
+            [module_chain.join("; "),
+             module_comment,
+             @last_module,
+             set_extension,
+             location_method].compact
+          end
+
+          def auto_comment
+            "# Set: #{label_body(*@modules)}\n#"
+          end
+
+          def label_body *anchors
+            if @pattern == "Abstract"
+              "Abstract (#{@modules.join ', '})"
+            else
+              pattern_label(*anchors)
+            end
+          end
+
+          def pattern_label *anchors
+            anchor_count = pattern_class.anchor_parts_count
+            label = pattern_class.label(pattern_anchor(*anchors, anchor_count))
+            remainder = anchors[anchor_count..-1]
+            label += " (#{remainder.join ', '})" if remainder.any?
+            label
+          end
+
+          def pattern_anchor *anchors, anchor_count
+            if anchor_count.zero?
+              ""
+            else
+              anchors[0..anchor_count].join(Card::Name.joint)
+            end
+          end
+
+          def pattern_class
+            @pattern_class ||= Card::Set.const_get_or_set(@pattern.camelize) { Class.new }
+          end
+
+          def capture_last_module
+            module_chain
+            @last_module = @module_chain.pop
+          end
+
+          def set_extension
+            "extend Card::Set" unless helper_module?
           end
 
-          def preamble
-            <<~RUBY.strip_heredoc
-              #{'extend Card::Set' unless helper_module?}
-                          def self.source_location; "#{@content_path}"; end
-            RUBY
+          def location_method
+            %(def self.source_location; "#{@content_path}"; end)
           end
 
-          def end_chain
+          def postamble
             "end;" * (@modules.size + 3)
           end
         end