gitlab-cloud-connector 0.3.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba0e1c9f5b77ddd68494a8c03334925cfb64dc37e18837c6ffdfa23fee41f12d
-  data.tar.gz: e184009e5f0df3176aec7361424d9d3d35c7f6217293205f2cac7cfde939f25e
+  metadata.gz: 4d3a9c6cb24eae104dda40308b879b159d1e1583da6c39292dc864b3f9306746
+  data.tar.gz: 474c1fa8efc2fb0480818d74ac587152aa3ab907a5c340e3d5de7524c95fb3e2
 SHA512:
-  metadata.gz: 3720195985967cd355d03f72be3522a67a33fa4c2907245c612a85f33fb358ab363282efb0b6dd56695659e4adfb3ec01ae8d9dac1c5cc47121ef44433b29908
-  data.tar.gz: 66d62a4f3764a7be75c3c0ea64c8fdc5ff2903cfd267b6a9386ce2927495151054856438040f22bbb557c99229b80fd160879cbcd807c5588312e0a02e94f5ca
+  metadata.gz: f502784866d6d67fdbccbf262591ccc14d0a96fd44c6e38ab0de5273e224ce85258e0e504ded2d90f8d00b6f7a48662afae650a3dc8afe6de39ad8adcba37b26
+  data.tar.gz: ce85d65412bf2722bc68c5dcc2c8f16fa5da8c80147abef96c606dce03367aaaf053396671cf88281530aba9cce406440ef6b4ce11ce35a0379e3966c989edd9

data/README.md

@@ -7,11 +7,9 @@ Ruby gem containing shared code for Cloud Connector token issuers (GitLab, Custo
 We expect Bundler is used to manage dependencies. To add the dependency, add it to `Gemfile`:
 
 ```Gemfile
-gem "gitlab-cloud-connector", "~> 0.1.1", require: 'cloud_connector'
+gem "gitlab-cloud-connector", "~> 1.0.0", require: 'gitlab/cloud_connector'
 ```
 
-## Usage
-
 ### Data Storage
 
 Cloud Connector uses YAML files stored in the project's `/config` directory. The data is organized by model type:
@@ -41,7 +39,7 @@ add_ons:
 `DataModels` are the core data structures in the Cloud Connector. Each model inherits from `DataModel::Base`. The data is loaded from YAML files into memory at runtime, making it efficient for read operations and relationship traversal.
 
 ```ruby
-require 'cloud_connector'
+require 'gitlab/cloud_connector'
 
 # Find unit primitive by name
 # Note:  value should be a symbol (e.g., `:duo_chat` instead of `'duo_chat'`).

data/config/unit_primitives/categorize_duo_chat_question.yml

@@ -1,6 +1,6 @@
 ---
 name: categorize_duo_chat_question
-description: This should not be an unit primitive
+description: This should not be an unit primitive.
 cut_off_date: 2024-10-17T00:00:00+00:00
 group: group::project management
 feature_category: team_planning

data/lib/gitlab/cloud_connector/configuration.rb

@@ -1,21 +1,48 @@
 # frozen_string_literal: true
 
+require_relative 'data_model/yaml_data_loader'
+require_relative 'data_model/abstract_data_loader'
+
 module Gitlab
   module CloudConnector
     module Configuration
+      DEFAULT_DATA_LOADER_CLASS = Gitlab::CloudConnector::DataModel::YamlDataLoader
+      INVALID_LOADER_MESSAGE = "Data loader must inherit from Gitlab::CloudConnector::DataModel::AbstractDataLoader"
+
+      InvalidDataLoaderError = Class.new(StandardError)
+
       class << self
-        attr_writer :config_dir
+        attr_writer :config_dir, :memoize_data
 
         def config_dir
           @config_dir ||= File.expand_path("../../../config", __dir__).freeze
         end
 
+        def data_loader_class
+          @data_loader_class ||= DEFAULT_DATA_LOADER_CLASS
+        end
+
+        def data_loader_class=(klass)
+          validate_data_loader!(klass)
+          @data_loader_class = klass
+        end
+
+        def memoize_data?
+          return @memoize_data unless @memoize_data.nil?
+
+          (data_loader_class == DEFAULT_DATA_LOADER_CLASS)
+        end
+
         def configure
           yield self if block_given?
         end
 
-        def reset!
-          @config_dir = nil
+        private
+
+        def validate_data_loader!(klass)
+          return if klass && klass < Gitlab::CloudConnector::DataModel::AbstractDataLoader
+
+          raise InvalidDataLoaderError, INVALID_LOADER_MESSAGE
         end
       end
     end

data/lib/gitlab/cloud_connector/data_model/abstract_data_loader.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module CloudConnector
+    module DataModel
+      class AbstractDataLoader
+        def initialize(model_class)
+          @model_class = model_class
+        end
+
+        def load!
+          raise NotImplementedError, "#{self.class} must implement #load!"
+        end
+
+        protected
+
+        attr_reader :model_class
+      end
+    end
+  end
+end

data/lib/gitlab/cloud_connector/data_model/base.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative 'associations'
-require_relative 'data_loader'
 
 module Gitlab
   module CloudConnector
@@ -24,13 +23,17 @@ module Gitlab
           end
 
           def all
-            @all ||= data_loader.load!
+            if Configuration.memoize_data?
+              @all ||= data_loader.load!
+            else
+              data_loader.load!
+            end
           end
 
           private
 
           def data_loader
-            @data_loader ||= DataLoader.new(self)
+            Configuration.data_loader_class.new(self)
           end
         end
 
@@ -43,6 +46,13 @@ module Gitlab
         def [](name)
           instance_variable_get(:"@#{name}")
         end
+
+        def to_hash
+          instance_variables.each_with_object({}) do |var, hash|
+            key = var.to_s.delete('@').to_sym
+            hash[key] = instance_variable_get(var)
+          end
+        end
       end
     end
   end

data/lib/gitlab/cloud_connector/data_model/yaml_data_loader.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require_relative 'abstract_data_loader'
+
+module Gitlab
+  module CloudConnector
+    module DataModel
+      class YamlDataLoader < AbstractDataLoader
+        def load!
+          Dir.glob(data_files_path).map { |file| load_model_from_file(file) }
+        end
+
+        private
+
+        def data_files_path
+          File.join(CloudConnector::Configuration.config_dir, model_class.model_name.tableize, '*.yml')
+        end
+
+        def load_model_from_file(file_path)
+          data = YAML.safe_load(
+            File.read(file_path),
+            permitted_classes: [Time],
+            symbolize_names: true
+          ).deep_symbolize_keys!
+
+          model_class.new(**data)
+        rescue StandardError => e
+          raise "Error loading file #{file_path}: #{e.message}"
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/cloud_connector/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module CloudConnector
-    VERSION = '0.3.0'
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-cloud-connector
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Nikola Milojevic
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-31 00:00:00.000000000 Z
+date: 2025-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -160,12 +160,14 @@ files:
 - config/unit_primitives/summarize_review.yml
 - config/unit_primitives/troubleshoot_job.yml
 - config/unit_primitives/write_tests.yml
-- lib/cloud_connector.rb
+- lib/gitlab/cloud_connector.rb
 - lib/gitlab/cloud_connector/available_services_generator.rb
 - lib/gitlab/cloud_connector/configuration.rb
+- lib/gitlab/cloud_connector/data_model/abstract_data_loader.rb
 - lib/gitlab/cloud_connector/data_model/associations.rb
 - lib/gitlab/cloud_connector/data_model/base.rb
 - lib/gitlab/cloud_connector/data_model/data_loader.rb
+- lib/gitlab/cloud_connector/data_model/yaml_data_loader.rb
 - lib/gitlab/cloud_connector/data_models.rb
 - lib/gitlab/cloud_connector/json_web_token.rb
 - lib/gitlab/cloud_connector/version.rb