erb-formatter 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b90b39bdcbed3837f51229bc9c840b0bd44d61fa48eace4e2c7b32aedcb90e3c
-  data.tar.gz: d42ecb4464e92ceb46b9d266647db19c88540b369acb8585bec5800b4f0d6617
+  metadata.gz: 93f3695219c717c8c307ccecad4141890ed86c11c397e36af0e569a24e303fd4
+  data.tar.gz: 67b9bd4f85b75b3ba8aaa18f370df3fa9f9f178f561aa02b4b1def6d04f6b8c2
 SHA512:
-  metadata.gz: 7e7ba4c9ad276e45a2ad557000fe565ed66bc9205a7aabaf432d5a99dd693758c73a7975fbe0a770fe0becd9f66be294d0f2bf168b1249b3fd4d416e20770611
-  data.tar.gz: 0fed7945792aa4ad161c6b784796703c00b0aef7c69c61f4d77d4cfedbfae71ee76b1d2b7eeb106e6f3ec633031878dff5fd033605d7e61e0875ce1a3902b30d
+  metadata.gz: 1cf1a5c6d0cdf543b18d0203daa82e532168b1665b9343a066b40a20a60d0236a442ce018337814b079ae7f0d094e3a6583b2862659bccbc9de64ae02ce5cdbe
+  data.tar.gz: 1694c549a0ad05b6495b9632e3941179b62437892ee7e3c0e3712839ac23ae1056a2bc12c1f445ca8499d42448810e5eb2ba117498f296a9685cade08ff48426

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,69 +1,5 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env ruby -W:no-experimental
 
-require 'optparse'
-
-write, filename, read_stdin, code = nil
-
-OptionParser.new do |parser|
-  parser.banner = "Usage: #{$0} FILENAME... --write"
-
-  parser.on("-w", "--[no-]write", "Write file") do |value|
-    write = value
-  end
-
-  parser.on("--stdin-filename FILEPATH", "Set the stdin filename (implies --stdin)") do |value|
-    filename = value
-    read_stdin = true
-  end
-
-  parser.on("--[no-]stdin", "Read the file from stdin") do |value|
-    if read_stdin == true && value == false
-      abort "Can't set stdin filename and not use stdin at the same time"
-    end
-
-    read_stdin = value
-    filename ||= '-'
-  end
-
-  parser.on("--[no-]debug", "Enable debug mode") do |value|
-    $DEBUG = value
-  end
-
-  parser.on("-h", "--help", "Prints this help") do
-    puts parser
-    exit
-  end
-end.parse!(ARGV)
-
-abort "Can't read both stdin and a list of files" if read_stdin && !ARGV.empty?
-
-# If multiple files are provided assume `--write` and
-# execute on each of them.
-if ARGV.size > 1
-  ARGV.each do |arg|
-    warn "==> Formatting #{arg}..."
-    system __FILE__, arg, *[
-      ('--write' if write)
-    ].compact or exit(1)
-  end
-  exit
-end
-
-require 'erb/formatter'
-
-filename ||= ARGV.first
-code = read_stdin ? $stdin.read : File.read(filename)
-ignore = ERB::Formatter::IgnoreList.new
-
-if ignore.should_ignore_file? filename
-  print code unless write
-else
-  html = ERB::Formatter.format(code, filename: filename)
-
-  if write
-    File.write(filename, html)
-  else
-    puts html
-  end
-end
+require 'erb/formatter/command_line'
 
+ERB::Formatter::CommandLine.new(ARGV).run

data/exe/erb-formatter

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby -W:no-experimental
+
+require 'erb/formatter/command_line'
+
+ERB::Formatter::CommandLine.new(ARGV).run

data/lib/erb/formatter/command_line.rb

@@ -0,0 +1,90 @@
+
+require 'erb/formatter'
+require 'optparse'
+
+class ERB::Formatter::CommandLine
+
+  attr_reader :write, :filename, :read_stdin
+
+  def initialize(argv, stdin: $stdin)
+    @argv = argv.dup
+    @stdin = stdin
+
+    @write, @filename, @read_stdin, @code = nil
+
+    OptionParser.new do |parser|
+      parser.banner = "Usage: #{$0} FILENAME... --write"
+
+      parser.on("-w", "--[no-]write", "Write file") do |value|
+        @write = value
+      end
+
+      parser.on("--stdin-filename FILEPATH", "Set the stdin filename (implies --stdin)") do |value|
+        @filename = value
+        @read_stdin = true
+      end
+
+      parser.on("--[no-]stdin", "Read the file from stdin") do |value|
+        if read_stdin == true && value == false
+          abort "Can't set stdin filename and not use stdin at the same time"
+        end
+
+        @read_stdin = value
+        @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
+
+      parser.on("-h", "--help", "Prints this help") do
+        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
+
+  def ignore_list
+    @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?
+      files = [
+        [@filename, @stdin.read]
+      ]
+    else
+      files = @argv.map do |filename|
+        [filename, File.read(filename)]
+      end
+    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)
+
+        if write
+          File.write(filename, html)
+        else
+          puts html
+        end
+      end
+    end
+  end
+end

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.0"
+end

data/lib/erb/formatter.rb

@@ -1,13 +1,26 @@
 # frozen_string_literal: false
 
+require 'pp'
 require "erb"
 require "ripper"
 require 'securerandom'
 require 'strscan'
 require 'stringio'
+require 'erb/formatter/version'
+
+require 'syntax_tree'
 
 class ERB::Formatter
-  VERSION = "0.2.2"
+  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'
 
   class Error < StandardError; end
@@ -65,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
 
@@ -90,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
@@ -151,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
@@ -195,9 +214,10 @@ 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)
@@ -234,30 +254,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"]
@@ -265,16 +261,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
@@ -301,22 +298,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
@@ -333,14 +332,14 @@ 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
         self.pre_pos = scanner.charpos
 
         # Don't accept `name= "value"` attributes
-        raise "Bad attribute, please fix spaces after the equal sign." if BAD_ATTR.match? pre_match
+        raise "Bad attribute, please fix spaces after the equal sign:\n#{pre_match}" if BAD_ATTR.match? pre_match
 
         format_erb_tags(pre_match) if pre_match
 
@@ -376,6 +375,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,34 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: erb-formatter
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Elia Schito
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-23 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
 executables:
 - erb-format
+- erb-formatter
 extensions: []
 extra_rdoc_files: []
 files:
@@ -39,7 +40,9 @@ files:
 - Rakefile
 - erb-formatter.gemspec
 - exe/erb-format
+- exe/erb-formatter
 - lib/erb/formatter.rb
+- lib/erb/formatter/command_line.rb
 - lib/erb/formatter/ignore_list.rb
 - lib/erb/formatter/version.rb
 - sig/erb/formatter.rbs