proiel-cli 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf5056d98706541003c897f25b470145a26dab43
-  data.tar.gz: 3bc9d72f373deec98554ec4bab9d0482f427a6b6
+  metadata.gz: fc78a4e1e71e4aeb4a10f6af394233bfa72c3be6
+  data.tar.gz: db99ba991d35a6a97948844b72c737f97bb870e1
 SHA512:
-  metadata.gz: 6f4a512e9c4f35ccfdd84c4ec1c7d2bed4c5089862802c6171247817b64bb00ba9a3dadf2e82b7ba12bee2b647b86d0faf705e402e34ba6f74c0bdc3a8547796
-  data.tar.gz: c14b7972c896f8f47dbf764b69796c011c9827b715fbf324b2bcca58f82d30acad7f0906d084e3e654299bb5cc22a77547c7fa6a7ef0e6d1c135227cf69701d9
+  metadata.gz: 5c6ef485c7ac49f746fb03a382e75601941893ff986618eabea94392e8a5c196366e2fd3a4a478a7312748e2ce66ec3db78d34832eec66ad115a1682ba8fd78c
+  data.tar.gz: 45cd79177f845d6e07bdd7af82af5a764d10acdc151c0c148c9334db33d70f905f62e41a9691106df42f373d57083e933b0b8c2713abf83072484f398e5d1bbf

data/README.md

@@ -17,6 +17,8 @@ The gem includes a command-line utility `proiel` for a number of routine tasks.
 `proiel convert conll` converts the treebank to CoNLL format. Use `proiel
 --help` for further examples and usage instructions.
 
+To use the `visualize` command you will need a local installation of [graphviz](http://graphviz.org). More specifically, the `dot` command must be available in the path.
+
 ## Development
 
 Check out the git repository from github and run `bin/setup` to install

data/bin/setup

@@ -4,4 +4,5 @@ IFS=$'\n\t'
 
 bundle install
 
-# Do any other automated setup that you need to do here
+# Issue a warning if dot cannot be found
+command -v dot >/dev/null 2>&1 || { echo >&2; echo >&2 "Warning: dot binary not found. Please install graphviz."; exit 0; }

data/lib/proiel/cli.rb

@@ -1,2 +1,4 @@
+require 'ruby-progressbar'
+
 require 'proiel/cli/version'
 require 'proiel/cli/commands'

data/lib/proiel/cli/commands/visualize.rb

@@ -0,0 +1,80 @@
+module PROIEL
+  module Commands
+    class Visualize < Command
+      class << self
+        def init_with_program(prog)
+          prog.command(:visualize) do |c|
+            c.syntax 'visualize sentences|divs|sources FILENAME(S)'
+            c.description 'Visualize treebank graphs'
+            c.option 'objects', '--objects sentences|divs|sources', 'Objects to visualize (default: sentences)'
+            c.option 'format', '--format png|svg|dot', 'Output format (default: svg)'
+            c.option 'layout', '--layout classic|linearized|packed', 'Graph layout (default: classic)'
+
+            c.action { |args, options| process(args, options) }
+          end
+        end
+
+        def process(args, options)
+          objects = options['objects'] || 'sentences'
+          format = options['format'] || 'svg'
+          layout = options['layout'] || 'classic'
+
+          if layout != 'classic' and layout != 'linearized' and layout != 'packed'
+            STDERR.puts "Invalid layout"
+            exit 1
+          end
+
+          if objects != 'sentences' and objects != 'divs' and objects != 'sources'
+            STDERR.puts "Invalid object type"
+            exit 1
+          end
+
+          if format != 'png' and format != 'svg' and format != 'dot'
+            STDERR.puts "Invalid format"
+            exit 1
+          end
+
+          tb = PROIEL::Treebank.new
+
+          if args.empty?
+            STDERR.puts "Reading from standard input...".green if options['verbose']
+            tb.load_from_xml(STDIN)
+          else
+            args.each do |filename|
+              STDERR.puts "Reading #{filename}...".green if options['verbose']
+
+              tb.load_from_xml(filename)
+            end
+          end
+
+          tb.sources.each do |source|
+            case objects
+            when 'sources'
+              puts "This can take a very, very long time... Be patient!"
+              save_graph layout, format, source
+            when 'divs'
+              save_graphs source.divs, layout, format, source.id, source.divs.count
+            when 'sentences'
+              save_graphs source.sentences, layout, format, source.id, source.sentences.count
+            else
+              raise
+            end
+          end
+        end
+
+        def save_graph(template, format, graph)
+          PROIEL::Visualization::Graphviz.generate_to_file(template, graph, format, "#{graph.id}.#{format}")
+        end
+
+        def save_graphs(enumerator, template, format, title, n)
+          pbar = ProgressBar.create progress_mark: 'X', remainder_mark: ' ', title: title, total: n
+
+          enumerator.each_with_index do |object, i|
+            save_graph template, format, object
+            pbar.increment
+          end
+        end
+      end
+    end
+  end
+end

data/lib/proiel/cli/version.rb

@@ -1,5 +1,5 @@
 module PROIEL
   module CLI
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: proiel-cli
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Marius L. Jøhndal
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-04 00:00:00.000000000 Z
+date: 2016-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -59,42 +59,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -143,42 +143,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: '0.14'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: '0.9'
 description: This provides a command-line interface to various tools that manipulate
   treebanks that use the PROIEL dependency format.
 email:
@@ -204,7 +204,7 @@ files:
 - lib/proiel/cli/commands/info.rb
 - lib/proiel/cli/commands/tokenize.rb
 - lib/proiel/cli/commands/validate.rb
-- lib/proiel/cli/commands/words.rb
+- lib/proiel/cli/commands/visualize.rb
 - lib/proiel/cli/converters/conll-u.rb
 - lib/proiel/cli/converters/conll-u/morphology.rb
 - lib/proiel/cli/converters/conll-u/syntax.rb
@@ -241,4 +241,3 @@ signing_key:
 specification_version: 4
 summary: A command-line interface for working with PROIEL treebanks
 test_files: []
-has_rdoc: 

data/lib/proiel/cli/commands/words.rb

@@ -1,36 +0,0 @@
-module PROIEL
-  module Commands
-    class Words < Command
-      class << self
-        def init_with_program(prog)
-          prog.command(:words) do |c|
-            c.syntax 'words [options] filename(s)'
-            c.description 'Extract a word list'
-
-            c.action do |args, options|
-              if args.empty?
-                STDERR.puts 'Missing filename(s). Use --help for more information.'
-              else
-                process(args, options)
-              end
-            end
-          end
-        end
-
-        def process(args, options)
-          tb = PROIEL::Treebank.new
-
-          args.each do |filename|
-            STDERR.puts "Reading #{filename}...".green if options['verbose']
-
-            tb.load_from_xml(filename)
-          end
-
-          tb.sources.map { |s| s.tokens.map(&:form) }.flatten.sort.uniq.each do |form|
-            STDOUT.puts form
-          end
-        end
-      end
-    end
-  end
-end