card 1.17.4 → 1.18.0

data/lib/card/format/nest.rb

@@ -0,0 +1,183 @@
+class Card
+  class Format
+    module Nest
+      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 with_nest_mode mode
+        if (switch_mode = INCLUSION_MODES[mode]) && @mode != switch_mode
+          old_mode = @mode
+          @mode = switch_mode
+          @nest_defaults = nil
+        end
+        result = yield
+        if old_mode
+          @nest_defaults = nil
+          @mode = old_mode
+        end
+        result
+      end
+
+      def prepare_nest opts
+        @char_count ||= 0
+        opts ||= {}
+
+        case
+        when opts.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 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! nest_defaults(nested_card)
+
+        sub = nil
+        if opts[:inc_name] =~ /^_(self)?$/
+          sub = self
+        else
+          sub = subformat nested_card
+          sub.nest_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 get_nest_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
+        Card.fetch options[:inc_name], new: nest_new_args(options)
+      end
+
+      def nest_new_args 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_nest_content options[:inc_name])
+          args[:content] = content
+        end
+        args
+      end
+
+      def wrap_main content
+        content # no wrapping in base format
+      end
+
+      def nest_defaults nested_card
+        @nest_defaults ||= begin
+          defaults = get_nest_defaults(nested_card).clone
+          defaults.merge! @nest_opts if @nest_opts
+          defaults
+        end
+      end
+
+      def get_nest_defaults _nested_card
+        { view: :name }
+      end
+
+      protected
+
+      def expand_main opts
+        opts.merge! root.main_opts if root.main_opts
+        legacy_main_opts_tweaks! opts
+
+        with_nest_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 view_in_edit_mode homeview, nested_card
+        not_in_form =
+          Card::Format.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 = Card::Format.closed[homeview]
+        case
+        when approved_view == true then
+          homeview
+        when Card::Format.error_code[homeview] then
+          homeview
+        when approved_view then
+          approved_view
+        when !nested_card.known? then
+          :closed_missing
+        else
+          :closed_content
+        end
+      end
+    end
+  end
+end

data/lib/card/format/permission.rb

@@ -0,0 +1,63 @@
+class Card
+  class Format
+    module Permission
+      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 = Card::Format.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 Card::Format.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 permitted_view view, args
+        perms_required = Card::Format.perms[view] || :read
+        args[:denied_task] =
+          if perms_required.is_a? Proc
+            :read unless perms_required.call(self)  # read isn't quite right
+          else
+            [perms_required].flatten.find { |task| !ok? task }
+          end
+
+        if args[:denied_task]
+          Card::Format.denial[view] || :denial
+        else
+          view
+        end
+      end
+
+      def view_for_unknown _view, _args
+        # note: overridden in HTML
+        focal? ? :not_found : :missing
+      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
+    end
+  end
+end

data/lib/card/format/render.rb

@@ -0,0 +1,140 @@
+class Card
+  class Format
+    module Render
+      def page view, slot_opts
+        @card.run_callbacks :show_page do
+          show view, slot_opts
+        end
+      end
+
+      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_nest_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 canonicalize_view view
+        return if view.blank?
+        view_key = view.to_viewname.key.to_sym
+        DEPRECATED_VIEWS[view_key] || view_key
+      end
+
+      def default_item_view
+        :name
+      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 api_option
+          # permanent visibility specified in code
+        when :always then true
+        when  :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"
+        send default_method, args if respond_to?(default_method)
+        args
+      end
+
+      def rescue_view e, view
+        raise e if Rails.env =~ /^cucumber|test$/
+        Rails.logger.info "\nError rendering #{error_cardname} / #{view}: "\
+                        "#{e.class} : #{e.message}"
+        Card::Error.current = e
+        card.notable_exception_raised
+        raise e if (debug = Card[:debugger]) && debug.content == 'on'
+        rendering_error e, view
+      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
+
+      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
+    end
+  end
+end

data/lib/card/loader.rb

@@ -21,9 +21,7 @@ class Card
         load_formats
         load_sets
 
-        if ENV['RAILS_ENV'] == 'development'
-          update_machine_output_hack
-        end
+        update_machine_output_hack if ENV['RAILS_ENV'] == 'development'
       end
 
       def update_machine_output_hack
@@ -51,7 +49,7 @@ class Card
         return unless (mtime_output = style.machine_output_card.updated_at)
         style.machine_input_card.item_cards.each do |i_card|
           next unless i_card.codename
-          ['03_machines', '06_bootstrap'].each do |mod|
+          %w(03_machines 06_bootstrap).each do |mod|
             style_dir = "#{Cardio.gem_root}/mod/#{mod}/lib/stylesheets"
             file_path = "#{style_dir}/#{i_card.codename}.scss"
             next unless File.exist? file_path
@@ -73,11 +71,11 @@ class Card
       def load_layouts
         mod_dirs.inject({}) do |hash, mod|
           dirname = "#{mod}/layout"
-          if File.exists? dirname
+          if File.exist? dirname
             Dir.foreach(dirname) do |filename|
               next if filename =~ /^\./
               hash[filename.gsub /\.html$/, ''] =
-                File.read([dirname, filename] * '/')
+                File.read([dirname, filename].join('/'))
             end
           end
           hash
@@ -97,9 +95,7 @@ class Card
       private
 
       def load_set_patterns
-        if rewrite_tmp_files?
-          generate_set_pattern_tmp_files
-        end
+        generate_set_pattern_tmp_files if rewrite_tmp_files?
         load_dir "#{Card.paths['tmp/set_pattern'].first}/*.rb"
       end
 
@@ -108,15 +104,14 @@ class Card
         seq = 100
         mod_dirs.each do |mod|
           dirname = "#{mod}/set_pattern"
-          if Dir.exists? dirname
-            Dir.entries(dirname).sort.each do |filename|
-              m = filename.match(/^(\d+_)?([^\.]*).rb/)
-              key = m && m[2]
-              next unless key
-              filename = [dirname, filename] * '/'
-              SetPattern.write_tmp_file key, filename, seq
-              seq = seq + 1
-            end
+          next unless Dir.exist? dirname
+          Dir.entries(dirname).sort.each do |filename|
+            m = filename.match(/^(\d+_)?([^\.]*).rb/)
+            key = m && m[2]
+            next unless key
+            filename = [dirname, filename].join('/')
+            SetPattern.write_tmp_file key, filename, seq
+            seq += 1
           end
         end
       end
@@ -146,19 +141,17 @@ class Card
             tmp_filename = "#{mod_tmp_dir}/#{rel_filename}"
             Set.write_tmp_file abs_filename, tmp_filename, rel_filename
           end
-          seq = seq + 1
+          seq += 1
         end
       end
 
       def load_tmp_set_modules
         patterns = Card.set_patterns.reverse.map(&:pattern_code)
-          .unshift 'abstract'
+                       .unshift 'abstract'
         Dir.glob("#{Card.paths['tmp/set'].first}/*").sort.each do |tmp_mod|
           patterns.each do |pattern|
             pattern_dir = "#{tmp_mod}/#{pattern}"
-            if Dir.exists? pattern_dir
-              load_dir "#{pattern_dir}/**/*.rb"
-            end
+            load_dir "#{pattern_dir}/**/*.rb" if Dir.exist? pattern_dir
           end
         end
       end
@@ -173,9 +166,7 @@ class Card
       def prepare_tmp_dir path
         return unless rewrite_tmp_files?
         p = Card.paths[path]
-        if p.existent.first
-          FileUtils.rm_rf p.first, secure: true
-        end
+        FileUtils.rm_rf p.first, secure: true if p.existent.first
         Dir.mkdir p.first
       end