module Roda::RodaPlugins::Assets::InstanceMethods
Public Instance Methods
Source
# File lib/roda/plugins/assets.rb, line 717 def assets(type, attrs = OPTS) ltype = type.is_a?(Array) ? type[0] : type o = self.class.assets_opts if o[:compiled] && (algo = o[:sri]) && (hash = _compiled_assets_hash(type)) attrs = Hash[attrs] attrs[:integrity] = "#{algo}-#{h([[hash].pack('H*')].pack('m').tr("\n", ''))}" end attributes = attrs.map{|k,v| "#{k}=\"#{h(v)}\""}.join(' ') if ltype == :js tag_start = "<script#{' type="text/javascript"' unless attrs[:type]} #{attributes} src=\"" tag_end = "\"></script>" else tag_start = "<link rel=\"stylesheet\" #{attributes} href=\"" tag_end = "\" />" end paths = assets_paths(type) if o[:early_hints] early_hint_as = ltype == :js ? 'script' : 'style' early_hints = paths.map{|p| "<#{p}>; rel=preload; as=#{early_hint_as}"} early_hints = early_hints.join("\n") if Rack.release < '3' send_early_hints(RodaResponseHeaders::LINK=>early_hints) end paths.map{|p| "#{tag_start}#{h(p)}#{tag_end}"}.join("\n") end
Return a string containing html tags for the given asset type. This will use a script tag for the :js type and a link tag for the :css type.
To return the tags for a specific asset group, use an array for the type, such as [:css, :frontend].
You can specify custom attributes for the tag by passing a hash as the attrs argument.
When the assets are not compiled, this will result in a separate tag for each asset file. When the assets are compiled, this will result in a single tag to the compiled asset file.
Source
# File lib/roda/plugins/assets.rb, line 661 def assets_paths(type) o = self.class.assets_opts if type.is_a?(Array) ltype, *dirs = type else ltype = type end stype = ltype.to_s url_prefix = request.script_name if self.class.opts[:add_script_name] relative_paths = o[:relative_paths] paths = if o[:compiled] relative_paths = false if o[:compiled_asset_host] if ukey = _compiled_assets_hash(type, true) ["#{o[:compiled_asset_host]}#{url_prefix}/#{o[:"compiled_#{stype}_prefix"]}.#{ukey}.#{stype}"] else [] end else asset_dir = o[ltype] if dirs && !dirs.empty? dirs.each{|f| asset_dir = asset_dir[f]} prefix = "#{dirs.join('/')}/" if o[:group_subdirs] end Array(asset_dir).map do |f| if ts = o[:timestamp_paths] mtime = asset_last_modified(File.join(o[:"#{stype}_path"], *[prefix, f].compact)) mtime = "#{sprintf("%i%06i", mtime.to_i, mtime.usec)}#{ts}" end "#{url_prefix}/#{o[:"#{stype}_prefix"]}#{mtime}#{prefix}#{f}#{o[:"#{stype}_suffix"]}" end end if relative_paths paths.map! do |path| "#{relative_prefix}#{path}" end end paths end
Return an array of paths for the given asset type and optionally asset group. See the assets function documentation for details.
Source
# File lib/roda/plugins/assets.rb, line 775 def read_asset_file(file, type) o = self.class.assets_opts content = if file.end_with?(".#{type}") ::File.read(file) else render_asset_file(file, :template_opts=>o[:"#{type}_opts"], :dependencies=>o[:expanded_dependencies][file]) end o[:postprocessor] ? o[:postprocessor].call(file, type, content) : content end
Return the content of the file if it is already of the correct type. Otherwise, render the file using the render plugin. file
should be the relative path to the file from the current directory.
Source
# File lib/roda/plugins/assets.rb, line 753 def render_asset(file, type) o = self.class.assets_opts if o[:compiled] file = "#{o[:"compiled_#{type}_path"]}#{file}" if o[:gzip] && env['HTTP_ACCEPT_ENCODING'] =~ /\bgzip\b/ @_response[RodaResponseHeaders::CONTENT_ENCODING] = 'gzip' file += '.gz' end check_asset_request(file, type, ::File.stat(file).mtime) ::File.read(file) else file = "#{o[:"#{type}_path"]}#{file}" check_asset_request(file, type, asset_last_modified(file)) read_asset_file(file, type) end end
Render
the asset with the given filename. When assets are compiled, or when the file is already of the given type (no rendering necessary), this returns the contents of the compiled file. When assets are not compiled and the file is not already in the same format, this will render the asset using the render plugin. In both cases, if the file has not been modified since the last request, this will return a 304 response.
Private Instance Methods
Source
# File lib/roda/plugins/assets.rb, line 789 def _compiled_assets_hash(type, return_ukey=false) compiled = self.class.assets_opts[:compiled] type, *dirs = type if type.is_a?(Array) stype = type.to_s if dirs && !dirs.empty? key = dirs.join('.') ckey = "#{stype}.#{key}" if hash = ukey = compiled[ckey] ukey = "#{key}.#{ukey}" end else hash = ukey = compiled[stype] end return_ukey ? ukey : hash end
Source
# File lib/roda/plugins/assets.rb, line 810 def asset_last_modified(file) if deps = self.class.assets_opts[:expanded_dependencies][file] ([file] + Array(deps)).map{|f| ::File.stat(f).mtime}.max else ::File.stat(file).mtime end end
Return when the file was last modified. If the file depends on any other files, check the modification times of all dependencies and return the maximum.
Source
# File lib/roda/plugins/assets.rb, line 821 def check_asset_request(file, type, mtime) @_request.last_modified(mtime) @_response.headers.merge!(self.class.assets_opts[:"#{type}_headers"]) end
If the asset hasn’t been modified since the last request, return a 304 response immediately. Otherwise, add the appropriate type-specific headers.
Source
# File lib/roda/plugins/assets.rb, line 828 def render_asset_file(file, options) render_template({:path => file}, options) end
Render
the given asset file using the render plugin, with the given options. file
should be the relative path to the file from the current directory.