asciidoctor-diagram 1.3.0.preview.3 → 1.3.0.preview.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d2afa05e275154704010cd26743547999d25f7b
+  data.tar.gz: 35f0709598867295eeca7435718eaad9e7f6cae4
+SHA512:
+  metadata.gz: 4c5137cb403ced6164b826f22c76f485c0bd75e89b6017ea83c96c939fe97987d5576e3caa808a8b3f42082e428098a831c379a97e5f1f445da3270ff4e6d041
+  data.tar.gz: 1a4608f53e812b5c1cc205c24636d3fefaa5149c33410ca6ceace5402ef11d289695cc74a6846381b3689f3fd9ff127973bdc0104ea26a86e0649a57e3ec410c

data/CHANGELOG.adoc

@@ -8,8 +8,10 @@ Enhancements::
   * Add support for Actdiag diagrams (requires Actdiag to be installed separately)
   * Add support for Seqdiag diagrams (requires Seqdiag to be installed separately)
   * Add support for Nwdiag diagrams (requires Nwdiag to be installed separately)
-  * Updated PlantUML to revision 8004 (23/08/2014)
+  * Updated PlantUML to revision 8021 (14/03/2015)
   * Remove dependency on RJB to simplify installation
+  * Add diagram scaling support using the scale attribute
+  * Add Ditaa command line option support using the options attribute
 
 Bug Fixes::
 

data/README.adoc

@@ -14,6 +14,12 @@ The extension takes care of running the diagram processor to generate the images
 
 This gem was inspired by the https://code.google.com/p/asciidoc-plantuml/[AsciiDoc PlantUML filter] for AsciiDoc Python.
 
+== Status
+
+image:https://travis-ci.org/asciidoctor/asciidoctor-diagram.svg?branch=master["Linux Build Status", link="https://travis-ci.org/asciidoctor/asciidoctor-diagram"]
+
+image:https://ci.appveyor.com/api/projects/status/4r4gkk5gy3igs6nh/branch/master?svg=true["Windows Build Status", link="https://ci.appveyor.com/project/asciidoctor/asciidoctor-diagram"]
+
 == Installation
 
 Add this line to your application's Gemfile:
@@ -91,6 +97,12 @@ 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`. Graphviz, Shaape and BlockDiag support `png` and `svg`. Ditaa only supports `png`.
 
+Once you have all of this in place and your original AsciiDoc file contains a diagram block, it's time to build it into an HTML file with Asciidoctor Diagram magic! 
+When executing Asciidoctor, you must reference the Adciidoctor Diagram library, otherwise your diagam blocks won't be recognized as such. When executing Asciidoctor from the command line, do it using the -r parameter to reference this external library:
+
+$ asciidoctor -r asciidoctor-diagram doc.adoc
+
+
 == Contributing
 
 . Fork it

data/Rakefile

@@ -1,7 +1,12 @@
 require 'rubygems/package_task'
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:test)
+test = RSpec::Core::RakeTask.new(:test)
+
+if ENV['APPVEYOR']
+  # Exclude diagram types that require external libraries that are difficult to build on Windows.
+  test.exclude_pattern = 'spec/**/{blockdiag,shaape}_spec.rb'
+end
 
 task :default => :test
 

data/lib/asciidoctor-diagram.rb

@@ -2,4 +2,5 @@ require 'asciidoctor-diagram/blockdiag'
 require 'asciidoctor-diagram/ditaa'
 require 'asciidoctor-diagram/graphviz'
 require 'asciidoctor-diagram/plantuml'
+require 'asciidoctor-diagram/salt'
 require 'asciidoctor-diagram/shaape'

data/lib/asciidoctor-diagram/ditaa/extension.rb

@@ -10,12 +10,15 @@ module Asciidoctor
       end
       Java.classpath.concat JARS
 
-      def ditaa(code)
+      def ditaa(code, attrs)
         Java.load
 
         response = Java.send_request(
             :url => '/ditaa',
-            :body => code
+            :body => code,
+            :headers => {
+                'X-Options' => attrs.delete('options') || ''
+            }
         )
 
         unless response[:code] == 200
@@ -26,8 +29,26 @@ module Asciidoctor
       end
 
       def self.included(mod)
-        mod.register_format(:png, :image) do |c|
-          ditaa(c.to_s)
+        mod.register_format(:png, :image) do |c, _, attrs|
+          ditaa(c.to_s, attrs)
+        end
+      end
+
+      def create_source(parent, reader, attributes)
+        source = super(parent, reader, attributes)
+        source.extend DitaaSource
+        source
+      end
+
+      module DitaaSource
+        def should_process?(image_file, image_metadata)
+          super(image_file, image_metadata) || image_metadata['options'] != attributes['options']
+        end
+
+        def create_image_metadata
+          metadata = super
+          metadata['options'] = attributes['options']
+          metadata
         end
       end
     end

data/lib/asciidoctor-diagram/extensions.rb

@@ -27,6 +27,8 @@ module Asciidoctor
         #     File.read(source.to_s)
         #   end
         def register_format(format, type, &block)
+          raise "Unsupported output type: #{type}" unless type == :image || type == :literal
+
           unless @default_format
             @default_format = format
           end
@@ -35,7 +37,7 @@ module Asciidoctor
               :type => type,
               :generator => block
           }
-        end
+       end
 
         # Returns the registered formats
         #
@@ -93,13 +95,19 @@ module Asciidoctor
 
           raise "#{self.class.name} does not support output format #{format}" unless generator_info
 
-          case generator_info[:type]
-            when :image
-              create_image_block(parent, source, attributes, format, generator_info)
-            when :literal
-              create_literal_block(parent, source, attributes, generator_info)
-            else
-              raise "Unsupported output format: #{format}"
+          begin
+            case generator_info[:type]
+              when :literal
+                create_literal_block(parent, source, attributes, generator_info)
+              else
+                create_image_block(parent, source, attributes, format, generator_info)
+            end
+          rescue => e
+            text = "Failed to generate image: #{e.message}"
+            warn %(asciidoctor-diagram: ERROR: #{text})
+            text << "\n"
+            text << source.code
+            Asciidoctor::Block.new parent, :listing, :source => text, :attributes => attributes
           end
         end
 
@@ -133,10 +141,12 @@ module Asciidoctor
             metadata = {}
           end
 
+          image_attributes = attributes.dup
+
           if !File.exists?(image_file) || source.should_process?(image_file, metadata)
             params = IMAGE_PARAMS[format]
 
-            result = instance_exec(source, parent, &generator_info[:generator])
+            result = instance_exec(source, parent, image_attributes, &generator_info[:generator])
 
             result.force_encoding(params[:encoding])
 
@@ -148,12 +158,25 @@ module Asciidoctor
             File.open(metadata_file, 'w') { |f| JSON.dump(metadata, f) }
           end
 
-          image_attributes = attributes.dup
           image_attributes['target'] = image_name
+
+          scale = image_attributes['scale']
+          if scalematch = /(\d+)%/.match(scale)
+            scale_factor = scalematch[1].to_i / 100.0
+          else
+            scale_factor = 1.0
+          end
+
           if /html/i =~ parent.document.attributes['backend']
-            image_attributes['width'] ||= metadata['width'] if metadata['width']
-            image_attributes['height'] ||= metadata['height'] if metadata['height']
+            image_attributes.delete('scale')
+            if metadata['width'] && !image_attributes['width']
+              image_attributes['width'] = (metadata['width'] * scale_factor).to_i
+            end
+            if metadata['height'] && !image_attributes['height']
+              image_attributes['height'] = (metadata['height'] * scale_factor).to_i
+            end
           end
+
           image_attributes['alt'] ||= if title_text = attributes['title']
                                         title_text
                                       elsif target = attributes['target']
@@ -165,6 +188,16 @@ module Asciidoctor
           Asciidoctor::Block.new parent, :image, :content_model => :empty, :attributes => image_attributes
         end
 
+        def scale(size, factor)
+          if match = /(\d+)(.*)/.match(size)
+            value = match[1].to_i
+            unit = match[2]
+            (value * factor).to_i.to_s + unit
+          else
+            size
+          end
+        end
+
         def image_output_dir(parent)
           document = parent.document
 
@@ -270,6 +303,8 @@ module Asciidoctor
       class BasicSource
         include DiagramSource
 
+        attr_reader :attributes
+
         def initialize(attributes)
           @attributes = attributes
         end

data/lib/asciidoctor-diagram/plantuml/extension.rb

@@ -40,22 +40,46 @@ module Asciidoctor
 
       def self.included(mod)
         mod.register_format(:png, :image) do |c, p|
-          plantuml(p, c.to_s, 'uml', 'image/png')
+          plantuml(p, c.to_s, mod.tag, 'image/png')
         end
         mod.register_format(:svg, :image) do |c, p|
-          plantuml(p, c.to_s, 'uml', 'image/svg+xml')
+          plantuml(p, c.to_s, mod.tag, 'image/svg+xml')
         end
         mod.register_format(:txt, :literal) do |c, p|
-          plantuml(p, c.to_s, 'uml', 'text/plain;charset=utf-8')
+          plantuml(p, c.to_s, mod.tag, 'text/plain;charset=utf-8')
         end
       end
     end
 
     class PlantUmlBlockProcessor < Extensions::DiagramBlockProcessor
+      def self.tag
+        'uml'
+      end
+
       include PlantUml
     end
 
     class PlantUmlBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
+      def self.tag
+        'uml'
+      end
+
+      include PlantUml
+    end
+
+    class SaltBlockProcessor < Extensions::DiagramBlockProcessor
+      def self.tag
+        'salt'
+      end
+
+      include PlantUml
+    end
+
+    class SaltBlockMacroProcessor < Extensions::DiagramBlockMacroProcessor
+      def self.tag
+        'salt'
+      end
+
       include PlantUml
     end
   end

data/lib/asciidoctor-diagram/salt.rb

@@ -0,0 +1,9 @@
+require 'asciidoctor/extensions'
+require_relative 'version'
+
+Asciidoctor::Extensions.register do
+  require_relative 'plantuml/extension'
+
+  block Asciidoctor::Diagram::SaltBlockProcessor, :salt
+  block_macro Asciidoctor::Diagram::SaltBlockMacroProcessor, :salt
+end

data/lib/asciidoctor-diagram/util/cli_generator.rb

@@ -31,7 +31,7 @@ module Asciidoctor
 
           raise "#{tool} image generation failed" unless result_code == 0
 
-          File.read(target_file.path, :mode => 'rb')
+          File.binread(target_file.path)
         ensure
           target_file.unlink
         end

data/lib/asciidoctor-diagram/util/java.rb

@@ -4,7 +4,7 @@ module Asciidoctor
     module Java
       def self.classpath
         @classpath ||= [
-            File.expand_path(File.join('../..', 'asciidoctor-diagram-java-1.3.1.jar'), File.dirname(__FILE__))
+            File.expand_path(File.join('../..', 'asciidoctor-diagram-java-1.3.2.jar'), File.dirname(__FILE__))
         ]
       end
 

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "1.3.0.preview.3"
+    VERSION = "1.3.0.preview.4"
   end
 end

data/spec/ditaa_spec.rb

@@ -118,4 +118,70 @@ Doc Writer <doc@example.com>
     expect(target).to match /\.png$/
     expect(File.exists?(target)).to be true
   end
+
+  it "should support ditaa options as attributes" do
+    doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[ditaa, options="--no-shadows --no-separation --round-corners --scale 2.5"]
+----
++--------+   +-------+    +-------+
+|        | --+ ditaa +--> |       |
+|  Text  |   +-------+    |diagram|
+|Document|   |!magic!|    |       |
+|     {d}|   |       |    |       |
++---+----+   +-------+    +-------+
+    :                         ^
+    |       Lots of work      |
+    +-------------------------+
+----
+    eos
+
+    d = Asciidoctor.load StringIO.new(doc)
+    expect(d).to_not be_nil
+
+    b = d.find { |b| b.context == :image }
+    expect(b).to_not be_nil
+    target = b.attributes['target']
+    expect(target).to match /\.png$/
+    expect(File.exists?(target)).to be true
+  end
+
+  it "should regenerate images when options change" do
+    doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[ditaa, options="{opts}"]
+----
++--------+   +-------+    +-------+
+|        | --+ ditaa +--> |       |
+|  Text  |   +-------+    |diagram|
+|Document|   |!magic!|    |       |
+|     {d}|   |       |    |       |
++---+----+   +-------+    +-------+
+    :                         ^
+    |       Lots of work      |
+    +-------------------------+
+----
+    eos
+
+    d = Asciidoctor.load StringIO.new(doc.sub('{opts}', 'no-shadow'))
+    b = d.find { |b| b.context == :image }
+    target = b.attributes['target']
+    mtime1 = File.mtime(target)
+
+    sleep 1
+
+    d = Asciidoctor.load StringIO.new(doc.sub('{opts}', 'round-corners'))
+
+    mtime2 = File.mtime(target)
+
+    expect(mtime2).to be > mtime1
+  end
 end

data/spec/plantuml_spec.rb

@@ -335,7 +335,7 @@ User -> (Start)
 ----
     eos
 
-    d = Asciidoctor.load StringIO.new(doc), :attributes => {'backend' => 'docbook5' }
+    d = Asciidoctor.load StringIO.new(doc), :attributes => {'backend' => 'docbook5'}
     expect(d).to_not be_nil
 
     b = d.find { |b| b.context == :image }
@@ -347,4 +347,142 @@ User -> (Start)
     expect(b.attributes['width']).to be_nil
     expect(b.attributes['height']).to be_nil
   end
+
+  it "should support salt diagrams using salt block type" do
+    doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[salt, format="png"]
+----
+{
+  Just plain text
+  [This is my button]
+  ()  Unchecked radio
+  (X) Checked radio
+  []  Unchecked box
+  [X] Checked box
+  "Enter text here   "
+  ^This is a droplist^
+}
+----
+    eos
+
+    d = Asciidoctor.load StringIO.new(doc), :attributes => {'backend' => 'docbook5'}
+    expect(d).to_not be_nil
+
+    b = d.find { |b| b.context == :image }
+    expect(b).to_not be_nil
+
+    target = b.attributes['target']
+    expect(File.exists?(target)).to be true
+
+    expect(b.attributes['width']).to be_nil
+    expect(b.attributes['height']).to be_nil
+  end
+
+  it "should support salt diagrams using plantuml block type" do
+    doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[plantuml, format="png"]
+----
+salt
+{
+  Just plain text
+  [This is my button]
+  ()  Unchecked radio
+  (X) Checked radio
+  []  Unchecked box
+  [X] Checked box
+  "Enter text here   "
+  ^This is a droplist^
+}
+----
+    eos
+
+    d = Asciidoctor.load StringIO.new(doc), :attributes => {'backend' => 'docbook5'}
+    expect(d).to_not be_nil
+
+    b = d.find { |b| b.context == :image }
+    expect(b).to_not be_nil
+
+    target = b.attributes['target']
+    expect(File.exists?(target)).to be true
+
+    expect(b.attributes['width']).to be_nil
+    expect(b.attributes['height']).to be_nil
+  end
+
+  it "should support salt diagrams containing tree widgets" do
+    doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[plantuml, format="png"]
+----
+salt
+{
+{T
++A
+++a
+}
+}
+----
+    eos
+
+    d = Asciidoctor.load StringIO.new(doc), :attributes => {'backend' => 'docbook5'}
+    expect(d).to_not be_nil
+
+    b = d.find { |b| b.context == :image }
+    expect(b).to_not be_nil
+
+    target = b.attributes['target']
+    expect(File.exists?(target)).to be true
+
+    expect(b.attributes['width']).to be_nil
+    expect(b.attributes['height']).to be_nil
+  end
+
+  it "should support scaling diagrams" do
+    doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[plantuml, format="png"]
+----
+A -> B
+----
+    eos
+
+    scaled_doc = <<-eos
+= Hello, PlantUML!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[plantuml, format="png", scale="150%"]
+----
+A -> B
+----
+    eos
+
+    d = Asciidoctor.load StringIO.new(doc), :attributes => {'backend' => 'html5'}
+    unscaled_image = d.find { |b| b.context == :image }
+
+    d = Asciidoctor.load StringIO.new(scaled_doc), :attributes => {'backend' => 'html5'}
+    scaled_image = d.find { |b| b.context == :image }
+
+    expect(scaled_image.attributes['width']).to be_within(1).of(unscaled_image.attributes['width'] * 1.5)
+    expect(scaled_image.attributes['height']).to be_within(1).of(unscaled_image.attributes['height'] * 1.5)
+  end
 end

metadata

@@ -1,78 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-diagram
 version: !ruby/object:Gem::Version
-  version: 1.3.0.preview.3
-  prerelease: 6
+  version: 1.3.0.preview.4
 platform: ruby
 authors:
 - Pepijn Van Eeckhoudt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-30 00:00:00.000000000 Z
+date: 2015-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: asciidoctor
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.0
 description: Asciidoctor diagramming extension
@@ -90,7 +81,7 @@ files:
 - examples/README.adoc
 - examples/design.adoc
 - examples/features.adoc
-- lib/asciidoctor-diagram-java-1.3.1.jar
+- lib/asciidoctor-diagram-java-1.3.2.jar
 - lib/asciidoctor-diagram.rb
 - lib/asciidoctor-diagram/blockdiag.rb
 - lib/asciidoctor-diagram/blockdiag/extension.rb
@@ -101,6 +92,7 @@ files:
 - lib/asciidoctor-diagram/graphviz/extension.rb
 - lib/asciidoctor-diagram/plantuml.rb
 - lib/asciidoctor-diagram/plantuml/extension.rb
+- lib/asciidoctor-diagram/salt.rb
 - lib/asciidoctor-diagram/shaape.rb
 - lib/asciidoctor-diagram/shaape/extension.rb
 - lib/asciidoctor-diagram/util/binaryio.rb
@@ -123,27 +115,26 @@ files:
 homepage: https://github.com/asciidoctor/asciidoctor-diagram
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>'
+  - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: An extension for asciidoctor that adds support for UML diagram generation
   using PlantUML
 test_files: