nanoc-tidy.rb 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dcf61d9f8cd7befb47dcf0f0f15d3e31b5b6dfa849f19d255c10e0ce0083fbc
-  data.tar.gz: eca622d7fe8ac8dd883de3393225420efb9ca9f0ab0c5d39c1b8a3cab41ede3c
+  metadata.gz: d805396fd479848ce7e69377255fc4b646dd34bf35f4453337d79c3c2560bdce
+  data.tar.gz: '08f58910fda43532c3ab1161036cdabf810067a84dc1847211f07315e433dca5'
 SHA512:
-  metadata.gz: 43cd2a510955f332b8aef7d06c884eeb8e958cfa9789a5f96880b9fe5ab744297d1c289b3b8fdcc027c5d8fc60df0a6ea9f03648d66fab47f068e037ec1bbe4d
-  data.tar.gz: 3c03bef0d16ff6762522b00f9fb84763fe7cba1ea5bdc1496e3335d874aa2f0bc92a6ff31823f00649877855c567cf7af834db55c707196da3651b5d85458507
+  metadata.gz: 74c898f367043cf746d9d4a5b292d261b13ce551071232558215b9ea86573127590330534c960da49252a1ccd533008a7e9d89d133f4d9bd2b70b5391e038efc
+  data.tar.gz: 200c914a37b4fa14b350be967643dc3a5d97f95e7eb57169724b3450805f4462de03a66e593ebcbb0fad5f171a86103c78ac2335cd5857b006b1b26d33c14b10

data/README.md

@@ -13,9 +13,8 @@ are often commonplace.
 
 __Defaults__
 
-The following is an example with the
-[default options](https://0x1eef.github.io/x/nanoc-tidy.rb/Nanoc/Tidy/Filter#default_options-class_method)
-being used:
+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):
 
 ``` ruby
 # Rules
@@ -30,7 +29,7 @@ end
 
 __Options__
 
-The following example forwards command-line options to
+The following example forwards custom command-line options to
 [tidy-html5](https://github.com/htacg/tidy-html5):
 
 ```ruby

data/lib/nanoc/tidy/filter.rb

@@ -9,6 +9,11 @@ class Nanoc::Tidy::Filter < Nanoc::Filter
   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.
@@ -17,18 +22,45 @@ class Nanoc::Tidy::Filter < Nanoc::Filter
   end
 
   def run(content, options = {})
-    file = temporary_file_for(content)
-    tidy file, self.class.default_options.merge(options)
+    tidy temporary_file(content),
+         self.class.default_options.merge(options)
   end
 
   private
 
+  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
+
+  ##
+  # tidy executable interface
+
   def tidy(file, options)
-    system tidy_exe, "-modify", "-quiet", *tidy_args(options), file.path
+    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})", []
+      raise Error,
+            "tidy exited unsuccessfully " \
+            "(exit code: #{$?.exitstatus}, " \
+            "item: #{item.identifier}, " \
+            "log: #{log.gsub(Dir.getwd, '')[1..]})",
+            []
+    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"
     end
   end
 
@@ -42,19 +74,18 @@ class Nanoc::Tidy::Filter < Nanoc::Filter
     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"
-    end
+  ##
+  # spawn-related methods
+
+  def spawn_options
+    { STDOUT => log, STDERR => log }
   end
 
-  def temporary_file_for(content)
-    dir = File.join(Dir.getwd, "tmp", "nanoc-tidy.rb")
-    mkdir_p(dir) unless Dir.exist?(dir)
-    file = Tempfile.new(File.basename(item.identifier.to_s), dir)
-    file.write(content)
-    file.tap(&:flush)
+  def log
+    File.join(cwd, "tidy.log")
+  end
+
+  def cwd
+    File.join(Dir.getwd, "tmp", "nanoc-tidy.rb")
   end
 end

data/lib/nanoc/tidy/version.rb

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

data/lib/nanoc/tidy.rb

@@ -4,4 +4,11 @@ require "nanoc"
 module Nanoc::Tidy
   require_relative "tidy/version"
   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
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-tidy.rb
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-30 00:00:00.000000000 Z
+date: 2024-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard