padrino/padrino-framework

View on GitHub
padrino-helpers/lib/padrino-helpers/render_helpers.rb

Summary

Maintainability
B
4 hrs
Test Coverage
module Padrino
  module Helpers
    ##
    # Helpers related to rendering within templates (i.e partials).
    #
    module RenderHelpers
      ##
      # Render a partials with collections support.
      #
      # @param [String] template
      #   Relative path to partial template.
      # @param [Hash] options
      #   Options hash for rendering options.
      # @option options [Object] :object
      #   Object rendered in partial.
      # @option options [Array<Object>] :collection
      #   Partial is rendered for each object in this collection.
      # @option options [Hash] :locals ({})
      #   Local variables accessible in the partial.
      # @option options [Symbol] :engine
      #   Explicit rendering engine to use for this partial.
      #
      # @return [String] The html generated from this partial.
      #
      # @example
      #   partial 'photo/item', :object => @photo
      #   partial 'photo/item', :collection => @photos
      #   partial 'photo/item', :locals => { :foo => :bar }
      #   partial 'photo/item', :engine => :erb
      #
      # @note If using this from Sinatra, pass explicit +:engine+ option
      #
      def partial(template, options={}, &block)
        options = { :layout => false }.update(options)
        explicit_engine = options.delete(:engine)

        path, _, name = template.to_s.rpartition(File::SEPARATOR)
        template_path = path.empty? ? :"_#{name}" : :"#{path}#{File::SEPARATOR}_#{name}"
        item_name = name.partition('.').first.to_sym

        items, counter = if options[:collection].respond_to?(:inject)
          [options.delete(:collection), 0]
        else
          [[options.delete(:object)], nil]
        end

        locals = options.delete(:locals) || {}
        items.each_with_object(SafeBuffer.new) do |item,html|
          locals[item_name] = item if item
          locals["#{item_name}_counter".to_sym] = counter += 1 if counter
          content =
            if block_given?
              concat_content(render(explicit_engine, template_path, options, locals) { capture_html(&block) })
            else
              render(explicit_engine, template_path, options, locals)
            end
          html.safe_concat content if content
        end
      end
      alias :render_partial :partial

      def self.included(base)
        unless base.instance_methods.include?(:render) || base.private_instance_methods.include?(:render)
          base.class_eval do
            fail "gem 'tilt' is required" unless defined?(::Tilt)

            def render(engine, file=nil, options={}, locals=nil, &block)
              options.delete(:layout)
              engine, file = file, engine if file.nil?
              template_engine = engine ? ::Tilt[engine] : ::Tilt.default_mapping[file]
              fail "Engine #{engine.inspect} is not registered with Tilt" unless template_engine
              unless File.file?(file.to_s)
                engine_extensions = ::Tilt.default_mapping.extensions_for(template_engine)
                file = Dir.glob("#{file}.{#{engine_extensions.join(',')}}").first || fail("Template '#{file}' not found")
              end
              template = template_engine.new(file.to_s, options)
              template.render(options[:scope] || self, locals, &block)
            end
          end
        end
      end
    end
  end
end