draftjs_html 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46ca7464191e9b163ce7d7a9e4175543606090934f08a8190dfd6a2ba4d946ed
-  data.tar.gz: 87288cdb9b61b818aa39083571e61f5b34e3f0d60b50d3b58da72b6ce057173f
+  metadata.gz: 46528a3d1be673050e64b56e4040d8c417b2f58932da8a53578f07fc7a21bf40
+  data.tar.gz: 541d38609ec3193c31276376f4ed59b6738cc0602450e14968a911a8be8e52ab
 SHA512:
-  metadata.gz: 52303e5b9f6ce70f2b2736fa34ebaada69e26ce709bfc263302cea4746aad00b8f9a831118e921ada1adb8d7c5eee700388685475347fda38008d27a5575ff73
-  data.tar.gz: ca29270b828f3bb15db3e958f7ead590df908bf66d4f0300734d26eba62fa89d9a1001ff3b672b4c67ce4d225d318cbc15eb72b274bd1c308d951ed4155bcbe0
+  metadata.gz: d1836e450c66f111355bad3a575249f6163d9aa9c7a779df4c30cfb06b8cb7ab36501dec1839866d587f0ef1cac4f0006c1cbd098ac57277e6433bb1b137da79
+  data.tar.gz: a2514f4841316b7bd552b1ddf26fd7380a039f7772741699f70de96bcbb2df07eb9bfd1db866162baa52f291a5fd5d0b78968f4ab2e7da9251605f26a57a6e2d

data/README.md

@@ -57,7 +57,7 @@ raw_draftjs = {
   },
 }
 
-DraftjsHtml.to_html(raw_draftjs, {
+DraftjsHtml.to_html(raw_draftjs, options: {
   entity_style_mappings:  {
     abc: ->(entity, content) {
       %Q{<a href="https://example.com/?id=#{entity.data['user_id']}">#{content}</a>}
@@ -70,6 +70,71 @@ Almost all of the options support Procs (or otherwise `.call`-ables) to provide
 flexibility in the conversion process. As the library uses Nokogiri to generate
 HTML, it's also possible to return `Nokogiri::Node` objects or String objects.
 
+### ToHtml Options
+
+#### `:encoding`
+
+Specify the HTML generation encoding.
+Defaults to `UTF-8`.
+
+#### `:entity_style_mappings`
+
+Allows the author to specify special mapping functions for entities.
+By default, we render `LINK` and `IMAGE` entities using the standard `<a>` and `<img>` tags, respectively.
+The author may supply a Proc object that returns any object Nokogiri can consume for adding to HTML.
+This includes `String`, `Nokogiri::Document::Fragment`, and `Nokogiri::Document` objects.
+
+#### `:block_type_mapping`
+
+You may wish to override the default HTML tags used for DraftJS block types.
+By default, we convert block types to tags as defined by `DraftjsHtml::ToHtml::BLOCK_TYPE_TO_HTML`.
+These may be overridden and appended to, like so:
+
+```ruby
+DraftjsHtml.to_html(raw_draftjs, options: {
+  block_type_mapping: {
+    'unstyled' => 'span',
+  },
+})
+
+# This would generate <span> tags instead of <p> tags for "unstyled" DraftJS blocks.
+```
+
+#### `:inline_style_mapping`
+
+You may wish to override the default HTML tags used to render DraftJS `inlineStyleRanges`.
+This works very similarly to `:block_type_mapping`, and the tags are defined by `DraftjsHtml::ToHtml::STYLE_MAP`.
+These may be overridden and appended to, like so:
+
+```ruby
+DraftjsHtml.to_html(raw_draftjs, options: {
+  inline_style_mapping: {
+    'BOLD' => 'strong',
+  },
+})
+
+# This would generate <strong> tags instead of <b> tags around ranges of `BOLD` inline styles.
+```
+
+#### `:inline_style_renderer`
+
+If the direct mapping from `:inline_style_mapping` isn't enough, you can supply a custom function for rendering a style range.
+This function, when provided, will be called with all applicable styles for a range, and the relevant content/text for that range.
+It bears stressing that this `#call`-able will be called with *all* defined styles for the content/character range.
+This means that by declaring this function, you take responsibility for handling _all_ styles for that range.
+However, if you "return" `nil` (or `false-y`) from the proc, it will fallback to the standard "mapping" fucntionality.
+
+```ruby
+DraftjsHtml.to_html(raw_draftjs, options: {
+  inline_style_renderer: ->(style_names, content) {
+    next if style_names != ['CUSTOM']
+    "<pre>#{content}</pre>"
+  },
+})
+
+# This would use the default inline style rendering UNLESS the *only* applied style for this range was "CUSTOM"
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/lib/draftjs_html/to_html.rb

@@ -53,8 +53,8 @@ module DraftjsHtml
     }.freeze
 
     def initialize(options)
-      @document = Nokogiri::HTML::Builder.new
       @options = ensure_options!(options)
+      @document = Nokogiri::HTML::Builder.new(encoding: @options.fetch(:encoding, 'UTF-8'))
     end
 
     def convert(raw_draftjs)

data/lib/draftjs_html/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DraftjsHtml
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: draftjs_html
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - TJ Taylor