erb-formatter 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9746e0224608b37531674e86d589b087a67875791440318536b7d55ec66c8548
-  data.tar.gz: 73b0639da80cba0761eb5b6a58270b32db5b146cca710b446ebae61737bba385
+  metadata.gz: a91fb15a3934ccb7a9589ebfefd60bd2b95610acb90259358a26239a34d7a3cb
+  data.tar.gz: 576ac293a9932d8c81d2ef9a62cd98fc3a39a01da9c3b8ac7919438768e18c28
 SHA512:
-  metadata.gz: d2658816da104a74d23952c1f59c70726c27668763ed94332914112fcd04e76c61ab95e738fea856c44e1f0bd72d0dae61d8ee7c6ec38d28abd927e91b970e56
-  data.tar.gz: 57a63692f5f533077df12677bbdf1dfa414ac564f897621d58fa08607e707d1af02fa9a78d7b0493e9340b27f046b2abee779758a0a6c8239e135abe3811da8b
+  metadata.gz: 460305512646f76855effa266fb439083e571f9d14538e2b6417e00fec52859c2311d7ab2e2e44d32164320cb868d8d94e7c3118b2a855fd8270dfbb66303d17
+  data.tar.gz: 9de4c93e2cf39ab24cf0b882b7c23291f812d9685fb6618b8787f425433288c1c3b9d4f3208118abedf54a193d01715734b3edbd523a8e694840a4eecd1230ba

data/README.md

@@ -125,6 +125,12 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+In order to run a specific test, use the following command:
+
+```bash
+m test/erb/test_formatter.rb:123
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/nebulab/erb-formatter.

data/erb-formatter.gemspec

@@ -29,4 +29,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "syntax_tree", '~> 6.0'
+
+  spec.add_development_dependency "tailwindcss-rails", "~> 2.0"
+  spec.add_development_dependency "m", "~> 1.0"
 end

data/lib/erb/formatter/command_line.rb

@@ -3,6 +3,19 @@ require 'erb/formatter'
 require 'optparse'
 
 class ERB::Formatter::CommandLine
+  def self.tailwindcss_class_sorter(css_path)
+    css = File.read(css_path)
+
+    css = css.tr("\n", " ").gsub(%r{\/\*.*?\*\/},"") # remove comments
+    css = css.gsub(%r<@media.*?\{>, "") # strip media queries
+    css = css.scan(%r<(?:^|\}|\{) *(\S.*?) *\{>).join(" ") # extract selectors
+    classes = css.tr(","," ").split(" ").grep(/\./).uniq.map { _1.split('.').last.gsub("\\", "") }
+    indexed_classes = Hash[classes.zip((0...classes.size).to_a)]
+
+    ->(class_name) do
+      indexed_classes[class_name] || classes.index { _1.start_with?(class_name) } || -1
+    end
+  end
 
   attr_reader :write, :filename, :read_stdin
 
@@ -41,6 +54,10 @@ class ERB::Formatter::CommandLine
         @single_class_per_line = value
       end
 
+      parser.on("--tailwind-output-path PATH", "Set the path to the tailwind output file") do |value|
+        @tailwind_output_path = value
+      end
+
       parser.on("--[no-]debug", "Enable debug mode") do |value|
         $DEBUG = value
       end
@@ -61,10 +78,6 @@ class ERB::Formatter::CommandLine
     @ignore_list ||= ERB::Formatter::IgnoreList.new
   end
 
-  def ignore?(filename)
-
-  end
-
   def run
     if read_stdin
       abort "Can't read both stdin and a list of files" unless @argv.empty?
@@ -77,11 +90,21 @@ class ERB::Formatter::CommandLine
       end
     end
 
+    if @tailwind_output_path
+      css_class_sorter = self.class.tailwindcss_class_sorter(@tailwind_output_path)
+    end
+
     files.each do |(filename, code)|
       if ignore_list.should_ignore_file? filename
         print code unless write
       else
-        html = ERB::Formatter.new(code, filename: filename, line_width: @width || 80, single_class_per_line: @single_class_per_line)
+        html = ERB::Formatter.new(
+          code,
+          filename: filename,
+          line_width: @width || 80,
+          single_class_per_line: @single_class_per_line,
+          css_class_sorter: css_class_sorter
+        )
 
         if write
           File.write(filename, html)

data/lib/erb/formatter/version.rb

@@ -3,5 +3,5 @@
 require 'erb'
 
 class ERB::Formatter
-  VERSION = "0.5.1"
+  VERSION = "0.7.0"
 end

data/lib/erb/formatter.rb

@@ -9,6 +9,7 @@ require 'securerandom'
 require 'erb/formatter/version'
 
 require 'syntax_tree'
+require 'syntax_tree/plugin/trailing_comma'
 
 class ERB::Formatter
   module SyntaxTreeCommandPatch
@@ -47,10 +48,17 @@ class ERB::Formatter
 
   SELF_CLOSING_TAG = /\A(area|base|br|col|command|embed|hr|img|input|keygen|link|menuitem|meta|param|source|track|wbr)\z/i
 
-  RUBY_OPEN_BLOCK = ->(code) do
-    # is nil when the parsing is broken, meaning it's an open expression
-    Ripper.sexp(code).nil?
-  end.freeze
+  begin
+    require 'prism' # ruby 3.3
+    RUBY_OPEN_BLOCK = Prism.method(:parse_failure?)
+  rescue LoadError
+    require 'ripper'
+    RUBY_OPEN_BLOCK = ->(code) do
+      # is nil when the parsing is broken, meaning it's an open expression
+      Ripper.sexp(code).nil?
+    end.freeze
+  end
+
   RUBY_CLOSE_BLOCK = /\Aend\z/
   RUBY_REOPEN_BLOCK = /\A(else|elsif\b(.*)|when\b(.*))\z/
 
@@ -67,7 +75,7 @@ class ERB::Formatter
     new(source, filename: filename).html
   end
 
-  def initialize(source, line_width: 80, single_class_per_line: false, filename: nil, debug: $DEBUG)
+  def initialize(source, line_width: 80, single_class_per_line: false, filename: nil, css_class_sorter: nil, debug: $DEBUG)
     @original_source = source
     @filename = filename || '(erb)'
     @line_width = line_width
@@ -75,6 +83,7 @@ class ERB::Formatter
     @html = +""
     @debug = debug
     @single_class_per_line = single_class_per_line
+    @css_class_sorter = css_class_sorter
 
     html.extend DebugShovel if @debug
 
@@ -117,7 +126,9 @@ class ERB::Formatter
     return "" if attrs.strip.empty?
 
     plain_attrs = attrs.tr("\n", " ").squeeze(" ").gsub(erb_tags_regexp, erb_tags)
-    return " #{plain_attrs}" if "<#{tag_name} #{plain_attrs}#{tag_closing}".size <= line_width
+    within_line_width = "<#{tag_name} #{plain_attrs}#{tag_closing}".size <= line_width
+
+    return " #{plain_attrs}" if within_line_width && !@css_class_sorter && !plain_attrs.match?(/ class=/)
 
     attr_html = ""
     tag_stack_push(['attr='], attrs)
@@ -132,8 +143,10 @@ class ERB::Formatter
       end
 
       value_parts = value[1...-1].strip.split(/\s+/)
+      value_parts.sort_by!(&@css_class_sorter) if name == 'class' && @css_class_sorter
 
-      full_attr = indented("#{name}=#{value[0]}#{value_parts.join(" ")}#{value[-1]}")
+      full_attr = "#{name}=#{value[0]}#{value_parts.join(" ")}#{value[-1]}"
+      full_attr = within_line_width ? " #{full_attr}" : indented(full_attr)
 
       if full_attr.size > line_width && MULTILINE_ATTR_NAMES.include?(name) && attr.match?(QUOTED_ATTR)
         attr_html << indented("#{name}=#{value[0]}")
@@ -157,14 +170,14 @@ class ERB::Formatter
         end
 
         tag_stack_pop('attr"', value)
-        attr_html << indented(value[-1])
+        attr_html << (within_line_width ? value[-1] : indented(value[-1]))
       else
         attr_html << full_attr
       end
     end
 
     tag_stack_pop(['attr='], attrs)
-    attr_html << indented("")
+    attr_html << indented("") unless within_line_width
     attr_html
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erb-formatter
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Elia Schito
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-01 00:00:00.000000000 Z
+date: 2023-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: syntax_tree
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: tailwindcss-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description:
 email:
 - elia@schito.me
@@ -68,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.23
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Format ERB files with speed and precision.