ghostwriter 1.2.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccebf53b35ad212e0c7e353a3cb4d79e1f91c63cec6490c5fff7ff56b72eed70
-  data.tar.gz: 5b3d36839dcef24d80605421970eb39e17efe3ec24d3126d753ac7a5039512a5
+  metadata.gz: c2bacc9e2d98409f7220a3b21d0cc57f18ff9c6768fb3175c0f06fdbef767e95
+  data.tar.gz: 5dba28996b1589fb94c0edbf7b3897a7610267438389ed57dbb009377544be93
 SHA512:
-  metadata.gz: d6039d9d2b3c1d6606da533c108c8087faa8b985ac0bf6adac7bc1ad4310cc601f76840ff32e83255847bedbd77dbc6cc280054f6eb4975dbe815a98b2a07373
-  data.tar.gz: d005669ca03f3ff465c351df0e47eba0372ca6061057102e14b0d879ddb0c5191a88bfaa389fa82a865787e6ff3b5d3fb351ae8b6351f108aef404a3bd66dd7a
+  metadata.gz: 101966376b10eec407d0a5b98bdb11ddfa3830c4532bc77b5e4ad4aeba41e05925c72dd78d25b6fc34f507f7ea9a32809757f735f8d6b6aa15d079a436c0db9b
+  data.tar.gz: dc870788a2971023a8276369d2953aa68f801edf31eeefd7bd6513400d453cf6e02fa728856f67a892e91fd8535c5607cca1cb244302d18e76bdc1c089b208e3

data/.rubocop.yml

@@ -1 +1 @@
-inherit_from: ../.rubocop.yml
+inherit_from: ~/.config/rubocop/config.yml

data/.ruby-version

@@ -1 +1 @@
-ruby-2.7.1
+ruby-3.3.0

data/.simplecov

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+SimpleCov.start do
+   coverage_dir '.coverage'
+   enable_coverage :branch
+
+   root __dir__
+
+   # add_filter 'spec/'
+end

data/Gemfile

@@ -2,5 +2,17 @@
 
 source 'https://rubygems.org'
 
-# Specify gem dependencies in ghostwriter.gemspec
+# Gem dependencies in ghostwriter.gemspec
 gemspec
+
+group :development do
+   gem 'bundler', '~> 2.4'
+   gem 'rake', '~> 13.2'
+   gem 'rubocop', '~> 1.69'
+   gem 'rubocop-performance', '~> 1.23'
+end
+
+group :test do
+   gem 'rspec', '~> 3.13'
+   gem 'simplecov', '~> 0.22'
+end

data/RELEASE_NOTES.md

@@ -1,5 +1,34 @@
 # Release Notes
 
+## 1.4.0 (2023-09-13)
+
+### Major
+
+* none
+
+### Minor
+
+* Support for graceful handling of nested tables
+* Increased minimum ruby to 3.3
+
+### Bugfixes
+
+* none
+
+## 1.3.0 (2023-09-13)
+
+### Major
+
+* none
+
+### Minor
+
+* Increased minimum Ruby to 3.1
+
+### Bugfixes
+
+* none
+
 ## 1.2.1 (2021-10-29)
 
 ### Major

data/Rakefile

@@ -1,5 +1,9 @@
+#!/usr/bin/env rake
 # frozen_string_literal: true
 
+# No longer require bundle exec
+Gem.use_gemdeps 'Gemfile'
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/{dirt-textify.gemspec → ghostwriter.gemspec}

@@ -19,6 +19,10 @@ Gem::Specification.new do |spec|
    spec.homepage = 'https://github.com/TenjinInc/ghostwriter'
    spec.license  = 'MIT'
 
+   spec.metadata = {
+         'rubygems_mfa_required' => 'true'
+   }
+
    spec.files = `git ls-files -z`.split("\x0").reject do |f|
       f.match(%r{^(test|spec|features)/})
    end
@@ -27,13 +31,7 @@ Gem::Specification.new do |spec|
    spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
    spec.require_paths = ['lib']
 
-   spec.required_ruby_version = '>= 2.7'
+   spec.required_ruby_version = '>= 3.3'
 
    spec.add_dependency 'nokogiri', '>= 1.12'
-
-   spec.add_development_dependency 'bundler', '~> 2.2'
-   spec.add_development_dependency 'rake', '~> 13.0'
-   spec.add_development_dependency 'rspec', '~> 3.3'
-   spec.add_development_dependency 'rubocop', '~> 1.22'
-   spec.add_development_dependency 'rubocop-performance', '~> 1.11'
 end

data/lib/ghostwriter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ghostwriter
-   VERSION = '1.2.1'
+   VERSION = '1.4.0'
 end

data/lib/ghostwriter/writer.rb

@@ -49,6 +49,12 @@ module Ghostwriter
 
       private
 
+      def simple_replace(doc, tag, replacement)
+         doc.search(tag).each do |node|
+            node.replace(node.inner_html + replacement)
+         end
+      end
+
       def normalize_lines(doc)
          doc.text.strip.split("\n").collect(&:strip).join("\n").concat("\n")
       end
@@ -114,78 +120,103 @@ module Ghostwriter
          end
       end
 
-      def replace_lists(doc)
-         doc.search('ol').each do |list_node|
-            replace_list_items(list_node, @ol_marker, after_marker: '.', increment: true)
-         end
+      # Methods for processing lists
+      module ListWriter
+         def replace_lists(doc)
+            doc.search('ol').each do |list_node|
+               replace_list_items(list_node, @ol_marker, after_marker: '.', increment: true)
+            end
 
-         doc.search('ul').each do |list_node|
-            replace_list_items(list_node, @ul_marker)
-         end
+            doc.search('ul').each do |list_node|
+               replace_list_items(list_node, @ul_marker)
+            end
 
-         doc.search('ul, ol').each do |list_node|
-            list_node.replace("#{ list_node.inner_html }\n")
+            doc.search('ul, ol').each do |list_node|
+               list_node.replace("#{ list_node.inner_html }\n")
+            end
          end
-      end
 
-      def replace_list_items(list_node, marker, after_marker: '', increment: false)
-         list_node.search('./li').each do |list_item|
-            list_item.replace("#{ marker }#{ after_marker } #{ list_item.inner_html }\n")
+         def replace_list_items(list_node, marker, after_marker: '', increment: false)
+            list_node.search('./li').each do |list_item|
+               list_item.replace("#{ marker }#{ after_marker } #{ list_item.inner_html }\n")
 
-            marker = marker.next if increment
+               marker = marker.next if increment
+            end
          end
       end
 
-      def replace_tables(doc)
-         doc.css('table').each do |table|
-            # remove whitespace between nodes
-            table.search('//text()[normalize-space()=""]').remove
+      # Methods for processing tables
+      module TableWriter
+         def replace_tables(doc)
+            doc.css('table').each do |table|
+               # TODO: nokogiri chokes on table:not(table table), but support may come later https://github.com/sparklemotion/nokogiri/issues/3207
+               next if complex? table
 
-            column_sizes = calculate_column_sizes(table)
+               # remove whitespace between nodes
+               table.search('//text()[normalize-space()=""]').remove
 
-            table.search('./thead/tr', './tbody/tr', './tr').each do |row|
-               replace_table_nodes(row, column_sizes)
+               column_sizes = calculate_column_sizes(table)
 
-               row.replace("#{ row.inner_html }#{ @table_column }\n")
+               fancy_rows! table, column_sizes
+
+               add_table_header_underline(table, column_sizes)
+
+               table.replace("\n#{ table.inner_html }\n")
             end
 
-            add_table_header_underline(table, column_sizes)
+            doc.css('table table').each do |table|
+               simple_rows! table
+            end
+         end
 
-            table.replace("\n#{ table.inner_html }\n")
+         # complex just means it contains a table or is itself nested
+         def complex?(table)
+            !table.css('table').empty? || !table.ancestors('table').empty?
          end
-      end
 
-      def calculate_column_sizes(table)
-         column_sizes = table.search('tr').collect do |row|
-            row.search('th', 'td').collect do |node|
-               node.text.length
+         def fancy_rows!(table, column_sizes)
+            table.search('./thead/tr', './tbody/tr', './tr').each do |row|
+               replace_table_nodes(row, column_sizes)
+
+               row.replace("#{ row.inner_html }#{ @table_column }\n")
             end
          end
 
-         column_sizes.transpose.collect(&:max)
-      end
+         def simple_rows!(table)
+            table.search('./thead/tr', './tbody/tr', './tr').each do |row|
+               row.replace("\n#{ row.inner_html }\n")
+            end
+         end
 
-      def add_table_header_underline(table, column_sizes)
-         table.search('./thead').each do |thead|
-            lines         = column_sizes.collect { |len| @table_row * (len + 2) }
-            underline_row = "#{ table_corner }#{ lines.join(@table_corner) }#{ @table_corner }"
+         def calculate_column_sizes(table)
+            column_sizes = table.search('tr').collect do |row|
+               row.search('th', 'td').collect do |node|
+                  node.text.length
+               end
+            end
 
-            thead.replace("#{ thead.inner_html }#{ underline_row }\n")
+            column_sizes.transpose.collect(&:max)
          end
-      end
 
-      def replace_table_nodes(row, column_sizes)
-         row.search('th', 'td').each_with_index do |node, i|
-            new_content = node.text.ljust(column_sizes[i] + 1)
+         def add_table_header_underline(table, column_sizes)
+            table.search('./thead').each do |thead|
+               lines         = column_sizes.collect { |len| @table_row * (len + 2) }
+               underline_row = "#{ table_corner }#{ lines.join(@table_corner) }#{ @table_corner }"
 
-            node.replace("#{ @table_column } #{ new_content }")
+               thead.replace("#{ thead.inner_html }#{ underline_row }\n")
+            end
          end
-      end
 
-      def simple_replace(doc, tag, replacement)
-         doc.search(tag).each do |node|
-            node.replace(node.inner_html + replacement)
+         def replace_table_nodes(row, column_sizes)
+            row.search('th', 'td').each_with_index do |node, i|
+               new_content = node.text.ljust(column_sizes[i] + 1)
+
+               node.replace("#{ @table_column } #{ new_content }")
+            end
          end
       end
+
+      include ListWriter
+      include TableWriter
    end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ghostwriter
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Robin Miller
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-29 00:00:00.000000000 Z
+date: 2025-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -24,76 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.12'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.2'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.22'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.22'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
 description: |
   Converts HTML to plain text, preserving as much legibility and functionality as possible.
 
@@ -108,6 +38,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".simplecov"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -117,14 +48,15 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- dirt-textify.gemspec
+- ghostwriter.gemspec
 - lib/ghostwriter.rb
 - lib/ghostwriter/version.rb
 - lib/ghostwriter/writer.rb
 homepage: https://github.com/TenjinInc/ghostwriter
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -133,14 +65,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Converts HTML to plain text