asciidoctor-diagram 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 429a698716d0d5cbdd6c579abe0b4b17294fa556
+  data.tar.gz: 410fa9e1683434a389503f90bfc251fff713bb7a
+SHA512:
+  metadata.gz: 811c4850dd0328025f961fac469ee7e9ae78635dae58a127884e3110bac4d6a031996ba9a7c77a44f592b4088152658f0cbcf257e921e7b78e629dc8cc5511e4
+  data.tar.gz: e8b358410c6107145a70edd1e819595a46283fa6d177a8534ec65946ce1476217bd49894a169bd56d8967ae1227b2731cf84164fc64bf0467f7020a3a2c35006

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+*.iml
+.idea
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby
+
+install:
+  - sudo apt-get install -qq graphviz
+  - bundle install

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in asciidoctor-diagram.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pepijn Van Eeckhoudt
+
+MIT License
+
+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,75 @@
+= Asciidoctor Diagram
+Pepijn Van_Eeckhoudt
+
+Asciidoctor Diagram is a set of extensions for http://asciidoctor.org[Asciidoctor], the Ruby-based AsciiDoc processor.
+These extensions allow you to embed diagrams written using the http://plantuml.sourceforge.net[PlantUML] or Ditaa syntax inside your AsciiDoc documents.
+The extension takes care of running the diagram processor to generate the images from the input text and insert them into the rendered document.
+
+This gem was inspired by the https://code.google.com/p/asciidoc-plantuml/[AsciiDoc PlantUML filter] for AsciiDoc Python.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'asciidoctor-diagram'
+```
+
+And then execute:
+
+ $ bundle
+
+Or install it yourself as:
+
+ $ gem install asciidoctor-diagram
+
+== Usage
+
+=== Enable the extensions
+
+The diagram extensions consist of a set of http://asciidoctor.org/docs/user-manual/#extension-points[block processors for Asciidoctor].
+In order to use extensions you should need to invoke Asciidoctor via the http://asciidoctor.org/docs/user-manual/#api[Ruby API].
+In your script you can then either require one or more of the following files:
+
+. `asciidoctor-diagram`: to enable all the diagramming extensions
+. `asciidoctor-diagram/ditaa`: to enable the ditaa extension
+. `asciidoctor-diagram/plantuml`: to enable the plantuml extension
+
+Requiring one or more of these files will automatically register the extensions for all processed documents. If you need
+more fine grained control over when the extensions are enabled or not, `asciidoctor-diagram/ditaa/extension` and `asciidoctor-diagram/plantuml/extension` can be used instead.
+This loads the extensions themselves but does not register them.
+You should then register the extensions yourself at the appropriate time using the `Asciidoctor::Extensions` API.
+
+=== Using the extensions
+
+Once the extensions are enabled support for `plantuml` and/or `ditaa` blocks becomes available for your documents.
+Detailed descriptions of the supported syntax inside these blocks is available on the http://plantuml.sourceforge.net/[PlantUML] and http://ditaa.sourceforge.net/[ditaa] websites.
+
+At this point you can start adding diagrams to your application, like the following example:
+
+----
+["plantuml", "asciidoctor-diagram-classes", "png"]
+---------------------------------------------------------------------
+class BlockProcessor
+class DiagramBlock
+class DitaaBlock
+class PlantUmlBlock
+
+BlockProcessor <|-- DiagramBlock
+DiagramBlock <|-- DitaaBlock
+DiagramBlock <|-- PlantUmlBlock
+---------------------------------------------------------------------
+----
+
+The diagram blocks support the following attributes:
+
+. `target` (or 2nd position): the basename of the file to generate. If not specified an auto-generated name will be used.
+. `format` (or 3rd position): the output format. PlantUML blocks support `png`, `svg` and `txt`. Ditaa only supports `png`.
+
+== Contributing
+
+. Fork it
+. Create your feature branch (`git checkout -b my-new-feature`)
+. Commit your changes (`git commit -am 'Add some feature'`)
+. Push to the branch (`git push origin my-new-feature`)
+. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:test)
+
+task :default => :test
+
+['ruby', 'java'].map do |platform|
+  $platform = platform
+  Gem::Specification.reset
+  spec = Gem::Specification.load('asciidoctor-diagram.gemspec')
+  Gem::PackageTask.new(spec) { |task| }
+end

data/asciidoctor-diagram.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'asciidoctor-diagram/version'
+
+$platform ||= RUBY_PLATFORM[/java/] || 'ruby'
+
+Gem::Specification.new do |spec|
+  spec.name          = "asciidoctor-diagram"
+  spec.version       = Asciidoctor::Diagram::VERSION
+  spec.authors       = ["Pepijn Van Eeckhoudt"]
+  spec.email         = ["pepijn@vaneeckhoudt.net"]
+  spec.description   = %q{Asciidoctor diagramming extension}
+  spec.summary       = %q{An extension for asciidoctor that adds support for UML diagram generation using PlantUML}
+  spec.platform      = $platform
+  spec.homepage      = "https://github.com/asciidoctor/asciidoctor-diagram"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency "asciidoctor", "~> 0.1.4"
+  spec.add_runtime_dependency "rjb", "~> 1.4.9" unless $platform == 'java'
+end

data/ditaamini-license.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/lib/asciidoctor-diagram.rb

@@ -0,0 +1,2 @@
+require 'asciidoctor-diagram/ditaa'
+require 'asciidoctor-diagram/plantuml'

data/lib/asciidoctor-diagram/binaryio.rb

@@ -0,0 +1,26 @@
+module Asciidoctor
+  module Diagram
+    class BinaryIO
+      def initialize(string)
+        @data = string
+        @offset = 0
+      end
+
+      def read_uint32_be
+        uint32 = @data[@offset,4].unpack('N')[0]
+        @offset += 4
+        uint32
+      end
+
+      def read_string(length, encoding = Encoding::ASCII_8BIT)
+        str = @data[@offset,length]
+        @offset += length
+        str.force_encoding(encoding)
+      end
+
+      def skip(length)
+        @offset += length
+      end
+    end
+  end
+end

data/lib/asciidoctor-diagram/diagram.rb

@@ -0,0 +1,111 @@
+require 'asciidoctor/extensions'
+require 'digest'
+require 'json'
+require_relative 'java'
+require_relative 'png'
+require_relative 'svg'
+
+module Asciidoctor
+  module Diagram
+    BLOCK_TYPES = {
+        :svg => :image,
+        :png => :image,
+        :txt => :asciiart
+    }
+
+    IMAGE_PARAMS = {
+        :svg => {
+            :encoding => Encoding::UTF_8,
+            :decoder => SVG
+        },
+        :png => {
+            :encoding => Encoding::ASCII_8BIT,
+            :decoder => PNG
+        }
+    }
+
+    class DiagramBlock < Asciidoctor::Extensions::BlockProcessor
+      option :contexts, [:listing, :literal, :open]
+      option :content_model, :simple
+      option :pos_attrs, ['target', 'format']
+      option :default_attrs, {'format' => 'png'}
+
+      def process(parent, reader, attributes)
+        diagram_code = reader.lines.join
+        format = attributes.delete('format').to_sym
+
+        raise "#{name} does not support output format #{format}" unless allowed_formats.include?(format)
+
+        case BLOCK_TYPES[format]
+          when :image
+            create_image_block(parent, diagram_code, attributes, format)
+          when :asciiart
+            create_ascii_art_block(parent, diagram_code, attributes)
+          else
+            raise "Unsupported output format: #{format}"
+        end
+      end
+
+      private
+
+      def create_image_block(parent, diagram_code, attributes, format)
+        target = attributes.delete('target')
+
+        checksum = code_checksum(diagram_code)
+
+        image_name = "#{target || checksum}.#{format}"
+        image_dir = File.expand_path(document.attributes['imagesdir'] || '', parent.document.attributes['docdir'])
+        image_file = File.expand_path(image_name, image_dir)
+        cache_file = File.expand_path("#{image_name}.cache", image_dir)
+
+        if File.exists? cache_file
+          metadata = File.open(cache_file, 'r') { |f| JSON.load f }
+        else
+          metadata = nil
+        end
+
+        unless File.exists?(image_file) && metadata && metadata['checksum'] == checksum
+          params = IMAGE_PARAMS[format]
+
+          result = generate_image(parent, diagram_code, format)
+
+          result.force_encoding(params[:encoding])
+
+          metadata = {'checksum' => checksum}
+          metadata['width'], metadata['height'] = params[:decoder].get_image_size(result)
+
+          File.open(image_file, 'w') { |f| f.write result }
+          File.open(cache_file, 'w') { |f| JSON.dump(metadata, f) }
+        end
+
+        attributes['target'] = image_name
+        attributes['width'] ||= metadata['width'] if metadata['width']
+        attributes['height'] ||= metadata['height'] if metadata['height']
+        attributes['alt'] ||= if (title_text = attributes['title'])
+                                title_text
+                              elsif target
+                                (File.basename target, (File.extname target) || '').tr '_-', ' '
+                              else
+                                'Diagram'
+                              end
+
+        Asciidoctor::Block.new parent, :image, :content_model => :empty, :attributes => attributes
+      end
+
+      def create_ascii_art_block(parent, diagram_code, attributes)
+        attributes.delete('target')
+
+        result = generate_text(parent, diagram_code)
+
+        result.force_encoding(Encoding::UTF_8)
+        Asciidoctor::Block.new parent, :literal, :source => result, :attributes => attributes
+      end
+
+      def code_checksum(code)
+        md5 = Digest::MD5.new
+        md5 << code
+        md5.hexdigest
+      end
+    end
+  end
+end