nanoc-tidy.rb 0.7.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: baa9bd78c6f407c7050903ec46fe89c19a702dc788eb556438078d43f10c2adf
-  data.tar.gz: 5bd8b9fd26eb7eb0a6831eaee86d0da38e02ceee4589cfbdef4881f29f52b6a7
+  metadata.gz: '0898b9a7ec2f3c137c9fa5233313a88102ea13ad27f8b6093f258c1f0f096e66'
+  data.tar.gz: 344d471e7428617674f06a759da09dcde5807ccdbc811ee76ab0a8e3d5d01083
 SHA512:
-  metadata.gz: 3acb6eb29a332c6013cdaa878f54327abfc96ec87fbd36c8a439afe153469b724713cea1a77572ab02b069c24e6f3dac25c1b05e00aeac146e304f9637c6766e
-  data.tar.gz: 83f346f2273873f02015065cc8701d8693e6cfd8a26686a767789a9dcd2f4cd46b084b452b928807758141ac4e3f312afb0f80d63bc6f355cdbd1663db9ab03d
+  metadata.gz: dd18a0e8598f6cfd2fe27a2294deed691d8e671110ea1efa3521fbb7c0005a17e43178251c9a90a331a0a8bbfdea46fb728982b78debb49a8c8699d7eb0a1fd7
+  data.tar.gz: 84471209421d20f88c6a6b36e05ed51f11c85cfebb623ad63c93ba35cf92a53335461cf518ea1ed56a32f4295e07d0924e91a5ad2be06ccf52dfbca9667c4d8a

data/README.md

@@ -14,8 +14,9 @@ build process.
 
 __Defaults__
 
-The following example uses the
-[default command line arguments](https://0x1eef.github.io/x/nanoc-tidy.rb/Nanoc/Tidy/Filter#default_argv-class_method):
+The following example executes tidy with the default settings. <br>
+See [Nanoc::Tidy.default_argv](https://0x1eef.github.io/x/nanoc-tidy.rb/Nanoc/Tidy/Filter#default_argv-class_method)
+for more details:
 
 ``` ruby
 # Rules
@@ -28,9 +29,11 @@ compile "/index.html.erb" do
 end
 ```
 
-__Options__
+__Option: argv__
 
-The following example forwards a command line argument:
+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):
 
 ```ruby
 # Rules
@@ -43,7 +46,24 @@ compile "/index.html.erb" do
 end
 ```
 
-## <a id='install'>Install</a>
+__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**
 
@@ -58,6 +78,6 @@ nanoc-tidy.rb can be installed via rubygems.org:
 
 ## License
 
-[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/).
+[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/)
 <br>
-See [LICENSE](./LICENSE).
+See [LICENSE](./LICENSE)

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

@@ -3,6 +3,7 @@
 module Nanoc::Tidy
   module Spawn
     require "fileutils"
+    require "test-cmd"
 
     ##
     # Spawns a process
@@ -13,29 +14,26 @@ module Nanoc::Tidy
     # @param [Array<String>] argv
     #  An array of command line arguments
     #
-    # @return [void]
-    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 = $?
+    # @return [Integer]
+    #  Returns the exit code of the spawned process
+    def spawn(exe, argv)
+      r = cmd(exe, *argv)
       ##
       # exit codes
       #  * 0: no warnings, no errors
       #  * 1: has warnings
       #  * 2: has errors
-      if [0, 1].include?(status.exitstatus)
-        status.exitstatus
+      if [0, 1].include?(r.exit_status)
+        r.exit_status
       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",
+              "(exit code: #{r.exit_status})\n" \
+              "(stdout: #{r.stdout&.chomp})\n" \
+              "(stderr: #{r.stderr&.chomp})\n",
               []
       end
-    ensure
-      File.exist?(logfile) ? FileUtils.rm(logfile) : nil
     end
   end
 end

data/lib/nanoc/tidy/version.rb

@@ -2,6 +2,6 @@
 
 module Nanoc
   module Tidy
-    VERSION = "0.7.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,8 +10,9 @@ 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"
   gem.add_development_dependency "redcarpet", "~> 3.5"
   gem.add_development_dependency "test-unit", "~> 3.6"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-tidy.rb
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.1
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-24 00:00:00.000000000 Z
+date: 2024-06-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: test-cmd.rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -122,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: []
@@ -166,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: []