databasium 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c8b3337e940bd7f5fbd9b5c7017fd0c5f54fba5c39bca36632ee289749c229db
+  data.tar.gz: c7476f1123cd0f7617a64a36f46542a9260a12938b421add487d3bbf5340c3bc
+SHA512:
+  metadata.gz: cdb17cf6669a8b896fb43d1671ab96feac30e653f212f3756a9f0e4165e574f2eb87febfde90a20ebc8047dc7c6511d1ba27281adf4d28f353fb9cb3d9fe3d15
+  data.tar.gz: d1a1ac46eb65b486570e841c02fc33734ff28a3c023e9eb54eba02d418c4e754343b7888ab765278953c99c2222347ab4d7f17e8f70c1548f87f272c4a86e4f8

data/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+
+## [0.1.0] - 2026-05-16
+
+First public release. Databasium is a development-only Rails engine for managing and exploring Rails databases from the browser.
+
+### Added
+
+- **Records** — browse tables, view rows, create and update records, bulk delete
+- **Migrations** — create migration files from the UI, run pending migrations, roll back individual migrations
+- **Models** — generate Active Record model files with attributes, associations, and validations
+- **Schema** — interactive entity-relationship diagram (ERD) synced from Active Record models
+- Rails engine mounted at `/databasium` with Phlex views, Hotwire (Turbo), and Stimulus controllers
+- Precompiled Tailwind CSS and importmap integration for engine assets
+- Homepage with links to each section
+
+### Security
+
+- Boot-time abort when the gem is loaded in production, to prevent accidental use outside development
+- Controller-level guard when routes are mounted outside development (renders a warning page)
+
+### Requirements
+
+- Ruby 3.2+
+- Rails 8.0.2+
+- Host app must use Active Record
+
+[0.1.0]: https://github.com/Unitato1/databasium/releases/tag/v0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Robert Svihla
+
+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,109 @@
+# Databasium
+
+Databasium is a Rails engine that gives you a browser UI for working with your database during local development. Browse and edit records, write and run migrations, generate Active Record models, and visualize your schema as an entity-relationship diagram (ERD).
+
+**Development only.** Databasium writes files under `db/migrate` and `app/models` and is not safe to expose publicly. Do not EVER use it in production. Databasium tries to guard this on its own so it might crash you app if you forget about it. Is should be easy to test locally, just run:
+
+```bash
+RAILS_ENV=production bin/rails s
+```
+
+## Requirements
+
+- Ruby 3.2+
+- Rails 8.0.2+
+- A Rails app with **Active Record** models
+- importmap-rails, turbo-rails, and stimulus-rails (installed automatically with the gem)
+- Databasium ships precompiled CSS and registers its own importmap pins.
+
+## Installation
+
+IMPORTANT: Add the gem to your **development** group only:
+
+```ruby
+# Gemfile
+group :development do
+  gem "databasium"
+end
+```
+
+Then install and mount the engine:
+
+```bash
+bundle install
+```
+
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  mount Databasium::Engine, at: "/databasium" if Rails.env.development?
+
+  # ...
+end
+```
+
+Visit [http://localhost:3000/databasium](http://localhost:3000/databasium) while running `bin/rails server` in development.
+
+The mount path is detected automatically from your routes. To override (optional):
+
+```ruby
+config.databasium.mount_path = "/admin/database"
+```
+
+Pending-migration blocking is skipped only under the Databasium mount so you can run migrations from the UI; the rest of your app still shows the normal Rails pending-migration page.
+
+### Production safety
+
+When `databasium` is in `group :development`, Bundler does not load it in production, so your app boots normally in production.
+
+If the gem is loaded in production (for example, added outside the development group), Databasium aborts on boot to prevent accidental use.
+
+## Features
+
+| Area           | Description                                               |
+| -------------- | --------------------------------------------------------- |
+| **Records**    | CRUD interface for table data                             |
+| **Migrations** | Create migration files, run pending migrations, roll back |
+| **Models**     | Generate Active Record model files from the UI            |
+| **Schema**     | ERD view synced from your models                          |
+
+Routes are mounted under `/databasium` (for example `/databasium/records`, `/databasium/migrations`)...
+
+## Developing the gem
+
+Clone the repository and install dependencies:
+
+```bash
+git clone https://github.com/Unitato1/databasium.git
+cd databasium
+bundle install
+```
+
+The engine is developed against the dummy app in `test/dummy`. Prepare its database:
+
+```bash
+./test/dummy/bin/rails db:migrate
+./test/dummy/bin/rails db:seed
+```
+
+Start the server from the gem root (this also watches and rebuilds Tailwind CSS):
+
+```bash
+bin/rails server
+```
+
+Open [http://127.0.0.1:3000/databasium](http://127.0.0.1:3000/databasium).
+
+## Status
+
+Version **0.1.0** is an early release. Automated test coverage is limited; treat the API and UI as subject to change.
+
+## Contributing
+
+I will be happy for any bug reports and pull requests.
+
+I am open for updating and working on any changes in the future if there would be interest.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+require "bundler/gem_tasks"