bidify 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28b6f2a2a467a1c0c61b7da79e06f2113cce82e0142c1c4646ba07a47261033f
-  data.tar.gz: 82ac8d4762aaf7ca746c5e7a3b1d285e85528929c4649c1396f68884b2b4863b
+  metadata.gz: 1422cfe24a1d9befab548ffcc1322e8c338c4071b59fc507fb27d1612bd0c9c2
+  data.tar.gz: e5be73c633debf5ab749773605daf538bc7dbd061e8a5bd149361987b5ce0eb7
 SHA512:
-  metadata.gz: efa3b752d9cabd3f6a37deb3a6a3a870214d2ccb3ccb6471d754dc99e6402ec389b2e18b44cc8c94ba2602a5c67a11628c72e572bed14f55e3adaf7884c2453a
-  data.tar.gz: 68f8d08def9b0a02c3ed7e34d10832bb29cbd918f6c59337585f51acf83a85e4c7d75ea50c89f8285f0d2d3e061f982d060edc0c4c00810a64ae775aa87d0b71
+  metadata.gz: c916797e6d73a4ab03947501b987d3eb4f8900a7deac7459c5b3756878ac6ce8aabc772eb1051b668e89c1de0997ca472d0425fbbe1a53d205aea2ac69c6641b
+  data.tar.gz: 7be01ddcf9db62892c70bd0e18084de7df6afa2d5ebedc1c3788cf419822712611687fa9c1f4a1a807b00dd7d3fa6f7954557c680004b881bb287eee1d4f44b4

data/CHANGELOG.md

@@ -0,0 +1,46 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.3.1] - 2023-08-26
+### Security
+- Upgrade `nokogiry` for security issues with libxml2 dependency (#14)
+
+## [0.3.0] - 2023-07-30
+
+### Added
+- Added a feature to stop budification if an element already has dir attribute
+  and a `greedy` option to force bidification on all nested elements (#10)
+- Added options for `only_tags`, `including_tags`, and `excluding_tags` (#12)
+
+## [0.2.0] - 2023-07-02
+
+### Changed
+- BREAKING: change the interface (#8)
+
+### Added
+- Added `with_table_support` option (#9)
+
+## [0.1.1] - 2023-06-25
+
+### Added
+- Include `div` in the default bidifiable tags (#6)
+
+### Fixed
+- Fix issues with lists by stoping bidification on `li` tags (#4)
+
+## [0.1.0] - 2023-06-22
+
+The initial release with the core functionality (#1)
+
+[unreleased]: https://github.com/dobidi/bidify-rb/compare/v0.3.1...HEAD
+[0.3.1]: https://github.com/dobidi/bidify-rb/compare/v0.3.0...v0.3.1
+[0.3.0]: https://github.com/dobidi/bidify-rb/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/dobidi/bidify-rb/compare/v0.1.1...v0.2.0
+[0.1.1]: https://github.com/dobidi/bidify-rb/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/dobidi/bidify-rb/releases/tag/v0.1.0

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    bidify (0.1.1)
-      nokogiri (~> 1.14)
+    bidify (0.3.1)
+      nokogiri (~> 1.15)
 
 GEM
   remote: https://rubygems.org/
@@ -10,15 +10,16 @@ GEM
     ast (2.4.2)
     diff-lcs (1.5.0)
     json (2.6.3)
-    nokogiri (1.15.2-x86_64-linux)
+    nokogiri (1.15.4-x86_64-linux)
       racc (~> 1.4)
     parallel (1.23.0)
-    parser (3.2.2.1)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
-    racc (1.7.0)
+      racc
+    racc (1.7.1)
     rainbow (3.1.1)
     regexp_parser (2.8.1)
-    rexml (3.2.5)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -28,10 +29,10 @@ GEM
     rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
+    rspec-support (3.12.1)
     rubocop (1.51.0)
       json (~> 2.3)
       parallel (~> 1.10)
@@ -42,16 +43,16 @@ GEM
       rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.1)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
     rubocop-capybara (2.18.0)
       rubocop (~> 1.41)
     rubocop-factory_bot (2.23.1)
       rubocop (~> 1.33)
-    rubocop-performance (1.18.0)
+    rubocop-performance (1.19.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.22.0)
+    rubocop-rspec (2.23.2)
       rubocop (~> 1.33)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)

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.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bidify
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Mostafa Ahangarha
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-02 00:00:00.000000000 Z
+date: 2023-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.15'
 description: Bidify helps to add bidirectional text support to HTML document
 email:
 - ahangarha@riseup.net
@@ -31,6 +31,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE