smeditor 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fa2dffff9ec8a5d1b502cbcba1c44420d778f0e5377db886812922fb9fd543c
-  data.tar.gz: f2892ee2d34a3b726d7e726acb5bca9de6a1973f18c8b06257dd425945f193a3
+  metadata.gz: bd12092236abeb99040e428490e6ef352721d4bb266b0a2933ca22a413350941
+  data.tar.gz: 8f3e32940dc8fdc7e37a26765d9925b8a0755319714a2d623ea1b8f8fd046091
 SHA512:
-  metadata.gz: 9a0923f3f4a6d7c51826a5e93e0853d3b9e452cbb46aa2a7027392a9fdfd9af6ed604a03e3224e6e4f86f10742f02b8dc0989441461890bd03842b388bcfa7a5
-  data.tar.gz: 8b4a6d29c7f033da64c91127d1a3a2a5b00f19607b60b10294972abff6137a7940a5464313231193cff23c83e516a971a3568a860e01c4555f0edfba915b6559
+  metadata.gz: 4fc1cb9a65be6f82544f1be230cb860fd0525df94a401b76921c2664e40a5e4587978cf9d3a2c0d011b230d0a9e7f1b89547cf38063d52ffb8614ef5ad7961b6
+  data.tar.gz: 4d72b4392ec27c3a13c46510da58a7266dbeeebaef74ef422c9ff7c2b15e7fff4ef499ad3d6cb839f9b31631b334d166af18c2e84f43ec5e22efc8609f4688a1

data/CHANGELOG.md

@@ -9,6 +9,29 @@ Cross-cutting product changes live in the repository root
 
 ## [Unreleased]
 
+### Changed
+
+- The Rails gem is now self-contained. It ships a precompiled browser bundle
+  containing SMEditor core, StarterKit and FullKit plus the default CSS theme.
+  Consuming Rails applications no longer need npm, React, esbuild, Vite,
+  importmap pins, or `jsbundling-rails`.
+- The Rails browser adapter mounts directly on `@smeditor/core`, removing React
+  from the gem runtime bundle while keeping the React package available for
+  normal npm consumers.
+- `smeditor:install` now creates only the initializer; it no longer copies a
+  host-app JavaScript entrypoint or prints npm installation steps.
+- `smeditor_editor` includes the packaged JS/CSS automatically once per view by
+  default. `config.auto_include_assets = false` + `smeditor_assets` provides an
+  explicit-layout mode.
+- The hidden input now emits bubbling `input` and `smeditor:change` events on editor
+  updates and exposes `smeditorInstance` for autosave/AI/DOCX integrations.
+- Turbo teardown is handled on `turbo:before-cache`.
+
+### Added
+
+- `scripts/build-gem-assets.mjs` creates the vendored browser JS and CSS from
+  the monorepo sources.
+
 ### Fixed
 
 - The boot script no longer imports `@smeditor/theme-default/index.css`, a
@@ -24,9 +47,6 @@ Cross-cutting product changes live in the repository root
 
 ### Added
 
-- `smeditor:install` copies the boot script into `app/javascript/smeditor.js`
-  so the host app's bundler resolves the `@smeditor/*` imports.
-  Pass `--skip-javascript` to opt out.
 - `config.max_upload_size` (10 MB default) and `config.allowed_upload_types`
   are enforced by the upload endpoint.
 - `LICENSE` and `CHANGELOG.md` ship in the gem; the internal `PLAN.md` no

data/README.md

@@ -1,21 +1,15 @@
 # smeditor
 
-Rails integration for the [SMEditor](https://github.com/sCruze/smeditor)
-rich-text editor.
+Self-contained Rails integration for [SMEditor](https://github.com/sCruze/smeditor).
 
-This gem is a **thin adapter**. The editor is the upstream npm
-packages (`@smeditor/react`, `@smeditor/starter-kit`, …); the gem
-adds a form helper, a safe server-side renderer, and an optional
-upload endpoint. It holds no schema, no commands and no rendering
-pipeline of its own.
+The gem ships the **editor core, StarterKit, FullKit, browser bundle and default
+CSS theme inside the gem itself**. A Rails application does not need npm,
+React, esbuild, Vite, importmap pins, or `jsbundling-rails` to use SMEditor.
 
 ## Requirements
 
-- Ruby >= 3.0, Rails >= 7.0
-- A JavaScript bundler in the host app — `jsbundling-rails` (esbuild,
-  rollup, webpack, bun) or Vite. The boot script imports the npm
-  packages by bare specifier, which Sprockets and importmap cannot
-  resolve on their own.
+- Ruby >= 3.0
+- Rails >= 7.0
 
 ## Install
 
@@ -29,113 +23,158 @@ bundle install
 bin/rails generate smeditor:install
 ```
 
-The generator writes `config/initializers/smeditor.rb` and copies the
-boot script to `app/javascript/smeditor.js`. Then install the editor
-itself and import the script:
+That is enough for normal editor usage. The generator only creates
+`config/initializers/smeditor.rb`; it does not copy JavaScript into the host
+application and does not ask you to install frontend packages.
 
-```bash
-npm install @smeditor/react @smeditor/starter-kit \
-            @smeditor/full-kit @smeditor/theme-default react react-dom
-```
-
-```js
-// app/javascript/application.js
-import "./smeditor";
-```
-
-Mount the engine if you want the upload endpoint:
+For ActiveStorage-backed image uploads, mount the engine:
 
 ```ruby
 # config/routes.rb
 mount SMEditor::Rails::Engine => "/smeditor"
 ```
 
-## Namespace
-
-Константа гема — `SMEditor` (не `Smeditor`). Каталоги называются `smeditor/`,
-поэтому движок сам регистрирует переопределение в обоих автозагрузчиках
-Zeitwerk (`smeditor` → `SMEditor`) до сканирования autoload-путей, а генератор
-объявляет namespace явно. Настроек в приложении не требуется, и глобальные
-inflections ActiveSupport не трогаются.
-
 ## Configure
 
 ```ruby
 # config/initializers/smeditor.rb
-SMEditor.configure do |c|
-  c.uploads             = :active_storage   # or :none (default)
-  c.sanitize_output     = true
-  c.default_kit         = "starter"         # or "full"
-  c.upload_path         = "/smeditor/uploads"
-  c.allowed_tags        = %w[p h1 h2 h3 strong em a img]
-  c.max_upload_size     = 10 * 1024 * 1024
-  c.allowed_upload_types = %w[image/png image/jpeg image/webp]
+SMEditor.configure do |config|
+  config.uploads = :none                 # or :active_storage
+  config.upload_path = "/smeditor/uploads"
+  config.default_kit = "starter"        # or "full"
+  config.sanitize_output = true
+
+  # true by default: the first editor field includes smeditor.js/css.
+  # Set false if you prefer calling `smeditor_assets` in your layout.
+  config.auto_include_assets = true
+
+  config.max_upload_size = 10 * 1024 * 1024
+  config.allowed_upload_types = %w[
+    image/png image/jpeg image/gif image/webp image/avif image/bmp
+  ]
 end
 ```
 
 ## Use
 
-The form helper mounts an editor and persists its HTML through a
-hidden field — a normal form submit saves the content:
-
 ```erb
 <%= form_with model: @article do |form| %>
-  <%= form.smeditor_editor :content %>
+  <%= form.smeditor_editor :content,
+        kit: "full",
+        placeholder: "Write…" %>
+
   <%= form.submit %>
 <% end %>
 ```
 
-Options: `:kit` (`"starter"` / `"full"`), `:placeholder`, `:class`,
-`:upload_url`.
+The helper renders a hidden Rails field plus the editor mount. The packaged
+browser bundle updates the hidden field on every editor change, including a
+normal bubbling `input` event and a `smeditor:change` custom event, so form submit and autosave code can
+observe the value without CKEditor-specific integration.
 
-Display saved content on a public page — always sanitized:
+Available options:
+
+- `kit: "starter" | "full"`
+- `placeholder:`
+- `class:`
+- `label:` — editor ARIA label
+- `upload_url:` — custom image upload endpoint
+- `include_assets: false` — skip automatic asset tags for this field
+
+### Assets in the layout (optional)
+
+By default the first `smeditor_editor` call includes the packaged assets once.
+If you prefer explicit layout assets:
+
+```ruby
+# config/initializers/smeditor.rb
+SMEditor.configure { |config| config.auto_include_assets = false }
+```
 
 ```erb
-<%= smeditor_render(@article.content) %>
+<head>
+  <%= smeditor_assets %>
+</head>
 ```
 
-## How it works
+The files still come from the gem; this only changes where the tags are
+rendered.
 
-`smeditor_editor` renders a hidden field (seeded with the stored
-HTML) and an empty mount point. The boot script finds each mount,
-attaches a real editor from the npm packages, and writes
-`editor.getHTML()` back into the hidden field on every change. The
-model attribute is a plain HTML string — SMEditor's transport format —
-so no special column type or serializer is needed.
+## Programmatic access
 
-Booting runs on `DOMContentLoaded`, on `turbo:load` and on
-`turbo:frame-load`; each mount is booted at most once.
+After boot, the editor instance is available on both the hidden input and the
+mount element:
 
-## Rendering and trust
+```js
+const input = document.querySelector("[data-smeditor-input]")
+const editor = input.smeditorInstance
 
-Stored editor HTML is treated as untrusted input. `smeditor_render`
-passes it through `SMEditor::Rails::Sanitizer`, which applies the tag
-allow-list, strips unsafe URLs and `style` declarations, and adds
-`rel="noopener noreferrer"` to `target="_blank"` links.
+editor.getHTML()
+editor.setContent("<p>New content</p>")
+editor.commands.toggleBold?.()
+```
+
+The bundle also exposes `window.SMEditor.boot()` and
+`window.SMEditor.destroy()` for advanced integrations.
+
+## Turbo
+
+SMEditor boots on `DOMContentLoaded`, `turbo:load`, and `turbo:frame-load`.
+Before Turbo caches a page, editor instances are destroyed and their mounts are
+reset, preventing stale contenteditable state after navigation.
+
+## Rendering saved content
+
+```erb
+<%= smeditor_render(@article.content) %>
+```
 
-Setting `config.sanitize_output = false` marks stored content
-`html_safe` without sanitizing it. Only do that when the content is
-already trusted upstream.
+Stored editor HTML is treated as untrusted input. `smeditor_render` sanitizes
+allowed tags, URLs and inline formatting and hardens `_blank` links by default.
+
+Set `config.sanitize_output = false` only if the stored HTML is already trusted.
 
 ## Uploads
 
 With `config.uploads = :active_storage`, the engine exposes
-`POST /smeditor/uploads`. It stores image files via ActiveStorage and
-responds with `{ src, alt, title }` for the editor to embed.
+`POST /smeditor/uploads`. It stores the image through ActiveStorage and returns
+`{ src, alt, title }` to the editor.
+
+The default upload endpoint is unauthenticated. It enforces the configured file
+size and MIME allow-list, but public applications should add their own
+authorization policy.
+
+## What the gem contains
 
-The endpoint is **unauthenticated by default** and only enforces the
-content-type allow-list and `max_upload_size`. Subclass
-`SMEditor::UploadsController` and add your own authorization before
-exposing it to the public internet.
+The published `.gem` includes:
 
-With `:none`, no endpoint is mounted — wire your own.
+- SMEditor browser bundle (core + StarterKit + FullKit)
+- default SMEditor theme
+- Rails form helper and FormBuilder extension
+- safe renderer/sanitizer
+- optional ActiveStorage upload endpoint
+- install generator
+
+The source monorepo still uses TypeScript/pnpm to develop and rebuild the
+frontend packages. Those are **build-time tools for SMEditor maintainers only**;
+they are not runtime dependencies of applications that install the gem.
 
 ## Development
 
+Rebuild the vendored Rails assets after changing core/extensions or the Rails
+browser adapter:
+
+```bash
+node scripts/build-gem-assets.mjs
+```
+
+Then test/build the gem:
+
 ```bash
 cd gems/smeditor
 bundle install
 bundle exec rspec
+gem build smeditor.gemspec
 ```
 
 ## License