asciidoctor-diagram 1.5.1 → 1.5.2

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

@@ -4,31 +4,52 @@ module Asciidoctor
   module Diagram
     module Platform
       def self.os
+        os_info[:os]
+      end
+
+      def self.os_variant
+        os_info[:os_variant]
+      end
+
+      def self.path_separator
+        os_info[:path_sep]
+      end
+
+      def self.os_info
         @os ||= (
         host_os = RbConfig::CONFIG['host_os']
+
+        path_sep = '/'
+        variant = nil
         case host_os
-          when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
-            :windows
-          when /darwin|mac os/
-            :macosx
-          when /linux/
-            :linux
-          when /solaris|bsd/
-            :unix
+          when /(mswin|bccwin|wince|emc)/i
+            os = :windows
+            variant = $1.downcase.to_sym
+            path_sep = '\\'
+          when /(msys|mingw|cygwin)/i
+            os = :windows
+            variant = $1.downcase.to_sym
+          when /darwin|mac os/i
+            os = :macosx
+          when /linux/i
+            os = :linux
           else
-            raise Error::WebDriverError, "unknown os: #{host_os.inspect}"
+            os = :unix
         end
+        {
+            :os => os, :os_variant => variant || os, :path_sep => path_sep
+        }
         )
       end
 
       def self.native_path(path)
         return path if path.nil?
 
-        case os
-          when :windows
-            path.to_s.gsub('/', '\\')
-          else
-            path.to_s
+        path_sep = path_separator
+        if path_sep != '/'
+          path.to_s.gsub('/', path_sep)
+        else
+          path.to_s
         end
       end
     end

data/lib/asciidoctor-diagram/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module Diagram
-    VERSION = "1.5.1"
+    VERSION = "1.5.2"
   end
 end

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

@@ -7,6 +7,7 @@ module Asciidoctor
   module Diagram
     # @private
     module Wavedrom
+      include CliGenerator
       include Which
 
       def self.included(mod)
@@ -22,7 +23,7 @@ module Asciidoctor
         phantomjs = which(parent, 'phantomjs', :alt_attrs => ['phantomjs_2'], :raise_on_error => false)
 
         if wavedrom_cli && !wavedrom_cli.include?('WaveDromEditor') && phantomjs
-          CliGenerator.generate_file(wavedrom_cli, 'wvd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
+          generate_file(wavedrom_cli, 'wvd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
             [phantomjs, Platform.native_path(tool_path), '-i', Platform.native_path(input_path), "-#{format.to_s[0]}", Platform.native_path(output_path)]
           end
         else
@@ -35,7 +36,7 @@ module Asciidoctor
             wavedrom = which(parent, 'WaveDromEditor', :alt_attrs => ['wavedrom'])
           end
 
-          CliGenerator.generate_file(wavedrom, 'wvd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
+          generate_file(wavedrom, 'wvd', format.to_s, source.to_s) do |tool_path, input_path, output_path|
             [tool_path, 'source', Platform.native_path(input_path), format.to_s, Platform.native_path(output_path)]
           end
         end

data/spec/blockdiag_spec.rb

@@ -23,15 +23,15 @@ blockdiag::blockdiag.txt[format="png"]
     d = load_asciidoc doc
     expect(d).to_not be_nil
 
-    b = d.find { |b| b.context == :image }
+    b = d.find { |bl| bl.context == :image }
     expect(b).to_not be_nil
 
     expect(b.content_model).to eq :empty
 
     target = b.attributes['target']
     expect(target).to_not be_nil
-    expect(target).to match /\.png$/
-    expect(File.exists?(target)).to be true
+    expect(target).to match(/\.png$/)
+    expect(File.exist?(target)).to be true
 
     expect(b.attributes['width']).to_not be_nil
     expect(b.attributes['height']).to_not be_nil
@@ -55,15 +55,15 @@ Doc Writer <doc@example.com>
     d = load_asciidoc doc
     expect(d).to_not be_nil
 
-    b = d.find { |b| b.context == :image }
+    b = d.find { |bl| bl.context == :image }
     expect(b).to_not be_nil
 
     expect(b.content_model).to eq :empty
 
     target = b.attributes['target']
     expect(target).to_not be_nil
-    expect(target).to match /\.png$/
-    expect(File.exists?(target)).to be true
+    expect(target).to match(/\.png$/)
+    expect(File.exist?(target)).to be true
 
     expect(b.attributes['width']).to_not be_nil
     expect(b.attributes['height']).to_not be_nil
@@ -85,15 +85,15 @@ Doc Writer <doc@example.com>
     d = load_asciidoc doc
     expect(d).to_not be_nil
 
-    b = d.find { |b| b.context == :image }
+    b = d.find { |bl| bl.context == :image }
     expect(b).to_not be_nil
 
     expect(b.content_model).to eq :empty
 
     target = b.attributes['target']
     expect(target).to_not be_nil
-    expect(target).to match /\.svg/
-    expect(File.exists?(target)).to be true
+    expect(target).to match(/\.svg/)
+    expect(File.exist?(target)).to be true
 
     expect(b.attributes['width']).to_not be_nil
     expect(b.attributes['height']).to_not be_nil
@@ -111,7 +111,7 @@ Doc Writer <doc@example.com>
 ----
     eos
 
-    expect { load_asciidoc doc }.to raise_error /support.*format/i
+    expect { load_asciidoc doc }.to raise_error(/support.*format/i)
   end
 
   it "should not regenerate images when source has not changed" do
@@ -132,7 +132,7 @@ blockdiag::blockdiag.txt
     eos
 
     d = load_asciidoc doc
-    b = d.find { |b| b.context == :image }
+    b = d.find { |bl| bl.context == :image }
     expect(b).to_not be_nil
     target = b.attributes['target']
     mtime1 = File.mtime(target)
@@ -160,7 +160,7 @@ blockdiag::blockdiag.txt[]
     eos
 
     load_asciidoc doc
-    expect(File.exists?('blockdiag.png')).to be true
+    expect(File.exist?('blockdiag.png')).to be true
   end
 
   it "should respect target attribute in block macros" do
@@ -177,8 +177,8 @@ blockdiag::blockdiag.txt["foobaz"]
     eos
 
     load_asciidoc doc
-    expect(File.exists?('foobar.png')).to be true
-    expect(File.exists?('foobaz.png')).to be true
-    expect(File.exists?('blockdiag.png')).to be false
+    expect(File.exist?('foobar.png')).to be true
+    expect(File.exist?('foobaz.png')).to be true
+    expect(File.exist?('blockdiag.png')).to be false
   end
 end

data/spec/ditaa_spec.rb

@@ -28,15 +28,15 @@ ditaa::ditaa.txt[format="png"]
     d = load_asciidoc doc
     expect(d).to_not be_nil
 
-    b = d.find { |b| b.context == :image }
+    b = d.find { |bl| bl.context == :image }
     expect(b).to_not be_nil
 
     expect(b.content_model).to eq :empty
 
     target = b.attributes['target']
     expect(target).to_not be_nil
-    expect(target).to match /\.png$/
-    expect(File.exists?(target)).to be true
+    expect(target).to match(/\.png$/)
+    expect(File.exist?(target)).to be true
 
     expect(b.attributes['width']).to_not be_nil
     expect(b.attributes['height']).to_not be_nil
@@ -68,15 +68,15 @@ Doc Writer <doc@example.com>
     d = load_asciidoc doc
     expect(d).to_not be_nil
 
-    b = d.find { |b| b.context == :image }
+    b = d.find { |bl| bl.context == :image }
     expect(b).to_not be_nil
 
     expect(b.content_model).to eq :empty
 
     target = b.attributes['target']
     expect(target).to_not be_nil
-    expect(target).to match /\.png$/
-    expect(File.exists?(target)).to be true
+    expect(target).to match(/\.png$/)
+    expect(File.exist?(target)).to be true
 
     expect(b.attributes['width']).to_not be_nil
     expect(b.attributes['height']).to_not be_nil
@@ -94,7 +94,7 @@ Doc Writer <doc@example.com>
 ----
     eos
 
-    expect { load_asciidoc doc }.to raise_error /support.*format/i
+    expect { load_asciidoc doc }.to raise_error(/support.*format/i)
   end
 
   it "should use a default format when none was given" do
@@ -112,11 +112,11 @@ Doc Writer <doc@example.com>
     d = load_asciidoc doc
     expect(d).to_not be_nil
 
-    b = d.find { |b| b.context == :image }
+    b = d.find { |bl| bl.context == :image }
     expect(b).to_not be_nil
     target = b.attributes['target']
-    expect(target).to match /\.png$/
-    expect(File.exists?(target)).to be true
+    expect(target).to match(/\.png$/)
+    expect(File.exist?(target)).to be true
   end
 
   it "should support ditaa options as attributes" do
@@ -145,11 +145,11 @@ Doc Writer <doc@example.com>
     d = load_asciidoc doc
     expect(d).to_not be_nil
 
-    b = d.find { |b| b.context == :image }
+    b = d.find { |bl| bl.context == :image }
     expect(b).to_not be_nil
     target = b.attributes['target']
-    expect(target).to match /\.png$/
-    expect(File.exists?(target)).to be true
+    expect(target).to match(/\.png$/)
+    expect(File.exist?(target)).to be true
   end
 
   it "should regenerate images when options change" do
@@ -174,7 +174,7 @@ Doc Writer <doc@example.com>
     eos
 
     d = load_asciidoc(doc.sub('{opts}', 'shadow=false'))
-    b = d.find { |b| b.context == :image }
+    b = d.find { |bl| bl.context == :image }
     target = b.attributes['target']
     mtime1 = File.mtime(target)
 

data/spec/erd_spec.rb

@@ -0,0 +1,289 @@
+require_relative 'test_helper'
+
+code = <<-eos
+title {label: "nfldb Entity-Relationship diagram (condensed)", size: "20"}
+
+# Entities
+
+[player] {bgcolor: "#d0e0d0"}
+  *player_id {label: "varchar, not null"}
+  full_name {label: "varchar, null"}
+  team {label: "varchar, not null"}
+  position {label: "player_pos, not null"}
+  status {label: "player_status, not null"}
+
+[team] {bgcolor: "#d0e0d0"}
+  *team_id {label: "varchar, not null"}
+  city {label: "varchar, not null"}
+  name {label: "varchar, not null"}
+
+[game] {bgcolor: "#ececfc"}
+  *gsis_id {label: "gameid, not null"}
+  start_time {label: "utctime, not null"}
+  week {label: "usmallint, not null"}
+  season_year {label: "usmallint, not null"}
+  season_type {label: "season_phase, not null"}
+  finished {label: "boolean, not null"}
+  home_team {label: "varchar, not null"}
+  home_score {label: "usmallint, not null"}
+  away_team {label: "varchar, not null"}
+  away_score {label: "usmallint, not null"}
+
+[drive] {bgcolor: "#ececfc"}
+  *+gsis_id {label: "gameid, not null"}
+  *drive_id {label: "usmallint, not null"}
+  start_field {label: "field_pos, null"}
+  start_time {label: "game_time, not null"}
+  end_field {label: "field_pos, null"}
+  end_time {label: "game_time, not null"}
+  pos_team {label: "varchar, not null"}
+  pos_time {label: "pos_period, null"}
+
+[play] {bgcolor: "#ececfc"}
+  *+gsis_id {label: "gameid, not null"}
+  *+drive_id {label: "usmallint, not null"}
+  *play_id {label: "usmallint, not null"}
+  time {label: "game_time, not null"}
+  pos_team {label: "varchar, not null"}
+  yardline {label: "field_pos, null"}
+  down {label: "smallint, null"}
+  yards_to_go {label: "smallint, null"}
+
+[play_player] {bgcolor: "#ececfc"}
+  *+gsis_id {label: "gameid, not null"}
+  *+drive_id {label: "usmallint, not null"}
+  *+play_id {label: "usmallint, not null"}
+  *+player_id {label: "varchar, not null"}
+  team {label: "varchar, not null"}
+
+[meta] {bgcolor: "#fcecec"}
+  version {label: "smallint, null"}
+  season_type {label: "season_phase, null"}
+  season_year {label: "usmallint, null"}
+  week {label: "usmallint, null"}
+
+# Relationships
+
+player      *--1 team
+game        *--1 team {label: "home"}
+game        *--1 team {label: "away"}
+drive       *--1 team
+play        *--1 team
+play_player *--1 team
+
+game        1--* drive
+game        1--* play
+game        1--* play_player
+
+drive       1--* play
+drive       1--* play_player
+
+play        1--* play_player
+
+player      1--* play_player
+eos
+
+describe Asciidoctor::Diagram::ErdBlockMacroProcessor, :broken_on_travis, :broken_on_windows do
+  it "should generate PNG images when format is set to 'png'" do
+    File.write('erd.txt', code)
+
+    doc = <<-eos
+= Hello, Erd!
+Doc Writer <doc@example.com>
+
+== First Section
+
+erd::erd.txt[format="png"]
+    eos
+
+    d = load_asciidoc doc
+    expect(d).to_not be_nil
+
+    b = d.find { |bl| bl.context == :image }
+    expect(b).to_not be_nil
+
+    expect(b.content_model).to eq :empty
+
+    target = b.attributes['target']
+    expect(target).to_not be_nil
+    expect(target).to match(/\.png$/)
+    expect(File.exist?(target)).to be true
+
+    expect(b.attributes['width']).to_not be_nil
+    expect(b.attributes['height']).to_not be_nil
+  end
+
+  it "should generate SVG images when format is set to 'svg'" do
+    File.write('erd.txt', code)
+
+    doc = <<-eos
+= Hello, Erd!
+Doc Writer <doc@example.com>
+
+== First Section
+
+erd::erd.txt[format="svg"]
+    eos
+
+    d = load_asciidoc doc
+    expect(d).to_not be_nil
+
+    b = d.find { |bl| bl.context == :image }
+    expect(b).to_not be_nil
+
+    expect(b.content_model).to eq :empty
+
+    target = b.attributes['target']
+    expect(target).to_not be_nil
+    expect(target).to match(/\.svg/)
+    expect(File.exist?(target)).to be true
+
+    expect(b.attributes['width']).to_not be_nil
+    expect(b.attributes['height']).to_not be_nil
+  end
+end
+
+describe Asciidoctor::Diagram::ErdBlockProcessor, :broken_on_travis, :broken_on_windows do
+  it "should generate PNG images when format is set to 'png'" do
+    doc = <<-eos
+= Hello, Erd!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[erd, format="png"]
+----
+#{code}
+----
+    eos
+
+    d = load_asciidoc doc
+    expect(d).to_not be_nil
+
+    b = d.find { |bl| bl.context == :image }
+    expect(b).to_not be_nil
+
+    expect(b.content_model).to eq :empty
+
+    target = b.attributes['target']
+    expect(target).to_not be_nil
+    expect(target).to match(/\.png$/)
+    expect(File.exist?(target)).to be true
+
+    expect(b.attributes['width']).to_not be_nil
+    expect(b.attributes['height']).to_not be_nil
+  end
+
+  it "should generate SVG images when format is set to 'svg'" do
+    doc = <<-eos
+= Hello, Erd!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[erd, format="svg"]
+----
+#{code}
+----
+    eos
+
+    d = load_asciidoc doc
+    expect(d).to_not be_nil
+
+    b = d.find { |bl| bl.context == :image }
+    expect(b).to_not be_nil
+
+    expect(b.content_model).to eq :empty
+
+    target = b.attributes['target']
+    expect(target).to_not be_nil
+    expect(target).to match(/\.svg/)
+    expect(File.exist?(target)).to be true
+
+    expect(b.attributes['width']).to_not be_nil
+    expect(b.attributes['height']).to_not be_nil
+  end
+
+  it "should raise an error when when format is set to an invalid value" do
+    doc = <<-eos
+= Hello, Erd!
+Doc Writer <doc@example.com>
+
+== First Section
+
+[erd, format="foobar"]
+----
+----
+    eos
+
+    expect { load_asciidoc doc }.to raise_error(/support.*format/i)
+  end
+
+  it "should not regenerate images when source has not changed" do
+    File.write('erd.txt', code)
+
+    doc = <<-eos
+= Hello, Erd!
+Doc Writer <doc@example.com>
+
+== First Section
+
+erd::erd.txt
+
+[erd, format="png"]
+----
+#{code}
+----
+    eos
+
+    d = load_asciidoc doc
+    b = d.find { |bl| bl.context == :image }
+    expect(b).to_not be_nil
+    target = b.attributes['target']
+    mtime1 = File.mtime(target)
+
+    sleep 1
+
+    d = load_asciidoc doc
+
+    mtime2 = File.mtime(target)
+
+    expect(mtime2).to eq mtime1
+  end
+
+  it "should handle two block macros with the same source" do
+    File.write('erd.txt', code)
+
+    doc = <<-eos
+= Hello, Erd!
+Doc Writer <doc@example.com>
+
+== First Section
+
+erd::erd.txt[]
+erd::erd.txt[]
+    eos
+
+    load_asciidoc doc
+    expect(File.exist?('erd.png')).to be true
+  end
+
+  it "should respect target attribute in block macros" do
+    File.write('erd.txt', code)
+
+    doc = <<-eos
+= Hello, Erd!
+Doc Writer <doc@example.com>
+
+== First Section
+
+erd::erd.txt["foobar"]
+erd::erd.txt["foobaz"]
+    eos
+
+    load_asciidoc doc
+    expect(File.exist?('foobar.png')).to be true
+    expect(File.exist?('foobaz.png')).to be true
+    expect(File.exist?('erd.png')).to be false
+  end
+end