refactor: rename core to resources so that individual resource-s can be later broken out

Author: jim80net

lib/datadog_backup.rb

@@ -5,7 +5,7 @@
 require_relative 'datadog_backup/local_filesystem'
 require_relative 'datadog_backup/options'
 require_relative 'datadog_backup/cli'
-require_relative 'datadog_backup/core'
+require_relative 'datadog_backup/resources'
 require_relative 'datadog_backup/dashboards'
 require_relative 'datadog_backup/monitors'
 require_relative 'datadog_backup/synthetics'

lib/datadog_backup/dashboards.rb

@@ -2,7 +2,7 @@
 
 module DatadogBackup
   # Dashboards specific overrides for backup and restore.
-  class Dashboards < Core
+  class Dashboards < Resources
     def all
       get_all.fetch('dashboards')
     end

lib/datadog_backup/local_filesystem.rb

@@ -7,7 +7,7 @@
 
 module DatadogBackup
   ##
-  # Meant to be mixed into DatadogBackup::Core
+  # Meant to be mixed into DatadogBackup::Resources
   # Relies on @options[:backup_dir] and @options[:output_format]
   module LocalFilesystem
     def all_files

lib/datadog_backup/monitors.rb

@@ -2,7 +2,7 @@
 
 module DatadogBackup
   # Monitor specific overrides for backup and restore.
-  class Monitors < Core
+  class Monitors < Resources
     def all
       get_all
     end

lib/datadog_backup/core.rb renamed to lib/datadog_backup/resources.rb

@@ -8,7 +8,7 @@
 module DatadogBackup
   # The default options for backing up and restores.
   # This base class is meant to be extended by specific resources, such as Dashboards, Monitors, and so on.
-  class Core
+  class Resources
     include ::DatadogBackup::LocalFilesystem
     include ::DatadogBackup::Options
 

lib/datadog_backup/synthetics.rb

@@ -2,7 +2,7 @@
 
 module DatadogBackup
   # Synthetic specific overrides for backup and restore.
-  class Synthetics < Core
+  class Synthetics < Resources
     def all
       get_all.fetch('tests')
     end

lib/datadog_backup/thread_pool.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module DatadogBackup
-  # Used by CLI and Dashboards to size thread pool according to available CPU cores.
+  # Used by CLI and Dashboards to size thread pool according to available CPU resourcess.
   module ThreadPool
     TPOOL = ::Concurrent::ThreadPoolExecutor.new(
       min_threads: [2, Concurrent.processor_count].max,

spec/datadog_backup/core_spec.rb

@@ -2,28 +2,28 @@
 
 require 'spec_helper'
 
-describe DatadogBackup::Core do
+describe DatadogBackup::Resources do
   let(:stubs) { Faraday::Adapter::Test::Stubs.new }
   let(:api_client_double) { Faraday.new { |f| f.adapter :test, stubs } }
   let(:tempdir) { Dir.mktmpdir }
-  let(:core) do
-    core = described_class.new(
+  let(:resources) do
+    resources = described_class.new(
       action: 'backup',
       backup_dir: tempdir,
       diff_format: nil,
       resources: [],
       output_format: :json
     )
-    allow(core).to receive(:api_service).and_return(api_client_double)
-    return core
+    allow(resources).to receive(:api_service).and_return(api_client_double)
+    return resources
   end
 
   describe '#diff' do
-    subject(:diff) { core.diff('diff') }
+    subject(:diff) { resources.diff('diff') }
 
     before do
-      allow(core).to receive(:get_by_id).and_return({ 'text' => 'diff1', 'extra' => 'diff1' })
-      core.write_file('{"text": "diff2", "extra": "diff2"}', "#{tempdir}/core/diff.json")
+      allow(resources).to receive(:get_by_id).and_return({ 'text' => 'diff1', 'extra' => 'diff1' })
+      resources.write_file('{"text": "diff2", "extra": "diff2"}', "#{tempdir}/resources/diff.json")
     end
 
     it {
@@ -39,55 +39,55 @@
   end
 
   describe '#except' do
-    subject { core.except({ a: :b, b: :c }) }
+    subject { resources.except({ a: :b, b: :c }) }
 
     it { is_expected.to eq({ a: :b, b: :c }) }
   end
 
   describe '#initialize' do
-    subject(:mycore) { core }
+    subject(:myresources) { resources }
 
     it 'makes the subdirectories' do
       fileutils = class_double(FileUtils).as_stubbed_const
       allow(fileutils).to receive(:mkdir_p)
-      mycore
-      expect(fileutils).to have_received(:mkdir_p).with("#{tempdir}/core")
+      myresources
+      expect(fileutils).to have_received(:mkdir_p).with("#{tempdir}/resources")
     end
   end
 
   describe '#myclass' do
-    subject { core.myclass }
+    subject { resources.myclass }
 
-    it { is_expected.to eq 'core' }
+    it { is_expected.to eq 'resources' }
   end
 
   describe '#create' do
-    subject(:create) { core.create({ 'a' => 'b' }) }
+    subject(:create) { resources.create({ 'a' => 'b' }) }
 
     example 'it will post /api/v1/dashboard' do
-      allow(core).to receive(:api_version).and_return('v1')
-      allow(core).to receive(:api_resource_name).and_return('dashboard')
+      allow(resources).to receive(:api_version).and_return('v1')
+      allow(resources).to receive(:api_resource_name).and_return('dashboard')
       stubs.post('/api/v1/dashboard', { 'a' => 'b' }) {  respond_with200({ 'id' => 'whatever-id-abc' }) }
       create
       stubs.verify_stubbed_calls
     end
   end
 
   describe '#update' do
-    subject(:update) { core.update('abc-123-def', { 'a' => 'b' }) }
+    subject(:update) { resources.update('abc-123-def', { 'a' => 'b' }) }
 
     example 'it puts /api/v1/dashboard' do
-      allow(core).to receive(:api_version).and_return('v1')
-      allow(core).to receive(:api_resource_name).and_return('dashboard')
+      allow(resources).to receive(:api_version).and_return('v1')
+      allow(resources).to receive(:api_resource_name).and_return('dashboard')
       stubs.put('/api/v1/dashboard/abc-123-def', { 'a' => 'b' }) { respond_with200({ 'id' => 'whatever-id-abc' }) }
       update
       stubs.verify_stubbed_calls
     end
 
     context 'when the id is not found' do
       before do
-        allow(core).to receive(:api_version).and_return('v1')
-        allow(core).to receive(:api_resource_name).and_return('dashboard')
+        allow(resources).to receive(:api_version).and_return('v1')
+        allow(resources).to receive(:api_resource_name).and_return('dashboard')
         stubs.put('/api/v1/dashboard/abc-123-def', { 'a' => 'b' }) { [404, {}, { 'id' => 'whatever-id-abc' }] }
       end
 
@@ -99,52 +99,52 @@
 
   describe '#restore' do
     before do
-      allow(core).to receive(:api_version).and_return('api-version-string')
-      allow(core).to receive(:api_resource_name).and_return('api-resource-name-string')
+      allow(resources).to receive(:api_version).and_return('api-version-string')
+      allow(resources).to receive(:api_resource_name).and_return('api-resource-name-string')
       stubs.get('/api/api-version-string/api-resource-name-string/abc-123-def') { respond_with200({ 'test' => 'ok' }) }
       stubs.get('/api/api-version-string/api-resource-name-string/bad-123-id') do
         [404, {}, { 'error' => 'blahblah_not_found' }]
       end
-      allow(core).to receive(:load_from_file_by_id).and_return({ 'load' => 'ok' })
+      allow(resources).to receive(:load_from_file_by_id).and_return({ 'load' => 'ok' })
     end
 
     context 'when id exists' do
-      subject(:restore) { core.restore('abc-123-def') }
+      subject(:restore) { resources.restore('abc-123-def') }
 
       example 'it calls out to update' do
-        allow(core).to receive(:update)
+        allow(resources).to receive(:update)
         restore
-        expect(core).to have_received(:update).with('abc-123-def', { 'load' => 'ok' })
+        expect(resources).to have_received(:update).with('abc-123-def', { 'load' => 'ok' })
       end
     end
 
     context 'when id does not exist on remote' do
-      subject(:restore_newly) { core.restore('bad-123-id') }
+      subject(:restore_newly) { resources.restore('bad-123-id') }
 
       let(:fileutils) { class_double(FileUtils).as_stubbed_const }
 
       before do
-        allow(core).to receive(:load_from_file_by_id).and_return({ 'load' => 'ok' })
+        allow(resources).to receive(:load_from_file_by_id).and_return({ 'load' => 'ok' })
         stubs.put('/api/api-version-string/api-resource-name-string/bad-123-id') do
           [404, {}, { 'error' => 'id not found' }]
         end
         stubs.post('/api/api-version-string/api-resource-name-string', { 'load' => 'ok' }) do
           respond_with200({ 'id' => 'my-new-id' })
         end
         allow(fileutils).to receive(:rm)
-        allow(core).to receive(:create).with({ 'load' => 'ok' }).and_return({ 'id' => 'my-new-id' })
-        allow(core).to receive(:get_and_write_file)
-        allow(core).to receive(:find_file_by_id).with('bad-123-id').and_return('/path/to/bad-123-id.json')
+        allow(resources).to receive(:create).with({ 'load' => 'ok' }).and_return({ 'id' => 'my-new-id' })
+        allow(resources).to receive(:get_and_write_file)
+        allow(resources).to receive(:find_file_by_id).with('bad-123-id').and_return('/path/to/bad-123-id.json')
       end
 
       example 'it calls out to create' do
         restore_newly
-        expect(core).to have_received(:create).with({ 'load' => 'ok' })
+        expect(resources).to have_received(:create).with({ 'load' => 'ok' })
       end
 
       example 'it saves the new file' do
         restore_newly
-        expect(core).to have_received(:get_and_write_file).with('my-new-id')
+        expect(resources).to have_received(:get_and_write_file).with('my-new-id')
       end
 
       example 'it deletes the old file' do