bidify 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c285c4d577dac68ea9c5ccac31db0a7f9e538a9e4d209d325a417692cb1b2386
-  data.tar.gz: 32aaa78fb00dbb86f7cffec8880c8d4f270c0ece0f08f8d34adbbb3884d721df
+  metadata.gz: 28b6f2a2a467a1c0c61b7da79e06f2113cce82e0142c1c4646ba07a47261033f
+  data.tar.gz: 82ac8d4762aaf7ca746c5e7a3b1d285e85528929c4649c1396f68884b2b4863b
 SHA512:
-  metadata.gz: 93927a24291b9d0a5a315a157c0d8439e7d4a4611a2046602646f0c7a06f9209e1d0131ea3feb6f74900b3040403503788f7da0f5259e102df8c5162a4a6fb69
-  data.tar.gz: d1600270358238a32b59542e844ec900b74eef247c408bb3ba21420385fc0eb4754cdd5a2f36a8f0827c10898821653d2094ac409e1ee85c4d3b1765de7d3b09
+  metadata.gz: efa3b752d9cabd3f6a37deb3a6a3a870214d2ccb3ccb6471d754dc99e6402ec389b2e18b44cc8c94ba2602a5c67a11628c72e572bed14f55e3adaf7884c2453a
+  data.tar.gz: 68f8d08def9b0a02c3ed7e34d10832bb29cbd918f6c59337585f51acf83a85e4c7d75ea50c89f8285f0d2d3e061f982d060edc0c4c00810a64ae775aa87d0b71

data/Gemfile.lock

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

data/README.md

@@ -1,7 +1,5 @@
 # Bidify (Ruby)
 
-[![Gem Version](https://badge.fury.io/rb/bidify.svg)](https://badge.fury.io/rb/bidify)
-
 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.
@@ -11,8 +9,35 @@ The project is in its very early stage of development and its interface or funct
 ```rb
 require 'bidify'
 
-html_input = '<div>some content even in nested format</div>'
+html_input = '<p>some content even in nested format</p>'
 bidified_html = Bidify.bidify(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:
+
+- Only apply on "bidifiable" tags.
+- All top-level elements
+- All child elements except the first child
+
+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.
+
+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:
+
+```css
+/* Physical properties */
+text-align: left;
+padding-right: 10px;
+border-left: 1px;
+/* Logical properties */
+text-align: start;
+padding-inline-end: 10px;
+border-inline-start: 1px;
 ```
 
 ## License

data/lib/bidify/bidifier.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Bidify
+  # Super class for custom bidifiers
+  class Bidifier
+    ###
+    # Instanciate a bidifier object with the given optional options hash
+    #
+    # @param [Hash] options
+    #
+    def initialize(options = {})
+      @options = options
+
+      configure
+    end
+
+    def apply
+      raise NotImplementedError
+    end
+
+    private
+
+    def configure
+      @bidifiable_tags = DEFAULT_BIDIFIABLE_TAGS.dup
+      @bidifiable_tags.concat(TABLE_TAGS) if @options[:with_table_support]
+    end
+
+    def bidify_recursively(html_node, options = {})
+      seen_the_first_bidifiable_element = false
+
+      html_node.children.each do |child_node|
+        bidify_recursively(child_node)
+
+        if (options[:root] || seen_the_first_bidifiable_element) && @bidifiable_tags.include?(child_node.name)
+          child_node.set_attribute('dir', 'auto')
+        end
+
+        seen_the_first_bidifiable_element = true if actual_content?(child_node)
+      end
+    end
+
+    def actual_content?(node)
+      node.element? || (node.text? && !node.blank?)
+    end
+  end
+end

data/lib/bidify/html_string_bidifier.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+require_relative 'bidifier'
+
+module Bidify
+  ###
+  # Bidifying html input as string
+  #
+  # == Example Usage
+  #
+  # Here's an example of how to use the class:
+  #
+  #   bidifier = HtmlStringBidifier.new
+  #   bidifier.apply("<p>text</p>")
+  #
+  class HtmlStringBidifier < Bidifier
+    ###
+    # Applies dir="auto" to the given html string with default configuration
+    #
+    # @param [String] html_string a stringified HTML content
+    # @return [String] Bidified version of the input string
+    #
+    def apply(html_input)
+      html_node = Nokogiri::HTML.fragment(html_input)
+      bidify_recursively(html_node, { root: true })
+
+      html_node.to_s
+    end
+  end
+end

data/lib/bidify/version.rb

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

data/lib/bidify.rb

@@ -1,50 +1,27 @@
 # frozen_string_literal: true
 
-require 'nokogiri'
+require 'bidify/html_string_bidifier'
 
-# Bidify applies `dir="auto"` to the given html string
+# == Bidify module
 #
-# ### Example:
+# The namespace and helper methods for bidiying HTML contents
 #
-#    bidified_html = Bidify.bidify(regular_html)
+# == Example:
+#
+#    bidified_html = Bidify.bidify_html_string(regular_html)
 module Bidify
-  @bidifiable_tags = %w[h1 h2 h3 h4 h5 h6 p a ul ol li blockquote]
+  DEFAULT_BIDIFIABLE_TAGS = %w[div h1 h2 h3 h4 h5 h6 p ul ol blockquote].freeze
+  TABLE_TAGS = %w[table thead tbody th tr td].freeze
 
   class << self
     ###
-    # bidify applies dir="auto" to the given html string
-    def bidify(input_html)
-      html_node = Nokogiri::HTML.fragment(input_html)
-      bidify_recursively(html_node, { root: true })
-      html_node.to_s
-    end
-
-    private
-
-    def bidify_recursively(html_node, options = {})
-      return unless html_node.children.count.positive?
-
-      apply_bidi(html_node, options)
-    end
-
-    def apply_bidi(node, options)
-      seen_the_first_bidifiable_element = false
-
-      node.children.each do |child_node|
-        next if child_node.blank?
-
-        bidify_recursively(child_node)
-
-        if (options[:root] || seen_the_first_bidifiable_element) && @bidifiable_tags.include?(child_node.name)
-          child_node.set_attribute('dir', 'auto')
-        end
-
-        seen_the_first_bidifiable_element = true if actual_content?(child_node)
-      end
-    end
-
-    def actual_content?(node)
-      node.element? || (node.text? && !node.blank?)
+    # Applies dir="auto" to the given html string with default configuration
+    #
+    # @param [String] html_string a stringified HTML content
+    # @return [String] Bidified version of the input string
+    #
+    def bidify_html_string(html_string)
+      Bidify::HtmlStringBidifier.new.apply(html_string)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bidify
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mostafa Ahangarha
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-22 00:00:00.000000000 Z
+date: 2023-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -36,6 +36,8 @@ files:
 - LICENSE
 - README.md
 - lib/bidify.rb
+- lib/bidify/bidifier.rb
+- lib/bidify/html_string_bidifier.rb
 - lib/bidify/version.rb
 homepage: https://github.com/dobidi/bidify-rb
 licenses: