erb-formatter 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74ce05292fc99dcfeb80526b22aa762325c40589640086886190cf40d534facd
-  data.tar.gz: faecec389f0cd92c85e1300d9c32920ac76f508e0fc37b7c2e6a5449b5d7db35
+  metadata.gz: 30ad88d7ebea80bf22ba7b6801a3ed030803b64725d618df54570442b351987d
+  data.tar.gz: 64f2fb608592b02e4ca2ba009495eaba662bd09dba8da215f88a8800b9f14915
 SHA512:
-  metadata.gz: 13dfae2c05ecbb7f283ed1e76e1239dbad2923f1b0bc63b5d67e8de229ea3dfd97fe11d3d51734a2a33382a0d5a566dd16e8b2d8c73cc334eb8e424b685a7e3b
-  data.tar.gz: 64b9b47e1a6dd2c324c8167daf9dafcc0126950e0ae509088e19abc9ffb51b14bfd21cefb98aaf538e2c4a46bf5073fbab90c187e02e7831aa32024d55529ca1
+  metadata.gz: 5fc9ffcb7b3539d287f4cb318ebafdd8fcc422d6cb1e93950f5d39d28ff0febe1754212204eccdc657461a97329673f43556e483c281d0ecd8cc1df53a4755d8
+  data.tar.gz: 7a7313fd434fa69f286f4cab42d2a5ee4739dcc0a555acadf9727a1bb9f4ebbf3f063384d2c1eb923908aa9e82b74984a25e48dee15bc3343a68856be5943d3d

data/README.md

@@ -6,7 +6,7 @@ Features:
 
 - very fast
 - attempts to limit length (configurable)
-- tries to have an ouput similar to prettier for HTML
+- tries to have an output similar to prettier for HTML
 - indents correctly ruby blocks (e.g. `if`/`elsif`/`do`/`end`)
 - designed to be integrated into editors and commit hooks
 - gives meaningful output in case of errors (most of the time)
@@ -19,19 +19,13 @@ Roadmap:
 - more ruby reformatting capabilities
 - JavaScript and CSS formatting
 - VSCode plugin
+- fix spaces after attribute equal signs instead of complaining
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'erb-formatter'
-gem 'rufo' # for enabling minimal ruby re-formatting
-```
-
-And then execute:
-
-    $ bundle install
+    $ bundle add erb-formatter
 
 Or install it yourself as:
 
@@ -41,6 +35,12 @@ Or install it yourself as:
 
 ### From the command line
 
+Update files in-place:
+
+    $ erb-format app/views/**/*.html.erb --write
+
+or use stdin/stdout (useful for editor integrations): 
+
     $ echo "<div       > asdf  <% if 123%> <%='foobar'%> <%end-%>  </div>" | erb-format --stdin
     <div>
       asdf
@@ -49,7 +49,6 @@ Or install it yourself as:
       <% end -%>
     </div>
 
-
 Check out `erb-format --help` for more options.
 
 ### From Ruby

data/erb-formatter.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "lib/erb/formatter"
+require_relative "lib/erb/formatter/version"
 
 Gem::Specification.new do |spec|
   spec.name = "erb-formatter"
@@ -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_development_dependency "rufo"
+  spec.add_dependency "syntax_tree", '~> 5.0'
 end

data/exe/erb-format

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env ruby -W:no-experimental
 
 require 'erb/formatter/command_line'
 

data/exe/erb-formatter

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env ruby -W:no-experimental
 
 require 'erb/formatter/command_line'
 

data/lib/erb/formatter/command_line.rb

@@ -33,6 +33,10 @@ class ERB::Formatter::CommandLine
         @filename ||= '-'
       end
 
+      parser.on("--print-width WIDTH", Integer, "Set the formatted output width") do |value|
+        @width = value
+      end
+
       parser.on("--[no-]debug", "Enable debug mode") do |value|
         $DEBUG = value
       end
@@ -41,6 +45,11 @@ class ERB::Formatter::CommandLine
         puts parser
         exit
       end
+
+      parser.on("-v", "--version", "Show ERB::Formatter version number and quit") do
+        puts "ERB::Formatter #{ERB::Formatter::VERSION}"
+        exit
+      end
     end.parse!(@argv)
   end
 
@@ -68,7 +77,7 @@ class ERB::Formatter::CommandLine
       if ignore_list.should_ignore_file? filename
         print code unless write
       else
-        html = ERB::Formatter.format(code, filename: filename)
+        html = ERB::Formatter.new(code, filename: filename, line_width: @width || 80)
 
         if write
           File.write(filename, html)

data/lib/erb/formatter/ignore_list.rb

@@ -1,7 +1,7 @@
 class ERB::Formatter::IgnoreList
   def initialize(contents: nil, base_dir: Dir.pwd)
     ignore_list_path = "#{base_dir}/.format-erb-ignore"
-    @contents = contents || (File.exists?(ignore_list_path) ? File.read(ignore_list_path) : '')
+    @contents = contents || (File.exist?(ignore_list_path) ? File.read(ignore_list_path) : '')
     @ignore_list = @contents.lines
   end
 
@@ -12,4 +12,3 @@ class ERB::Formatter::IgnoreList
     end
   end
 end
-

data/lib/erb/formatter/version.rb

@@ -1,3 +1,7 @@
 # frozen_string_literal: true
 
-require 'erb/formatter'
+require 'erb'
+
+class ERB::Formatter
+  VERSION = "0.4.1"
+end

data/lib/erb/formatter.rb

@@ -6,9 +6,20 @@ require "ripper"
 require 'securerandom'
 require 'strscan'
 require 'stringio'
+require 'erb/formatter/version'
+
+require 'syntax_tree'
 
 class ERB::Formatter
-  VERSION = "0.3.0"
+  module SyntaxTreeCommandPatch
+    def format(q)
+      q.group do
+        q.format(message)
+        q.text(" ")
+        q.format(arguments) # WAS: q.nest(message.value.length + 1) { q.format(arguments) }
+      end
+    end
+  end
 
   autoload :IgnoreList, 'erb/formatter/ignore_list'
 
@@ -67,7 +78,7 @@ class ERB::Formatter
     @original_source = source
     @filename = filename || '(erb)'
     @line_width = line_width
-    @source = source.dup
+    @source = remove_front_matter source.dup
     @html = +""
     @debug = debug
 
@@ -92,6 +103,13 @@ class ERB::Formatter
     freeze
   end
 
+  def remove_front_matter(source)
+    source.sub(/\A---\n[\s\S]*?\n---\n/) do |match|
+      @front_matter = match
+      match.gsub(/[^\n]/, ' ')
+    end
+  end
+
   attr_accessor \
     :source, :html, :tag_stack, :pre_pos, :pre_placeholders, :erb_tags, :erb_tags_regexp,
     :pre_placeholders_regexp, :tags_regexp, :line_width
@@ -153,7 +171,6 @@ class ERB::Formatter
           html << (erb_pre_match.match?(/\s+\z/) ? indented(full_erb_tag) : full_erb_tag)
           tag_stack_push('%erb%', ruby_code)
         when ERB_OPEN_BLOCK
-          ruby_code = format_ruby(ruby_code, autoclose: true)
           html << (erb_pre_match.match?(/\s+\z/) ? indented(full_erb_tag) : full_erb_tag)
           tag_stack_push('%erb%', ruby_code)
         else
@@ -197,13 +214,16 @@ class ERB::Formatter
     super error
   end
 
-  def indented(string)
+  def indented(string, strip: true)
+    string = string.strip if strip
     indent = "  " * tag_stack.size
-    "\n#{indent}#{string.strip}"
+    "\n#{indent}#{string}"
   end
 
   def format_text(text)
     p format_text: text if @debug
+    return unless text
+
     starting_space = text.match?(/\A\s/)
 
     final_newlines_count = text.match(/(\s*)\z/m).captures.last.count("\n")
@@ -236,30 +256,6 @@ class ERB::Formatter
     end
   end
 
-  def format_code_with_rubocop(code, line_width)
-    stdin, stdout = $stdin, $stdout
-    $stdin = StringIO.new(code)
-    $stdout = StringIO.new
-
-    Thread.current['RuboCop::Cop::Layout::LineLength#max'] = line_width
-
-    @rubocop_cli ||= begin
-      RuboCop::Cop::Layout::LineLength.prepend self
-      RuboCop::CLI.new
-    end
-
-    @rubocop_cli.run([
-      '--auto-correct',
-      '--stdin', @filename,
-      '-f', 'quiet',
-    ])
-
-    $stdout.string.split(RUBOCOP_STDIN_MARKER, 2).last
-  ensure
-    $stdin, $stdout = stdin, stdout
-    Thread.current['RuboCop::Cop::Layout::LineLength#max'] = nil
-  end
-
   def format_ruby(code, autoclose: false)
     if autoclose
       code += "\nend" unless ERB_OPEN_BLOCK["#{code}\nend"]
@@ -267,16 +263,17 @@ class ERB::Formatter
     end
     p RUBY_IN_: code if @debug
 
-    offset = tag_stack.size * 2
-    if defined? Rubocop
-      code = format_code_with_rubocop(code, line_width - offset) if (offset + code.size) > line_width
-    elsif defined?(Rufo)
-      code = Rufo.format(code) rescue code
+    SyntaxTree::Command.prepend SyntaxTreeCommandPatch
+
+    code = begin
+      SyntaxTree.format(code)
+    rescue SyntaxTree::Parser::ParseError
+      code
     end
 
     lines = code.strip.lines
     lines = lines[0...-1] if autoclose
-    code = lines.map { |l| indented(l) }.join.strip
+    code = lines.map { |l| indented(l.chomp("\n"), strip: false) }.join.strip
     p RUBY_OUT: code if @debug
     code
   end
@@ -294,7 +291,7 @@ class ERB::Formatter
       if erb_scanner.scan_until(erb_tags_regexp)
         p PRE_MATCH: [erb_pre_pos, '..', erb_scanner.pre_match] if @debug
         erb_pre_match = erb_scanner.pre_match
-        erb_pre_match = erb_pre_match[erb_pre_pos..]
+        erb_pre_match = erb_pre_match[erb_pre_pos..].to_s
         erb_pre_pos = erb_scanner.pos
 
         erb_code = erb_tags[erb_scanner.captures.first]
@@ -303,22 +300,24 @@ class ERB::Formatter
 
         erb_open, ruby_code, erb_close = ERB_TAG.match(erb_code).captures
         erb_open << ' ' unless ruby_code.start_with?('#')
-        full_erb_tag = "#{erb_open}#{ruby_code} #{erb_close}"
 
         case ruby_code
         when /\Aend\z/
+          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/
+          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
-          ruby_code = format_ruby(ruby_code, autoclose: true)
+          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)
         else
           ruby_code = format_ruby(ruby_code, autoclose: false)
+          full_erb_tag = "#{erb_open}#{ruby_code} #{erb_close}"
           html << (erb_pre_match.match?(/\s+\z/) ? indented(full_erb_tag) : full_erb_tag)
         end
       else
@@ -335,7 +334,7 @@ class ERB::Formatter
 
     until scanner.eos?
       if matched = scanner.scan_until(tags_regexp)
-        p format_pre_match: [pre_pos, '..', scanner.pre_match[pre_pos..]]  if @debug
+        p format_pre_match: [pre_pos, '..', scanner.pre_match[pre_pos..]] if @debug
         pre_match = scanner.pre_match[pre_pos..]
         p POS: pre_pos...scanner.pos, advanced: source[pre_pos...scanner.pos] if @debug
         p MATCHED: matched if @debug
@@ -378,6 +377,7 @@ class ERB::Formatter
     html.gsub!(erb_tags_regexp, erb_tags)
     html.gsub!(pre_placeholders_regexp, pre_placeholders)
     html.strip!
+    html.prepend @front_matter + "\n" if @front_matter
     html << "\n"
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: erb-formatter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Elia Schito
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-07 00:00:00.000000000 Z
+date: 2023-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rufo
+  name: syntax_tree
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '5.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 description:
 email:
 - elia@schito.me