inventory_refresh 0.3.6 → 1.0.0

data/lib/inventory_refresh/target_collection.rb

@@ -0,0 +1,92 @@
+require "active_support/core_ext/module/delegation"
+
+module InventoryRefresh
+  class TargetCollection
+    attr_reader :targets
+
+    delegate :<<, :to => :targets
+
+    # @param manager [ManageIQ::Providers::BaseManager] manager owning the TargetCollection
+    # @param manager_id [Integer] primary key of manager owning the TargetCollection
+    # @param event [EmsEvent] EmsEvent associated with the TargetCollection
+    # @param targets [Array<InventoryRefresh::Target, ApplicationRecord>] Array of InventoryRefresh::Target objects or
+    #                ApplicationRecord objects
+    def initialize(manager: nil, manager_id: nil, event: nil, targets: [])
+      @manager    = manager
+      @manager_id = manager_id
+      @event      = event
+      @targets    = targets
+    end
+
+    # @param association [Symbol] An existing association on Manager, that lists objects represented by a Target, naming
+    #                             should be the same of association of a counterpart InventoryCollection object
+    # @param manager_ref [Hash] A Hash that can be used to find_by on a given association and returning a unique object.
+    #                           The keys should be the same as the keys of the counterpart InventoryObject
+    # @param manager [ManageIQ::Providers::BaseManager] The Manager owning the Target
+    # @param manager_id [Integer] A primary key of the Manager owning the Target
+    # @param event_id [Integer] A primary key of the EmsEvent associated with the Target
+    # @param options [Hash] A free form options hash
+    def add_target(association:, manager_ref:, manager: nil, manager_id: nil, event_id: nil, options: {})
+      self << InventoryRefresh::Target.new(:association => association,
+                                           :manager_ref => manager_ref,
+                                           :manager     => manager || @manager,
+                                           :manager_id  => manager_id || @manager_id || @manager.try(:id),
+                                           :event_id    => event_id || @event.try(:id),
+                                           :options     => options)
+    end
+
+    # @return [String] A String containing a summary
+    def name
+      "Collection of #{targets.size} targets"
+    end
+
+    # @return [String] A String containing an id of each target in the TargetCollection
+    def id
+      "Collection of targets with id: #{targets.collect(&:name)}"
+    end
+
+    # Returns targets in a format:
+    #   {
+    #     :vms => {:ems_ref => Set.new(["vm_ref_1", "vm_ref2"])},
+    #     :network_ports => {:ems_ref => Set.new(["network_port_1", "network_port2"])
+    #   }
+    #
+    # Then we can quickly access all objects affected by:
+    #   NetworkPort.where(target_collection.manager_refs_by_association[:network_ports].to_a) =>
+    #     return AR objects with ems_refs ["network_port_1", "network_port2"]
+    # And we can get a list of ids for the API query by:
+    #   target_collection.manager_refs_by_association[:network_ports][:ems_ref].to_a =>
+    #     ["network_port_1", "network_port2"]
+    #
+    # Only targets of a type InventoryRefresh::Target are processed, any other targets present should be converted to
+    # InventoryRefresh::Target, e.g. in the Inventory::Collector code.
+    def manager_refs_by_association
+      @manager_refs_by_association ||= targets.select { |x| x.kind_of?(InventoryRefresh::Target) }.each_with_object({}) do |x, obj|
+        if obj[x.association].blank?
+          obj[x.association] = x.manager_ref.each_with_object({}) { |(key, value), hash| hash[key] = Set.new([value]) }
+        else
+          obj[x.association].each do |key, value|
+            value << x.manager_ref[key]
+          end
+        end
+      end
+    end
+
+    # Resets the cached @manager_refs_by_association to enforce reload when calling :manager_refs_by_association method
+    def manager_refs_by_association_reset
+      @manager_refs_by_association = nil
+    end
+
+    # Returns list of ems_refs
+    # @return [Array<String>]
+    def references(collection)
+      manager_refs_by_association.try(:[], collection).try(:[], :ems_ref)&.to_a || []
+    end
+
+    # Returns list of names
+    # @return [Array<String>]
+    def name_references(collection)
+      manager_refs_by_association.try(:[], collection).try(:[], :name)&.to_a || []
+    end
+  end
+end

data/lib/inventory_refresh/version.rb

@@ -1,3 +1,3 @@
 module InventoryRefresh
-  VERSION = "0.3.6".freeze
+  VERSION = "1.0.0".freeze
 end

data/lib/inventory_refresh.rb

@@ -6,4 +6,6 @@ require "inventory_refresh/logging"
 require "inventory_refresh/null_logger"
 require "inventory_refresh/persister"
 require "inventory_refresh/save_inventory"
+require "inventory_refresh/target"
+require "inventory_refresh/target_collection"
 require "inventory_refresh/version"

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: inventory_refresh
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 1.0.0
 platform: ruby
 authors:
 - ManageIQ Developers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-14 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: more_core_extensions
   requirement: !ruby/object:Gem::Requirement
@@ -101,75 +107,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.11.1
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: manageiq-style
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.21.2
 description: Topological Inventory Persister
 email: 
 executables: []
@@ -178,13 +170,14 @@ extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
 - ".github/CODEOWNERS"
+- ".github/workflows/ci.yaml"
 - ".gitignore"
 - ".rspec"
 - ".rspec_ci"
 - ".rubocop.yml"
 - ".rubocop_cc.yml"
 - ".rubocop_local.yml"
-- ".travis.yml"
+- ".whitesource"
 - ".yamllint"
 - CHANGELOG.md
 - Gemfile
@@ -199,7 +192,6 @@ files:
 - lib/inventory_refresh.rb
 - lib/inventory_refresh/application_record_iterator.rb
 - lib/inventory_refresh/application_record_reference.rb
-- lib/inventory_refresh/exception.rb
 - lib/inventory_refresh/graph.rb
 - lib/inventory_refresh/graph/topological_sort.rb
 - lib/inventory_refresh/inventory_collection.rb
@@ -227,7 +219,9 @@ files:
 - lib/inventory_refresh/persister.rb
 - lib/inventory_refresh/save_collection/base.rb
 - lib/inventory_refresh/save_collection/saver/base.rb
+- lib/inventory_refresh/save_collection/saver/batch.rb
 - lib/inventory_refresh/save_collection/saver/concurrent_safe_batch.rb
+- lib/inventory_refresh/save_collection/saver/default.rb
 - lib/inventory_refresh/save_collection/saver/partial_upsert_helper.rb
 - lib/inventory_refresh/save_collection/saver/retention_helper.rb
 - lib/inventory_refresh/save_collection/saver/sql_helper.rb
@@ -236,11 +230,14 @@ files:
 - lib/inventory_refresh/save_collection/sweeper.rb
 - lib/inventory_refresh/save_collection/topological_sort.rb
 - lib/inventory_refresh/save_inventory.rb
+- lib/inventory_refresh/target.rb
+- lib/inventory_refresh/target_collection.rb
 - lib/inventory_refresh/version.rb
 homepage: https://github.com/ManageIQ/inventory_refresh
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -256,7 +253,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Topological Inventory Persister

data/.travis.yml

@@ -1,23 +0,0 @@
-dist: xenial
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-- 2.5.7
-- 2.6.5
-addons:
-  postgresql: '10'
-env:
-  global:
-  - CC_TEST_REPORTER_ID=1ef1a3a3d007395b11083d634a6fdac1e3d979b6428c39d2cd8d58556cdd68f7
-before_install:
-- gem install bundler -v 2.0.1
-- psql -c "CREATE USER root SUPERUSER PASSWORD 'smartvm';" -U postgres
-before_script:
-- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64
-  > ./cc-test-reporter
-- chmod +x ./cc-test-reporter
-- "./cc-test-reporter before-build"
-- bundle exec rake spec:setup
-after_script:
-- "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"

data/lib/inventory_refresh/exception.rb

@@ -1,8 +0,0 @@
-module InventoryRefresh
-  module Exception
-    class SweeperError < StandardError; end
-    class SweeperNonExistentScopeKeyFoundError < SweeperError; end
-    class SweeperNonUniformScopeKeyFoundError < SweeperError; end
-    class SweeperScopeBadFormat < SweeperError; end
-  end
-end