gn_crossmap 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47ec0f7527076236262e11f44ad1740c730e05a4
-  data.tar.gz: 8656e9ce121a47a533f72fe76c23ea312b46e509
+  metadata.gz: 26928a347c511599c6e9a967195df956db3c1b87
+  data.tar.gz: 9a5208575690e25eee143712db621da7170c2240
 SHA512:
-  metadata.gz: cae7ecb4df507bef1fe64c6b9078772a3078d960f2e9af9a1d30ae7e233df85949fe2754c8830bd54dafd0ee2ec36b0788c0a61f7e0f7e8378dd69898465e487
-  data.tar.gz: 0ab13bc741d0f80b3bbc32d16a4e813a9db7f4954f476be23f1f0ef322bd7f1da782fbf7768fbf4c791f0544521ec9c82de1927d3c04cc22e524eb8b05033df9
+  metadata.gz: 00253061383725e4825ab528614b20df2fdfa83932ac725d7dc00a05dd4b3130627d130135a4c1ecacf3fe29c8a40e349cce8730ac6dd8a940cab2fdd27dab1f
+  data.tar.gz: 04a4ab00328ed2bb90e31b306a7c73631cf1b3ae70bb8f23ce94b6792f79b696cd5d1e0870ef2079e58d4ddb7dab8b887801cc72ddd2522ae9458042bad8d252

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # ``gn_crossmap`` CHANGELOG
 
+## 2.0.0
+
+* @dimus - #26 change GnCrossmap.run to take opts parameter
+
+## 1.3.0
+
+* @dimus - #25 add `alt_headers` parameter
+
 ## 1.2.2
 
 * @dimus - fix `resolution_stop` and final status in stats

data/README.md

@@ -68,7 +68,10 @@ Compares an input list to a data source from [GN Resolver][resolver] and
 writes result into an output file.
 
 ```ruby
-GnCrossmap.run(input, output, data_source_id, skip_original, alt_headers)
+
+opts = { input: input, output: output, data_source_id: 1 ,
+         skip_original: true, alt_headers: [] }
+GnCrossmap.run(opts)
 ```
 
 ``input``
@@ -102,19 +105,23 @@ require "gn_crossmap"
 
 GnCrossmap.logger = MyCustomLogger.new
 
+opts = { input: "path/to/input.csv", output: "path/to/output.csv,
+         data_source_id: 5 , skip_original: true }
 GnCrossmap.run("path/to/input.csv", "path/to/output.csv", 5, true)
 
 # if you want to use alternative headers instead of ones supplied in a file
 
-alt_headers = %w(taxonId, scientificName, rank)
-GnCrossmap.run("path/to/input.csv", "path/to/output.csv", 5, true, alt_headers)
+opts = { input: "path/to/input.csv", output: "path/to/output.csv,
+         data_source_id: 5 , skip_original: true,
+         alt_headers: %w(taxonId, scientificName, rank) }
+GnCrossmap.run(opts)
 ```
 
 If you want to get intermediate statistics for each resolution cycle use a
 block:
 
 ```ruby
-GnCrossmap.run("path/to/input.csv", "path/to/output.csv", 5, true) do |stats|
+GnCrossmap.run(opts) do |stats|
   puts stats
   puts "Matches:"
   stats[:matches].each do |key, value|

data/exe/crossmap

@@ -26,8 +26,7 @@ unless File.exist?(opts[:input]) || opts[:input] == "-"
 end
 
 begin
-  GnCrossmap.run(opts[:input], opts[:output], opts[:data_source_id],
-                 opts[:skip_original])
+  GnCrossmap.run(opts)
 rescue GnCrossmapError => e
   GnCrossmap.logger.error(e.message)
 end

data/lib/gn_crossmap.rb

@@ -1,4 +1,5 @@
 require "csv"
+require "ostruct"
 require "rest_client"
 require "tempfile"
 require "logger"
@@ -35,17 +36,17 @@ module GnCrossmap
 
     # rubocop:disable Metrics/AbcSize
 
-    def run(input, output, data_source_id, skip_original, alt_headers = [])
-      stats = Stats.new
-      input_io, output_io = io(input, output)
-      reader = Reader.new(input_io, input_name(input),
-                          skip_original, alt_headers, stats)
+    def run(opts)
+      opts = OpenStruct.new({ stats: Stats.new, alt_headers: [] }.merge(opts))
+      input_io, output_io = io(opts.input, opts.output)
+      reader = Reader.new(input_io, input_name(opts.input),
+                          opts.skip_original, opts.alt_headers, opts.stats)
       data = block_given? ? reader.read(&Proc.new) : reader.read
       writer = Writer.new(output_io, reader.original_fields,
-                          output_name(output))
-      resolver = Resolver.new(writer, data_source_id, stats)
+                          output_name(opts.output))
+      resolver = Resolver.new(writer, opts.data_source_id, opts.stats)
       block_given? ? resolver.resolve(data, &Proc.new) : resolver.resolve(data)
-      output
+      opts.output
     end
 
     # rubocop:enable all

data/lib/gn_crossmap/version.rb

@@ -1,6 +1,6 @@
 # Namespace module for crossmapping checklists to GN sources
 module GnCrossmap
-  VERSION = "1.3.0".freeze
+  VERSION = "2.0.0".freeze
 
   def self.version
     VERSION

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gn_crossmap
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Dmitry Mozzherin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-20 00:00:00.000000000 Z
+date: 2017-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop