gnparser 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 849f40bfbac283e1a93a0fe8bca7d00485e07382c4f41355890989710ffa89f6
-  data.tar.gz: bb79d9b08d7a6ace2f922b64e0679dc09fbf51131561d5f16523d050de7424a0
+  metadata.gz: ca997f4abf937af1e72a922b235560328ce24cab715212f131cfad1faae0180d
+  data.tar.gz: c19783e6482bdf6f100355aaa1111a32363b88fc34f5012a56b99349c1f847ea
 SHA512:
-  metadata.gz: ea8a7c40037914ba823f3b898ded00149e590d627acb3a9938684eea7fea69a6f6a7e3e1e4c45fcf5c236c9de624d5eebe74b716266823e6a9f953636723a9a1
-  data.tar.gz: 62116e4cc3410a4098a7a250cf9ee5a630df9fe5892c6fff03ffe92ed8916522099a61da63cbffca76189c46f9887b5d5e57f243f37763e0dd69cd9f0d7bc6d2
+  metadata.gz: 73c4aa417d996d80976afc931e8b6c67699cb388f61e34f5a1e872591a87ef6ebee76ac932fe5d70fe6cc4fee3f308a09be05dba34c86c051a80932bd7811f79
+  data.tar.gz: ab8df5a0a97c90bd7481d9a3e858e3fc2ff2ced99a597f5d1fe103f2111340d22fff206dcb508a4d0bdba5efbd818ad4f8fe092da5178861fa8cd9ea4bf49754

data/README.md

@@ -1,6 +1,6 @@
 # gnparser
 
-gRPC client to [gnparser] project
+gRPC client to [gnparser] project (Go version)
 
 ## Overview
 
@@ -15,21 +15,45 @@ gem install gnparser
 
 ## Usage
 
-[Download][releases] the latest version of Go gnparser, and start it
-on your local machine as a grpc server:
+[Download][releases] the latest version of Go `gnparser`, and start it
+on your local machine as a gRPC server:
 
 ```bash
 gnparser -g 8778
 ```
 
-Now you will be able to use Ruby gnparser with its default settings.
+Now you will be able to use Ruby `gnparser` with its default settings.
 
 ```ruby
 require 'gnparser'
 gnp = GNparser::Client.new
+
+# To use different host and port:
+gnp = GNparser::Client.new(host = 'parser.example.com', port = 1234 )
+gnp = GNparser::Client.new(host = 'parser.example.com', port = '1234' )
+# Use default 8778 port
+gnp = GNparser::Client.new(host = 'parser.example.com')
+# Use default 0.0.0.0 host
+gnp = GNparser::Client.new(port = '1234' )
+```
+
+### Versions
+
+To see version of the gem:
+
+```ruby
+gnp.version
+```
+
+To see version of the Go gnparser:
+
+```ruby
+ver = gnp.parser_version
+puts ver.value
+puts ver.build_time.size
 ```
 
-### Output format
+### Output formats
 
 gem supports the following formats:
 
@@ -40,12 +64,22 @@ gem supports the following formats:
 : ``Pretty`` JSON output.
 
 **simple**
-: Pipe-separated string where the fiels are, id, verbatim name, canonical form,
+: Pipe-separated string where the fields are, id, verbatim name, canonical form,
 extended canonical form, authorship, year, quality of parsing.
 
 **debug**
 : Abtract Syntax Tree of the parsed result.
 
+### Option preserve_order
+
+To speed parsing up parser normally executes several jobs in parallel, and
+as a result the order the jobs go back may be different from input. It means
+the user has to match output's ``verbatim`` field with the list of its names.
+
+If speed of parsing is sufficient you can use one-threaded parsing that
+guarantees that the order of output will be exactly the same as the order of
+the input. For this purpose use ``preserve_order: true`` option.
+
 ### Parse one name
 
 ```ruby
@@ -57,13 +91,13 @@ puts res.error
 For non-default format:
 
 ```ruby
-res = gnp.parse('Puma concolor (Linn.)', :pretty)
+res = gnp.parse('Puma concolor (Linn.)', format: :pretty)
 ...
-res = gnp.parse('Puma concolor (Linn.)', 'pretty')
+res = gnp.parse('Puma concolor (Linn.)', format: 'pretty')
 ...
-res = gnp.parse('Puma concolor (Linn.)', 'simple')
+res = gnp.parse('Puma concolor (Linn.)', format: 'simple')
 ...
-res = gnp.parse('Puma concolor (Linn.)', :simple)
+res = gnp.parse('Puma concolor (Linn.)', format: :simple)
 ...
 ```
 
@@ -71,7 +105,20 @@ res = gnp.parse('Puma concolor (Linn.)', :simple)
 
 ```ruby
 names = ['Plantago major L.', 'Homo sapiens Linn. 1758', 'Bubo bubo']
-res = gnp.parse_ary(names, :pretty)
+
+# fast, might get output in different order from input
+res = gnp.parse_ary(names, format: :pretty)
+res.each do |r|
+  puts r.value
+  puts r.error
+end
+
+# slower, returns the same order for output as it was for input
+results = []
+res = gnp.parse_ary(names, format: :pretty, preserve_order: true)
+res.each_with_index |r, i|
+  results << { input: names[i], output:  r }
+end
 ```
 
 ### Parse names from a file
@@ -80,7 +127,18 @@ File should have one name string per line.
 
 ```ruby
 path = File.join(__dir__, "path", "to", "names.txt")
-res = gnp.parse_file(path, :compact)
+res = gnp.parse_file(path, format: :compact)
+res.each do |r|
+  puts r.value
+  puts r.error
+end
+
+# preserving order of items in output
+results = []
+res = gnp.parse_file(path, format: :compact, preserve_order: true)
+res.each_with_index |r, i|
+  results << { input: names[i], output:  r }
+end
 ```
 
 [gnparser]: https://gitlab.com/gogna/gnparser

data/lib/gnparser/client.rb

@@ -9,29 +9,46 @@ module GNparser
   }.freeze
   # Gnfinder::Client connects to gnfinder server
   class Client
+    PARSER_MIN_VERSION = 'v0.6.0'
+
     def initialize(host = '0.0.0.0', port = '8778')
       @stub = Grpc::GNparser::Stub.new("#{host}:#{port}",
                                        :this_channel_is_insecure)
+      return if parser_version.value >= PARSER_MIN_VERSION
+
+      raise 'gRPC server of gnparser should be at least ' \
+            ' #{PARSER_MIN_VERSION}.\n Download latest version from ' \
+            'https://gitlab/gogna/gnparser/releases.'
     end
 
-    def version
+    def parser_version
       @stub.ver(Grpc::Void.new)
     end
 
-    def parse(name, format = :compact)
-      enum = InputEnum.new([name], format)
-      @stub.parse(enum.each_item).next
+    def parse(name, opts = {})
+      parse_iter([name], opts).next
     end
 
-    def parse_ary(ary, format = :compact)
-      enum = InputEnum.new(ary, format)
-      @stub.parse(enum.each_item)
+    def parse_ary(ary, opts = {})
+      parse_iter(ary, opts)
     end
 
-    def parse_file(path, format = :compact)
+    def parse_file(path, opts = {})
       f = File.open(path)
-      enum = InputEnum.new(f, format)
-      @stub.parse(enum.each_item)
+      parse_iter(f, opts)
+    end
+
+    private
+
+    def parse_iter(iter, opts)
+      format = opts[:format] || :compact
+      preserve_order = opts[:preserve_order]
+      enum = InputEnum.new(iter, format)
+      if preserve_order
+        @stub.parse_in_order(enum.each_item)
+      else
+        @stub.parse(enum.each_item)
+      end
     end
   end
 

data/lib/gnparser/version.rb

@@ -2,7 +2,7 @@
 
 # GNparser is a namespace module for gnparser gem.
 module GNparser
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 
   def self.version
     VERSION

data/lib/gnparser_pb.rb

@@ -16,35 +16,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :name, :string, 2
     end
   end
-  add_message "grpc.Name" do
-    optional :parsed, :bool, 1
-    optional :quality, :int32, 2
-    optional :verbatim, :string, 3
-    optional :normalized, :string, 4
-    optional :canonical_simple, :string, 5
-    optional :canonical_full, :string, 6
-    optional :genus, :message, 7, "grpc.Entry"
-    optional :subgenus, :message, 8, "grpc.Entry"
-    optional :species, :message, 9, "grpc.Entry"
-    optional :subspicies, :message, 10, "grpc.Entry"
-    optional :variety, :message, 11, "grpc.Entry"
-    optional :form, :message, 12, "grpc.Entry"
-  end
-  add_message "grpc.Entry" do
-    optional :value, :string, 1
-    optional :norm_value, :string, 2
-    optional :position, :message, 3, "grpc.Pos"
-    optional :authors, :string, 4
-    optional :year, :string, 5
-    optional :score, :string, 6
-  end
-  add_message "grpc.Pos" do
-    optional :start, :int32, 1
-    optional :end, :int32, 2
-  end
   add_message "grpc.Output" do
-    optional :value, :string, 1
-    optional :error, :string, 2
+    optional :value, :string, 2
+    optional :error, :string, 3
   end
   add_enum "grpc.Format" do
     value :Compact, 0
@@ -58,9 +32,6 @@ module Grpc
   Version = Google::Protobuf::DescriptorPool.generated_pool.lookup("grpc.Version").msgclass
   Void = Google::Protobuf::DescriptorPool.generated_pool.lookup("grpc.Void").msgclass
   Input = Google::Protobuf::DescriptorPool.generated_pool.lookup("grpc.Input").msgclass
-  Name = Google::Protobuf::DescriptorPool.generated_pool.lookup("grpc.Name").msgclass
-  Entry = Google::Protobuf::DescriptorPool.generated_pool.lookup("grpc.Entry").msgclass
-  Pos = Google::Protobuf::DescriptorPool.generated_pool.lookup("grpc.Pos").msgclass
   Output = Google::Protobuf::DescriptorPool.generated_pool.lookup("grpc.Output").msgclass
   Format = Google::Protobuf::DescriptorPool.generated_pool.lookup("grpc.Format").enummodule
 end

data/lib/gnparser_services_pb.rb

@@ -16,6 +16,7 @@ module Grpc
 
       rpc :Ver, Void, Version
       rpc :Parse, stream(Input), stream(Output)
+      rpc :ParseInOrder, stream(Input), stream(Output)
     end
 
     Stub = Service.rpc_stub_class

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gnparser
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Dmitry Mozzherin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-16 00:00:00.000000000 Z
+date: 2019-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc