Merge pull request #18 from nsidc/cop-fixes

juliacollins · juliacollins · commit d6982d0ca221 · 2016-05-18T14:38:00.000-06:00
Cop fixes
diff --git a/README.md b/README.md
@@ -93,11 +93,6 @@ one terminal window.
 
 RuboCop can be configured by modifying `.rubocop.yml`.
 
-Pushing with failing tests or RuboCop violations will cause the Jenkins build to
-break. Jenkins jobs to build and deploy this project are named
-"NSIDC_Search_SOLR_()…" and can be viewed under the
-[NSIDC Search tab](https://scm.nsidc.org/jenkins/view/NSIDC%20Search/).
-
 ### Testing
 
 Unit tests can be run with `rspec`, `bundle exec rake spec:unit`, or `bundle
@@ -114,7 +109,7 @@ Requirements:
 * [Bundler](http://bundler.io/)
 * [Gem Release](https://github.com/svenfuchs/gem-release)
 * [Rake](https://github.com/ruby/rake)
-* a [RubyGems](https://rubygems.org) account that has
+* A [RubyGems](https://rubygems.org) account that has
   [ownership](http://guides.rubygems.org/publishing/) of the gem
 * RuboCop and the unit tests should all pass (`rake`)
 
@@ -125,7 +120,7 @@ tagging, and publishing to RubyGems.
 |---------------------------|-------------|
 | `rake release:pre[false]` | Increase the current prerelease version number, push changes |
 | `rake release:pre[true]`  | Increase the current prerelease version number, publish release\* |
-| `rake release:none`       | Drop the prerelease version, publish release, then `pre[false]` |
+| `rake release:none`       | Drop the prerelease version, publish release, then `pre[false]` (does a patch release) |
 | `rake release:minor`      | Increase the minor version number, publish release, then `pre[false]` |
 | `rake release:major`      | Increase the major version number, publish release, then `pre[false]` |
 
diff --git a/bin/search_solr_tools b/bin/search_solr_tools
@@ -58,8 +58,7 @@ class SolrHarvestCLI < Thor
     harvester.delete_old_documents(options[:timestamp],
                                    "data_centers:\"#{SearchSolrTools::Helpers::SolrFormat::DATA_CENTER_NAMES[options[:data_center].upcase.to_sym][:long_name]}\"",
                                    SearchSolrTools::SolrEnvironments[harvester.environment][:collection_name],
-                                   true
-                                  )
+                                   true)
   end
 
   no_tasks do
@@ -90,7 +89,7 @@ class SolrHarvestCLI < Thor
 
     def get_harvester_class(data_center_name)
       name = data_center_name.downcase.to_s
-      fail("Invalid data center #{name}") unless harvester_map.key?(name)
+      raise("Invalid data center #{name}") unless harvester_map.key?(name)
 
       harvester_map[name]
     end
diff --git a/lib/search_solr_tools/harvesters/ade_auto_suggest.rb b/lib/search_solr_tools/harvesters/ade_auto_suggest.rb
@@ -3,7 +3,7 @@ module Harvesters
     class AdeAutoSuggest < AutoSuggest
       def harvest_and_delete
         puts 'Building auto-suggest indexes for ADE'
-        super(method(:harvest), "source:\"ADE\"", @env_settings[:auto_suggest_collection_name])
+        super(method(:harvest), 'source:"ADE"', @env_settings[:auto_suggest_collection_name])
       end
 
       def harvest
@@ -12,7 +12,8 @@ def harvest
       end
 
       def fields
-        { 'full_keywords_and_parameters' => { weight: 2, source: 'ADE', creator: method(:keyword_creator) },
+        {
+          'full_keywords_and_parameters' => { weight: 2, source: 'ADE', creator: method(:keyword_creator) },
           'full_authors' => { weight: 1, source: 'ADE', creator: method(:author_creator) }
         }
       end
diff --git a/lib/search_solr_tools/harvesters/base.rb b/lib/search_solr_tools/harvesters/base.rb
@@ -81,7 +81,7 @@ def insert_solr_docs(docs, content_type = XML_CONTENT_TYPE, core = SolrEnvironme
         end
         puts "#{success} document#{success == 1 ? '' : 's'} successfully added to Solr."
         puts "#{failure} document#{failure == 1 ? '' : 's'} not added to Solr."
-        fail 'Some documents failed to be inserted into Solr' if failure > 0
+        raise 'Some documents failed to be inserted into Solr' if failure > 0
       end
 
       def insert_solr_doc(doc, content_type = XML_CONTENT_TYPE, core = SolrEnvironments[@environment][:collection_name])
diff --git a/lib/search_solr_tools/harvesters/bcodmo.rb b/lib/search_solr_tools/harvesters/bcodmo.rb
@@ -18,7 +18,7 @@ def harvest_and_delete
       def harvest_bcodmo_into_solr
         result = translate_bcodmo
         insert_solr_docs result[:add_docs], Base::JSON_CONTENT_TYPE
-        fail 'Failed to harvest some records from the provider' if result[:failure_ids].length > 0
+        raise 'Failed to harvest some records from the provider' if result[:failure_ids].length > 0
       end
 
       def translate_bcodmo
diff --git a/lib/search_solr_tools/harvesters/eol.rb b/lib/search_solr_tools/harvesters/eol.rb
@@ -22,7 +22,7 @@ def harvest_eol_into_solr
             doc = open_xml_document(dataset)
             if doc.xpath('//xmlns:metadata').size > 1
               # THREDDS allows for a dataset of datasests, EOL should not utilize this
-              fail "Complex dataset encountered at #{doc.xpath('//xmlns:catalog').to_html}"
+              raise "Complex dataset encountered at #{doc.xpath('//xmlns:catalog').to_html}"
             end
             metadata_doc = open_xml_document(doc.xpath('//xmlns:metadata')[0]['xlink:href'])
             { 'add' => { 'doc' => @translator.translate(doc, metadata_doc) } }
diff --git a/lib/search_solr_tools/harvesters/gtnp.rb b/lib/search_solr_tools/harvesters/gtnp.rb
@@ -28,7 +28,7 @@ def harvest_and_delete
       def harvest_gtnp_into_solr
         result = translate_gtnp
         insert_solr_docs result[:add_docs], Base::JSON_CONTENT_TYPE
-        fail 'Failed to harvest some records from the provider' if result[:failure_ids].length > 0
+        raise 'Failed to harvest some records from the provider' if result[:failure_ids].length > 0
       end
 
       def translate_gtnp
diff --git a/lib/search_solr_tools/harvesters/ices.rb b/lib/search_solr_tools/harvesters/ices.rb
@@ -48,8 +48,7 @@ def build_csw_request(resultType = 'results', maxRecords = '25', startPosition =
                                                      'maxRecords' => maxRecords,
                                                      'startPosition' => startPosition,
                                                      'constraintLanguage' => 'CQL_TEXT',
-                                                     'outputSchema' => 'http://www.isotc211.org/2005/gmd'
-                                                    )
+                                                     'outputSchema' => 'http://www.isotc211.org/2005/gmd')
       end
     end
   end
diff --git a/lib/search_solr_tools/harvesters/ncdc_paleo.rb b/lib/search_solr_tools/harvesters/ncdc_paleo.rb
@@ -52,8 +52,7 @@ def build_csw_request(resultType = 'results', maxRecords = '1000', startPosition
         Helpers::CswIsoQueryBuilder.get_query_string(ncdc_paleo_url,
                                                      'resultType' => resultType,
                                                      'maxRecords' => maxRecords,
-                                                     'startPosition' => startPosition
-                                                    )
+                                                     'startPosition' => startPosition)
       end
     end
   end
diff --git a/lib/search_solr_tools/harvesters/nodc.rb b/lib/search_solr_tools/harvesters/nodc.rb
@@ -48,8 +48,7 @@ def build_csw_request(resultType = 'results', maxRecords = '25', startPosition =
                                                      'maxRecords' => maxRecords,
                                                      'startPosition' => startPosition,
                                                      'constraint' => bbox_constraint,
-                                                     'outputSchema' => 'http://www.isotc211.org/2005/gmd'
-                                                    )
+                                                     'outputSchema' => 'http://www.isotc211.org/2005/gmd')
       end
 
       def bbox_constraint
diff --git a/lib/search_solr_tools/harvesters/nsidc_auto_suggest.rb b/lib/search_solr_tools/harvesters/nsidc_auto_suggest.rb
@@ -3,7 +3,7 @@ module Harvesters
     class NsidcAutoSuggest < AutoSuggest
       def harvest_and_delete
         puts 'Building auto-suggest indexes for NSIDC'
-        super(method(:harvest), "source:\"NSIDC\"", @env_settings[:auto_suggest_collection_name])
+        super(method(:harvest), 'source:"NSIDC"', @env_settings[:auto_suggest_collection_name])
       end
 
       def harvest
@@ -12,7 +12,8 @@ def harvest
       end
 
       def fields
-        { 'authoritative_id' => { weight: 1, source: 'NSIDC', creator: method(:standard_add_creator) },
+        {
+          'authoritative_id' => { weight: 1, source: 'NSIDC', creator: method(:standard_add_creator) },
           'full_title' => { weight: 2, source: 'NSIDC', creator: method(:standard_add_creator) },
           'copy_parameters' => { weight: 5, source: 'NSIDC', creator: method(:standard_add_creator) },
           'full_platforms' => { weight: 2, source: 'NSIDC', creator: method(:short_full_split_add_creator) },
diff --git a/lib/search_solr_tools/harvesters/nsidc_json.rb b/lib/search_solr_tools/harvesters/nsidc_json.rb
@@ -23,7 +23,7 @@ def harvest_and_delete
       def harvest_nsidc_json_into_solr
         result = docs_with_translated_entries_from_nsidc
         insert_solr_docs result[:add_docs], Base::JSON_CONTENT_TYPE
-        fail 'Failed to harvest and insert some authoritative IDs' if result[:failure_ids].length > 0
+        raise 'Failed to harvest and insert some authoritative IDs' if result[:failure_ids].length > 0
       end
 
       def nsidc_json_url
diff --git a/lib/search_solr_tools/harvesters/oai.rb b/lib/search_solr_tools/harvesters/oai.rb
@@ -34,11 +34,11 @@ def harvest
       end
 
       def results
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def metadata_url
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def translated_docs(entries)
@@ -48,7 +48,7 @@ def translated_docs(entries)
       private
 
       def request_params
-        fail NotImplementedError
+        raise NotImplementedError
       end
 
       def request_string
diff --git a/lib/search_solr_tools/harvesters/usgs.rb b/lib/search_solr_tools/harvesters/usgs.rb
@@ -49,8 +49,7 @@ def build_csw_request(resultType = 'results', maxRecords = '25', startPosition =
                                                      'startPosition' => startPosition,
                                                      'TypeNames' => '',
                                                      'constraint' => bbox_constraint,
-                                                     'outputSchema' => 'http://www.isotc211.org/2005/gmd'
-                                                    )
+                                                     'outputSchema' => 'http://www.isotc211.org/2005/gmd')
       end
 
       def bbox_constraint
diff --git a/lib/search_solr_tools/helpers/iso_to_solr.rb b/lib/search_solr_tools/helpers/iso_to_solr.rb
@@ -83,7 +83,7 @@ def build_fields(xml, iso_xml_doc)
       end
 
       def strip_invalid_utf8_bytes(text)
-        if text.respond_to?(:encode) && (!text.valid_encoding?)
+        if text.respond_to?(:encode) && !text.valid_encoding?
           text.encode!('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '')
         end
 
diff --git a/lib/search_solr_tools/helpers/iso_to_solr_format.rb b/lib/search_solr_tools/helpers/iso_to_solr_format.rb
@@ -188,7 +188,7 @@ def self.get_bound(box_node, direction)
 
         return '' if vals.empty? || out_of_bounds
 
-        val = (-val.to_f) if %w(West South).include?(vals.last)
+        val = -val.to_f if %w(West South).include?(vals.last)
 
         val.to_f.to_s
       end
diff --git a/lib/search_solr_tools/helpers/solr_format.rb b/lib/search_solr_tools/helpers/solr_format.rb
@@ -134,7 +134,7 @@ def self.resolution_value(resolution, find_index_method, resolution_values)
           j = send(find_index_method, resolution['max_resolution'])
           return resolution_values[i..j]
         end
-        fail "Invalid resolution #{resolution['type']}"
+        raise "Invalid resolution #{resolution['type']}"
       end
 
       def self.resolution_not_specified?(resolution)
diff --git a/lib/search_solr_tools/translators/eol_to_solr.rb b/lib/search_solr_tools/translators/eol_to_solr.rb
@@ -62,9 +62,9 @@ def spatial_coverage_to_spatial_area(coverage)
       def parse_geospatial_coverages(doc)
         node = doc.xpath('//xmlns:geospatialCoverage')
         south = node.xpath('./xmlns:northsouth/xmlns:start').text.to_f
-        north = south + (node.xpath('./xmlns:northsouth/xmlns:size').text.to_f)
+        north = south + node.xpath('./xmlns:northsouth/xmlns:size').text.to_f
         west = node.xpath('./xmlns:eastwest/xmlns:start').text.to_f
-        east = west + (node.xpath('./xmlns:eastwest/xmlns:size').text.to_f)
+        east = west + node.xpath('./xmlns:eastwest/xmlns:size').text.to_f
         # EOL uses out-of-range east-west values to represent bounding boxes
         # that cross the date line.   For any box with a value out of range,
         # adjust the east/west value to lie within the -180 to 180 range.
diff --git a/lib/search_solr_tools/translators/nsidc_json.rb b/lib/search_solr_tools/translators/nsidc_json.rb
@@ -43,7 +43,7 @@ def translate(json_doc)
           'last_revision_date' => (Helpers::SolrFormat.date_str json_doc['lastRevisionDate']),
           'dataset_url' => json_doc['datasetUrl'],
           'distribution_formats' => json_doc['distributionFormats'],
-          'facet_format' => (json_doc['distributionFormats'].empty?) ? [Helpers::SolrFormat::NOT_SPECIFIED] : translate_format_to_facet_format(json_doc['distributionFormats']),
+          'facet_format' => json_doc['distributionFormats'].empty? ? [Helpers::SolrFormat::NOT_SPECIFIED] : translate_format_to_facet_format(json_doc['distributionFormats']),
           'source' => %w(NSIDC ADE),
           'popularity' => json_doc['popularity'],
           'data_access_urls' => translate_data_access_urls(json_doc['dataAccessLinks']),
diff --git a/spec/unit/harvesters/echo_harvester_spec.rb b/spec/unit/harvesters/echo_harvester_spec.rb
@@ -25,12 +25,11 @@
     it 'Issues a request to update Solr with data' do
       stub_request(:post, 'http://integration.search-solr.apps.int.nsidc.org:8983/solr/nsidc_oai/update?commit=true')
         .with(body: Nokogiri.XML('<add><foo></add>').to_xml,
-              headers: {
-                'Accept' => '*/*; q=0.5, application/xml',
-                'Accept-Encoding' => 'gzip, deflate',
-                'Content-Length' => '44',
-                'Content-Type' => 'text/xml; charset=utf-8',
-                'User-Agent' => 'Ruby' })
+              headers: { 'Accept'          => '*/*; q=0.5, application/xml',
+                         'Accept-Encoding' => 'gzip, deflate',
+                         'Content-Length'  => '44',
+                         'Content-Type'    => 'text/xml; charset=utf-8',
+                         'User-Agent'      => 'Ruby' })
         .to_return(status: 200, body: 'success', headers: {})
 
       expect(@harvester.insert_solr_doc(Nokogiri.XML('<add><foo></add>'))).to eql(true)
diff --git a/spec/unit/harvesters/eol_harvester_spec.rb b/spec/unit/harvesters/eol_harvester_spec.rb
@@ -12,13 +12,15 @@
         development: {}
       )
       allow_any_instance_of(described_class).to receive(:open_xml_document).and_return(
-        Nokogiri::XML(File.open(File.expand_path('../../fixtures/eol_thredds_project.xml', __FILE__))))
+        Nokogiri::XML(File.open(File.expand_path('../../fixtures/eol_thredds_project.xml', __FILE__)))
+      )
     end
 
     it 'Returns a list of dataset_urls' do
       expect(@harvester.eol_dataset_urls).to eql(
         ['http://data.eol.ucar.edu/jedi/catalog/ucar.ncar.eol.dataset.13_612.thredds.xml',
-         'http://data.eol.ucar.edu/jedi/catalog/ucar.ncar.eol.dataset.13_602.thredds.xml'])
+         'http://data.eol.ucar.edu/jedi/catalog/ucar.ncar.eol.dataset.13_602.thredds.xml']
+      )
     end
   end
 
diff --git a/spec/unit/harvesters/harvester_base_spec.rb b/spec/unit/harvesters/harvester_base_spec.rb
@@ -104,16 +104,15 @@ def described_method(request_url, metadata_path, content_type = 'application/xml
   it 'serializes a hash and adds it to solr in JSON format' do
     harvester = described_class.new 'integration'
     add_doc = { 'add' => { 'doc' => { 'authoritative_id' => 'TEST-0001' } } }
-    serialized_add_doc = "{\"add\":{\"doc\":{\"authoritative_id\":\"TEST-0001\"}}}"
+    serialized_add_doc = '{"add":{"doc":{"authoritative_id":"TEST-0001"}}}'
 
     stub_request(:post, 'http://integration.search-solr.apps.int.nsidc.org:8983/solr/nsidc_oai/update?commit=true')
       .with(body: serialized_add_doc,
-            headers: {
-              'Accept' => '*/*; q=0.5, application/xml',
-              'Accept-Encoding' => 'gzip, deflate',
-              'Content-Length' => '48',
-              'Content-Type' => described_class::JSON_CONTENT_TYPE,
-              'User-Agent' => 'Ruby' })
+            headers: { 'Accept'          => '*/*; q=0.5, application/xml',
+                       'Accept-Encoding' => 'gzip, deflate',
+                       'Content-Length'  => '48',
+                       'Content-Type'    => described_class::JSON_CONTENT_TYPE,
+                       'User-Agent'      => 'Ruby' })
       .to_return(status: 200, body: 'success', headers: {})
 
     expect(harvester.insert_solr_doc(add_doc, described_class::JSON_CONTENT_TYPE)).to eql(true)
@@ -124,12 +123,11 @@ def described_method(request_url, metadata_path, content_type = 'application/xml
     add_doc = Nokogiri.XML('<add><doc><field name="authoritative_id">TEST-0001</field></doc></add>')
     stub_request(:post, 'http://integration.search-solr.apps.int.nsidc.org:8983/solr/nsidc_oai/update?commit=true')
       .with(body: add_doc.to_xml,
-            headers: {
-              'Accept' => '*/*; q=0.5, application/xml',
-              'Accept-Encoding' => 'gzip, deflate',
-              'Content-Length' => '105',
-              'Content-Type' => described_class::XML_CONTENT_TYPE,
-              'User-Agent' => 'Ruby' })
+            headers: { 'Accept'          => '*/*; q=0.5, application/xml',
+                       'Accept-Encoding' => 'gzip, deflate',
+                       'Content-Length'  => '105',
+                       'Content-Type'    => described_class::XML_CONTENT_TYPE,
+                       'User-Agent'      => 'Ruby' })
       .to_return(status: 200, body: 'success', headers: {})
 
     expect(harvester.insert_solr_doc(add_doc)).to eql(true)
@@ -173,7 +171,8 @@ def described_method(request_url, metadata_path, content_type = 'application/xml
 
     it 'Can be forced to delete with a timestamp' do
       stubs = stub_update_and_delete(500, 75)
-      @harvester.delete_old_documents('20040202', "data_centers:\"test\"", SearchSolrTools::SolrEnvironments[@harvester.environment][:collection_name], true)
+      @harvester.delete_old_documents('20040202', 'data_centers:"test"', SearchSolrTools::SolrEnvironments[@harvester
+.environment][:collection_name], true)
 
       expect(stubs[:delete_stub]).to have_been_requested
       expect(stubs[:commit_stub]).to have_been_requested
diff --git a/spec/unit/harvesters/ncdc_paleo_spec.rb b/spec/unit/harvesters/ncdc_paleo_spec.rb
@@ -50,7 +50,8 @@ def described_method
     before(:each) do
       allow(described_object).to receive(:get_results).with(
         'http://gis.ncdc.noaa.gov/gptpaleo/csw?getxml={BA24F713-5035-4A21-8EEA-56C162517572}',
-        '/rdf:RDF/rdf:Description').and_return([entry_fixture])
+        '/rdf:RDF/rdf:Description'
+      ).and_return([entry_fixture])
     end
 
     check_values.each do |key, values|
@@ -77,7 +78,8 @@ def described_method
       harvester = described_class.new('dev', true)
       expect_any_instance_of(SearchSolrTools::Harvesters::Base).to receive(:get_results).with(
         'http://gis.ncdc.noaa.gov/gptpaleo/csw?service=CSW&version=2.0.2&request=GetRecords&TypeNames=gmd:MD_Metadata&ElementSetName=full&resultType=results&outputFormat=application/xml&maxRecords=50&startPosition=1',
-        '//csw:Record').and_return(true)
+        '//csw:Record'
+      ).and_return(true)
       harvester.get_results_from_ncdc_paleo_url(1)
     end
   end
diff --git a/spec/unit/harvesters/nodc_harvester_spec.rb b/spec/unit/harvesters/nodc_harvester_spec.rb
@@ -25,12 +25,11 @@
     it 'Issues a request to update Solr with data' do
       stub_request(:post, 'http://integration.search-solr.apps.int.nsidc.org:8983/solr/nsidc_oai/update?commit=true')
         .with(body: Nokogiri.XML('<add><foo></add>').to_xml,
-              headers: {
-                'Accept' => '*/*; q=0.5, application/xml',
-                'Accept-Encoding' => 'gzip, deflate',
-                'Content-Length' => '44',
-                'Content-Type' => 'text/xml; charset=utf-8',
-                'User-Agent' => 'Ruby' })
+              headers: { 'Accept'          => '*/*; q=0.5, application/xml',
+                         'Accept-Encoding' => 'gzip, deflate',
+                         'Content-Length'  => '44',
+                         'Content-Type'    => 'text/xml; charset=utf-8',
+                         'User-Agent'      => 'Ruby' })
         .to_return(status: 200, body: 'success', headers: {})
 
       expect(@harvester.insert_solr_doc(Nokogiri.XML('<add><foo></add>'))).to eql(true)
diff --git a/spec/unit/harvesters/tdar_harvester_spec.rb b/spec/unit/harvesters/tdar_harvester_spec.rb
@@ -27,12 +27,11 @@
     it 'Issues a request to update Solr with data' do
       stub_request(:post, 'http://integration.search-solr.apps.int.nsidc.org:8983/solr/nsidc_oai/update?commit=true')
         .with(body: Nokogiri.XML('<add><foo></add>').to_xml,
-              headers: {
-                'Accept' => '*/*; q=0.5, application/xml',
-                'Accept-Encoding' => 'gzip, deflate',
-                'Content-Length' => '44',
-                'Content-Type' => 'text/xml; charset=utf-8',
-                'User-Agent' => 'Ruby' })
+              headers: { 'Accept'          => '*/*; q=0.5, application/xml',
+                         'Accept-Encoding' => 'gzip, deflate',
+                         'Content-Length'  => '44',
+                         'Content-Type'    => 'text/xml; charset=utf-8',
+                         'User-Agent'      => 'Ruby' })
         .to_return(status: 200, body: 'success', headers: {})
 
       expect(@harvester.insert_solr_doc(Nokogiri.XML('<add><foo></add>'))).to eql(true)
diff --git a/spec/unit/harvesters/usgs_harvester_spec.rb b/spec/unit/harvesters/usgs_harvester_spec.rb
diff --git a/spec/unit/helpers/translate_spatial_coverage_spec.rb b/spec/unit/helpers/translate_spatial_coverage_spec.rb
diff --git a/spec/unit/solr_tools_spec.rb b/spec/unit/solr_tools_spec.rb
diff --git a/spec/unit/translators/eol_to_solr_spec.rb b/spec/unit/translators/eol_to_solr_spec.rb
diff --git a/spec/unit/translators/gtnp_json_to_solr_spec.rb b/spec/unit/translators/gtnp_json_to_solr_spec.rb
diff --git a/spec/unit/translators/nsidc_json_to_solr_spec.rb b/spec/unit/translators/nsidc_json_to_solr_spec.rb
