1
0
mirror of https://github.com/meineerde/rackstash.git synced 2026-01-31 17:27:13 +00:00

Clarify documentation on how to define filters

This commit is contained in:
Holger Just 2017-12-28 22:07:41 +01:00
parent e5c83d9ac5
commit 795a8e4e2d
2 changed files with 10 additions and 10 deletions

View File

@ -43,8 +43,8 @@ module Rackstash
filter_class
end
# @return [ClassRegistry] the registry object which allows to register and
# retrieve available filter classes
# @return [ClassRegistry] the {ClassRegistry} object which allows to
# register and retrieve available filter classes
def registry
@registry ||= Rackstash::ClassRegistry.new('filter'.freeze)
end
@ -58,7 +58,7 @@ module Rackstash
# class from which we are creating a new filter object. When giving a
# `Class`, we are using it as is to create a new filter object with the
# supplied `args` and `block`. When giving a `String` or `Symbol`, we
# first use the filter registry to find the matching class. With that,
# first use the filter {.registry} to find the matching class. With that
# we then create a filter object as before. When giving an object which
# responds to `call` already (e.g. a `Proc`, we return it unchanged,
# ignoring any additional passed `args`.

View File

@ -294,13 +294,13 @@ module Rackstash
# Build a new filter instance from the given specification.
#
# @param filter_spec [Array] the description of a filter to create. If you
# give a single `Proc` or a block (or another object which responds to
# `#call`), we will directly return it. If you give a `Class` plus any
# optional initializer arguments, we will return a new instance of that
# class. When giving a `String` or `Symbol`, we will resolve it to a
# filter class from the {Rackstash::Filter} module and create a new
# instance of that class with the additional arguments given to
# `initialize`.
# give a single `Proc` (or any other object which responds to `#call`) or
# simply a proc, we will directly return it. If you give a `Class` plus
# any optional initializer arguments, we will return a new instance of
# that class. When giving a `String` or `Symbol`, we first use the
# {Filter.registry} to find the matching filter class. With that class,
# we then create a filter object as before using the additional arguments
# given to `initialize`.
# @return [#call] a filter instance
def build_filter(filter_spec, &block)
if filter_spec.empty?