card 1.17.4 → 1.18.0

data/lib/card/director_register.rb

@@ -0,0 +1,66 @@
+class Card
+  def act opts={}
+    if !DirectorRegister.act_card
+      DirectorRegister.clear
+      self.director = nil
+      DirectorRegister.act_card = self
+      main_act_block = true
+      if opts[:success]
+        Env[:success] = Success.new(cardname, Env.params[:success])
+      end
+    else
+      main_act_block = false
+    end
+    yield
+  ensure
+    DirectorRegister.clear if main_act_block
+  end
+
+  def self.new_director card, opts={}
+    if opts[:parent]
+      StageSubdirector.new card, opts
+    elsif DirectorRegister.act_card &&
+          DirectorRegister.act_card != card &&
+          DirectorRegister.act_card.director.running?
+      DirectorRegister.act_card.director.subdirectors.add(card)
+    else
+      StageDirector.new card
+    end
+  end
+
+  class DirectorRegister
+    cattr_accessor :act_card
+
+    class << self
+      def act_director
+        return unless DirectorRegister.act_card
+        DirectorRegister.act_card.director
+      end
+
+      def directors
+        @directors ||= {}
+      end
+
+      def clear
+        DirectorRegister.act_card = nil
+        directors.each_pair do |card, _dir|
+          card.director = nil
+        end
+        @directors = nil
+      end
+
+      def fetch card, opts={}
+        directors[card] ||= Card.new_director card, opts
+      end
+
+      def add director
+        directors[director.card] = director
+      end
+
+      def delete director
+        return unless @directors
+        @directors.delete director.card
+      end
+    end
+  end
+end

data/lib/card/env.rb

@@ -1,5 +1,3 @@
-
-
 class Card
   require 'card/location'
 
@@ -16,8 +14,10 @@ class Card
           self[:ip]         = c.request.remote_ip
           self[:ajax]       = c.request.xhr? || c.request.params[:simulate_xhr]
           self[:html]       = [nil, 'html'].member?(c.params[:format])
-          self[:host]       = Card.config.override_host     || c.request.env['HTTP_HOST']
-          self[:protocol]   = Card.config.override_protocol || c.request.protocol
+          self[:host]       = Card.config.override_host ||
+                              c.request.env['HTTP_HOST']
+          self[:protocol]   = Card.config.override_protocol ||
+                              c.request.protocol
         end
       end
 
@@ -29,7 +29,6 @@ class Card
         @@env[key.to_sym] = value
       end
 
-
       def params
         self[:params] ||= {}
       end
@@ -56,9 +55,9 @@ class Card
 
       def method_missing method_id, *args
         case args.length
-        when 0 ; self[ method_id ]
-        when 1 ; self[ method_id ] = args[0]
-        else   ; super
+        when 0 then self[method_id]
+        when 1 then self[method_id] = args[0]
+        else super
         end
       end
     end
@@ -66,8 +65,6 @@ class Card
     # session history helpers: we keep a history stack so that in the case of
     # card removal we can crawl back up to the last un-removed location
     module LocationHistory
-      #include Card::Location
-
       def location_history
         session[:history] ||= [Card::Location.card_path('')]
         session[:history].shift if session[:history].size > 5
@@ -75,14 +72,17 @@ class Card
       end
 
       def save_location card
-        return if Env.ajax? || !Env.html? || !card.known? ||
-                  (card.codename == 'signin')
+        return unless save_location?(card)
         discard_locations_for card
         session[:previous_location] =
           Card::Location.card_path card.cardname.url_key
         location_history.push previous_location
       end
 
+      def save_location? card
+        !Env.ajax? && Env.html? && card.known? && (card.codename != 'signin')
+      end
+
       def previous_location
         return unless location_history
         session[:previous_location] ||= location_history.last
@@ -106,16 +106,13 @@ class Card
         session.delete :interrupted_action
       end
 
-      def url_key_for_location(location)
-        location.match( /\/([^\/]*$)/ ) ? $1 : nil
+      def url_key_for_location location
+        (%r{/([^/]*$)} =~ location) ? Regexp.last_match[1] : nil
       end
     end
 
     extend LocationHistory
-
   end
 
-
-
   Env.reset
 end

data/lib/card/exceptions.rb

@@ -1,22 +1,22 @@
 # -*- encoding : utf-8 -*-
 
 class Card
-  class Error < StandardError #code problem
+  class Error < StandardError # code problem
     cattr_accessor :current
   end
-  
+
   class Oops < Error # wagneer problem (rename!)
   end
-  
+
   class BadQuery < Error
   end
-    
+
   class NotFound < StandardError
   end
-  
+
   class PermissionDenied < Error
     attr_reader :card
-  
+
     def initialize card
       @card = card
       super build_message
@@ -30,7 +30,7 @@ class Card
       end
     end
   end
-  
+
   class Abort < StandardError
     attr_reader :status
 
@@ -38,7 +38,5 @@ class Card
       @status = status
       super msg
     end
-
   end
-  
 end

data/lib/card/format.rb

@@ -3,12 +3,15 @@
 class Card
   class Format
     include Card::Location
+    include Nest
+    include Permission
+    include Render
 
     DEPRECATED_VIEWS = { view: :open, card: :open, line: :closed,
-                         bare: :core, naked: :core }
+                         bare: :core, naked: :core }.freeze
     INCLUSION_MODES  = { closed: :closed, closed_content: :closed, edit: :edit,
                          layout: :layout, new: :edit, setup: :edit,
-                         normal: :normal, template: :template }
+                         normal: :normal, template: :template }.freeze
     # FIXME: should be set in views
 
     cattr_accessor :ajax_call, :registered
@@ -19,7 +22,7 @@ class Card
     end
 
     attr_reader :card, :root, :parent, :main_opts
-    attr_accessor :form, :error_status, :inclusion_opts
+    attr_accessor :form, :error_status, :nest_opts
 
     class << self
       @@registered = []
@@ -70,9 +73,7 @@ class Card
 
       def format_ancestry
         ancestry = [self]
-        unless self == Card::Format
-          ancestry = ancestry + superclass.format_ancestry
-        end
+        ancestry += superclass.format_ancestry unless self == Card::Format
         ancestry
       end
 
@@ -84,9 +85,7 @@ class Card
     # ~~~~~ INSTANCE METHODS
 
     def initialize card, opts={}
-      unless (@card = card)
-        raise Card::Error, 'format initialized without card'
-      end
+      raise Card::Error, 'format initialized without card' unless (@card = card)
       opts.each do |key, value|
         instance_variable_set "@#{key}", value
       end
@@ -103,11 +102,11 @@ class Card
     def get_context_names
       case
       when @context_names
-        part_keys = @card.cardname.part_names.map &:key
+        part_keys = @card.cardname.part_names.map(&:key)
         @context_names.reject { |n| !part_keys.include? n.key }
       when params[:slot]
         context_name_list = params[:slot][:name_context].to_s
-        context_name_list.split(',').map &:to_name
+        context_name_list.split(',').map(&:to_name)
       else
         []
       end
@@ -121,18 +120,6 @@ class Card
       end
     end
 
-    def inclusion_defaults nested_card
-      @inclusion_defaults ||= begin
-        defaults = get_inclusion_defaults(nested_card).clone
-        defaults.merge! @inclusion_opts if @inclusion_opts
-        defaults
-      end
-    end
-
-    def get_inclusion_defaults _nested_card
-      { view: :name }
-    end
-
     def params
       Env.params
     end
@@ -147,9 +134,9 @@ class Card
 
     def showname title=nil
       if title
-        title.to_name.to_absolute_name(card.cardname).to_show *@context_names
+        title.to_name.to_absolute_name(card.cardname).to_show(*@context_names)
       else
-        @showname ||= card.cardname.to_show *@context_names
+        @showname ||= card.cardname.to_show(*@context_names)
       end
     end
 
@@ -184,10 +171,13 @@ class Card
 
     def method_missing method, *opts, &proc
       if method =~ /(_)?(optional_)?render(_(\w+))?/
-        view = $3 ? $4 : opts.shift
+        view = Regexp.last_match(3) ? Regexp.last_match(4) : opts.shift
         args = opts[0] ? opts.shift.clone : {}
-        args.merge!(optional: true, default_visibility: opts.shift) if $2
-        args[:skip_permissions] = true if $1
+        if Regexp.last_match(2)
+          args[:optional] = true
+          args[:default_visibility] = opts.shift
+        end
+        args[:skip_permissions] = true if Regexp.last_match(1)
         render view, args
       else
         proc = proc { |*a| raw yield *a } if proc
@@ -196,135 +186,10 @@ class Card
       end
     end
 
-    #
-    # ---------- Rendering ------------
-    #
-
-    def render view, args={}
-      view = canonicalize_view view
-      return if hidden_view? view, args
-      view = ok_view view, args
-      current_view(view) do
-        args = default_render_args view, args
-        with_inclusion_mode view do
-          Card::ViewCache.fetch(self, view, args) do
-            method = view_method view, args
-            method.arity == 0 ? method.call : method.call(args)
-          end
-        end
-      end
-    rescue => e
-      rescue_view e, view
-    end
-
-    def view_method view, args
-      method "_view_#{view}"
-    rescue
-      args[:unsupported_view] = view
-      method '_view_unsupported_view'
-    end
-
-    def hidden_view? view, args
-      args.delete(:optional) && !show_view?(view, args)
-    end
-
-    def show_view? view, args
-      default = args.delete(:default_visibility) || :show # FIXME: - ugly
-      api_option = args["optional_#{view}".to_sym]
-      case
-      # permanent visibility specified in code
-      when api_option == :always then true
-      when api_option == :never  then false
-      else
-        # wagneer can override code settings
-        contextual_setting = nest_arg_visibility(view, args) || api_option
-        case contextual_setting
-        when :show               then true
-        when :hide               then false
-        else default == :show
-        end
-      end
-    end
-
-    def nest_arg_visibility view, args
-      [:show, :hide].each do |setting|
-        return setting if parse_view_visibility(args[setting]).member?(view)
-      end
-      false
-    end
-
-    def parse_view_visibility val
-      case val
-      when NilClass then []
-      when Array    then val
-      when String   then val.split(/[\s,]+/)
-      else raise Card::Error, "bad show/hide argument: #{val}"
-      end.map { |view| canonicalize_view view }
-    end
-
-    def default_render_args view, a=nil
-      args =
-        case a
-        when nil   then {}
-        when Hash  then a.clone
-        when Array then a[0].merge a[1]
-        else       raise Card::Error, "bad render args: #{a}"
-        end
-
-      default_method = "default_#{view}_args"
-      if respond_to? default_method
-        send default_method, args
-      end
-      args
-    end
-
-    def rescue_view e, view
-      if Rails.env =~ /^cucumber|test$/
-        raise e
-      else
-        Rails.logger.info "\nError rendering #{error_cardname} / #{view}: "\
-                          "#{e.class} : #{e.message}"
-        Card::Error.current = e
-        card.notable_exception_raised
-        if (debug = Card[:debugger]) && debug.content == 'on'
-          raise e
-        else
-          rendering_error e, view
-        end
-      end
-    end
-
-    def current_view view
-      old_view = @current_view
-      @current_view = view
-      yield
-    ensure
-      @current_view = old_view
-    end
-
-    def error_cardname
-      card && card.name.present? ? card.name : 'unknown card'
-    end
-
-    def rendering_error _exception, view
-      "Error rendering: #{error_cardname} (#{view} view)"
-    end
-
     #
     # ------------- Sub Format and Inclusion Processing ------------
     #
 
-    def subformat subcard
-      subcard = Card.fetch(subcard, new: {}) if subcard.is_a?(String)
-      self.class.new subcard,
-                     parent: self, depth: @depth + 1, root: @root,
-                     # FIXME: - the following four should not be hard-coded
-                     # here.  need a generalized mechanism
-                     # for attribute inheritance
-                     context_names: @context_names, mode: @mode,
-                     mainline: @mainline, form: @form
-    end
-
     def process_content override_content=nil, opts={}
       process_content_object(override_content, opts).to_s
     end
@@ -345,228 +210,14 @@ class Card
       end
     end
 
-    def ok_view view, args={}
-      return view if args.delete :skip_permissions
-      approved_view = approved_view view, args
-      args[:denied_view] = view if approved_view != view
-      if focal? && (error_code = @@error_code[approved_view])
-        root.error_status = error_code
-      end
-      approved_view
-    end
-
-    def approved_view view, args={}
-      case
-      when @depth >= Card.config.max_depth
-        # prevent recursion. @depth tracks subformats
-        :too_deep
-      when @@perms[view] == :none
-        # permission skipping specified in view definition
-        view
-      when args.delete(:skip_permissions)
-        # permission skipping specified in args
-        view
-      when !card.known? && !tagged(view, :unknown_ok)
-        # handle unknown cards (where view not exempt)
-        view_for_unknown view, args
-      else
-        # run explicit permission checks
-        permitted_view view, args
-      end
-    end
-
     def tagged view, tag
       self.class.tagged view, tag
     end
 
-    def permitted_view view, args
-      perms_required = @@perms[view] || :read
-      args[:denied_task] =
-        if Proc === perms_required
-          :read if !(perms_required.call self)  # read isn't quite right
-        else
-          [perms_required].flatten.find { |task| !ok? task }
-        end
-
-      if args[:denied_task]
-        @@denial[view] || :denial
-      else
-        view
-      end
-    end
-
-    def ok? task
-      task = :create if task == :update && card.new_card?
-      @ok ||= {}
-      @ok[task] = card.ok? task if @ok[task].nil?
-      @ok[task]
-    end
-
-    def view_for_unknown _view, _args
-      # note: overridden in HTML
-      focal? ? :not_found : :missing
-    end
-
-    def canonicalize_view view
-      return if view.blank?
-      view_key = view.to_viewname.key.to_sym
-      DEPRECATED_VIEWS[view_key] || view_key
-    end
-
-    def with_inclusion_mode mode
-      if (switch_mode = INCLUSION_MODES[mode]) && @mode != switch_mode
-        old_mode, @mode = @mode, switch_mode
-        @inclusion_defaults = nil
-      end
-      result = yield
-      if old_mode
-        @inclusion_defaults = nil
-        @mode = old_mode
-      end
-      result
-    end
-
-    def prepare_nest opts
-      @char_count ||= 0
-      opts ||= {}
-
-      case
-      when opts.has_key?(:comment)
-        # commented nest
-        opts[:comment]
-      when @mode == :closed && @char_count > Card.config.max_char_count
-        # move on; content out of view
-        ''
-      when opts[:inc_name] == '_main' && show_layout? && @depth == 0
-        # the main card within a layout
-        expand_main opts
-      else
-        # standard nest
-        result = nest fetch_nested_card(opts), opts
-        @char_count += result.length if @mode == :closed && result
-        result
-      end
-    end
-
-    def expand_main opts
-      opts.merge! root.main_opts if root.main_opts
-      legacy_main_opts_tweaks! opts
-
-      with_inclusion_mode :normal do
-        @mainline = true
-        result = wrap_main nest(root.card, opts)
-        @mainline = false
-        result
-      end
-    end
-
-    def legacy_main_opts_tweaks! opts
-      if (val = params[:size]) && val.present?
-        opts[:size] = val.to_sym
-      end
-
-      if (val = params[:item]) && val.present?
-        opts[:items] = (opts[:items] || {}).reverse_merge view: val.to_sym
-      end
-    end
-
-    def wrap_main content
-      content  # no wrapping in base format
-    end
-
-    def nest nested_card, opts={}
-      # ActiveSupport::Notifications.instrument('card', message:
-      # "nest: #{nested_card.name}, #{opts}") do
-      opts.delete_if { |_k, v| v.nil? }
-      opts.reverse_merge! inclusion_defaults(nested_card)
-
-      sub = nil
-      if opts[:inc_name] =~ /^_(self)?$/
-        sub = self
-      else
-        sub = subformat nested_card
-        sub.inclusion_opts = opts[:items] ? opts[:items].clone : {}
-      end
-
-      view = canonicalize_view opts.delete :view
-      opts[:home_view] = [:closed, :edit].member?(view) ? :open : view
-      # FIXME: special views should be represented in view definitions
-
-      view =
-        case @mode
-        when :edit     then view_in_edit_mode(view, nested_card)
-        when :template then :template_rule
-        when :closed   then view_in_closed_mode(view, nested_card)
-        else                view
-        end
-
-      sub.optional_render view, opts
-      # end
-    end
-
-    def view_in_edit_mode homeview, nested_card
-      not_in_form =
-        @@perms[homeview] == :none || # view configured not to keep in form
-        nested_card.structure || #      not yet nesting structures
-        nested_card.key.blank? #        eg {{_self|type}} on new cards
-
-      not_in_form ? :blank : :edit_in_form
-    end
-
-    def view_in_closed_mode homeview, nested_card
-      approved_view = @@closed[homeview]
-      case
-      when approved_view == true  then homeview
-      when @@error_code[homeview] then homeview
-      when approved_view          then approved_view
-      when !nested_card.known?    then :closed_missing
-      else                             :closed_content
-      end
-    end
-
-    def get_inclusion_content cardname
-      content = params[cardname.to_s.tr('+', '_')]
-
-      # CLEANME This is a hack so plus cards re-populate on failed signups
-      p = params['subcards']
-      if p && (card_params = p[cardname.to_s])
-        content = card_params['content']
-      end
-      content if content.present? # returns nil for empty string
-    end
-
-    def fetch_nested_card options
-      args = { name: options[:inc_name], type: options[:type], supercard: card }
-      args.delete(:supercard) if options[:inc_name].strip.blank?
-      # special case.  gets absolutized incorrectly. fix in smartname?
-      if options[:inc_name] =~ /^_main\+/
-        # FIXME: this is a rather hacky (and untested) way to get @superleft
-        # to work on new cards named _main+whatever
-        args[:name] = args[:name].gsub /^_main\+/, '+'
-        args[:supercard] = root.card
-      end
-      if (content = get_inclusion_content options[:inc_name])
-        args[:content] = content
-      end
-      Card.fetch options[:inc_name], new: args
-    end
-
-    def default_item_view
-      :name
-    end
-
     #
     # ------------ LINKS ---------------
     #
 
-    def add_class options, klass
-      options[:class] = [options[:class], klass].flatten.compact * ' '
-    end
-
-    def unique_id
-      "#{card.key}-#{Time.now.to_i}-#{rand(3)}"
-    end
-
     def format_date date, include_time=true
       # using DateTime because Time doesn't support %e on some platforms
       if include_time