Contents

module Eco
  module API
    module Common
      module Loaders
        class Base
          extend Eco::API::Common::ClassHelpers
          include Eco::Language::AuxiliarLogger

          class << self
            # Sort order
            def <=>(other)
              created_at <=> other.created_at
            end

            # If still not set, it sets the `created_at` class timestamp.
            def set_created_at!
              @created_at = Time.now unless @created_at
            end

            # Class creation timestamp, to be able to load them in the order they were declared.
            def created_at
              @created_at ||= Time.now
            end
          end

          # This method will be called when the BaseLoader is created
          # @note
          #   - this method should implement the loading logics for the given `Children` class.
          def initialize
            raise "You should implement this method"
          end

          private

          def simulate?
            options.dig(:simulate) || options.dig(:dry_run)
          end
          alias_method :dry_run?, :simulate?

          def session
            @session ||= ASSETS.session
          end

          def options
            @options ||= {}
          end

          def config
            session.config
          end

          def micro
            session.micro
          end

          def abort(msg, raising: true)
            logger.error(msg)
            raise msg if raising
            exit 1
          end
        end
      end
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
eco-helpers-2.6.4	lib/eco/api/common/loaders/base.rb
eco-helpers-2.6.3	lib/eco/api/common/loaders/base.rb
eco-helpers-2.6.2	lib/eco/api/common/loaders/base.rb