swiftpm-stencil/CHANGELOG.md

Stencil Changelog

Master

Bug Fixes

None

Breaking Changes

None

New Features

None

Internal Changes

None

0.12.1

Internal Changes

• Updated the PathKit dependency to 0.9.0 in CocoaPods, to be in line with SPM.
  David Jennes #227

0.12.0

Enhancements

• Added an optional second parameter to the include tag for passing a sub context to the included file.
  Yonas Kolb #214
• Variables now support the subscript notation. For example, if you have a variable key = "name", and an object item = ["name": "John"], then {{ item[key] }} will evaluate to "John".
  David Jennes #215
• Adds support for using spaces in filter expression.
  Ilya Puchka #178
• Improvements in error reporting.
  Ilya Puchka #167

Bug Fixes

• Fixed using quote as a filter parameter.
  Ilya Puchka #210

0.11.0 (2018-04-04)

Enhancements

• Added support for resolving superclass properties for not-NSObject subclasses.
  Ilya Puchka #152
• The {% for %} tag can now iterate over tuples, structures and classes via their stored properties.
  Ilya Puchka #172
• Added split filter.
  Ilya Puchka #187
• Allow default string filters to be applied to arrays.
  Ilya Puchka #190
• Similar filters are suggested when unknown filter is used.
  Ilya Puchka #186
• Added indent filter.
  Ilya Puchka #188
• Allow using new lines inside tags.
  Ilya Puchka #202
• Added support for iterating arrays of tuples.
  Ilya Puchka #177
• Added support for ranges in if-in expression.
  Ilya Puchka #193
• Added property forloop.length to get number of items in the loop.
  Ilya Puchka #171
• Now you can construct ranges for loops using a...b syntax, i.e. for i in 1...array.count.
  Ilya Puchka #192

Bug Fixes

• Fixed rendering {{ block.super }} with several levels of inheritance.
  Ilya Puchka #154
• Fixed checking dictionary values for nil in default filter.
  Ilya Puchka #162
• Fixed comparing string variables with string literals, in Swift 4 string literals became Substring and thus couldn't be directly compared to strings.
  Ilya Puchka #168
• Integer literals now resolve into Int values, not Float.
  Ilya Puchka #181
• Fixed accessing properties of optional properties via reflection.
  Ilya Puchka #204
• No longer render optional values in arrays as Optional(..).
  Ilya Puchka #205
• Fixed subscription tuples by value index, i.e. {{ tuple.0 }}.
  Ilya Puchka #172

0.10.1

Enhancements

• Add support for Xcode 9.1.

0.10.0

Enhancements

• Adds counter0 to for loop context allowing you to get the current index of the for loop 0 indexed.
• Introduces a new DictionaryLoader for loading templates from a Swift Dictionary.
• Added in expression in if tag for strings and arrays of hashable types
• You can now access the amount of items in a dictionary using the count property.

Bug Fixes

• Fixes a potential crash when using the {% for %} template tag with the incorrect amount of arguments.
• Fixes a potential crash when using incomplete tokens in a template for example, {%%} or {{}}.
• Fixes evaluating nil properties as true

0.9.0

Enhancements

• for block now can contain where expression to filter array items. For example {% for item in items where item > 1 %} is now supported.

• if blocks may now contain else if (elif) conditions.

  {% if one or two and not three %}
    one or two but not three
  {% elif four %}
    four
  {% else %}
    not one, two, or four
  {% endif %}
  

• for block now allows you to iterate over array of tuples or dictionaries.

  {% for key,value in thing %}
    <li>{{ key }}: {{ value }}</li>
  {% endfor %}
  

Bug Fixes

• You can now use literal filter arguments which contain quotes. #98

0.8.0

Breaking

• It is no longer possible to create Context objects. Instead, you can pass a dictionary directly to a Templates render method.

  - try template.render(Context(dictionary: ["name": "Kyle"]))
  + try template.render(["name": "Kyle"])
  

• Template loader are no longer passed into a Context, instead you will need to pass the Loader to an Environment and create a template from the Environment.

  let loader = FileSystemLoader(paths: ["templates/"])
  
  - let template = loader.loadTemplate(name: "index.html")
  - try template.render(Context(dictionary: ["loader": loader]))
  + let environment = Environment(loader: loader)
  + try environment.renderTemplate(name: "index.html")
  

• Loaders will now throw a TemplateDoesNotExist error when a template is not found.

• Namespace has been removed and replaced by extensions. You can create an extension including any custom template tags and filters. A collection of extensions can be passed to an Environment.

Enhancements

• Environment is a new way to load templates. You can configure an environment with custom template filters, tags and loaders and then create a template from an environment.

  Environment also provides a convenience method to render a template directly.

• FileSystemLoader will now ensure that template paths are within the base path. Any template names that try to escape the base path will raise a SuspiciousFileOperation error.

• New {% filter %} tag allowing you to perform a filter across the contents of a block.

  {% filter lowercase %}
    This Text Will Be Lowercased.
  {% endfilter %}
  

• You can now use {{ block.super }} to render a super block from another {% block %}.

• Environment allows you to provide a custom Template subclass, allowing new template to use a specific subclass.

• If expressions may now contain filters on variables. For example {% if name|uppercase == "TEST" %} is now supported.

Deprecations

• Template initialisers have been deprecated in favour of using a template loader such as FileSystemLoader inside an Environment.

• The use of whitespace inside variable filter expression is now deprecated.

  - {{ name | uppercase }}
  + {{ name|uppercase }}
  

Bug Fixes

• Restores compatibility with ARM based platforms such as iOS. Stencil 0.7 introduced compilation errors due to using the Float80 type which is not available.

0.7.1

Bug Fixes

• Fixes an issue where using {% if %} statements which use operators would throw a syntax error.

0.7.0

Breaking

• TemplateLoader has been renamed to FileSystemLoader. The loadTemplate(s) methods are now throwing and now take labels for the name and names arguments.

• Many internal classes are no longer public. Some APIs were previously accessible due to earlier versions of Swift requiring the types to be public to be able to test. Now we have access to @testable these can correctly be private.

• {% ifnot %} tag is now deprecated, please use {% if not %} instead.

Enhancements

• Variable lookup now supports introspection of Swift types. You can now lookup values of Swift structures and classes inside a Context.

• If tags can now use prefix and infix operators such as not, and, or, ==, !=, >, >=, < and <=.

  {% if one or two and not three %}
  

• You may now register custom template filters which make use of arguments.

• There is now a default filter.

  Hello {{ name|default:"World" }}
  

• There is now a join filter.

  {{ value|join:", " }}
  

• {% for %} tag now supports filters.

  {% for user in non_admins|default:admins %}
    {{ user }}
  {% endfor %}
  

Bug Fixes

• Variables ({{ variable.5 }}) that reference an array index at an unknown index will now resolve to nil instead of causing a crash.
  #72

• Templates can now extend templates that extend other templates.
  #60

• If comparisons will now treat 0 and below numbers as negative.

0.6.0

Enhancements

• Adds support for Swift 3.0.