turndown 1.0.0

data/lib/turndown/utilities.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Turndown
+  module Utilities
+    BLOCK_ELEMENTS = %w[
+      ADDRESS ARTICLE ASIDE AUDIO BLOCKQUOTE BODY CANVAS CENTER DD DIR DIV DL DT
+      FIELDSET FIGCAPTION FIGURE FOOTER FORM FRAMESET H1 H2 H3 H4 H5 H6 HEADER
+      HGROUP HR HTML ISINDEX LI MAIN MENU NAV NOFRAMES NOSCRIPT OL OUTPUT P PRE
+      SECTION TABLE TBODY TD TFOOT TH THEAD TR UL
+    ].freeze
+
+    VOID_ELEMENTS = %w[
+      AREA BASE BR COL COMMAND EMBED HR IMG INPUT KEYGEN LINK META PARAM SOURCE
+      TRACK WBR
+    ].freeze
+
+    MEANINGFUL_WHEN_BLANK_ELEMENTS = %w[
+      A TABLE THEAD TBODY TFOOT TH TD IFRAME SCRIPT AUDIO VIDEO
+    ].freeze
+
+    module_function
+
+    def extend(destination, *sources)
+      sources.each do |source|
+        source.each do |key, value|
+          destination[key] = value
+        end
+      end
+      destination
+    end
+
+    def repeat(character, count)
+      character * count
+    end
+
+    def trim_leading_newlines(string)
+      string.sub(/\A\n+/, "")
+    end
+
+    def trim_trailing_newlines(string)
+      index_end = string.length
+      index_end -= 1 while index_end.positive? && string[index_end - 1] == "\n"
+      string[0, index_end]
+    end
+
+    def trim_newlines(string)
+      trim_trailing_newlines(trim_leading_newlines(string))
+    end
+
+    def is_block?(node)
+      node_name_in?(node, BLOCK_ELEMENTS)
+    end
+
+    def is_void?(node)
+      node_name_in?(node, VOID_ELEMENTS)
+    end
+
+    def has_void?(node)
+      has_descendant_named?(node, VOID_ELEMENTS)
+    end
+
+    def is_meaningful_when_blank?(node)
+      node_name_in?(node, MEANINGFUL_WHEN_BLANK_ELEMENTS)
+    end
+
+    def has_meaningful_when_blank?(node)
+      has_descendant_named?(node, MEANINGFUL_WHEN_BLANK_ELEMENTS)
+    end
+
+    def escape_markdown(string)
+      string
+        .gsub(/\\/) { '\\' * 2 }
+        .gsub(/\*/) { '\*' }
+        .gsub(/\A-/) { '\-' }
+        .gsub(/\A\+ /) { '\+ ' }
+        .gsub(/\A(=+)/) { "\\#{$1}" }
+        .gsub(/\A(\#{1,6}) /) { "\\#{$1} " }
+        .gsub(/`/) { '\`' }
+        .gsub(/\A~~~/) { '\~~~' }
+        .gsub(/\[/) { '\[' }
+        .gsub(/\]/) { '\]' }
+        .gsub(/\A>/) { '\>' }
+        .gsub(/_/) { '\_' }
+        .gsub(/\A(\d+)\. /) { "#{$1}\\. " }
+    end
+
+    def camel_to_snake(string)
+      string.gsub(/([A-Z])/, '_\1').downcase.sub(/\A_/, "")
+    end
+
+    def node_name_in?(node, names)
+      node.respond_to?(:node_name) && names.include?(node.node_name)
+    end
+
+    def has_descendant_named?(node, names)
+      return false unless node.respond_to?(:css)
+
+      selector = names.map(&:downcase).join(",")
+      node.css(selector).any?
+    end
+  end
+end

data/lib/turndown/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Turndown
+  VERSION = "1.0.0"
+end

data/lib/turndown.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Turndown converts HTML to Markdown.
+#
+# This is an unofficial Ruby port of Turndown by Dom Christie
+# (https://github.com/mixmark-io/turndown), released under the MIT License.
+# It is not affiliated with or endorsed by the upstream project.
+
+require "nokogiri"
+
+require_relative "turndown/version"
+require_relative "turndown/utilities"
+require_relative "turndown/rule"
+require_relative "turndown/rules"
+require_relative "turndown/node"
+require_relative "turndown/collapse_whitespace"
+require_relative "turndown/root_node"
+require_relative "turndown/commonmark_rules"
+require_relative "turndown/converter"
+require_relative "turndown/plugins/gfm"

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: turndown
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Devran Cosmo Uenal
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+description: A Nokogiri-backed Ruby port of Turndown and turndown-plugin-gfm, verified
+  against the upstream fixture corpus. Unofficial and not affiliated with the upstream
+  JavaScript project.
+email:
+- devran@bavmind.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/turndown.rb
+- lib/turndown/collapse_whitespace.rb
+- lib/turndown/commonmark_rules.rb
+- lib/turndown/converter.rb
+- lib/turndown/node.rb
+- lib/turndown/plugins/gfm.rb
+- lib/turndown/root_node.rb
+- lib/turndown/rule.rb
+- lib/turndown/rules.rb
+- lib/turndown/utilities.rb
+- lib/turndown/version.rb
+homepage: https://github.com/bavmind/turndown
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bavmind/turndown
+  source_code_uri: https://github.com/bavmind/turndown/tree/v1.0.0
+  changelog_uri: https://github.com/bavmind/turndown/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/bavmind/turndown/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Convert HTML to Markdown. An unofficial Ruby port of Turndown.
+test_files: []