card 1.104.2 → 1.105.1

data/lib/card/set/registrar.rb

@@ -3,7 +3,7 @@
 class Card
   module Set
     # the set loading process has two main phases:
-
+    #
     #  1. Definition: interpret each set file, creating/defining set and
     #     set_format modules
     #  2. Organization: have base classes include modules associated with the
@@ -72,10 +72,8 @@ class Card
 
       # makes sets ready for dynamic loading via #include_set_modules
       def register_set_of_type set_module, set_type
-        mods = modules[set_type]
-        key = set_module.shortname
-        mods[key] ||= []
-        mods[key] << set_module
+        list = modules[set_type][set_module.shortname] ||= []
+        list << set_module unless list.member? set_module
       end
 
       def process_base_format_modules base_format_modules

data/lib/card/set/required_field.rb

@@ -18,11 +18,12 @@ class Card
       end
 
       def parent_event_name
-        [parent_set.underscore, "requires_field", field].join("__").to_sym
+        [parent_set.underscored_name, "requires_field", field].join("__").to_sym
       end
 
       def field_event_name action
-        [field, "required_by", parent_set.underscore, "on", action].join("__").to_sym
+        [field, "required_by", parent_set.underscored_name, "on", action]
+          .join("__").to_sym
       end
 
       private

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

@@ -1,49 +1,9 @@
 class Card
   module Set
+    # Base class for type sets defined in {Card::Set set modules}
     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/set.rb

@@ -1,7 +1,6 @@
 # -*- encoding : utf-8 -*-
 
 class Card
-  #
   # A _Set_ is a group of {Card Cards} to which _Rules_ may apply. Sets can be as
   # specific as a single card, as general as all cards, or anywhere in between.
   #
@@ -11,39 +10,86 @@ class Card
   # web interface and are thus documented at https://decko.org/rules.
   #  - **Code rules** can be defined in a 'set module'.
   #
-  # The {Cardio::Mod} docs explain how to create mods and set_modules. This page explains
-  # how those modules become useful.
+  # ## Set Modules
+  #
+  # ### File structure
+  #
+  # Set modules specify views, events, and other methods for a given set of cards.
+  # They are defined in a {Cardio::Mod mod's} _set_ directory. For example, suppose
+  # you've created a mod 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
   #
-  # Suppose you have created a "mod" for managing your contacts called "contactmanager",
-  # and it includes code that would apply to all +address cards here:
+  # **Note:** _the set module's filename connects it to the set, so both the set_pattern
+  # and the set_anchor must correspond to the codename of a card in the database to
+  # function correctly. For example, the type/company directory corresponds to the Set
+  # card named `:company+:type`. Both the :company and :type codenames must exist for this
+  # to work properly._
+  #
+  # ### Writing/Editing set modules
+  #
+  #  A set module is mostly standard ruby, but the files are quite concise because
+  #
+  #   1. the set module's file location is used to autogenerate ruby module definitions
+  #   2. A DSL (Domain-Specific Language) makes common tasks easy.
+  #
+  # You can, for example, edit `mod/biz/set/type/company.rb`, and add _only_ the
+  # following code:
+  #
+  #     def hello
+  #       "world"
+  #     end
   #
-  #      ./contactmanager/set/right/address.rb
+  # No further code is needed for this method to be available to cards with the type
+  # Company (as specified by the file's location). This code will automatically be added
+  # to a ruby module named `Card::Set::Type::Company`. That module is extended with the
+  # {Card::Set} module, giving it access to the set module DSL.
   #
-  # Then, whenever you fetch or instantiate a +address card, the card will automatically
-  # include code from that set module.  In fact, it will include all the set modules
-  # associated with sets of which it is a member.
+  # These important Card::Set subclasses explain more about the DSL
+  #
+  #   - {Format} introduces format blocks
+  #   - {Format::AbstractFormat} covers {Format::AbstractFormat#view view} definitions
+  #   - {Event::Api} explains {Event::Api#event event} definitions
+  #
+  # ### Loading set modules
+  #
+  # Whenever you fetch or instantiate a card, the card will automatically
+  # include code from all the set modules associated with sets of which it is a member.
   #
   #  For example, say you have a Plaintext card named 'Philipp+address', and you have set
   # files for the following sets:
   #
-  #      * all cards
-  #      * all Plaintext cards
-  #      * all cards ending in +address
+  #   * all cards
+  #   * all Plaintext cards
+  #   * all cards ending in +address
   #
-  #  When you run this:
+  #  When you run any of these:
   #
-  #      mycard = Card.fetch 'Philipp+address'
+  #      mycard = Card.fetch "Philipp+address"
+  #      mycard = "Philipp+address".card
+  #      mycard = ["Philipp", "address"].card
   #
   #  ...then mycard will include the set modules associated with each of those sets in the
   # above order.
   #
-  #  Note that the set module's filename connects it to the set, so both the set_pattern
-  # and the set_anchor must correspond to the codename of a card in the database to
-  # function correctly.
-  #
-  #  A set module is "just ruby", but is generally quite concise because Card uses
-  #        a) the set module's file location to autogenerate ruby module names and
-  #        b) Card::Set to provide API for the most common set methods.
   #
   module Set
     include Event::Api

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>)

data/lib/card/view/permission.rb

@@ -8,6 +8,8 @@ class Card
     #         # only render if user has permission to update card
     #         view :myview, perms: :update do...
     module Permission
+      CRUD = ::Set.new(%i[create read update delete]).freeze
+
       def view_perms
         @view_perms = setting(:perms) || :read
       end
@@ -47,11 +49,17 @@ class Card
         format.view_for_denial requested_view, task
       end
 
+      def crud? task
+        task.in? CRUD
+      end
+
       def denied_task
-        if view_perms.is_a? Proc
-          :read unless view_perms.call(format)  # read isn't quite right
-        else
-          Array.wrap(view_perms).find { |task| !format.ok? task }
+        Array.wrap(view_perms).find do |task|
+          if crud? task
+            !format.ok? task
+          else
+            !format.send task
+          end
         end
       end
     end

data/lib/card/view.rb

@@ -106,6 +106,10 @@ class Card
       !parent && !format.parent
     end
 
+    def depth
+      @depth ||= parent ? (parent.depth + 1) : 0
+    end
+
     # next voo object found tracing ancestry through parent voos and/or parent formats
     # @return [Card::View]
     def next_ancestor across_format=true

data/lib/card.rb

@@ -19,11 +19,11 @@ ActiveSupport.run_load_hooks(:before_card, self)
 # unique _name_, _key_, and _id_. Some cards also have a _codename_.
 #
 #       @card.name     # The name, a Card::Name object, is the most recognizable card
-# mark.
+#                      # mark.
 #       @card.key      # The key, a String, is a simple lower-case name variant.
 #       @card.id       # The id is an Integer.
 #       @card.codename # The codename, a Symbol, is the name by which a card can be
-# referred to in code.
+#                      # referred to in code.
 #
 # All names with the same key (including the key itself) are considered variants of each
 # other. No two cards can have names with the same key. {Card::Name} objects inherit from
@@ -47,7 +47,7 @@ ActiveSupport.run_load_hooks(:before_card, self)
 #       @card.type_code    # returns codename of type card [Symbol]
 #       @card.type_card    # returns Cardtype card associated with @card's type [Card]
 #
-# {file:mod/core/set/all/type.rb Common type methods}
+#   - {Set::All::Type Common type methods}
 #
 # ## Content
 #
@@ -57,9 +57,8 @@ ActiveSupport.run_load_hooks(:before_card, self)
 #       @card.content      # the "official" content, which may be different from
 # db_content when db_content is overridden with a structure rule.
 #
-# {Card::Content Processing card content}
-#
-# {file:mod/core/set/all/content.rb Common content methods}
+#   - {Content Processing card content}
+#   - {Set::All::Content Common content methods}
 #
 # ## Fetch
 #
@@ -68,15 +67,35 @@ ActiveSupport.run_load_hooks(:before_card, self)
 #
 # Any of the above marks (name, key, id, codename) can be used to fetch a card, eg:
 #
-#      @card = Card.fetch "Garden" # returns the card with the name "Garden" (or, more
+#      @card1 = Card.fetch "Garden" # returns the card with the name "Garden" (or, more
 # precisely, with the key "garden")
-#      @card = Card.fetch 100      # returns the card with the id 100
-#      @card = Card.fetch :help    # returns the card with the codename help
+#      @card2 = Card.fetch 100      # returns the card with the id 100
+#      @card3 = Card.fetch :help    # returns the card with the codename help
 #
 # The fetch API will first try to find the card in the cache and will only look in the
 # database if necessary.
 #
-# {file:mod/core/set/all/fetch.rb More on fetching.}
+# The `Card[]` shortcut will return the same results but does not support the full range
+# of advanced options and will not return virtual cards
+# (cards that can be constructed from naming patterns but are not actually in the
+# database).
+#
+#      # equivalent to the above but more concise
+#      @card1 = Card["Garden"]
+#      @card2 = Card[100]
+#      @card3 = Card[:help]
+#
+# Better still, you can use the `#card` method on Strings, Integers, Symbols, and Arrays
+#
+#      # equivalent to the above but even more concise
+#      @card1 = "Garden".card
+#      @card2 = 100.card
+#      @card3 = :help.card
+#
+# The `#card_id`, `#cardname`, and `#codename` methods work on all the same objects and
+# provide convenient shortcuts for quickly fetching and returning card attributes.
+#
+#   - {Card::Fetch::CardClass More on fetching.}
 #
 # ## Query
 #
@@ -84,7 +103,7 @@ ActiveSupport.run_load_hooks(:before_card, self)
 #
 #       Card.search type_id: 4 # returns an Array of cards with the type_id of 4.
 #
-# {Card::Query More on queries}
+#   - {Card::Query More on queries}
 #
 # ## Views and Events
 #
@@ -95,9 +114,8 @@ ActiveSupport.run_load_hooks(:before_card, self)
 # Both views and events are defined in {Cardio::Mod mods}, short for modules or
 # modifications.
 #
-# {Card::Set::Format::AbstractFormat More on views}
-#
-# {Card::Set::Event::Api More on events}
+#   - {Set::Format::AbstractFormat#view More on views}
+#   - {Set::Event::Api#event More on events}
 #
 # ## Accounts and Permissions
 #
@@ -117,10 +135,25 @@ class Card < Cardio::Record
   extend Cache::CardClass
   extend Director::CardClass
   extend Fetch::CardClass
+  extend Query::CardClass
+
+  cattr_accessor :action_specific_attributes, :set_specific_attributes
+
+  self.action_specific_attributes = [
+    :supercard,                   # [Card]
+    :superleft,                   # [Card]
+    :action,                      # [Symbol] :create, :update, or :delete
+    :current_action,              # [Card::Action]
+    :last_action_id_before_edit,  # [Integer]
+
+    :comment,      # TODO: refactor in favor of card[add], card[drop]
+    :silent_change # TODO: refactor following to use skip/trigger
+  ]
+
+  attr_accessor(*action_specific_attributes)
 
   include Dirty
   include DirtyNames
-  include Director::CardMethods
   include Name::All
   include Content::All
   include Set::CardMethods
@@ -139,36 +172,12 @@ class Card < Cardio::Record
   has_many :actions, -> { where(draft: [nil, false]).order :id }
   has_many :drafts, -> { where(draft: true).order :id }, class_name: :Action
 
-  cattr_accessor :action_specific_attributes, :set_specific_attributes
   alias_method :card_id, :id
 
   class << self
     delegate :config, :paths, to: Cardio
   end
 
-  self.action_specific_attributes = [
-    :supercard,
-    :superleft,
-    :action,                      # [Symbol] :create, :update, or :delete
-    :current_action,              # [Card::Action]
-    :last_action_id_before_edit,
-
-    :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
-    :comment,                     # obviated soon
-
-    # TODO: refactor following to use skip/trigger
-    :update_all_users,            # if the above is wrong then this one too
-    :silent_change                # and this probably too
-  ]
-
-  attr_accessor(*action_specific_attributes)
-
-  self.action_specific_attributes +=
-    %i[skip_hash full_skip_hash trigger_hash full_trigger_hash]
-
   define_callbacks :select_action, :show_page, :act
 
   ActiveSupport.run_load_hooks :card, self

data/lib/cardio/cli.rb

@@ -2,6 +2,8 @@ require "rbconfig"
 require "colorize"
 require "cardio/script_loader"
 
+Cardio::ScriptLoader.script_name = "card"
+
 # If we are inside a Decko application this method performs an exec and thus
 # the rest of this script is not run.
 Cardio::ScriptLoader.exec!
@@ -9,4 +11,4 @@ Cardio::ScriptLoader.exec!
 require "rails/ruby_version_check"
 Signal.trap("INT") { exit(1) }
 
-require "cardio/commands/application"
+require "cardio/command/application"

data/lib/cardio/command/application.rb

@@ -0,0 +1,5 @@
+require "rails/generators"
+require File.expand_path("../../../generators/deck/deck_generator", __FILE__)
+require "cardio/command"
+
+Cardio::Command.run_non_deck_command ARGV.first, "cardio/commands"

data/lib/cardio/{commands/command.rb → command/command_base.rb}

@@ -1,7 +1,7 @@
 module Cardio
-  class Commands
+  class Command
     # shared handling of commands splitting cardio and original args with "--"
-    class Command
+    class CommandBase
       def run
         puts command
         exit_with_child_status command

data/lib/cardio/{commands → command}/custom.rb

@@ -2,13 +2,15 @@ require "optparse"
 require "cardio/version"
 
 module Cardio
-  class Commands
+  class Command
+    # Card-extensions of Rails command patterns
     module Custom
       private
 
       def run_new
         if !["-h", "--help"].intersection(args).empty?
-          require "cardio/commands/application"
+          ARGV.unshift "new"
+          require "cardio/command/application"
         else
           puts "Can't initialize a new deck within the directory of another, " \
                "please change to a non-deck directory first.\n"
@@ -22,33 +24,35 @@ module Cardio
       end
 
       def run_rspec
-        require "cardio/commands/rspec_command"
+        require "cardio/command/rspec_command"
         RspecCommand.new(args).run
       end
 
       # def run_jasmine
-      #   require "cardio/commands/rake_command"
+      #   require "cardio/command/rake_command"
       #   RakeCommand.new("spec:javascript", envs: "test").run
       # end
 
       def run_help
         puts "Usage:"
-        puts "  #{gem} COMMAND [OPTIONS]".green
+        puts "  #{Command.bin_name} COMMAND [OPTIONS]".green
         puts
         puts "Run commands with -h (or --help) for more info."
 
         %i[shark monkey].each do |group|
-          puts
-          puts "For " + "#{group}s".yellow + ":"
-          map.each do |command, conf|
-            next unless conf[:group] == group
-            puts command_help(command, conf)
-          end
-          puts
+          run_help_for_group group
         end
       end
 
-      private
+      def run_help_for_group group
+        puts
+        puts "For " + "#{group}s".yellow + ":"
+        map.each do |command, conf|
+          next unless conf[:group] == group
+          puts command_help(command, conf)
+        end
+        puts
+      end
 
       # formats command string for help text
       def command_help command, conf

data/lib/cardio/{commands → command}/rake_command/parser.rb

@@ -3,7 +3,7 @@
 # require "optparse"
 #
 # module Cardio
-#   class Commands
+#   class Command
 #     class RakeCommand
 #       # parse decko/card -specific options for rake
 #       class Parser < OptionParser
@@ -23,8 +23,8 @@
 #           super() do |parser|
 #             parser.banner =
 #               "Usage:\n" +
-#                 "  #{Commands.gem} #{command} [options]".green +
-#                 "\n\nRuns `rake #{Commands.gem}:#{command}` task."
+#                 "  #{Command.bin_name} #{command} [options]".green +
+#                 "\n\nRuns `rake #{Command.bin_name}:#{command}` task."
 #             parser_ons parser, command do |env_array|
 #               opts[:envs] = env_array
 #             end