iv-org-mirror/shard-kemal
1
0
Fork 0
mirror of https://gitea.invidious.io/iv-org/shard-kemal.git synced 2024-08-15 00:53:36 +00:00
Code Issues Projects Releases Packages Wiki Activity

Improve docs

Browse source
This commit is contained in:
Sdogruyol 2017-03-03 23:42:08 +03:00
parent 25af53b70d
commit 7a772a9301
3 changed files with 9 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
src/kemal/common_log_handler.cr
View file

@ -1,6 +1,5 @@
module Kemal module Kemal
# Kemal::CommonLogHandler uses STDOUT by default and handles the logging of request/response process time. # Kemal::CommonLogHandler uses STDOUT by default and handles the logging of request/response process time.
# It's also provides a `write` method for common logging purposes.
class CommonLogHandler < Kemal::BaseLogHandler class CommonLogHandler < Kemal::BaseLogHandler
@handler : IO @handler : IO

3
src/kemal/filter_handler.cr
View file

@ -1,6 +1,5 @@
module Kemal module Kemal
# Kemal::FilterHandler handle all code that should be evaluated before and after # :nodoc:
# every request
class FilterHandler class FilterHandler
include HTTP::Handler include HTTP::Handler
INSTANCE = new INSTANCE = new

16
src/kemal/helpers/macros.cr
View file

@ -2,15 +2,15 @@ require "kilt"
CONTENT_FOR_BLOCKS = Hash(String, Tuple(String, Proc(String))).new CONTENT_FOR_BLOCKS = Hash(String, Tuple(String, Proc(String))).new
# <tt>content_for</tt> is a set of helpers that allows you to capture # `content_for` is a set of helpers that allows you to capture
# blocks inside views to be rendered later during the request. The most # blocks inside views to be rendered later during the request. The most
# common use is to populate different parts of your layout from your view. # common use is to populate different parts of your layout from your view.
# #
# The currently supported engines are: ecr and slang. # The currently supported engines are: ecr and slang.
# #
# == Usage # ## Usage
# #
# You call +content_for+, generally from a view, to capture a block of markup # You call `content_for`, generally from a view, to capture a block of markup
# giving it an identifier: # giving it an identifier:
# #
# # index.ecr # # index.ecr
@ -18,18 +18,18 @@ CONTENT_FOR_BLOCKS = Hash(String, Tuple(String, Proc(String))).new
# <chunk of="html">...</chunk> # <chunk of="html">...</chunk>
# <% end %> # <% end %>
# #
# Then, you call +yield_content+ with that identifier, generally from a # Then, you call `yield_content` with that identifier, generally from a
# layout, to render the captured block: # layout, to render the captured block:
# #
# # layout.ecr # # layout.ecr
# <%= yield_content "some_key" %> # <%= yield_content "some_key" %>
# #
# == And How Is This Useful? # ## And How Is This Useful?
# #
# For example, some of your views might need a few javascript tags and # For example, some of your views might need a few javascript tags and
# stylesheets, but you don't want to force this files in all your pages. # stylesheets, but you don't want to force this files in all your pages.
# Then you can put <tt><%= yield_content :scripts_and_styles %></tt> on your # Then you can put `<%= yield_content :scripts_and_styles %>` on your
# layout, inside the <head> tag, and each view can call <tt>content_for</tt> # layout, inside the <head> tag, and each view can call `content_for`
# setting the appropriate set of tags that should be added to the layout. # setting the appropriate set of tags that should be added to the layout.
macro content_for(key, file = __FILE__) macro content_for(key, file = __FILE__)
%proc = ->() { %proc = ->() {
@ -42,7 +42,7 @@ macro content_for(key, file = __FILE__)
nil nil
end end
# Yields content for the given key if a content_for block exists for that key. # Yields content for the given key if a `content_for` block exists for that key.
macro yield_content(key) macro yield_content(key)
if CONTENT_FOR_BLOCKS.has_key?({{key}}) if CONTENT_FOR_BLOCKS.has_key?({{key}})
__caller_filename__ = CONTENT_FOR_BLOCKS[{{key}}][0] __caller_filename__ = CONTENT_FOR_BLOCKS[{{key}}][0]