Merge pull request #409 from platanus/feat/add-markdown-input

Feat/add markdown input

Author: CarloGauss33

Gemfile.lock

@@ -11,6 +11,7 @@ PATH
     activeadmin_addons (1.9.0)
       active_material
       railties
+      redcarpet
       require_all
       sassc
       sassc-rails
@@ -249,6 +250,7 @@ GEM
     rb-fsevent (0.10.3)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
+    redcarpet (3.5.1)
     regexp_parser (1.6.0)
     require_all (3.0.0)
     responders (3.0.0)

README.md

@@ -134,6 +134,14 @@ You can show `Array` or `Hash` values as html lists.
 
 [Read more!](docs/list.md)
 
+#### Markdown
+
+You can render text as markdown.
+
+<img src="./docs/images/markdown-row.png" height="250" />
+
+[Read more!](docs/markdown.md)
+
 ### Inputs
 
 #### Select2 Input

activeadmin_addons.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "active_material"
   s.add_dependency "railties"
+  s.add_dependency "redcarpet"
   s.add_dependency "require_all"
   s.add_dependency "sassc"
   s.add_dependency "sassc-rails"

docs/images/markdown-row.png

@@ -0,0 +1,60 @@
+# Markdown
+
+## Markdown Column
+
+Renders text as markdown in the index view.
+
+You just need to use `markdown_column` method.
+
+```ruby
+index do
+  markdown_column :description
+end
+```
+
+## Markdown Row
+
+Renders text as markdown in the show view.
+
+You just need to use `markdown_row` method.
+
+```ruby
+show do
+  attributes_table do
+    markdown_row :description
+  end
+end
+```
+
+## Options
+
+This builder uses [Redcarpet](https://github.com/vmg/redcarpet) to render the text. You can pass any Redcarpet options to it. Using the options `extensions` and `render_options` to modify existing [Redcarpet options](https://github.com/vmg/redcarpet#and-its-like-really-simple-to-use).
+
+```ruby
+index do
+  markdown_column :description, extensions: { footnotes: true }
+end
+
+index do
+  markdown_column :description, render_options: { hard_wrap: true }
+end
+```
+
+### Builder default options
+
+The builder enables the following options by default to provide a plug-and-play experience:
+
+#### Extensions
+``` json
+fenced_code_blocks: true
+no_intra_emphasis: true
+strikethrough: true
+superscript: true
+```
+
+#### Render options
+
+```json
+filter_html: true,
+hard_wrap: true
+```

docs/markdown.md

@@ -0,0 +1,38 @@
+require 'redcarpet'
+
+module ActiveAdminAddons
+  class MarkdownBuilder < CustomBuilder
+    def render
+      return if data.blank?
+
+      Redcarpet::Markdown.new(renderer, extensions).render(@data).html_safe
+    end
+
+    private
+
+    def extensions_default
+      { fenced_code_blocks: true,
+        no_intra_emphasis: true,
+        strikethrough: true,
+        superscript: true }
+    end
+
+    def renderer_options_default
+      { filter_html: true, hard_wrap: true }
+    end
+
+    def extensions
+      @extensions ||= extensions_default.merge(options[:extensions] || {})
+    end
+
+    def render_options
+      @render_options ||= renderer_options_default.merge(options[:render_options] || {})
+    end
+
+    def renderer
+      @renderer ||= Redcarpet::Render::HTML.new(render_options)
+    end
+  end
+end
+
+ActiveAdminAddons::MarkdownBuilder.create_view_methods

lib/activeadmin_addons/addons/markdown_builder.rb

@@ -1,6 +1,6 @@
 ActiveAdmin.register Invoice do
   permit_params :legal_date, :number, :paid, :state, :attachment, :photo, :category_id, :city_id,
-    :amount, :color, :updated_at, :picture, :active, item_ids: [], other_item_ids: []
+    :amount, :color, :updated_at, :picture, :active, :description, item_ids: [], other_item_ids: []
 
   filter :id, as: :numeric_range_filter
 
@@ -21,6 +21,7 @@
     attachment_column :attachment
     number_column :amount, as: :currency, unit: "$", separator: ","
     toggle_bool_column :active
+    markdown_column :description
     column :created_at
     actions
   end
@@ -40,6 +41,7 @@
       row :legal_date
       number_row("Monto", :amount, as: :human, &:amount)
       row :city
+      markdown_row(:description)
       bool_row :active
     end
 
@@ -85,6 +87,8 @@
 
       f.input :attachment
 
+      f.input :description
+
       f.input :legal_date
 
       f.input :photo

spec/dummy/app/admin/invoices.rb

@@ -0,0 +1,5 @@
+class AddDescriptionToInvoice < ActiveRecord::Migration[5.2]
+  def change
+    add_column :invoices, :description, :text
+  end
+end

spec/dummy/db/migrate/20220617213244_add_description_to_invoice.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2022_04_01_181023) do
+ActiveRecord::Schema.define(version: 2022_06_17_213244) do
 
   create_table "active_admin_comments", force: :cascade do |t|
     t.string "namespace"
@@ -94,6 +94,7 @@
     t.boolean "active", default: true
     t.string "shipping_status"
     t.text "picture_data"
+    t.text "description"
     t.index ["category_id"], name: "index_invoices_on_category_id"
     t.index ["city_id"], name: "index_invoices_on_city_id"
   end

spec/dummy/db/schema.rb

@@ -0,0 +1,73 @@
+require 'rails_helper'
+
+describe "Markdown Builder", type: :feature do
+  context "shows text as markdown" do
+    before do
+      register_index(Invoice) do
+        markdown_column :description
+      end
+    end
+
+    context "with markdown text" do
+      before do
+        create_invoice(description: "# Header **bold** *italic*")
+        visit admin_invoices_path
+      end
+
+      it "shows parsed markdown" do
+        expect(page.html).to include("<h1>Header <strong>bold</strong> <em>italic</em></h1>")
+      end
+    end
+  end
+
+  context "shows text as markdown with custom options" do
+    before do
+      register_index(Invoice) do
+        markdown_column :description, extensions: { highlight: true }
+      end
+    end
+
+    context "with markdown text" do
+      before do
+        create_invoice(description: "This is ==highlighted==")
+        visit admin_invoices_path
+      end
+
+      it "shows parsed markdown" do
+        expect(page.html).to include("This is <mark>highlighted</mark>")
+      end
+    end
+  end
+
+  context "passing a block" do
+    before do
+      register_show(Invoice) do
+        markdown_row(:description) do
+          "# Header **bold** *italic*"
+        end
+      end
+
+      visit admin_invoice_path(create_invoice)
+    end
+
+    it "shows parsed markdown" do
+      expect(page.html).to include("<h1>Header <strong>bold</strong> <em>italic</em></h1>")
+    end
+  end
+
+  context "passing a block with custom options" do
+    before do
+      register_show(Invoice) do
+        markdown_row(:description, extensions: { highlight: true }) do
+          "This is ==highlighted=="
+        end
+      end
+
+      visit admin_invoice_path(create_invoice)
+    end
+
+    it "shows parsed markdown" do
+      expect(page.html).to include("This is <mark>highlighted</mark>")
+    end
+  end
+end