asciidoctor-indir_ext 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: deaebfcbdad3175d689bdf46707f0f5d61d3a51935f7b4b45c05c2a6831f0bf4
-  data.tar.gz: a922b30e24109594f39fa4a3b171e3e0aff1048668432f21ffa5d0ca7e63cc2a
+  metadata.gz: e223708a043aee7fe3db6aebe237e727d2074c4b9937ec3261b6d28b4a05185f
+  data.tar.gz: c0a899b375cf0b6bea009353fe30400b9ebafd2fba04f938e6fc391f3c361081
 SHA512:
-  metadata.gz: e10aee525cfd41a87df27c24ab2d8a9ee48be6b63c1bfa2294f4873412f0a1c29f99b6016850f59c8ac1e40fa9477124d224a1dbdc33767a5f7dbca8f70f2487
-  data.tar.gz: 0ffd97d129fc7664595398159013873d8031cfdf4a9a522a363eb9dc13a9e2ae4d8bf378cf8da5997df437316b691cdba94a0e16925fc270fda76df07d50b734
+  metadata.gz: 3012191c5aaaa9d528d7e70784d01306d78050580319632e9a69c160b5b1b0df4b0162fb992a8c40887ad6fe20df56596e56b01934bf1a9ba18a772a619ca4b8
+  data.tar.gz: 4e72e8dfd5c8d36f003b07d1726d76458b5502cfb2d2f26e65bb1068e916301e80fc6dc0f4778276189693f86da3cd37fb906f07ed70dd104bcde3f8e6fa957d

data/README.md

@@ -1,12 +1,13 @@
 # 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.
+An Asciidoctor extension that adds a variable `indir`, which always points to the directory of the currently included asciidoc file.
+
+This extension solves the problem that standard asciidoctor allows [no relative paths in subdocuments](https://github.com/asciidoctor/asciidoctor/issues/650), see  [asciidoctor issue #650](https://github.com/asciidoctor/asciidoctor/issues/650).
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
-Add this line to your application's Gemfile:
+If using bundler, add this line to your application's Gemfile:
 
 ```ruby
 gem 'asciidoctor-indir_ext'
@@ -14,15 +15,40 @@ gem 'asciidoctor-indir_ext'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
+
 
-Or install it yourself as:
+If you do not wish to use bundler, install as:
 
     $ gem install asciidoctor-indir_ext
 
+
 ## Usage
 
-TODO: Write usage instructions here
+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.
+
+For example:
+
+```bash
+bundle exec asciidoctor -r asciidoctor-indir_ext master.adoc
+```
+
+
+...or without bundler:
+
+```bash
+asciidoctor -r asciidoctor-indir_ext master.adoc
+```
+
+As a result, the extension provides an `indir` variable, which always points at the directory of the included asciidoc file. This allows image paths like `{indir}/images/example.svg` to be resolved relative to the included subdocument.
+
+
 
 ## Development
 
@@ -35,7 +61,16 @@ TODO: Write usage instructions here
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/asciidoctor-indir_ext.
+Bug reports and pull requests are welcome on GitHub at https://github.com/johannesjh/asciidoctor-indir_ext.
+
+
+
+## Credits
+
+This extension is based on another asciidoctor extension called [jirutka/asciidoctor-include-ext](https://github.com/jirutka/asciidoctor-include-ext), which provides a cleaner implementation of asciidoctor's include processing, and thus makes it easier to overwrite according behavior through an extension.
+
+Special thanks goes to [@mojavelinux](https://github.com/mojavelinux) for pointing out this solution in [asciidoctor issue #650](https://github.com/asciidoctor/asciidoctor/issues/650) and for providing valuable feedback.
+
 
 ## License
 

data/asciidoctor-indir_ext.gemspec

@@ -25,12 +25,12 @@ Gem::Specification.new do |spec|
   spec.files         = Dir['lib/**/*', '*.gemspec', 'LICENSE*', 'README*']
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'asciidoctor', '~> 1.5.6'
+  spec.add_runtime_dependency 'asciidoctor', '>= 1.5.6', '< 3.0.0'
   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 "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/asciidoctor/indir_ext/extension.rb

@@ -4,45 +4,6 @@ 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

data/lib/asciidoctor/indir_ext/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module IndirExt
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-indir_ext
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - johannesjh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-09 00:00:00.000000000 Z
+date: 2019-05-01 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
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -72,28 +78,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -146,8 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: An Asciidoctor extension that adds a variable `indir`, which always points