guard-asciidoc 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 621a8d0d226fdec058e5239ae62091c1998b96378b7732c9038fb4e3d7f733f2
+  data.tar.gz: 057e64e55fce0abf3abf84260b9467a654112afa04aaffacb387f267eb0ad471
+SHA512:
+  metadata.gz: f55e6ec7ecf4969d6ca53f0af21507a3ce04f84cd22a4aeaea5961f371448769148d84abba65b6833e12405f3f99941913b6e4437cb2bb9a1bb7e9d8adcef009
+  data.tar.gz: 5ae5ca408016dfb46dc17df32662790dce054cc74e0f9efe4c72ec30de27ff84ad4ded72c7acf110426cee775befbbe4b0916da7cc5383122b2b6226d4ce2c84

data/CHANGELOG.adoc

@@ -0,0 +1,13 @@
+= Guard AsciiDoc Changelog
+:url-repo: https://github.com/asciidoctor/guard-asciidoc
+
+This document provides a curated view of the changes to Guard AsciiDoc in each release.
+For a detailed view of what has changed, refer to the {url-repo}/commits/main[commit history] on GitHub.
+
+== 1.0.0 (2023-10-30) - @mojavelinux
+
+Initial release.
+=== Details
+
+{url-repo}/releases/tag/v1.0.0[git tag]
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013-present Paul Rayner
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.adoc

@@ -0,0 +1,136 @@
+= Guard::AsciiDoc
+Paul Rayner; Dan Allen <https://github.com/mojavelinux[@mojavelinux]>
+v1.0.0, 2023-10-30
+:idprefix:
+:idseparator: -
+:url-rvm: https://rvm.io
+:url-repo: https://github.com/asciidoctor/guard-asciidoc
+
+Guard::AsciiDoc is a plugin for Guard that uses Asciidoctor to convert watched AsciiDoc files to the specified output format.
+
+AsciiDoc:: https://asciidoc.org
+Guard:: https://github.com/guard/guard
+Asciidoctor:: https://github.com/asciidoctor/asciidoctor
+
+== Prerequisites
+
+Guard::AsciiDoc is a plugin for Guard, which is a Ruby application you install using Ruby packaging.
+To run Guard with this plugin, you need Ruby 3.0 or better.
+
+Run the following command to check which version of Ruby you have installed, if any:
+
+ $ ruby -v
+
+If Ruby is not installed, you can install it using {url-rvm}[RVM] (or, if you prefer, the package manager for your system).
+We generally recommend using RVM as it allows you to install gems without requiring elevated privileges or messing with system libraries.
+
+== Installation
+
+Set up your [.path]_Gemfile_:
+
+[,ruby]
+.Gemfile
+----
+source 'https://rubygems.org'
+
+gem 'guard-asciidoc'
+----
+
+Install the dependencies:
+
+ $ bundle config set --local path .bundle/gems
+   bundle
+
+Create a [.path]_Guardfile_ at the root of the project by running:
+
+ $ bundle exec guard init
+
+Now you can run Guard so it starts watching your files:
+
+ $ bundle exec guard
+
+In the console, you should see:
+
+ INFO - Guard::AsciiDoc is now watching for changes
+ INFO - Guard is now watching at '/path/to/current/directory'
+
+By default, the plugin looks for all AsciiDoc files in the project.
+
+== Configuration
+
+You can then configure the options of the plugins.
+For example, if your docs are located in the [.path]_docs_ folder, you can tell the plugin watch this folder instead of the root folder:
+
+[,ruby]
+.Guardfile
+----
+guard :asciidoc, watch_dir: 'docs'
+----
+
+You can also set AsciiDoc attributes:
+
+[,ruby]
+.Guardfile
+----
+guard :asciidoc, attributes: { 'toc' => '' }
+----
+
+If you want to convert to PDF, you first need to declare a dependency on the *asciidoctor-pdf* gem:
+
+ $ bundle add asciidoctor-pdf
+
+Now set the `:backend` option to `:pdf` in [.path]_Guardfile_.
+
+[,ruby]
+.Guardfile
+----
+guard :asciidoc, backend: :pdf
+----
+
+You can also require an extension, such as Asciidoctor Diagram.
+You first need to declare a dependency on the *asciidoctor-diagram* gem:
+
+ $ bundle add asciidoctor-diagram
+
+Now add *asciidoctor-diagram* to the `:requires` option in [.path]_Guardfile_.
+
+[,ruby]
+.Guardfile
+----
+guard :asciidoc, requires: ['asciidoctor-diagram']
+----
+
+If you want to output files to a build directory, such as [.path]_build_, set the `:to_dir` option in [.path]_Guardfile_.
+When the `:to_dir` option is specified, the directory structure of the input file is preserved (relative to the `:watch_dir` value, if present, or the project root otherwise).
+
+[,ruby]
+.Guardfile
+----
+guard :asciidoc, to_dir: 'build'
+----
+
+You can combine any of the options mentioned previously.
+
+By default, the plugin looks for files that have the `.adoc` file extension.
+If you want to watch for files with other file extensions, or in other folders, you can set up a custom watcher in [.path]_Guardfile_.
+Note that if you define a watcher, the default watcher will not be created (and hence the `:watch_dir` option is not relevant).
+
+[,ruby]
+.Guardfile
+----
+guard :asciidoc
+  watch %r{^docs/.+\.adoc$}
+  watch(%r{^docs/.+\.rb$}) { 'docs' }
+end
+----
+
+== Copyright and License
+
+Copyright (C) 2013-present Paul Rayner and Dan Allen.
+Use of this software is granted under the terms of the MIT License.
+
+See the link:LICENSE[LICENSE] for the full license text.
+
+== Trademarks
+
+AsciiDoc(R) and AsciiDoc Language(TM) are trademarks of the Eclipse Foundation, Inc.

data/guard-asciidoc.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+begin
+  require_relative 'lib/guard/asciidoc/version'
+rescue LoadError
+  require 'guard/asciidoc/version'
+end
+
+Gem::Specification.new do |s|
+  s.name = 'guard-asciidoc'
+  s.version = Guard::AsciiDocVersion::VERSION
+  s.summary = 'Guard::AsciiDoc automatically converts your AsciiDoc documents.'
+  s.description = 'Watches the specified source folder and automatically converts AsciiDoc documents to the backend format into a target directory.'
+  s.authors = ['Paul Rayner', 'Dan Allen']
+  s.email = ['paul@virtual-genius.com']
+  s.homepage = 'https://github.com/asciidoctor/guard-asciidoc'
+  s.license = 'MIT'
+
+  s.metadata = {
+    'bug_tracker_uri' => 'https://github.com/asciidoctor/guard-asciidoc/issues',
+    'changelog_uri' => 'https://github.com/asciidoctor/guard-asciidoc/blob/main/CHANGELOG.adoc',
+    'mailing_list_uri' => 'https://chat.asciidoctor.org',
+    'source_code_uri' => 'https://github.com/asciidoctor/guard-asciidoc'
+  }
+
+  # NOTE the logic to build the list of files is designed to produce a usable package even when the git command is not available
+  begin
+    files = (result = `git ls-files -z`.split ?\0).empty? ? Dir['**/*'] : result
+  rescue
+    files = Dir['**/*']
+  end
+  s.files = files.grep %r/^(?:lib\/.+|LICENSE|(?:CHANGELOG|README)\.adoc|#{s.name}\.gemspec)$/
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'guard', '~> 2.18.0'
+  s.add_dependency 'guard-compat', '~> 1.2.0'
+  s.add_dependency 'asciidoctor', '~> 2.0'
+
+  s.add_development_dependency 'rake', '~> 13.1.0'
+  s.add_development_dependency 'rspec', '~> 3.12.0'
+end

data/lib/guard/asciidoc/templates/Guardfile

@@ -0,0 +1,11 @@
+# options:
+# :watch_dir - sets which directory to watch if no watches are specified
+# :watch_ext - sets which file extensions to watch if no watches are specified
+# :watch_hidden - if true, sets whether to watch hidden files
+# :run_on_start - if true, run when Guard is starting; otherwise, wait for a change
+# :always_build_all - if true, always build all files instead of files which changed
+guard :asciidoc do
+  # uncomment to customize the watch patterns; alternately, use :watch_dir to change which directory the plugin watches
+  #watch %r{^docs/.+\.adoc$}
+  #watch 'README.adoc'
+end

data/lib/guard/asciidoc/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Guard
+  module AsciiDocVersion
+    VERSION = '1.0.0'
+  end
+end

data/lib/guard/asciidoc.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'guard/compat/plugin'
+autoload :Pathname, 'pathname'
+
+module Guard
+  class AsciiDoc < Plugin
+    BACKEND_ALIASES = { 'html' => 'html5', 'docbook' => 'docbook5' }
+    DEFAULT_BACKEND = 'html5'
+    DEFAULT_OPTIONS = {
+      watch_dir: '.',
+      watch_ext: %w(adoc),
+      watch_hidden: false,
+      run_on_start: false,
+      always_build_all: false,
+    }
+    FILE_SEPARATOR = ::File::SEPARATOR
+    PLUGIN_KEYS = [:any_return, :group, :watchers]
+    CONFIG_KEYS = DEFAULT_OPTIONS.keys
+
+    attr_reader :asciidoc_opts
+
+    def initialize options = {}
+      compiled_opts = DEFAULT_OPTIONS.merge
+      compiled_opts[:watch_dir] = (options.delete :watch_dir) || '.' if options.key? :watch_dir
+      compiled_opts.merge! options
+      compiled_opts[:watch_dir] = '.' if compiled_opts[:watch_dir].to_s.empty?
+      @asciidoc_opts = compiled_opts.except(*(PLUGIN_KEYS + CONFIG_KEYS))
+      unless (@asciidoc_opts[:backend] = BACKEND_ALIASES[(backend = @asciidoc_opts[:backend])] || backend)
+        @asciidoc_opts[:backend] = DEFAULT_BACKEND
+      end
+      case (attributes = @asciidoc_opts[:attributes] ||= {})
+      when ::Hash
+        attributes['env-guard'] = ''
+      when ::Array
+        attributes << 'env-guard'
+      when ::String
+        @asciidoc_opts[:attributes] += ' env-guard'
+      end
+      @asciidoc_opts[:safe] ||= :unsafe
+      if (compiled_opts[:watchers] ||= []).empty? && (watch_dir = compiled_opts[:watch_dir])
+        watch_dir = compiled_opts[:watch_dir] = (::Pathname.new watch_dir).cleanpath.to_s
+        watch_re = watch_dir == '.' ? '' : %(^#{::Regexp.escape watch_dir}(?=#{FILE_SEPARATOR}))
+        watch_re += compiled_opts[:watch_hidden] ? '.+?' : %((?:[^#{FILE_SEPARATOR}]|#{FILE_SEPARATOR}[^.])+?)
+        watch_re += %((?:#{compiled_opts[:watch_ext].join '|'})$)
+        watch_rx = ::Regexp.new watch_re
+        compiled_opts[:watchers] = [(Watcher.new watch_rx)]
+      end
+      super compiled_opts
+    end
+
+    def start
+      Compat::UI.info 'Guard::AsciiDoc is now watching files'
+      require 'asciidoctor'
+      require %(asciidoctor-#{asciidoc_opts[:backend]}) unless ::Asciidoctor::Converter.for asciidoc_opts[:backend]
+      if (requires = asciidoc_opts.delete :requires)
+        Array(requires).each {|require_| require require_ }
+      end
+      run_all if options[:run_on_start]
+    end
+
+    def run_all
+      run match_all, force: true
+    end
+
+    def run_on_changes paths
+      options[:always_build_all] ? run_all : (run paths)
+    end
+
+    alias run_on_additions run_on_changes
+    alias run_on_modifications run_on_changes
+
+    private
+
+    def run paths, force: nil
+      paths.each do |filepath|
+        if ::File.directory? filepath
+          run (match_all filepath), force: true
+        else
+          convert_asciidoc filepath, asciidoc_opts, force: force
+        end
+      end
+      true
+    end
+
+    def convert_asciidoc filepath, opts, force: nil
+      Compat::UI.info %(Converting#{force ? '' : ' changed'} file: #{filepath})
+      if (to_dir = opts[:to_dir])
+        filepath_segments = (::Pathname.new filepath).each_filename.to_a
+        if (watch_dir = options[:watch_dir]) != '.' && watch_dir == filepath_segments[0]
+          to_dir = File.join [to_dir] + (filepath_segments.slice 1...-1)
+        else
+          to_dir = File.join [to_dir] + (filepath_segments.slice 0...-1)
+        end
+      end
+      ::Asciidoctor.convert_file filepath, (to_dir ? (opts.merge mkdirs: true, to_dir: to_dir) : opts)
+    rescue => e
+      Compat::UI.error e.message
+      raise :task_has_failed
+    end
+
+    def match_all from = nil
+      glob = from ? (::File.join from, '**', '*.*') : (::File.join '**', '*.*')
+      (Compat.matching_files self, ::Dir[glob]).select {|it| ::File.file? it }
+    end
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: guard-asciidoc
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Paul Rayner
+- Dan Allen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.18.0
+- !ruby/object:Gem::Dependency
+  name: guard-compat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.12.0
+description: Watches the specified source folder and automatically converts AsciiDoc
+  documents to the backend format into a target directory.
+email:
+- paul@virtual-genius.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.adoc
+- LICENSE
+- README.adoc
+- guard-asciidoc.gemspec
+- lib/guard/asciidoc.rb
+- lib/guard/asciidoc/templates/Guardfile
+- lib/guard/asciidoc/version.rb
+homepage: https://github.com/asciidoctor/guard-asciidoc
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/asciidoctor/guard-asciidoc/issues
+  changelog_uri: https://github.com/asciidoctor/guard-asciidoc/blob/main/CHANGELOG.adoc
+  mailing_list_uri: https://chat.asciidoctor.org
+  source_code_uri: https://github.com/asciidoctor/guard-asciidoc
+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: Guard::AsciiDoc automatically converts your AsciiDoc documents.
+test_files: []