w_syntax_tree-erb 0.9.0

data/lib/syntax_tree/erb/pretty_print.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+module SyntaxTree
+  module ERB
+    class PrettyPrint < Visitor
+      attr_reader :q
+
+      def initialize(q)
+        @q = q
+      end
+
+      # Visit a Token node.
+      def visit_token(node)
+        q.pp(node.value)
+      end
+
+      # Visit a Document node.
+      def visit_document(node)
+        visit_node("document", node)
+      end
+
+      def visit_block(node)
+        visit_node(node.class.to_s, node)
+      end
+
+      # Visit an HtmlNode.
+      def visit_html(node)
+        visit_node("html", node)
+      end
+
+      # Visit an HtmlNode::OpeningTag node.
+      def visit_opening_tag(node)
+        visit_node("opening_tag", node)
+      end
+
+      # Visit an HtmlNode::ClosingTag node.
+      def visit_closing_tag(node)
+        visit_node("closing_tag", node)
+      end
+
+      # Visit an ErbNode node.
+      def visit_erb(node)
+        q.group do
+          q.text("(erb")
+          q.nest(2) do
+            q.breakable
+            visit(node.opening_tag)
+            if node.keyword
+              q.breakable
+              visit(node.keyword)
+            end
+            if node.content
+              q.breakable
+              q.text("content")
+            end
+
+            q.breakable
+            visit(node.closing_tag)
+          end
+          q.breakable("")
+          q.text(")")
+        end
+      end
+
+      def visit_erb_block(node)
+        q.group do
+          q.text("(erb_block")
+          q.nest(2) do
+            q.breakable
+            q.seplist(node.elements) { |child_node| visit(child_node) }
+          end
+          q.breakable
+          visit(node.closing)
+          q.breakable("")
+          q.text(")")
+        end
+      end
+
+      def visit_erb_if(node, key = "erb_if")
+        q.group do
+          q.text("(")
+          visit(node.opening)
+          q.nest(2) do
+            q.breakable()
+            q.seplist(node.child_nodes) { |child_node| visit(child_node) }
+          end
+          q.breakable
+          visit(node.closing)
+          q.breakable("")
+          q.text(")")
+        end
+      end
+
+      def visit_erb_elsif(node)
+        visit_erb_if(node, "erb_elsif")
+      end
+
+      def visit_erb_else(node)
+        visit_erb_if(node, "erb_else")
+      end
+
+      def visit_erb_case(node)
+        visit_erb_if(node, "erb_case")
+      end
+
+      def visit_erb_case_when(node)
+        visit_erb_if(node, "erb_when")
+      end
+
+      def visit_erb_end(node)
+        q.text("erb_end")
+      end
+
+      # Visit an ErbContent node.
+      def visit_erb_content(node)
+        q.text(node.value)
+      end
+
+      # Visit an Attribute node.
+      def visit_attribute(node)
+        visit_node("attribute", node)
+      end
+
+      # Visit a HtmlString node.
+      def visit_html_string(node)
+        visit_node("html_string", node)
+      end
+
+      # Visit a CharData node.
+      def visit_char_data(node)
+        visit_node("char_data", node)
+      end
+
+      def visit_erb_close(node)
+        visit_node("erb_close", node)
+      end
+
+      def visit_erb_do_close(node)
+        visit_node("erb_do_close", node)
+      end
+
+      # Visit a Doctype node.
+      def visit_doctype(node)
+        visit_node("doctype", node)
+      end
+
+      def visit_html_comment(node)
+        visit_node("html_comment", node)
+      end
+
+      private
+
+      # A generic visit node function for how we pretty print nodes.
+      def visit_node(type, node)
+        q.group do
+          q.text("(#{type}")
+          q.nest(2) do
+            q.breakable
+            q.seplist(node.child_nodes) { |child_node| visit(child_node) }
+          end
+          q.breakable("")
+          q.text(")")
+        end
+      end
+
+      def comments(node)
+        return if node.comments.empty?
+
+        q.breakable
+        q.group(2, "(", ")") do
+          q.seplist(node.comments) { |comment| q.pp(comment) }
+        end
+      end
+
+      def field(_name, value)
+        q.breakable
+        q.pp(value)
+      end
+
+      def list(_name, values)
+        q.breakable
+        q.group(2, "(", ")") { q.seplist(values) { |value| q.pp(value) } }
+      end
+
+      def node(_node, type)
+        q.group(2, "(", ")") do
+          q.text(type)
+          yield
+        end
+      end
+
+      def pairs(_name, values)
+        q.group(2, "(", ")") do
+          q.seplist(values) do |(key, value)|
+            q.pp(key)
+
+            if value
+              q.text("=")
+              q.group(2) do
+                q.breakable("")
+                q.pp(value)
+              end
+            end
+          end
+        end
+      end
+
+      def text(_name, value)
+        q.breakable
+        q.text(value)
+      end
+    end
+  end
+end

data/lib/syntax_tree/erb/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module SyntaxTree
+  module ERB
+    VERSION = "0.9.0"
+  end
+end

data/lib/syntax_tree/erb/visitor.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module SyntaxTree
+  module ERB
+    # Provides a visitor interface for visiting certain nodes. It's used
+    # internally to implement formatting and pretty-printing. It could also be
+    # used externally to visit a subset of nodes that are relevant to a certain
+    # task.
+    class Visitor < SyntaxTree::Visitor
+      def visit(node)
+        node&.accept(self)
+      end
+
+      alias visit_statements visit_child_nodes
+
+      private
+
+      def visit_all(nodes)
+        nodes.map { |node| visit(node) }
+      end
+
+      def visit_child_nodes(node)
+        visit_all(node.child_nodes)
+      end
+
+      # Visit a Token node.
+      alias visit_token visit_child_nodes
+
+      # Visit a Document node.
+      alias visit_document visit_child_nodes
+
+      # Visit an Html node.
+      alias visit_html visit_child_nodes
+
+      # Visit an HtmlNode::OpeningTag node.
+      alias visit_opening_tag visit_child_nodes
+
+      # Visit an HtmlNode::ClosingTag node.
+      alias visit_closing_tag visit_child_nodes
+
+      # Visit an Attribute node.
+      alias visit_attribute visit_child_nodes
+
+      # Visit a CharData node.
+      alias visit_char_data visit_child_nodes
+
+      # Visit an ErbNode node.
+      alias visit_erb visit_child_nodes
+
+      # Visit a HtmlString node.
+      alias visit_html_string visit_child_nodes
+    end
+  end
+end

data/lib/syntax_tree/erb.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "prettier_print"
+require "syntax_tree"
+
+require_relative "erb/nodes"
+require_relative "erb/parser"
+require_relative "erb/visitor"
+
+require_relative "erb/format"
+require_relative "erb/pretty_print"
+
+module SyntaxTree
+  module ERB
+    MAX_WIDTH = 80
+    def self.format(source, maxwidth = MAX_WIDTH, options: nil)
+      PrettierPrint.format(+"", maxwidth) { |q| parse(source).format(q) }
+    end
+
+    def self.parse(source)
+      Parser.new(source).parse
+    end
+
+    def self.read(filepath)
+      File.read(filepath)
+    end
+  end
+
+  register_handler(".erb", ERB)
+end

data/syntax_tree-erb.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/syntax_tree/erb/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "w_syntax_tree-erb"
+  spec.version = SyntaxTree::ERB::VERSION
+  spec.authors = ["Kevin Newton", "David Wessman"]
+  spec.email = %w[kddnewton@gmail.com david@wessman.co]
+
+  spec.summary = "Syntax Tree support for ERB"
+  spec.homepage = "https://github.com/davidwessman/syntax_tree-erb"
+  spec.license = "MIT"
+  spec.metadata = { "rubygems_mfa_required" => "true" }
+
+  spec.files =
+    Dir.chdir(__dir__) do
+      `git ls-files -z`.split("\x0")
+        .reject { |f| f.match(%r{^(test|spec|features)/}) }
+    end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib]
+
+  spec.add_dependency "prettier_print", ">= 1.2.0"
+  spec.add_dependency "syntax_tree", ">= 6.1.1"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: w_syntax_tree-erb
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Kevin Newton
+- David Wessman
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prettier_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: syntax_tree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- kddnewton@gmail.com
+- david@wessman.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/ISSUE_TEMPLATE/formatting-report.md"
+- ".github/ISSUE_TEMPLATE/general.md"
+- ".github/dependabot.yml"
+- ".github/workflows/auto-merge.yml"
+- ".github/workflows/main.yml"
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- check_erb_parse.rb
+- lib/syntax_tree/erb.rb
+- lib/syntax_tree/erb/format.rb
+- lib/syntax_tree/erb/nodes.rb
+- lib/syntax_tree/erb/parser.rb
+- lib/syntax_tree/erb/pretty_print.rb
+- lib/syntax_tree/erb/version.rb
+- lib/syntax_tree/erb/visitor.rb
+- syntax_tree-erb.gemspec
+homepage: https://github.com/davidwessman/syntax_tree-erb
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+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.4.1
+signing_key:
+specification_version: 4
+summary: Syntax Tree support for ERB
+test_files: []