nanoc-tidy.rb 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee29f7af6d3dbaf443aa2e35e52e696f184481641a493a29292d110760776c07
-  data.tar.gz: c42f3696900ea751574072d35a0005ed4dd2442cde77640e7a56a23f9794a500
+  metadata.gz: baa9bd78c6f407c7050903ec46fe89c19a702dc788eb556438078d43f10c2adf
+  data.tar.gz: 5bd8b9fd26eb7eb0a6831eaee86d0da38e02ceee4589cfbdef4881f29f52b6a7
 SHA512:
-  metadata.gz: bb1ad99a6c41a010f04d96483aac6cec646b153aeaaa0f827e2c2f176e5d0890435021a301e434600ab37623e5b824db75ce41826bde6b864a2da76a8e5be4ee
-  data.tar.gz: 648fa0abae522cf95225adc508991a7f5698cc4573e3d1cafd56a211fec6376a460c800142521bfe1ca4d400657b2b48fd96cf0074fdcaf2999a35d88259479f
+  metadata.gz: 3acb6eb29a332c6013cdaa878f54327abfc96ec87fbd36c8a439afe153469b724713cea1a77572ab02b069c24e6f3dac25c1b05e00aeac146e304f9637c6766e
+  data.tar.gz: 83f346f2273873f02015065cc8701d8693e6cfd8a26686a767789a9dcd2f4cd46b084b452b928807758141ac4e3f312afb0f80d63bc6f355cdbd1663db9ab03d

data/Rakefile.rb

@@ -1,5 +1,11 @@
 require "rake/testtask"
 
+desc "Run CI tasks"
+task :ci do
+  sh "rake test"
+  sh "bundle exec rubocop"
+end
+
 Rake::TestTask.new do |t|
   t.test_files = FileList['test/*_test.rb']
   t.verbose = true

data/lib/nanoc/tidy/filter.rb

@@ -4,6 +4,7 @@ module Nanoc::Tidy
   class Filter < Nanoc::Filter
     require "fileutils"
     require_relative "spawn"
+
     include Spawn
     include FileUtils
 
@@ -22,13 +23,27 @@ module Nanoc::Tidy
       @default_argv ||= ["-wrap", "120", "-indent"]
     end
 
+    ##
+    # Runs the filter
+    #
+    # @param [String] content
+    #  HTML content
+    #
+    # @param [Hash] options
+    #  Filter options
+    #
+    # @return [String]
+    #  Returns HTML content (modified)
     def run(content, options = {})
-      path = temporary_file(content).path
+      file = temporary_file(
+        File.basename(item.identifier.to_s),
+        content
+      )
       spawn tidy,
-            [*default_argv, *(options[:argv] || []), "-modify", path],
-            err: File.join(tmpdir, "stderr"),
-            out: File.join(tmpdir, "stdout")
-      File.read(path).tap { rm(path) }
+            [*default_argv, *(options[:argv] || []), "-modify", file.path]
+      File.read(file.path)
+    ensure
+      file&.unlink
     end
 
     private
@@ -37,23 +52,25 @@ module Nanoc::Tidy
       self.class.default_argv
     end
 
-    def temporary_file(content)
-      mkdir_p(tmpdir)
-      file = Tempfile.new(File.basename(item.identifier.to_s), tmpdir)
-      file.write(content)
-      file.tap(&:flush)
+    def temporary_file(basename, content)
+      tempname = [
+        ".nanoc.tidy.#{basename}.#{object_id}",
+        SecureRandom.alphanumeric(3)
+      ]
+      Tempfile.new(tempname).tap do
+        _1.write(content)
+        _1.flush
+      end
     end
 
     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
+      if system("which tidy > /dev/null 2>&1")
+        "tidy"
+      elsif system("which tidy5 > /dev/null 2>&1")
+        "tidy5"
+      else
+        raise Nanoc::Tidy::Error, "tidy executable not found on $PATH"
       end
     end
-
-    def tmpdir
-      File.join(Dir.getwd, "tmp", "tidy-html5")
-    end
   end
 end

data/lib/nanoc/tidy/spawn.rb

@@ -1,8 +1,8 @@
+# frozen_string_literal: true
+
 module Nanoc::Tidy
   module Spawn
-    require "securerandom"
     require "fileutils"
-    Error = Class.new(RuntimeError)
 
     ##
     # Spawns a process
@@ -13,20 +13,10 @@ module Nanoc::Tidy
     # @param [Array<String>] argv
     #  An array of command line arguments
     #
-    # @param [String] err
-    #  A path where stderr is redirected to
-    #
-    # @param [String] out
-    #  A path where stdout is redirected to
-    #
     # @return [void]
-    def spawn(exe, argv, err:, out:)
-      hex = SecureRandom.hex
-      err = "#{err}-ID#{hex}"
-      out = "#{out}-ID#{hex}"
-      Kernel.spawn(
-        exe, *argv, { STDERR => err, STDOUT => out }
-      )
+    def spawn(exe, argv, workdir: File.join(Dir.getwd, "tmp"))
+      logfile = File.join(workdir, ".#{Process.pid}.tidy")
+      Kernel.spawn(exe, *argv, {STDERR => logfile, STDOUT => logfile})
       Process.wait
       status = $?
       ##
@@ -34,24 +24,18 @@ module Nanoc::Tidy
       #  * 0: no warnings, no errors
       #  * 1: has warnings
       #  * 2: has errors
-      return if [0, 1].include?(status.exitstatus)
-
-      msgs = [err, out].map do
-        FileUtils.touch(_1)
-        [_1.gsub(Dir.getwd, ''), ":", File.binread(_1)].join
-      end.join("\n")
-      raise Error,
-            "#{File.basename(exe)} exited unsuccessfully " \
-            "(" \
-            "exit code: #{status.exitstatus}, " \
-            "item: #{item.identifier}" \
-            ")" \
-            "\n#{msgs}",
-            []
+      if [0, 1].include?(status.exitstatus)
+        status.exitstatus
+      else
+        raise Nanoc::Tidy::Error,
+              "#{File.basename(exe)} exited unsuccessfully\n" \
+              "(item: #{item.identifier})\n" \
+              "(exit code: #{status.exitstatus})\n" \
+              "output:\n#{File.binread(logfile)}\n",
+              []
+      end
     ensure
-      [err, out]
-        .select { File.exist?(_1) }
-        .each { FileUtils.rm(_1) }
+      File.exist?(logfile) ? FileUtils.rm(logfile) : nil
     end
   end
 end

data/lib/nanoc/tidy/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Nanoc
   module Tidy
-    VERSION = "0.6.1"
+    VERSION = "0.7.0"
   end
 end

data/lib/nanoc/tidy.rb

@@ -2,6 +2,11 @@
 
 require "nanoc"
 module Nanoc::Tidy
+  ##
+  # Generic error
+  Error = Class.new(RuntimeError)
+
+  require "securerandom"
   require_relative "tidy/version"
   require_relative "tidy/filter"
 

data/lib/nanoc-tidy.rb

@@ -1,2 +1,3 @@
 # frozen_string_literal: true
+
 require_relative "nanoc/tidy"

data/nanoc-tidy.rb.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.licenses = ["0BSD"]
   gem.files = `git ls-files`.split($/).reject { _1.start_with?(".") }
   gem.require_paths = ["lib"]
-  gem.summary = "nanoc-tidy.rb integrates tidy-html5 into nanoc"
+  gem.summary = "nanoc + tidy-html5"
   gem.description = gem.summary
   gem.add_development_dependency "yard", "~> 0.9"
   gem.add_development_dependency "redcarpet", "~> 3.5"

data/test/tidy_filter_test.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 require_relative "setup"
 
 class FilterTest < Test::Unit::TestCase
   def test_default_options
-    options = { argv: ["--tidy-mark", "false"] }
+    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 = { argv: ["-upper", "--tidy-mark", "false"] }
+    options = {argv: ["-upper", "--tidy-mark", "false"]}
     assert_equal read_result("upper_option.html"),
                  filter_for("fixture.html").run(html, options)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-tidy.rb
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-29 00:00:00.000000000 Z
+date: 2024-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -122,7 +122,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-description: nanoc-tidy.rb integrates tidy-html5 into nanoc
+description: nanoc + tidy-html5
 email:
 - 0x1eef@protonmail.com
 executables: []
@@ -166,5 +166,5 @@ requirements: []
 rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
-summary: nanoc-tidy.rb integrates tidy-html5 into nanoc
+summary: nanoc + tidy-html5
 test_files: []