fastreader 1.0.0

data/lib/curses_controller.rb

@@ -0,0 +1,176 @@
+require 'curses'
+require 'iconv'
+include Curses
+
+class CursesController
+  include EntriesController
+  include FeedsController
+  include EntryController
+
+  def log(statement)
+    LOGGER.debug(statement)
+  end
+
+  def show_help(text)
+    @command_window.escape_help_prompt
+    @help_window = Curses::Window.new(@scr.maxy - 4, @scr.maxx, 0, 0) 
+    @text_area = Curses::Window.new(@scr.maxy - 4, @scr.maxx - 4, 2, 5)  
+    @help_window.clear
+    @text_area.addstr(PREAMBLE)
+    @text_area.addstr(text)
+    @text_area.addstr(FOOTER)
+    @help_window.refresh
+    @text_area.refresh
+    @scr.getch
+    @text_area.close
+    @help_window.close
+  end
+
+  PREAMBLE = <<END
+FastReader Terminal Feed Reader Command Reference
+
+END
+
+  FOOTER = <<END
+
+                                      by Daniel Choi, June 2008
+                                      Cambridge, Massachusetts, USA
+                                      dhchoi@gmail.com
+
+                                      License: GPL 
+END
+
+
+  FEEDS_MENU_COMMANDS = <<-END
+Feed Menu Navigation
+
+The standard Vi bindings h, j, k, l move left, down, up, and right. You can
+also use the arrow keys. Right in this case drills down the hierachy
+(goes from the feed list to the entry list for a feed to an entry), while
+left goes back up the hierarchy.
+
+You can prefix a up or down movement command with a number to go that many
+steps in that direction.
+
+CTRL-f                    Page down
+CTRL-b                    Page up
+H                         Move to top of screen
+M                         Move to top middle of screen 
+L                         Move to bottom of screen
+G                         Move to last item
+1G                        Move to first item
+l, RIGHT ARROW, RETURN    Select a feed and display its entries
+
+You can also type the feed's number and press RETURN or RIGHT ARROW to select
+it.
+
+Actions
+
+q       Quit the program
+u       Updates the feed; won't update with last update was within the last hour
+U       Forces an update of the feed
+CTRL-u  Updates all feeds
+        * It's better to update the feeds from the command line because the
+        feedback if easier to follow. Use the command 'fastreader update'.
+d       Deletes the feed. This will also delete any flagged items from this feed.
+a       Adds a feed; enter the url of the webpage with a feed autodiscovery link
+        or the URL of the feed itself
+/       Start a global search; asks for a search string and will find all entry
+        items in the database that match
+
+  END
+
+  ENTRIES_MENU_COMMANDS = <<-END
+Feed Items Navigation
+
+The standard Vi bindings h, j, k, l move left, down, up, and right. You can
+also use the arrow keys. Right in this case drills down the hierachy
+(goes from the feed list to the item list for a feed to an item), while
+left goes back up the hierarchy.
+
+You can prefix a up or down movement command with a number to go that many
+steps in that direction.
+
+CTRL-f  Page down
+CTRL-b  Page up
+H       Move to top of screen
+M       Move to top middle of screen 
+L       Move to bottom of screen
+G       Move to last item
+1G      Move to first item
+l, RIGHT ARROW, RETURN    Select an item and display its content
+
+Actions
+
+q     Quit the program
+/     Start a local search of the item titles. This lets you jump to a
+      particular item quickly. 
+s, *  Flag an item. Flagged items appears in a virtual feed called
+      "Flagged Entries."
+A     Flag all items in the list
+Z     Unflag all items in the list
+D     Delete all the items from the cursor position downward. Flagged items will
+      be preserved.
+u     Updates the feed; won't update with last update was within the last hour
+U     Forces an update of the feed
+  END
+
+  ENTRY_PAGE_COMMANDS = <<-END
+Feed Item Content Navigation
+
+j, DOWN ARROW, CTRL-f     Page down (if there is more than one page)
+k, UP ARROW, CTRL-b       Page up 
+h, LEFT ARROW             Go back to entries list
+l, RIGHT ARROW, RETURN    Go to the web page linked to this entry. 
+
+By default, the command to open the web browser is "open {url}." This works out
+of the box on Mac OS X. You can change this command by setting your shell's
+FASTREADER_WEB environmental variable. Currently, in-terminal text browsers like
+elinks do not work with Fastreader.  Hopefully this will change.
+
+
+>, .  Go to next entry in the list
+<, ,  Go to previous entry in the list
+
+Actions
+
+q     Quit the program
+s, *  Flag an entry. Flagged entries appears in a virtual feed called
+      "Flagged Entries."
+\\     Show raw entry content markup
+
+  END
+
+  def initialize(formatter)
+    # Formatter is the Display class. Should change the variable names to match the class
+    # names or vice versa.
+    @formatter = formatter
+    @scr = init_screen
+    noecho
+    cbreak
+    Color.init
+    curs_set(0)
+    @scr.keypad = true
+    log "Screen width: #{@scr.maxx} | Screen height: #{@scr.maxy}."
+    log "Command window initilized."
+  end
+
+  def key_buffer(initial_char)
+    c = initial_char
+    buffer = []
+    printable = (33..126).to_a
+    while printable.include?(c) && c.chr =~ /\d/
+      LOGGER.debug("detecting a multiplier: #{c.chr}")
+      # TODO This code doesn't work right
+      buffer << c.chr.to_i
+      c = @scr.getch
+    end
+    return c, buffer
+  end
+
+  def control_key(character)
+    character[0] - 64
+  end
+
+end
+

data/lib/curses_extensions.rb

@@ -0,0 +1,161 @@
+# This code is taken from Takashi Nakamoto's GPLType example program
+
+#################################################################
+# Curses::Key
+#################################################################
+module Curses::Key
+  BS = 8
+  HT = 9
+  LF = 10
+  CR = 13
+  ESC = 27
+  SP = 32
+  DEL = 127
+
+  KEY_GROUP = {
+    :backspace => [BS, BACKSPACE, DEL],
+    :escape => [ESC, BREAK],
+    :space => [SP, HT],
+    :enter => [ENTER, LF, CR],
+    :printable => (33..126).to_a,
+  }
+
+  def match?(key_type, key_code)
+    if key_type.is_a?(Array)
+      key_type.map{ |type| KEY_GROUP[type].include?(key_code)}.include?(true)
+    elsif key_type.is_a?(Symbol)
+      KEY_GROUP[key_type].include?(key_code)
+    else
+      false
+    end
+  end
+  module_function :match?
+end
+
+#################################################################
+# Curses::Color
+#################################################################
+module Curses::Color
+  RED = Curses::COLOR_RED
+  BLUE = Curses::COLOR_BLUE
+  GREEN = Curses::COLOR_GREEN
+  YELLOW = Curses::COLOR_YELLOW
+  MAGENTA = Curses::COLOR_MAGENTA
+  CYAN = Curses::COLOR_CYAN
+  WHITE = Curses::COLOR_WHITE
+  BLACK = Curses::COLOR_BLACK
+
+  COLOR_STYLES = {
+  # :name => [foreground, background],
+    :default => [WHITE, BLACK],
+    :red => [RED, BLACK],
+    :blue => [BLUE, BLACK],
+    :green => [GREEN, BLACK],
+    :yellow => [YELLOW, BLACK],
+    :magenta => [MAGENTA, BLACK],
+    :cyan => [CYAN, BLACK],
+    :wrong => [RED, BLACK],
+    :wrong_space => [RED, RED],
+    :correct => [BLUE, BLACK],
+    :ok => [CYAN, BLACK],
+    :highscore => [GREEN, BLACK],
+    :search_string => [WHITE, BLUE],
+    :mistype => [RED, BLACK],
+  }
+
+  @@color_pair = {}
+  @@use_color = false
+
+  def init
+    @@use_color = Curses.has_colors?
+    return if @@use_color == false
+
+    Curses::start_color # background becomes black
+
+    n = 1
+    defined_pair = {}
+
+    COLOR_STYLES.each do |name, pair|
+      if defined_pair.include?(pair)
+        @@color_pair[name] = Curses::color_pair(defined_pair[pair])
+      else
+        Curses::init_pair(n, pair[0], pair[1])
+        @@color_pair[name] = Curses::color_pair(n)
+        defined_pair[pair] = n
+        n += 1
+      end
+    end
+  end
+  module_function :init
+
+  # Return the result of Curses::color_pair, or nil if the specified
+  # name is not defined or the terminal doesn't support color
+  def pair(name)
+    @@use_color ? @@color_pair[name] : nil
+  end
+  module_function :pair
+end
+
+#################################################################
+# Curses::Window
+#################################################################
+class Curses::Window
+  alias :width :maxx
+  alias :height :maxy
+
+  alias :_orig_addstr :addstr
+  def addstr(str, color_name = nil, align = nil, ref = false)
+    # color style on
+    if color_name && Curses::Color.pair(color_name)
+      attron(Curses::Color.pair(color_name))
+    end
+
+    # set alignment
+    case(align)
+    when :left
+      setpos(cury, 0)
+    when :right
+      setpos(cury, width - str.size)
+    when :center
+      setpos(cury, (width - str.size) / 2)
+    end
+
+    # draw
+    _orig_addstr(str)
+
+    # color style off
+    if color_name && Curses::Color.pair(color_name)
+      attroff(Curses::Color.pair(color_name))
+    end
+
+    # refresh is required
+    refresh if ref
+  end
+
+  def next_line
+    setpos(cury + 1, 0)
+  end
+
+  def set_title(title, align = :center)
+    return if width <= 6 # too small to show title
+
+    orig_cur = {:x => curx, :y => cury}
+
+    # shrink title
+    title = title[0...(width-6)] if (title.size + 6) > width
+
+    case(align)
+    when :left
+      setpos(0, 2)
+    when :right
+      setpos(0, width - title.size - 4)
+    else # :center
+      setpos(0, (width - title.size) / 2 - 1)
+    end
+    addstr(" #{title} ")
+
+    setpos(orig_cur[:y], orig_cur[:x])
+  end
+end
+
+

data/lib/display.rb

@@ -0,0 +1,232 @@
+require File.dirname(__FILE__) + '/htmlentities'
+require 'hpricot'
+require 'highline/import'
+require 'active_support/core_ext/string/unicode'
+# This class formats stuff for human consumption
+
+class Display
+  include CharacterCleaner
+
+  attr_reader :width
+  # In the future, may allow configuration options here, so that you can 
+  # customize the Display object.
+  def initialize(options={})
+    # could opt for :no_links
+    @options = options
+    @width = options[:width] || 80
+  end
+
+  def list_feeds(feeds)
+    if @options[:curses]
+      CursesController.new(self).show_feeds(feeds)
+    else
+      feeds.each {|f| display_feed(f)}
+    end
+  end
+
+
+  def display_entries(entries)
+    if @options[:curses]
+      CursesController.new(self).show_entries(entries)
+    else
+      entries.each do |e| 
+        puts '-' * @width
+        puts display_entry(e)
+      end
+    end
+  end
+
+  def display_entry(entry, show_title_and_feed = true)
+    out = []
+    if show_title_and_feed
+      out << "#{entry.feed.title} | #{entry.last_updated.strftime('%A, %B %d %Y')}"
+      out << wrap_text(html_to_text(entry.title.strip))
+    end
+    
+    # description is the summary, so mark it as such 
+    if entry.description && entry.content && (entry.description.strip.length < entry.content.strip.length)
+      out << "Entry Summary:\n\n" + html_to_text(entry.description).strip
+      out << divider.strip
+      out << "Entry Content:"
+    end
+
+    # If there is no content, just print the description
+    if entry.content.nil? || entry.content.strip == ''
+      out << html_to_text(entry.description || '').strip
+    else
+      out << html_to_text(entry.content || '').strip
+    end
+   
+    unless @options[:simple]
+      out << entry.url
+    end
+    unless entry.categories.empty?
+      out << "Categories: #{entry.categories.join(", ")}"
+    end
+    out.join("\n\n")
+  end
+
+  def display_title_and_feed(entry)
+    out = []
+    out << "#{entry.feed.title} | #{entry.last_updated.strftime('%A, %B %d %Y')}"
+    out << wrap_text(html_to_text(entry.title.strip))
+    out.join("\n\n")
+  end
+
+  def display_title(entry)
+    wrap_text(html_to_text(entry.title.strip))
+  end
+
+  def display_feed(entry)
+    "#{entry.feed.title} | #{entry.date_published.strftime('%A, %B %d %Y')}"
+  end
+
+  def display_raw_entry_content(entry)
+    out = []
+    if entry.description
+      out << divider + "Entry Summary\n\n" + entry.description
+    end
+    if entry.content
+      out << "Entry Content\n\n" + entry.content
+    end
+    wrap_text(out.join(divider)).strip
+  end
+
+  def html_to_text(html)
+    LOGGER.debug("html_to_text:\n #{html}")
+    html.strip!
+    # convert utf-8 to ascii
+
+    html = process_entities_and_utf(html) 
+
+    # if there are no tags, and this is a body, wrap what looks like paragraph
+    # in paragarph tags, so it can be processed with the html paragraph rule
+    # below.
+    if html =~ /\n/ && html !~ /<[^>]+>/  && html !~ /<\/[^>]+>/  
+      html = html.split("\n\n").collect {|x| "<p>#{x}</p>"}.join("\n")
+    end
+   
+    html, *links = links_to_footnotes(html)
+    html = tags_to_text(html)
+    html = normalize_blank_lines(html)
+    html = wrap_text(html)
+    html = [html, links.join("\n")].join("\n\n")
+    #puts out
+    #out = normalize_blank_lines(out)
+    html.strip
+  end
+
+  # Make sure there is no more than one blank line anywhere
+  def normalize_blank_lines(text)
+    # get rid of ms line feeds
+    text.gsub(/\r\n/, "\n").
+    # compress 3 or more blank lines to one
+    gsub(/^\s*$/, "\n").
+    split(/\n\n\n*/).join( "\n\n")
+    # hflush everything left to begin with
+    #gsub(/^\s+(\w)/, '\1')
+  end
+
+  def tags_to_text(html)
+    doc = Hpricot(html)
+
+    doc.search('//comment()').remove
+
+    doc.search('p, div') do |p|
+      p.swap( "\n\n" + p.inner_text.gsub("\n", ' ').squeeze(' ').strip + "\n\n" )
+    end
+
+    doc.search('//blockquote') do |x|
+      # compress extra spaces
+      text = x.inner_text.squeeze(' ').strip
+      # collapse the spacing in the text
+      text.gsub!(/\s{2,}/, ' ')
+      text = wrap_text(text, @width - 4).gsub(/^/, '    ') # indent 4 spaces
+      x.swap("\n\n" + text + "\n\n")
+    end
+
+    doc.search('h1,h2,h3,h4') do |p|
+      p.swap( "\n\n= #{p.inner_text}\n\n" )
+    end
+    doc.search('//img') do |img|
+      img.swap( "(img)" )
+    end
+    
+    doc.search('object').remove
+    doc.search('table').remove
+    doc.search('script').remove
+
+    doc.search('//br') do |p|
+      p.swap( "\n" )
+    end
+
+    doc.search('i, b') do |p|
+      p.swap( "*#{p.inner_text}*" )
+    end
+    # anchor tags are processed after real links 
+    doc.search('a') do |p|
+      p.swap( "#{p.inner_text}" )
+    end
+    doc.search('dt') do |x|
+      x.swap( "#{x.inner_html}:\n" )
+    end
+    # This could be improved to insure an indentation even if there are nested
+    # tag elements
+    doc.search('dd') do |x|
+      x.swap( "#{x.inner_text}\n" )
+    end
+
+
+    doc.search('//span') do |s|
+      s.swap( s.inner_text )
+    end
+    doc.search('hr') do |s|
+      s.swap( '-' * @width)
+    end
+    # Do this before erasing the enclosing <ul> or <ol> tags
+    doc.search('li') do |s|
+      text = s.inner_text.strip
+      # wrap the text and indent it 2 spaces
+      text = wrap_text(text, @width - 2).gsub(/^/, '  ') 
+      # don't indent 1st line
+      text.lstrip!
+      s.swap( "* " + text  + "\n" )
+    end
+    doc.search('ul, ol, dl') do |s|
+      s.swap(  s.inner_text.strip  )
+    end
+    doc.to_s
+  end
+
+  def links_to_footnotes(html)
+    doc = Hpricot(html)
+    footnotes = []
+    doc.search('//a[@href]') do |link|
+      if @options[:no_links]
+        link.swap(
+          if link.inner_text == ''
+            ''
+          else
+            "[#{link.inner_text}]"
+          end
+        )
+      else
+        href = link.attributes['href']
+        footnotes << "  [#{footnotes.size + 1}] #{href}"
+        link.swap(link.inner_text + "[#{footnotes.size}]")
+      end
+    end
+    [doc.to_s, *footnotes]
+  end
+
+  # From 
+  # http://blog.macromates.com/2006/wrapping-text-with-regular-expressions/
+  def wrap_text(txt, col = @width)
+    txt.chars.gsub(/(.{1,#{col}})( +|$\n?)|(.{1,#{col}})/, "\\1\\3\n") 
+  end
+
+
+  def divider
+    "\n" + '-' * @width + "\n"
+  end
+end