asciidoctor-indir_ext 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ac1cb1e933768661f4dc12cc953cb837f4fa90c688b5de8ab3a207dad4900899
+  data.tar.gz: 11c4ebd2d95bf894373814071a085e9203b9bdac5cc72b1bdb5ebe18641c1532
+SHA512:
+  metadata.gz: 2626b1f64f3352831589bc5bdaf699f6f418d316d5bc2d89544045c5433da432f091ffa9993c12374f27b85ead4a1bc1f29bf46d05a6d7460730a66298c08fb3
+  data.tar.gz: 40517971948052677c1c8c8da6d706c34c175e97a1751bf372e78111325dcb047aaa31d8adf3745aa51c3a09ecf53caabe138a81fa5fa99bc332301a675c6e5a

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Johannes Harms
+
+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.md

@@ -0,0 +1,42 @@
+# Asciidoctor::IndirExt
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/asciidoctor/indir_ext`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'asciidoctor-indir_ext'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install asciidoctor-indir_ext
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+* After checking out the repo, run `bundle install` to install dependencies.
+* To list all available rake tasks, run `bundle exec rake -T`.
+* To build a gem package on your local machine, run `bundle exec rake build`.
+* To install this gem onto your local machine, run `bundle exec rake install`.
+* To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/asciidoctor-indir_ext.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/asciidoctor-indir_ext.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "asciidoctor/indir_ext/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "asciidoctor-indir_ext"
+  spec.version       = Asciidoctor::IndirExt::VERSION
+  spec.authors       = ["johannesjh"]
+  spec.email         = ["johannesjh@users.noreply.github.com"]
+
+  spec.summary       = "An Asciidoctor extension that adds a variable `indir`, which always points to the directory of the currently included asciidoc file"
+  spec.description   = %q(This Asciidoctor extension exposes a variable `indir`, which holds the path to the directory where the current asciidoc file is located.
+    The value of this variable changes to always reflect the location of the current, included subdocument.
+    (Note, this is in contrast to the `docfile` variable, which remains the same throughout an entire document).)
+  spec.homepage      = "https://github.com/johannesjh/asciidoctor-indir_ext"
+  spec.license       = "MIT"
+
+  spec.metadata = {
+    'bug_tracker_uri' => 'https://github.com/johannesjh/asciidoctor-indir_ext/issues',
+    'source_code_uri' => 'https://github.com/johannesjh/asciidoctor-indir_ext'
+  }
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files         = Dir['lib/**/*', '*.gemspec', 'LICENSE*', 'README*']
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'asciidoctor', '~> 1.5.6'
+  spec.add_runtime_dependency 'concurrent-ruby', '~> 1.1.3'
+  spec.add_runtime_dependency 'asciidoctor-include-ext', '~> 0.3.0'
+
+  spec.add_development_dependency 'asciidoctor-pdf', '~> 1.5.0.alpha.16' # to build a pdf of the example folder
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/asciidoctor/indir_ext.rb

@@ -0,0 +1,5 @@
+require_relative 'indir_ext/extension'
+
+Asciidoctor::Extensions.register do
+  include_processor Asciidoctor::IndirExt::IndirIncludeProcessor
+end

data/lib/asciidoctor/indir_ext/extension.rb

@@ -0,0 +1,82 @@
+require 'asciidoctor/include_ext/include_processor'
+
+module Asciidoctor
+  module IndirExt
+    ##
+    # Asciidoctor extension that adds a variable "indir", pointing at the directory of included asciidoc files.
+    #
+    # The indir variable always points at the directory where the current asciidoc file is located.
+    # The value of the indir variable changes to always reflect the location of the current, included subdocument.
+    # (Note: This is in contrast to the docfile variable, which remains the same throughout an entire document).
+    # The indir variable can be used to construct image paths relative to included subdocuments.
+    #
+    # Background:
+    # This extension was created to ease the handling of image paths in nested subdocuments,
+    # see https://github.com/asciidoctor/asciidoctor/issues/650#issuecomment-433946605.
+    #
+    # Motivation:
+    # The usage scenario that motivates this extension is a nested folder structure with asciidoc files,
+    # with images stored next to the asciidoc file where they are used.
+    # For example, an asciidoc file "sub/sub1.adoc" may use an image located at "sub/images/img1.svg".
+    # In this scenario, we want to be able to compile the asciidoc files in two ways,
+    # as standalone documents, and included into a parent document.
+    # The image paths should resolve fine in both cases.
+    #
+    # Intended Usage of the Extension:
+    #
+    # 1. In the beginning of a subdocument, add this line:
+    #   ifndef::indir[:indir: .]
+    #
+    # 2. Include images like this:
+    #   image::{indir}/images/example.svg[]
+    #
+    # 3. When compiling a master document (that includes other subdocuments), require this extension.
+    # The extension will set the indir variable to always point at the directory of the included asciidoc file,
+    # to that the an image path like "{indir}/images/example.svg" is resolved relative to the included subdocument.
+    #
+    # Note that the subdocuments compile just fine without the extension.
+    # This can be handy to use an editor's built-in preview feature.
+    # The extension is only needed when compiling a master document (that includes other subdocuments).
+    #
+    # Caveats, Future Work:
+    # This extension, once registered, claims to handle any includes
+    # (because it does not overwrite the "handles?" method of its parent class, which always return true).
+    # In consequence, it is difficult to use this extension together with other include processor extensions.
+    # A better solution with finer-grained control could be based on https://github.com/jirutka/asciidoctor-include-ext.
+    class IndirIncludeProcessor < Asciidoctor::IncludeExt::IncludeProcessor
+      def initialize(*args, &block)
+        # temporary storage helper that won't be frozen by Asciidoctor
+        @tmp = { }
+        super
+      end
+
+      def process(document, reader, target, attributes)
+        @tmp[:document] = document
+        @tmp[:reader] = reader
+        super
+      end
+
+      def read_lines(filename, selector)
+        # read content using functionality from super
+        content = super(filename, selector)
+
+        # split content into a list of lines if it has been provided as string
+        if content.is_a? String then content = content.lines end
+
+        # Set variables at the beginning of the included content
+        included_docfile = filename
+        included_docdir = ::File.dirname filename
+        content.unshift ''
+        content.unshift %(:indir: #{included_docdir})
+
+        # Reset the variables at the end of the included content
+        parent_docfile = @tmp[:reader].include_stack&.dig(-1, 1) || (@tmp[:document].attr 'docfile')
+        parent_docdir = ::File.dirname parent_docfile
+        content << ''
+        content << %(:indir: #{parent_docdir})
+
+        return content
+      end
+    end
+  end
+end

data/lib/asciidoctor/indir_ext/version.rb

@@ -0,0 +1,5 @@
+module Asciidoctor
+  module IndirExt
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-indir_ext
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- johannesjh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: asciidoctor-include-ext
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: asciidoctor-pdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0.alpha.16
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0.alpha.16
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: |-
+  This Asciidoctor extension exposes a variable `indir`, which holds the path to the directory where the current asciidoc file is located.
+      The value of this variable changes to always reflect the location of the current, included subdocument.
+      (Note, this is in contrast to the `docfile` variable, which remains the same throughout an entire document).
+email:
+- johannesjh@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- asciidoctor-indir_ext.gemspec
+- lib/asciidoctor/indir_ext.rb
+- lib/asciidoctor/indir_ext/extension.rb
+- lib/asciidoctor/indir_ext/version.rb
+homepage: https://github.com/johannesjh/asciidoctor-indir_ext
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/johannesjh/asciidoctor-indir_ext/issues
+  source_code_uri: https://github.com/johannesjh/asciidoctor-indir_ext
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: An Asciidoctor extension that adds a variable `indir`, which always points
+  to the directory of the currently included asciidoc file
+test_files: []