html-renderer 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff38e106acb336902c8cfbfec5dff664be97cd9363741a610fc9ffe619d9bd02
-  data.tar.gz: d3a8b5ce270e4229d7821062696df741765f0911ba2f428dbc705ec6611b1322
+  metadata.gz: d3c17a79e5d484dfafbdf2161683d28c8ee9d24b3ec099c7e392236fe167f547
+  data.tar.gz: 4c0cc61cc44691ab2e35b2c289f352fe17aec1d499cd01d86b6a01f4a3a9dab6
 SHA512:
-  metadata.gz: 5d370198a4ae836fb62b37030cba865d00d08cfd87c5bf37ea24b26e1c34be827bf36c2f5f3f10333d9ad81e1f2bcc3559491025b80c8fa14a08cd073d1f4e59
-  data.tar.gz: cd0d53f4d19c32073d519d83b3023aba9c5228c8ecac590943d9a2364c2092e201f49aff59fbfb1a2dfc50616b4f27ed697e470d5377454aec170f13d50f37af
+  metadata.gz: 52f7781a488c72b42398dad8a8a10393a3ccc1eca7147696e94398d28633d57956133a05c026364c8125b5dfcdf333a6772ec44ee786ced02ceb130e2c6c1ce2
+  data.tar.gz: 228891adf55ef0e77c958399071c0eb2a4acbc2620e3681aa59b65b56bd47dc308e5cee5b968043603388cd92e44443b7906acf93963c69513d94cceafa3f0b4

data/.gemspec

@@ -14,8 +14,8 @@ Gem::Specification.new do |s|
 
   s.files            = `git ls`.lines.map(&:strip)
   s.extra_rdoc_files = ["README.md", "LICENSE"]
-  
-  s.add_dependency "oga", "~> 2"
+
+  s.add_dependency "oga"
   s.add_dependency "terminal-table", "~> 1.8"
   s.add_dependency "term-ansicolor", "~> 1.7"
 end

data/.gitignore

@@ -0,0 +1 @@
+/pkg/

data/README.md

@@ -2,11 +2,29 @@
 
 ## Overview
 
-Allows you to subclass `HTMLRenderer::Base`, add some methods, and then parse HTML to generate custom output.
+An extensible HTML renderer.
 
-(Uses a similar API to the [RedCarpet](https://github.com/vmg/redcarpet) gem.)
+Comes with two built-in renderers:
+* `HTMLRenderer::ANSI` (outputs colored text to the termnial)
+* `HTMLRenderer::Text` (outputs plain text)
 
-## Examples
+## Usage
 
-* [HTML to Plain Text Renderer](https://github.com/epitron/html-renderer/blob/master/examples/plain_text_renderer.rb)
-* [HTML to ANSI Renderer](https://github.com/epitron/html-renderer/blob/master/examples/ansi_renderer.rb)
+Render to ANSI:
+```
+ansi_text = HTMLRenderer::ANSI.render("<b>hello html</b>")
+ansi_text = HTMLRenderer::ANSI.render(open("file.html"))
+```
+
+Render to plain text:
+```
+plain_text = HTMLRenderer::Text.render(open("file.html"))
+```
+
+## Extending it
+
+The API design uses the same philosophy as [RedCarpet](https://github.com/vmg/redcarpet).
+
+To create a new renderer, subclass `HTMLRenderer::Base`, then add a method to handle each type of element. Whatever the method returns is output by the renderer.
+
+Example renderer: [HTMLRenderer::ANSI](https://github.com/epitron/html-renderer/blob/master/lib/html-renderer/ansi.rb)

data/Rakefile

@@ -7,7 +7,7 @@ task :build do
   system "mkdir pkg/" unless File.directory? "pkg"
   system "mv #{gemfile} pkg/"
 end
- 
+
 task :release => :build do
   system "gem push pkg/#{gemfile}"
 end
@@ -17,3 +17,9 @@ task :gem => :build
 task :install => :build do
   system "gem install pkg/#{gemfile}"
 end
+
+task :test do
+  Dir.chdir "test"
+  $: << "../lib"
+  load "test.rb"
+end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.3

data/lib/html-renderer/ansi.rb

@@ -1,15 +1,21 @@
-# require 'html-renderer'
+require 'html-renderer'
 require 'ansi/mixin'
 require 'terminal-table'
-require 'coderay'
+
+###########################################################################
+
+module ANSI::Mixin
+  def grey; ANSI::Code.bold { ANSI::Code.black { to_s } }; end
+end
 
 module HTMLRenderer::ANSIStrings
   refine String do
     include ANSI::Mixin
-    def grey; self.black.bold; end
   end
 end
 
+###########################################################################
+
 class HTMLRenderer::ANSI < HTMLRenderer::Base
 
   using HTMLRenderer::ANSIStrings
@@ -34,6 +40,9 @@ private
     s&.downcase&.scan(/\w+/)&.join
   end
 
+  def subscript(s)
+    "[#{s}]"
+  end
 
 public
 
@@ -80,13 +89,7 @@ public
   end
 
   def block_code(code, language)
-    language ||= :ruby
-
-    language = language[1..-1] if language[0] == "."  # strip leading "."
-    language = :cpp if language == "C++"
-
-    require 'coderay'
-    "#{indent CodeRay.scan(code, language).term, 4}\n"
+    code.bold.cyan + "\n"
   end
 
   def block_quote(text)
@@ -176,6 +179,7 @@ public
 
 end
 
+###########################################################################
 
 if __FILE__ == $0
   puts HTMLRenderer::ANSI.render(open(ARGV.first || "test.html"))

data/lib/html-renderer/base.rb

@@ -1,30 +1,25 @@
 ######################################################################################
 require 'oga'
 ######################################################################################
-#
-# TODOs:
-# - Streaming output (yield every paragraph/div/header)
-# - Embed into 'c' tool (for rendering raw HTML blocks)
-#
-######################################################################################
-
-class String
 
-  def tighten
-    gsub(/\s+/, ' ').strip
-  end
+module HTMLRenderer
 
-  def blank?; !!self[/[^\s]/]; end
+  module STDLIBRefinements
+    refine String do
+      def tighten
+        gsub(/\s+/, ' ').strip
+      end
 
-end
+      def blank?; !!self[/[^\s]/]; end
+    end
 
-class NilClass
-  def blank?; true; end
-end
+    refine NilClass do
+      def blank?; true; end
+    end
+  end
 
-######################################################################################
+  using STDLIBRefinements
 
-module HTMLRenderer
 
   class State
     attr_accessor :list_order
@@ -72,7 +67,9 @@ private
             name    = node["name"]
             content = render_children(node, state)
 
-            if name and not url
+            if title.blank? and url.blank? and name.blank?
+              content
+            elsif name and not url
               anchor(name, title, content)
             else
               link(url, title, content)
@@ -157,8 +154,9 @@ private
             render_children(node, state)
 
           when "head", "script", "link", "style"
-            # skip it
-
+            #
+            # don't render anything
+            #
           else
             # raise "Unrecognized HTML tag: #{node.name} -> #{node.inspect}"
             $stderr.puts "Unrecognized HTML tag: #{node.name} -> #{node.inspect}"

data/lib/html-renderer/debug.rb

@@ -0,0 +1,9 @@
+require 'html-renderer'
+
+class HTMLRenderer::DebugRenderer < HTMLRenderer::Base
+
+  def method_missing(meth, *args)
+    "#{meth}(#{args})"
+  end
+
+end

data/lib/html-renderer/text.rb

@@ -1,9 +1,10 @@
-# require 'html-renderer'
+require 'html-renderer'
 
 #
-# Everything-stripping renderer.
+# Strips out everything but the plain text.
 #
 class HTMLRenderer::Text < HTMLRenderer::Base
+
   # Methods where the first argument is the text content
   [
     # block-level calls
@@ -65,8 +66,3 @@ class HTMLRenderer::Text < HTMLRenderer::Base
     content + "\t"
   end
 end
-
-
-if __FILE__ == $0
-  puts HTMLRenderer::Text.render(open("test.html"))
-end

data/test/test.rb

@@ -0,0 +1,15 @@
+require 'html-renderer'
+require 'html-renderer/debug'
+
+[
+  HTMLRenderer::ANSI,
+  HTMLRenderer::Text,
+  HTMLRenderer::DebugRenderer,
+].each do |renderer|
+  puts
+  puts "=== #{renderer} =============================="
+  puts
+  puts renderer.render(open("test.html"))
+  puts
+  puts
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: html-renderer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - epitron
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-02 00:00:00.000000000 Z
+date: 2020-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oga
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
@@ -63,25 +63,25 @@ extra_rdoc_files:
 - LICENSE
 files:
 - ".gemspec"
+- ".gitignore"
 - LICENSE
 - README.md
 - Rakefile
 - TODO.md
 - VERSION
-- examples/ansi_renderer.rb
-- examples/debug_renderer.rb
-- examples/plain_text_renderer.rb
-- examples/test.html
 - lib/html-renderer.rb
 - lib/html-renderer/ansi.rb
 - lib/html-renderer/base.rb
+- lib/html-renderer/debug.rb
 - lib/html-renderer/html_parser.rb
 - lib/html-renderer/text.rb
+- test/test.html
+- test/test.rb
 homepage: http://github.com/epitron/html-renderer/
 licenses:
 - WTFPL
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -96,8 +96,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.3
+signing_key:
 specification_version: 4
 summary: HTML Renderer
 test_files: []

data/examples/ansi_renderer.rb

@@ -1,180 +0,0 @@
-require 'html-renderer'
-require 'ansi/mixin'
-require 'terminal-table'
-require 'coderay'
-
-class String
-  include ANSI::Mixin
-
-  def grey; self.black.bold; end
-end
-
-
-class ANSIRenderer < HTMLRenderer::Base
-
-private
-
-  def indented?(text)
-    indent_sizes = text.lines.map{ |line| if line =~ /^(\s+)/ then $1 else '' end }.map(&:size)
-    indent_sizes.all? {|dent| dent > 0 }
-  end
-
-  def unwrap(text)
-    return text unless indented? text
-    text.lines.to_a.map(&:strip).join ' '
-  end
-
-  def indent(text,amount=2)
-    text.lines.map{|line| " "*amount + line }.join
-  end
-
-  def smash(s)
-    s&.downcase&.scan(/\w+/)&.join
-  end
-
-
-public
-
-  def normal_text(text)
-    text
-  end
-
-  def underline(content)
-    content.magenta.bold
-  end
-
-  def superscript(content)
-    "^(#{content})"
-  end
-
-  def link(link, title, content)
-    unless content&.[] /^Back /
-      str = ""
-      # str += "<15>#{content}</15>" if content
-      str += content.white.bold if content
-      if smash(link) != smash(content)
-        # str += " <8>(</8><11>#{link}</11><8>)</8>"
-        str += " #{"(".grey}#{link.cyan.bold}#{")".grey}"
-      end
-
-      str
-    end
-  end
-
-  def anchor(name, title=nil, content=nil)
-    result = "Anchor: ##{name}"
-    result << " (#{title})" if title
-    result << "\n"
-    result << "#{content}\n" if content
-    result
-  end
-
-  def image(link, title, content)
-    link(link, nil, title)
-  end
-
-  def italic(text)
-    text.yellow.bold
-  end
-
-  def block_code(code, language)
-    language ||= :ruby
-
-    language = language[1..-1] if language[0] == "."  # strip leading "."
-    language = :cpp if language == "C++"
-
-    require 'coderay'
-    "#{indent CodeRay.scan(code, language).term, 4}\n"
-  end
-
-  def block_quote(text)
-    indent paragraph(text)
-  end
-
-  def codespan(code)
-    code.cyan
-  end
-
-  def header(title, level, anchor=nil)
-    bar = ("-"*(title.size+4)).grey
-
-    title = case level
-      when 1 then title.bold.yellow
-      when 2 then title.bold.cyan
-      when 3 then title.bold.blue
-      else title.magenta
-    end
-
-    "#{bar}\n  #{title}\n#{bar}\n\n"
-  end
-
-  def double_emphasis(text)
-    text.bold.green
-  end
-
-  def emphasis(text)
-    text.green
-  end
-
-  def linebreak
-    "\n"
-  end
-
-  def paragraph(text)
-    div(text) + "\n"
-  end
-
-  def div(text)
-    "#{indented?(text) ? text : unwrap(text)}\n"
-  end
-
-  def list(content, list_type)
-    case list_type
-    when :ordered
-      @counter = 0
-      "#{content}\n"
-    when :unordered
-      "#{content}\n"
-    end
-  end
-
-  def list_item(content, list_type)
-    case list_type
-    when :ordered
-      @counter ||= 0
-      @counter += 1
-      # "  <8>#{@counter}.</8> #{content.strip}\n".colorize
-      "  #{@counter.to_s.grey}. #{content.strip}\n"
-    when :unordered
-      # "  <8>*</8> #{content.strip}\n".colorize
-      "  #{"*".grey} #{content.strip}\n"
-    end
-  end
-
-  def definition_list(defs)
-    defs.each do |dt, dd|
-      puts "<15>#{dt}<7>:".colorize
-      puts "  #{dd}"
-      puts
-    end
-  end
-
-  def table(header, rows)
-    if header
-      table = Terminal::Table.new(headings: header, rows: rows)
-    else
-      table = Terminal::Table.new(rows: rows)
-    end
-    "#{table}\n\n"
-  end
-
-  def separator
-    "_____________________________\n\n"
-  end
-
-end
-
-
-if __FILE__ == $0
-  puts ANSIRenderer.render(open(ARGV.first || "test.html"))
-end

data/examples/debug_renderer.rb

@@ -1,14 +0,0 @@
-require 'html-renderer'
-
-class DebugRenderer < HTMLRenderer::Base
- 
-  def method_missing(meth, *args)
-    "#{meth}(#{args})"
-  end
-
-end
-
-
-if __FILE__ == $0
-  puts DebugRenderer.render(open("test.html"))
-end

data/examples/plain_text_renderer.rb

@@ -1,72 +0,0 @@
-require 'html-renderer'
-
-#
-# Everything-stripping renderer.
-#
-class PlainTextRenderer < HTMLRenderer::Base
-  # Methods where the first argument is the text content
-  [
-    # block-level calls
-    :block_code, :block_quote,
-    :block_html, :list, :list_item,
-
-    # span-level calls
-    :autolink, :codespan, :double_emphasis,
-    :emphasis, :underline, :raw_html,
-    :triple_emphasis, :strikethrough,
-    :superscript, :highlight,
-
-    # footnotes
-    :footnotes, :footnote_def, :footnote_ref,
-
-    # low level rendering
-    :entity, :normal_text
-  ].each do |method|
-    define_method method do |*args|
-      args.first
-    end
-  end
-
-  # Other methods where we don't return only a specific argument
-  def link(link, title, content)
-    "#{content} (#{link})"
-  end
-
-  def image(link, title, content)
-    content &&= content + " "
-    "#{content}#{link}"
-  end
-
-  def div(text)
-    text + "\n"
-  end
-
-  def paragraph(text)
-    div(text) + "\n"
-  end
-
-  def separator
-    "______________________\n\n"
-  end
-
-  def header(text, header_level)
-    text + "\n"
-  end
-
-  def table(header, body)
-    "#{header}#{body}"
-  end
-
-  def table_row(content)
-    content + "\n"
-  end
-
-  def table_cell(content, alignment)
-    content + "\t"
-  end
-end
-
-
-if __FILE__ == $0
-  puts PlainTextRenderer.render(open("test.html"))
-end