marksmith 0.1.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 138a40e01855d847e9b295185fcf85edc6801e80c9bd94b1d8a55de7efb0b0f7
-  data.tar.gz: d29d99ff35c10fbc9e7deaadc84d7b27fdadb494732364cfda3003c69d397b81
+  metadata.gz: 56e19c3a798fe08b0a94496122a474c12f86290e1bb8a5b4fff861d4aa6364aa
+  data.tar.gz: f93776bd5fd3d8a18ce3d7d037902488afd38708cd3decc85f1d3524fde77536
 SHA512:
-  metadata.gz: 5be1932c6cc7b5054cab6875a38c615977682b4e50f048c1f04ec29df9c46cec911c846e4eb7f2f9413702841b1a801145ea0a91431efd9c7b11c511725c4b09
-  data.tar.gz: 1dd261670a842ca375bc584cf1028b078e4c93d147ee8f0893952704993a741efea93341ea89a6b6b1106e742b1724056684b45a0c0fdd4cf42a9b8ddd1b2eaf
+  metadata.gz: dc4374a4aec89463df75d437a8c5a78d417c6551bfbff1136a060220c98847e0acdff03ede9e2d93e1ca8c2296ee815be0518203fe4cbf6a710f373e28ec7f64
+  data.tar.gz: 822a0b2071008c2a898330283ad0a3518ca4f7493e6a2465a08863c5b741263ca4d183f31e28a226ead98b2d4f3c05e5e5d2815d825274a45410abafafea964b

data/README.md

@@ -28,7 +28,7 @@ Temporary live demo here, under the description field: [https://main.avodemo.com
 Have Bundler add it by running this command:
 
 ```bash
-bundle add marksmith
+bundle add marksmith commonmarker
 ```
 
 Or manually install it.
@@ -38,6 +38,8 @@ Add this line to your application's Gemfile:
 ```ruby
 # Gemfile
 gem "marksmith"
+# Add a markdown parser
+gem "commonmarker"
 ```
 
 #### 2. Install the NPM package to import the StimulusJS controller.
@@ -154,8 +156,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.
 
@@ -172,31 +174,31 @@ 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
+## Customize the renderer
 
-You can customize the renderer by overriding the `Marksmith::Renderer` model.
+Marksmith comes with a default renderer that uses `Commonmarker` by default but it can be changed to `Redcarpet` in the configuration.
 
 ```ruby
-# app/models/marksmith/renderer.rb
-require "redcarpet"
+# 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 renderer
-      ::Redcarpet::Markdown.new(
-        ::Redcarpet::Render::HTML,
-        tables: true,
-        lax_spacing: true,
-        fenced_code_blocks: true,
-        space_after_headers: true,
-        hard_wrap: true,
-        autolink: true,
-        strikethrough: true,
-        underline: true,
-        highlight: true,
-        quote: true,
-        with_toc_data: true
-      )
+    def initialize(body:)
+      @body = body
+    end
+
+    def render
+      # Your custom renderer logic here
     end
   end
 end

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

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

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

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

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

@@ -1,5 +1,5 @@
 /*!
-Marksmith 0.1.3
+Marksmith 0.2.1
 */
 var MarksmithController = (function () {
     'use strict';
@@ -2949,7 +2949,7 @@ var MarksmithController = (function () {
       }
 
       #pathFromBlob(blob) {
-        return `/rails/active_storage/blobs/redirect/${blob.signed_id}/${blob.filename}`
+        return `/rails/active_storage/blobs/redirect/${blob.signed_id}/${encodeURIComponent(blob.filename)}`
       }
 
       #markdownLinkFromUrl(filename, url, contentType) {

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

@@ -1,5 +1,5 @@
 /*!
-Marksmith 0.1.3
+Marksmith 0.2.1
 */
 var MarksmithController = (function (stimulus) {
     'use strict';
@@ -2459,7 +2459,7 @@ var MarksmithController = (function (stimulus) {
       }
 
       #pathFromBlob(blob) {
-        return `/rails/active_storage/blobs/redirect/${blob.signed_id}/${blob.filename}`
+        return `/rails/active_storage/blobs/redirect/${blob.signed_id}/${encodeURIComponent(blob.filename)}`
       }
 
       #markdownLinkFromUrl(filename, url, contentType) {

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/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/frontend/entrypoints/javascript/controllers/marksmith_controller.js

@@ -139,7 +139,7 @@ export default class extends Controller {
   }
 
   #pathFromBlob(blob) {
-    return `/rails/active_storage/blobs/redirect/${blob.signed_id}/${blob.filename}`
+    return `/rails/active_storage/blobs/redirect/${blob.signed_id}/${encodeURIComponent(blob.filename)}`
   }
 
   #markdownLinkFromUrl(filename, url, contentType) {

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/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/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.3"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marksmith
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.1
 platform: ruby
 authors:
 - Adrian Marin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-14 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