ruby_cms 0.1.0

data/lib/ruby_cms/settings_registry.rb

@@ -0,0 +1,289 @@
+# frozen_string_literal: true
+
+module RubyCms
+  module SettingsRegistry
+    Entry = Struct.new(
+      :key,
+      :type,
+      :default,
+      :category,
+      :description
+    )
+
+    mattr_accessor :entries, default: {}
+
+    class << self
+      def register(key:, type:, default:, category: "general", description: nil)
+        k = key.to_s
+        entries[k] = Entry.new(
+          key: k,
+          type: normalize_type(type),
+          default: default,
+          category: category.to_s,
+          description: description.to_s
+        )
+      end
+
+      def fetch(key)
+        entries[key.to_s]
+      end
+
+      def each(&)
+        entries.each_value(&)
+      end
+
+      def defaults_hash
+        seed_defaults! if entries.empty?
+
+        entries.values.to_h do |entry|
+          [
+            entry.key.to_sym,
+            {
+              value: entry.default,
+              type: value_type_for(entry.type),
+              description: entry.description,
+              category: entry.category
+            }
+          ]
+        end
+      end
+
+      def seed_defaults!
+        return unless entries.empty?
+
+        # Pagination
+        register(
+          key: :visitor_errors_per_page,
+          type: :integer,
+          default: 25,
+          category: :pagination,
+          description: "Number of visitor errors to show per page"
+        )
+        register(
+          key: :content_blocks_per_page,
+          type: :integer,
+          default: 50,
+          category: :pagination,
+          description: "Number of content blocks to show per page"
+        )
+        register(
+          key: :users_per_page,
+          type: :integer,
+          default: 50,
+          category: :pagination,
+          description: "Number of users to show per page"
+        )
+        register(
+          key: :permissions_per_page,
+          type: :integer,
+          default: 50,
+          category: :pagination,
+          description: "Number of permissions to show per page"
+        )
+        register(
+          key: :pagination_min_per_page,
+          type: :integer,
+          default: 5,
+          category: :pagination,
+          description: "Minimum allowed per-page size"
+        )
+        register(
+          key: :pagination_max_per_page,
+          type: :integer,
+          default: 200,
+          category: :pagination,
+          description: "Maximum allowed per-page size"
+        )
+
+        # Analytics
+        register(
+          key: :analytics_high_volume_threshold,
+          type: :integer,
+          default: 1000,
+          category: :analytics,
+          description: "Threshold of visits per IP in selected period to flag high volume traffic"
+        )
+        register(
+          key: :analytics_rapid_request_threshold,
+          type: :integer,
+          default: 50,
+          category: :analytics,
+          description: "Threshold of visits from an IP per minute to flag rapid requests"
+        )
+        register(
+          key: :analytics_default_period,
+          type: :string,
+          default: "week",
+          category: :analytics,
+          description: "Default analytics period (day/week/month/year)"
+        )
+        register(
+          key: :analytics_max_date_range_days,
+          type: :integer,
+          default: 365,
+          category: :analytics,
+          description: "Maximum date range for analytics filters"
+        )
+        register(
+          key: :analytics_max_popular_pages,
+          type: :integer,
+          default: 10,
+          category: :analytics,
+          description: "Maximum number of popular pages to show"
+        )
+        register(
+          key: :analytics_max_top_visitors,
+          type: :integer,
+          default: 10,
+          category: :analytics,
+          description: "Maximum number of top visitors to show"
+        )
+        register(
+          key: :analytics_cache_duration_seconds,
+          type: :integer,
+          default: 600,
+          category: :analytics,
+          description: "Analytics cache duration in seconds"
+        )
+        register(
+          key: :analytics_recent_page_views_limit,
+          type: :integer,
+          default: 25,
+          category: :analytics,
+          description: "Recent page views shown on analytics dashboard"
+        )
+        register(
+          key: :analytics_page_details_limit,
+          type: :integer,
+          default: 100,
+          category: :analytics,
+          description: "Events shown on page details screen"
+        )
+        register(
+          key: :analytics_visitor_details_limit,
+          type: :integer,
+          default: 100,
+          category: :analytics,
+          description: "Events shown on visitor details screen"
+        )
+
+        # Dashboard
+        register(
+          key: :dashboard_recent_errors_limit,
+          type: :integer,
+          default: 5,
+          category: :dashboard,
+          description: "Recent visitor errors shown on dashboard"
+        )
+        register(
+          key: :dashboard_recent_content_blocks_limit,
+          type: :integer,
+          default: 5,
+          category: :dashboard,
+          description: "Recent content blocks shown on dashboard"
+        )
+
+        # Navigation visibility
+        register(
+          key: :nav_show_dashboard,
+          type: :boolean,
+          default: true,
+          category: :navigation,
+          description: "Show Dashboard in navigation"
+        )
+        register(
+          key: :nav_show_visual_editor,
+          type: :boolean,
+          default: true,
+          category: :navigation,
+          description: "Show Visual Editor in navigation"
+        )
+        register(
+          key: :nav_show_content_blocks,
+          type: :boolean,
+          default: true,
+          category: :navigation,
+          description: "Show Content Blocks in navigation"
+        )
+        register(
+          key: :nav_show_settings,
+          type: :boolean,
+          default: true,
+          category: :navigation,
+          description: "Show Settings in navigation"
+        )
+        register(
+          key: :nav_show_visitor_errors,
+          type: :boolean,
+          default: true,
+          category: :navigation,
+          description: "Show Visitor Errors in navigation"
+        )
+        register(
+          key: :nav_show_permissions,
+          type: :boolean,
+          default: true,
+          category: :navigation,
+          description: "Show Permissions in navigation"
+        )
+        register(
+          key: :nav_show_users,
+          type: :boolean,
+          default: true,
+          category: :navigation,
+          description: "Show Users in navigation"
+        )
+        register(
+          key: :nav_show_analytics,
+          type: :boolean,
+          default: true,
+          category: :navigation,
+          description: "Show Analytics in navigation"
+        )
+        register(
+          key: :nav_order,
+          type: :json,
+          default: [],
+          category: :navigation,
+          description: "Order of nav items (set via Settings → Navigation drag-and-drop)"
+        )
+
+        # Content/image constraints
+        register(
+          key: :reserved_key_prefixes,
+          type: :json,
+          default: ["admin_"],
+          category: :content,
+          description: "Reserved prefixes blocked for content block keys"
+        )
+        register(
+          key: :image_content_types,
+          type: :json,
+          default: ["image/png", "image/jpeg", "image/gif", "image/webp"],
+          category: :content,
+          description: "Allowed MIME types for content block images"
+        )
+        register(
+          key: :image_max_size,
+          type: :integer,
+          default: 5 * 1024 * 1024,
+          category: :content,
+          description: "Max image attachment size in bytes"
+        )
+      end
+
+      private
+
+      def normalize_type(type)
+        t = type.to_sym
+        return t if %i[string integer boolean json].include?(t)
+
+        :string
+      end
+
+      def value_type_for(type)
+        normalize_type(type).to_s
+      end
+    end
+  end
+end

data/lib/ruby_cms/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RubyCms
+  VERSION = "0.1.0"
+end

data/lib/ruby_cms.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+require_relative "ruby_cms/version"
+require_relative "ruby_cms/css_compiler"
+require_relative "ruby_cms/settings_registry"
+require_relative "ruby_cms/settings"
+require_relative "ruby_cms/engine"
+require_relative "ruby_cms/app_integration"
+require_relative "ruby_cms/content_blocks_sync"
+require_relative "ruby_cms/content_blocks_grouping"
+
+module RubyCms
+  class Error < StandardError; end
+
+  mattr_accessor :nav_registry
+  self.nav_registry = []
+
+  # Navigation section keys. Order in sidebar: main, then Settings (bottom).
+  # User can add items to either via nav_register with section: NAV_SECTION_MAIN (order 10+)
+  # or section: NAV_SECTION_BOTTOM (order 10+).
+  NAV_SECTION_MAIN = "main"
+  NAV_SECTION_BOTTOM = "Settings"
+
+  ANALYTICS_ICON_PATH = '<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" ' \
+                        'd="M3 3v18h18"></path>' \
+                        '<path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" ' \
+                        'd="M7 13l3-3 3 2 4-5"></path>'
+
+  def self.configure
+    yield(Rails.application.config.ruby_cms)
+  end
+
+  def self.setting(key, default: nil)
+    RubyCms::Settings.get(key, default:)
+  end
+
+  # Register a link for admin navigation.
+  # Sections: main (top), Settings (bottom). Add to main with section: "main", order: 10+;
+  # add to bottom with section: "Settings", order: 10+. Order can be changed via Settings → Navigation drag-and-drop.
+  # Options:
+  # - key: required Symbol/String
+  # - label: required String
+  # - path: required String or callable(view_context) -> path
+  # - icon: optional SVG path fragment
+  # - section: "main" | "Settings" (or nil => main)
+  # - order: optional Integer for sorting within section
+  # - permission: optional permission key (e.g., :manage_analytics)
+  # - default_visible: optional Boolean (default true)
+  # - if: optional callable for custom visibility gate
+  def self.nav_register(key:, label:, path:, icon: nil, section: nil, order: nil, permission: nil, default_visible: true, **options)
+    normalized_key = key.to_sym
+    normalized_section = section.presence || NAV_SECTION_MAIN
+    entry = {
+      key: normalized_key,
+      label: label.to_s,
+      path: path,
+      icon: icon,
+      section: normalized_section,
+      order: order,
+      permission: permission&.to_s,
+      default_visible: default_visible ? true : false,
+      if: options[:if]
+    }
+
+    self.nav_registry = nav_registry.reject {|e| e[:key] == normalized_key }
+    self.nav_registry += [entry]
+
+    register_navigation_setting!(entry)
+
+    entry
+  end
+
+  # Returns only entries that pass settings + permissions + conditional checks,
+  # sorted by saved nav_order (Settings → Navigation drag-and-drop) when set, else by section + order.
+  def self.visible_nav_registry(view_context: nil, user: nil)
+    list = nav_registry
+           .select {|item| nav_entry_visible?(item, view_context:, user:) }
+           .sort_by {|item| nav_sort_tuple(item) }
+    apply_nav_order(list)
+  rescue StandardError => e
+    Rails.logger.error("[RubyCMS] Error filtering navigation: #{e.message}") if defined?(Rails.logger)
+    nav_registry
+  end
+
+  module Nav
+    def self.register(key:, label:, path:, icon: nil, section: nil, order: nil, permission: nil, default_visible: true, **)
+      RubyCms.nav_register(
+        key:,
+        label:,
+        path:,
+        icon:,
+        section:,
+        order:,
+        permission:,
+        default_visible:,
+        **
+      )
+    end
+  end
+
+  class << self
+    private
+
+    def nav_sort_tuple(item)
+      section = item[:section].to_s.presence || NAV_SECTION_MAIN
+      priority = nav_section_priority(section)
+      [priority, item[:order] || 1000, item[:label].to_s]
+    end
+
+    def nav_section_priority(section)
+      section.to_s == NAV_SECTION_MAIN ? 0 : 2
+    end
+
+    def apply_nav_order(list)
+      # Read directly from DB so order is always from Settings, not Settings.get (which can return registry default).
+      pref = RubyCms::Preference.find_by(key: "nav_order")
+      return list unless pref&.value_type == "json" && pref.value.present?
+
+      saved = JSON.parse(pref.value)
+      return list unless saved.kind_of?(Array) && saved.any?
+
+      order_map = saved.each_with_index.to_h {|k, i| [k.to_s, i] }
+      list.sort_by {|item| order_map.fetch(item[:key].to_s, 9999) }
+    rescue StandardError
+      list
+    end
+
+    def nav_entry_visible?(item, view_context:, user:)
+      return false unless setting_enabled_for_nav_item?(item)
+      return false unless permission_allows_nav_item?(item, view_context:, user:)
+      return false unless condition_allows_nav_item?(item, view_context:)
+
+      true
+    end
+
+    def setting_enabled_for_nav_item?(item)
+      pref_key = :"nav_show_#{item[:key]}"
+      RubyCms::Settings.get(pref_key, default: item.fetch(:default_visible, true))
+    rescue StandardError
+      item.fetch(:default_visible, true)
+    end
+
+    def permission_allows_nav_item?(item, view_context:, user:)
+      permission_key = item[:permission]
+      return true if permission_key.blank?
+
+      current_user = user || user_from_view_context(view_context)
+      return false if current_user.nil?
+      return true unless current_user.respond_to?(:can?)
+
+      current_user.can?(permission_key.to_sym)
+    rescue StandardError
+      false
+    end
+
+    def condition_allows_nav_item?(item, view_context:)
+      condition = item[:if]
+      return true unless condition.respond_to?(:call)
+
+      case condition.arity
+      when 1
+        condition.call(view_context)
+      else
+        condition.call
+      end
+    rescue StandardError
+      false
+    end
+
+    def user_from_view_context(view_context)
+      return nil unless view_context
+
+      return view_context.current_user_cms if view_context.respond_to?(:current_user_cms)
+      return view_context.current_user if view_context.respond_to?(:current_user)
+
+      nil
+    end
+
+    def register_navigation_setting!(entry)
+      key = :"nav_show_#{entry[:key]}"
+
+      RubyCms::SettingsRegistry.register(
+        key: key,
+        type: :boolean,
+        default: entry.fetch(:default_visible, true),
+        category: :navigation,
+        description: "Show #{entry[:label]} in navigation"
+      )
+    rescue StandardError => e
+      Rails.logger.warn("[RubyCMS] Failed to register nav setting for #{entry[:key]}: #{e.message}") if defined?(Rails.logger)
+    end
+  end
+end
+
+RubyCms::SettingsRegistry.seed_defaults!

data/lib/tasks/ruby_cms.rake

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+namespace :ruby_cms do
+  namespace :css do
+    desc "Compile RubyCMS admin.css from component files (for gem development)"
+    task compile_gem: :environment do
+      require "ruby_cms/engine" unless defined?(RubyCms::Engine)
+
+      dest = RubyCms::Engine.root.join("app/assets/stylesheets/ruby_cms/admin.css")
+      RubyCms::Engine.compile_admin_css(dest)
+      puts "✓ Compiled admin.css in gem"
+    end
+
+    desc "Compile RubyCMS CSS to host app (combines component files)"
+    task compile: :environment do
+      require "fileutils"
+      require "ruby_cms/engine" unless defined?(RubyCms::Engine)
+
+      dest_dir = Rails.root.join("app/assets/stylesheets/ruby_cms")
+      FileUtils.mkdir_p(dest_dir)
+      dest = dest_dir.join("admin.css")
+      RubyCms::Engine.compile_admin_css(dest)
+      puts "✓ Compiled admin.css to #{dest}"
+      puts "✓ RubyCMS CSS compilation complete!"
+    end
+  end
+end