marksmith 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5018de3478a97ddcec156c4245851720d0ea86d36a2002ab82ba9a145f6739cc
-  data.tar.gz: 7fb9f7f2a8f702abad17476695f14bf65669af942609c2dffe1531bb71137f30
+  metadata.gz: bd1c156bdd01e593e1ed5a364b646b028e736a7e0d67763110cce1e08ccb4d08
+  data.tar.gz: 12cdfb76d754cd011892b76790784cc122f5500213ab5f18318e353fdd531013
 SHA512:
-  metadata.gz: 813d6e4f66ac1a41c20afc5d1d6815d8695163badf4cb45ddbf49a1da394eb3c9436677610a61bf00bbf67e961abab9a6e5b89b1ccf61f203d82650d36f97292
-  data.tar.gz: 10b74b2a3af7f5ee6ecea2d76d54efe3d91d9784c4f3bd38ba807a828f36a79ae722deaab0285c8b9027660b452380f35df2b84af945971b85ed7199a4bd3a91
+  metadata.gz: c5908c41dc5a0b241a3db237ad8c6bf08e8868cb57517ff621bafb47564fd328ab7cb24b225c638b252d24e0c44852ea285af5aa95709b0fc0ab9e12aaf4ffe1
+  data.tar.gz: 5437ee09dccfd514e25d2fcd4874acb7cf126fe5ae26d4839ae6061daedcbdeabdb259a6dba550fdfa87b9d44d3a3f769046d17a50539a2d545390ac958ce57b

data/README.md

@@ -1,8 +1,10 @@
 # Marksmith
 
+[![CI](https://github.com/avo-hq/marksmith/actions/workflows/ci.yml/badge.svg)](https://github.com/avo-hq/marksmith/actions/workflows/ci.yml)
+
 Marksmith is a GitHub-style markdown editor for Rails apps.
 
-It supports Active Storage attachments and comes with a built-in mardown preview renderer.
+It supports Active Storage attachments and comes with a built-in markdown preview renderer.
 
 ![Marksmith logo](./marksmith.png)
 
@@ -152,8 +154,8 @@ end
 
 ## Built-in preview renderer
 
-The renderer is powered by [`Redcarpet`](https://github.com/vmg/redcarpet).
-It supports basic styles for headings, `strong`, `italic` and others.
+The renderer is powered by [`Commonmarker`](https://github.com/gjtorikian/commonmarker) by default but it can be changed to [`Redcarpet`](https://github.com/vmg/redcarpet) in the configuration or add your own logic by customizing the `Marksmith::Renderer` model.
+It supports basic styles like headings, `strong`, `italic` and others.
 
 In your `show.html.erb` view or the place where you want to render the compiled markup use the `marksmithed` helper and it will run the content through the renderer.
 
@@ -170,6 +172,35 @@ In your `show.html.erb` view or the place where you want to render the compiled
 > sanitize(body, tags: %w(table th tr td span) + ActionView::Helpers::SanitizeHelper.sanitizer_vendor.safe_list_sanitizer.allowed_tags.to_a)
 > ```
 
+## Customize the renderer
+
+Marksmith comes with a default renderer that uses `Commonmarker` by default but it can be changed to `Redcarpet` in the configuration.
+
+```ruby
+# config/initializers/marksmith.rb
+Marksmith.configure do |config|
+  config.parser = "redcarpet"
+end
+```
+
+### Add your own renderer
+
+You can completely customize the renderer by overriding the `Marksmith::Renderer` model.
+
+```ruby
+# app/models/marksmith/renderer.rb
+module Marksmith
+  class Renderer
+    def initialize(body:)
+      @body = body
+    end
+
+    def render
+      # Your custom renderer logic here
+    end
+  end
+end
+```
 
 ## Active Storage
 

data/app/assets/javascripts/list_continuation_controller-full.esm.js

@@ -1,5 +1,5 @@
 /*!
-Marksmith 0.1.2
+Marksmith 0.2.0
 */
 var ListContinuationController = (function () {
     'use strict';

data/app/assets/javascripts/list_continuation_controller-no-stimulus.esm.js

@@ -1,5 +1,5 @@
 /*!
-Marksmith 0.1.2
+Marksmith 0.2.0
 */
 var ListContinuationController = (function (stimulus) {
   'use strict';

data/app/assets/javascripts/marksmith_controller-full.esm.js

@@ -1,5 +1,5 @@
 /*!
-Marksmith 0.1.2
+Marksmith 0.2.0
 */
 var MarksmithController = (function () {
     'use strict';

data/app/assets/javascripts/marksmith_controller-no-stimulus.esm.js

@@ -1,5 +1,5 @@
 /*!
-Marksmith 0.1.2
+Marksmith 0.2.0
 */
 var MarksmithController = (function (stimulus) {
     'use strict';

data/app/assets/stylesheets/marksmith.css

@@ -829,8 +829,8 @@
 .ms\:cursor-pointer {
   cursor: pointer;
 }
-.ms\:resize-y {
-  resize: vertical;
+.ms\:resize-none {
+  resize: none;
 }
 .ms\:flex-col {
   flex-direction: column;

data/app/components/marksmith/markdown_field/edit_component.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
-
-class Marksmith::MarkdownField::EditComponent < Avo::Fields::EditComponent
-  def unique_id
-    [@field.type, @resource&.singular_route_key, @field.id].compact.join("_")
+if defined?(Avo)
+  class Marksmith::MarkdownField::EditComponent < Avo::Fields::EditComponent
+    def unique_id
+      [@field.type, @resource&.singular_route_key, @field.id].compact.join("_")
+    end
   end
 end

data/app/components/marksmith/markdown_field/show_component.html.erb

@@ -1,3 +1,3 @@
 <%= field_wrapper **field_wrapper_args, full_width: true do %>
-  <%= render partial: "marksmith/shared/rendered_body", locals: { body: Marksmith::Renderer.new.renderer.render(@field.value) } %>
+  <%= render partial: "marksmith/shared/rendered_body", locals: { body: Marksmith::Renderer.new(body: @field.value).render } %>
 <% end %>

data/app/components/marksmith/markdown_field/show_component.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
-
-class Marksmith::MarkdownField::ShowComponent < Avo::Fields::ShowComponent
+if defined?(Avo)
+  class Marksmith::MarkdownField::ShowComponent < Avo::Fields::ShowComponent
+  end
 end

data/app/controllers/marksmith/markdown_previews_controller.rb

@@ -1,7 +1,7 @@
 module Marksmith
   class MarkdownPreviewsController < ApplicationController
     def create
-      @body = Marksmith::Renderer.new.renderer.render(params[:body])
+      @body = Marksmith::Renderer.new(body: params[:body]).render
     end
   end
 end

data/app/models/marksmith/renderer.rb

@@ -1,8 +1,24 @@
-require "redcarpet"
-
 module Marksmith
   class Renderer
-    def renderer
+    def initialize(body:)
+      @body = body
+    end
+
+    def render
+      if Marksmith.configuration.parser == "commonmarker"
+        render_commonmarker
+      else
+        render_redcarpet
+      end
+    end
+
+    def render_commonmarker
+      # commonmarker expects an utf-8 encoded string
+      body = @body.to_s.dup.force_encoding('utf-8')
+      Commonmarker.to_html(body)
+    end
+
+    def render_redcarpet
       ::Redcarpet::Markdown.new(
         ::Redcarpet::Render::HTML,
         tables: true,
@@ -16,7 +32,7 @@ module Marksmith
         highlight: true,
         quote: true,
         with_toc_data: true
-      )
+      ).render(@body)
     end
   end
 end

data/app/views/marksmith/shared/_editor.html.erb

@@ -84,7 +84,7 @@
     <%= content_tag :div, class: "ms:flex ms:flex-1 ms:flex-col ms:size-full", data: { marksmith_target: "fieldContainer" } do %>
       <%= text_area_tag field_name, value,
         id: name,
-        class: class_names("ms:flex ms:flex-1 ms:rounded ms:border-none ms:resize-y ms:focus:outline-none ms:font-mono ms:focus:ring-0 ms:leading-normal ms:p-2 ms:text-sm", classes),
+        class: class_names("ms:flex ms:flex-1 ms:rounded ms:border-none ms:resize-none ms:focus:outline-none ms:font-mono ms:focus:ring-0 ms:leading-normal ms:p-2 ms:text-sm", classes),
         rows: rows,
         data: {
           action: "drop->marksmith#dropUpload paste->marksmith#pasteUpload",

data/lib/marksmith/configuration.rb

@@ -4,6 +4,7 @@ module Marksmith
 
     config_accessor(:automatically_mount_engine) { true }
     config_accessor(:mount_path) { "/marksmith" }
+    config_accessor(:parser) { "commonmarker" }
   end
 
   def self.configuration

data/lib/marksmith/engine.rb

@@ -53,6 +53,11 @@ module Marksmith
           Avo.asset_manager.register_stimulus_controller "marksmith", "MarksmithController"
           Avo.asset_manager.register_stimulus_controller "list-continuation", "ListContinuationController"
         end
+      else
+        # Ignore the markdown_field components if Avo is not defined
+        app.autoloaders.main.ignore(
+          root.join("app", "components", "marksmith", "markdown_field"),
+        )
       end
     end
   end

data/lib/marksmith/helper.rb

@@ -1,7 +1,7 @@
 module Marksmith
   module Helper
     def marksmithed(body)
-      Marksmith::Renderer.new.renderer.render(body)
+      Marksmith::Renderer.new(body:).render
     end
 
     def marksmith_tag(name, **kwargs, &block)

data/lib/marksmith/version.rb

@@ -1,3 +1,3 @@
 module Marksmith
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marksmith
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Adrian Marin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-03 00:00:00.000000000 Z
+date: 2025-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Marksmith is a GitHub-style markdown editor for Ruby on Rails applications.
 email:
 - adrian@adrianthedev.com
@@ -84,9 +70,6 @@ files:
 - app/frontend/entrypoints/javascript/controllers/index.js
 - app/frontend/entrypoints/javascript/controllers/list_continuation_controller.js
 - app/frontend/entrypoints/javascript/controllers/marksmith_controller.js
-- app/helpers/marksmith/application_helper.rb
-- app/jobs/marksmith/application_job.rb
-- app/mailers/marksmith/application_mailer.rb
 - app/models/marksmith/application_record.rb
 - app/models/marksmith/renderer.rb
 - app/views/layouts/marksmith/application.html.erb
@@ -127,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Marksmith is a GitHub-style markdown editor for Ruby on Rails applications.

data/app/helpers/marksmith/application_helper.rb

@@ -1,4 +0,0 @@
-module Marksmith
-  module ApplicationHelper
-  end
-end

data/app/jobs/marksmith/application_job.rb

@@ -1,4 +0,0 @@
-module Marksmith
-  class ApplicationJob < ActiveJob::Base
-  end
-end

data/app/mailers/marksmith/application_mailer.rb

@@ -1,6 +0,0 @@
-module Marksmith
-  class ApplicationMailer < ActionMailer::Base
-    default from: "from@example.com"
-    layout "mailer"
-  end
-end