card 1.109.0 → 1.110.0

data/lib/card/format/render.rb

@@ -41,6 +41,58 @@ class Card
         add_debug_info view, method, rendered
       end
 
+      def pretty_path source_location
+        "#{source_location.first.gsub(%r{^.+mod\d+-([^/]+)},
+                                      '\1: ')}:#{source_location.second}"
+      end
+
+      # see {Abstract::Format}
+      # (:default), :yes, :deep, :force, :always, :never
+      def view_cache_setting view
+        voo&.cache || view_setting(:cache, view) || :default
+      end
+
+      def view_setting setting_name, view
+        try Card::Set::Format.view_setting_method_name(view, setting_name)
+      end
+
+      def stub_render cached_content
+        return cached_content if Cardio.config.view_cache == :debug
+
+        # stub_debugging do
+        # Rails.logger.info cached_content
+        expand_stubs cached_content
+        # end
+      end
+
+      def view_method view
+        unless supports_view? view
+          raise Card::Error::UserError, unsupported_view_error_message(view)
+        end
+
+        method Card::Set::Format.view_method_name(view)
+      end
+
+      def supports_view? view
+        respond_to? Card::Set::Format.view_method_name(view)
+      end
+
+      def current_view view
+        old_view = @current_view
+        @current_view = view
+        yield
+      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
+
+      private
+
       def wrap_and_render view
         current_view(view) { with_wrapper { final_render view } }
       rescue StandardError => e
@@ -64,36 +116,15 @@ class Card
         Env.params[:debug] == "view"
       end
 
-      def pretty_path source_location
-        "#{source_location.first.gsub(%r{^.+mod\d+-([^/]+)},
-                                      '\1: ')}:#{source_location.second}"
-      end
-
-      # see {Abstract::Format}
-      # (:default), :yes, :deep, :always, :never
-      def view_cache_setting view
-        voo&.cache || view_setting(:cache, view) || :default
-      end
-
-      def view_setting setting_name, view
-        try Card::Set::Format.view_setting_method_name(view, setting_name)
-      end
-
-      def stub_render cached_content
-        # stub_debugging do
-        expand_stubs cached_content
-        # end
+      def stub_debugging
+        result = yield
+        if Rails.env.development? && result.is_a?(String) && result =~ /StUb/
+          Rails.logger.debug "STUB IN RENDERED VIEW: #{card.name}: " \
+                             "#{voo.ok_view}\n#{result}"
+        end
+        result
       end
 
-      # def stub_debugging
-      #   result = yield
-      #   if Rails.env.development? && result.is_a?(String) && result =~ /StUb/
-      #     Rails.logger.debug "STUB IN RENDERED VIEW: #{card.name}: " \
-      #                       "#{voo.ok_view}\n#{result}"
-      #   end
-      #   result
-      # end
-
       def prepare_stub_nest stub_hash
         stub_card = Card.fetch_from_cast stub_hash[:cast]
         view_opts = stub_hash[:view_opts]
@@ -118,32 +149,6 @@ class Card
           conto.to_s
         end
       end
-
-      def view_method view
-        unless supports_view? view
-          raise Card::Error::UserError, unsupported_view_error_message(view)
-        end
-
-        method Card::Set::Format.view_method_name(view)
-      end
-
-      def supports_view? view
-        respond_to? Card::Set::Format.view_method_name(view)
-      end
-
-      def current_view view
-        old_view = @current_view
-        @current_view = view
-        yield
-      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/format/wrapper.rb

@@ -41,9 +41,9 @@ class Card
       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
+
+          raise ArgumentError, "unknown wrapper: #{wrapper}"
       end
 
       def send_wrapper_method method_name, opts

data/lib/card/lexicon.rb

@@ -18,9 +18,12 @@ class Card
       # param name [String]
       # @return [Integer]
       def id name
-        return unless name.present?
+        return if name.blank?
 
-        (lex = name_to_lex name.to_name) && lex_to_id(lex)
+        name = name.to_name
+        return if name.relative_fragment?
+
+        (lex = name_to_lex name) && lex_to_id(lex)
       end
 
       def cache

data/lib/card/model/save_helper/save_helper_helper.rb

@@ -17,11 +17,11 @@ class Card
           Card.exist? name
         end
 
-        def method_missing method, *args
+        def method_missing(method, *)
           method_name, cardtype_card = extract_cardtype_from_method_name method
           return super unless method_name
 
-          sargs = standardize_args(*args).merge(type_id: cardtype_card.id)
+          sargs = standardize_args(*).merge(type_id: cardtype_card.id)
           if method_name == "ensure"
             Card.ensure sargs
           else

data/lib/card/model/save_helper.rb

@@ -12,8 +12,8 @@ class Card
       include SaveHelperHelper
       include SaveArguments
 
-      def with_user user_name, &block
-        Card::Auth.with(current_id: user_name.card_id, &block)
+      def with_user(user_name, &)
+        Card::Auth.with(current_id: user_name.card_id, &)
       end
 
       def create_card name_or_args, content_or_args=nil

data/lib/card/name/all/parts.rb

@@ -3,14 +3,14 @@ class Card
     module All
       # Card methods for handling name parts, eg A and B are both parts of A+B
       module Parts
-        def left *args
+        def left(*)
           case
           when simple?   then nil
           when superleft then superleft
           when name_is_changing? && name.to_name.trunk_name == name_before_act.to_name
             nil # prevent recursion when, eg, renaming A+B to A+B+C
           else
-            Card.fetch name.left, *args
+            Card.fetch(name.left, *)
           end
         end
 
@@ -18,16 +18,16 @@ class Card
           left(args) || Card.new(args.merge(name: name.left))
         end
 
-        def right *args
-          Card.fetch(name.right, *args) unless simple?
+        def right(*)
+          Card.fetch(name.right, *) unless simple?
         end
 
-        def trunk *args
-          simple? ? self : left(*args)
+        def trunk(*)
+          simple? ? self : left(*)
         end
 
-        def tag *args
-          simple? ? self : Card.fetch(name.right, *args)
+        def tag(*)
+          simple? ? self : Card.fetch(name.right, *)
         end
 
         def right_id= cardish
@@ -44,11 +44,11 @@ class Card
           when_id_exists(cardish) { |id| write_attribute attribute, id }
         end
 
-        def when_id_exists cardish, &block
+        def when_id_exists(cardish, &)
           if (card_id = Card.id cardish)
             yield card_id
           elsif cardish.is_a? Card
-            with_id_after_store cardish, &block
+            with_id_after_store(cardish, &)
           else
             yield cardish # eg nil
           end

data/lib/card/name/all.rb

@@ -24,7 +24,6 @@ class Card
         update_subcard_names @name
         write_attribute :name, (@name.simple? ? @name.s : nil)
         assign_side_ids
-        @name
       end
 
       def [] *args
@@ -58,6 +57,10 @@ class Card
         end
       end
 
+      def id_string
+        "~#{id}"
+      end
+
       def key= newkey
         return if newkey == key
 
@@ -66,7 +69,6 @@ class Card
           @key = newkey
         end
         clean_patterns
-        @key
       end
 
       private

data/lib/card/name.rb

@@ -40,7 +40,7 @@ class Card
         elsif (id = id_from_string str)  # handles ~[id] and :[codename]
           from_id_from_string id, str
         else
-          super str
+          super(str)
         end
       end
 
@@ -89,8 +89,8 @@ class Card
         new_from_parts(parts) { |part| new part }
       end
 
-      def new_from_parts parts, &block
-        name_parts = parts.flatten.map(&block)
+      def new_from_parts(parts, &)
+        name_parts = parts.flatten.map(&)
         new name_parts.join(joint), true
       end
 

data/lib/card/query/card_class.rb

@@ -2,9 +2,9 @@ class Card
   module Query
     # query-related methods with which to extend Card class
     module CardClass
-      def search spec, comment=nil, &block
+      def search(spec, comment=nil, &)
         results = ::Card::Query.run(spec, comment)
-        results.each(&block) if block_given? && results.is_a?(Array)
+        results.each(&) if block_given? && results.is_a?(Array)
         results
       end
 

data/lib/card/query/card_query/interpretation.rb

@@ -103,7 +103,7 @@ class Card
         end
 
         def relate_multi_value_with_subcondition key, conj, val
-          send conj, (val.map { |v| { key => v } })
+          send(conj, val.map { |v| { key => v } })
         end
 
         def relate_multi_value_without_subcondition method, key, val

data/lib/card/query/card_query/normalization.rb

@@ -28,7 +28,7 @@ class Card
           case clause
           when Hash              then clause
           when Integer           then { id: clause }
-          when String            then { id: (Card::Lexicon.id(clause) || -2) }
+          when String            then { id: Card::Lexicon.id(clause) || -2 }
           when Symbol            then { id: Card::Codename.id(clause) }
           else raise Error::BadQuery, "Invalid clause: #{clause.inspect}"
           end

data/lib/card/query/card_query/relational_attributes.rb

@@ -4,7 +4,7 @@ class Card
       # interpret CQL attributes that relate multiple cards
       # each method below corresponds to a relational CQL term
       #
-      # NOTE: methods using "restrict" can  be executed without
+      # NOTE: methods using "restrict" can be executed without
       # tying in an additional query if the val in question can be
       # reduced to an id.
       module RelationalAttributes

data/lib/card/query/card_query/run.rb

@@ -38,7 +38,7 @@ class Card
           case
           when respond_to?(:"#{retrn}_result") then :"#{retrn}_result"
           when retrn.match?(/id$/)             then :id_result
-          when retrn.match?(/_\w+/)            then :name_result
+          when retrn.match?(/^_\w+/)           then :name_result
           when retrn == "key"                  then :key_result
           else                                      :default_result
           end
@@ -52,6 +52,10 @@ class Card
           record[field]
         end
 
+        def content_result record, _pattern
+          record["db_content"]
+        end
+
         def id_result record, field
           record[field].to_i
         end

data/lib/card/query/card_query.rb

@@ -13,6 +13,7 @@ class Card
       include Sorting
       include Conjunctions
       include Custom
+
       # Query Execution
 
       # By default a query returns card objects. This is accomplished by returning
@@ -32,7 +33,7 @@ class Card
       end
 
       def initialize statement, comment=nil
-        super statement
+        super(statement)
         @comment = comment || default_comment
         interpret @statement
       end

data/lib/card/query/sql_statement/where.rb

@@ -3,7 +3,7 @@ class Card
     class SqlStatement
       # handle where clause in SqlStatement
       module Where
-        def where explicit=true
+        def where explicit: true
           conditions = [explicit_conditions(@query), implicit_conditions(@query)]
           conditions = conditions.reject(&:blank?).join " AND "
           "#{'WHERE ' if explicit}#{conditions}" unless conditions.blank?

data/lib/card/query/sql_statement.rb

@@ -24,6 +24,7 @@ class Card
         @fields = fields
         @tables = tables
         @joins  = joins
+        @indexes = indexes
         @where  = where
         @group  = group
         @order  = order
@@ -33,7 +34,8 @@ class Card
 
       def to_s
         [
-          comment, select, from, @joins, @where, @group, @order, @limit_and_offset
+          comment, select, from,
+          @joins, @indexes, @where, @group, @order, @limit_and_offset
         ].compact.join " "
       end
 
@@ -103,6 +105,10 @@ class Card
         end
       end
 
+      def indexes
+        "USE INDEX (#{Array.wrap(@mods[:index]).join ', '})" if @mods[:index]
+      end
+
       def full_syntax
         @query.full? ? yield : return
       end

data/lib/card/query.rb

@@ -83,7 +83,7 @@ class Card
     # "dir" is DEPRECATED in favor of sort_dir
     # "sort" is DEPRECATED in favor of sort_by, except in cases where sort's value
     # is a hash
-    MODIFIERS = %i[conj return sort_by sort_as sort_dir sort dir group limit offset]
+    MODIFIERS = %i[conj return index sort_by sort_as sort_dir sort dir group limit offset]
                 .each_with_object({}) { |v, h| h[v] = nil }
 
     OPERATORS =

data/lib/card/reference/all.rb

@@ -113,10 +113,10 @@ class Card
         end
       end
 
-      def each_reference_type ref_types, &block
+      def each_reference_type(ref_types, &)
         ref_types.delete PARTIAL_REF_CODE if ref_types.size > 1
         # partial references are not necessary if there are explicit references
-        ref_types.each(&block)
+        ref_types.each(&)
       end
 
       # invokes the given block for each reference in content with

data/lib/card/set/advanced_api.rb

@@ -9,16 +9,17 @@ class Card
 
       def setting_opts opts
         extend Card::Setting
+
         register_setting opts
       end
 
-      def ensure_set &block
+      def ensure_set(&)
         set_module = yield
         set_module = card_set_module_const_get(set_module) unless set_module.is_a?(Module)
       rescue NameError => e
         define_set_from_error e
         # try again - there might be another submodule that doesn't exist
-        ensure_set(&block)
+        ensure_set(&)
       else
         set_module.extend Card::Set
       end
@@ -32,7 +33,7 @@ class Card
 
       def attachment name, args
         include_set Abstract::Attachment
-        add_attributes name, "remote_#{name}_url".to_sym,
+        add_attributes name, :"remote_#{name}_url",
                        :action_id_of_cached_upload, :empty_ok,
                        :storage_type, :bucket, :mod
         mount_uploader name, (args[:uploader] || ::CarrierWave::FileCardUploader)

data/lib/card/set/event/all.rb

@@ -31,7 +31,7 @@ class Card
 
         def on_condition_applies? _event, actions
           actions = Array(actions).compact
-          actions.empty? ? true : actions.include?(action)
+          actions.empty? || actions.include?(action)
         end
 
         # if changing name/type, the old card has no-longer-applicable set modules,

data/lib/card/set/event.rb

@@ -69,8 +69,8 @@ class Card
         #   event to fire.
         # @option opts [Symbol] :stage alternate representation for specifying stage
         # @option opts [True/False] :after_subcards run event after running subcard events
-        def event event, stage_or_opts={}, opts={}, &final
-          Event.new(event, self).register stage_or_opts, opts, &final
+        def event(event, stage_or_opts={}, opts={}, &)
+          Event.new(event, self).register(stage_or_opts, opts, &)
         end
       end
 
@@ -160,15 +160,13 @@ class Card
     end
   end
 
-  def rescuing_if_integration is_integration, &block
-    is_integration ? rescuing_integration(&block) : yield
+  def rescuing_if_integration(is_integration, &)
+    is_integration ? rescuing_integration(&) : yield
   end
 
   # one failed integration event should not harm others.
-  def rescuing_integration &block
-    Error.rescue_card(self, &block)
-  ensure
-    true
+  def rescuing_integration(&)
+    Error.rescue_card(self, &)
   end
 
   def log_event_call event

data/lib/card/set/format/abstract_format/haml_views.rb

@@ -24,9 +24,9 @@ class Card
 
           private
 
-          def haml_view_block view, &block
+          def haml_view_block(view, &)
             path = haml_template_path view
-            haml_template_proc ::File.read(path), path, &block
+            haml_template_proc(::File.read(path), path, &)
           end
 
           def haml_template_proc template, path, &block

data/lib/card/set/format/abstract_format/view_definition.rb

@@ -9,8 +9,8 @@ class Card
 
           private
 
-          def define_view_method view, def_opts, &block
-            view_block = view_block view, def_opts, &block
+          def define_view_method(view, def_opts, &)
+            view_block = view_block(view, def_opts, &)
             view_type = def_opts[:async] ? :async : :standard
             send "define_#{view_type}_view_method", view, &view_block
           end
@@ -20,7 +20,7 @@ class Card
             define_method Card::Set::Format.view_method_name(view), &block
           end
 
-          def define_async_view_method view, &block
+          def define_async_view_method(view, &)
             # This case makes only sense for HtmlFormat
             # but I don't see an easy way to override class methods for a specific
             # format. All formats are extended with this general module. So
@@ -28,7 +28,7 @@ class Card
             # We need something like AbstractHtmlFormat for that.
 
             view_content = "#{view}_async_content"
-            define_standard_view_method view_content, &block
+            define_standard_view_method(view_content, &)
             define_standard_view_method view do
               %(<card-view-placeholder data-url="#{path view: view_content}" />)
             end
@@ -44,8 +44,8 @@ class Card
             end
           end
 
-          def template_view_block view, template, &block
-            return haml_view_block(view, &block) if template == :haml
+          def template_view_block(view, template, &)
+            return haml_view_block(view, &) if template == :haml
 
             raise Card::Error::ServerError, "unknown view template: #{template}"
           end

data/lib/card/set/format/abstract_format/wrapper.rb

@@ -37,20 +37,20 @@ class Card
           #   wrapper :burger, :div, class: "medium"
           #
           #   wrap_with_burger "meat"  # => "<div class='medium'>meat</div>"
-          def wrapper wrapper_name, *args, &wrap_block
+          def wrapper(wrapper_name, *, &)
             method_name = Card::Set::Format.wrapper_method_name(wrapper_name)
             if block_given?
-              define_method method_name, &wrap_block
+              define_method(method_name, &)
             else
-              define_tag_wrapper method_name, *args
+              define_tag_wrapper(method_name, *)
             end
             define_wrap_with_method wrapper_name, method_name
           end
 
-          def layout layout, opts={}, &block
+          def layout(layout, opts={}, &)
             Card::Layout.register_built_in_layout layout, opts
             method_name = Card::Set::Format.layout_method_name(layout)
-            define_method method_name, &block
+            define_method(method_name, &)
             wrapper layout do
               send method_name
             end

data/lib/card/set/format/abstract_format.rb

@@ -51,10 +51,12 @@ class Card
         #       nested cards in your cache. (Instead, stub them and process them
         #       separately)
         #     * *:always* - cache even when rendered within another cached view
-        #     * *:deep* cache this view and include nested cards
+        #     * *:deep* cache this view and include nested cards (but stub nested views
+        #       that are set to "never")
         #     * *:never* - don't ever cache this view, even if it's rendered by another
         #       view of the same card. Frequently used to prevent caching problems, when
         #       dynamic context (eg params) can alter the view.
+        #     * *:force* - deep cache everything, even views marked "never"
         #
         #   You should certainly {Card::View::Cache learn more about caching} if you want
         #   to develop mods that are safe in a caching environment.
@@ -92,9 +94,9 @@ class Card
         # * __:wrap__ wrap view dynamically. Value is Symbol for wrapper or Hash with
         #   wrappers and wrapper options. See {Wrapper}
         #
-        def view viewname, *args, &block
+        def view(viewname, *args, &)
           def_opts = process_view_opts viewname, args
-          define_view_method viewname, def_opts, &block
+          define_view_method(viewname, def_opts, &)
         end
 
         # simple placeholder for views designed to be overridden elsewhere
@@ -106,8 +108,8 @@ class Card
         end
 
         # define code to be executed before a view is rendered
-        def before view, &block
-          define_method "_before_#{view}", &block
+        def before(view, &)
+          define_method("_before_#{view}", &)
         end
 
         # Defines a setting method that can be used in all formats. Example:

data/lib/card/set/format/haml_paths.rb

@@ -63,8 +63,8 @@ class Card
           path if ::File.exist? path
         end
 
-        def haml_block_locals &block
-          instance_exec(&block) if block_given?
+        def haml_block_locals(&)
+          instance_exec(&) if block_given?
           instance_variables.each_with_object({}) do |var, h|
             h[var.to_s.tr("@", "").to_sym] = instance_variable_get var
           end

data/lib/card/set/format.rb

@@ -115,7 +115,7 @@ class Card
 
       private
 
-      def define_on_format format_name=:base, &block
+      def define_on_format(format_name=:base, &)
         # format class name, eg. HtmlFormat
         klass = Card::Format.format_class_name format_name
 
@@ -127,7 +127,7 @@ class Card
           m.extend Card::Set::Format::AbstractFormat
           m
         end
-        mod.class_eval(&block)
+        mod.class_eval(&)
       end
 
       def register_set_format format_class, mod

data/lib/card/set/inheritance.rb

@@ -73,7 +73,7 @@ class Card
 
       def each_format_with_mods set
         set_type = set.abstract_set? ? :abstract : :nonbase
-        format_type = "#{set_type}_format".to_sym
+        format_type = :"#{set_type}_format"
         Set.modules[format_type].each_pair { |*args| yield(*args) }
       end