syntax_tree-xml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 77ac1585f5010fa007a87ee7565667e8e68e5a3842aea6baadcf3af668fb5e8a
+  data.tar.gz: c37f1aedf0172034ed2074c63918b04a86321f035ca8b87a34fd7a9f37e3f34e
+SHA512:
+  metadata.gz: '0167288cb4ed1856e5230478f5a45b5a2e80d93be75d3d88cc087402c8c0a30d4d751218e04d84ef416724ca0ac6f9fe063da66e83f56467e9a976f9a7d54959'
+  data.tar.gz: 9efacf8b18a2962a03a36bb5e72f0871d791b15e58d2f627229dced070a5d42f8d717272d395e2794d78ca72c8caa508f356e03e113a2ee86c109c3212f03df0

data/.github/dependabot.yml

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

data/.github/workflows/main.yml

@@ -0,0 +1,34 @@
+name: Main
+on:
+- push
+- pull_request_target
+jobs:
+  ci:
+    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: '3.1'
+    - name: Test
+      run: |
+        bundle exec rake test
+        bundle exec rake stree:check
+  automerge:
+    name: AutoMerge
+    needs: ci
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request_target' && github.actor == 'dependabot[bot]'
+    steps:
+    - uses: actions/github-script@v3
+      with:
+        script: |
+          github.pulls.merge({
+            owner: context.payload.repository.owner.login,
+            repo: context.payload.repository.name,
+            pull_number: context.payload.pull_request.number
+          })

data/.gitignore

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

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.1.0] - 2022-05-25
+
+### Added
+
+- 🎉 Initial release! 🎉
+
+[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree-xml/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/ruby-syntax-tree/syntax_tree-xml/compare/c34baa...v0.1.0

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    syntax_tree-xml (0.1.0)
+      prettier_print
+      syntax_tree (>= 2.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    docile (1.4.0)
+    minitest (5.15.0)
+    prettier_print (0.1.0)
+    rake (13.0.6)
+    simplecov (0.21.2)
+      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 (2.7.1)
+      prettier_print
+
+PLATFORMS
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  minitest
+  rake
+  simplecov
+  syntax_tree-xml!
+
+BUNDLED WITH
+   2.3.6

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,76 @@
+# SyntaxTree::XML
+
+[![Build Status](https://github.com/ruby-syntax-tree/syntax_tree-xml/actions/workflows/main.yml/badge.svg)](https://github.com/ruby-syntax-tree/syntax_tree-xml/actions/workflows/main.yml)
+[![Gem Version](https://img.shields.io/gem/v/syntax_tree-xml.svg)](https://rubygems.org/gems/syntax_tree-xml)
+
+[Syntax Tree](https://github.com/ruby-syntax-tree/syntax_tree) support for XML.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "syntax_tree-xml"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install syntax_tree-xml
+
+## Usage
+
+From code:
+
+```ruby
+require "syntax_tree/xml"
+
+pp SyntaxTree::XML.parse(source) # print out the AST
+puts SyntaxTree::XML.format(source) # format the AST
+```
+
+From the CLI:
+
+```sh
+$ stree ast --plugins=xml file.xml
+(document
+  (misc "\n"),
+  (element
+    (opening_tag "<", "message", ">"),
+    (char_data "\n" + "  "),
+    (element (opening_tag "<", "hello", ">"), (char_data "Hello"), (closing_tag "</", "hello", ">")),
+    (char_data "\n" + "  "),
+    (element (opening_tag "<", "world", ">"), (char_data "World"), (closing_tag "</", "world", ">")),
+    (char_data "\n"),
+    (closing_tag "</", "message", ">")
+  )
+)
+```
+
+or
+
+```sh
+$ stree format --plugins=xml file.xml
+<message>
+  <hello>Hello</hello>
+  <world>World</world>
+</message>
+```
+
+or
+
+```sh
+$ stree write --plugins=xml file.xml
+file.xml 1ms
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby-syntax-tree/syntax_tree-xml.
+
+## 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/lib/syntax_tree/xml/format.rb

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+
+module SyntaxTree
+  module XML
+    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
+            .select do |child_node|
+              case child_node
+              in Misc[value: Token[type: :whitespace]]
+                false
+              else
+                true
+              end
+            end
+            .sort_by(&:location)
+
+        q.seplist(child_nodes, -> { q.breakable(force: true) }) do |child_node|
+          visit(child_node)
+        end
+
+        q.breakable(force: true)
+      end
+
+      # Visit a Prolog node.
+      def visit_prolog(node)
+        q.group do
+          visit(node.opening)
+
+          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("")
+          visit(node.closing)
+        end
+      end
+
+      # Visit a Doctype node.
+      def visit_doctype(node)
+        q.group do
+          visit(node.opening)
+          q.text(" ")
+          visit(node.name)
+
+          if node.external_id
+            q.text(" ")
+            visit(node.external_id)
+          end
+
+          visit(node.closing)
+        end
+      end
+
+      # Visit an ExternalID node.
+      def visit_external_id(node)
+        q.group do
+          q.group do
+            visit(node.type)
+
+            if node.public_id
+              q.indent do
+                q.breakable
+                visit(node.public_id)
+              end
+            end
+          end
+
+          q.indent do
+            q.breakable
+            visit(node.system_id)
+          end
+        end
+      end
+
+      # Visit an Element node.
+      def visit_element(node)
+        inner_nodes =
+          node.content&.select do |child_node|
+            case child_node
+            in CharData[value: Token[type: :whitespace]]
+              false
+            in CharData[value: Token[value:]] if value.strip.empty?
+              false
+            else
+              true
+            end
+          end
+
+        case inner_nodes
+        in nil
+          visit(node.opening_tag)
+        in []
+          visit(
+            Element::OpeningTag.new(
+              opening: node.opening_tag.opening,
+              name: node.opening_tag.name,
+              attributes: node.opening_tag.attributes,
+              closing:
+                Token.new(
+                  type: :close,
+                  value: "/>",
+                  location: node.opening_tag.closing.location
+                ),
+              location: node.opening_tag.location
+            )
+          )
+        in [CharData[value: Token[type: :text, value:]]]
+          q.group do
+            visit(node.opening_tag)
+            q.indent do
+              q.breakable("")
+              format_text(q, value)
+            end
+
+            q.breakable("")
+            visit(node.closing_tag)
+          end
+        else
+          q.group do
+            visit(node.opening_tag)
+            q.indent do
+              q.breakable("")
+
+              inner_nodes.each_with_index do |child_node, index|
+                if index != 0
+                  q.breakable(force: true)
+
+                  end_line = inner_nodes[index - 1].location.end_line
+                  start_line = child_node.location.start_line
+                  q.breakable(force: true) if (start_line - end_line) >= 2
+                end
+
+                case child_node
+                in CharData[value: Token[type: :text, value:]]
+                  format_text(q, value)
+                else
+                  visit(child_node)
+                end
+              end
+            end
+
+            q.breakable(force: true)
+            visit(node.closing_tag)
+          end
+        end
+      end
+
+      # Visit an Element::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 Element::ClosingTag node.
+      def visit_closing_tag(node)
+        q.group do
+          visit(node.opening)
+          visit(node.name)
+          visit(node.closing)
+        end
+      end
+
+      # Visit a Reference node.
+      def visit_reference(node)
+        visit(node.value)
+      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 CharData node.
+      def visit_char_data(node)
+        lines = node.value.value.strip.split("\n")
+
+        q.seplist(lines, -> { q.breakable(indent: false) }) do |line|
+          q.text(line)
+        end
+      end
+
+      # Visit a Misc node.
+      def visit_misc(node)
+        visit(node.value)
+      end
+
+      private
+
+      # Format a text by splitting nicely at newlines and spaces.
+      def format_text(q, value)
+        sep_line = -> { q.breakable(force: true, indent: false) }
+        sep_word = -> { q.group { q.breakable } }
+
+        q.seplist(value.strip.split("\n"), sep_line) do |line|
+          q.seplist(line.split(/\b(?: +)\b/), sep_word) { |word| q.text(word) }
+        end
+      end
+    end
+  end
+end