feat: support for raw html fields

Author: blocknotes

Makefile

@@ -1,14 +1,14 @@
 specs:
 	RUBYOPT='-rbundler/setup -rrbs/test/setup' RBS_TEST_TARGET='TinyAdmin::*' bin/rspec
 
-console:
-	bin/rails c
-
 server:
-	bin/rails s
+	bin/rails s -b 0.0.0.0 -p 4000
 
-seed:
-	bin/rails db:migrate && bin/rails db:seed
+console:
+	bin/rails c
 
 lint:
 	bin/rubocop
+
+seed:
+	cd spec/dummy_rails && bin/rails db:reset

lib/tiny_admin/raw_html.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TinyAdmin
+  class RawHtml
+    attr_reader :to_s
+
+    def initialize(value)
+      @to_s = value.to_s
+    end
+  end
+end

lib/tiny_admin/support.rb

@@ -3,6 +3,10 @@
 module TinyAdmin
   class Support
     class << self
+      def raw_html(value)
+        TinyAdmin::RawHtml.new(value)
+      end
+
       def call(value, options: [])
         options.inject(value) { |result, message| result&.send(message) } if value && options&.any?
       end

lib/tiny_admin/views/components/field_value.rb

@@ -18,15 +18,25 @@ def view_template
           if field.options[:link_to]
             a(href: TinyAdmin.route_for(field.options[:link_to], reference: translated_value)) {
               span(class: value_class) {
-                field.apply_call_option(record) || translated_value
+                render_value(field.apply_call_option(record) || translated_value)
               }
             }
           else
             span(class: value_class) {
-              translated_value
+              render_value(translated_value)
             }
           end
         end
+
+        private
+
+        def render_value(val)
+          if val.is_a?(TinyAdmin::RawHtml)
+            unsafe_raw(val.to_s)
+          else
+            val
+          end
+        end
       end
     end
   end

spec/dummy_rails/app/models/author.rb

@@ -31,4 +31,12 @@ class Author < ApplicationRecord
   def to_s
     "#{name} (#{age})"
   end
+
+  def stats
+    [
+      "Posts: <b>#{posts.count}</b>",
+      "Published: <b>#{published_posts.count}</b>",
+      "Recent: <b>#{recent_posts.count}</b>"
+    ]
+  end
 end

spec/dummy_rails/app/models/post.rb

@@ -17,7 +17,7 @@ class Post < ApplicationRecord
   validates :title, allow_blank: false, presence: true
 
   scope :published, -> { where(published: true) }
-  scope :recents, -> { where('created_at > ?', Date.current - 8.months) }
+  scope :recents, -> { where('created_at > ?', Time.current - 1.week) }
 
   # # override a field - can be dangerous
   # def title

spec/dummy_rails/app/tiny_admin/admin_helper.rb

@@ -1,2 +1,7 @@
 class AdminHelper < TinyAdmin::Support
+  class << self
+    def multiline(array, options: [])
+      raw_html array.join("<br/>")
+    end
+  end
 end

spec/dummy_rails/config/application.rb

@@ -20,5 +20,7 @@ class Application < Rails::Application
     #
     # config.time_zone = "Central Time (US & Canada)"
     # config.eager_load_paths << Rails.root.join("extras")
+
+    config.hosts << "laptop:4000"
   end
 end

spec/dummy_rails/config/tiny_admin.yml

@@ -42,6 +42,23 @@ sections:
         - id
         - name
         - email
+        - field: stats
+          header: Some stats
+          method: multiline
+      links:
+        - show
+        - sample_mem
+    show:
+      attributes:
+        - id
+        - name
+        - email
+        - age
+        - field: stats
+          header: Some stats
+          method: multiline
+        - created_at
+        - updated_at
       links:
         - show
         - sample_mem

spec/lib/tiny_admin/views/components/field_value_spec.rb

@@ -20,7 +20,7 @@
   end
 
   describe "with link_to option" do
-    let(:field) { TinyAdmin::Field.new(name: "author_id", type: :integer, title: "Author", options: { link_to: "authors" }) }
+    let(:field) { TinyAdmin::Field.new(name: "author_id", type: :integer, title: "Author", options: {link_to: "authors"}) }
     let(:record) { double("record", id: 1) } # rubocop:disable RSpec/VerifiedDoubles
 
     it "wraps the value in a link", :aggregate_failures do
@@ -31,8 +31,42 @@
     end
   end
 
+  describe "with a RawHtml value" do
+    let(:field) { TinyAdmin::Field.new(name: "items", type: :string, title: "Items", options: {method: "multiline"}) }
+    let(:record) { double("record", id: 1) } # rubocop:disable RSpec/VerifiedDoubles
+
+    before do
+      allow(TinyAdmin.settings.helper_class).to receive(:multiline)
+        .and_return(TinyAdmin::RawHtml.new("1<br/>2<br/>3"))
+    end
+
+    it "renders the value as raw HTML without escaping", :aggregate_failures do
+      html = described_class.new(field, [1, 2, 3], record: record).call
+      expect(html).to include("<span>")
+      expect(html).to include("1<br/>2<br/>3")
+      expect(html).not_to include("&lt;br/&gt;")
+    end
+  end
+
+  describe "with a RawHtml value inside a link" do
+    let(:field) { TinyAdmin::Field.new(name: "items", type: :string, title: "Items", options: {method: "multiline", link_to: "posts"}) }
+    let(:record) { double("record", id: 1) } # rubocop:disable RSpec/VerifiedDoubles
+
+    before do
+      allow(TinyAdmin.settings.helper_class).to receive(:multiline)
+        .and_return(TinyAdmin::RawHtml.new("1<br/>2<br/>3"))
+    end
+
+    it "renders the value as raw HTML inside a link without escaping", :aggregate_failures do
+      html = described_class.new(field, [1, 2, 3], record: record).call
+      expect(html).to include("<a")
+      expect(html).to include("1<br/>2<br/>3")
+      expect(html).not_to include("&lt;br/&gt;")
+    end
+  end
+
   describe "with value_class option" do
-    let(:field) { TinyAdmin::Field.new(name: "status", type: :string, title: "Status", options: { options: ["value_class"] }) }
+    let(:field) { TinyAdmin::Field.new(name: "status", type: :string, title: "Status", options: {options: ["value_class"]}) }
     let(:record) { double("record", id: 1) } # rubocop:disable RSpec/VerifiedDoubles
 
     it "adds value-based CSS class to the span" do