Merge pull request #57 from ruby-syntax-tree/update-to-stree-5

Update to Syntax Tree version 5.0.0

Author: kddnewton

CHANGELOG.md

@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [3.0.0] - 2022-11-10
+
+### Changed
+
+- Required syntax_tree version 5.0.1 or higher.
+
 ## [2.0.0] - 2022-10-18
 
 ### Added
@@ -72,7 +78,8 @@ 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/v2.0.0...HEAD
+[unreleased]: https://github.com/ruby-syntax-tree/syntax_tree-haml/compare/v3.0.0...HEAD
+[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

Gemfile.lock

@@ -4,13 +4,13 @@ PATH
     syntax_tree-haml (2.0.0)
       haml (>= 5.2, != 6.0.0)
       prettier_print (>= 1.0.0)
-      syntax_tree (>= 4.0.0)
+      syntax_tree (>= 5.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     docile (1.4.0)
-    haml (6.0.9)
+    haml (6.0.10)
       temple (>= 0.8.2)
       thor
       tilt
@@ -23,7 +23,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    syntax_tree (5.0.0)
+    syntax_tree (5.0.1)
       prettier_print (>= 1.1.0)
     temple (0.9.1)
     thor (1.2.1)

lib/syntax_tree/haml.rb

@@ -33,8 +33,8 @@ def self.parse(source)
 
     # 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

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, *rest)
+        def initialize(
+          source,
+          *rest,
+          options: ::SyntaxTree::Formatter::Options.new
+        )
           @literal_lines = {}
           source
             .lines
@@ -15,7 +19,7 @@ def initialize(source, *rest)
               @literal_lines[index] = line.rstrip if line.start_with?("!")
             end
 
-          super(source, *rest)
+          super(source, *rest, options: options)
         end
       end
 

syntax_tree-haml.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   # 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_dependency "syntax_tree", ">= 5.0.1"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "minitest"

test/tag_test.rb

@@ -56,12 +56,11 @@ def test_dynamic_attributes_nested_hash
   end
 
   def test_dynamic_attributes_nested_hash_single_quotes
-    with_single_quotes do
-      assert_format(
-        "%div{data: { controller: \"lesson-evaluation\" }}",
-        "%div{data: { controller: 'lesson-evaluation' }}"
-      )
-    end
+    assert_format(
+      "%div{data: { controller: \"lesson-evaluation\" }}",
+      "%div{data: { controller: 'lesson-evaluation' }}",
+      options: SyntaxTree::Formatter::Options.new(quote: "'")
+    )
   end
 
   def test_dynamic_attributes_integers
@@ -84,12 +83,11 @@ def test_dynamic_attributes_strings
   end
 
   def test_dynamic_attributes_strings_single_quotes
-    with_single_quotes do
-      assert_format(
-        "%section(xml:lang=\"en\" title=\"title\")",
-        "%section{'xml:lang': 'en', title: 'title'}"
-      )
-    end
+    assert_format(
+      "%section(xml:lang=\"en\" title=\"title\")",
+      "%section{'xml:lang': 'en', title: 'title'}",
+      options: SyntaxTree::Formatter::Options.new(quote: "'")
+    )
   end
 
   def test_dynamic_attributes_with_at
@@ -137,25 +135,15 @@ def test_quotes_in_strings
   end
 
   def test_interpolation_in_strings
-    with_single_quotes { assert_format(<<~HAML) }
+    source = <<~HAML
       %div{style: "background: center/cover url(\#{url_for(page.resource.file)})"}
     HAML
+
+    options = SyntaxTree::Formatter::Options.new(quote: "'")
+    assert_format(source, options: options)
   end
 
   def test_interpolation_in_value
     assert_format("%p <small>hello</small>\"\#{1 + 2} little pigs\"")
   end
-
-  private
-
-  def with_single_quotes
-    quote = SyntaxTree::Formatter::OPTIONS[:quote]
-    SyntaxTree::Formatter::OPTIONS[:quote] = "'"
-
-    begin
-      yield
-    ensure
-      SyntaxTree::Formatter::OPTIONS[:quote] = quote
-    end
-  end
 end

test/test_helper.rb

@@ -15,7 +15,11 @@
 class Minitest::Test
   private
 
-  def assert_format(source, expected = nil)
+  def assert_format(
+    source,
+    expected = nil,
+    options: ::SyntaxTree::Formatter::Options.new
+  )
     # Adding a bit of code here just to make sure the pretty-printing gets
     # executed as part of this. Not going to actually assert against it since
     # it's more of a nice-to-have and the actual format is not strict.
@@ -26,7 +30,7 @@ def assert_format(source, expected = nil)
     # result is what we expect.
     assert_equal(
       (expected || source).strip,
-      SyntaxTree::Haml.format(source.dup).strip
+      SyntaxTree::Haml.format(source.dup, options: options).strip
     )
   end
 end