smeditor 0.1.0 → 0.2.0

data/lib/generators/smeditor/install_generator.rb

@@ -5,47 +5,21 @@ require "rails/generators"
 module SMEditor
   module Generators
     class InstallGenerator < ::Rails::Generators::Base
-      # Thor вывел бы из имени класса namespace "sm_editor:install".
-      # Задаём явно, чтобы генератор звался `rails g smeditor:install`.
       namespace "smeditor:install"
+      desc "Install SMEditor Rails configuration"
 
-      desc "Install SMEditor Rails configuration and the editor boot script"
-
-      class_option :skip_javascript,
-                   type: :boolean,
-                   default: false,
-                   desc: "Do not copy smeditor.js into app/javascript"
-
-      # Two source roots: the generator templates, and the packaged boot
-      # script. Copying the shipped asset rather than a duplicate template
-      # keeps a single source of truth for the JavaScript.
-      def self.source_paths
-        [
-          File.expand_path("templates", __dir__),
-          File.expand_path("../../../app/assets/javascripts", __dir__),
-        ]
-      end
+      source_root File.expand_path("templates", __dir__)
 
       def copy_initializer
         template "initializer.rb", "config/initializers/smeditor.rb"
       end
 
-      # The boot script imports @smeditor/* by bare specifier, so it has to
-      # be compiled by the host app's JavaScript bundler. Sprockets and
-      # importmap cannot resolve those imports; jsbundling-rails (esbuild,
-      # rollup, webpack) or Vite can.
-      def copy_boot_script
-        copy_file "smeditor.js", "app/javascript/smeditor.js" unless options[:skip_javascript]
-      end
-
       def show_next_steps
         say ""
-        say "SMEditor installed. Next:"
-        say "  1. npm install @smeditor/react @smeditor/starter-kit \\"
-        say "                 @smeditor/full-kit @smeditor/theme-default react react-dom"
-        say "  2. Add `import \"./smeditor\"` to app/javascript/application.js"
-        say "  3. For uploads: set config.uploads = :active_storage and mount"
-        say "     `mount SMEditor::Rails::Engine => \"/smeditor\"` in config/routes.rb"
+        say "SMEditor installed. No npm packages or JavaScript bundler are required."
+        say "Use `form.smeditor_editor :content` in a form."
+        say "For uploads: set config.uploads = :active_storage and mount"
+        say "`SMEditor::Rails::Engine => \"/smeditor\"` in config/routes.rb."
         say ""
       end
     end

data/lib/generators/smeditor/templates/initializer.rb

@@ -7,6 +7,10 @@ SMEditor.configure do |config|
   # Used by the JavaScript adapter when uploads are enabled.
   config.upload_path = "/smeditor/uploads"
 
+  # Assets are shipped inside the gem and inserted automatically with the
+  # first editor field. Set false if you call `smeditor_assets` in your layout.
+  config.auto_include_assets = true
+
   # "starter" gives the MVP toolbar; "full" enables the larger extension set.
   config.default_kit = "starter"
 

data/lib/smeditor/rails/config.rb

@@ -20,6 +20,9 @@ module SMEditor
     attr_accessor :default_kit
     # Upload endpoint used by the JavaScript adapter when uploads are enabled.
     attr_accessor :upload_path
+    # Include the packaged JS/CSS automatically with the first editor field.
+    # Set false when the host app calls `smeditor_assets` in its layout.
+    attr_accessor :auto_include_assets
     # Hard ceiling on an uploaded file, in bytes. The endpoint is reachable
     # by anyone who can reach the host app unless the controller is
     # subclassed with authentication, so it refuses anything larger.
@@ -38,6 +41,7 @@ module SMEditor
       ]
       @default_kit = "starter"
       @upload_path = "/smeditor/uploads"
+      @auto_include_assets = true
       @max_upload_size = 10 * 1024 * 1024
       @allowed_upload_types = %w[
         image/png image/jpeg image/gif image/webp image/avif image/bmp

data/lib/smeditor/rails/engine.rb

@@ -1,42 +1,33 @@
 # frozen_string_literal: true
 
-# `rails/engine` не подтягивает core-расширения ActiveSupport сам. Вне
-# приложения (например, в rspec) гем грузится первым, и Rails::Initializable
-# падает на delegate_missing_to. `require "rails"` ставит их на место.
 require "rails"
 require "rails/engine"
 
 module SMEditor
   module Rails
-    # Rails::Engine subclass — the gem's plumbing.
-    #
-    # It does three things and nothing more (per PLAN.md the gem stays
-    # a thin adapter):
-    #   1. Isolates the SMEditor namespace so routes / controllers
-    #      don't collide with the host app.
-    #   2. Mixes the view helpers into ActionView.
-    #   3. Adds smeditor_editor to the form builder.
-    #
-    # The upload route lives in config/routes.rb and is mounted by the
-    # host with `mount SMEditor::Rails::Engine => "/smeditor"`.
+    # Self-contained Rails engine. The browser bundle and theme are packaged
+    # under app/assets, so consuming applications only need the Ruby gem.
     class Engine < ::Rails::Engine
       isolate_namespace SMEditor
 
-      # `isolate_namespace` выводит "sm_editor" из имени константы. Закрепляем
-      # "smeditor", чтобы прокси маршрутов у смонтированного движка назывался
-      # `smeditor.uploads_path`.
       engine_name "smeditor"
       railtie_name "smeditor"
 
-      # Zeitwerk по имени каталога `smeditor/` вывел бы константу `Smeditor`.
-      # Оба автозагрузчика узнают про `SMEditor` до сканирования autoload-путей —
-      # иначе `SMEditor::UploadsController` не найдётся.
       initializer "smeditor.inflections", before: :set_autoload_paths do
         ::Rails.autoloaders.each do |autoloader|
           autoloader.inflector.inflect("smeditor" => "SMEditor")
         end
       end
 
+      # Sprockets requires non-application assets to be explicitly precompiled.
+      # Propshaft discovers engine assets through the normal Rails asset paths,
+      # so this block intentionally runs only when config.assets is available.
+      initializer "smeditor.assets" do |app|
+        if app.config.respond_to?(:assets) && app.config.assets.respond_to?(:precompile)
+          app.config.assets.precompile += %w[smeditor.js smeditor.css]
+        end
+      end
+
       initializer "smeditor.view_helpers" do
         ActiveSupport.on_load(:action_view) do
           include SMEditor::Rails::FormHelper

data/lib/smeditor/rails/form_helper.rb

@@ -2,25 +2,34 @@
 
 module SMEditor
   module Rails
-    # View helper that mounts a SMEditor editor inside a Rails form.
-    #
-    #   <%= form.smeditor_editor :content %>      # via FormBuilder
-    #   <%= smeditor_editor(form, :content) %>    # standalone
-    #
-    # Emits a hidden field carrying the document HTML plus an empty
-    # mount point. The boot script (smeditor.js) finds the mount,
-    # attaches a real editor seeded from the hidden field, and writes
-    # editor.getHTML() back into that field on every change — so a
-    # normal form submit persists the content with no extra wiring.
+    # View helper that mounts a self-contained SMEditor inside a Rails form.
+    # The gem ships the browser bundle and default theme itself; host apps do
+    # not need npm, React, esbuild, importmap pins, or jsbundling-rails.
     module FormHelper
+      # Render the packaged JS/CSS once for this view context. This makes the
+      # form helper work without editing the host layout. Apps that prefer to
+      # include assets in <head> can call `smeditor_assets` there and disable
+      # auto inclusion with config.auto_include_assets = false.
+      def smeditor_assets
+        return "".html_safe if defined?(@_smeditor_assets_rendered) && @_smeditor_assets_rendered
+
+        @_smeditor_assets_rendered = true
+        safe_join([
+          stylesheet_link_tag("smeditor", "data-turbo-track": "reload"),
+          javascript_include_tag("smeditor", defer: true, "data-turbo-track": "reload"),
+        ])
+      end
+
       # form    - a Rails FormBuilder
       # method  - the model attribute (stored as an HTML string)
-      # options - :kit ("starter" | "full"), :class, :placeholder, :upload_url
+      # options - :kit ("starter" | "full"), :class, :placeholder,
+      #           :upload_url, :label, :include_assets
       def smeditor_editor(form, method, options = {})
         object = form.object
         current = object.respond_to?(method) ? object.public_send(method) : nil
         kit = (options[:kit] || SMEditor.config.default_kit).to_s
         upload_url = options.fetch(:upload_url, smeditor_upload_url)
+        include_assets = options.fetch(:include_assets, SMEditor.config.auto_include_assets)
 
         hidden = form.hidden_field(
           method,
@@ -37,24 +46,23 @@ module SMEditor
             smeditor_kit: kit,
             smeditor_placeholder: options[:placeholder],
             smeditor_upload_url: upload_url,
-          },
+            smeditor_label: options[:label],
+          }.compact,
         )
 
         wrapper_class = ["smeditor-field", options[:class]].compact.join(" ")
-        content_tag(:div, safe_join([hidden, mount]), class: wrapper_class)
+        field = content_tag(:div, safe_join([hidden, mount]), class: wrapper_class)
+
+        include_assets ? safe_join([smeditor_assets, field]) : field
       end
 
       private
 
       def smeditor_upload_url
-        if SMEditor.config.uploads == :active_storage
-          SMEditor.config.upload_path
-        end
+        SMEditor.config.upload_path if SMEditor.config.uploads == :active_storage
       end
     end
 
-    # Mixed into ActionView::Helpers::FormBuilder so `form.smeditor_editor`
-    # works alongside the standalone helper.
     module FormBuilderExtension
       def smeditor_editor(method, options = {})
         @template.smeditor_editor(self, method, options)

data/lib/smeditor/rails/version.rb

@@ -2,6 +2,6 @@
 
 module SMEditor
   module Rails
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smeditor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - SMEditor contributors
@@ -16,6 +16,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -23,6 +26,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -41,21 +47,21 @@ dependencies:
   name: rails-html-sanitizer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 description: |
-  Thin Rails adapter for SMEditor. Provides a form helper, a safe
-  server-side renderer, and an optional ActiveStorage-backed upload
-  endpoint. The editor itself is the upstream npm packages — this gem
-  never replaces or duplicates them.
+  Self-contained SMEditor integration for Rails. The gem ships the editor
+  core, starter/full extension kits, browser bundle, default theme, form
+  helper, safe renderer, and optional ActiveStorage upload endpoint. Host
+  applications do not need npm, React, esbuild, or jsbundling-rails.
 email:
 - sCruze@users.noreply.github.com
 executables: []
@@ -69,6 +75,7 @@ files:
 - LICENSE
 - README.md
 - app/assets/javascripts/smeditor.js
+- app/assets/stylesheets/smeditor.css
 - app/controllers/smeditor/uploads_controller.rb
 - config/routes.rb
 - lib/generators/smeditor/install_generator.rb
@@ -89,7 +96,7 @@ metadata:
   source_code_uri: https://github.com/sCruze/smeditor/tree/main/gems/smeditor
   changelog_uri: https://github.com/sCruze/smeditor/blob/main/gems/smeditor/CHANGELOG.md
   bug_tracker_uri: https://github.com/sCruze/smeditor/issues
-  documentation_uri: https://rubydoc.info/gems/smeditor/0.1.0
+  documentation_uri: https://rubydoc.info/gems/smeditor/0.2.0
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -107,5 +114,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.6
 specification_version: 4
-summary: Rails integration for the SMEditor rich text editor.
+summary: Self-contained SMEditor rich text editor for Rails.
 test_files: []