syntax_tree-haml 1.3.2 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bddc6888f36d28a1f0829960a0be5a71edb719342895c68a1635f474fe977634
-  data.tar.gz: b56774e91f16a8521ca888824f84a4d9dbd3242837d74107add7255f3bc571d7
+  metadata.gz: c410fddce7b0b3de3dca5f4f0ff6f1f495f70897d1a07f956ceb3cedb8a3bc42
+  data.tar.gz: 6f4866aefe38f780411b65fa2671a9f9491aba0249884dc6c6f627d1a76f5520
 SHA512:
-  metadata.gz: e9b36d29e67e7ea5424825a8344580c3560e7a49672fceb121eec6959a4e0becbb0a8481e935450c3566e6c5647062f90ad6b9411d2d8ce202d2c98b4695eece
-  data.tar.gz: 35dcaa252fdfe1b53bf8904feb2d312cd7c6f353bc48343f0944a030c315a9289bce62a6578f5c6d5813d992c35681cb9770abd66e2cc5ea53fab3389b8b4f7f
+  metadata.gz: b79312706a5519a3d6933040c99f353ca344290d9c026d27ee2b6aa5b092ef8f03e735ae5e0de4b832bf7acbdceeceb844bdb9ca46ddd1b6aa9ea3f8c1d37cbc
+  data.tar.gz: e0993ba8112bb8149cbcaf972ba588e2b347431254bf0d3d0a63482657d18d5f70af4aa58f185b9d696d5c028bae55621cb483ad9800474242c2236be3043e98

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

@@ -1,22 +1,26 @@
 name: Main
+
 on:
-- push
-- pull_request_target
+  push:
+    branches:
+      - main
+  pull_request: {}
+
 jobs:
   ci:
     strategy:
       fail-fast: false
       matrix:
         ruby:
-        - '2.7'
+        - '2.7.0'
+        - '2.7.5'
         - '3.0'
         - '3.1'
+        - '3.2'
     name: CI
     runs-on: ubuntu-latest
-    env:
-      CI: true
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v3
     - uses: ruby/setup-ruby@v1
       with:
         bundler-cache: true
@@ -25,17 +29,3 @@ jobs:
       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/CHANGELOG.md

@@ -6,6 +6,52 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [4.0.3] - 2023-03-12
+
+### Changed
+
+- Fixed a bug where blank lines were being inserted into filter nodes accidentally.
+
+## [4.0.2] - 2023-03-09
+
+### Changed
+
+- Require `prettier_print` `1.2.1` or higher to fix the infinite loop bug.
+- Maintain blank lines in nested nodes.
+
+## [4.0.1] - 2023-03-07
+
+### Changed
+
+- We now keep blank lines around in the source template. (Multiple blank lines are squished down to a single blank line.)
+- We now actually parse the Ruby code written in `%=` tags. This fixed a couple of bugs and allows us to better format the output. For example, `%p= 1+1` will now be formatted as `%p= 1 + 1`. If the output fails to parse it falls back to the previous behavior of just printing the Ruby code as-is.
+
+## [4.0.0] - 2023-03-07
+
+### Changed
+
+- Required syntax_tree version 6.0.0 or higher.
+- Fixed up hash attribute parser to handle multiline hashes using Syntax Tree itself.
+
+## [3.0.0] - 2022-12-23
+
+### Changed
+
+- Required syntax_tree version 5.0.1 or higher.
+- Drop internal pattern matching in order to support Ruby implementations that don't support it.
+
+## [2.0.0] - 2022-10-18
+
+### Added
+
+- Support for Ruby 2.7.0, not just 2.7.3
+- Require syntax_tree 4.0.1 or higher.
+- Require prettier_print 1.0.0 or higher.
+
+### Changed
+
+- Nodes must now be formatted with a `SyntaxTree::Haml::Formatter`.
+
 ## [1.3.2] - 2022-09-19
 
 ### Added
@@ -60,7 +106,13 @@ 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.3.2...HEAD
+[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree-haml/compare/v4.0.3...HEAD
+[4.0.3]: https://github.com/ruby-syntax-tree/syntax_tree-haml/compare/v4.0.2...v4.0.3
+[4.0.2]: https://github.com/ruby-syntax-tree/syntax_tree-haml/compare/v4.0.1...v4.0.2
+[4.0.1]: https://github.com/ruby-syntax-tree/syntax_tree-haml/compare/v4.0.0...v4.0.1
+[4.0.0]: https://github.com/ruby-syntax-tree/syntax_tree-haml/compare/v3.0.0...v4.0.0
+[3.0.0]: https://github.com/ruby-syntax-tree/syntax_tree-haml/compare/v2.0.0...v3.0.0
+[2.0.0]: https://github.com/ruby-syntax-tree/syntax_tree-haml/compare/v1.3.2...v2.0.0
 [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

data/Gemfile.lock

@@ -1,37 +1,36 @@
 PATH
   remote: .
   specs:
-    syntax_tree-haml (1.3.2)
+    syntax_tree-haml (4.0.3)
       haml (>= 5.2)
-      prettier_print
-      syntax_tree (>= 2.0.1)
+      prettier_print (>= 1.2.1)
+      syntax_tree (>= 6.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     docile (1.4.0)
-    haml (5.2.2)
-      temple (>= 0.8.0)
+    haml (6.1.1)
+      temple (>= 0.8.2)
+      thor
       tilt
-    minitest (5.16.3)
-    prettier_print (0.1.0)
+    minitest (5.18.0)
+    prettier_print (1.2.1)
     rake (13.0.6)
-    simplecov (0.21.2)
+    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 (3.6.0)
-      prettier_print
-    temple (0.8.2)
-    tilt (2.0.11)
+    syntax_tree (6.0.2)
+      prettier_print (>= 1.2.0)
+    temple (0.10.0)
+    thor (1.2.1)
+    tilt (2.1.0)
 
 PLATFORMS
-  ruby
-  x86_64-darwin-19
-  x86_64-darwin-20
-  x86_64-darwin-21
+  arm64-darwin-22
   x86_64-linux
 
 DEPENDENCIES
@@ -42,4 +41,4 @@ DEPENDENCIES
   syntax_tree-haml!
 
 BUNDLED WITH
-   2.3.6
+   2.4.1

data/lib/syntax_tree/haml/format.rb

@@ -4,9 +4,13 @@ module SyntaxTree
   module Haml
     class Format < Visitor
       class Formatter < ::SyntaxTree::Formatter
-        attr_reader :literal_lines, :quote
+        attr_reader :literal_lines
 
-        def initialize(source, ...)
+        def initialize(
+          source,
+          *rest,
+          options: ::SyntaxTree::Formatter::Options.new
+        )
           @literal_lines = {}
           source
             .lines
@@ -15,7 +19,7 @@ module SyntaxTree
               @literal_lines[index] = line.rstrip if line.start_with?("!")
             end
 
-          super(source, ...)
+          super(source, *rest, options: options)
         end
       end
 
@@ -62,12 +66,20 @@ module SyntaxTree
           q.text(node.value[:name])
 
           q.indent do
-            q.breakable(force: true)
+            q.breakable_force
+            first = true
+
+            node.value[:text]
+              .rstrip
+              .each_line(chomp: true) do |line|
+                if first
+                  first = false
+                else
+                  q.breakable_force
+                end
 
-            segments = node.value[:text].strip.split("\n")
-            q.seplist(segments, -> { q.breakable(force: true) }) do |segment|
-              q.text(segment)
-            end
+                q.text(line)
+              end
           end
         end
       end
@@ -78,11 +90,19 @@ module SyntaxTree
         text = node.value[:text].strip
 
         if text.include?("\n")
-          separator = -> { q.breakable(force: true) }
-
           q.indent do
-            separator.call
-            q.seplist(text.split("\n"), separator) { |segment| q.text(segment) }
+            q.breakable_force
+            first = true
+
+            text.each_line(chomp: true) do |line|
+              if first
+                first = false
+              else
+                q.breakable_force
+              end
+
+              q.text(line)
+            end
           end
         else
           q.text(" #{text}")
@@ -102,9 +122,14 @@ module SyntaxTree
 
       # Visit the root node of the AST.
       def visit_root(node)
+        previous_line = nil
+
         node.children.each do |child|
+          q.breakable_force if previous_line && (child.line - previous_line) > 1
+          previous_line = child.last_line
+
           visit(child)
-          q.breakable(force: true)
+          q.breakable_force
         end
       end
 
@@ -130,11 +155,11 @@ module SyntaxTree
 
           node.children.each do |child|
             if continuation?(node, child)
-              q.breakable(force: true)
+              q.breakable_force
               visit(child)
             else
               q.indent do
-                q.breakable(force: true)
+                q.breakable_force
                 visit(child)
               end
             end
@@ -144,8 +169,6 @@ 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.
@@ -201,6 +224,14 @@ module SyntaxTree
       end
 
       class HTMLAttributesPart
+        class Separator
+          def call(q)
+            q.fill_breakable
+          end
+        end
+
+        SEPARATOR = Separator.new
+
         attr_reader :values
 
         def initialize(raw)
@@ -214,11 +245,9 @@ module SyntaxTree
           q.group do
             q.text("(")
             q.nest(align) do
-              q.seplist(
-                values,
-                -> { q.fill_breakable },
-                :each_pair
-              ) { |key, value| q.text("#{key}=#{value}") }
+              q.seplist(values, SEPARATOR, :each_pair) do |key, value|
+                q.text("#{key}=#{value}")
+              end
             end
             q.text(")")
           end
@@ -249,9 +278,9 @@ module SyntaxTree
             q.text("{")
             q.indent do
               q.group do
-                q.breakable(level == 0 ? "" : " ")
+                level == 0 ? q.breakable_empty : q.breakable_space
                 q.seplist(hash, nil, :each_pair) do |key, value|
-                  if key.match?(/^@|[-:]/)
+                  if key.match?(/^@|[-:]/) && !key.match?(/^["']/)
                     q.text("#{quote}#{Quotes.normalize(key, quote)}#{quote}:")
                   else
                     q.text("#{key}:")
@@ -275,7 +304,7 @@ module SyntaxTree
               end
             end
 
-            q.breakable(level == 0 ? "" : " ")
+            level == 0 ? q.breakable_empty : q.breakable_space
             q.text("}")
           end
         end
@@ -329,17 +358,7 @@ module SyntaxTree
         # 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
+          parts << parse_attributes(node.value[:dynamic_attributes].old)
         end
 
         # https://haml.info/docs/yardoc/file.REFERENCE.html#object-reference-
@@ -363,18 +382,10 @@ module SyntaxTree
             q.indent do
               # Split between the declaration of the tag and the contents of the
               # tag.
-              q.breakable("")
+              q.breakable_empty
 
-              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)
+              if node.value[:parse]
+                format_tag_value(q, value)
               else
                 q.if_break { q.text("") }.if_flat { q.text(" ") }
                 q.text(value)
@@ -388,17 +399,42 @@ module SyntaxTree
 
       private
 
+      def format_tag_value(q, value)
+        program = SyntaxTree.parse(value)
+        if !program || program.statements.body.length > 1
+          return q.text("= #{value}")
+        end
+
+        statement = program.statements.body.first
+        formatter = SyntaxTree::Formatter.new(value, [], Float::INFINITY)
+        formatter.format(statement)
+        formatter.flush
+        formatted = formatter.output.join
+
+        if statement.is_a?(StringLiteral) && statement.parts.length > 1
+          # 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(formatted[1...-1].gsub(/\\"/, "\""))
+        else
+          q.text("= #{formatted}")
+        end
+      rescue Parser::ParseError
+        q.text("= #{value}")
+      end
+
       # 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
+        case node.value[:keyword]
+        when "case"
+          %w[in when else].include?(child.value[:keyword])
+        when "if", "unless"
+          %w[elsif else].include?(child.value[:keyword])
         else
           false
         end
@@ -413,20 +449,55 @@ module SyntaxTree
         end
       end
 
-      # Take a source string and attempt to parse it into a set of attributes that
-      # can be used to format the source.
+      # 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)
+        source = source.strip
+        source = source.start_with?("{") ? source : "{#{source}}"
+
+        program = SyntaxTree.parse(source)
+        return PlainPart.new(source) if program.nil?
+
+        node = program.statements.body.first
+        return PlainPart.new(source) unless node.is_a?(HashLiteral)
+
+        HashAttributesPart.new(parse_attributes_hash(source, node))
+      rescue Parser::ParseError
+        PlainPart.new(source)
+      end
+
+      def parse_attributes_hash(source, node, level = 1)
+        node.assocs.to_h do |assoc|
+          key =
+            case assoc.key
+            when StringLiteral
+              format(assoc.key)
+            when Label
+              assoc.key.value.delete_suffix(":")
+            when DynaSymbol
+              format(assoc.key).delete_prefix(":")
+            else
+              format(assoc.key)
+            end
+
+          value =
+            case assoc.value
+            when HashLiteral
+              parse_attributes_hash(source, assoc.value, level + 1)
+            when StringLiteral
+              assoc.value
+            else
+              LiteralHashValue.new(format(assoc.value, level * 2).lstrip)
+            end
+
+          [key, value]
         end
       end
 
+      def format(node, column = 0)
+        SyntaxTree::Formatter.format(+"", node, column)
+      end
+
       def with_children(node)
         if node.children.empty?
           q.group { yield }
@@ -434,9 +505,17 @@ module SyntaxTree
           q.group do
             q.group { yield }
             q.indent do
+              previous_line = nil
+
               node.children.each do |child|
-                q.breakable(force: true)
+                q.breakable_force
+
+                if previous_line && (child.line - previous_line) > 1
+                  q.breakable_force
+                end
+
                 visit(child)
+                previous_line = child.last_line
               end
             end
           end

data/lib/syntax_tree/haml/version.rb

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

data/lib/syntax_tree/haml.rb

@@ -33,8 +33,8 @@ 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)
-      formatter = Format::Formatter.new(source, +"", maxwidth)
+    def self.format(source, maxwidth = 80, options: Formatter::Options.new)
+      formatter = Format::Formatter.new(source, +"", maxwidth, options: options)
       parse(source).format(formatter)
 
       formatter.flush
@@ -59,31 +59,53 @@ class Haml::Parser::ParseNode
   # accept a visitor in order to walk through the tree.
   def accept(visitor)
     case type
-    in :comment
+    when :comment
       visitor.visit_comment(self)
-    in :doctype
+    when :doctype
       visitor.visit_doctype(self)
-    in :filter
+    when :filter
       visitor.visit_filter(self)
-    in :haml_comment
+    when :haml_comment
       visitor.visit_haml_comment(self)
-    in :plain
+    when :plain
       visitor.visit_plain(self)
-    in :root
+    when :root
       visitor.visit_root(self)
-    in :script
+    when :script
       visitor.visit_script(self)
-    in :silent_script
+    when :silent_script
       visitor.visit_silent_script(self)
-    in :tag
+    when :tag
       visitor.visit_tag(self)
+    else
+      raise "Unknown node type: #{type}"
     end
   end
 
+  # This is our entrypoint for the formatter. We effectively delegate this to
+  # accepting the Format visitor.
   def format(q)
     accept(SyntaxTree::Haml::Format.new(q))
   end
 
+  # When we're formatting a list of children, we need to know the last line a
+  # node is on. This is because the next node in the list of children should be
+  # at most 1 blank line below the last line of the previous node. We cache this
+  # because at worst it requires walking the entire tree because filter nodes
+  # can take up multiple lines.
+  def last_line
+    @last_line ||=
+      if children.any?
+        children.last.last_line
+      elsif type == :filter
+        line + value[:text].rstrip.count("\n") + 1
+      else
+        line
+      end
+  end
+
+  # This is our entrypoint for the pretty printer. We effectively delegate this
+  # to accepting the PrettyPrint visitor.
   def pretty_print(q)
     accept(SyntaxTree::Haml::PrettyPrint.new(q))
   end

data/syntax_tree-haml.gemspec

@@ -25,8 +25,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w[lib]
 
   spec.add_dependency "haml", ">= 5.2"
-  spec.add_dependency "prettier_print"
-  spec.add_dependency "syntax_tree", ">= 2.0.1"
+  spec.add_dependency "prettier_print", ">= 1.2.1"
+  spec.add_dependency "syntax_tree", ">= 6.0.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "minitest"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syntax_tree-haml
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 4.0.3
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-19 00:00:00.000000000 Z
+date: 2023-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: syntax_tree
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/workflows/auto-merge.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - CHANGELOG.md
@@ -152,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.21
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Syntax Tree support for Haml