module WrapIt
#
# Base class for all HTML helper classes
#
# @example Prevent user from changing element tag
# class Helper < WrapIt::Base
# after_initialize { @tag = 'table' }
# end
# @example Including some simple HTML into content
# class Helper < WrapIt::Base
# after_initialize do
# @icon = optioins.delete(:icon)
# end
# after_capture do
# unless @icon.nil?
# @content = html_safe("") + @content
# end
# end
# @author Alexey Ovchinnikov
#
class Base
include DerivedAttributes
include Callbacks
callback :initialize, :capture, :render
include HTMLClass
include HTMLData
include Switches
include Enums
include Renderer
@omit_content = false
attr_reader :tag
attr_reader :options
def initialize(template, *args, &block)
@template, @arguments, @block = template, args, block
self.options = @arguments.extract_options!
@helper_name = @options.delete(:helper_name)
@helper_name.is_a?(String) && @helper_name = @helper_name.to_sym
@arguments.extend ArgumentsArray
add_default_classes
run_callbacks :initialize do
@tag = @options.delete(:tag) ||
self.class.get_derived(:@default_tag) || 'div'
@tag = @tag.to_s
end
@arguments = nil
end
def omit_content?
self.class.get_derived(:@omit_content)
end
#
# Renders element to template
#
# @override render([content, ...])
# @param content [String] additional content that will be appended
# to element content
# @yield [element] Runs block after capturing element content and before
# rendering it. Returned value appended to content.
# @yieldparam element [Base] rendering element.
# @yieldreturn [String, nil] content to append to HTML
#
# @return [String] rendered HTML for element
def render(*args, &render_block)
# return cached copy if it available
return @content unless @content.nil?
@content = empty_html
do_capture
# add to content string args and block result if its present
args.flatten.each { |a| @content << a if a.is_a? String }
if block_given?
result = instance_exec(self, &render_block) || empty_html
result.is_a?(String) && @content << result
end
do_render
do_wrap
if @template.output_buffer.nil?
# when render called from code, just return content as a String
@content
else
# in template context, write content to templates buffer
concat(@content)
empty_html
end
end
#
# Wraps element with another.
#
# You can provide wrapper directly or specify wrapper class as first
# argument. In this case wrapper will created with specified set of
# arguments and options. If wrapper class ommited, WrapIt::Base will
# be used.
#
# If block present, it will be called when wrapper will rendered.
#
# @override wrap(wrapper)
# @param wrapper [Base] wrapper instance.
#
# @override wrap(wrapper_class, [arg, ...], options = {})
# @param wrapper_class [Class] WrapIt::Base subclass for wrapper.
# @param arg [String, Symbol] wrapper creation arguments.
# @param options [Hash] wrapper creation options.
#
# @override wrap([arg, ...], options = {})
# @param arg [String, Symbol] wrapper creation arguments.
# @param options [Hash] wrapper creation options.
#
# @return [void]
def wrap(*args, &block)
if args.first.is_a?(Base)
@wrapper = args.shift
else
wrapper_class = args.first.is_a?(Class) ? args.shift : Base
@wrapper = wrapper_class.new(@template, *args, &block)
end
end
def unwrap
@wrapper = nil
end
protected
#
# @dsl
# Defines default tag name for element. This tag can be changed soon.
# @param name [] Tag name. Converted to `String`.
#
# @return [void]
def self.default_tag(name, override = true)
name.is_a?(String) || name.is_a?(Symbol) ||
fail(ArgumentError, 'Tag name should be a String or Symbol')
override ? @default_tag = name.to_s : @default_tag ||= name.to_s
end
def self.omit_content
@omit_content = true
end
def options=(hash)
hash.is_a?(Hash) || return
hash.symbolize_keys!
# sanitize class
hash[:class] ||= []
hash[:class] = [hash[:class]] unless hash[:class].is_a?(Array)
hash[:class] = hash[:class].map { |c| c.to_s }.uniq
@options = hash
end
private
def do_capture
run_callbacks :capture do
@content ||= empty_html
unless @block.nil? || omit_content?
@content << (capture(self, &@block) || empty_html)
end
end
end
def do_render
# cleanup options from empty values
@options.select! do |k, v|
!v.nil? && (!v.respond_to?(:empty?) || !v.empty?)
end
run_callbacks :render do
@content = content_tag(tag, @content, options)
end
end
def do_wrap
@wrapper.is_a?(Base) && @content = @wrapper.render(html_safe(@content))
end
end
end