zen_admin 0.9.2

data/lib/tasks/zen_admin_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :zen_admin do
+#   # Task goes here
+# end

data/lib/zen_admin/authenticatable.rb

@@ -0,0 +1,44 @@
+module ZenAdmin
+  module Authenticatable
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :current_admin_user if respond_to?(:helper_method)
+    end
+
+    private
+
+    def current_admin_user
+      @current_admin_user ||= if session[:zen_admin_user_id] == "config_admin"
+        # 定义一个简单的类来模拟拥有 can? 方法的用户
+        Class.new do
+          def username; ZenAdmin.configuration.username; end
+          def can?(_permission); true; end # 硬编码管理员拥有所有权限
+          def super_admin?; true; end
+          def id; "config_admin"; end
+        end.new
+      elsif session[:zen_admin_user_id]
+        ZenAdmin::User.find_by(id: session[:zen_admin_user_id])
+      end
+    end
+
+    def authenticate_admin!
+      unless current_admin_user
+        redirect_to zen_admin.login_path
+      end
+    end
+
+    # 手动记录审计日志的快捷方法
+    def zen_admin_audit(resource, action, note: nil, changes: nil)
+      @zen_admin_audited = true # 标记已手动审计
+      ZenAdmin::AuditLog.record(
+        current_admin_user, 
+        resource, 
+        action, 
+        note: note, 
+        changes: changes, 
+        request: request
+      )
+    end
+  end
+end

data/lib/zen_admin/builtin.rb

@@ -0,0 +1,77 @@
+module ZenAdmin
+  module Builtin
+    def self.register_active_storage_blob
+      return unless defined?(ActiveStorage::Attachment)
+      return unless ActiveRecord::Base.connection.table_exists?("active_storage_attachments")
+
+      # 锁定保护
+      ActiveStorage::Attachment.send(:define_method, :zen_admin_editable?) { false }
+      ActiveStorage::Blob.send(:define_method, :zen_admin_editable?) { false }
+
+      # 1. 注册 Blob (完全隐藏，仅作为底层支撑)
+      ZenAdmin.register(ActiveStorage::Blob) do |resource|
+        resource.menu visible: false
+        resource.show do
+          field :id, label: "文件链接" do |blob|
+            url = Rails.application.routes.url_helpers.rails_blob_url(blob, host: "localhost:3000") rescue ""
+            render "zen_admin/builtin/file_link", url: url
+          end
+        end
+      end
+
+      # 2. Register System Attachments
+      ZenAdmin.register(ActiveStorage::Attachment) do |resource|
+        resource.label :'zen_admin.builtin.attachments', :'zen_admin.builtin.attachments'
+        resource.menu label: :'zen_admin.builtin.attachments', icon: "fas fa-robot", position: 101, group: "系统管理"
+        resource.soft_delete = false
+        resource.includes :blob, :record
+        resource.enable_batch_actions
+        resource.batch_action :delete, label: :'zen_admin.actions.delete', type: :danger, confirm: I18n.t('zen_admin.ui.confirm_bulk_delete') do |records|
+          records.destroy_all
+        end
+        
+        resource.list do
+          field :id, label: :'zen_admin.models.active_storage/attachment.fields.id' do |att|
+            if att.blob.representable?
+              url = main_app.rails_blob_path(att.blob, only_path: true)
+              full_url = main_app.url_for(att.blob)
+              tag.div(class: "thumbnail-box border rounded cursor-pointer shadow-xs", 
+                      style: "width: 35px; height: 35px; overflow: hidden;",
+                      data: { action: "click->layout#previewImage", preview_url: full_url }) do
+                image_tag(url, style: "width: 100%; height: 100%; object-fit: cover;")
+              end
+            else
+              # 精细化文件图标显示
+              tag.i(class: "fas #{case att.blob.content_type
+                                when /pdf/ then 'fa-file-pdf text-danger'
+                                when /word|officedocument/ then 'fa-file-word text-primary'
+                                when /excel|sheet/ then 'fa-file-excel text-success'
+                                else 'fa-file-alt'
+                                end} fa-lg")
+            end
+          end
+          field :record_type, label: :'zen_admin.models.active_storage/attachment.fields.record_type'
+          field :name, label: :'zen_admin.models.active_storage/attachment.fields.name'
+          field :blob_filename, label: :'zen_admin.models.active_storage/attachment.fields.blob_filename' do |att|
+            att.blob.filename.to_s
+          end
+          field :blob_id, label: :'zen_admin.models.active_storage/attachment.fields.blob_id' do |att|
+            url = Rails.application.routes.url_helpers.rails_blob_url(att.blob, host: "localhost:3000") rescue "#"
+            render "zen_admin/builtin/copy_button", url: url
+          end
+        end
+
+        resource.show do
+          field :record, label: :'zen_admin.models.active_storage/attachment.fields.record'
+          field :blob, label: :'zen_admin.models.active_storage/attachment.fields.blob' do |att|
+            url = Rails.application.routes.url_helpers.rails_blob_url(att.blob, host: "localhost:3000") rescue ""
+            render "zen_admin/builtin/file_link", url: url
+          end
+        end
+      end
+      
+      # 3. 显式加载我们的手动资源库模型
+      require_dependency ZenAdmin::Engine.root.join("app/models/zen_admin/asset")
+    end
+  end
+end

data/lib/zen_admin/configuration.rb

@@ -0,0 +1,17 @@
+module ZenAdmin
+  class Configuration
+    attr_accessor :enable_ui, :admin_path, :username, :password, :rbac_enable, :default_locale, :custom_dashboard, :audit_log_enable, :time_zone
+
+    def initialize
+      @enable_ui = true
+      @admin_path = "/admin"
+      @username = "admin"
+      @password = "password"
+      @rbac_enable = false
+      @default_locale = :"zh-CN"
+      @custom_dashboard = nil
+      @audit_log_enable = true
+      @time_zone = "Beijing"
+    end
+  end
+end

data/lib/zen_admin/core/field.rb

@@ -0,0 +1,34 @@
+module ZenAdmin
+  module Core
+    class Field
+      attr_accessor :name, :type, :options, :required, :condition
+
+      def initialize(name, type: :string, options: {}, required: false, condition: nil, label: nil)
+        @name = name
+        @type = type
+        @options = options
+        @options[:label] = label if label
+        @required = required
+        @condition = condition
+      end
+
+      def label
+        val = @options[:label]
+        if val.is_a?(Symbol)
+          I18n.t(val)
+        else
+          val || @name.to_s.humanize
+        end
+      end
+
+      def to_h
+        {
+          name: @name.to_s,
+          type: @type.to_s,
+          required: @required,
+          options: []
+        }
+      end
+    end
+  end
+end

data/lib/zen_admin/core/filter.rb

@@ -0,0 +1,16 @@
+module ZenAdmin
+  module Core
+    class Filter
+      attr_accessor :name, :type
+
+      def initialize(name, type: :string)
+        @name = name
+        @type = type
+      end
+
+      def to_h
+        { name: @name.to_s, type: @type.to_s }
+      end
+    end
+  end
+end

data/lib/zen_admin/core/resource.rb

@@ -0,0 +1,175 @@
+module ZenAdmin
+  module Core
+    class Resource
+      attr_accessor :name, :list_fields, :form_fields, :show_fields, :search_fields, :filters, :actions, :menu_options, :includes_list, :batch_actions, :member_actions, :resource_label_singular, :resource_label_plural, :soft_delete, :model_name, :scopes_list, :scopes_proc, :exportable
+
+      def initialize(model)
+        @model_name = model.to_s
+        if model.respond_to?(:name)
+          @name = model.name.underscore.pluralize
+        else
+          @name = model.to_s.underscore.pluralize
+        end
+        
+        begin
+          @resource_label_singular = model.model_name.human
+          @resource_label_plural = model.model_name.human.pluralize
+        rescue
+          @resource_label_singular = model.to_s.humanize
+          @resource_label_plural = @resource_label_singular.pluralize
+        end
+
+        @list_fields = []
+        @form_fields = []
+        @show_fields = []
+        @search_fields = []
+        @filters = []
+        @actions = [:index, :new, :create, :edit, :update, :show, :destroy]
+        @menu_options = { visible: true, label: nil, icon: nil, position: 10 }
+        @includes_list = []
+        @batch_actions = {}
+        @member_actions = {}
+        @scopes_list = []
+        @scopes_proc = nil
+        @soft_delete = true
+        @exportable = false
+      end
+
+      def label(singular = nil, plural = nil)
+        if singular
+          @resource_label_singular = singular
+          @resource_label_plural = plural || singular
+        else
+          translate_if_symbol(@resource_label_singular)
+        end
+      end
+
+      def label_plural
+        translate_if_symbol(@resource_label_plural)
+      end
+
+      def translate_if_symbol(val)
+        if val.is_a?(Symbol)
+          I18n.t(val, default: [model.model_name.human, val.to_s.split('.').last.humanize])
+        else
+          val
+        end
+      end
+
+      def exportable!
+        @exportable = true
+      end
+
+      def scope(name_or_proc = nil, label: nil, query: {}, default: false, &block)
+        if block_given?
+          @scopes_proc = block
+        elsif name_or_proc.is_a?(Proc)
+          @scopes_proc = name_or_proc
+        else
+          @scopes_list << { name: name_or_proc.to_sym, label: label, query: query, default: default }
+        end
+      end
+
+      def computed_scopes(context = nil)
+        results = @scopes_list.dup
+        if @scopes_proc
+          dynamic_results = context ? context.instance_exec(&@scopes_proc) : @scopes_proc.call
+          results += Array(dynamic_results)
+        end
+        results
+      end
+
+      def batch_actions; @batch_actions || {}; end
+      def member_actions; @member_actions || {}; end
+
+      def member_action(name_or_array, label: nil, type: :default, icon: nil, confirm: nil, method: nil, url: nil, handler: nil, &block)
+        if name_or_array.is_a?(Array)
+          name_or_array.each do |config|
+            name = config[:name]
+            @member_actions[name.to_sym] = {
+              name: name.to_sym,
+              label: config[:label],
+              icon: config[:icon],
+              type: config[:type] || :default,
+              confirm: config[:confirm],
+              method: config[:method],
+              url: config[:url],
+              handler: config[:handler]
+            }
+          end
+        else
+          @member_actions[name_or_array.to_sym] = {
+            name: name_or_array.to_sym,
+            label: label,
+            icon: icon,
+            type: type,
+            confirm: confirm,
+            method: method,
+            url: url,
+            handler: handler || block
+          }
+        end
+      end
+
+      def enable_batch_actions(enabled = true)
+        @batch_actions = {} if enabled && (@batch_actions.nil? || @batch_actions == false)
+      end
+
+      def batch_action(name_or_array, label: nil, type: :default, confirm: nil, method: nil, url: nil, handler: nil, &block)
+        if name_or_array.is_a?(Array)
+          name_or_array.each do |config|
+            name = config[:name]
+            @batch_actions[name.to_sym] = {
+              name: name.to_sym,
+              label: config[:label],
+              type: config[:type] || :default,
+              confirm: config[:confirm],
+              method: config[:method],
+              url: config[:url],
+              handler: config[:handler]
+            }
+          end
+        else
+          @batch_actions[name_or_array.to_sym] = {
+            name: name_or_array.to_sym,
+            label: label,
+            type: type,
+            confirm: confirm,
+            method: method,
+            url: url,
+            handler: handler || block
+          }
+        end
+      end
+
+      def search(&block); end
+      def includes(*args); @includes_list.concat(args); end
+      
+      def menu(visible: true, label: nil, icon: nil, position: 10, group: nil)
+        @menu_options = { visible: visible, label: label, icon: icon, position: position, group: group }
+      end
+
+      def model; @model_name.constantize; end
+      def show(&block); dsl = FieldDSL.new(self, :show_fields); dsl.instance_eval(&block); end
+      def list(&block); dsl = FieldDSL.new(self, :list_fields); dsl.instance_eval(&block); end
+      def form(&block); dsl = FieldDSL.new(self, :form_fields); dsl.instance_eval(&block); end
+      def filters(&block)
+        if block_given?
+          dsl = FieldDSL.new(self, :filters); dsl.instance_eval(&block)
+        else
+          @filters || []
+        end
+      end
+      def filter_fields; @filters || []; end
+
+      class FieldDSL
+        def initialize(resource, target_attr); @resource = resource; @target = target_attr; end
+        def field(name, type: :string, required: false, condition: nil, **options, &block)
+          field_obj = ZenAdmin::Core::Field.new(name, type: type, options: options, required: required, condition: condition)
+          field_obj.options[:formatter] = block if block_given?
+          @resource.send(@target) << field_obj
+        end
+      end
+    end
+  end
+end

data/lib/zen_admin/core.rb

@@ -0,0 +1,3 @@
+require "zen_admin/core/field"
+require "zen_admin/core/filter"
+require "zen_admin/core/resource"

data/lib/zen_admin/engine.rb

@@ -0,0 +1,67 @@
+module ZenAdmin
+  class Engine < ::Rails::Engine
+    isolate_namespace ZenAdmin
+
+    initializer "zen_admin.i18n" do |app|
+      app.config.i18n.default_locale = ZenAdmin.configuration.default_locale
+      # Add engine locales to host app
+      app.config.i18n.load_path += Dir[root.join("config", "locales", "**", "*.{rb,yml}")]
+      
+      # 设置 Rails 时区
+      Time.zone = ZenAdmin.configuration.time_zone
+      Groupdate.time_zone = Time.zone if defined?(Groupdate)
+    end
+
+    initializer "zen_admin.active_storage_csrf_fix" do
+      ActiveSupport.on_load(:active_storage_direct_uploads_controller) do
+        skip_before_action :verify_authenticity_token, raise: false
+      end
+    end
+
+    initializer "zen_admin.assets" do |app|
+      app.config.assets.paths << root.join("app/javascript")
+    end
+
+    initializer "zen_admin.importmap", before: "importmap" do |app|
+      if app.config.respond_to?(:importmap)
+        app.config.importmap.paths << root.join("config/importmap.rb")
+        app.config.importmap.cache_sweepers << root.join("app/javascript")
+      end
+    end
+
+    initializer "zen_admin.auto_discover_models" do
+      Rails.application.config.to_prepare do
+        # 1. 加载内置资源逻辑
+        require_dependency ZenAdmin::Engine.root.join("lib/zen_admin/builtin")
+        ZenAdmin::Builtin.register_active_storage_blob rescue nil
+
+        # 2. 显式加载所有内置模型 (确保注册到 Registry)
+        require_dependency ZenAdmin::Engine.root.join("app/models/zen_admin/asset")
+        require_dependency ZenAdmin::Engine.root.join("app/models/zen_admin/trash_item")
+        require_dependency ZenAdmin::Engine.root.join("app/models/zen_admin/audit_log")
+
+        if ZenAdmin.configuration.rbac_enable
+          require_dependency ZenAdmin::Engine.root.join("app/models/zen_admin/user")
+          require_dependency ZenAdmin::Engine.root.join("app/models/zen_admin/role")
+          require_dependency ZenAdmin::Engine.root.join("app/models/zen_admin/permission")
+        end
+
+        # 3. 扫描并加载宿主应用的模型
+        files = Dir.glob(Rails.root.join("app/models/**/*.rb")) + Dir.glob(Rails.root.join("app/controllers/**/*.rb"))
+        files.each do |file|
+          next if File.directory?(file)
+          begin
+            require_dependency file
+          rescue => e
+            Rails.logger.debug "[ZenAdmin] Failed to load #{file}: #{e.message}"
+          end
+        end
+
+        # 4. 自动同步权限点到数据库
+        if ZenAdmin.configuration.rbac_enable
+          ZenAdmin::Permission.sync_from_registry! rescue nil
+        end
+      end
+    end
+  end
+end

data/lib/zen_admin/link_registerable.rb

@@ -0,0 +1,11 @@
+module ZenAdmin
+  module LinkRegisterable
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def zen_admin_link(label, path, icon: "fas fa-link", visible: true, position: 10, permission: nil)
+        ZenAdmin.register_link(label, path, icon: icon, visible: visible, position: position, permission: permission)
+      end
+    end
+  end
+end

data/lib/zen_admin/registerable.rb

@@ -0,0 +1,17 @@
+module ZenAdmin
+  module Registerable
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def zen_admin(&block)
+        ZenAdmin.register(self, &block)
+        
+        # 自动授权 Ransack 搜索权限
+        if respond_to?(:ransackable_attributes)
+          define_singleton_method(:ransackable_attributes) { |auth_object = nil| column_names }
+          define_singleton_method(:ransackable_associations) { |auth_object = nil| reflect_on_all_associations.map { |a| a.name.to_s } }
+        end
+      end
+    end
+  end
+end

data/lib/zen_admin/registry.rb

@@ -0,0 +1,83 @@
+require "singleton"
+
+module ZenAdmin
+  class Registry
+    include Singleton
+
+    def initialize
+      @resources = {}
+      @links = []
+    end
+
+    def register(resource)
+      @resources[resource.model_name.to_s] = resource
+    end
+    
+    def register_link(label, path, icon:, visible:, position: 10, permission: nil)
+      @links.reject! { |l| l[:label] == label || l[:path] == path }
+      @links << { label: label, path: path, icon: icon, visible: visible, position: position, permission: permission }
+    end
+
+    def menu_items
+      raw_items = []
+      
+      # Collect resources
+      all.each do |r|
+        next unless r.respond_to?(:menu_options) && r.menu_options[:visible]
+        raw_items << { 
+          type: :resource, 
+          object: r, 
+          position: r.menu_options[:position] || 10,
+          group: r.menu_options[:group] 
+        }
+      end
+
+      # Collect links
+      @links.each do |l|
+        next unless l[:visible]
+        raw_items << { 
+          type: :link, 
+          object: l, 
+          position: l[:position] || 10,
+          group: nil # Links currently don't support grouping in this iteration, or we can add it later
+        }
+      end
+
+      # Grouping logic
+      grouped_items = {}
+      ungrouped_items = []
+
+      raw_items.each do |item|
+        if item[:group].present?
+          group_name = item[:group]
+          grouped_items[group_name] ||= { type: :group, label: group_name, items: [], position: nil }
+          grouped_items[group_name][:items] << item
+        else
+          ungrouped_items << item
+        end
+      end
+
+      # Calculate position for groups (min position of children)
+      grouped_items.each do |_, group|
+        group[:items].sort_by! { |i| i[:position] }
+        group[:position] = group[:items].first[:position]
+      end
+
+      # Merge and sort
+      final_list = ungrouped_items + grouped_items.values
+      final_list.sort_by { |i| i[:position] }
+    end
+
+    def [](model_or_name)
+      @resources[model_or_name.to_s]
+    end
+
+    def all
+      @resources.values
+    end
+    
+    def links
+      @links
+    end
+  end
+end

data/lib/zen_admin/schema/serializer.rb

@@ -0,0 +1,15 @@
+module ZenAdmin
+  module Schema
+    class Serializer
+      def self.serialize(resource)
+        {
+          model: resource.model.name,
+          list: resource.list_fields.map(&:to_h),
+          form: resource.form_fields.map(&:to_h),
+          filters: resource.filters.map(&:to_h),
+          actions: resource.actions.map(&:to_h)
+        }
+      end
+    end
+  end
+end

data/lib/zen_admin/schema.rb

@@ -0,0 +1 @@
+require "zen_admin/schema/serializer"

data/lib/zen_admin/version.rb

@@ -0,0 +1,3 @@
+module ZenAdmin
+  VERSION = "0.9.2"
+end

data/lib/zen_admin.rb

@@ -0,0 +1,51 @@
+require "zen_admin/version"
+require "zen_admin/engine"
+require "zen_admin/configuration"
+require "zen_admin/core"
+require "zen_admin/registry"
+require "zen_admin/schema"
+require "zen_admin/registerable"
+require "zen_admin/link_registerable"
+require "zen_admin/authenticatable"
+require "kaminari"
+require "pundit"
+require "ransack"
+
+module ZenAdmin
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def register(model, &block)
+      resource = Core::Resource.new(model)
+      block.call(resource) if block_given?
+      Registry.instance.register(resource)
+    end
+
+    def register_link(label, path, icon: "fas fa-link", visible: true, position: 10, permission: nil)
+      Registry.instance.register_link(label, path, icon: icon, visible: visible, position: position, permission: permission)
+    end
+  end
+end
+
+# Auto-include in ActiveRecord::Base
+ActiveSupport.on_load(:active_record) do
+  include ZenAdmin::Registerable
+end
+
+# Auto-include in ActionController::Base
+
+ActiveSupport.on_load(:action_controller) do
+
+  include ZenAdmin::LinkRegisterable
+
+  include ZenAdmin::Authenticatable
+  
+  helper ZenAdmin::ApplicationHelper
+
+end