syntax_tree-haml 1.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dfb86a00b3723b124c178e28e4a6af8a604aba895a495324ea151732449bde3
-  data.tar.gz: d597c33107dc7d04b1b52dbe645b2b8b0bf0830e0dc328f83971e95305dab32f
+  metadata.gz: 61fd378df6679c193bda86bdb1f1f78de949b0978c7ec02ec114e1d8fadcd3b5
+  data.tar.gz: 1011cad24c3f91ab3086c14b9dda49c6a0093d20c8d3af8fc86286e8dd8851ed
 SHA512:
-  metadata.gz: b6c225f3fcbd9af942f4a6cc00ca8a018a9ebec362b18e987f3b38895164da276ceec928fc02303fcb5055b4a4d787e0224d37cea9402de94f3310171e290c87
-  data.tar.gz: 40ae9ef5f96374fed98f1e00302bfda455e3b279f4f653c733cd806bdc52af37ee4f56bd6464b3a16442dd522a56afc23a8773d07692213d978bad16d68b87ac
+  metadata.gz: 3cfb430120300e2fe6a593a7a47e8be22c09d160960b5a6f6d324e117827d752c648d6111c47d664a8d137cff584aa5fb856d93241c5f7edf2be2360e7e8f8c4
+  data.tar.gz: 4e4597ea20a6514cc10ff326db244616ebdd41f11d71095f76ca4aabfb1a1c355e76620e024223ff761e5f9f5bcd0eb868ca62323b2ba669a202da8c0ba13d55

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,14 +1,17 @@
 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'
     name: CI
@@ -16,7 +19,7 @@ jobs:
     env:
       CI: true
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v3
     - uses: ruby/setup-ruby@v1
       with:
         bundler-cache: true
@@ -25,17 +28,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,24 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [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
+
+- Properly support unescaping plain and script.
+
 ## [1.3.1] - 2022-08-01
 
 ### Changed
@@ -54,7 +72,9 @@ 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.1...HEAD
+[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree-haml/compare/v2.0.0...HEAD
+[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
 [1.2.1]: https://github.com/ruby-syntax-tree/syntax_tree-haml/compare/v1.2.0...v1.2.1

data/Gemfile.lock

@@ -1,20 +1,21 @@
 PATH
   remote: .
   specs:
-    syntax_tree-haml (1.3.1)
-      haml (>= 5.2)
-      prettier_print
-      syntax_tree (>= 2.0.1)
+    syntax_tree-haml (2.0.0)
+      haml (>= 5.2, != 6.0.0)
+      prettier_print (>= 1.0.0)
+      syntax_tree (>= 4.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     docile (1.4.0)
-    haml (5.2.2)
-      temple (>= 0.8.0)
+    haml (6.0.7)
+      temple (>= 0.8.2)
+      thor
       tilt
-    minitest (5.16.2)
-    prettier_print (0.1.0)
+    minitest (5.16.3)
+    prettier_print (1.0.1)
     rake (13.0.6)
     simplecov (0.21.2)
       docile (~> 1.1)
@@ -22,9 +23,10 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    syntax_tree (3.2.1)
-      prettier_print
+    syntax_tree (4.0.1)
+      prettier_print (>= 1.0.1)
     temple (0.8.2)
+    thor (1.2.1)
     tilt (2.0.11)
 
 PLATFORMS

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, *rest)
+          @literal_lines = {}
+          source
+            .lines
+            .each
+            .with_index(1) do |line, index|
+              @literal_lines[index] = line.rstrip if line.start_with?("!")
+            end
+
+          super(source, *rest)
+        end
+      end
+
       attr_reader :q
 
       def initialize(q)
@@ -46,11 +62,17 @@ module SyntaxTree
           q.text(node.value[:name])
 
           q.indent do
-            q.breakable(force: true)
+            q.breakable_force
+            first = true
+
+            node.value[:text].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)
+              q.text(line)
             end
           end
         end
@@ -63,11 +85,18 @@ module SyntaxTree
 
         if text.include?("\n")
           q.indent do
-            q.breakable(force: true)
-            q.seplist(
-              text.split("\n"),
-              -> { q.breakable(force: true) }
-            ) { |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}")
@@ -76,28 +105,34 @@ 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.
       def visit_root(node)
         node.children.each do |child|
           visit(child)
-          q.breakable(force: true)
+          q.breakable_force
         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)
+          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
 
@@ -109,11 +144,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
@@ -122,7 +157,6 @@ module SyntaxTree
       end
 
       LiteralHashValue = Struct.new(:value)
-
       StringHashValue = Struct.new(:value, :quote)
 
       # When formatting a tag, there are a lot of different kinds of things that
@@ -180,6 +214,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)
@@ -193,11 +235,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
@@ -222,13 +262,13 @@ module SyntaxTree
         private
 
         def format_value(q, hash, level = 0)
-          quote = SyntaxTree::Formatter::OPTIONS[:quote]
+          quote = q.quote
 
           q.group do
             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?(/^@|[-:]/)
                     q.text("#{quote}#{Quotes.normalize(key, quote)}#{quote}:")
@@ -244,8 +284,7 @@ module SyntaxTree
                   when LiteralHashValue
                     q.text(value.value)
                   when StringLiteral
-                    qq = Formatter.new("")
-                    qq.with_target(q.target) { value.format(qq) }
+                    value.format(q)
                   when String
                     q.text("#{quote}#{Quotes.normalize(value, quote)}#{quote}")
                   else
@@ -255,7 +294,7 @@ module SyntaxTree
               end
             end
 
-            q.breakable(level == 0 ? "" : " ")
+            level == 0 ? q.breakable_empty : q.breakable_space
             q.text("}")
           end
         end
@@ -343,7 +382,7 @@ 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
@@ -353,8 +392,7 @@ module SyntaxTree
                 q.if_break { q.text("") }.if_flat { q.text(" ") }
                 q.text(value[1...-1].gsub(/\\"/, "\""))
               elsif node.value[:parse]
-                q.text("= ")
-                q.text(value)
+                q.text("= #{value}")
               else
                 q.if_break { q.text("") }.if_flat { q.text(" ") }
                 q.text(value)
@@ -393,8 +431,8 @@ 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 =
@@ -415,7 +453,7 @@ module SyntaxTree
             q.group { yield }
             q.indent do
               node.children.each do |child|
-                q.breakable(force: true)
+                q.breakable_force
                 visit(child)
               end
             end

data/lib/syntax_tree/haml/version.rb

@@ -2,6 +2,6 @@
 
 module SyntaxTree
   module Haml
-    VERSION = "1.3.1"
+    VERSION = "2.0.0"
   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.

data/syntax_tree-haml.gemspec

@@ -24,9 +24,10 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w[lib]
 
-  spec.add_dependency "haml", ">= 5.2"
-  spec.add_dependency "prettier_print"
-  spec.add_dependency "syntax_tree", ">= 2.0.1"
+  # Can't use 6.0.0 due to https://github.com/haml/haml/issues/1085
+  spec.add_dependency "haml", ">= 5.2", "!= 6.0.0"
+  spec.add_dependency "prettier_print", ">= 1.0.0"
+  spec.add_dependency "syntax_tree", ">= 4.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.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Kevin Newton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-01 00:00:00.000000000 Z
+date: 2022-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,34 +27,37 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: prettier_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: syntax_tree
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +122,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/workflows/auto-merge.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - CHANGELOG.md
@@ -152,7 +159,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