erb-formatter 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddc79db481ece2c7a1a3c3dedbce6f65f176ad045805125cbd997fdaf5f4fb11
-  data.tar.gz: e27fe52c37feb8fe80386af2fb0083a5b6398a9319189ec0baec5251db4a1a31
+  metadata.gz: ba78d2f06a198fd4f9af049e11a4f0ec92fcfa56e16688eaa65b3ea9253320ca
+  data.tar.gz: 5d06c40737f856c445cf70fd530639e8876c60dad08d9fdc91acc12e42c9e086
 SHA512:
-  metadata.gz: 3e08e5783a5315111f5bbe0acc0f8d819b7e8b80f0a6626ec6283006441005dcba10526282ea6d331b54e7e6fc56c8a24cecb93c235f11b2394448195cf2f264
-  data.tar.gz: 5ca38f5fd851e57056a87490d5f668a0fa2a9374e6ff46cf0efe7b6cb39af0dc813e0026cee9bf7fc57f99a86833c5385979e1b0bd8c2d03a7d83f969daf494f
+  metadata.gz: 4997b2e942b1fe2ed3a0bf0b0e828ba7565090bf781508accd4d64540e90b986d7d0414534e066cd149d56d8d208342dd20c6ac1ba749498e03b080d4e799a10
+  data.tar.gz: 59901e642196b0538e88379384d655a8f6a174007ba30fa7829b25db829cedbc8bcb94ef80e58b026e6223cc166fa442db798c84a18d38baecf5c36d63cee3cf

data/README.md

@@ -33,13 +33,18 @@ Or install it yourself as:
 
 ## Usage
 
+### From [Visual Studio Code](https://code.visualstudio.com)
+
+Just install the [Ruby ERB::Formatter 🪜](https://marketplace.visualstudio.com/items?itemName=elia.erb-formatter) extension
+and follow the setup instructions there.
+
 ### From the command line
 
 Update files in-place:
 
     $ erb-format app/views/**/*.html.erb --write
 
-or use stdin/stdout (useful for editor integrations): 
+or use stdin/stdout (useful for editor integrations):
 
     $ echo "<div       > asdf  <% if 123%> <%='foobar'%> <%end-%>  </div>" | erb-format --stdin
     <div>
@@ -51,7 +56,7 @@ or use stdin/stdout (useful for editor integrations):
 
 Check out `erb-format --help` for more options.
 
-### From Ruby
+### From [Ruby](https://www.ruby-lang.org/en/)
 
 ```ruby
 require 'erb/formatter'
@@ -76,7 +81,7 @@ ERB
 #   </div>
 ```
 
-### With `lint-staged`
+### With [`lint-staged`](https://github.com/okonet/lint-staged#readme)
 
 Add the gem to your gemfile and the following to your `package.json`:
 
@@ -87,7 +92,7 @@ Add the gem to your gemfile and the following to your `package.json`:
 }
 ```
 
-### As a TextMate plugin
+### As a [TextMate](http://macromates.com) command
 
 Create a command with the following settings:
 
@@ -104,6 +109,16 @@ cd "$TM_PROJECT_DIRECTORY"
 bundle exec erb-format --stdin-filename "$TM_FILEPATH" < /dev/stdin 2> /dev/stdout
 ```
 
+### With [(Neo)VIM ALE](https://github.com/dense-analysis/ale)
+
+Enable `erb-formatter` as a fixer in the ALE config:
+
+```vim
+let g:ale_fixers = {
+\   'eruby': ['erb-formatter'],
+\}
+```
+
 ## 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.

data/erb-formatter.gemspec

@@ -28,5 +28,5 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "syntax_tree", '~> 5.0'
+  spec.add_dependency "syntax_tree", '~> 6.0'
 end

data/lib/erb/formatter/command_line.rb

@@ -10,7 +10,7 @@ class ERB::Formatter::CommandLine
     @argv = argv.dup
     @stdin = stdin
 
-    @write, @filename, @read_stdin, @code = nil
+    @write, @filename, @read_stdin, @code, @single_class_per_line = nil
 
     OptionParser.new do |parser|
       parser.banner = "Usage: #{$0} FILENAME... --write"
@@ -37,6 +37,10 @@ class ERB::Formatter::CommandLine
         @width = value
       end
 
+      parser.on("--single-class-per-line", "Print each class on a separate line") do |value|
+        @single_class_per_line = value
+      end
+
       parser.on("--[no-]debug", "Enable debug mode") do |value|
         $DEBUG = value
       end
@@ -77,7 +81,7 @@ class ERB::Formatter::CommandLine
       if ignore_list.should_ignore_file? filename
         print code unless write
       else
-        html = ERB::Formatter.new(code, filename: filename, line_width: @width || 80)
+        html = ERB::Formatter.new(code, filename: filename, line_width: @width || 80, single_class_per_line: @single_class_per_line)
 
         if write
           File.write(filename, html)

data/lib/erb/formatter/version.rb

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

data/lib/erb/formatter.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: false
 
 require 'pp'
-require "erb"
-require "ripper"
-require 'securerandom'
+require 'erb'
+require 'yaml'
 require 'strscan'
 require 'stringio'
+require 'securerandom'
 require 'erb/formatter/version'
 
 require 'syntax_tree'
@@ -38,8 +38,6 @@ class ERB::Formatter
 
   ERB_TAG = %r{(<%(?:==|=|-|))\s*(.*?)\s*(-?%>)}m
   ERB_PLACEHOLDER = %r{erb[a-z0-9]+tag}
-  ERB_END = %r{(<%-?)\s*(end)\s*(-?%>)}
-  ERB_ELSE = %r{(<%-?)\s*(else|elsif\b.*)\s*(-?%>)}
 
   TAG_NAME = /[a-z0-9_:-]+/
   TAG_NAME_ONLY = /\A#{TAG_NAME}\z/
@@ -49,20 +47,15 @@ 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
 
-  ERB_OPEN_BLOCK = ->(code) do
+  RUBY_OPEN_BLOCK = ->(code) do
     # is nil when the parsing is broken, meaning it's an open expression
     Ripper.sexp(code).nil?
   end.freeze
+  RUBY_CLOSE_BLOCK = /\Aend\z/
+  RUBY_REOPEN_BLOCK = /\A(else|elsif\b(.*)|when\b(.*))\z/
 
   RUBOCOP_STDIN_MARKER = "===================="
 
-  # Override the max line length to account from already indented ERB
-  module RubocopForcedMaxLineLength
-    def max
-      Thread.current['RuboCop::Cop::Layout::LineLength#max'] || super
-    end
-  end
-
   module DebugShovel
     def <<(string)
       puts "ADDING: #{string.inspect} FROM:\n  #{caller(1, 5).join("\n  ")}"
@@ -74,13 +67,14 @@ class ERB::Formatter
     new(source, filename: filename).html
   end
 
-  def initialize(source, line_width: 80, filename: nil, debug: $DEBUG)
+  def initialize(source, line_width: 80, single_class_per_line: false, filename: nil, debug: $DEBUG)
     @original_source = source
     @filename = filename || '(erb)'
     @line_width = line_width
     @source = remove_front_matter source.dup
     @html = +""
     @debug = debug
+    @single_class_per_line = single_class_per_line
 
     html.extend DebugShovel if @debug
 
@@ -104,10 +98,13 @@ class ERB::Formatter
   end
 
   def remove_front_matter(source)
-    source.sub(/\A---\n[\s\S]*?\n---\n/) do |match|
-      @front_matter = match
-      match.gsub(/[^\n]/, ' ')
-    end
+    return source unless source.start_with?("---\n")
+
+    first_body_line = YAML.parse(source).children.first.end_line + 1
+    lines = source.lines
+
+    @front_matter = lines[0...first_body_line].join
+    lines[first_body_line..].join
   end
 
   attr_accessor \
@@ -124,6 +121,7 @@ class ERB::Formatter
 
     attr_html = ""
     tag_stack_push(['attr='], attrs)
+
     attrs.scan(ATTR).flatten.each do |attr|
       attr.strip!
       full_attr = indented(attr)
@@ -132,59 +130,38 @@ class ERB::Formatter
       if full_attr.size > line_width && MULTILINE_ATTR_NAMES.include?(name) && attr.match?(QUOTED_ATTR)
         attr_html << indented("#{name}=#{value[0]}")
         tag_stack_push('attr"', value)
-        value[1...-1].strip.split(/\s+/).each do |value_part|
-          attr_html << indented(value_part)
+
+        value_parts = value[1...-1].strip.split(/\s+/)
+
+        if !@single_class_per_line && name == 'class'
+          line = value_parts.shift
+          value_parts.each do |value_part|
+            if (line.size + value_part.size + 1) <= line_width
+              line << " #{value_part}"
+            else
+              attr_html << indented(line)
+              line = value_part
+            end
+          end
+          attr_html << indented(line) if line
+        else
+          value_parts.each do |value_part|
+            attr_html << indented(value_part)
+          end
         end
+
         tag_stack_pop('attr"', value)
         attr_html << indented(value[-1])
       else
         attr_html << full_attr
       end
     end
+
     tag_stack_pop(['attr='], attrs)
     attr_html << indented("")
     attr_html
   end
 
-  def format_erb_attributes(string)
-    erb_scanner = StringScanner.new(string.to_s)
-    erb_pre_pos = 0
-    until erb_scanner.eos?
-      if erb_scanner.scan_until(erb_tags_regexp)
-        erb_pre_match = erb_scanner.pre_match
-        erb_pre_match = erb_pre_match[erb_pre_pos..]
-        erb_pre_pos = erb_scanner.pos
-
-        erb_code = erb_tags[erb_scanner.captures.first]
-
-        format_attributes(erb_pre_match)
-
-        erb_open, ruby_code, erb_close = ERB_TAG.match(erb_code).captures
-        full_erb_tag = "#{erb_open} #{ruby_code} #{erb_close}"
-
-        case ruby_code
-        when /\Aend\z/
-          tag_stack_pop('%erb%', ruby_code)
-          html << (erb_pre_match.match?(/\s+\z/) ? indented(full_erb_tag) : full_erb_tag)
-        when /\A(else|elsif\b(.*))\z/
-          tag_stack_pop('%erb%', ruby_code)
-          html << (erb_pre_match.match?(/\s+\z/) ? indented(full_erb_tag) : full_erb_tag)
-          tag_stack_push('%erb%', ruby_code)
-        when ERB_OPEN_BLOCK
-          html << (erb_pre_match.match?(/\s+\z/) ? indented(full_erb_tag) : full_erb_tag)
-          tag_stack_push('%erb%', ruby_code)
-        else
-          ruby_code = format_ruby(ruby_code, autoclose: false)
-          html << (erb_pre_match.match?(/\s+\z/) ? indented(full_erb_tag) : full_erb_tag)
-        end
-      else
-        rest = erb_scanner.rest.to_s
-        format_erb_attributes(rest)
-        erb_scanner.terminate
-      end
-    end
-  end
-
   def tag_stack_push(tag_name, code)
     tag_stack << [tag_name, code]
     p PUSH: tag_stack if @debug
@@ -258,8 +235,8 @@ class ERB::Formatter
 
   def format_ruby(code, autoclose: false)
     if autoclose
-      code += "\nend" unless ERB_OPEN_BLOCK["#{code}\nend"]
-      code += "\n}" unless ERB_OPEN_BLOCK["#{code}\n}"]
+      code += "\nend" unless RUBY_OPEN_BLOCK["#{code}\nend"]
+      code += "\n}" unless RUBY_OPEN_BLOCK["#{code}\n}"]
     end
     p RUBY_IN_: code if @debug
 
@@ -303,16 +280,16 @@ class ERB::Formatter
         erb_open << ' ' unless ruby_code.start_with?('#')
 
         case ruby_code
-        when /\Aend\z/
+        when RUBY_CLOSE_BLOCK
           full_erb_tag = "#{erb_open}#{ruby_code} #{erb_close}"
           tag_stack_pop('%erb%', ruby_code)
           html << (erb_pre_match.match?(/\s+\z/) ? indented(full_erb_tag) : full_erb_tag)
-        when /\A(else|elsif\b(.*))\z/
+        when RUBY_REOPEN_BLOCK
           full_erb_tag = "#{erb_open}#{ruby_code} #{erb_close}"
           tag_stack_pop('%erb%', ruby_code)
           html << (erb_pre_match.match?(/\s+\z/) ? indented(full_erb_tag) : full_erb_tag)
           tag_stack_push('%erb%', ruby_code)
-        when ERB_OPEN_BLOCK
+        when RUBY_OPEN_BLOCK
           full_erb_tag = "#{erb_open}#{ruby_code} #{erb_close}"
           html << (erb_pre_match.match?(/\s+\z/) ? indented(full_erb_tag) : full_erb_tag)
           tag_stack_push('%erb%', ruby_code)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erb-formatter
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Elia Schito
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-03 00:00:00.000000000 Z
+date: 2023-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: syntax_tree
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 description:
 email:
 - elia@schito.me
@@ -68,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.5
+rubygems_version: 3.3.23
 signing_key:
 specification_version: 4
 summary: Format ERB files with speed and precision.