rsyntaxtree 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5801173697da7daaf1e8f8741b7af0cf6c296a6a
-  data.tar.gz: 96806aede17441ce30718cfc983a4883166787f7
+  metadata.gz: 4579e09d625fbfed3bf8415818f1d3e1faae5f1c
+  data.tar.gz: b8541960fc98bc992340960990bf53a36a73730d
 SHA512:
-  metadata.gz: 50f211f9a4d650270c502d5feafd69abe441becc400aba6df7f38c512ab8f2fb03af37ea983776566a907b5c3d7ffee9074bc24be9b0524c1d5443498212080a
-  data.tar.gz: 5d38af416912e8b362713d771a5a48c484d123b053edd386fdb6f191e2e9d1677228fd51190bf9e312c01f496acef83fdac958db3e55808b8bfb91f143508b51
+  metadata.gz: fa4628dc3690b7532d80ca4d093d12fef301a8054ab034d9ea8b45302e802c65ac96d3cc2ce12edba514d439d75f6851e8d4297c50e042c9a2b1e2a56f7c9735
+  data.tar.gz: a11e485de6a1cdc3f11be9d75e0177b6b7f46ec6fbc1b6a23ba827227e593610a99206c26271f6dd4b2cc194316cb41bbefdab7eb872c7b44c4f97bab96bfdc0

data/README.md

@@ -2,8 +2,6 @@
 
 **RSyntaxTree** is a graphical syntax tree generator written in the Ruby programming language inspired by [phpSyntaxTree](http://ironcreek.net/phpsyntaxtree/). 
 
-- - -
-
 ### Web Interface
 
 Working web interface of is available at <https://yohasebe.com/rsyntaxtree>.
@@ -30,11 +28,12 @@ where [options] are:
       -n, --fontstyle=<s>     Font style (available when ttf font is specified): sans, serif, mono, cjk (default: sans)
       -t, --font=<s>          Path to a ttf font used to generate tree (optional)
       -s, --fontsize=<i>      Size: 8-26 (default: 16)
-      -m, --margin=<i>        Margin: 0-120 (default: 0)
       -c, --color=<s>         Color text and bars: on or off (default: on)
       -y, --symmetrize=<s>    Generate symmetrical, balanced tree: on or off (default: on)
       -a, --autosub=<s>       Put subscript numbers to nodes: on or off (default: off)
-      -v, --version           Print version and exit
+      -m, --margin=<i>        Margin: 0-120 (default: 0)
+      -v, --vheight=<f>       Connector Height: 0.5-2.0 (default: 0.5)
+      -e, --version           Print version and exit
       -h, --help              Show this message
 ```
 
@@ -51,12 +50,12 @@ You can put a subscript to any node by putting the _ character between the main
 Bracket notation (auto-subscript-on):
 
 ```text
-[S [NP RSyntaxTree^][VP [V generates][NP multilingual syntax trees]]]
+[S [NP RSyntaxTree^][VP [V generates][NP [Adj multilingual] [NP syntax trees]]]]
 ```
 
 Resulting PNG
 
-![RSyntaxTree generates multilingual syntax trees](https://i.gyazo.com/8d8cbce1e8d8d45c0dda0741009641fd.png)
+![RSyntaxTree generates multilingual syntax trees](https://i.gyazo.com/6bb68b0bdb35d7a10c4a11d5788d484f.png)
 
 ### Development
 

data/bin/rsyntaxtree

@@ -18,7 +18,7 @@ EOS
 
   opt :outdir, "Output directory",
       :default => "./"
-  opt :format, "Output format: png, pdf, or svg",
+  opt :format, "Output format: png, gif, jpg, pdf, or svg",
       :default => "png"
   opt :leafstyle, "visual style of tree leaves: auto, triangle, bar, or nothing", 
       :default => "auto"
@@ -29,6 +29,8 @@ EOS
       :default => 16
   opt :margin, "Margin: 0-120",
       :default => 0
+  opt :vheight, "Connector Height: 0.5-2.0",
+    :default => 1.0
   opt :color, "Color text and bars: on or off",
       :default => "on" 
   opt :symmetrize, "Generate symmetrical, balanced tree: on or off",
@@ -38,15 +40,16 @@ EOS
 end
 
 Trollop::die :outdir, "must be an exsting directory path" unless FileTest::directory?(opts[:outdir])
-Trollop::die :format, "must be png or svg" unless /\A(png|pdf|svg)\z/ =~ opts[:format]
+Trollop::die :format, "must be png, jpg, gif, or svg" unless /\A(png|jpg|gif|pdf|svg)\z/ =~ opts[:format]
 Trollop::die :leafstyle, "must be auto, triangle, bar, or nothing" unless /\A(auto|triangle|bar|nothing)\z/ =~ opts[:leafstyle]
 Trollop::die :fontstyle, "must be sans, serif, mono, cjk" unless /\A(sans|serif|mono|cjk)\z/ =~ opts[:fontstyle]
 Trollop::die :font, "must be path to an existing ttf font" if opts[:font] && !File::exists?(opts[:font])
-Trollop::die :fontsize, "must be in the range 8-26" unless opts[:fontsize] >= 8 && opts[:fontsize] <= 26
-Trollop::die :margin, "must be in the range 0-120" if opts[:margin] < 0 || opts[:margin] > 120
+Trollop::die :fontsize, "must be in the range of 8-26" unless opts[:fontsize] >= 8 && opts[:fontsize] <= 26
 Trollop::die :color, "must be either on or off" unless /\A(on|off)\z/ =~ opts[:color]
 Trollop::die :symmetrize, "must be either on or off" unless /\A(on|off)\z/ =~ opts[:symmetrize]
 Trollop::die :autosub, "must be either on or off" unless /\A(on|off)\z/ =~ opts[:autosub]
+Trollop::die :margin, "must be in the range of 0-120" if opts[:margin] < 0 || opts[:margin] > 120
+Trollop::die :vheight, "must be in the range of 0.5-2.0" if opts[:vheight] < 0.5 || opts[:vheight] > 2.0
 
 string_opts = {}
 opts.each do |key, value|
@@ -68,6 +71,10 @@ outfile = File.new(File.expand_path(string_opts[:outdir]) + "/syntree." + ext, "
 case ext
 when "png"
   outfile.write rsg.draw_png
+when "jpg"
+  outfile.write rsg.draw_jpg
+when "gif"
+  outfile.write rsg.draw_gif
 when "pdf"
   outfile.write rsg.draw_pdf
 when "svg"

data/lib/rsyntaxtree.rb

@@ -42,6 +42,10 @@ require 'pp'
 
 FONT_DIR = File.expand_path(File.dirname(__FILE__) + "/../fonts")
 
+ETYPE_UNDEFINED = 0
+ETYPE_NODE = 1
+ETYPE_LEAF = 2
+
 class RSGenerator 
   def initialize(params = {})
     new_params = {}
@@ -63,6 +67,8 @@ class RSGenerator
         new_params[key] = value.to_i
       when :margin
         new_params[key] = value.to_i
+      when :vheight
+        new_params[key] = value.to_f
       when :fontstyle
         if value == "noto-sans" || value == "sans"
           new_params[:font] = FONT_DIR + "/NotoSansCJKjp-Regular.otf"
@@ -92,10 +98,22 @@ class RSGenerator
       :font       => FONT_DIR + "/NotoSansCKjp-Regular.otf",
       :filename   => "syntree",
       :data       => "",
-      :margin     => 0
+      :margin     => 0,
+      :vheight     =>  1.0
+    }
+    @metrics = {
+      :e_width  => 120,
+      :e_padd   => 14,
+      :v_space  => 20,
+      :h_space  => 20,
+      :b_side   => 10,
+      :b_topbot => 10
     }
     
     @params.merge! new_params
+    @params[:fontsize]  = @params[:fontsize] * 2
+    @params[:margin]    = @params[:margin] * 2
+    @metrics[:v_space] = @metrics[:v_space] * @params[:vheight]
    end
 
   def self.check_data(text)
@@ -108,6 +126,16 @@ class RSGenerator
     draw_tree
   end
 
+  def draw_jpg
+    @params[:format] = "jpg"
+    draw_tree
+  end
+
+  def draw_gif
+    @params[:format] = "gif"
+    draw_tree
+  end
+
   def draw_pdf
     @params[:format] = "pdf"
     draw_tree
@@ -118,7 +146,7 @@ class RSGenerator
     sp.parse
     sp.auto_subscript if @params[:autosub]
     elist = sp.get_elementlist
-    graph = TreeGraph.new(elist, 
+    graph = TreeGraph.new(elist, @metrics,
       @params[:symmetrize], @params[:color], @params[:leafstyle], @params[:font], @params[:fontsize], @params[:format], @params[:margin])
     graph.to_blob(@params[:format])
   end
@@ -129,7 +157,7 @@ class RSGenerator
     sp.parse
     sp.auto_subscript if @params[:autosub]
     elist = sp.get_elementlist
-    graph = SVGGraph.new(elist, 
+    graph = SVGGraph.new(elist, @metrics,
       @params[:symmetrize], @params[:color], @params[:leafstyle], @params[:font], @params[:fontsize])
     graph.svg_data
   end

data/lib/rsyntaxtree/element.rb

@@ -27,10 +27,6 @@
 # along with this program; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
-ETYPE_UNDEFINED = 0
-ETYPE_NODE = 1
-ETYPE_LEAF = 2
-
 class Element
 
     attr_accessor :id, :parent, :type, :content, :level, :width, :indent, :triangle

data/lib/rsyntaxtree/string_parser.rb

@@ -72,7 +72,7 @@ class StringParser
       return false  
     end
 
-    if /\[\_ / =~ @data
+    if /\[\_/ =~ @data
       return false
     end
 

data/lib/rsyntaxtree/svg_graph.rb

@@ -33,30 +33,28 @@ include Magick
 
 # constant variables are already set in tree_graph.rb
 
-
 class SVGGraph
     
-  def initialize(e_list, symmetrize = true, color = true, leafstyle = "auto",
+  def initialize(e_list, metrics, symmetrize = true, color = true, leafstyle = "auto",
                  font = "Helvetica", font_size = 10, simple = false)
 
     # Store parameters
     @e_list     = e_list
+    @m          = metrics
     @font       = font
-    @font_size = font_size
+    @font_size  = font_size
     @leafstyle  = leafstyle
     @symmetrize = symmetrize
-    # Element dimensions
-    @e_width   = E_WIDTH
 
 
     # Calculate image dimensions
-    @e_height = @font_size + E_PADD * 2
-    h = @e_list.get_level_height
-    w = calc_level_width(0)
-    w_px = w + B_SIDE
-    h_px = h * @e_height + (h-1) * (V_SPACE + @font_size) + B_TOPBOT * 2
-    @height    = h_px
-    @width     = w_px
+    @e_height = @font_size + @m[:e_padd] * 2
+    h         = @e_list.get_level_height
+    w         = calc_level_width(0)
+    w_px      = w + @m[:b_side] 
+    h_px      = h * @e_height + (h-1) * (@m[:v_space] + @font_size) + @m[:b_topbot] * 2
+    @height   = h_px
+    @width    = w_px
 
     
     # Initialize the image and colors
@@ -127,7 +125,7 @@ EOD
     else 
       top   = row2px(y)
     end
-    left   = x + B_SIDE
+    left   = x + @m[:b_side]
     bottom = top  + @e_height
     right  = left + w
 
@@ -173,7 +171,7 @@ EOD
     main_data  = @text_styles.sub(/COLOR/, col)
     main_data  = main_data.sub(/FONT_SIZE/, @font_size.to_s)
     main_x = txt_pos
-    main_y = top + @e_height - E_PADD
+    main_y = top + @e_height - @m[:e_padd]
     main_data  = main_data.sub(/X_VALUE/, main_x.to_s)
     main_data  = main_data.sub(/Y_VALUE/, main_y.to_s)
     @tree_data += main_data.sub(/CONTENT/, main)
@@ -182,13 +180,12 @@ EOD
     sub_data  = @text_styles.sub(/COLOR/, col)
     sub_data  = sub_data.sub(/FONT_SIZE/, @font_size.to_s)
     sub_x = main_x + main_width + (sub_size/8)
-    sub_y = top + (@e_height - E_PADD + sub_size / 2).ceil
+    sub_y = top + (@e_height - @m[:e_padd] + sub_size / 2).ceil
     if (sub.length > 0 )
       sub_data   = sub_data.sub(/X_VALUE/, sub_x.ceil.to_s)
       sub_data   = sub_data.sub(/Y_VALUE/, sub_y.ceil.to_s)
       @tree_data += sub_data.sub(/CONTENT/, sub)
     end
-
   end
 
   # Draw a line between child/parent elements
@@ -199,9 +196,9 @@ EOD
     end
             
     fromTop  = row2px(fromY)
-    fromLeft = (fromX + fromW / 2 + B_SIDE)
+    fromLeft = (fromX + fromW / 2 + @m[:b_side])
     toBot    = (row2px(fromY - 1 ) + @e_height)
-    toLeft  = (toX + toW / 2 + B_SIDE)
+    toLeft  = (toX + toW / 2 + @m[:b_side])
 
     line_data   = @line_styles.sub(/X1/, fromLeft.ceil.to_s.to_s)
     line_data   = line_data.sub(/Y1/, fromTop.ceil.to_s.to_s)
@@ -217,7 +214,7 @@ EOD
     end
           
     toX = fromX
-    fromCenter = (fromX + fromW / 2 + B_SIDE)
+    fromCenter = (fromX + fromW / 2 + @m[:b_side])
     
     fromTop  = row2px(fromY).ceil
     fromLeft1 = (fromCenter + textW / 2).ceil
@@ -225,9 +222,9 @@ EOD
     toBot    = (row2px(fromY - 1) + @e_height)
 
     if symmetrize
-      toLeft   = (toX + textW / 2 + B_SIDE)
+      toLeft   = (toX + textW / 2 + @m[:b_side])
     else
-      toLeft   = (toX + textW / 2 + B_SIDE * 3)
+      toLeft   = (toX + textW / 2 + @m[:b_side] * 3)
     end
         
     polygon_data = @polygon_styles.sub(/X1/, fromLeft1.ceil.to_s)
@@ -465,11 +462,8 @@ EOD
     end
   end
 
-    
   # Calculate top position from row (level)
   def row2px(row)
-   B_TOPBOT + @e_height * row + (V_SPACE + @font_size) * row
+   @m[:b_topbot] + @e_height * row + (@m[:v_space] + @font_size) * row
   end
-  
 end
-  

data/lib/rsyntaxtree/tree_graph.rb

@@ -29,47 +29,36 @@
 
 require 'imgutils'
 require 'elementlist'
-# require 'rubygems'
 require 'rmagick'
 include Magick
 
-# Double to make image retina ready
-E_WIDTH   = 60 * 2 # Element width
-E_PADD    = 7  * 2 # Element height padding
-V_SPACE   = 20 * 2
-H_SPACE   = 10 * 2
-B_SIDE   =   5 * 2
-B_TOPBOT =   5 * 2
-
 class TreeGraph
 
-  def initialize(e_list, symmetrize = true, color = true, terminal = "auto",
+  def initialize(e_list, metrics, symmetrize = true, color = true, terminal = "auto",
                  font = "Helvetica", font_size = 10, simple = false, margin = 0)
 
     # Store parameters (double font size and margin to make image retina ready)
     @e_list     = e_list
+    @m          = metrics
     @font       = font
-    @terminal = terminal
+    @terminal   = terminal
     @symmetrize = symmetrize
-    @simple = simple
-    @font_size = font_size * 2
-    @margin = margin * 2
+    @simple     = simple
+    @font_size  = font_size
+    @margin     = margin
 
-    # Element dimensions
-    @e_width   = E_WIDTH
-    
     # Calculate image dimensions
-    @e_height = @font_size + E_PADD * 2
-    h = @e_list.get_level_height
-    w = calc_level_width(0)
-    w_px = w + B_SIDE * 2
-    h_px = h * @e_height + (h-1) * (V_SPACE + @font_size) + B_TOPBOT * 2
-    @height    = h_px
-    @width     = w_px
+    @e_height = @font_size + metrics[:e_padd] * 2
+    h         = @e_list.get_level_height
+    w         = calc_level_width(0)
+    w_px      = w + metrics[:b_side] * 2
+    h_px      = h * @e_height + (h-1) * (metrics[:v_space] + @font_size) + metrics[:b_topbot] * 2
+    @height   = h_px
+    @width    = w_px
 
     # Initialize the image and colors
-    @im = Image.new(w_px, h_px)
-    @gc = Draw.new
+    @im      = Image.new(w_px, h_px)
+    @gc      = Draw.new
     @gc.font = @font
     @gc.pointsize(@font_size)
 
@@ -123,7 +112,7 @@ class TreeGraph
     else 
       top   = row2px(y)
     end
-    left   = x + B_SIDE
+    left   = x + @m[:b_side]
     bottom = top  + @e_height
     right  = left + w
 
@@ -172,14 +161,14 @@ class TreeGraph
     # Draw main text
     @gc.pointsize(@font_size)
     main_x = txt_pos
-    main_y = top + @e_height - E_PADD
+    main_y = top + @e_height - @m[:e_padd]
     @gc.text(main_x.ceil, main_y.ceil, main)
         
     # Draw subscript text
     if (sub.length > 0 )
       @gc.pointsize(sub_size)
       sub_x = txt_pos + main_width + (sub_size/8)
-      sub_y = top + (@e_height - E_PADD + sub_size / 2)
+      sub_y = top + (@e_height - @m[:e_padd] + sub_size / 2)
       @gc.text(sub_x.ceil, sub_y.ceil, sub)
     end
      
@@ -193,9 +182,9 @@ class TreeGraph
     end
             
     fromTop  = row2px(fromY)
-    fromLeft = (fromX + fromW / 2 + B_SIDE)
+    fromLeft = (fromX + fromW / 2 + @m[:b_side])
     toBot    = (row2px(fromY - 1 ) + @e_height)
-    toLeft  = (toX + toW / 2 + B_SIDE)
+    toLeft  = (toX + toW / 2 + @m[:b_side])
 
     @gc.fill("none")
     @gc.stroke @col_line
@@ -210,16 +199,16 @@ class TreeGraph
     end
       
     toX = fromX
-    fromCenter = (fromX + fromW / 2 + B_SIDE)
+    fromCenter = (fromX + fromW / 2 + @m[:b_side])
     
     fromTop  = row2px(fromY).ceil
     fromLeft1 = (fromCenter + textW / 2).ceil
     fromLeft2 = (fromCenter - textW / 2).ceil
     toBot    = (row2px(fromY - 1) + @e_height)
     if symmetrize
-      toLeft   = (toX + textW / 2 + B_SIDE)
+      toLeft   = (toX + textW / 2 + @m[:b_side])
     else
-      toLeft   = (toX + textW / 2 + B_SIDE * 3)
+      toLeft   = (toX + textW / 2 + @m[:b_side] * 3)
     end
         
     @gc.fill("none")
@@ -455,7 +444,6 @@ class TreeGraph
   end
 
   def row2px(row)
-   B_TOPBOT + @e_height * row + (V_SPACE + @font_size) * row
+   @m[:b_topbot] + @e_height * row + (@m[:v_space] + @font_size) * row
   end
-  
 end

data/lib/rsyntaxtree/version.rb

@@ -1,4 +1,4 @@
 module RSyntaxTree
-  VERSION = "0.7.1"
+  VERSION = "0.7.2"
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsyntaxtree
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Yoichiro Hasebe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-03 00:00:00.000000000 Z
+date: 2018-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rmagick