railspress-engine 0.1.2 → 1.2.0

data/db/migrate/20241218000005_create_railspress_imports.rb

@@ -0,0 +1,21 @@
+class CreateRailspressImports < ActiveRecord::Migration[7.1]
+  def change
+    create_table :railspress_imports do |t|
+      t.string :import_type, null: false
+      t.string :filename
+      t.string :content_type
+      t.string :status, default: "pending", null: false
+      t.integer :total_count, default: 0
+      t.integer :success_count, default: 0
+      t.integer :error_count, default: 0
+      t.text :error_messages
+      t.bigint :user_id
+
+      t.timestamps
+    end
+
+    add_index :railspress_imports, :import_type
+    add_index :railspress_imports, :status
+    add_index :railspress_imports, :user_id
+  end
+end

data/db/migrate/20241218000006_create_railspress_exports.rb

@@ -0,0 +1,20 @@
+class CreateRailspressExports < ActiveRecord::Migration[7.1]
+  def change
+    create_table :railspress_exports do |t|
+      t.string :export_type, null: false
+      t.string :filename
+      t.string :status, default: "pending", null: false
+      t.integer :total_count, default: 0
+      t.integer :success_count, default: 0
+      t.integer :error_count, default: 0
+      t.text :error_messages
+      t.bigint :user_id
+
+      t.timestamps
+    end
+
+    add_index :railspress_exports, :export_type
+    add_index :railspress_exports, :status
+    add_index :railspress_exports, :user_id
+  end
+end

data/db/migrate/20241218000007_create_railspress_taggings.rb

@@ -0,0 +1,20 @@
+class CreateRailspressTaggings < ActiveRecord::Migration[8.0]
+  def change
+    create_table :railspress_taggings do |t|
+      t.references :tag, null: false, foreign_key: { to_table: :railspress_tags }
+      t.references :taggable, polymorphic: true, null: false
+      t.timestamps
+    end
+
+    # Unique constraint: one tag per taggable
+    add_index :railspress_taggings,
+              [ :tag_id, :taggable_type, :taggable_id ],
+              unique: true,
+              name: "index_taggings_unique"
+
+    # For "find all entities with tag X" queries
+    add_index :railspress_taggings,
+              [ :taggable_type, :taggable_id ],
+              name: "index_taggings_on_taggable"
+  end
+end

data/db/migrate/20241218000008_drop_railspress_post_tags.rb

@@ -0,0 +1,14 @@
+class DropRailspressPostTags < ActiveRecord::Migration[8.0]
+  def up
+    drop_table :railspress_post_tags
+  end
+
+  def down
+    create_table :railspress_post_tags do |t|
+      t.references :post, null: false, foreign_key: { to_table: :railspress_posts }
+      t.references :tag, null: false, foreign_key: { to_table: :railspress_tags }
+      t.timestamps
+    end
+    add_index :railspress_post_tags, [ :post_id, :tag_id ], unique: true
+  end
+end

data/db/migrate/20241218000010_add_reading_time_to_railspress_posts.rb

@@ -0,0 +1,5 @@
+class AddReadingTimeToRailspressPosts < ActiveRecord::Migration[8.0]
+  def change
+    add_column :railspress_posts, :reading_time, :integer
+  end
+end

data/db/migrate/20250105000002_create_railspress_focal_points.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class CreateRailspressFocalPoints < ActiveRecord::Migration[8.0]
+  def change
+    create_table :railspress_focal_points do |t|
+      t.references :record, polymorphic: true, null: false, index: false
+      t.string :attachment_name, null: false
+      t.decimal :focal_x, precision: 5, scale: 4, default: 0.5, null: false
+      t.decimal :focal_y, precision: 5, scale: 4, default: 0.5, null: false
+      t.json :overrides, default: {}
+
+      t.timestamps
+    end
+
+    add_index :railspress_focal_points,
+              [ :record_type, :record_id, :attachment_name ],
+              unique: true,
+              name: "idx_focal_points_record_attachment"
+  end
+end

data/db/migrate/20260206000001_create_railspress_content_groups.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class CreateRailspressContentGroups < ActiveRecord::Migration[8.0]
+  def change
+    create_table :railspress_content_groups do |t|
+      t.string :name, null: false
+      t.text :description
+      t.bigint :author_id
+      t.datetime :deleted_at
+
+      t.timestamps
+    end
+
+    add_index :railspress_content_groups, :name, unique: true
+    add_index :railspress_content_groups, :deleted_at
+    add_index :railspress_content_groups, :author_id
+  end
+end

data/db/migrate/20260206000002_create_railspress_content_elements.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class CreateRailspressContentElements < ActiveRecord::Migration[8.0]
+  def change
+    create_table :railspress_content_elements do |t|
+      t.string :name, null: false
+      t.integer :content_type, default: 0, null: false
+      t.text :text_content
+      t.references :content_group, null: false, foreign_key: { to_table: :railspress_content_groups }
+      t.bigint :author_id
+      t.integer :position
+      t.datetime :deleted_at
+
+      t.timestamps
+    end
+
+    add_index :railspress_content_elements, :deleted_at
+    add_index :railspress_content_elements, :author_id
+    add_index :railspress_content_elements, :content_type
+  end
+end

data/db/migrate/20260206000003_create_railspress_content_element_versions.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class CreateRailspressContentElementVersions < ActiveRecord::Migration[8.0]
+  def change
+    create_table :railspress_content_element_versions do |t|
+      t.references :content_element, null: false, foreign_key: { to_table: :railspress_content_elements }
+      t.bigint :author_id
+      t.text :text_content
+      t.integer :version_number, null: false
+
+      t.timestamps
+    end
+
+    add_index :railspress_content_element_versions,
+              [ :content_element_id, :version_number ],
+              unique: true,
+              name: "idx_content_element_versions_unique"
+    add_index :railspress_content_element_versions, :author_id
+  end
+end

data/db/migrate/20260207000001_add_unique_index_to_content_elements.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class AddUniqueIndexToContentElements < ActiveRecord::Migration[8.1]
+  def change
+    add_index :railspress_content_elements,
+              [ :content_group_id, :name ],
+              unique: true,
+              where: "deleted_at IS NULL",
+              name: "idx_content_elements_unique_name_per_group"
+  end
+end

data/db/migrate/20260211112812_add_image_hint_to_railspress_content_elements.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class AddImageHintToRailspressContentElements < ActiveRecord::Migration[8.1]
+  def change
+    add_column :railspress_content_elements, :image_hint, :string
+  end
+end

data/db/migrate/20260211154040_add_required_to_railspress_content_elements.rb

@@ -0,0 +1,5 @@
+class AddRequiredToRailspressContentElements < ActiveRecord::Migration[8.1]
+  def change
+    add_column :railspress_content_elements, :required, :boolean, default: false, null: false
+  end
+end

data/lib/generators/railspress/entity/entity_generator.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/active_record"
+
+module Railspress
+  module Generators
+    class EntityGenerator < Rails::Generators::NamedBase
+      include ActiveRecord::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+      desc "Generate a RailsPress-managed entity with model, migration, and registration"
+
+      def create_model_file
+        template "model.rb.tt", File.join("app/models", "#{file_name}.rb")
+      end
+
+      def create_migration
+        migration_template "migration.rb.tt", File.join(db_migrate_path, "create_#{table_name}.rb")
+      end
+
+      def add_registration
+        initializer_file = "config/initializers/railspress.rb"
+
+        unless File.exist?(initializer_file)
+          create_file initializer_file, <<~RUBY
+            # frozen_string_literal: true
+
+            Railspress.configure do |config|
+              # Register your CMS-managed entities here
+              # config.register_entity Project
+            end
+          RUBY
+          say_status :created, "RailsPress initializer", :green
+        end
+
+        inject_into_file initializer_file, after: "Railspress.configure do |config|\n" do
+          "  config.register_entity #{class_name}\n"
+        end
+
+        say_status :registered, "#{class_name} entity", :green
+      end
+
+      def show_next_steps
+        say ""
+        say "=" * 60, :green
+        say "  Entity #{class_name} created!", :green
+        say "=" * 60, :green
+        say ""
+        say "Next steps:", :yellow
+        say ""
+        say "  1. Run the migration:"
+        say "     $ rails db:migrate", :cyan
+        say ""
+        say "  2. Restart your Rails server"
+        say ""
+        say "  3. Access #{class_name} in the admin:"
+        say "     /railspress/admin/entities/#{table_name}", :cyan
+        say ""
+        say "=" * 60, :green
+      end
+
+      private
+
+      def db_migrate_path
+        "db/migrate"
+      end
+
+      def rich_text_fields
+        attributes.select { |a| a.type == :rich_text }
+      end
+
+      def regular_attributes
+        attributes.reject { |a| a.type == :rich_text }
+      end
+
+      def railspress_field_names
+        attributes.map { |a| ":#{a.name}" }.join(", ")
+      end
+
+      def migration_version
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+      end
+    end
+  end
+end

data/lib/generators/railspress/entity/templates/migration.rb.tt

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class Create<%= class_name.pluralize %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :<%= table_name %> do |t|
+<% regular_attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/railspress/entity/templates/model.rb.tt

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class <%= class_name %> < ApplicationRecord
+  include Railspress::Entity
+<% rich_text_fields.each do |attribute| -%>
+
+  has_rich_text :<%= attribute.name %>
+<% end -%>
+
+  # Declare which fields appear in the CMS admin
+  railspress_fields <%= railspress_field_names %>
+<% rich_text_fields.each do |attribute| -%>
+  railspress_fields :<%= attribute.name %>, as: :rich_text
+<% end -%>
+
+  # Optional: customize sidebar label (defaults to pluralized class name)
+  # railspress_label "Custom Label"
+
+  # Add your validations
+  # validates :title, presence: true
+end

data/lib/generators/railspress/install/install_generator.rb

@@ -10,6 +10,10 @@ module Railspress
 
       desc "Install RailsPress: copy migrations, mount engine, and configure JavaScript"
 
+      def detect_install_mode
+        @upgrading_existing_install = existing_railspress_installation?
+      end
+
       def copy_railspress_migrations
         run "bundle exec rake railspress:install:migrations"
       end
@@ -59,61 +63,58 @@ module Railspress
           say_status :pinned, "@rails/activestorage in importmap", :green
         end
 
-        # Pin Lexxy editor
-        if importmap_content.include?('"lexxy"')
-          say_status :skip, "Lexxy already pinned in importmap", :yellow
-        else
-          append_to_file importmap_file, <<~RUBY
-
-            # RailsPress rich text editor
-            pin "lexxy", to: "lexxy.js"
-          RUBY
-          say_status :pinned, "Lexxy in importmap", :green
-        end
+        # Lexxy is auto-pinned by the engine's importmap — no host app pin needed
       end
 
-      def configure_javascript
-        return unless importmap_available?
-
-        application_js = Rails.root.join("app", "javascript", "application.js")
-        return unless File.exist?(application_js)
-
-        js_content = File.read(application_js)
+      def generate_initializer
+        initializer_path = Rails.root.join("config", "initializers", "railspress.rb")
 
-        if js_content.include?('import "lexxy"')
-          say_status :skip, "Lexxy already imported in application.js", :yellow
+        if File.exist?(initializer_path)
+          say_status :skip, "config/initializers/railspress.rb already exists", :yellow
         else
-          append_to_file application_js, <<~JS
-
-            // RailsPress rich text editor
-            import "lexxy"
-          JS
-          say_status :added, "Lexxy import to application.js", :green
+          template "initializer.rb", initializer_path
+          say_status :created, "config/initializers/railspress.rb", :green
         end
       end
 
       def show_post_install_message
+        upgrading = !!@upgrading_existing_install
+
         say ""
         say "=" * 60, :green
-        say "  RailsPress installed successfully!", :green
+        say("  RailsPress #{upgrading ? "upgrade setup completed!" : "installed successfully!"}", :green)
         say "=" * 60, :green
         say ""
-        say "Next steps:", :yellow
-        say ""
-        say "  1. Run migrations:"
-        say "     $ rails db:migrate", :cyan
+        say(upgrading ? "Upgrade next steps:" : "Next steps:", :yellow)
         say ""
-        say "  2. Access the admin dashboard:"
-        say "     http://localhost:3000/railspress/admin", :cyan
-        say ""
-        say "  3. (Optional) Change the mount path in config/routes.rb:"
-        say "     mount Railspress::Engine => \"/blog\"", :cyan
+        if upgrading
+          say "  1. Review upgrade notes:"
+          say "     docs/UPGRADING.md", :cyan
+          say ""
+          say "  2. Run migrations:"
+          say "     $ rails db:migrate", :cyan
+          say ""
+          say "  3. Verify your JS integration if using host-page features:"
+          say '     app/javascript/application.js includes: import "railspress"', :cyan
+        else
+          say "  1. Run migrations:"
+          say "     $ rails db:migrate", :cyan
+          say ""
+          say "  2. Access the admin dashboard:"
+          say "     http://localhost:3000/railspress/admin", :cyan
+          say ""
+          say "  3. (Optional) Change the mount path in config/routes.rb:"
+          say '     mount Railspress::Engine => "/blog"', :cyan
+        end
         say ""
-        say "JavaScript setup:", :yellow
-        say "  The installer added Lexxy (rich text editor) to your importmap"
-        say "  and application.js. If you use a custom JS entry point, add:"
+        say "Optional features:", :yellow
+        say "  Edit config/initializers/railspress.rb to enable:"
+        say "    - CMS content elements (config.enable_cms)"
+        say "    - Inline CMS editing (config.inline_editing_check)"
+        say "  See docs/CONFIGURING.md and docs/INLINE_EDITING.md for details."
         say ""
-        say "     import \"lexxy\"", :cyan
+        say "Full guides & documentation:", :yellow
+        say "  https://railspress.org", :cyan
         say ""
         say "=" * 60, :green
       end
@@ -139,6 +140,16 @@ module Railspress
       def importmap_available?
         defined?(Importmap) && Rails.root.join("config", "importmap.rb").exist?
       end
+
+      def existing_railspress_installation?
+        routes_mounted = File.read(rails_route_file).include?("Railspress::Engine")
+        initializer_exists = Rails.root.join("config", "initializers", "railspress.rb").exist?
+        migrations_copied = Dir.glob(migrations_dir.join("*railspress*.rb")).any?
+
+        routes_mounted || initializer_exists || migrations_copied
+      rescue Errno::ENOENT
+        false
+      end
     end
   end
 end

data/lib/generators/railspress/install/templates/initializer.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+Railspress.configure do |config|
+  # === Blog Features (always available) ===
+
+  # Author tracking for posts and content elements.
+  # Uncomment to enable:
+  # config.enable_authors
+  # config.author_class_name = "User"
+  # config.current_author_method = :current_user
+
+  # === CMS Content Elements (opt-in) ===
+  # Adds content groups, content elements, and the cms_element/cms_value
+  # view helpers for managing structured content on your site.
+  # Image elements support dropzone upload and focal points when
+  # enable_focal_points is also active.
+  # See docs/CONFIGURING.md for details.
+  # Uncomment to enable:
+  # config.enable_cms
+
+  # === Inline CMS Editing (requires enable_cms) ===
+  # Right-click editing of CMS content on public pages.
+  # Also requires: import "railspress" in your application.js
+  # and yield :head in your layout. See docs/INLINE_EDITING.md.
+  # Uncomment to enable:
+  # config.inline_editing_check = ->(context) {
+  #   context.controller.current_user&.admin?
+  # }
+end

data/lib/railspress/engine.rb

@@ -6,8 +6,46 @@ module Railspress
     initializer "railspress.assets" do |app|
       if app.config.respond_to?(:assets)
         app.config.assets.paths << root.join("app", "assets", "stylesheets").to_s
+        app.config.assets.paths << root.join("app", "assets", "stylesheets", "railspress").to_s
         app.config.assets.paths << root.join("app", "assets", "javascripts").to_s
         app.config.assets.paths << root.join("app", "assets", "images").to_s
+        app.config.assets.paths << root.join("app", "javascript").to_s
+      end
+    end
+
+    # Make CMS helper available to host application views (or stub when disabled)
+    initializer "railspress.cms_helper" do
+      ActiveSupport.on_load(:action_view) do
+        if Railspress.cms_enabled?
+          include Railspress::CmsHelper
+        else
+          include Railspress::CmsHelper::DisabledStub
+        end
+      end
+    end
+
+    # Clear CMS cache on each request in development
+    initializer "railspress.cms_cache" do |app|
+      if Railspress.cms_enabled?
+        app.config.to_prepare do
+          Railspress::CmsHelper.clear_cache
+        end
+      end
+    end
+
+    # Validate configuration after all initializers have run
+    initializer "railspress.validate_config" do
+      if Railspress.inline_editing_check && !Railspress.cms_enabled?
+        raise Railspress::ConfigurationError,
+          "Inline editing requires CMS. Add `config.enable_cms` to your initializer."
+      end
+    end
+
+    # Configure importmap for Stimulus controllers
+    initializer "railspress.importmap", before: "importmap" do |app|
+      if app.respond_to?(:importmap)
+        app.config.importmap.paths << root.join("config", "importmap.rb")
+        app.config.importmap.cache_sweepers << root.join("app", "javascript")
       end
     end
   end