htmlbeautifier 1.3.1 → 1.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b9b315f8ad4b0cf0028ab69db1bdae35dd00c4a4
-  data.tar.gz: b7a5c639356777eca4411779b489382111547a99
+SHA256:
+  metadata.gz: fcd8d466ff4ebc3419c99968d8a82f617c9911c520a4623d649d72a821dcec5c
+  data.tar.gz: 28113c3062ebfcf3dd6cb5d30dfd551d658b6d3061e7127bfb50e5584266266c
 SHA512:
-  metadata.gz: f3f3ff9b529fca273e945ecd9a0463673d967160dc12068604a6764e2df2efab6c69da563b217f874fdb93bcc3c816a10a58ebafa6a17f1fbc4b74790597b169
-  data.tar.gz: b3ff2f097c7d4904538f14995ca2071b3aa27fc63cf057e04c0e43fb4eba42b9d7f76f72f61be78c35fd321df6523e86571d2a6aa3a2a03bbbe55c2a9410fa8a
+  metadata.gz: 0c07ed38537750b35280e3131c9333f5c31deabff6da46f5a333557b8af5c261babda15f98a45f9ea9d8213f14368ad9b671fac38f61e7f7439a3d0edb2bb675
+  data.tar.gz: 76c39b1d92accd12e3b6c354b2214e0da149d7e400d0e66583b6505c498eadd8de79336abfcf90087d1ca9e56c00d6a0ec4b4f211da5924a7546fc65e1d84971

data/README.md

@@ -23,13 +23,13 @@ Ideal for tidying up Rails templates.
 To update files in-place:
 
 ``` sh
-$ htmlbeautifier file1 [file2 ...]
+$ htmlbeautifier file1.html.erb [file2.html.erb ...]
 ```
 
 or to operate on standard input and output:
 
 ``` sh
-$ htmlbeautifier < input > output
+$ htmlbeautifier < untidy.html.erb > formatted.html.erb
 ```
 
 ### In your code
@@ -37,13 +37,13 @@ $ htmlbeautifier < input > output
 ```ruby
 require 'htmlbeautifier'
 
-beautiful = HtmlBeautifier.beautify(messy)
+beautiful = HtmlBeautifier.beautify(untify_html_string)
 ```
 
 You can also specify how to indent (the default is two spaces):
 
 ```ruby
-beautiful = HtmlBeautifier.beautify(messy, indent: "\t")
+beautiful = HtmlBeautifier.beautify(untidy_html_string, indent: "\t")
 ```
 
 ## Installation

data/bin/htmlbeautifier

@@ -1,7 +1,10 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require "htmlbeautifier"
 require "optparse"
 require "fileutils"
+require "stringio"
 
 def beautify(name, input, output, options)
   output.puts HtmlBeautifier.beautify(input, options)
@@ -11,21 +14,21 @@ end
 
 executable = File.basename(__FILE__)
 
-options = { indent: "  " }
+options = {indent: "  "}
 parser = OptionParser.new do |opts|
   opts.banner = "Usage: #{executable} [options] [file ...]"
-  opts.separator <<END
+  opts.separator <<~STRING
 
-#{executable} has two modes of operation:
+    #{executable} has two modes of operation:
 
-1. If no files are listed, it will read from standard input and write to
-   standard output.
-2. If files are listed, it will modify each file in place, overwriting it
-   with the beautified output.
+    1. If no files are listed, it will read from standard input and write to
+       standard output.
+    2. If files are listed, it will modify each file in place, overwriting it
+       with the beautified output.
 
-The following options are available:
+    The following options are available:
 
-END
+  STRING
   opts.on(
     "-t", "--tab-stops NUMBER", Integer,
     "Set number of spaces per indent (default #{options[:tab_stops]})"
@@ -56,6 +59,20 @@ END
   ) do |num|
     options[:keep_blank_lines] = num
   end
+  opts.on(
+    "-l", "--lint-only",
+    "Lint only, error on files which would be modified",
+    "This is not available when reading from standard input"
+  ) do |num|
+    options[:lint_only] = num
+  end
+  opts.on(
+    "-v", "--version",
+    "Display version and exit"
+  ) do
+    puts HtmlBeautifier::VERSION::STRING
+    exit
+  end
   opts.on(
     "-h", "--help",
     "Display this help message and exit"
@@ -64,16 +81,31 @@ END
     exit
   end
 end
+
 parser.parse!
 
 if ARGV.any?
+  failures = []
   ARGV.each do |path|
     input = File.read(path)
-    temppath = path + ".tmp"
-    File.open(temppath, "w") do |output|
+    if options[:lint_only]
+      output = StringIO.new
       beautify path, input, output, options
+      failures << path unless input == output.string
+    else
+      temppath = "#{path}.tmp"
+      File.open(temppath, "w") do |file|
+        beautify path, input, file, options
+      end
+      FileUtils.mv temppath, path
     end
-    FileUtils.mv temppath, path
+  end
+  unless failures.empty?
+    warn [
+      "Lint failed - files would be modified:",
+      *failures
+    ].join("\n")
+    exit 1
   end
 else
   beautify "standard input", $stdin.read, $stdout, options

data/lib/htmlbeautifier/builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "htmlbeautifier/parser"
 require "htmlbeautifier/ruby_indenter"
 
@@ -8,7 +10,7 @@ module HtmlBeautifier
       initial_level: 0,
       stop_on_errors: false,
       keep_blank_lines: 0
-    }
+    }.freeze
 
     def initialize(output, options = {})
       options = DEFAULT_OPTIONS.merge(options)
@@ -23,10 +25,11 @@ module HtmlBeautifier
       @embedded_indenter = RubyIndenter.new
     end
 
-  private
+    private
 
     def error(text)
       return unless @stop_on_errors
+
       raise text
     end
 
@@ -40,9 +43,10 @@ module HtmlBeautifier
     end
 
     def emit(*strings)
+      strings_join = strings.join("")
       @output << "\n" if @new_line && !@empty
-      @output << (@tab * @level) if @new_line
-      @output << strings.join("")
+      @output << (@tab * @level) if @new_line && !strings_join.strip.empty?
+      @output << strings_join
       @new_line = false
       @empty = false
     end
@@ -87,42 +91,42 @@ module HtmlBeautifier
       new_line
     end
 
-    def standalone_element(e)
-      emit e
-      new_line if e =~ %r{^<br[^\w]}
+    def standalone_element(elem)
+      emit elem
+      new_line if elem =~ %r{^<br[^\w]}
     end
 
-    def close_element(e)
+    def close_element(elem)
       outdent
-      emit e
+      emit elem
     end
 
-    def close_block_element(e)
-      close_element e
+    def close_block_element(elem)
+      close_element elem
       new_line
     end
 
-    def open_element(e)
-      emit e
+    def open_element(elem)
+      emit elem
       indent
     end
 
-    def open_block_element(e)
+    def open_block_element(elem)
       new_line
-      open_element e
+      open_element elem
     end
 
-    def close_ie_cc(e)
+    def close_ie_cc(elem)
       if @ie_cc_levels.empty?
         error "Unclosed conditional comment"
       else
         @level = @ie_cc_levels.pop
       end
-      emit e
+      emit elem
     end
 
-    def open_ie_cc(e)
-      emit e
+    def open_ie_cc(elem)
+      emit elem
       @ie_cc_levels.push @level
       indent
     end
@@ -130,12 +134,10 @@ module HtmlBeautifier
     def new_lines(*content)
       blank_lines = content.first.scan(%r{\n}).count - 1
       blank_lines = [blank_lines, @keep_blank_lines].min
-      @output << "\n" * blank_lines
+      @output << ("\n" * blank_lines)
       new_line
     end
 
-    def text(t)
-      emit t
-    end
+    alias_method :text, :emit
   end
 end

data/lib/htmlbeautifier/html_parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "htmlbeautifier/parser"
 
 module HtmlBeautifier
@@ -8,47 +10,49 @@ module HtmlBeautifier
       link | meta | param | source | track | wbr
     )}mix
     HTML_BLOCK_ELEMENTS = %r{(?:
-      address | article | aside | audio | blockquote | canvas | dd | dir | div |
-      dl | dt | fieldset | figcaption | figure | footer | form | h1 | h2 | h3 |
-      h4 | h5 | h6 | header | hr | li | menu | noframes | noscript | ol | p |
-      pre | section | table | tbody | td | tfoot | th | thead | tr | ul | video
+      address | article | aside | audio | blockquote | canvas | dd | details |
+      dir | div | dl | dt | fieldset | figcaption | figure | footer | form |
+      h1 | h2 | h3 | h4 | h5 | h6 | header | hr | li | menu | noframes |
+      noscript | ol | p | pre | section | table | tbody | td | tfoot | th |
+      thead | tr | ul | video
     )}mix
 
     MAPPINGS = [
       [%r{(<%-?=?)(.*?)(-?%>)}om,
-       :embed],
+        :embed],
       [%r{<!--\[.*?\]>}om,
-       :open_ie_cc],
+        :open_ie_cc],
       [%r{<!\[.*?\]-->}om,
-       :close_ie_cc],
+        :close_ie_cc],
       [%r{<!--.*?-->}om,
-       :standalone_element],
+        :standalone_element],
       [%r{<!.*?>}om,
-       :standalone_element],
+        :standalone_element],
       [%r{(<script#{ELEMENT_CONTENT}>)(.*?)(</script>)}omi,
-       :foreign_block],
+        :foreign_block],
       [%r{(<style#{ELEMENT_CONTENT}>)(.*?)(</style>)}omi,
-       :foreign_block],
+        :foreign_block],
       [%r{(<pre#{ELEMENT_CONTENT}>)(.*?)(</pre>)}omi,
-       :preformatted_block],
+        :preformatted_block],
       [%r{(<textarea#{ELEMENT_CONTENT}>)(.*?)(</textarea>)}omi,
-       :preformatted_block],
+        :preformatted_block],
       [%r{<#{HTML_VOID_ELEMENTS}(?: #{ELEMENT_CONTENT})?/?>}om,
-       :standalone_element],
-      [%r{<\w+(?: #{ELEMENT_CONTENT})?/>}om,
-       :standalone_element],
+        :standalone_element],
       [%r{</#{HTML_BLOCK_ELEMENTS}>}om,
-       :close_block_element],
+        :close_block_element],
       [%r{<#{HTML_BLOCK_ELEMENTS}(?: #{ELEMENT_CONTENT})?>}om,
-       :open_block_element],
+        :open_block_element],
       [%r{</#{ELEMENT_CONTENT}>}om,
-       :close_element],
-      [%r{<#{ELEMENT_CONTENT}>}om,
-       :open_element],
+        :close_element],
+      [%r{<#{ELEMENT_CONTENT}[^/]>}om,
+        :open_element],
+      [%r{<[\w\-]+(?: #{ELEMENT_CONTENT})?/>}om,
+        :standalone_element],
       [%r{(\s*\r?\n\s*)+}om,
-       :new_lines],
+        :new_lines],
       [%r{[^<\n]+},
-       :text]]
+        :text]
+    ].freeze
 
     def initialize
       super do |p|

data/lib/htmlbeautifier/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "strscan"
 
 module HtmlBeautifier
@@ -24,18 +26,20 @@ module HtmlBeautifier
       [source_so_far.chomp.split(%r{\n}).count, 1].max
     end
 
-  private
+    private
 
     def dispatch(receiver)
       _, method = @maps.find { |pattern, _| @scanner.scan(pattern) }
       raise "Unmatched sequence" unless method
+
       receiver.__send__(method, *extract_params(@scanner))
-    rescue => ex
-      raise "#{ex.message} on line #{source_line_number}"
+    rescue => e
+      raise "#{e.message} on line #{source_line_number}"
     end
 
     def extract_params(scanner)
       return [scanner[0]] unless scanner[1]
+
       params = []
       i = 1
       while scanner[i]

data/lib/htmlbeautifier/ruby_indenter.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module HtmlBeautifier
   class RubyIndenter
-    INDENT_KEYWORDS = %w[ if elsif else unless while until begin for ]
-    OUTDENT_KEYWORDS = %w[ elsif else end ]
-    RUBY_INDENT  = %r{
+    INDENT_KEYWORDS = %w[if elsif else unless while until begin for case when].freeze
+    OUTDENT_KEYWORDS = %w[elsif else end when].freeze
+    RUBY_INDENT = %r{
       ^ ( #{INDENT_KEYWORDS.join("|")} )\b
-      | \b ( do | \{ ) ( \s* \| [^\|]+ \| )? $
+      | \b ( do | \{ ) ( \s* \| [^|]+ \| )? $
     }xo
     RUBY_OUTDENT = %r{ ^ ( #{OUTDENT_KEYWORDS.join("|")} | \} ) \b }xo
 

data/lib/htmlbeautifier/version.rb

@@ -1,8 +1,10 @@
-module HtmlBeautifier #:nodoc:
-  module VERSION #:nodoc:
+# frozen_string_literal: true
+
+module HtmlBeautifier # :nodoc:
+  module VERSION # :nodoc:
     MAJOR = 1
-    MINOR = 3
-    TINY  = 1
+    MINOR = 4
+    TINY = 3
 
     STRING = [MAJOR, MINOR, TINY].join(".")
   end

data/lib/htmlbeautifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "htmlbeautifier/builder"
 require "htmlbeautifier/html_parser"
 require "htmlbeautifier/version"
@@ -22,7 +24,7 @@ module HtmlBeautifier
     if options[:tab_stops]
       options[:indent] = " " * options[:tab_stops]
     end
-    "".tap { |output|
+    String.new.tap { |output|
       HtmlParser.new.scan html.to_s, Builder.new(output, options)
     }
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: htmlbeautifier
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.3
 platform: ruby
 authors:
 - Paul Battley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-04 00:00:00.000000000 Z
+date: 2024-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -39,19 +39,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        version: '1.33'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        version: '1.33'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 description: A normaliser/beautifier for HTML that also understands embedded Ruby.
 email: pbattley@gmail.com
 executables:
@@ -80,15 +108,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.4.15
 signing_key: 
 specification_version: 4
 summary: HTML/ERB beautifier