nanoc-tidy.rb 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ef9ec4aa2d04e43d4caed4ba3e2eecf7c835d81156e5a2025c0f2990470754c
-  data.tar.gz: d028d3cc3aaa355854fa3f1a234f85cba915c1b08b8e9d7b8f4e5865a293bd6e
+  metadata.gz: 377f965bc7630e3d0208011340dedea0c8e1463d17755d2ced834a5a2b10cec1
+  data.tar.gz: 2cac200122ecebbfcc9b0b28a8264bc83a0706ed8cdc4fdb4524e121aa977510
 SHA512:
-  metadata.gz: 6dfaf3bc792c4c7d079408132087c20ba0aac896692764c79efb2b110aae09a11566fb9af1010df197cfd25af6a43e16f7b7de0823ab6db7132278dc3e05f9d8
-  data.tar.gz: f94ce085f463bb1229f1d3e5b88b35d5c3a5e141d3ec5f5e20ce12d20e60e34da4e78751d51beb40b73a213e5a42a808f471b5239efb1d952f6f7d7e3ccd5df8
+  metadata.gz: '0159259928a18678becc9df9ada135133f8fbd917e15a479cc81d97d42cc8cb70ffc1df1a9aac1e5828dbb5af83e36163920c9ca288873185c14fc41eb541bb2'
+  data.tar.gz: 64592fabd2529dfa1b28f6c6f423702a0c38ae0dd72edcb029cd57818235533f4d750b78ad4667bf426a0560432c70e31193693c191133edc345d769150cf51b

data/README.md

@@ -13,14 +13,14 @@ 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
 require "nanoc-tidy"
 compile "/index.html.erb" do
+  layout("/default.*")
   filter(:erb)
   filter(:tidy)
   write("/index.html")
@@ -29,13 +29,14 @@ 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
 # Rules
 require "nanoc-tidy"
 compile "/index.html.erb" do
+  layout("/default.*")
   filter(:erb)
   filter(:tidy, "-upper" => true)
   write("/index.html")

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.
@@ -24,7 +29,7 @@ class Nanoc::Tidy::Filter < Nanoc::Filter
   private
 
   def tidy(file, options)
-    system "tidy", "-modify", "-quiet", *tidy_args(options), file.path
+    system tidy_exe, "-modify", "-quiet", *tidy_args(options), file.path
     if $?.success?
       File.read(file.path).tap { file.tap(&:unlink).close }
     else
@@ -42,6 +47,14 @@ 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
+  end
+
   def temporary_file_for(content)
     dir = File.join(Dir.getwd, "tmp", "nanoc-tidy.rb")
     mkdir_p(dir) unless Dir.exist?(dir)

data/lib/nanoc/tidy/version.rb

@@ -1,5 +1,5 @@
 module Nanoc
   module Tidy
-    VERSION = "0.2.1"
+    VERSION = "0.3.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.1
+  version: 0.3.0
 platform: ruby
 authors:
 - '0x1eef'
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-14 00:00:00.000000000 Z
+date: 2024-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -148,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: nanoc-tidy.rb integrates tidy-html5 into nanoc.