syntax_tree-haml 1.3.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9068b047f884f2383ae24642a130e7382b0dfdf776aa1b2bf2f154ed7ea6041f
-  data.tar.gz: 216ff4b132dc97df75181128256036e85824f123f380bee074ae8c47a0e501ce
+  metadata.gz: bddc6888f36d28a1f0829960a0be5a71edb719342895c68a1635f474fe977634
+  data.tar.gz: b56774e91f16a8521ca888824f84a4d9dbd3242837d74107add7255f3bc571d7
 SHA512:
-  metadata.gz: cc8c88bc84720391bd137c6c09113dc616509f3b3630e096c1ecd0da5f09722e72103fa67c3b4e8c746ab7db9922cc97902220dfdf2e3ffc48dc83434198f3bf
-  data.tar.gz: a737c7723359dd1efd998d8a1a02f71c559994dd5d7b28e2169aac223072af0fe136490b335603cb8864c8c499e97134b58547f58dc34181ed5605533201e622
+  metadata.gz: e9b36d29e67e7ea5424825a8344580c3560e7a49672fceb121eec6959a4e0becbb0a8481e935450c3566e6c5647062f90ad6b9411d2d8ce202d2c98b4695eece
+  data.tar.gz: 35dcaa252fdfe1b53bf8904feb2d312cd7c6f353bc48343f0944a030c315a9289bce62a6578f5c6d5813d992c35681cb9770abd66e2cc5ea53fab3389b8b4f7f

data/CHANGELOG.md

@@ -6,6 +6,18 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [1.3.2] - 2022-09-19
+
+### Added
+
+- Properly support unescaping plain and script.
+
+## [1.3.1] - 2022-08-01
+
+### Changed
+
+- Use Syntax Tree to handle properly quoting strings.
+
 ## [1.3.0] - 2022-07-22
 
 ### Added
@@ -48,7 +60,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.1...HEAD
+[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree-haml/compare/v1.3.2...HEAD
+[1.3.2]: https://github.com/ruby-syntax-tree/syntax_tree-haml/compare/v1.3.1...v1.3.2
+[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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    syntax_tree-haml (1.3.0)
+    syntax_tree-haml (1.3.2)
       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.16.2)
+    minitest (5.16.3)
     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 (3.2.0)
+    syntax_tree (3.6.0)
       prettier_print
     temple (0.8.2)
-    tilt (2.0.10)
+    tilt (2.0.11)
 
 PLATFORMS
   ruby

data/README.md

@@ -55,7 +55,7 @@ template.haml 1ms
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests. You can also run `bundle console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/lib/syntax_tree/haml/format.rb

@@ -3,6 +3,22 @@
 module SyntaxTree
   module Haml
     class Format < Visitor
+      class Formatter < ::SyntaxTree::Formatter
+        attr_reader :literal_lines, :quote
+
+        def initialize(source, ...)
+          @literal_lines = {}
+          source
+            .lines
+            .each
+            .with_index(1) do |line, index|
+              @literal_lines[index] = line.rstrip if line.start_with?("!")
+            end
+
+          super(source, ...)
+        end
+      end
+
       attr_reader :q
 
       def initialize(q)
@@ -62,12 +78,11 @@ module SyntaxTree
         text = node.value[:text].strip
 
         if text.include?("\n")
+          separator = -> { q.breakable(force: true) }
+
           q.indent do
-            q.breakable(force: true)
-            q.seplist(
-              text.split("\n"),
-              -> { q.breakable(force: true) }
-            ) { |segment| q.text(segment) }
+            separator.call
+            q.seplist(text.split("\n"), separator) { |segment| q.text(segment) }
           end
         else
           q.text(" #{text}")
@@ -76,9 +91,13 @@ module SyntaxTree
 
       # 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)
+        if line = q.literal_lines[node.line]
+          q.text(line)
+        else
+          text = node.value[:text]
+          q.text("\\") if escaped?(text)
+          q.text(text)
+        end
       end
 
       # Visit the root node of the AST.
@@ -92,12 +111,14 @@ module SyntaxTree
       # 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)
+          if line = q.literal_lines[node.line]
+            q.text(line)
+          else
+            q.text("&") if node.value[:escape_html]
+            q.text(node.value[:preserve] ? "~" : "=")
+            q.text(" ")
+            q.text(node.value[:text].strip)
+          end
         end
       end
 
@@ -123,6 +144,8 @@ module SyntaxTree
 
       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.
@@ -220,19 +243,33 @@ module SyntaxTree
         private
 
         def format_value(q, hash, level = 0)
+          quote = q.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|
-                  q.text(Format.hash_key(key))
+                  if key.match?(/^@|[-:]/)
+                    q.text("#{quote}#{Quotes.normalize(key, quote)}#{quote}:")
+                  else
+                    q.text("#{key}:")
+                  end
+
                   q.text(" ")
 
-                  if value.is_a?(Hash)
+                  case value
+                  when Hash
                     format_value(q, value, level + 1)
+                  when LiteralHashValue
+                    q.text(value.value)
+                  when StringLiteral
+                    value.format(q)
+                  when String
+                    q.text("#{quote}#{Quotes.normalize(value, quote)}#{quote}")
                   else
-                    q.text(Format.hash_value(value))
+                    q.text(value.to_s)
                   end
                 end
               end
@@ -244,27 +281,6 @@ module SyntaxTree
         end
       end
 
-      def self.hash_key(key)
-        if key.match?(/^@|[-:]/)
-          quote = SyntaxTree::Formatter::OPTIONS[:quote]
-          "#{quote}#{Quotes.normalize(key, quote)}#{quote}:"
-        else
-          "#{key}:"
-        end
-      end
-
-      def self.hash_value(value)
-        case value
-        when LiteralHashValue
-          value.value
-        when String
-          quote = SyntaxTree::Formatter::OPTIONS[:quote]
-          "#{quote}#{Quotes.normalize(value, quote)}#{quote}"
-        else
-          value.to_s
-        end
-      end
-
       # Visit a tag node.
       def visit_tag(node)
         parts = PartList.new(node)
@@ -405,7 +421,7 @@ module SyntaxTree
              ::Haml::AttributeParser.parse(source)
           parsed.to_h { |key, value| [key, parse_attributes(value)] }
         in [:program, [[:string_literal, *], *]]
-          source[1...-1]
+          SyntaxTree.parse(source).statements.body[0]
         else
           LiteralHashValue.new(source)
         end

data/lib/syntax_tree/haml/version.rb

@@ -2,6 +2,6 @@
 
 module SyntaxTree
   module Haml
-    VERSION = "1.3.0"
+    VERSION = "1.3.2"
   end
 end

data/lib/syntax_tree/haml.rb

@@ -34,7 +34,11 @@ module SyntaxTree
     # This is the main entrypoint for the formatter. It parses the source,
     # builds a formatter, then pretty prints the result.
     def self.format(source, maxwidth = 80)
-      PrettierPrint.format(+"", maxwidth) { |q| parse(source).format(q) }
+      formatter = Format::Formatter.new(source, +"", maxwidth)
+      parse(source).format(formatter)
+
+      formatter.flush
+      formatter.output
     end
 
     # This is a required API for syntax tree which just delegates to File.read.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syntax_tree-haml
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.2
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-22 00:00:00.000000000 Z
+date: 2022-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -152,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.21
 signing_key:
 specification_version: 4
 summary: Syntax Tree support for Haml