dwc-archive 0.9.11 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5c6c5b2a4de324abded5b3adb81d6bcd9603965f
-  data.tar.gz: ac00e15f95766838ff42a9bdc3f1a682c4a8e9ff
+SHA256:
+  metadata.gz: 8e61e692fe24c4b6bd56e38a7b19a357ba0acdd3180999e606bd6fc8e55dae29
+  data.tar.gz: 1bf6ee067e24d6cb75d415eaa1f10bcf37a96d7daee7a1935248a6a58a0cb5ed
 SHA512:
-  metadata.gz: d84f2974ed7bcbabc62d2d3b5c5b15dd8d6d2aa38836a955c12896ada2391e978ca2d420d86bf59db2ab61cc801c9c43036be13699ba7b3902d8daa4f366d45b
-  data.tar.gz: a07a91365cba60fa418b85d7b516781c9209ea607dbe5ec45da86febd14bfa104cc16e4b55619a157f5bbb487dff2fd7e318399d815a63372197a9732b3820fb
+  metadata.gz: a162b05026795e2e4ea8e92683682fab820fb0cfcea68a8c166eb9dc012246ba01a16af4e17af39a2ae28bf2b6a3b85f877ac53b71e27915f8529cb4d973d67a
+  data.tar.gz: 10a59bee9c60103c91fd5403c4c765903521e640dab3c6ef7ff78eaceb04938aa0bd554e9941bdd90260a2f0a2e4927be3d0ada830b2a4310be405f2ead1184f

data/.rspec

@@ -1,2 +1,3 @@
---format nested
+--format p
 --color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+    - features/**/*
+    - .bundle/**/*
+    - bundle_bin/**/*
+    - lib/dwc_archive/ingester.rb
+    - lib/dwc_archive/generator_meta_xml.rb
+    - lib/dwc_archive/generator_eml_xml.rb
+    - lib/dwc_archive/classification_normalizer.rb
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '*.gemspec'
+    - '**/*.rake'
+    - 'spec/**/*spec.rb'

data/.ruby-version

@@ -1 +1 @@
-2.0.0-p353
+2.5.1

data/.travis.yml

@@ -1,9 +1,8 @@
 rvm:
-  - 1.9.3-p484
-  - 2.0.0-p353
+  - 2.4
+  - 2.5
 before_install:
   - sudo apt-get update
-  - gem install debugger
 # bundler_args: --without development
 services:
   - redis-server

data/CHANGELOG

@@ -1,3 +1,5 @@
+1.0.1  Cleanup and gems update
+
 0.9.11 Removed VERSION duplicate
 
 0.9.7  Refactoring and tests improvements

data/Gemfile

@@ -1,3 +1,5 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 gemspec

data/README.md

@@ -19,136 +19,140 @@ Installation
 
 ### System Requirements
 
-You need [Redis Server][12] and unzip library installed 
+You need [Redis Server][12] and unzip library installed
 
 
 Usage
 -----
 
-    require 'rubygems'
-    require 'dwc-archive'
+```ruby
+require 'rubygems'
+require 'dwc-archive'
 
-    dwc = DarwinCore.new('/path_to_file/archive_file.tar.gz')
-    dwc.archive.files      # the archive file list
-    dwc.metadata.data      # summary of metadata from eml.xml if it exists
-    dwc.metadata.authors   # authors of the archive
-    dwc.core.data          # summary of DarwinCore main file
-    dwc.core.file_path     # path to the DarwinCore main file
-    dwc.extensions         # array of DarwinCore Star extensions
-    dwc.extensions[0].data # summary for an extension
+dwc = DarwinCore.new('/path_to_file/archive_file.tar.gz')
+dwc.archive.files      # the archive file list
+dwc.metadata.data      # summary of metadata from eml.xml if it exists
+dwc.metadata.authors   # authors of the archive
+dwc.core.data          # summary of DarwinCore main file
+dwc.core.file_path     # path to the DarwinCore main file
+dwc.extensions         # array of DarwinCore Star extensions
+dwc.extensions[0].data # summary for an extension
 
-    # read content of the core data file into memory or used with a block
-    # it returns array of arrays of data
-    # rows that had a wrong encoding will be collected into errors array
-    data, errors = dwc.core.read
+# read content of the core data file into memory or used with a block
+# it returns array of arrays of data
+# rows that had a wrong encoding will be collected into errors array
+data, errors = dwc.core.read
 
-    # read content using a block, getting back results in sets of 100 rows each
-    results = []
-    tail_data, tail_errors = dwc.core.read(100) do |data, errors|
-      results << [data, errors]
-    end
-    results << [tail_data, tail_errors]
+# read content using a block, getting back results in sets of 100 rows each
+results = []
+tail_data, tail_errors = dwc.core.read(100) do |data, errors|
+  results << [data, errors]
+end
+results << [tail_data, tail_errors]
 
-    # read content of an extension data file into memory
-    data, errors = dwc.core.extensions[0].read
+# read content of an extension data file into memory
+data, errors = dwc.core.extensions[0].read
 
-    # read content of an extension data using block
-    results = []
-    tail_data, tail_errors = dwc.core.extensions[0](100) do |data, errors|
-      results << [data, errors]
-    end
-    results << [tail_data, tail_errors]
+# read content of an extension data using block
+results = []
+tail_data, tail_errors = dwc.core.extensions[0](100) do |data, errors|
+  results << [data, errors]
+end
+results << [tail_data, tail_errors]
 
-    # normalize names in classification collecting together synonyms,
-    # canonical names, vernacular names and associating paths to taxons
-    # in a classification distributed as DwCA file
+# normalize names in classification collecting together synonyms,
+# canonical names, vernacular names and associating paths to taxons
+# in a classification distributed as DwCA file
 
-    result = dwc.normalize_classification
+result = dwc.normalize_classification
 
-    # for a finer control over normalization:
+# for a finer control over normalization:
 
-    cn = DarwinCore::ClassificationNormalizer.new(dwc)
-    cn.normalize
-    # if you don't want to generate path consisting of canonical forms
-    # of ancestors to a taxon
-    cn.normalize(:with_canonical_names => false)
+cn = DarwinCore::ClassificationNormalizer.new(dwc)
+cn.normalize
+# if you don't want to generate path consisting of canonical forms
+# of ancestors to a taxon
+cn.normalize(:with_canonical_names => false)
 
-    # if you don't want to ingest information from extensions
-    cn.normalize(:with_extensions => false)
+# if you don't want to ingest information from extensions
+cn.normalize(:with_extensions => false)
 
-    # to get a flat hash of nodes with attached vernacular names and synonyms
-    normalized_data = cn.normalized_data
+# to get a flat hash of nodes with attached vernacular names and synonyms
+normalized_data = cn.normalized_data
 
-    # to get a representation of tree organization as a hash
-    classification_tree = cn.tree
+# to get a representation of tree organization as a hash
+classification_tree = cn.tree
 
-    # to get list of all name strings used as scientific or vernacular names
-    all_name_strings = cn.name_strings
+# to get list of all name strings used as scientific or vernacular names
+all_name_strings = cn.name_strings
 
-    # to get list of errors generated during the normalization
-    errors = cn.error_names
+# to get list of errors generated during the normalization
+errors = cn.error_names
 
-    DarwinCore.clean_all   # remove all expanded archives
+DarwinCore.clean_all   # remove all expanded archives
+```
 
 Creating a DarwinCore Archive file
 ----------------------------------
 
-    gen = DarwinCore::Generator.new('/tmp/dwc_birches.tar.gz')
-
-    core = [
-      ["http://rs.tdwg.org/dwc/terms/taxonID",
-       "http://rs.tdwg.org/dwc/terms/parentNameUsageID",
-       "http://rs.tdwg.org/dwc/terms/scientificName",
-       "http://rs.tdwg.org/dwc/terms/taxonRank"],
-      [1, 0, "Plantae", "kingdom"],
-      [2, 1, "Betula", "genus"],
-      [3, 2, "Betula verucosa", "species"]
-    ]
-
-    vernacular_names = [
-      ["http://rs.tdwg.org/dwc/terms/TaxonID",
-      "http://rs.tdwg.org/dwc/terms/vernacularName"],
-      [1, "Plants"],
-      [1, "Растения"],
-      [2, "Birch"],
-      [2, "Береза"],
-      [3, "Wheeping Birch"],
-      [3, "Береза плакучая"]
-    ]
-
-    eml = {
-      :id => '1234',
-      :license => 'http://creativecommons.org/licenses/by-sa/3.0/',
-      :title => 'Test Classification',
-      :authors => [
-        { :first_name => 'John',
-          :last_name => 'Doe',
-          :email => 'jdoe@example.com',
-          :organization => 'Example',
-          :position => 'Assistant Professor',
-          :url => 'http://example.org' },
-          { :first_name => 'Jane',
-            :last_name => 'Doe',
-            :email => 'jane@example.com' }
-    ],
-      :metadata_providers => [
-        { :first_name => 'Jim',
-          :last_name => 'Doe',
-          :email => 'jimdoe@example.com',
-          :url => 'http://aggregator.example.org' }],
-      :abstract => 'test classification',
-      :citation =>
-        'Test classification: Doe John, Doe Jane, Taxnonmy, 10, 1, 2010',
-      :url => 'http://example.com'
-    }
-
-    gen.add_core(core, 'core.txt')
-    gen.add_extension(vernacular_names,
-                      'vernacular_names.txt',
-                      true, 'http://rs.gbif.org/terms/1.0/VernacularName')
-    gen.add_meta_xml
-    gen.add_eml_xml(eml)
-    gen.pack
+```ruby
+gen = DarwinCore::Generator.new('/tmp/dwc_birches.tar.gz')
+
+core = [
+  ["http://rs.tdwg.org/dwc/terms/taxonID",
+   "http://rs.tdwg.org/dwc/terms/parentNameUsageID",
+   "http://rs.tdwg.org/dwc/terms/scientificName",
+   "http://rs.tdwg.org/dwc/terms/taxonRank"],
+  [1, 0, "Plantae", "kingdom"],
+  [2, 1, "Betula", "genus"],
+  [3, 2, "Betula verucosa", "species"]
+]
+
+vernacular_names = [
+  ["http://rs.tdwg.org/dwc/terms/TaxonID",
+  "http://rs.tdwg.org/dwc/terms/vernacularName"],
+  [1, "Plants"],
+  [1, "Растения"],
+  [2, "Birch"],
+  [2, "Береза"],
+  [3, "Wheeping Birch"],
+  [3, "Береза плакучая"]
+]
+
+eml = {
+  :id => '1234',
+  :license => 'http://creativecommons.org/licenses/by-sa/3.0/',
+  :title => 'Test Classification',
+  :authors => [
+    { :first_name => 'John',
+      :last_name => 'Doe',
+      :email => 'jdoe@example.com',
+      :organization => 'Example',
+      :position => 'Assistant Professor',
+      :url => 'http://example.org' },
+      { :first_name => 'Jane',
+        :last_name => 'Doe',
+        :email => 'jane@example.com' }
+],
+  :metadata_providers => [
+    { :first_name => 'Jim',
+      :last_name => 'Doe',
+      :email => 'jimdoe@example.com',
+      :url => 'http://aggregator.example.org' }],
+  :abstract => 'test classification',
+  :citation =>
+    'Test classification: Doe John, Doe Jane, Taxnonmy, 10, 1, 2010',
+  :url => 'http://example.com'
+}
+
+gen.add_core(core, 'core.txt')
+gen.add_extension(vernacular_names,
+                  'vernacular_names.txt',
+                  true, 'http://rs.gbif.org/terms/1.0/VernacularName')
+gen.add_meta_xml
+gen.add_eml_xml(eml)
+gen.pack
+```
 
 Logging
 -------

data/Rakefile

@@ -1,44 +1,21 @@
-require "bundler/gem_tasks"
-
-# Bundler::GemHelper.install_tasks
-# require 'bundler/gem_tasks'
-# require 'rake/testtasks'
-# require 'rubygems'
-# require 'rake'
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-end
+# frozen_string_literal: true
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-# task :spec => :check_dependencies
-
-begin
-  require 'cucumber/rake/task'
-  Cucumber::Rake::Task.new(:features)
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "cucumber/rake/task"
 
-  task :features => :check_dependencies
-rescue LoadError
-  task :features do
-    abort 'Cucumber is not available. In order to run features, ' +
-      'you must: sudo gem install cucumber'
-  end
+RSpec::Core::RakeTask.new(:rspec) do |rspec|
+  rspec.pattern = "spec/**/*_spec.rb"
 end
 
-desc 'Run an IRB session with CSL loaded'
-task :irb, [:script] do |t, args|
-  ARGV.clear
+Cucumber::Rake::Task.new(:features)
 
-  require 'irb'
-  require_relative 'lib/dwc-archive'
+# task rspec: :check_dependencies
+task features: :check_dependencies
 
-  IRB.conf[:SCRIPT] = args.script
-  IRB.start
+desc "open an irb session preloaded with this library"
+task :console do
+  sh "irb -I lib -I extra -r dwc_archive.rb"
 end
 
-task :default => :spec
+task default: :rspec

data/dwc-archive.gemspec

@@ -1,33 +1,38 @@
-require File.expand_path('../lib/dwc-archive/version', __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path("lib/dwc_archive/version", __dir__)
 
 Gem::Specification.new do |gem|
   gem.name          = "dwc-archive"
   gem.version       = DarwinCore::VERSION
   gem.authors       = ["Dmitry Mozzherin"]
   gem.email         = ["dmozzherin at gmail dot com"]
-  gem.description   = %q{Darwin Core Archive is the current standard exchange 
-                          format for GLobal Names Architecture modules.  
-                          This gem makes it easy to incorporate files in 
-                          Darwin Core Archive format into a ruby project.}
-  gem.summary       = %q{Handler of Darwin Core Archive files}
+  gem.description   = "Darwin Core Archive is the current standard exchange " \
+                      "format for GLobal Names Architecture modules. " \
+                      "This gem makes it easy to incorporate files in " \
+                      "Darwin Core Archive format into a ruby project."
+  gem.summary       = "Handler of Darwin Core Archive files"
   gem.homepage      = "http://github.com/GlobalNamesArchitecture/dwc-archive"
   gem.license       = "MIT"
 
-  gem.files         = `git ls-files`.split($/)
+  gem.required_ruby_version = ">= 2.4.1"
+  gem.files         = `git ls-files`.split("\n").map(&:strip)
   gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_runtime_dependency 'nokogiri', '~> 1.6'
-  gem.add_runtime_dependency 'parsley-store', '~> 0.3'
-  gem.add_runtime_dependency 'archive-tar-minitar', '~> 0.5'
-  
-  gem.add_development_dependency 'rake', '~> 10.1'
-  gem.add_development_dependency 'bundler', '~> 1.3'
-  gem.add_development_dependency 'rspec', '~> 2.14'
-  gem.add_development_dependency 'cucumber', '~> 1.3'
-  gem.add_development_dependency 'coveralls', '~> 0.7'
-  gem.add_development_dependency 'debugger', '~> 1.6'
-  gem.add_development_dependency 'git', '~> 1.2'
-end
+  # gem.add_runtime_dependency "minitar", "~> 0.6"
+  gem.add_runtime_dependency "nokogiri", "~> 1.8"
+  gem.add_runtime_dependency "parsley-store", "~> 0.3"
 
+  # gem.add_development_dependency "byebug", "~> 3.4"
+  gem.add_development_dependency "bundler", "~> 1.16"
+  gem.add_development_dependency "coveralls", "~> 0.8"
+  gem.add_development_dependency "cucumber", "~> 3.1"
+  gem.add_development_dependency "git", "~> 1.4"
+  gem.add_development_dependency "rake", "~> 12.3"
+  gem.add_development_dependency "rspec", "~> 3.7"
+  gem.add_development_dependency "rubocop", "~> 0.58"
+  gem.add_development_dependency "solargraph", "~> 0.23"
+  gem.add_development_dependency "travis", "~> 1.8"
+end

data/features/step_definitions/dwc-creator_steps.rb

@@ -19,7 +19,7 @@ end
 
 Then /^these data should be saved as "([^\"]*)" file$/ do |file_name|
   file = File.join(@gen.path, file_name)
-  @gen.files.include?(file_name).should be_true
+  @gen.files.include?(file_name).should be true
   csv = CSV.open(file).count.should == 4
 end
 
@@ -51,7 +51,7 @@ end
 Then /^data are saved as "([^\"]*)" and "([^\"]*)"$/ do |file_name_1, file_name_2|
   [file_name_1, file_name_2].each do |file_name|
     file = File.join(@gen.path, file_name)
-    @gen.files.include?(file_name).should be_true
+    @gen.files.include?(file_name).should be true
     csv = CSV.open(file).count.should > 1
   end
 end
@@ -86,7 +86,7 @@ end
 
 Then /^there should be "([^\"]*)" file with core and extensions informations$/ do |file_name|
   meta = File.join(@gen.path, file_name)
-  @gen.files.include?(file_name).should be_true
+  @gen.files.include?(file_name).should be true
   dom = Nokogiri::XML(open(File.join(@gen.path, file_name)))
   dom.xpath('//xmlns:core//xmlns:location').text.should == 'darwin_core.txt'
   dom.xpath('//xmlns:extension[1]//xmlns:location').text.should == 'vernacular.txt'
@@ -94,7 +94,7 @@ end
 
 Then /^there should be "([^\"]*)" file with authoriship information$/ do |file_name|
   eml = File.join(@gen.path, file_name)
-  @gen.files.include?(file_name).should be_true
+  @gen.files.include?(file_name).should be true
 end
 
 Given /^a path to a new file \- "([^\"]*)"$/ do |file_name|
@@ -107,6 +107,6 @@ end
 
 Then /^there should be a valid new archive file$/ do
   dwc = DarwinCore.new('/tmp/dwc.tar.gz')
-  dwc.archive.valid?.should be_true
+  dwc.archive.valid?.should be true
 end