nanoc-tidy.rb 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d805396fd479848ce7e69377255fc4b646dd34bf35f4453337d79c3c2560bdce
-  data.tar.gz: '08f58910fda43532c3ab1161036cdabf810067a84dc1847211f07315e433dca5'
+  metadata.gz: 5998921c6f4be39dbe3f20c9d248cc4d8939b905a2a08549689699aeaf6e12a4
+  data.tar.gz: bb4d0a22b665bac952dad499ef906d81ea85c98d2ef6a9e7027c2d0eeb2a1338
 SHA512:
-  metadata.gz: 74c898f367043cf746d9d4a5b292d261b13ce551071232558215b9ea86573127590330534c960da49252a1ccd533008a7e9d89d133f4d9bd2b70b5391e038efc
-  data.tar.gz: 200c914a37b4fa14b350be967643dc3a5d97f95e7eb57169724b3450805f4462de03a66e593ebcbb0fad5f171a86103c78ac2335cd5857b006b1b26d33c14b10
+  metadata.gz: b0d63eed8bd9e8955977420462ef0498ea5dac27f656ddcfb2cf4c1fbd7574d59590a13af1dfe81d416ade6061559f59c247b04727d9a5688b076ae760d7d28f
+  data.tar.gz: 8dfd5a2914ac5b3a3385c92bb65c05de74191f03b6951bb0e6667c6eafef8b9783282f8e7f28475c39343a74b3fea179f2a72846d10f911008346ae5b5e1cd43

data/README.md

@@ -2,19 +2,20 @@
 
 nanoc-tidy.rb is a
 [nanoc](https://nanoc.app)
-filter that utilizes
+filter that integrates
 [tidy-html5](https://github.com/htacg/tidy-html5)
-to nicely format, and detect / correct markup
-errors in HTML produced by template languages such as ERB -
-where misaligned indentation and other whitespace issues
-are often commonplace.
+into nanoc. <br>
+The filter can format and validate HTML produced
+during the
+[nanoc](https://nanoc.app)
+build process.
 
 ## Examples
 
 __Defaults__
 
-The following is an example that uses the
-[default options](https://0x1eef.github.io/x/nanoc-tidy.rb/Nanoc/Tidy/Filter#default_options-class_method):
+The following example uses the
+[default command-line options](https://0x1eef.github.io/x/nanoc-tidy.rb/Nanoc/Tidy/Filter#default_argv-class_method):
 
 ``` ruby
 # Rules
@@ -29,7 +30,7 @@ end
 
 __Options__
 
-The following example forwards custom command-line options to
+The following example forwards command-line options to
 [tidy-html5](https://github.com/htacg/tidy-html5):
 
 ```ruby
@@ -38,23 +39,23 @@ require "nanoc-tidy"
 compile "/index.html.erb" do
   layout("/default.*")
   filter(:erb)
-  filter(:tidy, "-upper" => true)
+  filter(:tidy, argv: ["-upper"])
   write("/index.html")
 end
 ```
 
-## Sources
+## <a id='install'>Install</a>
 
-* [Source code (GitHub)](https://github.com/0x1eef/nanoc-tidy.rb)
-* [Source code (GitLab)](https://gitlab.com/0x1eef/nanoc-tidy.rb)
+**Rubygems.org**
 
-## <a id='install'>Install</a>
+nanoc-tidy.rb can be installed via rubygems.org.
+
+    gem install nanoc-tidy.rb
+
+## Sources
 
-nanoc-tidy.rb is distributed as a RubyGem through its git repositories. <br>
-[GitHub](https://github.com/0x1eef/nanoc-tidy.rb),
-and
-[GitLab](https://gitlab.com/0x1eef/nanoc-tidy.rb)
-are available as sources.
+* [GitHub](https://github.com/0x1eef/nanoc-tidy.rb#readme)
+* [GitLab](https://gitlab.com/0x1eef/nanoc-tidy.rb#about)
 
 ## License
 

data/lib/nanoc/tidy/filter.rb

@@ -1,91 +1,56 @@
 # frozen_string_literal: true
 
-class Nanoc::Tidy::Filter < Nanoc::Filter
-  require "fileutils"
-  include FileUtils
-  Error = Class.new(RuntimeError)
-
-  identifier :tidy
-  type text: :text
-
-  ##
-  # @example
-  #   Nanoc::Tidy.default_options.merge!(
-  #     "-upper" => true
-  #   )
-  #
-  # @return [{"-wrap" => 120, "-indent" => true}]
-  #  Returns the default options forwarded as command-line
-  #  arguments to tidy-html5.
-  def self.default_options
-    @default_options ||= {"-wrap" => 120, "-indent" => true}
-  end
-
-  def run(content, options = {})
-    tidy temporary_file(content),
-         self.class.default_options.merge(options)
-  end
-
-  private
+module Nanoc::Tidy
+  class Filter < Nanoc::Filter
+    require "fileutils"
+    require_relative "spawn"
+    include Spawn
+    include FileUtils
+
+    identifier :tidy
+    type text: :text
+
+    ##
+    # @example
+    #   Nanoc::Tidy.default_argv.concat ["-upper"]
+    #
+    # @return [Array<String>]
+    #  The default command line options forwarded to tidy-html5.
+    def self.default_argv
+      ["-wrap", "120", "-indent"]
+    end
 
-  def temporary_file(content)
-    dir = cwd
-    mkdir_p(dir) unless Dir.exist?(dir)
-    file = Tempfile.new(File.basename(item.identifier.to_s), dir)
-    file.write(content)
-    file.tap(&:flush)
-  end
+    def run(content, options = {})
+      path = temporary_file(content).path
+      spawn tidy,
+            [*default_argv, *(options[:argv] || []), "-modify", path],
+            log: File.join(tmpdir, "tidy-html5.log")
+      File.read(path).tap { rm(path) }
+    end
 
-  ##
-  # tidy executable interface
+    private
 
-  def tidy(file, options)
-    Process.wait spawn(
-      tidy_exe, "-modify", "-quiet", *tidy_args(options), file.path,
-      spawn_options
-    )
-    if $?.success?
-      File.read(file.path).tap { file.tap(&:unlink).close }
-    else
-      raise Error,
-            "tidy exited unsuccessfully " \
-            "(exit code: #{$?.exitstatus}, " \
-            "item: #{item.identifier}, " \
-            "log: #{log.gsub(Dir.getwd, '')[1..]})",
-            []
+    def default_argv
+      self.class.default_argv
     end
-  end
 
-  def tidy_exe
-    case
-    when system("which tidy > /dev/null 2>&1") then "tidy"
-    when system("which tidy5 > /dev/null 2>&1") then "tidy5"
-    else raise Error, "unable to find a tidy executable on $PATH"
+    def temporary_file(content)
+      mkdir_p(tmpdir)
+      file = Tempfile.new(File.basename(item.identifier.to_s), tmpdir)
+      file.write(content)
+      file.tap(&:flush)
     end
-  end
 
-  def tidy_args(options)
-    options.each_with_object([]) do |(key, value), ary|
-      if value.equal?(true)
-        ary << key
-      else
-        ary.concat [key, value.to_s]
+    def tidy
+      case
+      when system("which tidy > /dev/null 2>&1") then "tidy"
+      when system("which tidy5 > /dev/null 2>&1") then "tidy5"
+      else nil
       end
     end
-  end
 
-  ##
-  # spawn-related methods
-
-  def spawn_options
-    { STDOUT => log, STDERR => log }
-  end
-
-  def log
-    File.join(cwd, "tidy.log")
-  end
-
-  def cwd
-    File.join(Dir.getwd, "tmp", "nanoc-tidy.rb")
+    def tmpdir
+      File.join(Dir.getwd, "tmp", "nanoc-tidy.rb")
+    end
   end
 end

data/lib/nanoc/tidy/spawn.rb

@@ -0,0 +1,19 @@
+module Nanoc::Tidy
+  module Spawn
+    Error = Class.new(RuntimeError)
+    def spawn(exe, argv, log:)
+      Kernel.spawn(
+        exe, *argv, { STDOUT => log, STDERR => log }
+      )
+      Process.wait
+      unless $?.success?
+        raise Error,
+              "#{File.basename(exe)} exited unsuccessfully " \
+              "(exit code: #{$?.exitstatus}, " \
+              "item: #{item.identifier}, " \
+              "log: #{log.gsub(Dir.getwd, '')[1..]})",
+              []
+      end
+    end
+  end
+end

data/lib/nanoc/tidy/version.rb

@@ -1,5 +1,5 @@
 module Nanoc
   module Tidy
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/nanoc/tidy.rb

@@ -6,9 +6,9 @@ module Nanoc::Tidy
   require_relative "tidy/filter"
 
   ##
-  # @example (see Nanoc::Tidy::Filter.default_options)
-  # @return (see Nanoc::Tidy::Filter.default_options)
-  def self.default_options
-    Filter.default_options
+  # @example (see Nanoc::Tidy::Filter.default_argv)
+  # @return (see Nanoc::Tidy::Filter.default_argv)
+  def self.default_argv
+    Filter.default_argv
   end
 end

data/test/tidy_filter_test.rb

@@ -2,16 +2,15 @@ require_relative "setup"
 
 class FilterTest < Test::Unit::TestCase
   def test_default_options
-    options = { "--tidy-mark" => false }
-    assert_equal filter_for("fixture.html").run(html, options),
-                 read_result("default_options.html")
+    options = { argv: ["--tidy-mark", "false"] }
+    assert_equal read_result("default_options.html"),
+                 filter_for("fixture.html").run(html, options)
   end
 
   def test_upper_option
-    options = { "-upper" => true, "--tidy-mark" => false }
-    assert_equal filter_for("fixture.html").run(html, options),
-                 read_result("upper_option.html")
-
+    options = { argv: ["-upper", "--tidy-mark", "false"] }
+    assert_equal read_result("upper_option.html"),
+                 filter_for("fixture.html").run(html, options)
   end
 
   private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-tidy.rb
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-26 00:00:00.000000000 Z
+date: 2024-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -122,6 +122,7 @@ files:
 - lib/nanoc-tidy.rb
 - lib/nanoc/tidy.rb
 - lib/nanoc/tidy/filter.rb
+- lib/nanoc/tidy/spawn.rb
 - lib/nanoc/tidy/version.rb
 - nanoc-tidy.rb.gemspec
 - test/fixtures/fixture.html