Module: MatViews

Defined in:
lib/mat_views.rb,
lib/tasks/helpers.rb,
lib/mat_views/engine.rb,
lib/mat_views/version.rb,
lib/mat_views/jobs/adapter.rb,
lib/mat_views/configuration.rb,
lib/mat_views/service_response.rb,
lib/mat_views/admin/auth_bridge.rb,
lib/mat_views/admin/default_auth.rb,
app/models/mat_views/mat_view_run.rb,
lib/mat_views/helpers/ui_test_ids.rb,
app/jobs/mat_views/application_job.rb,
app/jobs/mat_views/create_view_job.rb,
app/jobs/mat_views/delete_view_job.rb,
lib/mat_views/services/create_view.rb,
lib/mat_views/services/delete_view.rb,
app/jobs/mat_views/refresh_view_job.rb,
lib/mat_views/services/base_service.rb,
lib/mat_views/services/swap_refresh.rb,
app/helpers/mat_views/admin/ui_helper.rb,
lib/mat_views/services/regular_refresh.rb,
app/models/mat_views/application_record.rb,
app/models/mat_views/mat_view_definition.rb,
lib/mat_views/services/concurrent_refresh.rb,
lib/mat_views/services/check_matview_exists.rb,
app/controllers/mat_views/admin/runs_controller.rb,
lib/generators/mat_views/install/install_generator.rb,
app/controllers/mat_views/admin/dashboard_controller.rb,
app/controllers/mat_views/admin/application_controller.rb,
app/controllers/mat_views/admin/preferences_controller.rb,
app/controllers/mat_views/admin/mat_view_definitions_controller.rb

Overview

Copyright Codevedas Inc. 2025-present

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree.

Defined Under Namespace

Modules: Admin, Generators, Helpers, Jobs, Services, Tasks Classes: ApplicationJob, ApplicationRecord, Configuration, CreateViewJob, DeleteViewJob, Engine, MatViewDefinition, MatViewRun, RefreshViewJob, ServiceResponse

Constant Summary collapse

VERSION =

Defines the version of the MatViews gem.

This constant is used to track and publish gem releases. It follows [Semantic Versioning](semver.org/):

  • MAJOR: Incompatible API changes

  • MINOR: Backwards-compatible functionality

  • PATCH: Backwards-compatible bug fixes

Returns:

  • (String) —

    the current gem version

'0.3.0'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ MatViews::Configuration (readonly)

Global configuration for MatViews

Returns:



48
49
50
 
# File 'lib/mat_views.rb', line 48

def configuration
  @configuration
end

.importmap ⇒ Object

Returns the value of attribute importmap.



13
14
15
 
# File 'lib/mat_views/engine.rb', line 13

def importmap
  @importmap
end

Class Method Details

.configure {|configuration| ... } ⇒ Object

Configure MatViews via block.

Example:

MatViews.configure do |config|
  config.job_adapter = :sidekiq
  config.job_queue   = :materialised
end

Yields:



57
58
59
60
61
62
 
# File 'lib/mat_views.rb', line 57

def configure
  @configuration ||= Configuration.new
  yield(configuration)

  configuration.admin_ui[:row_count_strategy] ||= :none
end