htmlbeautifier 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a56b2b5efa4d86724c29098dd2877d5e480cc3f8
-  data.tar.gz: 191861084a908515224d0df8cb6bce30d962090d
+SHA256:
+  metadata.gz: 2cd83943c1a2aa479dd33fb87de1cdb14aa9dd462760c9d20b25c93cbc86f079
+  data.tar.gz: e1aa440e4c79f663cfacb1946c95c15094e77d636b938bc7f33a4cd04ebd9969
 SHA512:
-  metadata.gz: c21dd2ce56776f1ef0dd3ccb496eda14c5f83363660d95098d96bf9af287d63f98ce512011b9433e3a5136e0ed19d273b8bda4465fe21e892c1cc22c9e873bea
-  data.tar.gz: 0d14c894a17c9841abaef8f41121f10cb7701cd2a4a1fc1721692aca02fc70af0274d1a2317746d0be1aba69ead804dedae0d5ecf5bbc4ccf8415335fa444480
+  metadata.gz: 4d427b44b461d784f4cc3e19f0c1aef81153f6c821b7bb956d78b75d8710be862a13f0765a1940612dc3da8359bb04a03d8c39898356b30d43000e5b5979e599
+  data.tar.gz: 4c8873331ebb4a02ede609d548caed30fe612e7a5d113733bdd68090881e3424c7fd94aa810191a5bb20751113056c1e36752f81f8d0c0df2bdeb56e7a7ad9ea

data/bin/htmlbeautifier

@@ -1,11 +1,14 @@
 #!/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)
-rescue => e
+rescue StandardError => e
   raise "Error parsing #{name}: #{e}"
 end
 
@@ -14,18 +17,18 @@ executable = File.basename(__FILE__)
 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]})"
@@ -50,6 +53,26 @@ END
   ) do |num|
     options[:stop_on_errors] = num
   end
+  opts.on(
+    "-b", "--keep-blank-lines NUMBER", Integer,
+    "Set number of consecutive blank lines"
+  ) 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"
@@ -58,16 +81,34 @@ 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?
+    relative_paths = failures.map { |path|
+      Pathname.new(path).relative_path_from Dir.pwd
+    }
+    $stderr.puts [
+      "Lint failed - files would be modified:",
+      *relative_paths
+    ].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"
 
@@ -6,14 +8,16 @@ module HtmlBeautifier
     DEFAULT_OPTIONS = {
       indent: "  ",
       initial_level: 0,
-      stop_on_errors: false
-    }
+      stop_on_errors: false,
+      keep_blank_lines: 0
+    }.freeze
 
     def initialize(output, options = {})
       options = DEFAULT_OPTIONS.merge(options)
       @tab = options[:indent]
       @stop_on_errors = options[:stop_on_errors]
       @level = options[:initial_level]
+      @keep_blank_lines = options[:keep_blank_lines]
       @new_line = false
       @empty = true
       @ie_cc_levels = []
@@ -25,6 +29,7 @@ module HtmlBeautifier
 
     def error(text)
       return unless @stop_on_errors
+
       raise text
     end
 
@@ -38,14 +43,15 @@ 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
 
-    def new_line(*)
+    def new_line
       @new_line = true
     end
 
@@ -64,7 +70,7 @@ module HtmlBeautifier
 
     def emit_reindented_block_content(code)
       lines = code.strip.split(%r{\n})
-      indentation = lines.first[%r{^\s+}]
+      indentation = foreign_block_indentation(code)
 
       indent
       new_line
@@ -75,55 +81,63 @@ module HtmlBeautifier
       outdent
     end
 
+    def foreign_block_indentation(code)
+      code.split(%r{\n}).find { |ln| !ln.strip.empty? }[%r{^\s+}]
+    end
+
     def preformatted_block(opening, content, closing)
       new_line
       emit opening, content, closing
       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
 
-    def text(t)
-      emit t.chomp
-      new_line if t.end_with?("\n")
+    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)
+      new_line
     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
@@ -41,12 +43,15 @@ module HtmlBeautifier
        :open_block_element],
       [%r{</#{ELEMENT_CONTENT}>}om,
        :close_element],
-      [%r{<#{ELEMENT_CONTENT}>}om,
+      [%r{<#{ELEMENT_CONTENT}[^/]>}om,
        :open_element],
-      [%r{\s*\r?\n\s*}om,
-       :new_line],
-      [%r{[^<]+},
-       :text]]
+      [%r{<\w+(?: #{ELEMENT_CONTENT})?/>}om,
+       :standalone_element],
+      [%r{(\s*\r?\n\s*)+}om,
+       :new_lines],
+      [%r{[^<\n]+},
+       :text]
+    ].freeze
 
     def initialize
       super do |p|

data/lib/htmlbeautifier/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "strscan"
 
 module HtmlBeautifier
@@ -29,13 +31,15 @@ module HtmlBeautifier
     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 StandardError => 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].freeze
+    OUTDENT_KEYWORDS = %w[elsif else end].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,7 +1,9 @@
-module HtmlBeautifier #:nodoc:
-  module VERSION #:nodoc:
+# frozen_string_literal: true
+
+module HtmlBeautifier # :nodoc:
+  module VERSION # :nodoc:
     MAJOR = 1
-    MINOR = 2
+    MINOR = 4
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join(".")

data/lib/htmlbeautifier.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "htmlbeautifier/builder"
 require "htmlbeautifier/html_parser"
 require "htmlbeautifier/version"
@@ -15,12 +17,14 @@ module HtmlBeautifier
   # is false, i.e. continue to process the rest of the document.
   # initial_level - The entire output will be indented by this number of steps.
   # Default is 0.
+  # keep_blank_lines - an integer for the number of consecutive empty lines
+  # to keep in output.
   #
   def self.beautify(html, options = {})
     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.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Paul Battley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-06 00:00:00.000000000 Z
+date: 2021-11-26 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
@@ -44,14 +44,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.30.0
+        version: '1'
+- !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.1
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: HTML/ERB beautifier