syntax_tree-haml 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b81fe1099e22a95015983cabc44340820430e2b1273d89b8042cd5c0799e9eec
-  data.tar.gz: 81dac915a833b4a8a4fd82e5f14dc1b98b6db5d94733701c57b18cc9d86cd983
+  metadata.gz: 0dfb86a00b3723b124c178e28e4a6af8a604aba895a495324ea151732449bde3
+  data.tar.gz: d597c33107dc7d04b1b52dbe645b2b8b0bf0830e0dc328f83971e95305dab32f
 SHA512:
-  metadata.gz: fd3c147a0e384a3b95196ed051420f8d873c960bc28af8df964b9fa0e5550adcf1072c1f76b4b39675ccdbdc8099fd7fb02ec1e5c6062a028ee4f0317afca19e
-  data.tar.gz: 764aa4c5a07616dd5a6a43f8dde3efa0b61490573ff414b5c271a2ee25b417def1b8586b7ce7bfaa4d51871bb8bd66356e826fc0131b9cabadf0b31e441a5183
+  metadata.gz: b6c225f3fcbd9af942f4a6cc00ca8a018a9ebec362b18e987f3b38895164da276ceec928fc02303fcb5055b4a4d787e0224d37cea9402de94f3310171e290c87
+  data.tar.gz: 40ae9ef5f96374fed98f1e00302bfda455e3b279f4f653c733cd806bdc52af37ee4f56bd6464b3a16442dd522a56afc23a8773d07692213d978bad16d68b87ac

data/.github/workflows/main.yml

@@ -22,7 +22,9 @@ jobs:
         bundler-cache: true
         ruby-version: ${{ matrix.ruby }}
     - name: Test
-      run: bundle exec rake test
+      run: |
+        bundle exec rake test
+        bundle exec rake stree:check
   automerge:
     name: AutoMerge
     needs: ci

data/CHANGELOG.md

@@ -6,6 +6,24 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [1.3.1] - 2022-08-01
+
+### Changed
+
+- Use Syntax Tree to handle properly quoting strings.
+
+## [1.3.0] - 2022-07-22
+
+### Added
+
+- Support changing the preferred quote through the single quotes plugin.
+
+## [1.2.1] - 2022-07-22
+
+### Changed
+
+- Fix formatting for when empty `%div` or `%div` with no attributes and just children is present.
+
 ## [1.2.0] - 2022-05-13
 
 ### Added
@@ -36,7 +54,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 - 🎉 Initial release! 🎉
 
-[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree-haml/compare/v1.2.0...HEAD
+[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree-haml/compare/v1.3.1...HEAD
+[1.3.1]: https://github.com/ruby-syntax-tree/syntax_tree-haml/compare/v1.3.0...v1.3.1
+[1.3.0]: https://github.com/ruby-syntax-tree/syntax_tree-haml/compare/v1.2.1...v1.3.0
+[1.2.1]: https://github.com/ruby-syntax-tree/syntax_tree-haml/compare/v1.2.0...v1.2.1
 [1.2.0]: https://github.com/ruby-syntax-tree/syntax_tree-haml/compare/v1.1.0...v1.2.0
 [1.1.0]: https://github.com/ruby-syntax-tree/syntax_tree-haml/compare/v1.0.1...v1.1.0
 [1.0.1]: https://github.com/ruby-syntax-tree/syntax_tree-haml/compare/v1.0.0...v1.0.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    syntax_tree-haml (1.2.0)
+    syntax_tree-haml (1.3.1)
       haml (>= 5.2)
       prettier_print
       syntax_tree (>= 2.0.1)
@@ -13,7 +13,7 @@ GEM
     haml (5.2.2)
       temple (>= 0.8.0)
       tilt
-    minitest (5.15.0)
+    minitest (5.16.2)
     prettier_print (0.1.0)
     rake (13.0.6)
     simplecov (0.21.2)
@@ -22,10 +22,10 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    syntax_tree (2.5.0)
+    syntax_tree (3.2.1)
       prettier_print
     temple (0.8.2)
-    tilt (2.0.10)
+    tilt (2.0.11)
 
 PLATFORMS
   ruby

data/Rakefile

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "syntax_tree/rake_tasks"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -9,4 +10,10 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
+SOURCE_FILES =
+  FileList[%w[Gemfile Rakefile syntax_tree-haml.gemspec lib/**/*.rb test/*.rb]]
+
+SyntaxTree::Rake::CheckTask.new { |t| t.source_files = SOURCE_FILES }
+SyntaxTree::Rake::WriteTask.new { |t| t.source_files = SOURCE_FILES }
+
 task default: :test

data/lib/syntax_tree/haml/format.rb

@@ -0,0 +1,427 @@
+# frozen_string_literal: true
+
+module SyntaxTree
+  module Haml
+    class Format < Visitor
+      attr_reader :q
+
+      def initialize(q)
+        @q = q
+      end
+
+      # https://haml.info/docs/yardoc/file.REFERENCE.html#html-comments-
+      def visit_comment(node)
+        with_children(node) do
+          q.text("/")
+          q.text("!") if node.value[:revealed]
+
+          if node.value[:conditional]
+            q.text(node.value[:conditional])
+          elsif node.value[:text]
+            q.text(" #{node.value[:text]}")
+          end
+        end
+      end
+
+      # https://haml.info/docs/yardoc/file.REFERENCE.html#doctype-
+      def visit_doctype(node)
+        parts = ["!!!"]
+
+        parts << if DOCTYPE_TYPES.key?(node.value[:type])
+          DOCTYPE_TYPES[node.value[:type]]
+        elsif DOCTYPE_VERSIONS.include?(node.value[:version])
+          node.value[:version]
+        else
+          node.value[:type]
+        end
+
+        parts << node.value[:encoding] if node.value[:encoding]
+        q.text(parts.join(" "))
+      end
+
+      # https://haml.info/docs/yardoc/file.REFERENCE.html#filter
+      def visit_filter(node)
+        q.group do
+          q.text(":")
+          q.text(node.value[:name])
+
+          q.indent do
+            q.breakable(force: true)
+
+            segments = node.value[:text].strip.split("\n")
+            q.seplist(segments, -> { q.breakable(force: true) }) do |segment|
+              q.text(segment)
+            end
+          end
+        end
+      end
+
+      # https://haml.info/docs/yardoc/file.REFERENCE.html#haml-comments--
+      def visit_haml_comment(node)
+        q.text("-#")
+        text = node.value[:text].strip
+
+        if text.include?("\n")
+          q.indent do
+            q.breakable(force: true)
+            q.seplist(
+              text.split("\n"),
+              -> { q.breakable(force: true) }
+            ) { |segment| q.text(segment) }
+          end
+        else
+          q.text(" #{text}")
+        end
+      end
+
+      # https://haml.info/docs/yardoc/file.REFERENCE.html#plain-text
+      def visit_plain(node)
+        text = node.value[:text]
+        q.text("\\") if escaped?(text)
+        q.text(text)
+      end
+
+      # Visit the root node of the AST.
+      def visit_root(node)
+        node.children.each do |child|
+          visit(child)
+          q.breakable(force: true)
+        end
+      end
+
+      # https://haml.info/docs/yardoc/file.REFERENCE.html#inserting_ruby
+      def visit_script(node)
+        with_children(node) do
+          q.text("&") if node.value[:escape_html]
+
+          node.value[:preserve] ? q.text("~") : q.text("=")
+
+          q.text(" ")
+          q.text(node.value[:text].strip)
+        end
+      end
+
+      # https://haml.info/docs/yardoc/file.REFERENCE.html#running-ruby--
+      def visit_silent_script(node)
+        q.group do
+          q.text("- ")
+          q.text(node.value[:text].strip)
+
+          node.children.each do |child|
+            if continuation?(node, child)
+              q.breakable(force: true)
+              visit(child)
+            else
+              q.indent do
+                q.breakable(force: true)
+                visit(child)
+              end
+            end
+          end
+        end
+      end
+
+      LiteralHashValue = Struct.new(:value)
+
+      StringHashValue = Struct.new(:value, :quote)
+
+      # When formatting a tag, there are a lot of different kinds of things that
+      # can be printed out. There's the tag name, the attributes, the content,
+      # etc. This object is responsible for housing all of those parts.
+      class PartList
+        attr_reader :node, :parts
+
+        def initialize(node)
+          @node = node
+          @parts = []
+        end
+
+        def <<(part)
+          parts << part
+        end
+
+        def empty?
+          parts.empty?
+        end
+
+        def format(q)
+          if empty? && node.value[:name] == "div"
+            # If we don't have any other parts to print and the tag is a div
+            # then we need to make sure to add that to the beginning. Otherwise
+            # it's implied by the presence of other operators.
+            q.text("%div")
+          else
+            parts.inject(0) do |align, part|
+              part.format(q, align)
+              align + part.length
+            end
+          end
+        end
+      end
+
+      class PlainPart < Struct.new(:value)
+        def format(q, align)
+          q.text(value)
+        end
+
+        def length
+          value.length
+        end
+      end
+
+      class PrefixPart < Struct.new(:prefix, :value)
+        def format(q, align)
+          q.text("#{prefix}#{value}")
+        end
+
+        def length
+          prefix.length + value.length
+        end
+      end
+
+      class HTMLAttributesPart
+        attr_reader :values
+
+        def initialize(raw)
+          @values =
+            raw[1...-1]
+              .split(",")
+              .to_h { |keypair| keypair[1..-1].split("\" => ") }
+        end
+
+        def format(q, align)
+          q.group do
+            q.text("(")
+            q.nest(align) do
+              q.seplist(
+                values,
+                -> { q.fill_breakable },
+                :each_pair
+              ) { |key, value| q.text("#{key}=#{value}") }
+            end
+            q.text(")")
+          end
+        end
+
+        def length
+          values.sum { |key, value| key.length + value.length + 3 }
+        end
+      end
+
+      class HashAttributesPart < Struct.new(:values)
+        def format(q, align)
+          format_value(q, values)
+        end
+
+        def length
+          values.sum do |key, value|
+            key.length + (value.is_a?(String) ? value : value.to_s).length + 3
+          end
+        end
+
+        private
+
+        def format_value(q, hash, level = 0)
+          quote = SyntaxTree::Formatter::OPTIONS[:quote]
+
+          q.group do
+            q.text("{")
+            q.indent do
+              q.group do
+                q.breakable(level == 0 ? "" : " ")
+                q.seplist(hash, nil, :each_pair) do |key, value|
+                  if key.match?(/^@|[-:]/)
+                    q.text("#{quote}#{Quotes.normalize(key, quote)}#{quote}:")
+                  else
+                    q.text("#{key}:")
+                  end
+
+                  q.text(" ")
+
+                  case value
+                  when Hash
+                    format_value(q, value, level + 1)
+                  when LiteralHashValue
+                    q.text(value.value)
+                  when StringLiteral
+                    qq = Formatter.new("")
+                    qq.with_target(q.target) { value.format(qq) }
+                  when String
+                    q.text("#{quote}#{Quotes.normalize(value, quote)}#{quote}")
+                  else
+                    q.text(value.to_s)
+                  end
+                end
+              end
+            end
+
+            q.breakable(level == 0 ? "" : " ")
+            q.text("}")
+          end
+        end
+      end
+
+      # Visit a tag node.
+      def visit_tag(node)
+        parts = PartList.new(node)
+
+        # If we have a tag that isn't a div, then we need to print out that
+        # name of that tag first. If it is a div, first we'll check if there
+        # are any other things that would force us to print out the div
+        # explicitly, and otherwise we'll leave it off.
+        if node.value[:name] != "div"
+          parts << PrefixPart.new("%", node.value[:name])
+        end
+
+        # If we have a class attribute, then we're going to print that here
+        # using the special class syntax.
+        if node.value[:attributes].key?("class")
+          parts << PrefixPart.new(
+            ".",
+            node.value[:attributes]["class"].tr(" ", ".")
+          )
+        end
+
+        # If we have an id attribute, then we're going to print that here
+        # using the special id syntax.
+        if node.value[:attributes].key?("id")
+          parts << PrefixPart.new("#", node.value[:attributes]["id"])
+        end
+
+        # If we're using dynamic attributes on this tag, then they come in as
+        # a string that looks like the output of Hash#inspect from Ruby. So
+        # here we're going to split it all up and print it out nicely.
+        if node.value[:dynamic_attributes].new
+          parts << HTMLAttributesPart.new(node.value[:dynamic_attributes].new)
+        end
+
+        # If there are any static attributes that are not class or id (because
+        # we already took care of those), then we're going to print them out
+        # here.
+        static =
+          node.value[:attributes].reject do |key, _|
+            key == "class" || key == "id"
+          end
+
+        parts << HashAttributesPart.new(static) if static.any?
+
+        # If there are dynamic attributes that don't use the newer syntax, then
+        # we're going to print them out here.
+        if node.value[:dynamic_attributes].old
+          parts << PlainPart.new("%div") if parts.empty?
+
+          if ::Haml::AttributeParser.available?
+            dynamic = parse_attributes(node.value[:dynamic_attributes].old)
+            parts << if dynamic.is_a?(LiteralHashValue)
+              PlainPart.new(dynamic.value)
+            else
+              HashAttributesPart.new(dynamic)
+            end
+          else
+            parts << PlainPart.new(node.value[:dynamic_attributes].old)
+          end
+        end
+
+        # https://haml.info/docs/yardoc/file.REFERENCE.html#object-reference-
+        if node.value[:object_ref] != :nil
+          parts << PlainPart.new("%div") if parts.empty?
+          parts << PlainPart.new(node.value[:object_ref])
+        end
+
+        # https://haml.info/docs/yardoc/file.REFERENCE.html#whitespace-removal--and-
+        parts << PlainPart.new(">") if node.value[:nuke_outer_whitespace]
+        parts << PlainPart.new("<") if node.value[:nuke_inner_whitespace]
+
+        # https://haml.info/docs/yardoc/file.REFERENCE.html#empty-void-tags-
+        parts << PlainPart.new("/") if node.value[:self_closing]
+
+        # If there is a value part, then we're going to print slightly
+        # differently as the value goes after the tag declaration.
+        if (value = node.value[:value]) && !value.empty?
+          with_children(node) do
+            q.group { parts.format(q) }
+            q.indent do
+              # Split between the declaration of the tag and the contents of the
+              # tag.
+              q.breakable("")
+
+              if node.value[:parse] && value.match?(/#[{$@]/)
+                # There's a weird case here where if the value includes
+                # interpolation and it's marked as { parse: true }, then we
+                # don't actually want the = prefix, and we want to remove extra
+                # escaping.
+                q.if_break { q.text("") }.if_flat { q.text(" ") }
+                q.text(value[1...-1].gsub(/\\"/, "\""))
+              elsif node.value[:parse]
+                q.text("= ")
+                q.text(value)
+              else
+                q.if_break { q.text("") }.if_flat { q.text(" ") }
+                q.text(value)
+              end
+            end
+          end
+        else
+          with_children(node) { parts.format(q) }
+        end
+      end
+
+      private
+
+      # When printing out sequences of silent scripts, sometimes subsequent nodes
+      # will be continuations of previous nodes. In that case we want to dedent
+      # them to match.
+      def continuation?(node, child)
+        return false if child.type != :silent_script
+
+        case [node.value[:keyword], child.value[:keyword]]
+        in ["case", "in" | "when" | "else"]
+          true
+        in ["if" | "unless", "elsif" | "else"]
+          true
+        else
+          false
+        end
+      end
+
+      # If a node comes in as the plain type but starts with one of the special
+      # characters that haml parses, then we need to escape it with a \ when
+      # printing.
+      def escaped?(text)
+        ::Haml::Parser::SPECIAL_CHARACTERS.any? do |special|
+          text.start_with?(special)
+        end
+      end
+
+      # Take a source string and attempt to parse it into a set of attributes that
+      # can be used to format the source.
+      def parse_attributes(source)
+        case Ripper.sexp(source)
+        in [:program, [[:hash, *], *]] if parsed =
+             ::Haml::AttributeParser.parse(source)
+          parsed.to_h { |key, value| [key, parse_attributes(value)] }
+        in [:program, [[:string_literal, *], *]]
+          SyntaxTree.parse(source).statements.body[0]
+        else
+          LiteralHashValue.new(source)
+        end
+      end
+
+      def with_children(node)
+        if node.children.empty?
+          q.group { yield }
+        else
+          q.group do
+            q.group { yield }
+            q.indent do
+              node.children.each do |child|
+                q.breakable(force: true)
+                visit(child)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/syntax_tree/haml/pretty_print.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module SyntaxTree
+  module Haml
+    class PrettyPrint < Visitor
+      attr_reader :q
+
+      def initialize(q)
+        @q = q
+      end
+
+      # https://haml.info/docs/yardoc/file.REFERENCE.html#html-comments-
+      def visit_comment(node)
+        group("comment") do
+          if node.value[:conditional]
+            pp_field("conditional", node.value[:conditional])
+          elsif node.value[:text]
+            pp_field("text", node.value[:text])
+          end
+
+          bool_field("revealed") if node.value[:revealed]
+          pp_field("children", node.children) if node.children.any?
+        end
+      end
+
+      # https://haml.info/docs/yardoc/file.REFERENCE.html#doctype-
+      def visit_doctype(node)
+        group("doctype") do
+          if DOCTYPE_TYPES.key?(node.value[:type])
+            pp_field("type", node.value[:type])
+          elsif DOCTYPE_VERSIONS.include?(node.value[:version])
+            pp_field("version", node.value[:version])
+          else
+            pp_field("text", node.value[:text])
+          end
+
+          pp_field("encoding", node.value[:encoding]) if node.value[:encoding]
+        end
+      end
+
+      # https://haml.info/docs/yardoc/file.REFERENCE.html#filter
+      def visit_filter(node)
+        group("filter") do
+          text_field("name", node.value[:name])
+          pp_field("text", node.value[:text])
+        end
+      end
+
+      # https://haml.info/docs/yardoc/file.REFERENCE.html#haml-comments--
+      def visit_haml_comment(node)
+        group("haml_comment") { pp_field("text", node.value[:text]) }
+      end
+
+      # https://haml.info/docs/yardoc/file.REFERENCE.html#plain-text
+      def visit_plain(node)
+        group("plain") { pp_field("text", node.value[:text]) }
+      end
+
+      # Visit the root node of the AST.
+      def visit_root(node)
+        group("root") do
+          pp_field("children", node.children) if node.children.any?
+        end
+      end
+
+      # https://haml.info/docs/yardoc/file.REFERENCE.html#inserting_ruby
+      def visit_script(node)
+        group("script") do
+          pp_field("text", node.value[:text])
+          bool_field("escape_html") if node.value[:escape_html]
+          bool_field("preserve") if node.value[:preserve]
+          pp_field("children", node.children) if node.children.any?
+        end
+      end
+
+      # https://haml.info/docs/yardoc/file.REFERENCE.html#running-ruby--
+      def visit_silent_script(node)
+        group("silent-script") do
+          pp_field("text", node.value[:text])
+          pp_field("children", node.children) if node.children.any?
+        end
+      end
+
+      # Visit a tag node.
+      def visit_tag(node)
+        group("tag") do
+          pp_field("name", node.value[:name])
+
+          if node.value[:attributes].any?
+            pp_field("attributes", node.value[:attributes])
+          end
+
+          if node.value[:dynamic_attributes].new
+            pp_field(
+              "dynamic_attributes.new",
+              node.value[:dynamic_attributes].new
+            )
+          end
+
+          if node.value[:dynamic_attributes].old
+            pp_field(
+              "dynamic_attributes.old",
+              node.value[:dynamic_attributes].old
+            )
+          end
+
+          if node.value[:object_ref] != :nil
+            pp_field("object_ref", node.value[:object_ref])
+          end
+
+          if node.value[:nuke_outer_whitespace]
+            bool_field("nuke_outer_whitespace")
+          end
+
+          if node.value[:nuke_inner_whitespace]
+            bool_field("nuke_inner_whitespace")
+          end
+
+          bool_field("self_closing") if node.value[:self_closing]
+          pp_field("value", node.value[:value]) if node.value[:value]
+          pp_field("children", node.children) if node.children.any?
+        end
+      end
+
+      private
+
+      def bool_field(name)
+        q.breakable
+        q.text(name)
+      end
+
+      def group(name)
+        q.group do
+          q.text("(")
+          q.text(name)
+
+          q.nest(2) { yield }
+          q.breakable("")
+          q.text(")")
+        end
+      end
+
+      def pp_field(name, value)
+        q.breakable
+        q.text(name)
+        q.text("=")
+        q.pp(value)
+      end
+
+      def text_field(name, value)
+        q.breakable
+        q.text(name)
+        q.text("=")
+        q.text(value)
+      end
+    end
+  end
+end

data/lib/syntax_tree/haml/version.rb

@@ -2,6 +2,6 @@
 
 module SyntaxTree
   module Haml
-    VERSION = "1.2.0"
+    VERSION = "1.3.1"
   end
 end