Merge pull request #155 from Shopify/fix/154-paginate

Fix paginate parsing error

Author: charlespwd

grammar/liquid-html.ohm

@@ -164,7 +164,7 @@ Liquid <: Helpers {
 
   liquidTagOpenPaginate = liquidTagOpenRule<"paginate", liquidTagOpenPaginateMarkup>
   liquidTagOpenPaginateMarkup =
-    liquidExpression space+ "by" space+ liquidExpression (argumentSeparatorOptionalComma tagArguments)? space*
+    liquidExpression space+ "by" space+ liquidExpression argumentSeparatorOptionalComma tagArguments space*
 
   liquidDrop = "{{" "-"? space* liquidDropCases "-"? "}}"
   liquidDropCases = liquidVariable | liquidDropBaseCase

src/parser/grammar.spec.ts

@@ -1,8 +1,8 @@
 import { expect } from 'chai';
-import { liquidHtmlGrammar } from '~/parser/grammar';
+import { liquidHtmlGrammar, liquidStatementsGrammar } from '~/parser/grammar';
 
 describe('Unit: liquidHtmlGrammar', () => {
-  it('should succeed at parsing valid HTML+Liquid', () => {
+  it('should parse or not parse HTML+Liquid', () => {
     expectMatchSucceeded('<h6 data-src="hello world">').to.be.true;
     expectMatchSucceeded('<a src="https://product"></a>').to.be.true;
     expectMatchSucceeded('<a src="https://google.com"></b>').to.be.true;
@@ -51,14 +51,32 @@ describe('Unit: liquidHtmlGrammar', () => {
     expectMatchSucceeded(`<div data-popup-{{ section.id }}="size-{{ section.id }}">`).to.be.true;
     expectMatchSucceeded('<img {% if aboveFold %} loading="lazy"{% endif %} />').to.be.true;
     expectMatchSucceeded('<svg><use></svg>').to.be.true;
-  });
-
-  it('should fail at parsing invalid HTML+Liquid', () => {
-    // Not valid HTML tag
     expectMatchSucceeded('<6h>').to.be.false;
+
+    function expectMatchSucceeded(text: string) {
+      const match = liquidHtmlGrammar.match(text, 'Node');
+      return expect(match.succeeded());
+    }
   });
 
-  function expectMatchSucceeded(text: string) {
-    return expect(liquidHtmlGrammar.match(text, 'Node').succeeded());
-  }
+  it('should parse or not parse {% liquid %} lines', () => {
+    expectMatchSucceeded(`
+      layout none
+
+      paginate search.results by 28
+        for item in search.results
+          if item.object_type != 'product'
+            continue
+          endif
+
+          render 'product-item', product: item
+        endfor
+      endpaginate
+    `).to.be.true;
+
+    function expectMatchSucceeded(text: string) {
+      const match = liquidStatementsGrammar.match(text.trimStart(), 'Node');
+      return expect(match.succeeded());
+    }
+  });
 });

src/parser/grammar.ts

@@ -5,6 +5,7 @@ export const liquidHtmlGrammars = ohm.grammars(
 );
 
 export const liquidHtmlGrammar = liquidHtmlGrammars['LiquidHTML'];
+export const liquidStatementsGrammar = liquidHtmlGrammars['LiquidStatement'];
 
 // see ../../grammar/liquid-html.ohm for full list
 export const BLOCKS = (

test/issue-154/fixed.liquid

@@ -0,0 +1,11 @@
+{%- liquid
+  layout none
+
+  paginate search.results by 28
+    render 'product-item', product: item
+  endpaginate
+
+  paginate search.results by 28, window_size: 1
+    render 'product-item', product: item
+  endpaginate
+-%}

test/issue-154/index.liquid

@@ -0,0 +1,11 @@
+{%- liquid
+layout none
+
+paginate search.results by 28
+  render 'product-item', product: item
+endpaginate
+
+paginate search.results by 28 window_size:1
+  render 'product-item', product: item
+endpaginate
+-%}

test/issue-154/index.spec.ts

@@ -0,0 +1,6 @@
+import { assertFormattedEqualsFixed } from '../test-helpers';
+import * as path from 'path';
+
+describe(`Unit: ${path.basename(__dirname)}`, () => {
+  assertFormattedEqualsFixed(__dirname);
+});