nanoc-tidy.rb 0.6.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc9b28f3f15fbbf7cfa46c1111b7d8c5a0b6c31f6363a7c90d74e08ce6894d8b
-  data.tar.gz: b57bd052f6d65a3c04edf7f145ee53ec60594df0caa8cd3c4f1b8f0259fd7449
+  metadata.gz: 133f30c53d54b2f5cea16c3877fa597d86b5db84bb240214459eee5e6a8c4f07
+  data.tar.gz: 8d054b51e4f6fbd7351fac5eb78ddcae57bcf175ebfea062c588daf9d5358c56
 SHA512:
-  metadata.gz: 26938031e1f797cbdcdc7ccada9b57c516c80c5ef9250c23dd36d4791b68e01e3f9f9262b37345f5cf76c89092c43730efd15f1546028b185e6a7d5e34ef36fd
-  data.tar.gz: 4e64a7be6793e07884f54455a3a447793ec1eb35852ffb2e96e058f345156a902107472aeeb1b852b3d12ecf4c303c3bf54639b8fe02901dbe08e14c707f8973
+  metadata.gz: 95b712fefeaf461ec57efe23fbcfada16a9be99498ee923affd4db983ffa522157f95b2659a4fd726d626296a515a6cb1631ca1ae890af7caa5e8ef82949716a
+  data.tar.gz: d83de9881073f9a53818fec78482c7a98023acc1bc798137b78a766b96f343cec659b54e06425cda3cd78c611d32a2b606c9f15cca466859ca3b95257e9cb4ef

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,10 @@ 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 +45,7 @@ compile "/index.html.erb" do
 end
 ```
 
-## <a id='install'>Install</a>
+## Install
 
 **Rubygems.org**
 
@@ -58,6 +60,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/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
 
@@ -34,14 +35,15 @@ module Nanoc::Tidy
     # @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)
+            [*default_argv, *(options[:argv] || []), "-modify", file.path]
+      File.read(file.path)
     ensure
-      rm(path) if File.exist?(path)
+      file&.unlink
     end
 
     private
@@ -50,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,9 @@
+# frozen_string_literal: true
+
 module Nanoc::Tidy
   module Spawn
-    require "securerandom"
     require "fileutils"
-    Error = Class.new(RuntimeError)
+    require "test-cmd"
 
     ##
     # Spawns a process
@@ -13,45 +14,25 @@ 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:)
-      id = SecureRandom.hex
-      err = "#{err}+#{id}"
-      out = "#{out}+#{id}"
-      Kernel.spawn(
-        exe, *argv, { STDERR => err, STDOUT => out }
-      )
-      Process.wait
-      status = $?
+    def spawn(exe, argv)
+      r = cmd(exe, *argv)
       ##
       # exit codes
       #  * 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, ''), ":", "\n", File.binread(_1)].join
-      end.join("\n")
-      raise Error,
-            "#{File.basename(exe)} exited unsuccessfully " \
-            "(" \
-            "exit code: #{status.exitstatus}, " \
-            "item: #{item.identifier}" \
-            ")" \
-            "\n#{msgs}",
-            []
-    ensure
-      [err, out]
-        .select { File.exist?(_1) }
-        .each { FileUtils.rm(_1) }
+      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: #{r.exit_status})\n" \
+              "(stdout:\n#{r.stdout})\n" \
+              "(stderr:\n#{r.stderr})\n",
+              []
+      end
     end
   end
 end

data/lib/nanoc/tidy/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Nanoc
   module Tidy
-    VERSION = "0.6.2"
+    VERSION = "0.8.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,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.rb integrates tidy-html5 into nanoc"
+  gem.summary = "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"

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,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: nanoc-tidy.rb
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.8.0
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-29 00:00:00.000000000 Z
+date: 2024-06-14 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.rb integrates tidy-html5 into nanoc
+description: 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.rb integrates tidy-html5 into nanoc
+summary: nanoc + tidy-html5
 test_files: []