nanoc-tidy.rb 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 133f30c53d54b2f5cea16c3877fa597d86b5db84bb240214459eee5e6a8c4f07
-  data.tar.gz: 8d054b51e4f6fbd7351fac5eb78ddcae57bcf175ebfea062c588daf9d5358c56
+  metadata.gz: 8d6e154d29de034dfe0b684d5e95473021844c209b99fcd5660e7bf9a9f68fd6
+  data.tar.gz: e03bc5eaa2bc6ce7d3b24fd449bc72ad4dd0e31b0aec5af5f4419ae4c298fc1d
 SHA512:
-  metadata.gz: 95b712fefeaf461ec57efe23fbcfada16a9be99498ee923affd4db983ffa522157f95b2659a4fd726d626296a515a6cb1631ca1ae890af7caa5e8ef82949716a
-  data.tar.gz: d83de9881073f9a53818fec78482c7a98023acc1bc798137b78a766b96f343cec659b54e06425cda3cd78c611d32a2b606c9f15cca466859ca3b95257e9cb4ef
+  metadata.gz: 8a92d50b08bdd9bbd65ab664c55a867404a9755ddf3c2f0dd4f40c8fecf48c00e84bfd824e5281cda17083b2963b4b7ccfb8614d3b40c308815570b7b53b8e00
+  data.tar.gz: 840a2eca0b0cbbeec99fa022d13f0674fb0eca061310b070e58d3d99c916cb14b43d249f6234b8c78217834f9ceadcac3dd1907a57692f4d3dfea2f73c505265

data/README.md

@@ -32,7 +32,8 @@ end
 __Option: argv__
 
 The following example sets the "argv" filter option. <br>
-The filter option is combined with [Nanoc::Tidy.default_argv](https://0x1eef.github.io/x/nanoc-tidy.rb/Nanoc/Tidy/Filter#default_argv-class_method):
+The filter option is combined with
+[Nanoc::Tidy.default_argv](https://0x1eef.github.io/x/nanoc-tidy.rb/Nanoc/Tidy/Filter#default_argv-class_method):
 
 ```ruby
 # Rules
@@ -45,6 +46,23 @@ compile "/index.html.erb" do
 end
 ```
 
+__Option: exe__
+
+The "exe" option can be used to change the default executable
+from "tidy5" to something else, the most common alternative
+might be "tidy":
+
+```ruby
+# Rules
+require "nanoc-tidy"
+compile "/index.html.erb" do
+  layout("/default.*")
+  filter(:erb)
+  filter(:tidy, exe: "tidy")
+  write("/index.html")
+end
+```
+
 ## Install
 
 **Rubygems.org**

data/lib/nanoc/tidy/filter.rb

@@ -4,7 +4,6 @@ module Nanoc::Tidy
   class Filter < Nanoc::Filter
     require "fileutils"
     require_relative "spawn"
-
     include Spawn
     include FileUtils
 
@@ -35,15 +34,16 @@ module Nanoc::Tidy
     # @return [String]
     #  Returns HTML content (modified)
     def run(content, options = {})
+      options = Ryo(options)
       file = temporary_file(
         File.basename(item.identifier.to_s),
         content
       )
-      spawn tidy,
-            [*default_argv, *(options[:argv] || []), "-modify", file.path]
+      spawn options.exe || "tidy5",
+            [*default_argv, *(options.argv || []), "-modify", file.path]
       File.read(file.path)
     ensure
-      file&.unlink
+      file ? file.tap(&:unlink).close : nil
     end
 
     private
@@ -53,24 +53,14 @@ module Nanoc::Tidy
     end
 
     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
-      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
+      tmpdir = File.join(Dir.getwd, "tmp", "tidy")
+      name = item.identifier.to_s
+      file = Tempfile.new(
+        [ File.basename(name), File.extname(name) ],
+        mkdir_p(tmpdir).last
+      )
+      file.write(content)
+      file.tap(&:flush)
     end
   end
 end

data/lib/nanoc/tidy/spawn.rb

@@ -14,7 +14,8 @@ module Nanoc::Tidy
     # @param [Array<String>] argv
     #  An array of command line arguments
     #
-    # @return [void]
+    # @return [Integer]
+    #  Returns the exit code of the spawned process
     def spawn(exe, argv)
       r = cmd(exe, *argv)
       ##
@@ -29,8 +30,8 @@ module Nanoc::Tidy
               "#{File.basename(exe)} exited unsuccessfully\n" \
               "(item: #{item.identifier})\n" \
               "(exit code: #{r.exit_status})\n" \
-              "(stdout:\n#{r.stdout})\n" \
-              "(stderr:\n#{r.stderr})\n",
+              "(stdout: #{r.stdout&.chomp})\n" \
+              "(stderr: #{r.stderr&.chomp})\n",
               []
       end
     end

data/lib/nanoc/tidy/version.rb

@@ -2,6 +2,6 @@
 
 module Nanoc
   module Tidy
-    VERSION = "0.8.0"
+    VERSION = "0.8.2"
   end
 end

data/lib/nanoc/tidy.rb

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

data/nanoc-tidy.rb.gemspec

@@ -10,9 +10,10 @@ 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-html5"
+  gem.summary = "nanoc-tidy.rb = nanoc + tidy-html5"
   gem.description = gem.summary
-  gem.add_runtime_dependency "test-cmd.rb", "~> 0.12.2"
+  gem.add_runtime_dependency "ryo.rb", "~> 0.5"
+  gem.add_runtime_dependency "test-cmd.rb", "~> 0.12.3"
   gem.add_development_dependency "yard", "~> 0.9"
   gem.add_development_dependency "redcarpet", "~> 3.5"
   gem.add_development_dependency "test-unit", "~> 3.6"

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-tidy.rb
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.2
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
+date: 2024-06-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ryo.rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: test-cmd.rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 0.12.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 0.12.3
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +150,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-description: nanoc + tidy-html5
+description: nanoc-tidy.rb = nanoc + tidy-html5
 email:
 - 0x1eef@protonmail.com
 executables: []
@@ -180,5 +194,5 @@ requirements: []
 rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
-summary: nanoc + tidy-html5
+summary: nanoc-tidy.rb = nanoc + tidy-html5
 test_files: []