richer_text 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b63576861e360399b080b94d0bc593c516688af16f6dbfd0ea70ee922deddf34
-  data.tar.gz: a488d3031c92e1d0e34662bf942e48209030e2393a9227737e905ffb7041e60d
+  metadata.gz: 8ab9e5f516632d096522a7aa18daaad74e8c6b2eb5736bce0aff526e49a6f5a0
+  data.tar.gz: 532ff98188ba2b2425188cfcbec7cf80d5563d65339c7a247fdebb41d418247a
 SHA512:
-  metadata.gz: 7dbebb9524973cf7a949ee78b45fa80c73c97286e17d83a901281f500fde88d9bc8b03f103552545fd0fc5c066181a0a729dc4ba2e86575306c8be423b6b65d7
-  data.tar.gz: 45832c613c64aced07c6260163d4a1af2afe815a1af1a83beb799db24731b22e0787a262c5b0f109d0c1563510c594c1664294f5df1efe6c54a7d62b53ccd04d
+  metadata.gz: 39981e09d8ce208402c1c66a1541a706af868ad1563d4497b5d919a452256da00308448a6c08a5751f5cebc4b1613c165a2c0ec4d9302a8356a0f33f27f653db
+  data.tar.gz: 5ea9229f6bfd06ab525ab96b543dc63eed8dcbd34b3419f2dda0fe1058dba8168d881e29871917916ba1b03be7b7d7372da1b233f7c37018528f7c867383d4a6

data/README.md

@@ -1,10 +1,11 @@
 # RicherText
-Short description and motivation.
 
-## Usage
-How to use my plugin.
+RicherText aims to provide a richer text editing experience than what comes out of the box with ActionText in Rails. **It is however a seperate thing from ActionText** and is **not** backwards compatible.
+
+RicherText uses React and TipTap under the hood to create an editor, this does mean that you'll have react and react-dom in your project, but you absolutely don't need to use it outside of the RicherText editor. Additionally there's currently a hard requirement for ActiveStorage as well.
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -12,17 +13,73 @@ gem "richer_text"
 ```
 
 And then execute:
+
 ```bash
 $ bundle
 ```
 
-Or install it yourself as:
+Once you've installed the gem the next step is to run the Generator and install all required libraries.
+
 ```bash
-$ gem install richer_text
+$ rails richer_text:install
+```
+
+> [!IMPORTANT]  
+> If you wish to use highlight.js outside of RicherText you'll need to add some code to your javascript entry point.
+
+```js
+const hljs = require("highlight.js");
+
+document.addEventListener("turbo:load", (event) => {
+  document.querySelectorAll("pre").forEach((block) => {
+    hljs.highlightElement(block);
+  });
+});
+```
+
+## Usage
+
+> [!WARNING]  
+> You probably shouldn't use this gem / npm package (yet!) for anything serious. It's still undergoing development. But please do try it on a non-production app!
+
+To use RicherText, once you've completed the installation process is a matter of doing the following:
+
+**Add has_richer_text to a model**
+
+Take a Post model where you'd like to add RicherText to write, and edit the body attribute:
+
+```ruby
+class Post < ApplicationRecord
+  has_richer_text :body
+end
+```
+
+**Add the form helper to the form**
+
+Inside of your form partial:
+
+```erb
+  <%= form.label :body %>
+  <%= form.richer_text_area :body %>
+```
+
+Optionally you can pass arguments to the RicherText editor...
+
+```erb
+  <%= form.label :body %>
+  <%= form.richer_text_area :body, callouts: true, placeholder: "Write something..." %>
+```
+
+**Render the richer text content**
+
+```erb
+  <%= @post.body %>
 ```
 
 ## Contributing
+
 Contribution directions go here.
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/models/richer_text/rich_text.rb

@@ -1,17 +1,18 @@
 module RicherText
   class RichText < ApplicationRecord
-    belongs_to :record, polymorphic: true
+    belongs_to :record, polymorphic: true, touch: true
 
     serialize :body, RicherText::Content
 
     delegate :to_s, :nil?, to: :body
+    delegate :blank?, :empty?, :present?, to: :to_html
 
     has_many_attached :images
 
     before_save :update_images
 
     def to_html
-      body&.to_html
+      body&.to_html&.to_s
     end
 
     private

data/app/views/richer_text/contents/_content.html.erb

@@ -0,0 +1,3 @@
+<div class="richer-text">
+  <%= sanitize(content.to_html, attributes: %w(id class style data-color)) %>
+</div>

data/lib/generators/richer_text/install/install_generator.rb

@@ -9,6 +9,13 @@ module RicherText
         rails_command "railties:install:migrations FROM=active_storage,richer_text", inline: true
       end
 
+      def copy_files
+        copy_file(
+          "app/views/richer_text/contents/_content.html.erb",
+          "app/views/richer_text/contents/_content.html.erb"
+        )
+      end
+
       def install_javascript_dependencies
         destination = Pathname(destination_root)
 

data/lib/richer_text/content.rb

@@ -1,6 +1,6 @@
 module RicherText
   class Content
-    include Serialization
+    include ActiveModel::Conversion, Serialization, Rendering
 
     delegate :blank?, :empty?, :html_safe, :present?, to: :to_html
 
@@ -15,7 +15,7 @@ module RicherText
     end
 
     def to_s
-      to_html.html_safe # TODO: add some kind of sanitization
+      render partial: to_partial_path, layout: false, locals: { content: self }
     end
 
     def to_html
@@ -41,6 +41,7 @@ module RicherText
       end
     end
 
-    attr_reader :body, :fragment
+    attr_reader :fragment
+    attr_accessor :body
   end
 end

data/lib/richer_text/rendering.rb

@@ -0,0 +1,13 @@
+module RicherText
+  module Rendering
+    private
+
+    def render(*args, &block)
+      action_controller_renderer.render(*args, &block)
+    end
+
+    def action_controller_renderer
+      ActionController::Base.renderer
+    end
+  end
+end

data/lib/richer_text/version.rb

@@ -1,3 +1,3 @@
 module RicherText
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/richer_text.rb

@@ -9,6 +9,7 @@ module RicherText
 
   autoload :Attribute
   autoload :Content
+  autoload :Rendering
   autoload :Fragment
   autoload :Serialization
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: richer_text
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrea Fomera
@@ -45,6 +45,7 @@ files:
 - app/models/richer_text/application_record.rb
 - app/models/richer_text/rich_text.rb
 - app/views/layouts/richer_text/application.html.erb
+- app/views/richer_text/contents/_content.html.erb
 - config/routes.rb
 - db/migrate/20230107020316_create_richer_text_rich_texts.rb
 - lib/generators/richer_text/install/install_generator.rb
@@ -53,6 +54,7 @@ files:
 - lib/richer_text/content.rb
 - lib/richer_text/engine.rb
 - lib/richer_text/fragment.rb
+- lib/richer_text/rendering.rb
 - lib/richer_text/serialization.rb
 - lib/richer_text/version.rb
 - lib/tasks/richer_text_tasks.rake