Merge pull request #10 from Expez/config

Add support for configuration files

Author: jfredett

.hatterrc

@@ -0,0 +1,10 @@
+#
+# This file contains the default configuration for Hatter.
+
+# Each setting is of the form: <key> = <value>
+
+# Path to the root of the local maildir
+maildir = /path/to/maildir
+
+# The format of the maildir, e.g maildir or mbox
+maildir_format = maildir

Gemfile

@@ -4,6 +4,9 @@ group :development, :test do
   gem 'rspec'
   gem 'pry'
   gem 'rake'
+  gem 'mail'
+  gem 'rbcurse'
+  gem 'configtoolkit'
 end
 
 # Specify your gem's dependencies in hatter.gemspec

Gemfile.lock

@@ -6,9 +6,27 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
+    assertions (1.4.1)
     coderay (1.0.8)
+    configtoolkit (2.3.2)
+      assertions (>= 1.0.0)
+      relative (>= 1.0.0)
     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)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
     method_source (0.8.1)
+    mime-types (1.19)
+    polyglot (0.3.3)
     pry (0.9.11.4)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
@@ -19,6 +37,14 @@ 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)
+    relative (1.0.3)
     rspec (2.12.0)
       rspec-core (~> 2.12.0)
       rspec-expectations (~> 2.12.0)
@@ -28,6 +54,9 @@ GEM
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.12.2)
     slop (3.4.3)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
     win32console (1.3.2-x86-mingw32)
 
 PLATFORMS
@@ -36,6 +65,9 @@ PLATFORMS
 
 DEPENDENCIES
   Hatter!
+  configtoolkit
+  mail
   pry
   rake
+  rbcurse
   rspec

lib/configuration.rb

@@ -0,0 +1,18 @@
+require 'configtoolkit'
+require 'configtoolkit/keyvaluereader'
+
+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
+    load reader
+  end
+
+  add_required_param(:maildir, String)
+  add_required_param(:maildir_format, String)
+end

lib/hatter.rb

@@ -0,0 +1 @@
+

spec/configuration_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'relative'
+require 'configtoolkit/keyvaluereader'
+
+describe 'Configuration' do
+
+  before :all do
+    @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
+  end
+
+  it "contains all the required configuration settings" do
+    @config.maildir?.should be_true
+    @config.maildir_format?.should be_true
+  end
+
+  it "the settings have the correct values" do
+    @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
+    config.maildir.should eq @maildir_path
+    config.maildir_format.should eq @maildir_format
+  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")
+  end
+end

spec/spec_helper.rb

@@ -1,3 +1,4 @@
 require 'rspec'
 
-require './lib/hatter.rb'
+require './lib/hatter.rb'
+require './lib/configuration.rb'