liquid2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 179efed7b2ddc977ca19af55dbf412e8c8f4dda6b81c12d674bd1126b34c4cfa
+  data.tar.gz: 6645357f4c601ca0de255d5d6f6ab639f3bfa07709387f5e7b983f76a30a4903
+SHA512:
+  metadata.gz: 9bb548ec7455d05fd83e8a13bf46bb3e2ccd28cdef322a0d866c0f78a111684f21c8e7b246047254f4167790501b18ff7412681a35b01a914a130f139cb819ae
+  data.tar.gz: '0827b948829f77dd64feee3f1dea14291d6a011dabf56dd57b448c373254a93f4017a628eed857e78fe68f3510029561b3fc7f4ef1716a87ccaf5a8a6114d312'

data/.rubocop.yml

@@ -0,0 +1,46 @@
+plugins:
+  - rubocop-minitest
+  - rubocop-rake
+  - rubocop-performance
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  Exclude:
+    - "test/golden_liquid/*"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 100
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Max: 100
+
+Metrics/CyclomaticComplexity:
+  Max: 50
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  AllowUnusedKeywordArguments: true

data/.ruby-version

@@ -0,0 +1 @@
+3.4.3

data/.vscode/settings.json

@@ -0,0 +1,32 @@
+{
+  "rubocop.mode": "enableUnconditionally",
+  "cSpell.words": [
+    "bigdecimal",
+    "bytesize",
+    "byteslice",
+    "charpos",
+    "Cyclomatic",
+    "endcapture",
+    "endcase",
+    "endcomment",
+    "endraw",
+    "forloop",
+    "ivar",
+    "keyreq",
+    "kwargs",
+    "ljust",
+    "lparen",
+    "lstrip",
+    "ndigits",
+    "nodoc",
+    "parentloop",
+    "rparen",
+    "rpartition",
+    "rstrip",
+    "tablerow",
+    "truncatewords"
+  ],
+  "cSpell.enabledFileTypes": {
+    "ruby": true
+  }
+}

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-03-18
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 James Prior
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/LICENSE_SHOPIFY.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2005, 2006 Tobias Luetke
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,219 @@
+<h1 align="center">Ruby Liquid2</h1>
+
+<p align="center">
+Liquid templates for Ruby, with some extra features.
+</p>
+
+---
+
+**Table of Contents**
+
+- [Install](#install)
+- [Example](#example)
+- [Links](#links)
+- [About](#about)
+- [Usage](#usage)
+
+## Install
+
+TODO
+
+## Example
+
+```ruby
+require "liquid2"
+
+template = Liquid2.parse("Hello, {{ you }}!")
+puts template.render("you" => "World")  # Hello, World!
+puts template.render("you" => "Liquid")  # Hello, Liquid!
+```
+
+## Links
+
+- Change log: https://github.com/jg-rp/ruby-liquid2/blob/main/CHANGELOG.md
+- RubyGems: TODO
+- Source code: https://github.com/jg-rp/ruby-liquid2
+- Issue tracker: https://github.com/jg-rp/ruby-liquid2/issues
+
+## About
+
+This project aims to be mostly compatible with [Shopify/liquid](https://github.com/Shopify/liquid), but with fewer quirks and some new features.
+
+For those already familiar with Liquid, here's a quick description of the features added in Liquid2. Also see [test/test_compliance.rb](https://github.com/jg-rp/ruby-liquid2/blob/main/test/test_compliance.rb) for a list of [golden tests](https://github.com/jg-rp/golden-liquid) that we skip.
+
+### Additional features
+
+#### "Proper" string literal parsing
+
+String literals can contain markup delimiters (`{{`, `}}`, `{%`, `%}`, `{#` and `#}`) and c-like escape sequences without interfering with template parsing. Escape sequences follow JSON string syntax and semantics, with the addition of single quoted strings and the `\'` escape sequence.
+
+```liquid
+{% assign x = "Hi \uD83D\uDE00!" %}
+{{ x }}
+```
+
+**Output:**
+
+```
+Hi 😀!
+```
+
+#### String interpolation
+
+String literals support interpolation using JavaScript-style `${` and `}`. Any single or double quoted string can use `${variable_name}` placeholders for automatic variable substitution, and `${` can be escaped with `\${` to prevent variable substitution.
+
+Liquid template strings are effectively a shorthand alternative to `capture` tags or chains of `append` filters, which is especially useful when building short strings in `{% liquid %}` tags. These two tags are equivalent.
+
+```liquid2
+{% capture greeting %}
+Hello, {{ you | capitalize }}!
+{% endcapture %}
+
+{% assign greeting = 'Hello, ${you | capitalize}!' %}
+```
+
+#### Array literals
+
+Filtered expressions (those found in output statements, the `assign` tag and the `echo` tag) and `for` tag expressions support array literal syntax. We don't use the traditional `[item1, item2, ...]` syntax with square brackets because square brackets are already used for variables (`["some variable with spaces"]` is a valid variable).
+
+```liquid2
+{% assign my_array = a, b, '42', false -%}
+{% for item in my_array -%}
+    - {{ item }}
+{% endfor %}
+```
+
+or, using a `{% liquid %}` tag:
+
+```liquid2
+{% liquid
+    for item in a, b, '42', false
+        echo "- ${item}\n"
+    endfor %}
+```
+
+With `a` set to `"Hello"` and `b` set to `"World"`, both of the examples above produce the following output.
+
+```plain title="output"
+- Hello
+- World
+- 42
+- false
+```
+
+#### Logical `not`
+
+Logical expressions now support negation with the `not` operator and grouping terms with parentheses. Without parentheses, logical `and` takes priority over logical `or`.
+
+In this example, `{% if not user %}` is equivalent to `{% unless user %}`, however, `not` can also be used after `and` and `or`, like `{% if user.active and not user.title %}`, potentially saving nested `if` and `unless` tags.
+
+```liquid2
+{% if not user %}
+  please log in
+{% else %}
+  hello user
+{% endif %}
+```
+
+#### Inline conditional and relational expressions
+
+In most expressions where you'd normally provide a literal (string, integer, float, true, false, nil/null) or variable name/path (foo.bar[0]), you can now use an inline conditional or relational expression.
+
+See [Shopify/liquid #1922](https://github.com/Shopify/liquid/pull/1922) and [jg-rp/liquid #175](https://github.com/jg-rp/liquid/pull/175).
+
+These two templates are equivalent.
+
+```liquid
+{{ user.name || "guest" }}
+```
+
+```liquid
+{% if user.name %}{{ user.name }}{% else %}guest{% endif %}
+```
+
+#### Ternary expressions
+
+Output statements, the `{% assign %}` tag and the `{% echo %}` tag support ternary expressions.
+
+```liquid2
+{{ a if b else c }}
+{{ a | upcase if b == 'foo' else c || split }}
+```
+
+Either branch can use filters with the usual single pipe character (`|`), like `upcase` in the examples above. Filters following a double pipe (`||`) are _tail filters_, which apply to both branches.
+
+#### Lambda expressions
+
+Many built-in filters that operate on arrays now accept lambda expression arguments. For example, we can use the `where` filter to select values according to an arbitrary Boolean expression.
+
+```liquid2
+{% assign coding_pages = pages | where: page => page.tags contains 'coding' %}
+```
+
+#### Dedicated comment syntax
+
+Comments surrounded by `{#` and `#}` are enabled by default. Additional `#`'s can be added to comment out blocks of markup that already contain comments, as long as hashes are balanced.
+
+```liquid2
+{## comment this out for now
+{% for x in y %}
+    {# x could be empty #}
+    {{ x | default: TODO}}
+{% endfor %}
+##}
+```
+
+#### More whitespace control
+
+Tags and the output statement support `-` and `~` for controlling whitespace in templates. By default, `~` will remove newlines but retain space and tab characters.
+
+Here we use `~` to remove the newline after the opening `for` tag, but preserve indentation before `<li>`.
+
+```liquid2
+<ul>
+{% for x in (1..4) ~%}
+  <li>{{ x }}</li>
+{% endfor -%}
+</ul>
+```
+
+```plain title="output"
+<ul>
+  <li>1</li>
+  <li>2</li>
+  <li>3</li>
+  <li>4</li>
+</ul>
+```
+
+#### Scientific notation
+
+Integer and float literals can use scientific notation, like `1.2e3` or `1e-2`.
+
+## Usage
+
+TODO
+
+## Development
+
+TODO
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+### Profiling
+
+#### CPU profile
+
+Dump profile data with `bundle exec ruby performance/profile.rb`, then generate an HTML flame graph with, changing the file names appropriately:
+
+```
+bundle exec stackprof --d3-flamegraph .stackprof-cpu-parse.dump > flamegraph-cpu-parse.html
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+This project is not affiliated with Shopify, but we do reference [Shopify/liquid](https://github.com/Shopify/liquid) frequently and have used code from Shopify/liquid. See `LICENSE_SHOPIFY.txt` for a copy of the Shopify/liquid license.

data/Rakefile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new do |task|
+  task.plugins << "rubocop-minitest"
+  task.plugins << "rubocop-rake"
+  task.plugins << "rubocop-performance"
+end
+
+require "steep/rake_task"
+
+Steep::RakeTask.new do |t|
+  t.check.severity_level = :error
+  t.watch.verbose
+end
+
+task default: %i[test rubocop steep]

data/Steepfile

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+D = Steep::Diagnostic
+
+target :lib do
+  signature "sig"
+  check "lib"
+
+  library "base64"
+  library "bigdecimal"
+  library "cgi"
+  library "json"
+  library "strscan"
+  library "stringio"
+  library "time"
+  library "pathname"
+  library "monitor"
+
+  # configure_code_diagnostics(D::Ruby.default)      # `default` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+  # configure_code_diagnostics(D::Ruby.silent)       # `silent` diagnostics setting
+  # configure_code_diagnostics do |hash|             # You can setup everything yourself
+  #   hash[D::Ruby::NoMethod] = :information
+  # end
+end