stimulus_grid_rails 0.1.0

data/lib/stimulus_grid_rails/version.rb

@@ -0,0 +1,3 @@
+module StimulusGridRails
+  VERSION = "0.1.0"
+end

data/lib/stimulus_grid_rails.rb

@@ -0,0 +1,79 @@
+require "stimulus_grid_rails/version"
+require "stimulus_grid_rails/engine"
+require "stimulus_grid_rails/column"
+require "stimulus_grid_rails/grid"
+require "stimulus_grid_rails/turbo_streams_helper"
+require "stimulus_grid_rails/concerns/broadcastable"
+
+module StimulusGridRails
+  class << self
+    # Base class for the gem's controllers. Set to your authenticated base
+    # controller so Devise (authenticate_user!) and ActsAsTenant
+    # (set_current_tenant_through_filter) before_actions apply to the grid's
+    # cell/row endpoints too — otherwise they'd run unauthenticated and
+    # unscoped, leaking across tenants.
+    #
+    #   StimulusGridRails.parent_controller = "ApplicationController"  # default
+    attr_writer :parent_controller
+
+    def parent_controller
+      @parent_controller ||= "ApplicationController"
+    end
+
+    # Where the engine is mounted. The grid's client-side endpoints are built
+    # from this, so it must match how you mount the engine:
+    #
+    #   # config/initializers/stimulus_grid_rails.rb
+    #   StimulusGridRails.mount_path = "/admin/grids"
+    #
+    #   # config/routes.rb
+    #   mount StimulusGridRails::Engine => StimulusGridRails.mount_path
+    #
+    # Using the same value in both places keeps the browser requests and the
+    # routes in sync regardless of namespace/scope. Default "/grids".
+    def mount_path
+      @mount_path || "/grids"
+    end
+
+    def mount_path=(path)
+      @mount_path = path.to_s.sub(%r{/+\z}, "")   # strip trailing slash(es)
+    end
+  end
+
+  # Per-process registry of ApplicationGrid subclasses, keyed by `resource`.
+  # Populated lazily when a Grid subclass is instantiated, so the cells
+  # controller can resolve `/grids/:resource/...` back to the right Grid class.
+  def self.registry
+    @registry ||= {}
+  end
+
+  def self.register_grid(resource, klass)
+    registry[resource.to_s] = klass
+  end
+
+  def self.lookup_grid(resource)
+    registry[resource.to_s] or
+      raise ArgumentError, "No grid registered for resource #{resource.inspect}. " \
+                           "Did you define a Grid subclass and reference it from a view?"
+  end
+
+  # Tenant-isolation token for stream names (RAILS.md §2). When the app uses
+  # ActsAsTenant and a tenant is set, this returns a per-tenant token so a
+  # broadcast for one tenant can never reach another tenant's subscribers,
+  # even when grids share a logical stream name. Returns nil when not
+  # multi-tenant. Both the broadcaster (model callback) and the subscriber
+  # (turbo_stream_from in the view) run in the same request/tenant context, so
+  # they derive the same token and match.
+  def self.tenant_stream_token
+    return nil unless defined?(ActsAsTenant) && ActsAsTenant.respond_to?(:current_tenant)
+    tenant = ActsAsTenant.current_tenant
+    tenant ? "sgr-tenant:#{tenant.class.name}:#{tenant.id}" : nil
+  end
+
+  # The streamables a grid's broadcasts + subscription share. Tenant-scoped
+  # automatically. Pass extra view-scoping tokens (e.g. a signed view name)
+  # as needed.
+  def self.streamables_for(resource, *extra)
+    [tenant_stream_token, "sgr-grid:#{resource}", *extra].compact
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: stimulus_grid_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcus Schappi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: stimulus-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: importmap-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Brings the stimulus_grid data-grid into Rails as a first-class engine.
+  Provides ApplicationGrid for declaring columns server-side; cell-grained Turbo Stream
+  actions (cell, cell-confirm, cell-revert, row-insert-sorted, row-remove, bulk);
+  a single PATCH endpoint for cell mutations with optimistic-id reconciliation; and
+  importmap-pinnable JS for both the grid and the live-sync layer.
+email:
+- marcus@schappi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/stimulus_grid.js
+- app/assets/javascripts/stimulus_grid_rails.js
+- app/assets/stylesheets/stimulus_grid.css
+- app/assets/stylesheets/stimulus_grid_rails.css
+- app/controllers/stimulus_grid_rails/base_controller.rb
+- app/controllers/stimulus_grid_rails/cells_controller.rb
+- app/controllers/stimulus_grid_rails/history_controller.rb
+- app/controllers/stimulus_grid_rails/rows_controller.rb
+- app/models/stimulus_grid_rails/audit.rb
+- app/views/stimulus_grid_rails/grids/_grid.html.erb
+- app/views/stimulus_grid_rails/grids/_row.html.erb
+- config/importmap.rb
+- config/routes.rb
+- db/migrate/20260520000001_create_stimulus_grid_audits.rb
+- lib/stimulus_grid_rails.rb
+- lib/stimulus_grid_rails/column.rb
+- lib/stimulus_grid_rails/concerns/broadcastable.rb
+- lib/stimulus_grid_rails/engine.rb
+- lib/stimulus_grid_rails/grid.rb
+- lib/stimulus_grid_rails/turbo_streams_helper.rb
+- lib/stimulus_grid_rails/version.rb
+homepage: https://github.com/schappim/stimulus_grid
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/schappim/stimulus_grid
+  source_code_uri: https://github.com/schappim/stimulus_grid
+  changelog_uri: https://github.com/schappim/stimulus_grid/blob/main/gem/stimulus_grid_rails/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Rails + Hotwire bindings for stimulus_grid — server-side column registry,
+  custom Turbo Stream actions, optimistic cell updates.
+test_files: []