smriti 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b61c4232f0786ee6491d8bdaaf802ec9736465e492816afcf0b94e14c38301b
+  data.tar.gz: 789a21799a501a393f5b89c870717770592adf6a54c66b79a80c9abc253e73de
+SHA512:
+  metadata.gz: ced5a07863c0ad29bf2c6c80f97f8b826dcbdbc5d4927a8c393c7c7200affaf5599f6a98bdf2791323261a35683c4a933835fddca9452acff05f1032f00ecb11
+  data.tar.gz: 6d245a12638e631a2d6e9bc9af26301b7e1f2691299223cedb76f0f2a58037111d9858ccebf322e5eb83c52832c32412533ca8245c85e1460d593a334a6a0f1a

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 The smriti Authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,168 @@
+# smriti (engine)
+
+[![Gem](https://img.shields.io/gem/v/smriti.svg?style=flat-square)](https://rubygems.org/gems/smriti)
+[![CI](https://github.com/Code-Vedas/smriti/actions/workflows/ci.yml/badge.svg)](https://github.com/Code-Vedas/smriti/actions/workflows/ci.yml)
+![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)
+
+Rails engine that manages **PostgreSQL materialized views** with definitions, services, background jobs, and Rake tasks.
+
+---
+
+## Quickstart (diagram)
+
+```mermaid
+flowchart LR
+  A[Define MatViewDefinition] --> B[Create]
+  B --> C[Unique Index for CONCURRENT]
+  C --> D[Refresh: regular or concurrent or swap]
+  D --> E[Read MV]
+  D --> F[Track runs]
+```
+
+---
+
+## Install
+
+```bash
+bundle add smriti
+bin/rails g smriti:install
+bin/rails db:migrate
+```
+
+```ruby
+# config/initializers/smriti.rb
+Smriti.configure do |c|
+  c.job_queue = :default
+end
+```
+
+---
+
+## Define a view
+
+```ruby
+defn = Smriti::MatViewDefinition.create!(
+  name: 'mv_user_activity',
+  sql: <<~SQL,
+    SELECT u.id AS user_id,
+           COUNT(a.*) AS accounts_count,
+           COUNT(e.*) AS events_count,
+           COUNT(s.*) AS sessions_count
+    FROM users u
+    LEFT JOIN accounts a ON a.user_id = u.id
+    LEFT JOIN events   e ON e.user_id = u.id
+    LEFT JOIN sessions s ON s.user_id = u.id
+    GROUP BY u.id
+  SQL
+  refresh_strategy: :concurrent,
+  unique_index_columns: ['user_id']
+)
+```
+
+---
+
+## Services & Jobs
+
+```ruby
+# Create
+Smriti::Services::CreateView.new(defn, force: true).call
+Smriti::CreateViewJob.perform_later(defn.id, force: true)
+
+# Refresh
+Smriti::Services::RegularRefresh.new(defn, row_count_strategy: :estimated).call
+Smriti::RefreshViewJob.perform_later(defn.id, row_count_strategy: :exact)
+
+# Delete
+ Smriti::Services::DeleteView.new(defn, cascade: false).call
+Smriti::DeleteViewJob.perform_later(defn.id, cascade: true)
+```
+
+**Uniform response**: `status`, `meta`, `success?` / `error?`.
+
+---
+
+## Enqueue adapter
+
+```ruby
+Smriti::Jobs::Adapter.enqueue(job_class, queue: :default, args: [...])
+```
+
+- Uses your configured backend; **no guessing**.
+- Supports **ActiveJob**, **Sidekiq**, **Resque**.
+
+---
+
+## Rake tasks
+
+```bash
+# Create
+bundle exec rake smriti:create_by_name\[VIEW_NAME,force,row_count_strategy,--yes]
+bundle exec rake smriti:create_by_id\[ID,force,row_count_strategy,--yes]
+bundle exec rake smriti:create_all\[force,row_count_strategy,--yes]
+
+# Refresh
+bundle exec rake smriti:refresh_by_name\[VIEW_NAME,row_count_strategy,--yes]
+bundle exec rake smriti:refresh_by_id\[ID,row_count_strategy,--yes]
+bundle exec rake smriti:refresh_all\[row_count_strategy,--yes]
+
+# Delete
+bundle exec rake smriti:delete_by_name\[VIEW_NAME,cascade,row_count_strategy,--yes]
+bundle exec rake smriti:delete_by_id\[ID,cascade,row_count_strategy,--yes]
+bundle exec rake smriti:delete_all\[cascade,row_count_strategy,--yes]
+```
+
+---
+
+## Rails version matrix
+
+Use the pinned Gemfiles in `gemfiles/` to exercise the engine against specific Rails releases:
+
+```bash
+# Rails 7.2.x
+bundle install --gemfile gemfiles/rails_7_2.gemfile
+BUNDLE_GEMFILE=gemfiles/rails_7_2.gemfile bundle exec bin/rspec-unit
+BUNDLE_GEMFILE=gemfiles/rails_7_2.gemfile bundle exec bin/rspec-e2e
+
+# Rails 8.0.x
+bundle install --gemfile gemfiles/rails_8_0.gemfile
+BUNDLE_GEMFILE=gemfiles/rails_8_0.gemfile bundle exec bin/rspec-unit
+BUNDLE_GEMFILE=gemfiles/rails_8_0.gemfile bundle exec bin/rspec-e2e
+
+# Rails 8.1.x
+bundle install --gemfile gemfiles/rails_8_1.gemfile
+BUNDLE_GEMFILE=gemfiles/rails_8_1.gemfile bundle exec bin/rspec-unit
+BUNDLE_GEMFILE=gemfiles/rails_8_1.gemfile bundle exec bin/rspec-e2e
+
+# Rails main branch
+bundle install --gemfile gemfiles/rails_edge.gemfile
+BUNDLE_GEMFILE=gemfiles/rails_edge.gemfile bundle exec bin/rspec-unit
+BUNDLE_GEMFILE=gemfiles/rails_edge.gemfile bundle exec bin/rspec-e2e
+```
+
+The CI workflow consumes the same Gemfiles to run the unit suite across the compatibility matrix.
+
+---
+
+## Screenshots
+
+The end-to-end tests generate screenshots for visual verification. They are uploaded as artifacts in the GitHub Actions workflow runs.
+After creating a pull request, apply the `e2e-screenshots` label to trigger screenshot generation.
+
+You can trigger screenshot in your local setup as well:
+
+```bash
+# 'en' is the desired locale
+SCREENSHOT_LANG=en bin/rspec-app-screenshot
+
+# OR
+
+# runs for all configured locales (this may take long time)
+bin/rspec-app-screenshots
+```
+
+## Docs & policies
+
+- Root README: [../README.md](../README.md)
+- **Contributing:** [../CONTRIBUTING.md](../CONTRIBUTING.md)
+- **Security policy:** [../SECURITY.md](../SECURITY.md)
+- **Code of Conduct:** [../CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT.md)

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# 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.
+
+require 'bundler/setup'
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/assets/images/smriti/favicon.svg

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="128" height="128" viewBox="0 0 256 256" fill="none"
+  xmlns="http://www.w3.org/2000/svg" role="img" aria-labelledby="title desc">
+  <title id="title">Smriti Monogram</title>
+  <desc id="desc">Stylized M and V mark for Materialized Views. Transparent background.</desc>
+
+  <!-- subtle outer ring -->
+  <circle cx="128" cy="128" r="110" stroke="#0F172A" stroke-opacity="0.18" stroke-width="10" fill="none"/>
+
+  <!-- V (accent) -->
+  <path d="M64 64 L128 192 L192 64" stroke="#10B981" stroke-width="20" stroke-linecap="round" stroke-linejoin="round"/>
+
+  <!-- M (primary) -->
+  <path d="M48 176 L92 80 L128 144 L164 80 L208 176" stroke="#0F172A" stroke-width="20" stroke-linecap="round" stroke-linejoin="round"/>
+
+  <!-- optional tiny dot to balance negative space -->
+  <circle cx="128" cy="208" r="4" fill="#10B981" fill-opacity="0.9"/>
+</svg>

data/app/assets/images/smriti/logo.svg

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="128" height="128" viewBox="0 0 256 256" fill="none"
+  xmlns="http://www.w3.org/2000/svg" role="img" aria-labelledby="title desc">
+  <title id="title">Smriti Monogram</title>
+  <desc id="desc">Stylized M and V mark for Materialized Views. Transparent background.</desc>
+
+  <!-- subtle outer ring -->
+  <circle cx="128" cy="128" r="110" stroke="#0F172A" stroke-opacity="0.18" stroke-width="10" fill="none"/>
+
+  <!-- V (accent) -->
+  <path d="M64 64 L128 192 L192 64" stroke="#10B981" stroke-width="20" stroke-linecap="round" stroke-linejoin="round"/>
+
+  <!-- M (primary) -->
+  <path d="M48 176 L92 80 L128 144 L164 80 L208 176" stroke="#0F172A" stroke-width="20" stroke-linecap="round" stroke-linejoin="round"/>
+
+  <!-- optional tiny dot to balance negative space -->
+  <circle cx="128" cy="208" r="4" fill="#10B981" fill-opacity="0.9"/>
+</svg>

data/app/assets/images/smriti/mask-icon.svg

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg viewBox="0 0 256 256" xmlns="http://www.w3.org/2000/svg" fill="none">
+  <path d="M64 64 L128 192 L192 64" stroke="currentColor" stroke-width="28" stroke-linecap="round" stroke-linejoin="round"/>
+  <path d="M48 176 L92 80 L128 144 L164 80 L208 176" stroke="currentColor" stroke-width="28" stroke-linecap="round" stroke-linejoin="round"/>
+</svg>