bidify 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28b6f2a2a467a1c0c61b7da79e06f2113cce82e0142c1c4646ba07a47261033f
-  data.tar.gz: 82ac8d4762aaf7ca746c5e7a3b1d285e85528929c4649c1396f68884b2b4863b
+  metadata.gz: 32b3c244317bd021ff911b1be914990a87e7056b64d7c7ef8ec08fe4597721d0
+  data.tar.gz: db60b88d64e4c288d7160072ffb67edebb46959941294159ab231593ee6d8217
 SHA512:
-  metadata.gz: efa3b752d9cabd3f6a37deb3a6a3a870214d2ccb3ccb6471d754dc99e6402ec389b2e18b44cc8c94ba2602a5c67a11628c72e572bed14f55e3adaf7884c2453a
-  data.tar.gz: 68f8d08def9b0a02c3ed7e34d10832bb29cbd918f6c59337585f51acf83a85e4c7d75ea50c89f8285f0d2d3e061f982d060edc0c4c00810a64ae775aa87d0b71
+  metadata.gz: 7ff62ccd19cef7e7427e7a369d97d3832325066e0c73f6ef6ef1fe1774d5895cc3212d82e9df3be6534e614249b0047056483ba4d78cd78bbb9b0648b8134804
+  data.tar.gz: 23389f67993355bd021f140b4392b4641800cb01fff36ae0b232a27c70d072c84103f791e83517510ee2c64db4f91765274f2dd4e804d42c10a063b640d81589

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bidify (0.1.1)
+    bidify (0.2.0)
       nokogiri (~> 1.14)
 
 GEM

data/README.md

@@ -2,7 +2,8 @@
 
 Bidify helps to add bidirectional text support to HTML documents.
 
-The project is in its very early stage of development and its interface or functionality may break from one version to another. Use it with caution.
+The project is in its very early stage of development, and its interface or
+functionality may break from one version to another. Use it with caution.
 
 ## Usage
 
@@ -10,22 +11,20 @@ The project is in its very early stage of development and its interface or funct
 require 'bidify'
 
 html_input = '<p>some content even in nested format</p>'
-bidified_html = Bidify.bidify(html_input)
+bidified_html = Bidify.bidify_html_string(html_input)
 # bidified_html: '<p dir="auto">some content even in nested format</p>' 
 ```
 
 ## Rules
 
-The `dir="auto"` attribute should be applied on "bidifiable" tags as per the following rules:
+Bidification (the `dir="auto"` attribute) follows these simple rules:
 
-- Only apply on "bidifiable" tags.
-- All top-level elements
-- All child elements except the first child
+- It applies to "bidifiable" tags.
+- It excludes the first immediate child element.
+- It excludes `li` tags.
 
-Bidifiable elements can be defined as per the use case requirements (not yet implemented).
-The default bidifiable tags are: `div`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `p`, `ul`, `ol`, `blockquote`.
-
-Notice that `li` elements shouldn't get `dir=auto` otherwise, the list appearance gets damaged.
+The default bidifiable tags are `div`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`,
+`p`, `ul`, `ol`, and `blockquote`. One can modify this list using options.
 
 As a complementary step, CSS styles should use [logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_logical_properties_and_values). Here are a few examples:
 
@@ -40,6 +39,48 @@ padding-inline-end: 10px;
 border-inline-start: 1px;
 ```
 
+## Configuration
+
+To use this gem with custom configuration, use the following syntax and pass
+options while creating an instance of bidifier:
+
+```rb
+options = {
+  # ...
+}
+
+bidifier = Bidify::HtmlStringBidifier.new(options)
+
+puts bidifier.apply('<div>input stringified html</div>')
+```
+
+### Options
+
+Available options with their default values are as follows:
+
+- `excluding_tags: []`
+
+    Removes tags from the list of bidifiable tags. This option affects the
+    provided tags in `including_tags` options.
+
+- `including_tags: []`
+
+    Adds new tags to the list of bidifiable tags
+
+- `greedy: false`
+
+    By default, bidification stops when it reaches an element that has `dir`
+    attribute. Use `true` to disregard any existing `dir` attributes.
+
+- `only_tags: []`
+
+    It sets the bidifiable tags to the given tags.
+
+- `with_table_support: false`
+
+    Use `true` to add table tags support.
+
 ## License
 
-This project is a Free/Libre and Open Source software released under LGPLv3 license.
+This project is a Free/Libre and Open Source software released under LGPLv3
+license.

data/lib/bidify/bidifier.rb

@@ -23,12 +23,17 @@ module Bidify
     def configure
       @bidifiable_tags = DEFAULT_BIDIFIABLE_TAGS.dup
       @bidifiable_tags.concat(TABLE_TAGS) if @options[:with_table_support]
+      @bidifiable_tags.concat(@options[:including_tags]) if @options.key?(:including_tags)
+      @bidifiable_tags.delete_if { |tag| @options[:excluding_tags]&.include?(tag) }
+      @bidifiable_tags = @options[:only_tags] if @options.key?(:only_tags)
     end
 
     def bidify_recursively(html_node, options = {})
       seen_the_first_bidifiable_element = false
 
       html_node.children.each do |child_node|
+        next if stop_recursion_at?(child_node)
+
         bidify_recursively(child_node)
 
         if (options[:root] || seen_the_first_bidifiable_element) && @bidifiable_tags.include?(child_node.name)
@@ -42,5 +47,11 @@ module Bidify
     def actual_content?(node)
       node.element? || (node.text? && !node.blank?)
     end
+
+    def stop_recursion_at?(node)
+      return false if @options[:greedy] == true
+
+      node.has_attribute?('dir')
+    end
   end
 end

data/lib/bidify/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bidify
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mostafa Ahangarha
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-02 00:00:00.000000000 Z
+date: 2023-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri