nanoc-tidy.rb 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 133f30c53d54b2f5cea16c3877fa597d86b5db84bb240214459eee5e6a8c4f07
-  data.tar.gz: 8d054b51e4f6fbd7351fac5eb78ddcae57bcf175ebfea062c588daf9d5358c56
+  metadata.gz: '0898b9a7ec2f3c137c9fa5233313a88102ea13ad27f8b6093f258c1f0f096e66'
+  data.tar.gz: 344d471e7428617674f06a759da09dcde5807ccdbc811ee76ab0a8e3d5d01083
 SHA512:
-  metadata.gz: 95b712fefeaf461ec57efe23fbcfada16a9be99498ee923affd4db983ffa522157f95b2659a4fd726d626296a515a6cb1631ca1ae890af7caa5e8ef82949716a
-  data.tar.gz: d83de9881073f9a53818fec78482c7a98023acc1bc798137b78a766b96f343cec659b54e06425cda3cd78c611d32a2b606c9f15cca466859ca3b95257e9cb4ef
+  metadata.gz: dd18a0e8598f6cfd2fe27a2294deed691d8e671110ea1efa3521fbb7c0005a17e43178251c9a90a331a0a8bbfdea46fb728982b78debb49a8c8699d7eb0a1fd7
+  data.tar.gz: 84471209421d20f88c6a6b36e05ed51f11c85cfebb623ad63c93ba35cf92a53335461cf518ea1ed56a32f4295e07d0924e91a5ad2be06ccf52dfbca9667c4d8a

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
 
@@ -39,11 +38,11 @@ module Nanoc::Tidy
         File.basename(item.identifier.to_s),
         content
       )
-      spawn tidy,
+      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 +52,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.1"
   end
 end

data/lib/nanoc/tidy.rb

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

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-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_development_dependency "yard", "~> 0.9"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-tidy.rb
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 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: test-cmd.rb
@@ -136,7 +136,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 +180,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: []