card 1.17.4 → 1.18.0

data/mod/01_core/format/html_format.rb

@@ -7,7 +7,7 @@ class Card
   class HtmlFormat < Format
     include Diff
 
-    attr_accessor  :options_need_save, :start_time, :skip_autosave
+    attr_accessor :options_need_save, :start_time, :skip_autosave
 
     # builtin layouts allow for rescue / testing
     LAYOUTS = Loader.load_layouts.merge 'none' => '{{_main}}'
@@ -31,7 +31,7 @@ class Card
 
     def layout_from_card_or_code name
       layout_card = Card.fetch name.to_s, skip_virtual: true, skip_modules: true
-      if layout_card and layout_card.ok? :read
+      if layout_card && layout_card.ok?(:read)
         layout_card.content
       elsif (hardcoded_layout = LAYOUTS[name])
         hardcoded_layout
@@ -40,8 +40,8 @@ class Card
       end
     end
 
-    def get_inclusion_defaults nested_card
-      {view: (nested_card.rule( :default_html_view ) || :titled) }
+    def get_nest_defaults nested_card
+      { view: (nested_card.rule(:default_html_view) || :titled) }
     end
 
     def default_item_view
@@ -50,23 +50,19 @@ class Card
 
     def output content
       case content
-      when String; content
-      when Array ; content.compact.join "\n"
+      when String then content
+      when Array then content.compact.join "\n"
       end
     end
 
     def html_escape_except_quotes s
       # to be used inside single quotes (makes for readable json attributes)
-      s.to_s.gsub(/&/, "&amp;").gsub(/\'/, "&apos;").gsub(/>/, "&gt;").gsub(/</, "&lt;")
+      s.to_s.gsub(/&/, '&amp;').gsub(/\'/, '&apos;').gsub(/>/, '&gt;').gsub(/</, '&lt;')
     end
 
-
-
-
-
     def main?
       if show_layout?
-        @depth == 1 && @mainline #assumes layout includes {{_main}}
+        @depth == 1 && @mainline # assumes layout includes {{_main}}
       else
         @depth == 0 && params[:is_main]
       end

data/mod/01_core/format/text_format.rb

@@ -3,7 +3,7 @@
 class Card
   Format.register :text
   Format.register :txt
-  
+
   class TextFormat < Format
     @@aliases['txt'] = 'text'
   end

data/mod/01_core/set/all/actify.rb

@@ -0,0 +1,96 @@
+
+# The Card#abort method is for cleanly exiting an action without continuing
+# to process any further events.
+#
+# Three statuses are supported:
+#
+#   failure: adds an error, returns false on save
+#   success: no error, returns true on save
+#   triumph: similar to success, but if called on a subcard
+#            it causes the entire action to abort (not just the subcard)
+def abort status, msg='action canceled'
+  if status == :failure && errors.empty?
+    errors.add :abort, msg
+  elsif status.is_a?(Hash) && status[:success]
+    success << status[:success]
+    status = :success
+  end
+  raise Card::Abort.new(status, msg)
+end
+
+module ClassMethods
+  def create! opts
+    card = Card.new opts
+    card.act do
+      card.save!
+    end
+    card
+  end
+
+  def create opts
+    card = Card.new opts
+    card.act do
+      card.save
+    end
+    card
+  end
+end
+
+def delete
+  act do
+    super
+  end
+end
+
+def delete!
+  act do
+    super
+  end
+end
+
+def update_attributes opts
+  act do
+    super opts
+  end
+end
+
+def update_attributes! opts
+  act do
+    super opts
+  end
+end
+
+def abortable
+  yield
+rescue Card::Abort => e
+  if e.status == :triumph
+    @supercard ? raise(e) : true
+  elsif e.status == :success
+    if @supercard
+      @supercard.subcards.delete key
+      @supercard.director.subdirectors.delete self
+      expire_soft
+    end
+    true
+  end
+end
+
+# this is an override of standard rails behavior that rescues abort
+# makes it so that :success abortions do not rollback
+def with_transaction_returning_status
+  status = nil
+  self.class.transaction do
+    add_to_transaction
+    status = abortable { yield }
+    raise ActiveRecord::Rollback unless status
+  end
+  status
+end
+
+event :notable_exception_raised do
+  Rails.logger.debug "BT:  #{Card::Error.current.backtrace * "\n  "}"
+end
+
+def success
+  Env.success(cardname)
+end

data/mod/01_core/set/all/active_card.rb

@@ -19,17 +19,17 @@ end
 
 =end
 
-def trait_var var_name, &block
-  # FIXME - following optimization attempt needs to handle cache clearing!
-#  instance_variable_get var_name or begin
-#    instance_variable_set var_name, block_given? ? yield : raise("no block?")
-#  end
+def trait_var _var_name, &_block
+  # FIXME: - following optimization attempt needs to handle cache clearing!
+  #  instance_variable_get var_name or begin
+  #    instance_variable_set var_name, block_given? ? yield : raise("no block?")
+  #  end
   yield
 end
 
-#fixme -this needs a better home!
+# FIXME: -this needs a better home!
 def format opts={}
   opts = { format: opts.to_sym } if [Symbol, String].member? opts.class
 
   Card::Format.new self, opts
-end
+end

data/mod/01_core/set/all/collection.rb

@@ -75,7 +75,7 @@ def insert_item index, name
   self.content = new_names.join "\n"
 end
 
-def extended_item_cards context = nil
+def extended_item_cards context=nil
   context = (context ? context.cardname : cardname)
   args = { limit: '' }
   items = item_cards(args.merge(context: context))
@@ -128,7 +128,7 @@ format do
 
   def item_view args
     args[:item] ||
-      (@inclusion_opts && @inclusion_opts[:view]) ||
+      (@nest_opts && @nest_opts[:view]) ||
       default_item_view
   end
 
@@ -170,7 +170,7 @@ format do
     params.each do |key, val|
       case key.to_s
       when '_wql'      then hash.merge! val
-      when /^\_(\w+)$/ then hash[:vars][$1.to_sym] = val
+      when /^\_(\w+)$/ then hash[:vars][Regexp.last_match(1).to_sym] = val
       end
     end
   end
@@ -197,10 +197,10 @@ format do
     result
   end
 
-  def unique_chunks chunk, processed_set, &block
+  def unique_chunks chunk, processed_set, &_block
     return if processed_set.include? chunk.referee_name.key
     processed_set << chunk.referee_name.key
-    block.call(chunk)
+    yield(chunk)
   end
 
   def each_nested_field args, &block
@@ -208,26 +208,25 @@ format do
 
     each_nested_chunk(args) do |chunk|
       # TODO: handle structures that are non-virtual
-      if chunk.referee_name.to_name.field_of? card.name
-        if chunk.referee_card &&
-           chunk.referee_card.virtual? &&
-           !processed_chunk_keys.include?(chunk.referee_name.key)
-
-          processed_chunk_keys << chunk.referee_name.key
-          subformat(chunk.referee_card).each_nested_field(args) do |sub_chunk|
-            unique_chunks sub_chunk, processed_chunk_keys, &block
-          end
-        else
-          unique_chunks chunk, processed_chunk_keys, &block
+      next unless chunk.referee_name.to_name.field_of? card.name
+      if chunk.referee_card &&
+         chunk.referee_card.virtual? &&
+         !processed_chunk_keys.include?(chunk.referee_name.key)
+
+        processed_chunk_keys << chunk.referee_name.key
+        subformat(chunk.referee_card).each_nested_field(args) do |sub_chunk|
+          unique_chunks sub_chunk, processed_chunk_keys, &block
         end
+      else
+        unique_chunks chunk, processed_chunk_keys, &block
       end
     end
   end
 
-  def map_references_with_args args={}, &block
+  def map_references_with_args args={}, &_block
     result = []
     each_reference_with_args args do |name, n_args|
-      result << block.call(name, n_args)
+      result << yield(name, n_args)
     end
     result
   end
@@ -235,7 +234,7 @@ format do
   # process args for links and nests
   def nest_args args, chunk=nil
     r_args = item_args(args)
-    r_args.merge! @inclusion_opts.clone if @inclusion_opts
+    r_args.merge! @nest_opts.clone if @nest_opts
 
     case chunk
     when Card::Chunk::Include
@@ -276,7 +275,7 @@ format :html do
     args[:tab_type] ||= 'tabs'
   end
 
-  # create a path for a nest with respect ot the inclusion options
+  # create a path for a nest with respect ot the nest options
   def nest_path name, nest_args
     path_args = {}
     path_args[:view] = nest_args[:view]

data/mod/01_core/set/all/content.rb

@@ -46,15 +46,17 @@ def last_draft_content
   drafts.last.card_changes.last.value
 end
 
-event :save_draft,
-      before: :store, on: :update,
-      when: proc { Env.params['draft'] == 'true' } do
+event :save_draft, :store,
+      on: :update, when: proc { Env.params['draft'] == 'true' } do
   save_content_draft content
   abort :success
 end
 
-event :set_default_content, on: :create, before: :approve do
-  if !db_content_changed? && template && template.db_content.present?
-    self.db_content = template.db_content
-  end
+event :set_default_content, :prepare_to_validate,
+      on: :create, when: proc { |c| c.use_default_content? } do
+  self.db_content = template.db_content
+end
+
+def use_default_content?
+  !db_content_changed? && template && template.db_content.present?
 end

data/mod/01_core/set/all/erb.rb

@@ -1,11 +1,11 @@
 format do
   def render_erb locals={}, template=nil, a_binding=nil, &block
-    template ||= block.call
+    template ||= yield
     a_binding ||= binding
-    locals.each do |k,v|
-      #a_binding.local_variable_set(k, v) # needs ruby 2.1
-      instance_variable_set("@#{k}",v)
+    locals.each do |k, v|
+      # a_binding.local_variable_set(k, v) # needs ruby 2.1
+      instance_variable_set("@#{k}", v)
     end
-    ERB.new(template,nil,'-').result(binding)
+    ERB.new(template, nil, '-').result(binding)
   end
 end

data/mod/01_core/set/all/event.rb

@@ -0,0 +1,60 @@
+def event_applies? opts
+  on_condition_applies?(opts[:on]) &&
+    changed_condition_applies?(opts[:changed]) &&
+    when_condition_applies?(opts[:when])
+end
+
+def rescue_event e
+  @action = nil
+  expire_pieces
+  subcards.each(&:expire_pieces)
+  raise e
+  # rescue Card::Cancel
+  # false
+end
+
+private
+
+def on_condition_applies? action
+  if action
+    Array.wrap(action).member? @action
+  else
+    true
+  end
+end
+
+def changed_condition_applies? db_columns
+  case db_columns
+  when Symbol
+    return single_changed_condition_applies?(db_columns)
+  when Array
+    db_columns.each do |col|
+      return true if single_changed_condition_applies? col
+    end
+  else
+    return  true
+  end
+  false
+end
+
+def single_changed_condition_applies? db_column
+  if db_column
+    db_column =
+      case db_column.to_sym
+      when :content then 'db_content'
+      when :type    then 'type_id'
+      else db_column.to_s
+      end
+    @action != :delete && changes[db_column]
+  else
+    true
+  end
+end
+
+def when_condition_applies? block
+  if block
+    block.call self
+  else
+    true
+  end
+end

data/mod/01_core/set/all/fetch.rb

@@ -100,15 +100,10 @@ module ClassMethods
     Card.cache.hard.delete "~#{card.id}" if card.id
   end
 
-  def expire name, subcards=false
+  def expire name
     # note: calling instance method breaks on dirty names
     key = name.to_name.key
     return unless (card = Card.cache.read key)
-    if subcards
-      card.expire_subcards
-    else
-      card.preserve_subcards
-    end
     Card.cache.delete key
     Card.cache.delete "~#{card.id}" if card.id
   end
@@ -120,9 +115,14 @@ module ClassMethods
     set_cache_list.nil? ? [] : set_cache_list.keys
   end
 
+  # updates the members hash for all sets self is a member of
+  # QUESTION: why map and not each?
+  # I don't see where that array is useful. It contains
+  # nil for all sets for which self was already cached as a member
   def set_members set_names, key
-    set_names.compact.map(&:to_name).map(&:key).map do |set_key|
-      skey = "$#{set_key}" # dollar sign avoids conflict with card keys
+    set_names.compact.map do |set_name|
+      # dollar sign avoids conflict with card keys
+      skey = "$#{set_name.to_name.key}"
       h = Card.cache.read skey
       if h.nil?
         h = {}
@@ -137,7 +137,7 @@ module ClassMethods
 
   def validate_fetch_opts! opts
     return unless opts[:new] && opts[:skip_virtual]
-    fail Card::Error, 'fetch called with new args and skip_virtual'
+    raise Card::Error, 'fetch called with new args and skip_virtual'
   end
 
   def cache
@@ -196,7 +196,6 @@ module ClassMethods
     query = { mark_type => mark_key }
     query[:trash] = false unless opts[:look_in_trash]
     card = Card.where(query).take
-    card.restore_subcards if card
     card
   end
 
@@ -288,7 +287,7 @@ end
 
 def expire_pieces
   cardname.piece_names.each do |piece|
-    Card.expire piece, !cardname.field_of?(piece)
+    Card.expire piece
   end
 end
 
@@ -298,19 +297,14 @@ def expire_hard
   Card.cache.hard.delete "~#{id}" if id
 end
 
-def expire_soft subcards=false
-  if subcards
-    expire_subcards
-  else
-    preserve_subcards
-  end
+def expire_soft
   Card.cache.soft.delete key
   Card.cache.soft.delete "~#{id}" if id
 end
 
-def expire subcards=false
+def expire
   expire_hard
-  expire_soft subcards
+  expire_soft
 end
 
 def refresh force=false