gnparser 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3dc26ce2cf1c9838a910e9d4fcd38f5b511b7fe28dffff1b0f1749d35c97365
-  data.tar.gz: '038fd9a682da0115201370edb16bbdfaec0871d933da5df014e658371b2c91d6'
+  metadata.gz: 849f40bfbac283e1a93a0fe8bca7d00485e07382c4f41355890989710ffa89f6
+  data.tar.gz: bb79d9b08d7a6ace2f922b64e0679dc09fbf51131561d5f16523d050de7424a0
 SHA512:
-  metadata.gz: d70363cd8b27e6f114979f35339d53fe64dd0eeb7c995aabb84a2eb3cf1335b4510bf9ebc4231cea585f18fe14115b55fe3d675775d4d80ef54dde6c14164189
-  data.tar.gz: 989134d36fc7508f474de59fc5e575406df0fc42b1803a6d229ec003e3871e8ec8b824e3e6e69665ac0496ff6c23f34ec119879390d3f492bb4fe8763e5ebdca
+  metadata.gz: ea8a7c40037914ba823f3b898ded00149e590d627acb3a9938684eea7fea69a6f6a7e3e1e4c45fcf5c236c9de624d5eebe74b716266823e6a9f953636723a9a1
+  data.tar.gz: 62116e4cc3410a4098a7a250cf9ee5a630df9fe5892c6fff03ffe92ed8916522099a61da63cbffca76189c46f9887b5d5e57f243f37763e0dd69cd9f0d7bc6d2

data/.gitignore

@@ -0,0 +1,18 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+*.swp
+*.swo
+biodiversity*.gem
+*json
+*xml
+tmp
+.DS_Store
+spec/parser/test_data_new.txt
+t
+bin
+.bundle
+bundle_bin
+Gemfile.lock

data/Gemfile.lock

@@ -1,7 +1,9 @@
 PATH
   remote: .
   specs:
-    gnparser (0.1.1)
+    gnparser (0.1.2)
+      grpc (~> 1.15)
+      grpc-tools (~> 1.15)
 
 GEM
   remote: https://rubygems.org/
@@ -54,8 +56,6 @@ DEPENDENCIES
   bundler (~> 1.16)
   byebug (~> 10.0)
   gnparser!
-  grpc (~> 1.15)
-  grpc-tools (~> 1.15)
   rake (~> 12.3)
   rspec (~> 3.8)
   rubocop (~> 0.59)

data/README.md

@@ -5,6 +5,83 @@ gRPC client to [gnparser] project
 ## Overview
 
 ``gnparser`` is a Ruby gem that allows to parse scientific names extremely
-fast using remote method calls to [gnparser].
+fast using remote gRPC method calls to [gnparser] written in Go.
 
-[gnparser]: https://gitlab.com/gogna/gnparser
+## Install
+
+```bash
+gem install gnparser
+```
+
+## Usage
+
+[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.
+
+```ruby
+require 'gnparser'
+gnp = GNparser::Client.new
+```
+
+### Output format
+
+gem supports the following formats:
+
+**compact**
+: JSON output in one line. This is the default format.
+
+**pretty**
+: ``Pretty`` JSON output.
+
+**simple**
+: Pipe-separated string where the fiels are, id, verbatim name, canonical form,
+extended canonical form, authorship, year, quality of parsing.
+
+**debug**
+: Abtract Syntax Tree of the parsed result.
+
+### Parse one name
+
+```ruby
+res = gnp.parse('Puma concolor L.')
+puts res.value
+puts res.error
+```
+
+For non-default format:
+
+```ruby
+res = gnp.parse('Puma concolor (Linn.)', :pretty)
+...
+res = gnp.parse('Puma concolor (Linn.)', 'pretty')
+...
+res = gnp.parse('Puma concolor (Linn.)', 'simple')
+...
+res = gnp.parse('Puma concolor (Linn.)', :simple)
+...
+```
+
+### Parse an array of names
+
+```ruby
+names = ['Plantago major L.', 'Homo sapiens Linn. 1758', 'Bubo bubo']
+res = gnp.parse_ary(names, :pretty)
+```
+
+### Parse names from a file
+
+File should have one name string per line.
+
+```ruby
+path = File.join(__dir__, "path", "to", "names.txt")
+res = gnp.parse_file(path, :compact)
+```
+
+[gnparser]: https://gitlab.com/gogna/gnparser
+[releases]: https://gitlab.com/gogna/gnparser/releases

data/{gnparser_rb.gemspec → gnparser.gemspec}

@@ -21,10 +21,10 @@ Gem::Specification.new do |gem|
 
   gem.require_paths = ['lib']
   gem.required_ruby_version = '~> 2.5'
+  gem.add_dependency 'grpc', '~> 1.15'
+  gem.add_dependency 'grpc-tools', '~> 1.15'
   gem.add_development_dependency 'bundler', '~> 1.16'
   gem.add_development_dependency 'byebug', '~> 10.0'
-  gem.add_development_dependency 'grpc', '~> 1.15'
-  gem.add_development_dependency 'grpc-tools', '~> 1.15'
   gem.add_development_dependency 'rake', '~> 12.3'
   gem.add_development_dependency 'rspec', '~> 3.8'
   gem.add_development_dependency 'rubocop', '~> 0.59'

data/lib/gnparser/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gnparser
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Dmitry Mozzherin
@@ -11,61 +11,61 @@ cert_chain: []
 date: 2019-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: grpc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
+        version: '1.15'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: grpc-tools
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
+        version: '1.15'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: grpc
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: grpc-tools
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -117,6 +117,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".byebug_history"
+- ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".vscode/settings.json"
@@ -126,13 +127,12 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- gnparser_rb.gemspec
+- gnparser.gemspec
 - lib/gnparser.rb
 - lib/gnparser/client.rb
 - lib/gnparser/version.rb
 - lib/gnparser_pb.rb
 - lib/gnparser_services_pb.rb
-- pkg/gnparser-0.1.0.gem
 homepage: http://gitlab.com/gnames/gnparser_rb
 licenses:
 - MIT