card 1.104.1 → 1.105.0

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

@@ -33,11 +33,12 @@ class Card
         # DEPRECATE?
 
         def member_of val
-          interpret right_plus: [Card::RolesID, { refer_to: val }]
+          interpret referred_to_by: { left: val, right: { codename: "members" } }
         end
 
         def member val
-          interpret referred_to_by: { left: val, right: Card::RolesID }
+          interpret type_id: Card::RoleID,
+                    right_plus: [{ codename: "members" }, refer_to: val]
         end
       end
     end

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

@@ -2,6 +2,7 @@ class Card
   module Query
     class CardQuery
       # handle relational (not simple) CQL sort values
+      # (see #interpret_as_modifier? and #order_directives)
       #
       # sorting with subqueries is not fully supported; only a few experimental
       # examples have been attempted, and even for those the syntax is likely
@@ -14,7 +15,7 @@ class Card
         SORT_BY_ITEM_JOIN_MAP = { left: "left_id", right: "right_id" }.freeze
 
         def sort val
-          return nil unless full?
+          return nil unless full? # eg, no sorting on simple count queries
 
           interpret_sort_hash val do |value, item, sort_field|
             sort_by value, item, sort_field
@@ -34,7 +35,7 @@ class Card
           join = join_cards val, to_field: join_field,
                                  side: "LEFT",
                                  conditions_on_join: true
-          @mods[:sort] ||= "#{join.table_alias}.#{sort_field}"
+          @mods[:sort_by] ||= "#{join.table_alias}.#{sort_field}"
         end
 
         def sort_by_item_join_field item
@@ -42,7 +43,7 @@ class Card
         end
 
         # EXPERIMENTAL!
-        # sort: { referred_to_by { right: "*follow" }, return count }
+        # sort_by: { referred_to_by { right: "*follow" }, return count }
 
         def sort_by_count val, item
           method_name = "sort_by_count_#{item}"
@@ -55,7 +56,7 @@ class Card
         end
 
         def sort_by_count_referred_to val
-          @mods[:sort] = "coalesce(count,0)" # needed for postgres
+          @mods[:sort_by] = "coalesce(count,0)" # needed for postgres
           sort_query = count_sort_query
           sort_query.add_condition "referer_id in (#{count_subselect(val).sql})"
           # FIXME: - SQL generated before SQL phase

data/lib/card/query/card_query.rb

@@ -12,6 +12,7 @@ class Card
       include Normalization
       include Sorting
       include Conjunctions
+      include Custom
       # Query Execution
 
       # By default a query returns card objects. This is accomplished by returning

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

@@ -1,8 +1,8 @@
 class Card
   module Query
     # convert @query sort rep into order by statement
-    # order information is stored in @mods[:sort], @mods[:sort_as], and
-    # @mods[:dir]
+    # order information is stored in @mods[:sort_by], @mods[:sort_as], and
+    # @mods[:sort_dir]
     class SqlStatement
       ORDER_MAP = {
         "id" => "id",
@@ -24,17 +24,18 @@ class Card
         end
 
         def order_directives
-          return if @mods[:sort].blank?
+          sort_mod = @mods[:sort_by] || @mods[:sort]
+          return if sort_mod.blank?
 
-          Array.wrap(@mods[:sort]).map do |order_key|
-            order_directive order_key
+          Array.wrap(sort_mod).map.with_index do |order_key, index|
+            order_directive order_key, index
           end
         end
 
-        def order_directive order_key
+        def order_directive order_key, index
           field = order_field order_key
           @fields += ", #{field}"
-          "#{field} #{order_dir order_key}"
+          "#{field} #{order_dir order_key, index}"
         end
 
         def order_field order_key
@@ -54,11 +55,12 @@ class Card
           "CAST(#{field} AS #{cast_type(safe_sql(as))})"
         end
 
-        def order_dir order_key
-          if @mods[:dir].blank?
+        def order_dir order_key, index
+          dir = @mods[:sort_dir] || @mods[:dir] # dir is DEPRECATED
+          if dir.blank?
             DEFAULT_ORDER_DIRS[order_key.to_sym] || "asc"
           else
-            safe_sql @mods[:dir]
+            safe_sql Array.wrap(dir)[index]
           end
         end
       end

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

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

data/lib/card/query.rb

@@ -68,6 +68,7 @@ class Card
 
       plus_relational: %i[plus left_plus right_plus],
       conjunction: %i[and or all any],
+      custom: [:compound],
       ignore: %i[prepend append vars],
       deprecated: %i[view params size]
     }.each_with_object({}) do |pair, h|
@@ -76,7 +77,10 @@ class Card
 
     CONJUNCTIONS = { any: :or, in: :or, or: :or, all: :and, and: :and }.freeze
 
-    MODIFIERS = %i[conj return sort sort_as group dir limit offset]
+    # "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]
                 .each_with_object({}) { |v, h| h[v] = nil }
 
     OPERATORS =

data/lib/card/reference/all.rb

@@ -73,16 +73,6 @@ class Card
 
       private
 
-      def with_normalized_referee referee_name
-        return unless referee_name # eg commented nest has no referee_name
-
-        referee_name = referee_name.to_name
-        referee_key = referee_name.key
-        return if referee_key == key # don't create self reference
-
-        yield referee_name, referee_key, Lexicon.id(referee_name)
-      end
-
       # interpretation phase helps to prevent duplicate references
       # results in hash like:
       # { referee1_key: [referee1_id, referee1_type2],
@@ -96,6 +86,16 @@ class Card
         end
       end
 
+      def with_normalized_referee referee_name
+        return unless referee_name # eg commented nest has no referee_name
+
+        referee_name = referee_name.to_name
+        referee_key = referee_name.key
+        return if referee_key == key # don't create self reference
+
+        yield referee_name, referee_key, Lexicon.id(referee_name)
+      end
+
       # translate interpreted reference hash into values array,
       # removing duplicate and unnecessary ref_types
       def reference_values_array ref_hash

data/lib/card/set/advanced_api.rb

@@ -4,7 +4,7 @@ class Card
     module AdvancedApi
       def assign_type type, module_key=nil
         module_key ||= shortname
-        Type.assignment[module_key] = type.card_id
+        Type.assignment[module_key] = type
       end
 
       def setting_opts opts

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

@@ -1,8 +1,16 @@
 class Card
   module Set
     class Event
-      # card methods for testing event applicability
+      # card methods for scheduling events and testing event applicability
       module All
+        def schedule event
+          @scheduled ||= {}
+          return if @scheduled[event.to_sym]
+
+          send :"#{event}_with_delay"
+          @scheduled[event.to_sym] = true
+        end
+
         include SkipAndTrigger
 
         def event_applies? event

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

@@ -8,7 +8,8 @@ class Card
   # needed, then we clearly need to make sure that they are fully restored. At a bare
   # minimum they would need to include set modules.
   def serializable_attributes
-    self.class.action_specific_attributes + set_specific.keys - %i[supercard superleft]
+    self.class.action_specific_attributes + set_specific.keys -
+      %i[supercard superleft subcards]
   end
 
   module Set
@@ -28,7 +29,8 @@ class Card
         end
 
         def with_delay? opts
-          DELAY_STAGES.include?(opts[:after]) || DELAY_STAGES.include?(opts[:before])
+          opts.delete(:delay) ||
+            DELAY_STAGES.intersect?([opts[:after], opts[:before]].to_set)
         end
 
         def define_delayed_event_method

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

@@ -4,7 +4,7 @@ class Card
       module Options
         def validate_conditions
           @opts.each do |key, val|
-            next if key.in? %i[stage before after around]
+            next if key.in? %i[stage before after around delay]
 
             validate_condition_name key
             validate_condition_value key, val

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

@@ -3,6 +3,37 @@ class Card
     class Event
       # opt into (trigger) or out of (skip) events
       module SkipAndTrigger
+        settings = [
+          :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
+        ]
+        attr_reader(*settings)
+
+        Card.action_specific_attributes +=
+          settings + %i[skip_hash full_skip_hash trigger_hash full_trigger_hash]
+
+        def skip= skip_val
+          @skip_hash = @full_skip_hash = nil
+          @skip = skip_val
+        end
+
+        def skip_in_action= skip_val
+          @skip_hash = @full_skip_hash = nil
+          @skip_in_action = skip_val
+        end
+
+        def trigger= trigger_val
+          @trigger_hash = @full_trigger_hash = nil
+          @trigger = trigger_val
+        end
+
+        def trigger_in_action= trigger_val
+          @trigger_hash = @full_trigger_hash = nil
+          @trigger_in_action = trigger_val
+        end
+
         # force skipping this event for all cards in act
         def skip_event! *events
           @full_skip_hash = nil
@@ -59,23 +90,16 @@ class Card
         end
 
         def full_skip_hash
-          @full_skip_hash ||= act_skip_hash.merge skip_in_action_hash
+          @full_skip_hash ||= act_skip_hash.merge hash_with_value(skip_in_action, true)
         end
 
         def act_skip_hash
           (act_card || self).skip_hash
         end
 
-        def skip_in_action_hash
-          hash_with_value skip_in_action, true
-        end
-
         def full_trigger_hash
-          @full_trigger_hash ||= act_trigger_hash.merge trigger_in_action_hash
-        end
-
-        def trigger_in_action_hash
-          hash_with_value trigger_in_action, true
+          @full_trigger_hash ||=
+            act_trigger_hash.merge hash_with_value(trigger_in_action, true)
         end
 
         def act_trigger_hash

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

@@ -10,15 +10,15 @@ class Card
         #   # mod/core/set/type/basic.rb
         #   view :my_view, template: :haml  # uses mod/core/view/type/basic/my_view.haml
         #
-        #   view :with_instance_variables, template: :haml do
+        #   view :sample_view, template: :haml do
         #     @actor = "Mark Haml"
         #   end
         #
-        #   # mod/core/view/type/basic/with_instance_variables.haml
+        #   # mod/core/set/type/basic/sample_view.haml
         #   Luke is played by
         #     = actor
         #
-        #   > render :with_instance_variables  # => "Luke is played by Mark Haml"
+        #   > render :sample_view  # => "Luke is played by Mark Haml"
         module HamlViews
           include Card::Set::Format::HamlPaths
 

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

@@ -59,7 +59,7 @@ class Card
         #     * *:create*, *:read* (default), *:update*, *:delete* - only users with the
         #       given permission for the card viewed.
         #     * *:none* - no permission check; anyone can view
-        #     * a *Proc* object.  Eg `perms: ->(_fmt) { Auth.needs_setup? }`
+        #     * a format method name.  Eg `perms: :is_my_view_ok?`
         #
         # * __:template__ [Symbol] view is defined in a template. Currently `:haml` is
         #   the only supported value.  See {HamlViews}

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

@@ -3,9 +3,6 @@ class Card
     module Format
       # methods for handling paths to HAML templates
       module HamlPaths
-        CORE_MODS = ::Set.new %w[core admin].freeze
-        TEMPLATE_DIR = %w[template set].freeze
-
         delegate :tmp_files?, to: Cardio::Mod::LoadStrategy
 
         def haml_to_html haml, locals={}, a_binding=nil, debug_info={}
@@ -49,34 +46,21 @@ class Card
           end
         end
 
-        TMPSET_REGEXP = %r{(?<carddir>/card)/tmp(sets)?/set/mod\d{3}-(?<modname>[^/]+)/}
+        TMPSET_REGEXP = %r{^.*/tmp(sets)?/set/[\w-]+/mod\d{3}-(?<modname>[^/]+)}
 
         def deep_source source
           return source unless tmp_files?
 
-          source&.gsub TMPSET_REGEXP do
-            match = Regexp.last_match
-            source_mod_dir match[:modname], match[:carddir]
+          source&.sub TMPSET_REGEXP do
+            "#{Cardio::Mod.fetch(Regexp.last_match[:modname]).path}/set"
           end
         end
 
-        def source_mod_dir modname, carddir
-          # TODO: handle non-standard mod dirs
-          dir = "/mod/#{modname}/set/"
-          return dir unless modname.in? CORE_MODS
-
-          "#{carddir}/#{dir}/"
-        end
-
         def try_haml_template_path template_path, view, source_dir, ext="haml"
           template_path = File.join(template_path, view.to_s) if view.present?
           template_path += ".#{ext}"
-          TEMPLATE_DIR.each do |template_dir|
-            path = ::File.expand_path(template_path, source_dir)
-                         .sub(%r{(/mod/[^/]+)/set/}, "\\1/#{template_dir}/")
-            return path if ::File.exist?(path)
-          end
-          false
+          path = ::File.expand_path(template_path, source_dir)
+          path if ::File.exist? path
         end
 
         def haml_block_locals &block

data/lib/card/set/inheritance.rb

@@ -3,8 +3,8 @@ class Card
     # API to inherit other sets and their formats
     module Inheritance
       # include a set module and all its format modules
-      # @param [Module] set
-      # @param [Hash] opts choose the formats you want to include. You can also
+      # @param set [Module]
+      # @param opts [Hash] choose the formats you want to include. You can also
       #    pass arbitrary options to the included set. The option is saved
       #    in the including set. To use the option you need a `included` method
       #    in the included set to fetch the option.
@@ -41,8 +41,8 @@ class Card
       end
 
       # include format modules of a set
-      # @param [Module] set
-      # @param [Hash] opts choose the formats you want to include
+      # @param set [Module]
+      # @param opts [Hash] choose the formats you want to include
       # @option opts [Symbol, Array<Symbol>] :only include only these formats
       # @option opts [Symbol, Array<Symbol>] :except don't include these formats
       # @example

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

@@ -21,7 +21,7 @@ class Card
           @patterns = @concrete_patterns = nil
           @template = @virtual = nil
           @set_mods_loaded = @set_modules = @set_names = @rule_lookup_keys = nil
-          @junction_only = nil # only applies to set cards
+          @compound_only = nil # only applies to set cards
           true
         end
 

data/lib/card/set/pattern/base.rb

@@ -39,7 +39,7 @@ class Card
 
         def anchor_codenames
           anchor_parts.map do |part|
-            part.cardname&.code || break
+            part.cardname&.codename || break
           end
         end
 

data/lib/card/set/pattern/class_methods.rb

@@ -3,7 +3,7 @@ class Card
     module Pattern
       # methods for Set::Pattern classes
       module ClassMethods
-        attr_accessor :pattern_code, :junction_only, :assigns_type, :anchorless
+        attr_accessor :pattern_code, :compound_only, :assigns_type, :anchorless
         attr_writer :anchor_parts_count
 
         def new card
@@ -17,8 +17,8 @@ class Card
           opts.each { |key, val| send "#{key}=", val }
         end
 
-        def junction_only?
-          junction_only == true
+        def compound_only?
+          compound_only == true
         end
 
         def anchorless?
@@ -35,7 +35,7 @@ class Card
         end
 
         def pattern_applies? card
-          junction_only? ? card.name.compound? : true
+          compound_only? ? card.name.compound? : true
         end
 
         def anchor_parts_count

data/lib/card/set/trait.rb

@@ -60,7 +60,7 @@ class Card
         if all_set?
           [:right, trait]
         elsif type_set?
-          [:type_plus_right, set_name_parts.last, trait]
+          [:type_plus_right, set_name_parts[3], trait]
         end
       end
 

data/lib/card/set/type.rb

@@ -3,47 +3,6 @@ class Card
     class Type < Pattern::Base
       cattr_accessor :assignment
       self.assignment = {}
-
-      def initialize card
-        super
-        # support type inheritance
-        @inherit_card = card unless module_key
-      end
-
-      def lookup_module_list modules_hash
-        lookup_key = module_key || inherited_key
-        modules_hash[lookup_key] if lookup_key
-      end
-
-      private
-
-      def inherited_key
-        if defined?(@inherited_key)
-          @inherited_key
-        else
-          @inherited_key = lookup_inherited_key
-        end
-      end
-
-      def lookup_inherited_key
-        return unless (card = @inherit_card)
-
-        @inherit_card = nil
-        return unless (type_code = default_type_code card)
-
-        mod_key = "Type::#{type_code.to_s.camelize}"
-        mod_key if mods_exist_for_key? mod_key
-      end
-
-      def default_type_code card
-        card.rule_card(:default, skip_modules: true)&.type_code
-      end
-
-      def mods_exist_for_key? mod_key
-        list_of_hashes = Card::Set.modules[:nonbase_format].values
-        list_of_hashes << Card::Set.modules[:nonbase]
-        list_of_hashes.any? { |h| h[mod_key] }
-      end
     end
   end
 end

data/lib/card/setting.rb

@@ -49,7 +49,6 @@ class Card
       editing
       event
       other
-      config
     ].each_with_object({}) do |key, groups|
       groups[key] = []
     end

data/lib/card/subcards/all.rb

@@ -2,6 +2,8 @@ class Card
   class Subcards
     # subcard-related Card instance methods
     module All
+      Card.action_specific_attributes << :subcards
+
       def subcards
         @subcards ||= Card::Subcards.new self
       end
@@ -27,7 +29,7 @@ class Card
         subcards.card(card_name).present?
       end
 
-      def subfield field_name, args={}
+      def field field_name, args={}
         if (sf = subcards.field field_name)
           sf.assign_attributes args
           sf
@@ -36,23 +38,19 @@ class Card
         end
       end
 
-      def subfield_content field_name
+      def field_content field_name
         subcards.field(field_name)&.content
       end
 
-      def subfield? field_name
-        subcards.field(field_name).present?
-      end
-
       def field? tag
-        field(tag) || subfield?(tag)
+        fetch(tag) || subcards.field(tag).present?
       end
 
       def drop_subcard name_or_card
         subcards.remove name_or_card
       end
 
-      def drop_subfield name_or_card
+      def drop_field name_or_card
         subcards.remove_field name_or_card
       end
 

data/lib/card/subcards/args.rb

@@ -4,8 +4,8 @@ class Card
     module Args
       def extract_subcard_args! args
         safe_subcard_args args do |subcards|
-          extract_explicit_subfields subcards, args
-          extract_implicit_subfields subcards, args
+          extract_explicit_fields subcards, args
+          extract_implicit_fields subcards, args
         end
       end
 
@@ -18,21 +18,21 @@ class Card
         subcards.try(:to_unsafe_h) || subcards
       end
 
-      def extract_explicit_subfields subcards, args
-        return unless (subfields = args.delete :subfields)
+      def extract_explicit_fields subcards, args
+        return unless (fields = args.delete :fields)
 
-        subfields.each_pair do |key, value|
-          subcards[normalize_subfield_key(key)] = value
+        fields.each_pair do |key, value|
+          subcards[normalize_field_key(key)] = value
         end
       end
 
       # ensure a leading '+'
-      def normalize_subfield_key key
-        key = Card::Codename.name(key) if key.is_a?(Symbol) && Card::Codename.exist?(key)
+      def normalize_field_key key
+        key = Card::Codename.name! key if key.is_a?(Symbol)
         key.to_name.prepend_joint
       end
 
-      def extract_implicit_subfields subcards, args
+      def extract_implicit_fields subcards, args
         args.each_key do |key|
           subcards[key.to_s] = args.delete(key) if key.to_s.match?(/^\+/)
         end

data/lib/card/view/cache/cache_action.rb

@@ -84,7 +84,7 @@ class Card
           case view_perms
           when :none             then true
           when parent.view_perms then true
-          when Symbol            then format.anyone_can?(view_perms)
+          when *Permission::CRUD then format.anyone_can?(view_perms)
           else                        false
           end
         end

data/lib/card/view/options/visibility.rb

@@ -19,6 +19,10 @@ class Card
           !hide? view
         end
 
+        def explicit_show? view
+          viz_hash[view&.to_sym] == :show
+        end
+
         # write methods
 
         def show *views

data/lib/card/view/options.rb

@@ -56,6 +56,7 @@ class Card
           :type,           # set the default type of new cards
           :size,           # set an image size
           #                    (also used for character limit in one_line_content)
+          :header,         # h1, h2, h3..
           :items,          # options for items (Hash)
           :cache,          # change view cache behaviour
           #                    (Symbol<:always, :standard, :never>)