cms42 0.1.0

data/lib/generators/cms/install/templates/create_cms_tables.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+class CreateCmsTables < ActiveRecord::Migration[7.1]
+  def change
+    enable_extension "unaccent" unless extension_enabled?("unaccent")
+
+    create_table :cms_sites do |t|
+      t.string :name, null: false
+      t.string :slug, null: false
+      t.boolean :published, null: false, default: false
+      t.string :default_locale, null: false, default: "en"
+      t.timestamps
+    end
+
+    add_index :cms_sites, :slug, unique: true
+
+    create_table :cms_pages do |t|
+      t.references :site, null: false, foreign_key: { to_table: :cms_sites }
+      t.bigint :parent_id
+      t.string :slug, null: false
+      t.integer :position, null: false, default: 0
+      t.boolean :home, null: false, default: false
+      t.string :template_key, null: false, default: "standard"
+      t.string :status, null: false, default: "draft"
+      t.boolean :show_in_header, null: false, default: true
+      t.boolean :show_in_footer, null: false, default: false
+      t.string :nav_group, null: false, default: "main"
+      t.integer :nav_order, null: false, default: 0
+      t.integer :footer_order, null: false, default: 0
+      t.integer :depth, null: false, default: 0
+      t.string :preview_token
+      t.datetime :discarded_at
+      t.timestamps
+    end
+
+    add_index :cms_pages, %i[site_id slug], unique: true
+    add_index :cms_pages, %i[site_id status position]
+    add_index :cms_pages, %i[site_id nav_group nav_order]
+    add_index :cms_pages, :parent_id
+    add_index :cms_pages, :preview_token, unique: true
+    add_index :cms_pages, :discarded_at
+
+    add_foreign_key :cms_pages, :cms_pages, column: :parent_id
+
+    create_table :cms_page_translations do |t|
+      t.references :page, null: false, foreign_key: { to_table: :cms_pages }
+      t.string :locale, null: false
+      t.string :title, null: false
+      t.string :seo_title
+      t.string :seo_description
+      t.timestamps
+    end
+
+    add_index :cms_page_translations, %i[page_id locale], unique: true
+
+    create_table :cms_images do |t|
+      t.references :site, null: false, foreign_key: { to_table: :cms_sites }
+      t.string :title, null: false
+      t.timestamps
+    end
+
+    create_table :cms_image_translations do |t|
+      t.references :image, null: false, foreign_key: { to_table: :cms_images }
+      t.string :locale, null: false
+      t.string :alt_text, null: false
+      t.string :caption
+      t.timestamps
+    end
+
+    add_index :cms_image_translations, %i[image_id locale], unique: true
+
+    create_table :cms_sections do |t|
+      t.references :site, null: false, foreign_key: { to_table: :cms_sites }
+      t.string :kind, null: false, default: "rich_text"
+      t.boolean :global, null: false, default: false
+      t.boolean :enabled, null: false, default: true
+      t.jsonb :settings, null: false, default: {}
+      t.datetime :discarded_at
+      t.timestamps
+    end
+
+    add_index :cms_sections, %i[site_id kind]
+    add_index :cms_sections, %i[site_id global kind]
+    add_index :cms_sections, :discarded_at
+
+    create_table :cms_section_translations do |t|
+      t.references :section, null: false, foreign_key: { to_table: :cms_sections }
+      t.string :locale, null: false
+      t.string :title, null: false
+      t.string :subtitle
+      t.timestamps
+    end
+
+    add_index :cms_section_translations, %i[section_id locale], unique: true
+
+    create_table :cms_section_images do |t|
+      t.references :section, null: false, foreign_key: { to_table: :cms_sections }
+      t.references :image, null: false, foreign_key: { to_table: :cms_images }
+      t.integer :position, null: false, default: 0
+      t.timestamps
+    end
+
+    add_index :cms_section_images, %i[section_id position]
+    add_index :cms_section_images, %i[section_id image_id], unique: true
+
+    create_table :cms_documents do |t|
+      t.references :site, null: false, foreign_key: { to_table: :cms_sites }
+      t.string :title, null: false
+      t.text :description
+      t.timestamps
+    end
+
+    create_table :cms_page_sections do |t|
+      t.references :page, null: false, foreign_key: { to_table: :cms_pages }
+      t.references :section, null: false, foreign_key: { to_table: :cms_sections }
+      t.integer :position, null: false, default: 0
+      t.timestamps
+    end
+
+    add_index :cms_page_sections, %i[page_id position]
+    add_index :cms_page_sections, %i[page_id section_id], unique: true
+
+    create_table :cms_form_fields do |t|
+      t.references :page, null: false, foreign_key: { to_table: :cms_pages }
+      t.string :kind, null: false, default: "text"
+      t.string :label, null: false
+      t.string :field_name, null: false
+      t.string :placeholder
+      t.string :hint
+      t.boolean :required, null: false, default: false
+      t.jsonb :options, null: false, default: []
+      t.integer :position, null: false, default: 0
+      t.timestamps
+    end
+
+    add_index :cms_form_fields, %i[page_id position]
+    add_index :cms_form_fields, %i[page_id field_name], unique: true
+
+    create_table :cms_form_submissions do |t|
+      t.references :page, null: false, foreign_key: { to_table: :cms_pages }
+      t.jsonb :data, null: false, default: {}
+      t.string :ip_address
+      t.datetime :created_at, null: false, default: -> { "CURRENT_TIMESTAMP" }
+    end
+
+    add_index :cms_form_submissions, :created_at
+
+    create_table :cms_api_keys do |t|
+      t.references :site, null: false, foreign_key: { to_table: :cms_sites }
+      t.string :name, null: false
+      t.string :token, null: false
+      t.boolean :active, null: false, default: true
+      t.datetime :last_used_at
+      t.timestamps
+    end
+
+    add_index :cms_api_keys, :token, unique: true
+
+    create_table :cms_webhooks do |t|
+      t.references :site, null: false, foreign_key: { to_table: :cms_sites }
+      t.string :url, null: false
+      t.jsonb :events, null: false, default: []
+      t.string :secret
+      t.boolean :active, null: false, default: true
+      t.timestamps
+    end
+
+    create_table :cms_webhook_deliveries do |t|
+      t.references :webhook, null: false, foreign_key: { to_table: :cms_webhooks }
+      t.string :event, null: false
+      t.integer :response_code
+      t.text :response_body
+      t.boolean :success, null: false, default: false
+      t.string :error_message
+      t.datetime :delivered_at, null: false, default: -> { "CURRENT_TIMESTAMP" }
+    end
+
+    add_index :cms_webhook_deliveries, %i[webhook_id delivered_at]
+
+    return if table_exists?(:action_text_rich_texts)
+
+    create_table :action_text_rich_texts do |t|
+      t.string :name, null: false
+      t.text :body
+      t.references :record, null: false, polymorphic: true, index: false
+      t.timestamps
+    end
+
+    add_index :action_text_rich_texts,
+              %i[record_type record_id name],
+              unique: true,
+              name: "index_action_text_rich_texts_uniqueness"
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+Cms.setup do |config|
+  # Public/API controllers inherit from this host controller.
+  config.parent_controller = "ApplicationController"
+
+  # Required for admin in production: point this at a host controller that
+  # already enforces authentication and authorization for CMS access.
+  config.admin_parent_controller = "Admin::BaseController"
+
+  # Optional for public/API requests when you use site slugs, headers, or
+  # subdomains. Required for admin once any Cms::Site exists.
+  config.current_site_resolver = ->(controller) { controller.current_organization&.cms_site }
+
+  # Optional: replace the public/API page lookup service.
+  # config.page_resolver_class = "Cms::PageResolver"
+
+  # Optional: replace API serialization classes.
+  # config.api_site_serializer_class = "Cms::Api::SiteSerializer"
+  # config.api_page_serializer_class = "Cms::Api::PageSerializer"
+end

data/lib/generators/cms/views/views_generator.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module Cms
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root Cms::Engine.root.join("app/views")
+      desc "Copies CMS views to your application."
+
+      argument :scope,
+               required: false,
+               default: nil,
+               desc: "Select a view scope (admin, public, mailer, all)"
+
+      class_option :views,
+                   aliases: "-v",
+                   type: :array,
+                   desc: "Select specific view scopes to generate (admin, public, mailer)"
+
+      VIEW_GROUPS = {
+        "admin" => [
+          "cms/admin"
+        ],
+        "public" => [
+          "cms/sections",
+          "cms/public",
+          "layouts/cms"
+        ],
+        "mailer" => [
+          "cms/form_submission_mailer"
+        ],
+        "all" => [
+          "cms",
+          "layouts/cms"
+        ]
+      }.freeze
+
+      def copy_views
+        selected_groups.each do |group|
+          copy_group(group)
+        end
+      end
+
+      private
+
+      def selected_groups
+        groups =
+          if options[:views].present?
+            options[:views]
+          elsif scope.present?
+            [scope]
+          else
+            ["all"]
+          end
+
+        normalized = groups.map { |entry| entry.to_s.downcase }.uniq
+        invalid = normalized - VIEW_GROUPS.keys
+        return normalized if invalid.empty?
+
+        raise Thor::Error, "Unknown view scope(s): #{invalid.join(', ')}. " \
+                           "Valid scopes: #{VIEW_GROUPS.keys.join(', ')}"
+      end
+
+      def copy_group(group)
+        VIEW_GROUPS.fetch(group).each do |relative_path|
+          source = Cms::Engine.root.join("app/views", relative_path)
+          target = File.join("app/views", relative_path)
+
+          if source.directory?
+            directory relative_path, target
+          else
+            copy_file relative_path, target
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tasks/cms_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :cms do
+#   # Task goes here
+# end

data/lib/tasks/version.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+namespace :cms do
+  desc "Print current gem version"
+  task :version do
+    puts Cms::VERSION
+  end
+end

metadata

@@ -0,0 +1,281 @@
+--- !ruby/object:Gem::Specification
+name: cms42
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- shift42
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actiontext
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !ruby/object:Gem::Dependency
+  name: discard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+- !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: 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'
+description: A mountable Rails CMS engine. Multi-site, multilingual, content blocks,
+  page tree, media management, forms, headless JSON API, and webhooks.
+email:
+- hello@shift42.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/cms/application.css
+- app/controllers/cms/admin/api_keys_controller.rb
+- app/controllers/cms/admin/base_controller.rb
+- app/controllers/cms/admin/documents_controller.rb
+- app/controllers/cms/admin/form_fields_controller.rb
+- app/controllers/cms/admin/form_submissions_controller.rb
+- app/controllers/cms/admin/images_controller.rb
+- app/controllers/cms/admin/pages_controller.rb
+- app/controllers/cms/admin/sections_controller.rb
+- app/controllers/cms/admin/sites_controller.rb
+- app/controllers/cms/admin/webhook_deliveries_controller.rb
+- app/controllers/cms/admin/webhooks_controller.rb
+- app/controllers/cms/api/base_controller.rb
+- app/controllers/cms/api/v1/base_controller.rb
+- app/controllers/cms/api/v1/pages_controller.rb
+- app/controllers/cms/api/v1/sites_controller.rb
+- app/controllers/cms/application_controller.rb
+- app/controllers/cms/public/base_controller.rb
+- app/controllers/cms/public/form_submissions_controller.rb
+- app/controllers/cms/public/previews_controller.rb
+- app/controllers/cms/public/sites_controller.rb
+- app/controllers/concerns/cms/admin/page_scoped_sections.rb
+- app/controllers/concerns/cms/current_site_resolver.rb
+- app/controllers/concerns/cms/public/page_paths.rb
+- app/controllers/concerns/cms/public/page_rendering.rb
+- app/controllers/concerns/cms/site_resolvable.rb
+- app/helpers/cms/admin/pages_helper.rb
+- app/helpers/cms/admin/sections_helper.rb
+- app/helpers/cms/admin/sites_helper.rb
+- app/helpers/cms/application_helper.rb
+- app/helpers/cms/media_helper.rb
+- app/helpers/cms/pages_helper.rb
+- app/helpers/cms/sections_helper.rb
+- app/helpers/cms/sites_helper.rb
+- app/javascript/cms/controllers/sortable_controller.js
+- app/jobs/cms/application_job.rb
+- app/jobs/cms/deliver_webhook_job.rb
+- app/mailers/cms/application_mailer.rb
+- app/mailers/cms/form_submission_mailer.rb
+- app/models/cms/api_key.rb
+- app/models/cms/application_record.rb
+- app/models/cms/document.rb
+- app/models/cms/form_field.rb
+- app/models/cms/form_submission.rb
+- app/models/cms/image.rb
+- app/models/cms/image_translation.rb
+- app/models/cms/page.rb
+- app/models/cms/page_section.rb
+- app/models/cms/page_translation.rb
+- app/models/cms/section.rb
+- app/models/cms/section/block_base.rb
+- app/models/cms/section/blocks/call_to_action_block.rb
+- app/models/cms/section/blocks/hero_block.rb
+- app/models/cms/section/blocks/image_block.rb
+- app/models/cms/section/blocks/rich_text_block.rb
+- app/models/cms/section/kind_registry.rb
+- app/models/cms/section_image.rb
+- app/models/cms/section_translation.rb
+- app/models/cms/site.rb
+- app/models/cms/webhook.rb
+- app/models/cms/webhook_delivery.rb
+- app/serializers/cms/api/base_serializer.rb
+- app/serializers/cms/api/page_serializer.rb
+- app/serializers/cms/api/site_serializer.rb
+- app/services/cms/locale_resolver.rb
+- app/services/cms/page_resolver.rb
+- app/services/cms/public_page_context.rb
+- app/views/cms/admin/api_keys/_form.html.erb
+- app/views/cms/admin/api_keys/create.html.erb
+- app/views/cms/admin/api_keys/edit.html.erb
+- app/views/cms/admin/api_keys/index.html.erb
+- app/views/cms/admin/api_keys/new.html.erb
+- app/views/cms/admin/documents/_form.html.erb
+- app/views/cms/admin/documents/edit.html.erb
+- app/views/cms/admin/documents/index.html.erb
+- app/views/cms/admin/documents/new.html.erb
+- app/views/cms/admin/form_fields/_form.html.erb
+- app/views/cms/admin/form_fields/edit.html.erb
+- app/views/cms/admin/form_fields/index.html.erb
+- app/views/cms/admin/form_fields/new.html.erb
+- app/views/cms/admin/form_submissions/index.html.erb
+- app/views/cms/admin/images/_form.html.erb
+- app/views/cms/admin/images/edit.html.erb
+- app/views/cms/admin/images/index.html.erb
+- app/views/cms/admin/images/new.html.erb
+- app/views/cms/admin/pages/_attach_section_panel.html.erb
+- app/views/cms/admin/pages/_form.html.erb
+- app/views/cms/admin/pages/_section_editor_frame.html.erb
+- app/views/cms/admin/pages/_sections_list.html.erb
+- app/views/cms/admin/pages/edit.html.erb
+- app/views/cms/admin/pages/index.html.erb
+- app/views/cms/admin/pages/new.html.erb
+- app/views/cms/admin/pages/show.html.erb
+- app/views/cms/admin/sections/_form.html.erb
+- app/views/cms/admin/sections/_section.html.erb
+- app/views/cms/admin/sections/edit.html.erb
+- app/views/cms/admin/sections/index.html.erb
+- app/views/cms/admin/sections/new.html.erb
+- app/views/cms/admin/sections/page_update.turbo_stream.erb
+- app/views/cms/admin/sections/show.html.erb
+- app/views/cms/admin/sites/_form.html.erb
+- app/views/cms/admin/sites/edit.html.erb
+- app/views/cms/admin/sites/new.html.erb
+- app/views/cms/admin/sites/show.html.erb
+- app/views/cms/admin/webhook_deliveries/index.html.erb
+- app/views/cms/admin/webhooks/_form.html.erb
+- app/views/cms/admin/webhooks/edit.html.erb
+- app/views/cms/admin/webhooks/index.html.erb
+- app/views/cms/admin/webhooks/new.html.erb
+- app/views/cms/form_submission_mailer/notify.html.erb
+- app/views/cms/form_submission_mailer/notify.text.erb
+- app/views/cms/public/pages/_content.html.erb
+- app/views/cms/public/pages/show.html.erb
+- app/views/cms/public/pages/templates/_custom.html.erb
+- app/views/cms/public/pages/templates/_form.html.erb
+- app/views/cms/public/pages/templates/_landing.html.erb
+- app/views/cms/public/pages/templates/_standard.html.erb
+- app/views/cms/sections/kinds/_cta.html.erb
+- app/views/cms/sections/kinds/_hero.html.erb
+- app/views/cms/sections/kinds/_image.html.erb
+- app/views/cms/sections/kinds/_rich_text.html.erb
+- app/views/layouts/cms/application.html.erb
+- app/views/layouts/cms/public.html.erb
+- bin/rails
+- bin/rubocop
+- cms.gemspec
+- config/importmap.rb
+- config/locales/activerecord.cms.en.yml
+- config/locales/en.yml
+- config/routes.rb
+- lib/cms.rb
+- lib/cms/engine.rb
+- lib/cms/version.rb
+- lib/cms42.rb
+- lib/generators/cms/install/install_generator.rb
+- lib/generators/cms/install/templates/create_cms_tables.rb
+- lib/generators/cms/install/templates/initializer.rb
+- lib/generators/cms/views/views_generator.rb
+- lib/tasks/cms_tasks.rake
+- lib/tasks/version.rake
+homepage: https://github.com/shift42/cms
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Modular, mountable CMS engine for Rails apps
+test_files: []