random-words 1.0.5 → 1.0.7

data/lib/random-words/html2markdown.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'nokogiri'
+require_relative 'table-cleanup'
+
+module RandomWords
+  # Convert HTML to Markdown
+  class HTML2Markdown
+    attr_reader :markdown
+
+    # Initialize the HTML2Markdown converter
+    # @param str [String] The HTML string to convert
+    # @param baseurl [String] The base URL for resolving relative links
+    def initialize(str, baseurl = nil)
+      @links = []
+      @baseuri = (baseurl ? URI.parse(baseurl) : nil)
+      @section_level = 0
+      @encoding = str.encoding
+      @markdown = output_for(Nokogiri::HTML(str, baseurl).root).gsub(/\n\n\n+/, "\n\n\n")
+    end
+
+    # Convert the HTML to Markdown
+    # @return [String] The converted Markdown string
+    # @example
+    #   converter = HTML2Markdown.new('<p>Hello world</p>')
+    #   puts converter.to_s
+    def to_s
+      i = 0
+      @markdown = TableCleanup.new(@markdown).clean
+      "#{@markdown}\n\n" + @links.map { |link|
+        i += 1
+        "[#{i}]: #{link[:href]}" + (link[:title] ? %( "#{link[:title]}") : '')
+      }.join("\n")
+    end
+
+    # Recursively convert child nodes
+    # @param node [Nokogiri::XML::Node] The parent node
+    def output_for_children(node)
+      node.children.map do |el|
+        output_for(el)
+      end.join
+    end
+
+    # Add a link to the list of links
+    # @param link [Hash] The link to add
+    def add_link(link)
+      if @baseuri
+        begin
+          link[:href] = URI.parse(link[:href])
+        rescue Exception
+          link[:href] = URI.parse('')
+        end
+        link[:href].scheme = @baseuri.scheme unless link[:href].scheme
+        unless link[:href].opaque
+          link[:href].host = @baseuri.host unless link[:href].host
+          link[:href].path = @baseuri.path.to_s + '/' + link[:href].path.to_s if link[:href].path.to_s[0] != '/'
+        end
+        link[:href] = link[:href].to_s
+      end
+      @links.each_with_index do |l, i|
+        return i + 1 if l[:href] == link[:href]
+      end
+      @links << link
+      @links.length
+    end
+
+    # Wrap a string to 74 characters
+    # @param str [String] The string to wrap
+    # @return [String] The wrapped string
+    def wrap(str)
+      return str if str =~ /\n/
+
+      out = []
+      line = []
+      str.split(/[ \t]+/).each do |word|
+        line << word
+        if line.join(' ').length >= 74
+          out << line.join(' ')
+          line = []
+        end
+      end
+      out << (line.join(' ') + (str[-1..-1] =~ /[ \t\n]/ ? str[-1..-1] : ''))
+      out.join("\n")
+    end
+
+    # Convert a node to Markdown
+    # @param node [Nokogiri::XML::Node] The node to convert
+    # @return [String] The converted Markdown string
+    def output_for(node)
+      case node.name
+      when 'head', 'style', 'script'
+        ''
+      when 'br'
+        "  \n"
+      when 'p', 'div'
+        "\n\n#{output_for_children(node)}\n\n"
+      when 'section', 'article'
+        @section_level += 1
+        o = "\n\n----\n\n#{output_for_children(node)}\n\n"
+        @section_level -= 1
+        o
+      when /h(\d+)/
+        "\n\n" + (('#' * (::Regexp.last_match(1).to_i + @section_level)) + ' ' + output_for_children(node)) + "\n\n"
+      when /mark/
+        "==#{output_for_children(node)}=="
+      when 'blockquote'
+        @section_level += 1
+        o = "\n\n> #{output_for_children(node).lstrip.gsub("\n", "\n> ")}\n\n".gsub(/> \n(> \n)+/, "> \n")
+        @section_level -= 1
+        o
+      when 'cite'
+        "*#{output_for_children(node)}*"
+      when 'ul'
+        "\n\n" + node.children.map { |el|
+          next if el.name == 'text'
+
+          "* #{output_for_children(el).gsub(/^(\t)|(    )/, "\t\t").gsub(/^>/, "\t>")}\n"
+        }.join + "\n\n"
+      when 'ol'
+        i = 0
+        "\n\n" + node.children.map { |el|
+          next if el.name == 'text'
+
+          i += 1
+          "#{i}. #{output_for_children(el).gsub(/^(\t)|(    )/, "\t\t").gsub(/^>/, "\t>")}\n"
+        }.join + "\n\n"
+      when 'code'
+        if @in_pre
+          @in_pre = false
+          node.text.strip
+        else
+          "`#{output_for_children(node).gsub("\n", ' ')}`"
+        end
+      when 'pre'
+        @in_pre = true
+        lang = node['lang'] || node['language']
+        lang = '' if lang.nil? || lang.empty?
+        "\n\n```#{lang}\n" + output_for_children(node).lstrip + "\n```\n\n"
+      when 'hr'
+        "\n\n----\n\n"
+      when 'a', 'link'
+        link = { href: node['href'], title: node['title'] }
+        "[#{output_for_children(node).gsub("\n", ' ')}][#{add_link(link)}]"
+      when 'img'
+        link = { href: node['src'], title: node['title'] }
+        "![#{node['alt']}][#{add_link(link)}]"
+      when 'video', 'audio', 'embed'
+        link = { href: node['src'], title: node['title'] }
+        "[#{output_for_children(node).gsub("\n", ' ')}][#{add_link(link)}]"
+      when 'object'
+        link = { href: node['data'], title: node['title'] }
+        "[#{output_for_children(node).gsub("\n", ' ')}][#{add_link(link)}]"
+      when 'i', 'em', 'u'
+        "_#{output_for_children(node)}_"
+      when 'b', 'strong'
+        "**#{output_for_children(node)}**"
+      when 'dl'
+        "\n\n" + node.children.map do |el|
+          case el.name
+          when 'dt'
+            "#{output_for_children(el)}\n"
+          when 'dd'
+            ": #{output_for_children(el)}\n\n"
+          end
+        end.join + "\n\n"
+      # Tables are not part of Markdown, so we output WikiCreole
+      when 'table'
+        @table_header = true
+        node.children.select do |c|
+          %w[tr tbody thead].include?(c.name)
+        end.map do |c|
+          output_for(c)
+        end.join
+      when 'tr'
+        header = "\n"
+        if @table_header
+          @table_header = false
+          cells = node.children.select do |c|
+            %w[th td].include?(c.name)
+          end.count
+          header = "\n|#{cells.times.map { '-------' }.join('|')}|\n"
+        end
+        node.children.select do |c|
+          %w[th td].include?(c.name)
+        end.map do |c|
+          output_for(c)
+        end.join.gsub('||', '|') + header
+      when 'th', 'td'
+        "| #{output_for_children(node)} |"
+      when 'text'
+        # Sometimes Nokogiri lies. Force the encoding back to what we know it is
+        if (c = node.content.force_encoding(@encoding)) =~ /\S/
+          c.gsub!(/\n\n+/, '<$PreserveDouble$>')
+          c.gsub!(/\s+/, ' ')
+          c.gsub('<$PreserveDouble$>', "\n\n")
+        else
+          c
+        end
+      else
+        output_for_children(node)
+      end
+    end
+  end
+end

data/lib/random-words/lorem-markdown.rb

@@ -0,0 +1,397 @@
+# frozen_string_literal: true
+
+module RandomWords
+  # Generates random Lorem Ipsum text in Markdown format.
+  class LoremMarkdown
+    # Stores the output
+    attr_accessor :output
+
+    # Stores the RandomWords::Generator
+    attr_accessor :generator
+
+    # Generates random Lorem Ipsum text.
+    # @param options [Hash] Options for generating Lorem Ipsum text.
+    # @return [String] A string of random Lorem Ipsum text.
+    def initialize(options = {})
+      @added = {
+        em: false,
+        strong: false,
+        link: false,
+        code: false,
+        mark: false
+      }
+
+      defaults = {
+        source: :latin,
+        grafs: 10,
+        sentences: 5,
+        length: :medium,
+        decorate: true,
+        link: false,
+        ul: false,
+        ol: false,
+        dl: false,
+        bq: false,
+        code: false,
+        mark: false,
+        headers: false,
+        table: false
+      }
+
+      @options = defaults.merge(options)
+
+      @generator = RandomWords::Generator.new(@options[:source], {
+                                                sentence_length: @options[:length],
+                                                paragraph_length: @options[:sentences]
+                                              })
+
+      @output = ''
+      strong = @options[:decorate]
+      em = @options[:decorate]
+      links = @options[:link]
+      code = @options[:code]
+      mark = @options[:mark]
+      force = []
+      # Generate the specified number of paragraphs.
+      @options[:grafs].times.with_index do |_, i|
+        @output += paragraph(1, em: em, strong: strong, links: links, code: code, mark: mark, force: force)
+        em = Random.rand(0..3).zero? && @options[:decorate]
+        strong = Random.rand(0..3).zero? && @options[:decorate]
+        links = Random.rand(0..3).zero? && @options[:link]
+        code = Random.rand(0..3).zero? && @options[:code]
+
+        if i == @options[:grafs] - 2
+          force << :code if !@added[:code] && @options[:code]
+          force << :link if !@added[:link] && @options[:link]
+          force << :em if !@added[:em] && @options[:decorate]
+          force << :strong if !@added[:strong] && @options[:decorate]
+        end
+        @output += "\n\n"
+      end
+
+      generate
+    end
+
+    # Use the RandomWords class to generate the Lorem Ipsum text.
+    def generate
+      compress_newlines
+
+      items = { short: 4, medium: 8, long: 10, very_long: 12 }[@options[:length]]
+
+      if @options[:ul] && @options[:ol]
+        # If both unordered and ordered lists are specified, add them both.
+        inject_block(1, -> { list(items, :ul) })
+        inject_block(1, -> { list(items, :ol) })
+      elsif @options[:ul]
+        # If only unordered list is specified, add it.
+        inject_block(2, -> { list(items, :ul) })
+      elsif @options[:ol]
+        # If only ordered list is specified, add it.
+        inject_block(2, -> { list(items, :ol) })
+      end
+
+      # Add definition list if specified.
+      inject_block(1, -> { list(items, :dl) }) if @options[:dl]
+
+      # Add blockquote if specified.
+      inject_block(1, -> { blockquote(items / 2) }) if @options[:bq]
+
+      # Add headers if specified.
+      inject_headers if @options[:headers]
+
+      # Add code block if specified.
+      inject_block(1, -> { code }) if @options[:code]
+
+      # Add table if specified.
+      inject_block(1, -> { table }) if @options[:table]
+
+      ensure_block_newlines
+      compress_newlines
+    end
+
+    private
+
+    # Rolls for zero with the specified odds.
+    def roll(odds)
+      Random.rand(0..odds).zero?
+    end
+
+    # Generates a list of items.
+    # @param [Integer] count The number of items to generate.
+    # @param [Symbol] type The type of list to generate (:ul, :ol, :dl).
+    # @return [String] The generated list.
+    def list(count, type)
+      ul = "\n\n<#{type}>\n"
+
+      count.times do
+        links = roll(4) && @options[:link]
+        em = roll(2) && @options[:decorate]
+        strong = roll(2) && @options[:decorate]
+        code = roll(4) && @options[:code]
+        mark = roll(6) && @options[:mark]
+        frag = fragment(1, 4).cap_first
+        long_frag = fragment(4, 8).cap_first
+        long_frag = inject_inline(long_frag, -> { link }) if links
+        long_frag = inject_inline(long_frag, -> { emphasis(:em) }) if em
+        long_frag = inject_inline(long_frag, -> { emphasis(:strong) }) if strong
+        long_frag = inject_inline(long_frag, -> { code_span }, 1) if code
+        long_frag = inject_inline(long_frag, -> { emphasis(:mark) }, 1) if mark
+        long_frag = long_frag.restore_spaces if links
+        if type == :dl
+          ul += "\t<dt>#{frag}</dt>\n"
+          ul += "\t<dd>#{long_frag}</dd>\n"
+        else
+          ul += "\t<li>#{long_frag}</li>\n"
+        end
+      end
+      ul + "</#{type}>\n\n"
+    end
+
+    # Generates a blockquote.
+    # @param [Integer] count The number of items to generate.
+    # @param [Boolean] nested Whether the blockquote is nested.
+    # @return [String] The generated blockquote.
+    def blockquote(count, nested = false)
+      if count > 1 && !nested
+        level1 = Random.rand(1..count - 1).to_i
+        level2 = count - level1
+      else
+        level1 = 1
+        level2 = 0
+      end
+      cite = "\n<cite>— #{@generator.name}</cite>\n" unless nested
+      newline = nested ? '' : "\n\n"
+      quote = "#{newline}<blockquote>\n"
+      quote += paragraph(level1,
+                         em: @options[:decorate],
+                         strong: @options[:decorate],
+                         links: @options[:link],
+                         code: @options[:code],
+                         mark: @options[:mark]).gsub(
+                           /\n+/, "\n"
+                         )
+      quote += blockquote(level2, true).strip if level2.positive?
+      "#{quote}#{cite}</blockquote>#{newline}"
+    end
+
+    # Generates a header.
+    # @param [Integer] level The level of the header (1-6).
+    # @return [String] The generated header.
+    def header(level)
+      level = 6 if level > 6
+      pre = level > 1 ? "\n\n" : ''
+      h = "#{pre}<h#{level}>"
+      h += fragment(2, 8).cap_first
+      h + "</h#{level}>\n\n"
+    end
+
+    # Injects headers in the output. Number injected depends on overall length
+    # of the input.
+    # @return [String] The output with injected headers.
+    def inject_headers
+      count = if @options[:grafs] == 1
+                1
+              elsif @options[:grafs] <= 3
+                2
+              elsif @options[:grafs] <= 5
+                4
+              elsif @options[:grafs] == 6
+                5
+              else
+                6
+              end
+      grafs = @output.split("\n\n").reverse
+
+      @output = header(1)
+      @output += "#{grafs.slice!(-1)}\n\n"
+
+      if count == 1
+        grafs = grafs.reverse
+        @output += grafs.join("\n\n")
+        return
+      end
+
+      level = 2
+
+      c = (grafs.length / count).to_i
+
+      while grafs.any? && level <= count
+        @output += header(level)
+        @output += grafs.slice!(grafs.length - c, c).join("\n\n")
+        level += 1
+      end
+      @output += grafs.join("\n\n")
+      compress_newlines
+    end
+
+    # Generates a random table. Length is determined by @options[:length]
+    # @return [String] The generated table.
+    def table
+      items = { short: 2, medium: 2, long: 4, very_long: 6 }[@options[:length]]
+      # Generates a random table.
+      table = "\n\n<table>\n"
+      table += "\t<tr>\n"
+      items.times do
+        table += "\t\t<th>#{fragment(1, 2).cap_first}</th>\n"
+      end
+      table += "\t</tr>\n"
+      items.times do
+        table += "\t<tr>\n"
+        items.times do
+          table += "\t\t<td>#{Random.rand(10_000)}</td>\n"
+        end
+        table += "\t</tr>\n"
+      end
+      table += "</table>\n\n"
+      table
+    end
+
+    # Generates a random code block
+    # @return [String] The generated code block.
+    def code
+      lang = @generator.code_lang
+      code = "\n\n<pre lang=\"#{lang}\"><code>\n"
+      code += "#{@generator.code_snippet(lang)}\n"
+      "#{code}</code></pre>\n\n"
+    end
+
+    # Generates a random code span
+    def code_span
+      @added[:code] = true
+      code = '<code>'
+      code += "#{@generator.words(Random.rand(1..5))} "
+      "#{code.strip}</code>"
+    end
+
+    # Generates a random emphasis tag
+    # @param [String] tag The tag to use for emphasis.
+    def emphasis(tag)
+      @added[tag] = true
+      "<#{tag}>#{fragment(1, 4)}</#{tag}>"
+    end
+
+    # Generates a random link
+    # @return [String] The generated link.
+    def link
+      @added[:link] = true
+      path = "/#{path_string(4, 8)}/#{path_string(4, 8)}"
+      title = fragment(4, 8).cap_first
+      "<a%%href=\"https://example.com#{path}\"%%title=\"#{title.preserve_spaces}\">#{fragment(1,
+                                                                                              8).cap_first}</a>"
+    end
+
+    # Injects a block of text into the output.
+    # @param [Integer] count The number of blocks to inject.
+    # @param [Proc] block The block whose result to inject.
+    def inject_block(count, block)
+      grafs = @output.split("\n\n")
+
+      len = if grafs.length < 2
+              1
+            else
+              Random.rand(1..grafs.length / 2).to_i
+            end
+
+      @output = "#{grafs.slice!(0, len).join("\n\n")}\n\n"
+
+      # count = { short: 4, medium: 8, long: 10, very_long: 12 }[@options[:length]]
+      @output += block.call
+      added = 1
+      while grafs.any?
+        len = Random.rand(1..grafs.length)
+
+        @output += "#{grafs.slice!(0, len).join("\n\n")}\n\n"
+        if added < count
+          @output += block.call
+          added += 1
+        end
+      end
+
+      compress_newlines
+    end
+
+    # Injects inline text into the output.
+    # @param [String] text The text to inject into.
+    # @param [Proc] block The block whose result to inject.
+    # @param [Integer] max The maximum number of times to inject the block.
+    def inject_inline(text, block, max = nil)
+      max ||= { short: 1, medium: 2, long: 3, very_long: 4 }[@options[:length]]
+
+      words = text.split(' ')
+      out = []
+      count = 0
+      while words.any?
+        if count >= max
+          out << words.slice!(0..-1)
+          break
+        else
+          el = block.call
+          out << words.slice!(0..Random.rand(1..words.length))
+          out << el if words.any?
+          count += 1
+        end
+      end
+      out.join(' ').term
+    end
+
+    # Generates a paragraph of Lorem Ipsum text.
+    # The `words` method generates a specified number of words.
+    # @param [Integer] count The number of paragraphs to generate.
+    # @param [Boolean] em Whether to include emphasis tags.
+    # @param [Boolean] strong Whether to include strong tags.
+    # @param [Boolean] links Whether to include links.
+    # @param [Boolean] code Whether to include code tags.
+    # @param [Boolean] mark Whether to include mark tags.
+    # @param [Array] force An array of tags to force.
+    # @return [String] The generated paragraph.
+    def paragraph(count, em: false, strong: false, links: false, code: false, mark: false, force: [])
+      output = ''
+      s = { short: 2, medium: 4, long: 6, very_long: 8 }[@options[:length]]
+      count.times do
+        p = @generator.sentences(s).join(' ')
+
+        should_em = force.include?(:em) || (em && roll(1))
+        should_strong = force.include?(:strong) || (strong && roll(1))
+        should_code = force.include?(:code) || (code && roll(6))
+        should_link = force.include?(:links) || (links && roll(4))
+        should_mark = force.include?(:mark) || (mark && roll(8))
+        p = inject_inline(p, -> { link }) if should_link
+        p = inject_inline(p, -> { emphasis('em') }) if should_em
+        p = inject_inline(p, -> { emphasis('strong') }) if should_strong
+        p = inject_inline(p, -> { emphasis('mark') }, 1) if should_mark
+        p = inject_inline(p, -> { code_span }, 1) if should_code
+
+        output += "<p>#{p.restore_spaces.cap_first.term('.')}</p>\n\n"
+      end
+      output
+    end
+
+    # Find block level tags and add newlines around them.
+    def ensure_block_newlines
+      # Adds newlines around block level tags.
+      @output.gsub!(/(<(h\d|div|blockquote|dl|ul|ol)>)/, "\n\n\\1")
+      @output.gsub!(%r{(</(h\d|div|blockquote|dl|ul|ol)>)\s*}, "\\1\n\n")
+    end
+
+    # Compresses newlines in the output.
+    # This method removes extra newlines from the output.
+    def compress_newlines
+      @output.compress_newlines!
+    end
+
+    # Generates a random fragment of text.
+    # The `words` method generates a specified number of words.
+    # @param [Integer] min The minimum number of words to generate.
+    # @param [Integer] max The maximum number of words to generate.
+    # @return [String] The generated fragment.
+    def fragment(min, max)
+      @generator.words(Random.rand(min..max)).no_term(generator.terminators).downcase_first
+    end
+
+    # Generates a random string of characters.
+    # The `characters` method generates a specified number of characters.
+    def path_string(min, max)
+      @generator.characters(min, max, whole_words: false, whitespace: false).downcase
+    end
+  end
+end