liquidice 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a391144863c9ca02f6d171de7480c298f530bba3373b926d7ef73e1c083d0eaa
+  data.tar.gz: b9fa907d2a02fb8e8813aef8188bddf18822eca3d48d88c72770ede08d3f0789
+SHA512:
+  metadata.gz: 6990461ad59956cadd62c96de954d745b0ac29a6eb1d3ccb1608e08bf83880c514ca4110dcd93e3c2be14303bd02ee1b4da8823344f8b41f95917ca6ef112a43
+  data.tar.gz: deef2278f2598f919f093d2cd4222101c551782ea56d558fb83cdefed2ebd68cf3c5a0b27ebcc93ec82e7df9f499941f1b03178cf5d403b7bb544f6ef0aefc44

data/lib/liquidice/errors.rb

@@ -0,0 +1,5 @@
+module Liquidice
+  module Errors
+    class InvalidWysiwygTemplate < StandardError; end
+  end
+end

data/lib/liquidice/liquidice_grammar.treetop

@@ -0,0 +1,99 @@
+# Liquidice grammar
+
+grammar LiquidiceGrammar
+  rule liquid_template
+    (liquid_tag / liquid_text)*
+  end
+
+  rule liquid_tag
+    liquid_open_delimeter content_with_tags liquid_close_delimeter
+  end
+
+  rule liquid_open_delimeter
+    liquid_open_delimeter_start any_tag* (liquid_open_delimeter_start / "%")
+  end
+
+  rule liquid_close_delimeter
+    (liquid_close_delimeter_end / "%") any_tag* liquid_close_delimeter_end
+  end
+
+  rule liquid_open_delimeter_start
+    "{"
+  end
+
+  rule liquid_close_delimeter_end
+    "}"
+  end
+
+  rule content_with_tags
+    (any_tag / text_content)*
+  end
+
+  rule text_content
+    (alphabets / digits / dash / ws)*
+  end
+
+  rule any_tag
+    (tag_open / tag_empty / tag_close)
+  end
+
+  rule tag_open
+    "<" tag_name ws* attr_list? ws* ">"
+  end
+
+  rule tag_empty
+    "<" tag_name ws* attr_list? ws* "/>"
+  end
+
+  rule tag_close
+    "</" tag_name ws* ">"
+  end
+
+  rule attr_list
+    (ws+ attr)*
+  end
+
+  rule attr
+    attr_empty / attr_unquoted / attr_single_quoted / attr_double_quoted
+  end
+
+  rule attr_empty
+    attr_name
+  end
+
+  rule attr_unquoted
+    attr_name ws* "=" ws* attr_unquoted_value
+  end
+
+  rule attr_single_quoted
+    attr_name ws* "=" ws* "'" attr_single_quoted_value "'"
+  end
+
+  rule attr_double_quoted
+    attr_name ws* "=" ws* "\"" attr_double_quoted_value "\""
+  end
+
+  rule tag_name
+    (alphabets / digits / dash)+
+  end
+
+  rule attr_name
+
+  rule attr_unquoted_value
+
+  rule attr_single_quoted_value
+
+  rule attr_double_quoted_value
+
+  rule alphabets
+
+  rule digits
+
+  rule ws
+    /\s/
+  end
+
+  rule dash
+    "-"
+  end
+end

data/lib/liquidice/parser.rb

@@ -0,0 +1,33 @@
+require 'treetop'
+
+module Liquidice
+  class Parser
+    Treetop.load(File.expand_path(File.join(File.dirname(__FILE__), 'liquidice_grammar.treetop')))
+
+    attr_accessor :strict_mode, :parser, :ast
+
+    def initialize(strict_mode: false)
+      @strict_mode = strict_mode
+      @parser = LiquidiceGrammarParser.new
+    end
+
+    def parse_from_wysiwyg(wysiwyg_template)
+      @ast = parser.parse(wysiwyg_template)
+
+      raise Liquidice::Errors::InvalidWysiwygTemplate, parser.failure_reason if @ast.nil?
+
+      @ast
+    end
+
+    def transform_to_liquid(ast)
+      # Transform the AST to a valid Liquid template
+      transformer = Transformer.new
+      transformer.apply(ast)
+    end
+
+    def parse_and_transform(wysiwyg_template)
+      ast = parse_from_wysiwyg(wysiwyg_template)
+      transform_to_liquid(ast)
+    end
+  end
+end

data/lib/liquidice/transformer.rb

@@ -0,0 +1,160 @@
+module Liquidice
+  class Transformer < Treetop::Runtime::SyntaxNode
+    def apply(node)
+      case node
+      when LiquidiceGrammarParser::LiquidTemplate
+        transform_liquid_template(node)
+      when LiquidiceGrammarParser::LiquidTag
+        transform_liquid_tag(node)
+      when LiquidiceGrammarParser::LiquidOpenDelimeter
+        transform_liquid_open_delimeter(node)
+      when LiquidiceGrammarParser::LiquidCloseDelimeter
+        transform_liquid_close_delimeter(node)
+      when LiquidiceGrammarParser::ContentWithTags
+        transform_content_with_tags(node)
+      when LiquidiceGrammarParser::TextContent
+        transform_text_content(node)
+      when LiquidiceGrammarParser::AnyTag
+        transform_any_tag(node)
+      when LiquidiceGrammarParser::TagOpen
+        transform_tag_open(node)
+      when LiquidiceGrammarParser::TagEmpty
+        transform_tag_empty(node)
+      when LiquidiceGrammarParser::TagClose
+        transform_tag_close(node)
+      when LiquidiceGrammarParser::AttrList
+        transform_attr_list(node)
+      when LiquidiceGrammarParser::Attr
+        transform_attr(node)
+      when LiquidiceGrammarParser::AttrEmpty
+        transform_attr_empty(node)
+      when LiquidiceGrammarParser::AttrUnquoted
+        transform_attr_unquoted(node)
+      when LiquidiceGrammarParser::AttrSingleQuoted
+        transform_attr_single_quoted(node)
+      when LiquidiceGrammarParser::AttrDoubleQuoted
+        transform_attr_double_quoted(node)
+      when LiquidiceGrammarParser::TagName
+        transform_tag_name(node)
+      when LiquidiceGrammarParser::AttrName
+        transform_attr_name(node)
+      when LiquidiceGrammarParser::AttrUnquotedValue
+        transform_attr_unquoted_value(node)
+      when LiquidiceGrammarParser::AttrSingleQuotedValue
+        transform_attr_single_quoted_value(node)
+      when LiquidiceGrammarParser::AttrDoubleQuotedValue
+        transform_attr_double_quoted_value(node)
+      when LiquidiceGrammarParser::Alphabets
+        transform_alphabets(node)
+      when LiquidiceGrammarParser::Digits
+        transform_digits(node)
+      when LiquidiceGrammarParser::Ws
+        transform_ws(node)
+      when LiquidiceGrammarParser::Dash
+        transform_dash(node)
+      else
+        raise "Invalid AST node"
+      end
+    end
+
+    def transform_liquid_template(node)
+      node.elements.map { |element| apply(element) }.join
+    end
+
+    def transform_liquid_tag(node)
+      "{{ " + apply(node.content_with_tags) + " }}"
+    end
+
+    def transform_liquid_open_delimeter(node)
+      "{% "
+    end
+
+    def transform_liquid_close_delimeter(node)
+      " %}"
+    end
+
+    def transform_content_with_tags(node)
+      node.elements.map { |element| apply(element) }.join
+    end
+
+    def transform_text_content(node)
+      node.text_value
+    end
+
+    def transform_any_tag(node)
+      apply(node.tag_open) || apply(node.tag_empty) || apply(node.tag_close)
+    end
+
+    def transform_tag_open(node)
+      node.text_value
+    end
+
+    def transform_tag_empty(node)
+      node.text_value
+    end
+
+    def transform_tag_close(node)
+      node.text_value
+    end
+
+    def transform_attr_list(node)
+      node.elements.map { |element| apply(element) }.join
+    end
+
+    def transform_attr(node)
+      apply(node.attr_empty) || apply(node.attr_unquoted) || apply(node.attr_single_quoted) || apply(node.attr_double_quoted)
+    end
+
+    def transform_attr_empty(node)
+      node.text_value
+    end
+
+    def transform_attr_unquoted(node)
+      node.text_value
+    end
+
+    def transform_attr_single_quoted(node)
+      node.text_value
+    end
+
+    def transform_attr_double_quoted(node)
+      node.text_value
+    end
+
+    def transform_tag_name(node)
+      node.text_value
+    end
+
+    def transform_attr_name(node)
+      node.text_value
+    end
+
+    def transform_attr_unquoted_value(node)
+      node.text_value
+    end
+
+    def transform_attr_single_quoted_value(node)
+      node.text_value
+    end
+
+    def transform_attr_double_quoted_value(node)
+      node.text_value
+    end
+
+    def transform_alphabets(node)
+      node.text_value
+    end
+
+    def transform_digits(node)
+      node.text_value
+    end
+
+    def transform_ws(node)
+      node.text_value
+    end
+
+    def transform_dash(node)
+      node.text_value
+    end
+  end
+end

data/lib/liquidice/version.rb

@@ -0,0 +1,9 @@
+module Liquidice #:nodoc:
+  module Version #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/liquidice.rb

@@ -0,0 +1,3 @@
+require "liquidice/errors"
+require "liquidice/parser"
+require "liquidice/transformer"

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: liquidice
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aliaksandr Lomau
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A gem that enables the use of Liquid templates with WYSIWYG editor output
+  by transforming the output to a valid Liquid template
+email:
+- aliaksandr.lomau@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/liquidice.rb
+- lib/liquidice/errors.rb
+- lib/liquidice/liquidice_grammar.treetop
+- lib/liquidice/parser.rb
+- lib/liquidice/transformer.rb
+- lib/liquidice/version.rb
+homepage: https://github.com/allomov/liquidice
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: A gem that allows the use of Liquid templates with WYSIWYG editor output
+test_files: []