actiontext-syntax-highlighter 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31390bf8597bfd8d545a61a1682161e6e5e7096411cd89e1bcf981aa358eb0b2
-  data.tar.gz: be598fa01d142a066f9c736594f7b58e67cd26338f1349f4ae60ba531003c4d4
+  metadata.gz: 237e94b19c7b9fcf502f85f01e71cd7d4eb6bdf372feedb036cc88699863127a
+  data.tar.gz: c7c503cbc3d413e1543b1df16bef35e5eebbb6611b82482ed52debbf970a1261
 SHA512:
-  metadata.gz: 05bf47fa9c3a47e153b51a63a532e806fe18d6b3aa8d68a49c0ad9c7d04613f794971f2bd3efa81020c0204a3a8900fbabc75187e430905195a98e9e375d3d78
-  data.tar.gz: 3d8c27f3a029bb7b13ec6e4b95ad1a3a39150632a41cc0e388f732a2b5348f8f9f61a0fa1c577d3e9c80b52c68401653886c5dc34f7b3590b1a5d62a46455feb
+  metadata.gz: 7d37cbff4ad68c89e68cac23b3e3034ea04264f764ab52996da963b329cdd9d12898a5eb12bc0b3c0d79fb43072f623368e185f2860dbf8abc58c38ecb8a79c7
+  data.tar.gz: ba94cbab086ab0e4ff21b6a35addedb23ba69e9f8c6c8fca1d8bb77038572556af952d85d7a487f320b9316a01b909b1d2a777861d56e8431d43b02e52242bc0

data/README.md

@@ -60,7 +60,7 @@ config.action_text_syntax_highlighter.default_theme = :base16
 
 You can override the default theme by setting `@highlighted_code_block_theme` in your controller action where you're rendering out the rich text.
 
-This plugin requires a global `Trix` variable to create attachments, so require Trix in your application as below:
+`ActionTextSyntaxHighlighter` requires a global `Trix` variable to create attachments, so require Trix in your application as below:
 
 ```javascript
 window.Trix = require("trix")
@@ -80,6 +80,25 @@ If you wish, you can import pre-bundled JavaScript instead of the module as desc
 import "@ayushn21/actiontext-syntax-highlighter/dist"
 ```
 
+## Converting existing rich texts
+
+If you've already code rich texts in your app with code blocks using a `pre` tag, you can use the method `convert_pre_tags_to_highlighted_code_blocks` on `ActionText::RichText` to migrate them over to highlighted code blocks.
+
+For example:
+
+```ruby
+ActionText::RichText.find_each do |rich_text|
+  rich_text.convert_pre_tags_to_highlighted_code_blocks
+end
+```
+
+## Cleaning up deleted code blocks
+
+`ActionTextSyntaxHighlighter` nullifies the `rich_text_id` on a `HighlightedCodeBlock` when it's removed from an `ActionText::RichText`. However it doesn't delete the record. 
+
+I recommend you set up a cron job to execute the included `ActionTextSyntaxHighlighter::PurgeDeletedHighlightedCodeBlocksJob` which will delete all `HighlightedCodeBlock`s over a day old without an associated `RichText`.
+
+
 ## Contributing
 
 1. Fork it (https://github.com/ayushn21/actiontext-syntax-highlighter/fork)

data/app/models/action_text_syntax_highlighter/highlighted_code_block.rb

@@ -31,6 +31,7 @@ class ActionTextSyntaxHighlighter::HighlightedCodeBlock < ApplicationRecord
 
   private
     def process_content
+      self.content = CGI.unescapeHTML(self.content)
       self.content&.gsub!(/<br>/, "\n")
     end
 

data/lib/action_text_syntax_highlighter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActionTextSyntaxHighlighter
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: actiontext-syntax-highlighter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ayush Newatia