Added filter to apply dynamic filters #203

ilyapuchka · 2018-03-22T23:34:04Z

filter:arg will resolve its argument as filter expression which will allow to apply dynamic filters.

The use case for that can be using Sourcery to generated code for Codable protocols and use different key coding strategies applied for different data models. It will allow to specify strategy as one of Stencil filters in a type annotation, i.e. uppercaseFirstLetter or camelCaseToSnakeCase, or even filter with arguments.

Currently in template I have to check annotations against hardcoded set of filters to be able to apply them. With this change this template code

{% if strategy == "upperFirstLetter" %}{{ variable.name|replace:"_",""|upperFirstLetter }}{% else %}{{ variable.name|replace:"_",""|camelToSnakeCase }}{% endif %}

becomes this

{{ variable.name|replace:"_",""|filter:strategy }}

and allows to use any registered filter without changing anything in template.

AliSoftware · 2018-05-10T21:04:11Z

I'll have to re-check the Stencil docs (on phone rn so not the best device to read them) but I thought Stencil already had a {% filter xx %}…{% endfilter %} tag that would also allow you to do dynamic filters already?

AliSoftware · 2018-05-10T21:06:16Z

My bad, nvm, that tag indeed already exists but expects a filter name not a variable so isn't able to do dynamic filters. Forget I said anything

ilyapuchka · 2018-05-10T21:07:41Z

@AliSoftware the implementation of filter node only converts the whole node to filter expression applied to the rendered content of the node, it does not resolve the name of the filter as variable. But that's something we can add too! Also I just find filter expression easier to use than filter node and better composable (chaining vs nesting)

djbe · 2018-07-11T21:19:17Z

CHANGELOG.md

@@ -12,6 +12,8 @@
  [Ilya Puchka](https://github.com/yonaskolb)
  [#178](https://github.com/stencilproject/Stencil/pull/178)

+- Added support for dynamic filter using `filter` filter


~~If (when?) #221 gets merged~~ (merged), could you fix the format of this entry? Remove the newline above, add a . and 2 spaces at the end, and credit yourself + link to this PR.

djbe · 2018-07-11T21:25:44Z

Sources/Parser.swift

@@ -71,8 +71,24 @@ public class TokenParser {
    tokens.insert(token, at: 0)
  }

+  public func compileFilter(_ token: String) throws -> Resolvable {


Why do these methods (compileFilter, compileExpression and compileResolvable) have to be public?

Note: if they can be internal, don't forget to reset the Expression protocol back to internal.

So that they can be used by 3rd party extensions

Ehm, do they need to be used by 3rd party extensions? Do you have a scenario where that'd be necessary?

I cant think of any now but if I needed it in filter then it might be needed in something else complex too. Anyway, I don't see any harm in making these methods public.

Honestly, a library should only expose the minimal surface necessary for a developer to use it. If at any point, something is missing, it can be added later on.

Maybe someone else has some thoughts on this point? @AliSoftware?

I'd normally agree with limiting the surface of the public API, but given all other stuff like parse(until:), nextToken() and prependToken are already public too, I say it's fine by me.

TBH I haven't used Stencil as a library to be extended for a while now (only use case for us is StencilSwiftKit to extend Stencil), not sure there are many people using those features — main uses of this lib is probably just using it as-is to render templates, adding maybe some custom filters and that's all), that shouldn't really bother them.

BUT, if we're gonna have so much public API, then we should then definitely add doc-comments to them to explain to end users what they're supposed to be used for (especially to those not completely familiar with the concepts of a parser vs lexer etc, and proper definition of token etc).

Good idea on the docs then. It took me quite a while to understand the codebase a bit, and the documentation in the code is quite sparse.

Sources/Parser.swift

Sources/Extension.swift

djbe · 2018-07-11T23:09:04Z

Except from the small changelog change, and some small access questions, this LGTM.

djbe · 2018-07-11T23:40:41Z

Before I forget: This PR should document the changes in the docs.

ilyapuchka · 2018-08-04T19:10:00Z

@djbe comments addressed

djbe · 2018-09-11T22:04:12Z

docs/builtins.rst

+``filter``
+~~~~~~~~~
+
+Applies filter by its name, provided as an argument.


Applies the filter with the name (provided as argument) to the current expression.

djbe · 2018-09-11T22:04:54Z

docs/builtins.rst

+
+    {{ string|filter:myfilter }}
+
+This expression will resolve `myfilter` variable and will apply filter with such name to `string` variable.


This expression will resolve the myfilter variable, and it will apply the filter with that resolved name to the string variable.

djbe · 2018-09-11T22:12:39Z

This will need a rebase, based on 0.12. Be careful when rebasing the changelog, as the entry will need to be moved to the right section (under master).

# Conflicts: # CHANGELOG.md # Sources/ForTag.swift # Sources/IfTag.swift # Sources/Parser.swift # Sources/Variable.swift # Tests/StencilTests/ExpressionSpec.swift # Tests/StencilTests/FilterSpec.swift # Tests/StencilTests/ForNodeSpec.swift # Tests/StencilTests/VariableSpec.swift

ilyapuchka · 2018-10-01T21:18:59Z

@djbe I updated docs. We'll need this, in particular making Expression type public to add support for {% call this if condition else that %} in StencilSwiftKit, unless we move call node into Stencil.

djbe · 2018-10-01T21:44:43Z

Looks GTM. How come this branch is till out-of-date after that merge you did one hour ago?

ilyapuchka · 2018-10-01T21:45:27Z

🤷‍♂️

ilyapuchka mentioned this pull request Mar 22, 2018

Added map, compact and filter array filters #189

Open

ilyapuchka requested a review from kylef March 23, 2018 00:27

ilyapuchka requested review from AliSoftware and djbe May 10, 2018 21:01

ilyapuchka force-pushed the dynamic-filter branch from 8e1e7b6 to deba939 Compare May 10, 2018 23:12

added filter to apply dynamic filter

564ccb7

ilyapuchka force-pushed the dynamic-filter branch from deba939 to 564ccb7 Compare May 13, 2018 11:47

djbe reviewed Jul 11, 2018

View reviewed changes

djbe added this to the 0.12.0 milestone Jul 11, 2018

ilyapuchka added 2 commits August 4, 2018 19:49

updated CHANGELOG

f3d5843

Merge branch 'master' into dynamic-filter

2c411ca

ilyapuchka force-pushed the dynamic-filter branch from bd1872a to 2c411ca Compare August 4, 2018 19:06

updated docs

e795f05

djbe requested changes Sep 11, 2018

View reviewed changes

djbe modified the milestones: 0.12.0, 0.13.0, 0.14.0 Sep 21, 2018

ilyapuchka added 4 commits October 1, 2018 21:21

solve merge conflict issues

dbb5e14

added some doc comments

da6a0cc

updated docs

019d0cc

Merge branch 'master' into dynamic-filter

08fc21d

djbe approved these changes Oct 1, 2018

View reviewed changes

djbe merged commit 6f3ca60 into master Oct 1, 2018

djbe deleted the dynamic-filter branch October 1, 2018 22:50

djbe mentioned this pull request Jan 11, 2019

Map only works with strings SwiftGen/StencilSwiftKit#113

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added filter to apply dynamic filters #203

Added filter to apply dynamic filters #203

ilyapuchka commented Mar 22, 2018

AliSoftware commented May 10, 2018

AliSoftware commented May 10, 2018

ilyapuchka commented May 10, 2018 •

edited

Loading

djbe Jul 11, 2018 •

edited

Loading

djbe Jul 11, 2018

ilyapuchka Jul 17, 2018

djbe Jul 18, 2018

ilyapuchka Jul 18, 2018

djbe Sep 11, 2018

AliSoftware Sep 12, 2018

djbe Sep 12, 2018

djbe commented Jul 11, 2018

djbe commented Jul 11, 2018

ilyapuchka commented Aug 4, 2018

djbe Sep 11, 2018

djbe Sep 11, 2018

djbe commented Sep 11, 2018

ilyapuchka commented Oct 1, 2018

djbe commented Oct 1, 2018

ilyapuchka commented Oct 1, 2018


		{{ string\|filter:myfilter }}

		This expression will resolve `myfilter` variable and will apply filter with such name to `string` variable.

Added filter to apply dynamic filters #203

Added filter to apply dynamic filters #203

Conversation

ilyapuchka commented Mar 22, 2018

AliSoftware commented May 10, 2018

AliSoftware commented May 10, 2018

ilyapuchka commented May 10, 2018 • edited Loading

djbe Jul 11, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

djbe commented Jul 11, 2018

djbe commented Jul 11, 2018

ilyapuchka commented Aug 4, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

djbe commented Sep 11, 2018

ilyapuchka commented Oct 1, 2018

djbe commented Oct 1, 2018

ilyapuchka commented Oct 1, 2018

ilyapuchka commented May 10, 2018 •

edited

Loading

djbe Jul 11, 2018 •

edited

Loading