card 1.108.1 → 1.109.1

data/lib/card/env/support.rb

@@ -21,10 +21,33 @@ class Card
       def reset_session
         if session.is_a? Hash
           @session = {}
-        else
-          controller&.reset_session
+        elsif request
+          update_session_options drop: false
+          controller.reset_session
+          # destroy_cookie unless Cardio.config.allow_anonymous_cookies
         end
       end
+
+      def update_session_options drop: nil
+        return unless request
+        return if Cardio.config.allow_anonymous_cookies
+
+        request.session_options[:drop] = drop.nil? ? !Auth.signed_in? : drop
+      end
+
+      # private
+
+      # FIXME: not working
+      # the response generally works to destroy a cookie, but
+      # the deletion doesn't appear to work in a redirect. Since signing out
+      # has a redirect response, we're still left with a cookie
+      # def destroy_cookie
+      #   app = Cardio.application
+      #   app_name = app.class.name ? app.railtie_name.chomp("_application") : ""
+      #   expire_in_past = "expires=Thu, 01 Jan 1970 00:00:00 GMT;"
+      #   controller.response.set_header "SET-COOKIE",
+      #                                  "_#{app_name}_session=deleted; #{expire_in_past}"
+      # end
     end
   end
 end

data/lib/card/error.rb

@@ -78,6 +78,7 @@ class Card
     class BadQuery < UserError
     end
 
+    # error with url
     class BadAddress < UserError
       self.status_code = 404
       self.view = :bad_address

data/lib/card/fetch/store.rb

@@ -36,7 +36,7 @@ class Card
       end
 
       def needs_prep?
-        return unless card.present?
+        return false unless card.present?
 
         !(skip_modules? || card.patterns?)
       end

data/lib/card/format/error.rb

@@ -1,5 +1,6 @@
 class Card
   class Format
+    # permissions and errors in card format classes
     module Error
       def ok? task
         task = :create if task == :update && card.new_card?
@@ -16,8 +17,8 @@ class Card
 
       def view_for_unknown setting_view
         if main? && voo.root?
-          root.error_status = 404
-          :not_found
+          root.error_status = page_status_for_unknown
+          page_view_for_unknown
         else
           setting_view || :unknown
         end
@@ -38,11 +39,21 @@ class Card
         yield
       end
 
+      private
+
       def rescue_view e, view
         method = loud_error? ? :loud_error : :quiet_error
         send method, e, view
       end
 
+      def page_status_for_unknown
+        404
+      end
+
+      def page_view_for_unknown
+        :not_found
+      end
+
       def error_cardname _exception
         if card&.name.present?
           safe_name

data/lib/card/format/method_delegation.rb

@@ -1,5 +1,7 @@
 class Card
   class Format
+    # missing methods may be render calls or action view methods
+    # these methods sort that out
     module MethodDelegation
       RENDER_METHOD_RE =
         /^
@@ -40,7 +42,7 @@ class Card
         if (match = api_render? method)
           api_render match, opts
         else
-          delegate_to_action_view(method, opts, proc) { yield }
+          delegate_to_action_view method, opts, &proc
         end
       end
 
@@ -66,9 +68,9 @@ class Card
         end
       end
 
-      def delegate_to_action_view method, opts, proc
-        proc = proc { |*a| raw yield(*a) } if proc
-        response = action_view.send method, *opts, &proc
+      def delegate_to_action_view method, opts, &old_proc
+        new_proc = proc { |*a| raw yield(*a) } if old_proc
+        response = action_view.send method, *opts, &new_proc
         response.is_a?(String) ? action_view.raw(response) : response
       end
     end

data/lib/card/format/registration.rb

@@ -1,5 +1,7 @@
 class Card
   class Format
+    # handles format registry, tracking which formats (html, css, json, etc) are
+    # available
     module Registration
       def register format
         registered << format.to_s
@@ -7,11 +9,11 @@ class Card
       end
 
       def new card, opts={}
-        if self != Format
-          super
-        else
+        if self == Format
           klass = format_class opts
           self == klass ? super : klass.new(card, opts)
+        else
+          super
         end
       end
 

data/lib/card/format/render.rb

@@ -41,6 +41,57 @@ 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, :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
+        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,27 +115,6 @@ 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
-      end
-
       # def stub_debugging
       #   result = yield
       #   if Rails.env.development? && result.is_a?(String) && result =~ /StUb/
@@ -118,32 +148,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

@@ -1,5 +1,6 @@
 class Card
   class Format
+    # handles view wrapping, including with layouts and slots
     module Wrapper
       def with_wrapper
         if voo.layout.present?

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/mailer.rb

@@ -3,6 +3,7 @@
 require "open-uri"
 
 class Card
+  # extends ActionMailer with card config
   class Mailer < ActionMailer::Base
     class << self
       def new_mail *args, &block
@@ -14,20 +15,6 @@ class Card
         end
       end
 
-      def layout message
-        <<-HTML
-          <!DOCTYPE html>
-          <html>
-            <head>
-              <meta http-equiv="Content-type" content="text/html;charset=UTF-8"/>
-            </head>
-            <body>
-              #{message}
-            </body>
-          </html>
-        HTML
-      end
-
       def defaults_from_config
         (Card.config.email_defaults || {}).symbolize_keys.tap do |defaults|
           defaults[:return_path] ||= defaults[:from] if defaults[:from]

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

@@ -5,7 +5,7 @@ class Card
       module Parts
         def left *args
           case
-          when simple?    then nil
+          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

data/lib/card/name/all.rb

@@ -8,6 +8,7 @@ class Card
       # TODO: use delegations and include more name functions
       delegate :simple?, :compound?, :junction?, to: :name
       attr_reader :supercard
+
       def name
         @name ||= left_id ? Lexicon.lex_to_name([left_id, right_id]) : super.to_name
       end
@@ -57,6 +58,10 @@ class Card
         end
       end
 
+      def id_string
+        "~#{id}"
+      end
+
       def key= newkey
         return if newkey == key
 

data/lib/card/name/name_variants.rb

@@ -1,5 +1,6 @@
 class Card
   class Name
+    # variants of card names
     module NameVariants
       @@variant_methods = %i[capitalize singularize pluralize titleize
                              downcase upcase swapcase reverse succ]

data/lib/card/query/abstract_query/query_helper.rb

@@ -19,13 +19,12 @@ class Card
         end
 
         def table_alias
-          @table_alias ||= begin
+          @table_alias ||=
             if fasten == :direct
               @superquery.table_alias
             else
               "#{table_prefix}#{root.table_seq}#{@table_suffix}"
             end
-          end
         end
 
         def table_seq

data/lib/card/query/abstract_query/tie.rb

@@ -107,7 +107,7 @@ class Card
         end
 
         def list_of_ids? val
-          return unless val.is_a? Array
+          return false unless val.is_a? Array
 
           !val.find { |v| !id_from_val v }
         end

data/lib/card/query/abstract_query.rb

@@ -71,10 +71,10 @@ class Card
       end
 
       def context
-        if !@context.nil?
-          @context
-        else
+        if @context.nil?
           @context = superquery ? superquery.context : ""
+        else
+          @context
         end
       end
 

data/lib/card/query/card_class.rb

@@ -1,5 +1,6 @@
 class Card
   module Query
+    # query-related methods with which to extend Card class
     module CardClass
       def search spec, comment=nil, &block
         results = ::Card::Query.run(spec, comment)

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/clause.rb

@@ -1,5 +1,6 @@
 class Card
   module Query
+    # shared methods for query clauses
     module Clause
       #    attr_accessor :clause
 

data/lib/card/query/join.rb

@@ -44,10 +44,10 @@ class Card
       end
 
       def side
-        if !@side.nil?
-          @side.to_s.upcase
-        else
+        if @side.nil?
           @side = inside_or? ? "LEFT" : nil
+        else
+          @side.to_s.upcase
         end
       end
 

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

@@ -1,13 +1,12 @@
 class Card
   class Reference < Cardio::Record
-    module All
-      # frozen_string_literal: true
-
-      # Cards can refer to other cards in their content, eg via links and nests.
-      # The card that refers is the "referer", the card that is referred to is
-      # the "referee". The reference itself has its own class (Card::Reference),
-      # which handles id-based reference tracking.
+    # frozen_string_literal: true
 
+    # Cards can refer to other cards in their content, eg via links and nests.
+    # The card that refers is the "referer", the card that is referred to is
+    # the "referee". The reference itself has its own class (Card::Reference),
+    # which handles id-based reference tracking.
+    module All
       PARTIAL_REF_CODE = "P".freeze
 
       # cards that refer to self

data/lib/card/rule/cache.rb

@@ -1,5 +1,6 @@
 class Card
   module Rule
+    # a cache of all card rules in the deck
     class Cache
       class_attribute :sql, :cache_key
 

data/lib/card/rule/preference_cache.rb

@@ -1,5 +1,7 @@
 class Card
   module Rule
+    # a preference is a user-specific rule.
+    # This caches all preferences in the deck
     class PreferenceCache < Cache
       self.sql = %(
         SELECT

data/lib/card/rule/read_rule_cache.rb

@@ -1,5 +1,8 @@
 class Card
   module Rule
+    # the read rule cache, unlike the standard rule cache, is optimized for lookups
+    # based on the rules' values, because this is needed for high-performance
+    # permission-checking
     class ReadRuleCache < Cache
       self.sql = %(
         SELECT

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

@@ -14,7 +14,9 @@ class Card
         include SkipAndTrigger
 
         def event_applies? event
-          return unless set_condition_applies? event.set_module, event.opts[:changing]
+          unless set_condition_applies? event.set_module, event.opts[:changing]
+            return false
+          end
 
           CONDITIONS.all? { |c| send "#{c}_condition_applies?", event, event.opts[c] }
         end
@@ -91,10 +93,10 @@ class Card
         def wrong_stage opts
           return false if director.stage_ok? opts
 
-          if !stage
-            "phase method #{method} called outside of event phases"
-          else
+          if stage
             "#{opts.inspect} method #{method} called in stage #{stage}"
+          else
+            "phase method #{method} called outside of event phases"
           end
         end
 

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

@@ -1,6 +1,7 @@
 class Card
   module Set
     class Event
+      # handle card event callbacks
       module Callbacks
         def set_event_callbacks
           %i[before after around].each do |kind|

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

@@ -1,6 +1,7 @@
 class Card
   module Set
     class Event
+      # handle options available for event definition
       module Options
         def validate_conditions
           @opts.each do |key, val|
@@ -32,8 +33,8 @@ class Card
           return if invalid.empty?
 
           raise ArgumentError,
-                "invalid option#{'s' if invalid.size > 1} '#{invalid}' "\
-                  "for condition '#{condition}' in event '#{@event}'"
+                "invalid option#{'s' if invalid.size > 1} '#{invalid}' " \
+                "for condition '#{condition}' in event '#{@event}'"
         end
 
         def invalid_condition_values condition, val

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

@@ -7,7 +7,7 @@ class Card
           :skip,                        # [Array] skip event(s) for all cards in act
           :skip_in_action,              # [Array] skip event for just this card
           :trigger,                     # [Array] trigger event(s) for all cards in act
-          :trigger_in_action,           # [Array] trigger event for just this card
+          :trigger_in_action            # [Array] trigger event for just this card
         ]
         attr_reader(*settings)
 

data/lib/card/set/event.rb

@@ -165,8 +165,8 @@ class Card
   end
 
   # one failed integration event should not harm others.
-  def rescuing_integration
-    Error.rescue_card(self) { yield }
+  def rescuing_integration &block
+    Error.rescue_card(self, &block)
   ensure
     true
   end

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

@@ -58,7 +58,7 @@ class Card
 
             views[mod][alias_to] || begin
               raise "cannot find #{alias_to} view in #{mod}; " \
-                      "failed to alias #{view} from #{self}"
+                    "failed to alias #{view} from #{self}"
             end
           end
         end

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

@@ -46,7 +46,7 @@ class Card
           end
         end
 
-        TMPSET_REGEXP = %r{^.*/tmp(sets)?/set/[\w-]+/mod\d{3}-(?<modname>[^/]+)}
+        TMPSET_REGEXP = %r{^.*/tmp(?:sets)?/set/[\w-]+/mod\d{3}-(?<modname>[^/]+)}
 
         def deep_source source
           return source unless tmp_files?

data/lib/card/set/format.rb

@@ -103,14 +103,14 @@ class Card
 
       # shortcut for {AbstractFormat#view} for when #view is called outside of a format
       # block
-      def view *args, &block
-        format { view(*args, &block) }
+      def view(...)
+        format { view(...) }
       end
 
       # shortcut for {AbstractFormat#before} for when #before is called outside of a
       # format block
-      def before view, &block
-        format { before view, &block }
+      def before(...)
+        format { before(...) }
       end
 
       private