Merge pull request #45 from nsidc/srch-135

SRCH-135

Author: scott-lewis-nsidc

.rubocop.yml

@@ -5,6 +5,8 @@ require:
 AllCops:
   Include:
     - tasks/*.rake
+    - lib/**/*.rb
+    - spec/**/*.rb
     - Guardfile
     - Rakefile
   Exclude:
@@ -15,6 +17,10 @@ AllCops:
 Layout/EmptyLinesAroundAttributeAccessor:
   Enabled: true
 
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
 Layout/LineLength:
   Enabled: false
 
@@ -37,16 +43,19 @@ Metrics/AbcSize:
   Max: 20
 
 Metrics/ClassLength:
-  Max: 125
+  Max: 200
 
 Metrics/CyclomaticComplexity:
-  Max: 8
+  Max: 10
 
 Metrics/MethodLength:
   Max: 30
 
 Metrics/ModuleLength:
-  Max: 101
+  Max: 200
+
+Metrics/PerceivedComplexity:
+  Max: 10
 
 Style/Documentation:
   Enabled: false
@@ -80,3 +89,26 @@ Style/RescueModifier:
 
 Style/SlicingWithRange:
   Enabled: true
+
+# RSPEC SPECIFIC
+
+RSpec/DescribeClass:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 30
+
+RSpec/FilePath:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 10
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+
+RSpec/NestedGroups:
+  Max: 5
+
+RSpec/VerifiedDoubleReference:
+  EnforcedStyle: string

CHANGELOG.md

@@ -1,3 +1,8 @@
+## Unreleased
+
+  - Update Rubocop configuration to actually run against files, and make
+    necessary corrections to comply with Rubocop styling.
+
 ## v6.2.0 (2022-07-18)
 
   - Remove deprecated harvesters and associated tests, helpers, etc.

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    search_solr_tools (6.2.0)
+    search_solr_tools (6.3.0.pre.1)
       ffi-geos (~> 2.4.0)
       iso8601 (~> 0.13.0)
       multi_json (~> 1.15.0)

bin/search_solr_tools

@@ -47,7 +47,7 @@ class SolrHarvestCLI < Thor
     end
 
     ping_status = SearchSolrTools::Helpers::HarvestStatus.new(
-      SearchSolrTools::Helpers::HarvestStatus::PING_SOLR => solr_success,
+      SearchSolrTools::Helpers::HarvestStatus::PING_SOLR   => solr_success,
       SearchSolrTools::Helpers::HarvestStatus::PING_SOURCE => source_success
     )
     raise SearchSolrTools::Errors::HarvestError, ping_status unless ping_status.ok?
@@ -64,9 +64,9 @@ class SolrHarvestCLI < Thor
       puts "Target: #{target}"
       begin
         harvest_class = get_harvester_class(target)
-        harvester = harvest_class.new(options[:environment], die_on_failure)
+        harvester = harvest_class.new(options[:environment], die_on_failure:)
         ping_status = SearchSolrTools::Helpers::HarvestStatus.new(
-          SearchSolrTools::Helpers::HarvestStatus::PING_SOLR => harvester.ping_solr,
+          SearchSolrTools::Helpers::HarvestStatus::PING_SOLR   => harvester.ping_solr,
           SearchSolrTools::Helpers::HarvestStatus::PING_SOURCE => harvester.ping_source
         )
         raise SearchSolrTools::Errors::HarvestError, ping_status unless ping_status.ok?
@@ -120,7 +120,7 @@ class SolrHarvestCLI < Thor
   no_tasks do
     def harvester_map
       {
-        'nsidc' => SearchSolrTools::Harvesters::NsidcJson,
+        'nsidc'              => SearchSolrTools::Harvesters::NsidcJson,
         'nsidc_auto_suggest' => SearchSolrTools::Harvesters::NsidcAutoSuggest
       }
     end

lib/search_solr_tools.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require_relative 'search_solr_tools/config/environments'
 require_relative 'search_solr_tools/version'
 
 require_relative 'search_solr_tools/helpers/harvest_status'
 require_relative 'search_solr_tools/errors/harvest_error'
 
-%w( harvesters translators ).each do |subdir|
+%w[harvesters translators].each do |subdir|
   Dir[File.join(__dir__, 'search_solr_tools', subdir, '*.rb')].each { |file| require file }
 end

lib/search_solr_tools/config/environments.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'yaml'
 
 module SearchSolrTools
   # configuration to work with solr locally, or on integration/qa/staging/prod
   module SolrEnvironments
-    YAML_ENVS = YAML.load_file(File.expand_path('../environments.yaml', __FILE__))
+    YAML_ENVS = YAML.load_file(File.expand_path('environments.yaml', __dir__))
 
     def self.[](env = :development)
       YAML_ENVS[:common].merge(YAML_ENVS[env.to_sym])

lib/search_solr_tools/errors/harvest_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SearchSolrTools
   module Errors
     class HarvestError < StandardError
@@ -10,55 +12,65 @@ class HarvestError < StandardError
       ERRCODE_OTHER = 128
 
       ERRCODE_DESC = {
-          ERRCODE_SOLR_PING => 'Solr instance did not return a successful ping',
-          ERRCODE_SOURCE_PING => 'Source to be harvested did not return a successful ping',
-          ERRCODE_SOURCE_NO_RESULTS => 'Source to be harvested returned no documents matching query',
-          ERRCODE_SOURCE_HARVEST_ERROR => 'One or more source documents returned an error when trying to retrieve or translate',
-          ERRCODE_DOCUMENT_INVALID => 'One or more documents to be harvested was invalid (malformed)',
-          ERRCODE_INGEST_ERROR => 'Solr returned an error trying to ingest one or more harvested documents',
-          ERRCODE_OTHER => 'General error code for non-harvest related issues'
+        ERRCODE_SOLR_PING            => 'Solr instance did not return a successful ping',
+        ERRCODE_SOURCE_PING          => 'Source to be harvested did not return a successful ping',
+        ERRCODE_SOURCE_NO_RESULTS    => 'Source to be harvested returned no documents matching query',
+        ERRCODE_SOURCE_HARVEST_ERROR => 'One or more source documents returned an error when trying to retrieve or translate',
+        ERRCODE_DOCUMENT_INVALID     => 'One or more documents to be harvested was invalid (malformed)',
+        ERRCODE_INGEST_ERROR         => 'Solr returned an error trying to ingest one or more harvested documents',
+        ERRCODE_OTHER                => 'General error code for non-harvest related issues'
       }.freeze
 
       PING_ERRCODE_MAP = {
-        'ping_solr' => ERRCODE_SOLR_PING,
-        'ping_source' => ERRCODE_SOURCE_PING,
-      }
+        'ping_solr'   => ERRCODE_SOLR_PING,
+        'ping_source' => ERRCODE_SOURCE_PING
+      }.freeze
 
       STATUS_ERRCODE_MAP = {
-          Helpers::HarvestStatus::HARVEST_NO_DOCS => ERRCODE_SOURCE_NO_RESULTS,
-          Helpers::HarvestStatus::HARVEST_FAILURE => ERRCODE_SOURCE_HARVEST_ERROR,
-          Helpers::HarvestStatus::INGEST_ERR_INVALID_DOC => ERRCODE_DOCUMENT_INVALID,
-          Helpers::HarvestStatus::INGEST_ERR_SOLR_ERROR => ERRCODE_INGEST_ERROR,
-          Helpers::HarvestStatus::OTHER_ERROR => ERRCODE_OTHER
+        Helpers::HarvestStatus::HARVEST_NO_DOCS        => ERRCODE_SOURCE_NO_RESULTS,
+        Helpers::HarvestStatus::HARVEST_FAILURE        => ERRCODE_SOURCE_HARVEST_ERROR,
+        Helpers::HarvestStatus::INGEST_ERR_INVALID_DOC => ERRCODE_DOCUMENT_INVALID,
+        Helpers::HarvestStatus::INGEST_ERR_SOLR_ERROR  => ERRCODE_INGEST_ERROR,
+        Helpers::HarvestStatus::OTHER_ERROR            => ERRCODE_OTHER
       }.freeze
 
       # If code is -1, it means display all error codes
       def self.describe_exit_code(code = -1)
+        code_list = code_to_list(code)
+
+        codes = {}
+        code_list.each do |k|
+          next if code == -1 && !ERRCODE_DESC.keys.include?(k) # skip INVALID CODE if showing all codes
+
+          codes[k] = ERRCODE_DESC.keys.include?(k) ? ERRCODE_DESC[k] : 'INVALID CODE NUMBER'
+        end
+
+        codes
+      end
+
+      # Loop through all bit-flag values to produce a list of integers
+      def self.code_to_list(code)
         code = code.to_i
         code_list = []
 
-        # Loop through all bit-flag values
         [128, 64, 32, 16, 8, 4, 2, 1].each do |k|
           if code >= k || code == -1
             code_list.prepend k
             code -= k unless code == -1
           end
         end
 
-        codes = {}
-        code_list.each do |k|
-          next if code == -1 && !ERRCODE_DESC.keys.include?(k)  # skip INVALID CODE if showing all codes
-          codes[k] = ERRCODE_DESC.keys.include?(k) ? ERRCODE_DESC[k] : 'INVALID CODE NUMBER'
-        end
-
-        codes
+        code_list
       end
 
-      def initialize(status, message=nil)
+      def initialize(status, message = nil)
         @status_data = status
         @other_message = message
+
+        super message
       end
 
+      # rubocop:disable Metrics/AbcSize
       def exit_code
         if @status_data.nil?
           puts "OTHER ERROR REPORTED: #{@other_message}"
@@ -70,19 +82,20 @@ def exit_code
         code = 0
         code += ERRCODE_SOLR_PING unless @status_data.ping_solr
         code += ERRCODE_SOURCE_PING unless @status_data.ping_source
-        code += ERRCODE_SOURCE_NO_RESULTS if @status_data.status[Helpers::HarvestStatus::HARVEST_NO_DOCS] > 0
-        code += ERRCODE_SOURCE_HARVEST_ERROR if @status_data.status[Helpers::HarvestStatus::HARVEST_FAILURE] > 0
-        code += ERRCODE_DOCUMENT_INVALID if @status_data.status[Helpers::HarvestStatus::INGEST_ERR_INVALID_DOC] > 0
-        code += ERRCODE_INGEST_ERROR if @status_data.status[Helpers::HarvestStatus::INGEST_ERR_SOLR_ERROR] > 0
+        code += ERRCODE_SOURCE_NO_RESULTS if @status_data.status[Helpers::HarvestStatus::HARVEST_NO_DOCS].positive?
+        code += ERRCODE_SOURCE_HARVEST_ERROR if @status_data.status[Helpers::HarvestStatus::HARVEST_FAILURE].positive?
+        code += ERRCODE_DOCUMENT_INVALID if @status_data.status[Helpers::HarvestStatus::INGEST_ERR_INVALID_DOC].positive?
+        code += ERRCODE_INGEST_ERROR if @status_data.status[Helpers::HarvestStatus::INGEST_ERR_SOLR_ERROR].positive?
 
-        code = ERRCODE_OTHER if code == 0
+        code = ERRCODE_OTHER if code.zero?
 
         code
       end
+      # rubocop:enable Metrics/AbcSize
 
       def message
-        self.class.describe_exit_code(exit_code).map{|c,v| v}.join("\n")
+        self.class.describe_exit_code(exit_code).map { |_c, v| v }.join("\n")
       end
     end
   end
-end
+end

lib/search_solr_tools/harvesters/auto_suggest.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'base'
 require 'json'
 require 'rest-client'
@@ -6,8 +8,8 @@ module SearchSolrTools
   module Harvesters
     # Use the nsidc_oai core to populate the auto_suggest core
     class AutoSuggest < Base
-      def initialize(env = 'development', die_on_failure = false)
-        super env, die_on_failure
+      def initialize(env = 'development', die_on_failure: false)
+        super
         @env_settings = SolrEnvironments[@environment] # super sets @environment.
       end
 
@@ -50,7 +52,7 @@ def add_documents_to_solr(add_docs)
 
         if status == Helpers::HarvestStatus::INGEST_OK
           puts "Added #{add_docs.size} auto suggest documents in one commit"
-          return Helpers::HarvestStatus.new(Helpers::HarvestStatus::INGEST_OK => add_docs)
+          Helpers::HarvestStatus.new(Helpers::HarvestStatus::INGEST_OK => add_docs)
         else
           puts "Failed adding #{add_docs.size} documents in single commit, retrying one by one"
           new_add_docs = []