nanoc-tidy.rb 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 82bb7fbdab23c96d587126887440424d6952c7e083fafb48385d1daad72459ab
+  data.tar.gz: 72960c21694c0a722fac6c6a3c09b2b78250fc3033dac85b6c11ed838f001726
+SHA512:
+  metadata.gz: 48d64352f129d1593b0e6f787a53a15cf3dc72b1700d7dc82d8c60aaf6b8895345f54f612305d67f1868a95adfd3cdecd544343b91844adc1bab47dbdd4c0d59
+  data.tar.gz: feb6516507e522d664dfb9194efb2897f0bdea0bf9515276e3be84ee27ab493f4281d16c723048c88e9033d203f532af449bae803912bdc14b6f31c6e716b2ea

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_PATH: ".gems"

data/.github/workflows/tests.yml

@@ -0,0 +1,24 @@
+name: nanoc-tidy.rb
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  specs:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        ruby: [3.1, 3.2]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - run: sudo apt-get install tidy
+    - run: bundle install
+    - run: rake

data/.gitignore

@@ -0,0 +1,2 @@
+.gems/
+*.lock

data/.projectile

@@ -0,0 +1,6 @@
+-.gems/
++.github/
++lib/
++test/
++.bundle/
++.

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,15 @@
+Copyright (C) 2023 by 0x1eef <0x1eef@protonmail.com>
+
+Permission to use, copy, modify, and/or distribute this
+software for any purpose with or without fee is hereby
+granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS
+ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
+EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
+RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
+ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+## About
+
+nanoc-tidy.rb is a
+[nanoc](https://nanoc.app)
+filter that utilizes
+[tidy-html5](https://github.com/htacg/tidy-html5)
+to nicely format, and detect / correct markup
+errors in HTML produced by template languages such as ERB -
+where misaligned indentation and other whitespace issues
+are often commonplace.
+
+## Examples
+
+__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:
+
+``` ruby
+# Rules
+require "nanoc-tidy"
+compile "/index.html.erb" do
+  filter(:erb)
+  filter(:tidy)
+  write("/index.html")
+end
+```
+
+__Options__
+
+The following example forwards command-line options to
+[tidy-html5](https://github.com/htacg/tidy-html5):
+
+```ruby
+# Rules
+require "nanoc-tidy"
+compile "/index.html.erb" do
+  filter(:erb)
+  filter(:tidy, "-upper" => true)
+  write("/index.html")
+end
+```
+
+## Sources
+
+* [Source code (GitHub)](https://github.com/0x1eef/nanoc-tidy.rb)
+* [Source code (GitLab)](https://gitlab.com/0x1eef/nanoc-tidy.rb)
+
+## <a id='install'>Install</a>
+
+nanoc-tidy.rb is distributed as a RubyGem through its git repositories. <br>
+[GitHub](https://github.com/0x1eef/nanoc-tidy.rb),
+and
+[GitLab](https://gitlab.com/0x1eef/nanoc-tidy.rb)
+are available as sources.
+
+**Gemfile**
+
+```ruby
+gem "nanoc-tidy.rb", github: "0x1eef/nanoc-tidy.rb"
+```
+
+## License
+
+[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/).
+<br>
+See [LICENSE](./LICENSE).

data/Rakefile.rb

@@ -0,0 +1,8 @@
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+  t.warning = false
+end
+task default: :test

data/lib/nanoc/tidy/filter.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+class Nanoc::Tidy::Filter < Nanoc::Filter
+  require "fileutils"
+  include FileUtils
+  Error = Class.new(RuntimeError)
+
+  identifier :tidy
+  type text: :text
+
+  ##
+  # @return [{"-wrap" => 120, "-indent" => true}]
+  #  Returns the default options forwarded as command-line
+  #  arguments to tidy-html5.
+  def self.default_options
+    @default_options ||= {"-wrap" => 120, "-indent" => true}
+  end
+
+  def run(content, options = {})
+    file = temporary_file_for(content)
+    tidy file, self.class.default_options.merge(options)
+  end
+
+  private
+
+  def tidy(file, options)
+    system "tidy", "-modify", "-quiet", *tidy_args(options), file.path
+    if $?.success?
+      File.read(file.path).tap { file.tap(&:unlink).close }
+    else
+      raise Error, "tidy exited unsuccessfully (exit code: #{$?.exitstatus})", []
+    end
+  end
+
+  def tidy_args(options)
+    options.each_with_object([]) do |(key, value), ary|
+      if value.equal?(true)
+        ary << key
+      else
+        ary.concat [key, value.to_s]
+      end
+    end
+  end
+
+  def temporary_file_for(content)
+    dir = File.join(Dir.getwd, "tmp", "nanoc-tidy.rb")
+    mkdir_p(dir) unless Dir.exist?(dir)
+    file = Tempfile.new(File.basename(item.identifier.to_s), dir)
+    file.write(content)
+    file.tap(&:flush)
+  end
+end

data/lib/nanoc/tidy/version.rb

@@ -0,0 +1,5 @@
+module Nanoc
+  module Tidy
+    VERSION = "0.2.0"
+  end
+end

data/lib/nanoc/tidy.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "nanoc"
+module Nanoc::Tidy
+  require_relative "tidy/version"
+  require_relative "tidy/filter"
+end

data/lib/nanoc-tidy.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require_relative "nanoc/tidy"

data/nanoc-tidy.rb.gemspec

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "./lib/nanoc/tidy/version"
+Gem::Specification.new do |gem|
+  gem.name = "nanoc-tidy.rb"
+  gem.authors = ["0x1eef"]
+  gem.email = ["0x1eef@protonmail.com"]
+  gem.homepage = "https://github.com/0x1eef/nanoc-tidy.rb#readme"
+  gem.version = Nanoc::Tidy::VERSION
+  gem.licenses = ["0BSD"]
+  gem.files = `git ls-files`.split($/)
+  gem.require_paths = ["lib"]
+  gem.summary = "nanoc-tidy.rb integrates tidy-html5 into nanoc."
+  gem.description = gem.summary
+  gem.add_development_dependency "yard", "~> 0.9"
+  gem.add_development_dependency "redcarpet", "~> 3.5"
+  gem.add_development_dependency "test-unit", "~> 3.6"
+  gem.add_development_dependency "standard", "~> 1.13"
+  gem.add_development_dependency "nanoc", "~> 4.12"
+  gem.add_development_dependency "rack", "~> 3.0"
+  gem.add_development_dependency "rackup", "~> 2.1"
+end

data/test/fixtures/fixture.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>1.html</title>
+  </head>
+  <body>
+    <p>
+             foo
+             </p>
+</body>
+  </html>

data/test/results/default_options.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>1.html</title>
+</head>
+<body>
+  <p>foo</p>
+</body>
+</html>

data/test/results/upper_option.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<HTML>
+<HEAD>
+  <TITLE>1.html</TITLE>
+</HEAD>
+<BODY>
+  <P>foo</P>
+</BODY>
+</HTML>

data/test/setup.rb

@@ -0,0 +1,3 @@
+require "bundler/setup"
+require "test/unit"
+require "nanoc-tidy"

data/test/tidy_filter_test.rb

@@ -0,0 +1,41 @@
+require_relative "setup"
+
+class FilterTest < Test::Unit::TestCase
+  def test_default_options
+    options = { "--tidy-mark" => false }
+    assert_equal filter_for("fixture.html").run(html, options),
+                 read_result("default_options.html")
+  end
+
+  def test_upper_option
+    options = { "-upper" => true, "--tidy-mark" => false }
+    assert_equal filter_for("fixture.html").run(html, options),
+                 read_result("upper_option.html")
+
+  end
+
+  private
+
+  def filter_for(basename)
+    @filter ||= begin
+      filter = Nanoc::Tidy::Filter.new
+      filter.extend module_for(basename)
+    end
+  end
+
+  def module_for(basename)
+    Module.new do
+      define_method(:item) do
+        OpenStruct.new(identifier: basename)
+      end
+    end
+  end
+
+  def read_result(basename)
+    File.binread File.join("test", "results", basename)
+  end
+
+  def html
+    File.binread "./test/fixtures/fixture.html"
+  end
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: nanoc-tidy.rb
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- '0x1eef'
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: nanoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.12'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rackup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: nanoc-tidy.rb integrates tidy-html5 into nanoc.
+email:
+- 0x1eef@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".bundle/config"
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- ".projectile"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile.rb
+- lib/nanoc-tidy.rb
+- lib/nanoc/tidy.rb
+- lib/nanoc/tidy/filter.rb
+- lib/nanoc/tidy/version.rb
+- nanoc-tidy.rb.gemspec
+- test/fixtures/fixture.html
+- test/results/default_options.html
+- test/results/upper_option.html
+- test/setup.rb
+- test/tidy_filter_test.rb
+homepage: https://github.com/0x1eef/nanoc-tidy.rb#readme
+licenses:
+- 0BSD
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: nanoc-tidy.rb integrates tidy-html5 into nanoc.
+test_files: []