Merge pull request #11 from Expez/ui

Merge initial UI roughout

Author: jfredett

.gitignore

@@ -0,0 +1 @@
+.rbx

.rvmrc

@@ -6,7 +6,7 @@
 # First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
 # Only full ruby name is supported here, for short names use:
 #     echo "rvm use 1.9.3" > .rvmrc
-environment_id="ruby-1.9.3-p374@hatter"
+environment_id="rbx-head@hatter"
 
 # Uncomment the following lines if you want to verify rvm version per project
 # rvmrc_rvm_version="1.18.3 (stable)" # 1.10.1 seams as a safe start
@@ -46,3 +46,6 @@ fi
 # then
 #   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
 # fi
+
+DIR=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
+export RUBYLIB="$DIR/lib"

Gemfile

@@ -5,7 +5,7 @@ group :development, :test do
   gem 'pry'
   gem 'rake'
   gem 'mail'
-  gem 'rbcurse'
+  gem 'rb_termbox'
   gem 'configtoolkit'
 end
 

Gemfile.lock

@@ -14,11 +14,6 @@ GEM
     diff-lcs (1.1.3)
     ffi (1.3.1)
     ffi (1.3.1-x86-mingw32)
-    ffi-locale (1.0.1)
-      ffi (>= 1.0.9)
-    ffi-ncurses (0.4.0)
-      ffi (>= 1.0.9)
-      ffi-locale (>= 1.0.0)
     i18n (0.6.1)
     mail (2.5.3)
       i18n (>= 0.4.0)
@@ -37,13 +32,8 @@ GEM
       slop (~> 3.4)
       win32console (~> 1.3)
     rake (10.0.3)
-    rbcurse (1.5.2)
-      rbcurse-core (>= 0.0)
-      rbcurse-extras (>= 0.0)
-    rbcurse-core (0.0.3)
-      ffi-ncurses (>= 0.4.0)
-    rbcurse-extras (0.0.0)
-      rbcurse-core (>= 0.0.3)
+    rb_termbox (0.1.0)
+      ffi
     relative (1.0.3)
     rspec (2.12.0)
       rspec-core (~> 2.12.0)
@@ -69,5 +59,5 @@ DEPENDENCIES
   mail
   pry
   rake
-  rbcurse
+  rb_termbox
   rspec

.hatterrc renamed to hatterrc

@@ -8,3 +8,9 @@ maildir = /path/to/maildir
 
 # The format of the maildir, e.g maildir or mbox
 maildir_format = maildir
+
+# Hatter relies on Termbox for the terminal UI
+termbox_library_path = /usr/lib/libtermbox.so
+
+# All the colors i Hatter can be customized:
+colors = {foreground => green, background => black}

lib/configuration.rb

@@ -1,18 +1,25 @@
 require 'configtoolkit'
 require 'configtoolkit/keyvaluereader'
+require 'relative'
 
 class Configuration < ConfigToolkit::BaseConfig
 
-  # Reads a configuration from file.
-  #
-  # @param [String] configPath the path to a configuration file.
-  #
-  # @return [Configuration] with values loaded from file.
-  def self.from_file configPath
-    reader = ConfigToolkit::KeyValueReader.new configPath
+  include Singleton
+
+  CONFIG_FILE = File.expand_path_relative_to_caller("../hatterrc")
+
+  def initialize(config_file = CONFIG_FILE)
+    reader = ConfigToolkit::KeyValueReader.new config_file
     load reader
   end
 
+  class Colors < ConfigToolkit::BaseConfig
+  add_required_param(:foreground, String)
+  add_required_param(:background, String)
+  end
+
   add_required_param(:maildir, String)
   add_required_param(:maildir_format, String)
+  add_required_param(:termbox_library_path, String)
+  add_required_param(:colors, Colors)
 end

lib/hatter.rb

@@ -1 +1,9 @@
+require 'terminal'
 
+terminal = Terminal.new
+begin
+  terminal.draw
+  sleep(10)
+ensure
+  terminal.shutdown
+end

lib/mailbox/maildir_mailbox.rb

@@ -0,0 +1,25 @@
+require 'mail'
+
+class MaildirMailbox
+
+  def initialize(maildir_path)
+    @maildir_path = maildir_path
+    @maildir_path = "spec/fixtures/maildir"
+  end
+
+  def mail(where={label: nil, folder: nil, from: nil, to: nil, date: nil})
+    Mail.read(@maildir_path + "/INBOX/cur/TRAIN_00001.eml")
+  end
+
+  def most_recent
+    mail
+  end
+
+  def labels
+    ["work", "cat pictures", "news"]
+  end
+
+  def folders
+    %w{ inbox archived spam trash }
+  end
+end

lib/terminal.rb

@@ -0,0 +1,49 @@
+require 'termbox'
+require 'views/mail_view'
+require 'views/label_view'
+require 'views/folder_view'
+
+module Termbox
+  TB_INPUT_ESCAPE = 1
+  TB_INPUT_ALT = 2
+end
+
+class Terminal
+
+  def initialize
+    initialize_termbox
+    initialize_views
+  end
+
+  def draw
+    Termbox.tb_clear
+    @views.each {|view| view.draw}
+    Termbox.tb_present
+  end
+
+  def shutdown
+    Termbox.tb_shutdown
+  end
+
+  private
+
+  def initialize_views
+    folder_view_location = {x0: 0, y0: 0, x1: 19, y1: 40}
+    label_view_location = {x0: 0, y0: 41, x1: 19, y1: 79}
+    mail_view_location = {x0: 20, y0: 0, x1: 79, y1: 79}
+    @views = [MailView.new(mail_view_location),
+              LabelView.new(label_view_location),
+              FolderView.new(folder_view_location)]
+  end
+
+  def initialize_termbox
+    libtermbox_path = Configuration.instance.termbox_library_path
+    Termbox.initialize_library libtermbox_path
+    unless Termbox.tb_init
+      raise "Failed failed to start UI"
+    end
+    @event = Termbox::Event.new
+    Termbox.tb_select_input_mode Termbox::TB_INPUT_ESCAPE
+  end
+
+end

lib/views/folder_view.rb

@@ -0,0 +1,18 @@
+class FolderView < View
+
+  def draw
+    draw_folders
+    draw_horizontal_line @end_y
+  end
+
+  private
+
+  def draw_folders
+    x = @start_x
+    y = @start_y
+    y = draw_text("Folders:", x, y)
+    @mailbox.folders.each do |folder|
+      y = draw_text folder, x, y + 1
+    end
+  end
+end

lib/views/label_view.rb

@@ -0,0 +1,17 @@
+class LabelView < View
+
+  def draw
+    draw_labels
+  end
+
+  private
+
+  def draw_labels
+    x = @start_x
+    y = @start_y
+    y = draw_text("Labels:", x, y)
+    @mailbox.labels.each do |label|
+      y = draw_text label, x, y + 1
+    end
+  end
+end

lib/views/mail_view.rb

@@ -0,0 +1,37 @@
+require 'views/view'
+require 'termbox'
+
+class MailView < View
+
+  def initialize(location)
+    super
+    @mail = @mailbox.most_recent
+  end
+
+  def draw
+    draw_borders
+    draw_mail
+  end
+
+  private
+
+  def draw_borders
+    draw_horizontal_line @start_y
+    draw_horizontal_line @end_y
+    draw_vertical_line @start_x
+    draw_vertical_line @end_x
+  end
+
+  def draw_mail
+    from, = @mail.from
+    subject = @mail.subject
+    text = @mail.body.decoded
+    x = @start_x + @Border_width + 1
+    y = @start_y + @Border_width + 1
+
+    y = draw_text(("From: " + from), x, y) + 1
+    y = draw_text(("Subject: " + subject), x, y + 1) + 1
+    draw_text text, x, y + 1
+  end
+
+end

lib/views/view.rb

@@ -0,0 +1,74 @@
+require 'configuration'
+require 'termbox'
+
+class View
+
+  attr_reader :colors, :mailbox
+
+  def initialize(location)
+    @Border_width = 1
+    @start_x = location[:x0]
+    @start_y = location[:y0]
+    @end_x = location[:x1]
+    @end_y = location[:y1]
+    set_mailbox
+    set_colors
+  end
+
+  def draw_text(text, x, y)
+    words = text.split(/\s+/)
+    words.each do |word|
+      if x + word.length + 1 >= @end_x
+        y += 1
+        x = @start_x + @Border_width + 1
+        redo
+      elsif y >= @end_y
+        return y
+      end
+      word.each_char do |c|
+        Termbox.tb_change_cell(x, y, c.ord, @colors[:bg], @colors[:fg])
+        x += 1
+      end
+      Termbox.tb_change_cell(x, y, " ".ord, @colors[:bg], @colors[:fg])
+      x += 1
+    end
+    return y
+  end
+
+  def draw_horizontal_line(at)
+    @start_x.upto(@end_x) do |x|
+      Termbox.tb_change_cell(x, at, " ".ord, @colors[:bg], @colors[:fg])
+    end
+  end
+
+  def draw_vertical_line(at)
+    @start_y.upto(@end_y) do |y|
+      Termbox.tb_change_cell(at, y, " ".ord, @colors[:bg], @colors[:fg])
+    end
+  end
+
+  private
+
+  # Reads the maildir format from config file.  Requires the class and sets
+  # @mailbox to mailbox/<maildir-format>Mailbox
+  def set_mailbox
+    config = Configuration.instance
+    maildir_format = config.maildir_format
+    mailbox_class = maildir_format.capitalize + "Mailbox"
+    class_dir = File.expand_path('../../', __FILE__) + "/mailbox"
+    mailbox_file = File.join class_dir, maildir_format + "_mailbox"
+    require mailbox_file
+    maildir_path = config.maildir
+    @mailbox = self.class.const_get(mailbox_class).new maildir_path
+  end
+
+  def set_colors
+    colors = Configuration.instance.colors
+    prefix = 'Termbox::Colors[:'
+    suffix = ']'
+    fg = prefix + colors.foreground + suffix
+    bg = prefix + colors.background + suffix
+    @colors = {fg: (eval fg), bg: (eval bg)}
+  end
+
+end

spec/configuration_spec.rb

@@ -5,36 +5,37 @@
 describe 'Configuration' do
 
   before :all do
+    CONFIG_FILE = File.expand_path_relative_to_caller("../hatterrc")
     @maildir_path = "/path/to/maildir"
-    CONFIG_FILE = File.expand_path_relative_to_caller("../.hatterrc")
     @maildir_format = "maildir"
-    @config = Configuration.new() do |config|
-      config.maildir = @maildir_path
-      config.maildir_format = @maildir_format
-    end
+    @termbox_library_path = "/usr/lib/libtermbox.so"
   end
 
-  it "contains all the required configuration settings" do
-    @config.maildir?.should be_true
-    @config.maildir_format?.should be_true
+  it "barfs when required values are missing" do
+    config = File.read CONFIG_FILE
+    config.gsub!(/maildir/, 'asdf')
+    File.open("invalid_config", "w") {|file| file.write config}
+    expect {Configuration.instance "invalid_config"}.to raise_error
+    FileUtils::rm("invalid_config")
   end
 
-  it "the settings have the correct values" do
-    @config.maildir.should eq @maildir_path
-    @config.maildir_format.should eq @maildir_format
+  it "reads the configuration values from file" do
+    config = Configuration.instance
+    config.maildir.should eq @maildir_path
+    config.maildir_format.should eq @maildir_format
   end
 
-  it "reads the configuration values from file" do
-    config = Configuration.from_file CONFIG_FILE
+  it "the settings have the correct values" do
+    config = Configuration.instance
     config.maildir.should eq @maildir_path
     config.maildir_format.should eq @maildir_format
+    config.termbox_library_path.should eq @termbox_library_path
   end
 
-  it "barfs when required values are missing" do
-    config = File.read CONFIG_FILE
-    config.gsub!(/maildir/, 'asdf')
-    File.open("invalid_config", "w") {|file| file.write config}
-    expect {Configuration.from_file("invalid_config")}.to raise_error
-    FileUtils::rm("invalid_config")
+  it "contains a nested config with colors" do
+    config = Configuration.instance
+    config.colors.foreground.should eq "green"
+    config.colors.foreground.should eq "green"
   end
+
 end