rsyntaxtree 0.6.92 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6ad7b71169247421655b54b4d81049209dea63e
-  data.tar.gz: cc0769fc2a20c71dc35e9472d0a9a31d6b7f0e13
+  metadata.gz: a5dcdb349a03810a145b1f240feee3ccc72f9f4f
+  data.tar.gz: a696ad43029ef6ea253f40a7277c621e52166fee
 SHA512:
-  metadata.gz: 8fa57fddcdee21e06ca2793791868268770ab4e56d6f0b4c4b002c831c9c843512b2db2860589a31dcf7c7dd828f48aa873988622793f93a605ae224f9acd5bd
-  data.tar.gz: b9a26b9894a8fdd7dbb2333d4e4a34ee14d0c8ea53ce15cb111e8401402ca855ec2d1ba080d59c6e2e095d03c96d43844f91f072877341d69d4d9b3b3b0d3b49
+  metadata.gz: ea1203926e30c5e02083f0975cb39856cc223ee83d8a9da69792f417b164b55b8f74818f125891aee088d71ccb90e2c451e11b9c2fa829bdae57108689985166
+  data.tar.gz: 5dfa20627985562e499262b3e107f0c2fb020d831be3b29c1f47625ad4d381e42aaa70f22fbfbc2e665a5974d2c066f0add3744b6fa99d9bb209fdc8b3269762

data/Gemfile

@@ -1,9 +1,4 @@
 source "http://rubygems.org"
 
-gem 'sinatra'
-gem 'haml'
 gem 'rmagick'
 gem 'trollop'
-group :development do
-  gem 'thin'
-end

data/README.md

@@ -1,14 +1,12 @@
 # RSyntaxTree: yet another syntax tree generator in Ruby
 
-RSyntaxTree is a graphical syntax tree generator written in the Ruby programming language. It is basically a port of  [phpSyntaxTree](http://ironcreek.net/phpsyntaxtree/) created by André Eisenbach.
+**RSyntaxTree** is a graphical syntax tree generator written in the Ruby programming language inspired by [phpSyntaxTree](http://ironcreek.net/phpsyntaxtree/). 
 
-While phpSyntaxTree does not accept **multi-byte characters** as those in Chinese, Japanese, and Korean, RSyntaxTree handles text of any language as long as encoded in UTF-8 and fonts have been installed. Additionally, RSyntaxTree can output **symmetrized** tree diagrams, a functionality that is not implemented in phpSyntaxTree.
-
-RSyntaxTree consists of an easy-to-use command-line app and a web-based interface made with  [Sinatra](http://www.sinatrarb.com) web framework.
+- - -
 
 ### Web Interface
 
-Working web interface of a previous version of RSyntaxTree is available at http://yohasebe.com/rsyntaxtree .  New version will be deployed soon.
+Working web interface of is available at <https://yohasebe.com/rsyntaxtree>.
 
 ### Installation
 
@@ -16,26 +14,29 @@ Working web interface of a previous version of RSyntaxTree is available at http:
 
 ### Usage
 
-For the web interface, see Usage section in http://yohasebe.com/rsyntaxtree .
+For the web interface, see Usage section of <https://yohasebe.com/rsyntaxtree>.
 
 For the command-line interface, type `$rsyntaxtree -h` after installation. Here's what you get:
     
-    RSyntaxTree, (linguistic) syntax tree generator written in Ruby.
-    
-    Usage:
-           rsyntaxtree [options] "[VP [VP [V set] [NP bracket notation]] [ADV here]]"
-    where [options] are:
-          --outdir, -o <s>:   Output directory (default: present working directory) (default: ./)
-          --format, -f <s>:   Output format: png, pdf, or svg (default: png)
-       --leafstyle, -l <s>:   visual style of tree leaves: auto, triangle, bar, or nothing (default: auto)
-       --fontstyle, -n <s>:   Font style: sans-serif, serif, jp-gothic, jp-mincho, cjk (default: cjk)
-            --font, -t <s>:   Path to a ttf font used to generate tree
-        --fontsize, -s <i>:   Font size: 8-20 (default: 16)
-           --color, -c <s>:   Color text and bars: on or off (default: on)
-      --symmetrize, -y <s>:   Generate symmetrical, balanced tree: on or off (default: on)
-         --autosub, -a <s>:   Put subscript numbers to nodes: on or off (default: off)
-             --version, -v:   Print version and exit
-                --help, -h:   Show this message
+```text
+RSyntaxTree, (linguistic) syntax tree generator written in Ruby.
+
+Usage:
+       rsyntaxtree [options] "[VP [VP [V set] [NP bracket notation]] [ADV here]]"
+where [options] are:
+      -o, --outdir=<s>        Output directory (default: ./)
+      -f, --format=<s>        Output format: png, pdf, or svg (default: png)
+      -l, --leafstyle=<s>     visual style of tree leaves: auto, triangle, bar, or nothing (default: auto)
+      -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
+      -h, --help              Show this message
+```
 
 ### Tips
 
@@ -49,11 +50,13 @@ You can put a subscript to any node by putting the _ character between the main
 
 Bracket notation (auto-subscript-on):
 
-    [S [NP RSyntaxTree^][VP [V generates][NP multilingual syntax trees]]]
+```text
+[S [NP RSyntaxTree^][VP [V generates][NP multilingual syntax trees]]]
+```
 
 Resulting PNG
 
-![RSyntaxTree generates multilingual syntax trees](http://yohasebe.com/img/rsyntaxtree_example3.png)
+![RSyntaxTree generates multilingual syntax trees](https://i.gyazo.com/8d8cbce1e8d8d45c0dda0741009641fd.png)
 
 ### Development
 
@@ -61,7 +64,7 @@ For the latest updates and downloads please visit http://github.com/yohasebe/rsy
 
 ### Author
 
-Yoichiro Hasebe yohasebe@gmail.com
+Yoichiro Hasebe <yohasebe@gmail.com>
 
 ### License
 

data/bin/rsyntaxtree

@@ -7,7 +7,7 @@ require 'rsyntaxtree'
 require 'trollop'
 
 opts = Trollop::options do
-  version "RSyntaxTree #{RSyntaxTree::VERSION} (c) 2012 Yoichiro Hasebe"
+  version "RSyntaxTree #{RSyntaxTree::VERSION} (c) 2018 Yoichiro Hasebe"
   banner <<-EOS
 RSyntaxTree, (linguistic) syntax tree generator written in Ruby.
 
@@ -22,11 +22,13 @@ EOS
       :default => "png"
   opt :leafstyle, "visual style of tree leaves: auto, triangle, bar, or nothing", 
       :default => "auto"
-  opt :fontstyle, "Font style (available when ttf font is specified): sans-serif, serif, jp-gothic, jp-mincho, cjk",
-      :default => "cjk"
+  opt :fontstyle, "Font style (available when ttf font is specified): sans, serif, mono, cjk",
+      :default => "sans"
   opt :font, "Path to a ttf font used to generate tree (optional)", :type => String
-  opt :fontsize, "Font size: 8-20",
+  opt :fontsize, "Size: 8-26",
       :default => 16
+  opt :margin, "Margin: 0-120",
+      :default => 0
   opt :color, "Color text and bars: on or off",
       :default => "on" 
   opt :symmetrize, "Generate symmetrical, balanced tree: on or off",
@@ -38,30 +40,31 @@ 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 :leafstyle, "must be auto, triangle, bar, or nothing" unless /\A(auto|triangle|bar|nothing)\z/ =~ opts[:leafstyle]
-Trollop::die :fontstyle, "must be sans-serif, serif, jp-gothic, jp-mincho, or cjk" unless /\A(sans\-serif|serif|jp\-gothic|jp\-mincho|cjk)\z/ =~ opts[:fontstyle]
+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-20" unless opts[:fontsize] >= 8 && opts[:fontsize] <= 20
+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 :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]
 
 string_opts = {}
 opts.each do |key, value|
-  string_opts[key.to_s] = value unless key == :font && !value
+  string_opts[key.to_sym] = value unless key == :font && !value
 end
 
 data = ARGV[0]
 
 unless data && RSGenerator.check_data(data)
-  puts "bracket notation given is invalid"
+  puts "Error: given bracket notation is invalid; try 'rsyntaxtree --help' "
   exit
 end
 
-string_opts["data"] = data
+string_opts[:data] = data
 
 rsg = RSGenerator.new(string_opts)
-ext = string_opts["format"]
-outfile = File.new(File.expand_path(string_opts["outdir"]) + "/syntree." + ext, "wb")
+ext = string_opts[:format]
+outfile = File.new(File.expand_path(string_opts[:outdir]) + "/syntree." + ext, "wb")
 case ext
 when "png"
   outfile.write rsg.draw_png

data/lib/rsyntaxtree.rb

@@ -10,7 +10,7 @@
 #
 # This file is part of RSyntaxTree, which is a ruby port of Andre Eisenbach's
 # excellent program phpSyntaxTree.
-# Copyright (c) 2007-2009 Yoichiro Hasebe <yohasebe@gmail.com>
+# Copyright (c) 2007-2018 Yoichiro Hasebe <yohasebe@gmail.com>
 # Copyright (c) 2003-2004 Andre Eisenbach <andre@ironcreek.net>
 # 
 # This program is free software; you can redistribute it and/or modify
@@ -28,7 +28,6 @@
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 $LOAD_PATH << File.join( File.dirname(__FILE__), 'rsyntaxtree')
-$LOAD_PATH << File.join( File.dirname(__FILE__), '../helpers')
 
 require 'uri'
 require 'imgutils'
@@ -38,32 +37,18 @@ require 'string_parser'
 require 'tree_graph'
 require 'svg_graph'
 require 'error_message'
-require 'helpers'
 require 'version'
+require 'pp'
 
 FONT_DIR = File.expand_path(File.dirname(__FILE__) + "/../fonts")
 
-##################################################
-# if !development?
-#   # load and store Google Analytics code, if any, to a variable
-#   ga_path = File.dirname(__FILE__) + "/../google_analytics_tracking_code"
-#   if File.exists?(ga_path)
-#     gfile = File.open(ga_path, "r:UTF-8:UTF-8")
-#     $GOOGLE_CODE = gfile.read
-#     gfile.close
-#   else
-#     $GOOGLE_CODE = ""
-#   end
-# end
-##################################################
-
 class RSGenerator 
-  include Helpers
   def initialize(params = {})
     new_params = {}
-    params.each do |key, value|
+    params.each do |keystr, value|
+      key = keystr.to_sym
       case key
-      when "data"
+      when :data
         data = URI.unescape(value)
         data  = data.gsub('-AMP-', '&')
           .gsub('-PERCENT-', "%")
@@ -72,83 +57,80 @@ class RSGenerator
           .gsub('-OABRACKET-', '<')
           .gsub('-CABRACKET-', '>')
         new_params[key] = data
-      when "symmetrize", "color", "autosub"
-        new_params[key] = value == "on"? true : false
-      when "fontsize"
+      when :symmetrize, :color, :autosub
+        new_params[key] = value && value != "off" ? true : false
+      when :fontsize
+        new_params[key] = value.to_i
+      when :margin
         new_params[key] = value.to_i
-      when "fontstyle"
-        if value == "sans-serif"
-          new_params["font"] = FONT_DIR + "/DroidSans.ttf"
-        elsif value == "serif"
-          new_params["font"] = FONT_DIR + "/DroidSerif-Regular.ttf"
-        elsif value == "jp-gothic"
-          new_params["font"] = FONT_DIR + "/ipagp.ttf"
-        elsif value == "jp-mincho"
-          new_params["font"] = FONT_DIR + "/ipamp.ttf"
-        elsif value == "cjk"
-          new_params["font"] = FONT_DIR + "/wqy-zenhei.ttf"
-        elsif value == "aru"
-          new_params["font"] = FONT_DIR + "/ArialUnicode.ttf"
-        elsif value == "tnr"
-          new_params["font"] = FONT_DIR + "/TimesNewRoman.ttf"
-        elsif value == "noto"
-          new_params["font"] = FONT_DIR + "/NotoSansCJK.ttc"
+      when :fontstyle
+        if value == "noto-sans" || value == "sans"
+          new_params[:font] = FONT_DIR + "/NotoSansCJKjp-Regular.otf"
+        elsif value == "noto-serif" || value == "serif"
+          new_params[:font] = FONT_DIR + "/NotoSerifCJKjp-Regular.otf"
+        elsif value == "noto-mono" || value == "mono"
+          new_params[:font] = FONT_DIR + "/NotoSansMonoCJKjp-Regular.otf"
+        elsif value == "western-sans"
+          new_params[:font] = FONT_DIR + "/DroidSans.ttf"
+        elsif value == "western-serif"
+          new_params[:font] = FONT_DIR + "/DroidSerif-Regular.ttf"
+        elsif value == "cjk zenhei" || value == "cjk"
+          new_params[:font] = FONT_DIR + "/wqy-zenhei.ttf"
         end
       else
         new_params[key] = value
       end
     end
     
-    
     @params = {
-      "symmetrize" => true,
-      "color"      => true,
-      "autosub"    => false,
-      "fontsize"   => 18,
-      "format"     => "png",
-      "leafstyle"   => "auto",
-      "font"        => FONT_DIR + "/ipagp.ttf",
-      "filename"   => "syntree",
-      "data"       => "",
+      :symmetrize => true,
+      :color      => true,
+      :autosub    => false,
+      :fontsize   => 18,
+      :format     => "png",
+      :leafstyle  => "auto",
+      :font       => FONT_DIR + "/NotoSansCKjp-Regular.otf",
+      :filename   => "syntree",
+      :data       => "",
+      :margin     => 0
     }
     
     @params.merge! new_params
    end
 
   def self.check_data(text)
-     # StringParser.validate_text(text)     
      sp = StringParser.new(text)
      sp.valid?
   end
   
   def draw_png
-    @params["format"] = "png"
+    @params[:format] = "png"
     draw_tree
   end
 
   def draw_pdf
-    @params["format"] = "pdf"
+    @params[:format] = "pdf"
     draw_tree
   end
     
   def draw_tree
-    sp = StringParser.new(@params["data"])
+    sp = StringParser.new(@params[:data])
     sp.parse
-    sp.auto_subscript if @params["autosub"]
+    sp.auto_subscript if @params[:autosub]
     elist = sp.get_elementlist
     graph = TreeGraph.new(elist, 
-      @params["symmetrize"], @params["color"], @params["leafstyle"], @params["font"], @params["fontsize"], @params["format"])
-    graph.to_blob(@params["format"])
+      @params[:symmetrize], @params[:color], @params[:leafstyle], @params[:font], @params[:fontsize], @params[:format], @params[:margin])
+    graph.to_blob(@params[:format])
   end
   
   def draw_svg
-    @params["format"] = "svg"
-    sp = StringParser.new(@params["data"].gsub('&', '&amp;').gsub('%', '&#37;'))
+    @params[:format] = "svg"
+    sp = StringParser.new(@params[:data].gsub('&', '&amp;').gsub('%', '&#37;'))
     sp.parse
-    sp.auto_subscript if @params["autosub"]
+    sp.auto_subscript if @params[:autosub]
     elist = sp.get_elementlist
     graph = SVGGraph.new(elist, 
-      @params["symmetrize"], @params["color"], @params["leafstyle"], @params["font"], @params["fontsize"])
+      @params[:symmetrize], @params[:color], @params[:leafstyle], @params[:font], @params[:fontsize])
     graph.svg_data
   end
 end

data/lib/rsyntaxtree/element.rb

@@ -10,7 +10,7 @@
 # This file is part of RSyntaxTree, which is a ruby port of Andre Eisenbach's
 # excellent program phpSyntaxTree.
 #
-# Copyright (c) 2007-2009 Yoichiro Hasebe <yohasebe@gmail.com>
+# Copyright (c) 2007-2018 Yoichiro Hasebe <yohasebe@gmail.com>
 # Copyright (c) 2003-2004 Andre Eisenbach <andre@ironcreek.net>
 # 
 # This program is free software; you can redistribute it and/or modify

data/lib/rsyntaxtree/elementlist.rb

@@ -10,7 +10,7 @@
 # This file is part of RSyntaxTree, which is a ruby port of Andre Eisenbach's
 # excellent program phpSyntaxTree.
 #
-# Copyright (c) 2007-2009 Yoichiro Hasebe <yohasebe@gmail.com>
+# Copyright (c) 2007-2018 Yoichiro Hasebe <yohasebe@gmail.com>
 # Copyright (c) 2003-2004 Andre Eisenbach <andre@ironcreek.net>
 # 
 # This program is free software; you can redistribute it and/or modify
@@ -134,4 +134,4 @@ class ElementList
     end
     
 end
-    
+    

data/lib/rsyntaxtree/error_message.rb

@@ -10,7 +10,7 @@
 # This file is part of RSyntaxTree, which is a ruby port of Andre Eisenbach's
 # excellent program phpSyntaxTree.
 #
-# Copyright (c) 2007-2009 Yoichiro Hasebe <yohasebe@gmail.com>
+# Copyright (c) 2007-2018 Yoichiro Hasebe <yohasebe@gmail.com>
 # Copyright (c) 2003-2004 Andre Eisenbach <andre@ironcreek.net>
 # 
 # This program is free software; you can redistribute it and/or modify

data/lib/rsyntaxtree/imgutils.rb

@@ -10,7 +10,7 @@
 # This file is part of RSyntaxTree, which is a ruby port of Andre Eisenbach's
 # excellent program phpSyntaxTree.
 #
-# Copyright (c) 2007-2009 Yoichiro Hasebe <yohasebe@gmail.com>
+# Copyright (c) 2007-2018 Yoichiro Hasebe <yohasebe@gmail.com>
 # Copyright (c) 2003-2004 Andre Eisenbach <andre@ironcreek.net>
 # 
 # This program is free software; you can redistribute it and/or modify

data/lib/rsyntaxtree/string_parser.rb

@@ -11,7 +11,7 @@
 # This file is part of RSyntaxTree, which is a ruby port of Andre Eisenbach's
 # excellent program phpSyntaxTree.
 #
-# Copyright (c) 2007-2009 Yoichiro Hasebe <yohasebe@gmail.com>
+# Copyright (c) 2007-2018 Yoichiro Hasebe <yohasebe@gmail.com>
 # Copyright (c) 2003-2004 Andre Eisenbach <andre@ironcreek.net>
 # 
 # This program is free software; you can redistribute it and/or modify

data/lib/rsyntaxtree/svg_graph.rb

@@ -10,7 +10,7 @@
 # This file is part of RSyntaxTree, which is a ruby port of Andre Eisenbach's
 # excellent program phpSyntaxTree.
 #
-# Copyright (c) 2007-2009 Yoichiro Hasebe <yohasebe@gmail.com>
+# Copyright (c) 2007-2018 Yoichiro Hasebe <yohasebe@gmail.com>
 # Copyright (c) 2003-2004 Andre Eisenbach <andre@ironcreek.net>
 # 
 # This program is free software; you can redistribute it and/or modify

data/lib/rsyntaxtree/tree_graph.rb

@@ -10,7 +10,7 @@
 # This file is part of RSyntaxTree, which is a ruby port of Andre Eisenbach's
 # excellent program phpSyntaxTree.
 #
-# Copyright (c) 2007-2009 Yoichiro Hasebe <yohasebe@gmail.com>
+# Copyright (c) 2007-2018 Yoichiro Hasebe <yohasebe@gmail.com>
 # Copyright (c) 2003-2004 Andre Eisenbach <andre@ironcreek.net>
 # 
 # This program is free software; you can redistribute it and/or modify
@@ -33,25 +33,27 @@ require 'elementlist'
 require 'rmagick'
 include Magick
 
-E_WIDTH   = 60 # Element width
-E_PADD    = 7 # Element height padding
-V_SPACE   = 20
-H_SPACE   = 10
-B_SIDE   =   5
-B_TOPBOT =   5
+# 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",
-                 font = "Helvetica", font_size = 10, simple = false)
+                 font = "Helvetica", font_size = 10, simple = false, margin = 0)
 
-    # Store parameters
+    # Store parameters (double font size and margin to make image retina ready)
     @e_list     = e_list
     @font       = font
-    @font_size = font_size
     @terminal = terminal
     @symmetrize = symmetrize
     @simple = simple
+    @font_size = font_size * 2
+    @margin = margin * 2
 
     # Element dimensions
     @e_width   = E_WIDTH
@@ -104,6 +106,7 @@ class TreeGraph
   # by Geoffrey Grosenbach
   def to_blob(fileformat='PNG')
     draw
+    @im.border!(@margin, @margin, "white")
     return @im.to_blob do
        self.format = fileformat
     end