nanoc-weasyprint.rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 754742e20e7029fec88fcbd708ab45504935f37f283eb78f6a91722be7a79119
+  data.tar.gz: d88b791fd6247156b2b607c5ae331307933883ae64ec8f6a4a8db02aade2bab2
+SHA512:
+  metadata.gz: d3a95584be1306e396284692bb0dd893774386918fdf342bb884dcad0c7e75063fa5f2d8806983ab5759d4eed0256929dc63c1175b0c357ec0bd9d80b339e84f
+  data.tar.gz: 9daefce2312c4e6d8887c81836263d340c6d0f71115696ce6332fb6960e0f0628dcc3c68bac8f1f166475f4d17dcb42d8a161bb23b334c17aa946c8e49c7e5ff

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,66 @@
+## About
+
+nanoc-weasyprint.rb is a
+[nanoc](https://nanoc.app)
+filter that integrates
+[weasyprint](https://github.com/Kozea/WeasyPrint)
+into nanoc.
+The filter can create PDF documents from markdown
+and other markup languages during the
+[nanoc](https://nanoc.app)
+build process.
+
+## Examples
+
+__Defaults__
+
+The following example uses the
+[default command-line options](https://0x1eef.github.io/x/nanoc-weasyprint.rb/Nanoc/WeasyPrint/Filter#default_options-class_method):
+
+``` ruby
+# Rules
+require "nanoc-weasyprint"
+compile "/example.md" do
+  layout("/default.*")
+  filter(:kramdown)
+  write("/example.html")
+  filter(:weasyprint)
+  write("/example.pdf")
+end
+```
+
+__Options__
+
+The following example forwards command-line options to
+[weasyprint](https://github.com/Kozea/WeasyPrint):
+
+```ruby
+# Rules
+require "nanoc-weasyprint"
+compile "/example.md" do
+  layout("/default.*")
+  filter(:kramdown)
+  write("/example.html")
+  filter(:weasyprint, argv: ["--encoding", "UTF-8"])
+  write("/example.pdf")
+end
+```
+
+## <a id='install'>Install</a>
+
+**Rubygems.org**
+
+nanoc-weasyprint.rb can be installed via rubygems.org.
+
+    gem install nanoc-weasyprint.rb
+
+## Sources
+
+* [GitHub](https://github.com/0x1eef/nanoc-weasyprint.rb#readme)
+* [GitLab](https://gitlab.com/0x1eef/nanoc-weasyprint.rb#about)
+
+## License
+
+[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/).
+<br>
+See [LICENSE](./LICENSE).

data/lib/nanoc/weasyprint/filter.rb

@@ -0,0 +1,49 @@
+module Nanoc::WeasyPrint
+  class Filter < Nanoc::Filter
+    require "fileutils"
+    require_relative "spawn"
+    include Spawn
+    include FileUtils
+
+    identifier :weasyprint
+    type text: :binary
+
+    ##
+    # @return [Array<String>]
+    #  The default command line options forwarded to weasyprint.
+    def self.default_argv
+      []
+    end
+
+    ##
+    # @param [String] content
+    #  HTML contnet.
+    #
+    # @param [Hash] options
+    #  Filter options.
+    #
+    # @return [void]
+    def run(content, options = {})
+      spawn "weasyprint",
+            [*default_argv, *(options[:argv] || []), temporary_file(content).path, output_filename],
+            log: File.join(tmpdir, "weasyprint.log")
+    end
+
+    private
+
+    def default_argv
+      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)
+    end
+
+    def tmpdir
+      File.join(Dir.getwd, "tmp", "weasyprint")
+    end
+  end
+end

data/lib/nanoc/weasyprint/spawn.rb

@@ -0,0 +1,19 @@
+module Nanoc::WeasyPrint
+  module Spawn
+    Error = Class.new(RuntimeError)
+    def spawn(exe, argv, log:)
+      Kernel.spawn(
+        exe, *argv, { STDOUT => log, STDERR => log }
+      )
+      Process.wait
+      unless $?.success?
+        raise Error,
+              "#{File.basename(exe)} exited unsuccessfully " \
+              "(exit code: #{$?.exitstatus}, " \
+              "item: #{item.identifier}, " \
+              "log: #{log.gsub(Dir.getwd, '')[1..]})",
+              []
+      end
+    end
+  end
+end

data/lib/nanoc/weasyprint/version.rb

@@ -0,0 +1,5 @@
+module Nanoc
+  module WeasyPrint
+    VERSION = "0.1.0"
+  end
+end

data/lib/nanoc/weasyprint.rb

@@ -0,0 +1,15 @@
+##
+# nanoc-weasyprint.rb is a [nanoc](https://nanoc.app)
+# filter that integrates [weasyprint](https://github.com/Kozea/WeasyPrint)
+# into nanoc. The filter can create PDF documents
+# from markdown and other markup languages during the
+# [nanoc](https://nanoc.app) build process.
+module Nanoc::WeasyPrint
+  require_relative "weasyprint/filter"
+
+  ##
+  # @return (see Nanoc::WeasyPrint::Filter.default_argv)
+  def self.default_argv
+    Filter.default_argv
+  end
+end

data/lib/nanoc-weasyprint.rb

@@ -0,0 +1,2 @@
+require "nanoc"
+require_relative "nanoc/weasyprint"

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: nanoc-weasyprint.rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- '0x1eef'
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-03-29 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-weasyprint.rb integrates weasyprint into nanoc.
+email:
+- 0x1eef@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/nanoc-weasyprint.rb
+- lib/nanoc/weasyprint.rb
+- lib/nanoc/weasyprint/filter.rb
+- lib/nanoc/weasyprint/spawn.rb
+- lib/nanoc/weasyprint/version.rb
+homepage: https://github.com/0x1eef/nanoc-weasyprint.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.5.3
+signing_key:
+specification_version: 4
+summary: nanoc-weasyprint.rb integrates weasyprint into nanoc.
+test_files: []