w_syntax_tree-erb 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b1234ed5afef9a96ebefb415733354ac530ffa9bb35b718195d36be9f9fed7c
+  data.tar.gz: 03c589bb628753e874f05aa6ea504f0d3d14e2057a7843d919abfd31f9fc66e9
+SHA512:
+  metadata.gz: cb5dd5cad343aabf4eaa8bd8cb177eeabb673cf68b8a016f36c13ee5ff2fbbb277a313800849cee940013355e430edca26d5d8541d566588f7902c41816d20a9
+  data.tar.gz: 3a147354e9fbef1bf89b604033c57f3746f1e17e69d050e7b4b41ffc409005000f4a7e5a12085e2704da71c4de4e16691795f6fe4600ba04de1106f5179c15b6

data/.github/ISSUE_TEMPLATE/formatting-report.md

@@ -0,0 +1,37 @@
+---
+name: Formatting report
+about: Create a report to help us improve
+title: "[Formatting] "
+labels: bug
+assignees: davidwessman
+
+---
+
+<details>
+  <summary>ERB-snippet</summary
+
+  ```html
+  <% code %>
+  ```
+</details>
+
+<details>
+  <summary>Expected formatting</summary
+
+  ```html
+  <% code %>
+  ```
+</details>
+<details>
+  <summary>Actual formatting</summary
+
+  ```html
+  <% code %>
+  ```
+</details>
+
+## Comment
+
+## Versions
+syntax_tree: 
+syntax_tree-erb:

data/.github/ISSUE_TEMPLATE/general.md

@@ -0,0 +1,10 @@
+---
+name: General
+about: General issues
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/auto-merge.yml

@@ -0,0 +1,22 @@
+name: Dependabot auto-merge
+on: pull_request
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - name: Dependabot metadata
+        id: metadata
+        uses: dependabot/fetch-metadata@v1.3.3
+        with:
+          github-token: "${{ secrets.GITHUB_TOKEN }}"
+      - name: Enable auto-merge for Dependabot PRs
+        run: gh pr merge --auto --merge "$PR_URL"
+        env:
+          PR_URL: ${{github.event.pull_request.html_url}}
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

data/.github/workflows/main.yml

@@ -0,0 +1,32 @@
+name: Main
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  ci:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "3.0"
+          - "3.1"
+          - "3.2"
+    name: CI
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+      - uses: actions/checkout@master
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby }}
+      - name: Test
+        run: |
+          bundle exec rake test
+          bundle exec rake stree:check

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+test.erb

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.0.1] - 2023-05-25
+
+### Added
+
+- 🎉 First version based on syntax_tree-xml 🎉
+
+[unreleased]: https://github.com/davidwessman/syntax_tree-erb/compare/v0.1.0...HEAD
+[0.0.1]: https://github.com/davidwessman/syntax_tree-erb/compare/b280a...v0.1.0

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    syntax_tree-erb (0.0.1)
+      prettier_print (>= 1.2.0)
+      syntax_tree (>= 6.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    docile (1.4.0)
+    minitest (5.18.0)
+    prettier_print (1.2.1)
+    rake (13.0.6)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    syntax_tree (6.1.1)
+      prettier_print (>= 1.2.0)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-darwin-21
+  x86_64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  minitest
+  rake
+  simplecov
+  syntax_tree-erb!
+
+BUNDLED WITH
+   2.4.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022-present Kevin Newton
+
+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,84 @@
+# SyntaxTree::ERB
+
+[![Build Status](https://github.com/davidwessman/syntax_tree-erb/actions/workflows/main.yml/badge.svg)](https://github.com/davidwessman/syntax_tree-erb/actions/workflows/main.yml)
+
+[Syntax Tree](https://github.com/ruby-syntax-tree/syntax_tree) support for ERB.
+
+Currently handles
+
+- ERB
+  - Tags with and without output
+  - Tags inside strings
+  - `if`, `elsif`, `else` and `unless` statements
+  - blocks
+  - comments
+  - Formatting of the ruby-code is done by `syntax_tree`
+- HTML
+  - Tags with attributes
+  - Tags with and without closing tags
+  - Comments
+- Vue
+  - Attributes, events and slots using `:`, `@` and `#` respectively
+- Text output
+
+## Unhandled cases
+
+- Please add to this pinned issue (https://github.com/davidwessman/syntax_tree-erb/issues/28) or create a separate issue if you encounter formatting or parsing errors.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "w_syntax_tree-erb", "~> 0.9", require: false
+```
+
+## Usage
+
+```sh
+bundle exec stree --plugins=erb "./**/*.html.erb"
+```
+
+From code:
+
+```ruby
+require "syntax_tree/erb"
+
+pp SyntaxTree::ERB.parse(source) # print out the AST
+puts SyntaxTree::ERB.format(source) # format the AST
+```
+
+## List all parsing errors
+
+In order to get a list of all parsing errors (which needs to be fixed before the formatting works), this script can be used:
+
+```ruby
+#!/bin/ruby
+
+require "syntax_tree/erb"
+
+failures = []
+
+Dir
+  .glob("./app/**/*.html.erb")
+  .each do |file|
+    puts("Processing #{file}")
+    begin
+      source = SyntaxTree::ERB.read(file)
+      SyntaxTree::ERB.parse(source)
+      SyntaxTree::ERB.format(source)
+    rescue => exception
+      failures << { file: file, message: exception.message }
+    end
+  end
+
+puts failures
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/davidwessman/syntax_tree-erb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "syntax_tree/rake_tasks"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+SyntaxTree::Rake::CheckTask.new
+SyntaxTree::Rake::WriteTask.new
+
+task default: :test

data/check_erb_parse.rb

@@ -0,0 +1,20 @@
+#!/bin/ruby
+
+require "syntax_tree/erb"
+
+failures = []
+
+Dir
+  .glob("./app/**/*.html.erb")
+  .each do |file|
+    puts("Processing #{file}")
+    begin
+      source = SyntaxTree::ERB.read(file)
+      SyntaxTree::ERB.parse(source)
+      SyntaxTree::ERB.format(source)
+    rescue => exception
+      failures << { file: file, message: exception.message }
+    end
+  end
+
+puts failures

data/lib/syntax_tree/erb/format.rb

@@ -0,0 +1,230 @@
+# frozen_string_literal: true
+
+module SyntaxTree
+  module ERB
+    class Format < Visitor
+      attr_reader :q
+
+      def initialize(q)
+        @q = q
+      end
+
+      # Visit a Token node.
+      def visit_token(node)
+        q.text(node.value.strip)
+      end
+
+      # Visit a Document node.
+      def visit_document(node)
+        child_nodes = node.child_nodes.sort_by(&:location)
+
+        q.seplist(child_nodes, -> { q.breakable(force: true) }) do |child_node|
+          visit(child_node)
+        end
+
+        q.breakable(force: true)
+      end
+
+      def visit_block(node)
+        visit(node.opening)
+
+        if node.elements.any?
+          q.indent do
+            q.breakable("")
+            q.seplist(
+              node.elements,
+              -> { q.breakable(force: true) }
+            ) { |child_node| visit(child_node) }
+          end
+        end
+
+        if node.closing
+          q.breakable("")
+          visit(node.closing)
+        end
+      end
+
+      def visit_html(node)
+        visit_block(node)
+      end
+
+      def visit_erb_block(node)
+        visit_block(node)
+      end
+
+      def visit_erb_if(node)
+        visit_block(node)
+      end
+
+      def visit_erb_elsif(node)
+        visit_block(node)
+      end
+
+      def visit_erb_else(node)
+        visit_block(node)
+      end
+
+      def visit_erb_case(node)
+        visit_block(node)
+      end
+
+      def visit_erb_case_when(node)
+        visit_block(node)
+      end
+
+      # Visit an ErbNode node.
+      def visit_erb(node)
+        visit(node.opening_tag)
+
+        if node.keyword
+          q.text(" ")
+          visit(node.keyword)
+        end
+
+        visit(node.content)
+
+        visit(node.closing_tag)
+      end
+
+      def visit_erb_do_close(node)
+        visit(node.closing)
+      end
+
+      def visit_erb_close(node)
+        visit(node.closing)
+      end
+
+      # Visit an ErbEnd node.
+      def visit_erb_end(node)
+        visit(node.opening_tag)
+        q.text(" ")
+        visit(node.keyword)
+        q.text(" ")
+        visit(node.closing_tag)
+      end
+
+      def visit_erb_content(node)
+        rows =
+          if node.value.is_a?(String)
+            node.value.split("\n")
+          else
+            formatter =
+              SyntaxTree::Formatter.new("", [], erb_print_width(node.value))
+            formatter.format(node.value.statements)
+            formatter.flush
+            formatter.output.join.split("\n")
+          end
+
+        if rows.size > 1
+          q.group do
+            q.text(" ")
+            q.seplist(rows, -> { q.breakable(" ") }) { |row| q.text(row) }
+            q.text(" ")
+          end
+        elsif rows.size == 1
+          q.text(" ")
+          q.text(rows.first)
+          q.text(" ")
+        else
+          q.text(" ")
+        end
+      end
+
+      # Visit an HtmlNode::OpeningTag node.
+      def visit_opening_tag(node)
+        q.group do
+          visit(node.opening)
+          visit(node.name)
+
+          if node.attributes.any?
+            q.indent do
+              q.breakable
+              q.seplist(node.attributes, -> { q.breakable }) do |child_node|
+                visit(child_node)
+              end
+            end
+          end
+
+          q.breakable(node.closing.value == "/>" ? " " : "")
+          visit(node.closing)
+        end
+      end
+
+      # Visit an HtmlNode::ClosingTag node.
+      def visit_closing_tag(node)
+        q.group do
+          visit(node.opening)
+          visit(node.name)
+          visit(node.closing)
+        end
+      end
+
+      # Visit an Attribute node.
+      def visit_attribute(node)
+        q.group do
+          visit(node.key)
+          visit(node.equals)
+          visit(node.value)
+        end
+      end
+
+      # Visit a HtmlString node.
+      def visit_html_string(node)
+        q.group do
+          q.text("\"")
+          q.seplist(node.contents, -> { "" }) { |child_node| visit(child_node) }
+          q.text("\"")
+        end
+      end
+
+      def visit_html_comment(node)
+        visit(node.token)
+      end
+
+      # Visit a CharData node.
+      def visit_char_data(node)
+        lines = node.value.value.strip.split("\n")
+
+        if lines.size > 0
+          q.seplist(lines, -> { q.breakable(indent: false) }) do |line|
+            q.text(line)
+          end
+        end
+      end
+
+      # Visit a Doctype node.
+      def visit_doctype(node)
+        q.group do
+          visit(node.opening)
+          q.text(" ")
+          visit(node.name)
+
+          visit(node.closing)
+        end
+      end
+
+      def erb_print_width(syntax_tree)
+        statements = syntax_tree.statements.body
+        # Set the width to maximum if we have an IfNode or IfOp,
+        # we cannot format them purely with SyntaxTree because the ERB-syntax will be unparseable.
+        if statements.any? { |node| check_for_if_statement(node) }
+          999_999
+        else
+          SyntaxTree::ERB::MAX_WIDTH
+        end
+      end
+
+      def check_for_if_statement(node)
+        return false if node.nil?
+
+        if node.is_a?(SyntaxTree::IfNode) || node.is_a?(SyntaxTree::IfOp)
+          return true
+        end
+
+        node.child_nodes.any? do |child_node|
+          check_for_if_statement(child_node)
+        end
+      end
+    end
+  end
+end