Rearranged the project, added tests

Author: mark

.gitignore

@@ -0,0 +1 @@
+.DS_Store

Rakefile

@@ -0,0 +1,6 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push %w(lib spec)
+  t.pattern = 'spec/*_spec.rb'
+end

lib/formattable.rb

@@ -0,0 +1,19 @@
+module Formattable
+
+  module ClassMethods
+
+    def define_format_string(formatter_method, options = {}, &block)
+      formatter_class = options.fetch(:with) { StringFormatter }
+      
+      define_method formatter_method do |format_string|
+        formatter_class.new(self, format_string).to_s
+      end
+    end
+
+  end
+
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+
+end

string_formatter.rb renamed to lib/string_formatter.rb

@@ -1,3 +1,5 @@
+require_relative 'formattable'
+
 class StringFormatter
 
   #############
@@ -9,49 +11,50 @@ class StringFormatter
   STRING_FORMAT_REGEX = /[^%]+|%./
 
   SPECIAL_CHARACTER_FORMATS = {
-    'ampersand' => '&',
-    'at' => '@',
-    'backslash' => '\\',
-    'backtick' => '`',
-    'bang' => '!',
-    'caret' => '^',
-    'cash' => '$',
-    'colon' => ':',
-    'comma' => ',',
-    'dash' => '-',
-    'double_quote' => '"',
-    'eight' => '8',
-    'equals' => '=',
-    'five' => '5',
-    'four' => '4',
-    'hash' => '#',
-    'left_bracket' => '[',
-    'left_chevron' => '<',
-    'left_paren' => '(',
-    'left_stache' => '{',
-    'nine' => '9',
-    'one' => '1',
-    'percent' => '%', # Defining this method is not recommended
-    'period' => '.',
-    'pipe' => '|',
-    'plus' => '+',
-    'quote' => "'",
+    'ampersand'     => '&',
+    'at'            => '@',
+    'backslash'     => '\\',
+    'backtick'      => '`',
+    'bang'          => '!',
+    'caret'         => '^',
+    'cash'          => '$',
+    'colon'         => ':',
+    'comma'         => ',',
+    'dash'          => '-',
+    'double_quote'  => '"',
+    'eight'         => '8',
+    'equals'        => '=',
+    'five'          => '5',
+    'four'          => '4',
+    'hash'          => '#',
+    'left_bracket'  => '[',
+    'left_chevron'  => '<',
+    'left_paren'    => '(',
+    'left_brace'    => '{',
+    'nine'          => '9',
+    'one'           => '1',
+    # Defining this method is not recommended:
+    'percent'       => '%',
+    'period'        => '.',
+    'pipe'          => '|',
+    'plus'          => '+',
+    'quote'         => "'",
     'right_bracket' => ']',
     'right_chevron' => '>',
-    'right_paren' => ')',
-    'right_stache' => '}',
-    'semicolon' => ';',
-    'seven' => '7',
-    'six' => '6',
-    'slash' => '/',
-    'splat' => '*',
-    'three' => '3',
-    'tilde' => '~',
-    'two' => '2',
-    'underscore' => '_',
-    'what' => '?',
-    'zero' => '0'
-  }
+    'right_paren'   => ')',
+    'right_brace'   => '}',
+    'semicolon'     => ';',
+    'seven'         => '7',
+    'six'           => '6',
+    'slash'         => '/',
+    'splat'         => '*',
+    'three'         => '3',
+    'tilde'         => '~',
+    'two'           => '2',
+    'underscore'    => '_',
+    'what'          => '?',
+    'zero'          => '0'
+  }.freeze
 
   ###############
   #             #
@@ -87,7 +90,7 @@ def self.method_missing(meth, *args, &block)
       super
     end
   end
-  
+
   ####################
   #                  #
   # Instance Methods #
@@ -110,15 +113,3 @@ def translate_component(string)
   end
 
 end
-
-class Module
-  
-  def define_format_string(formatter_method, options = {})
-    formatter_class = options[:with]
-    
-    define_method formatter_method do |format_string|
-      formatter_class.new(self, format_string).to_s
-    end
-  end
-  
-end

spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'minitest/spec'
+require 'minitest/autorun'
+
+require 'string_formatter'

spec/string_formatter_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe StringFormatter do
+
+  class PersonFormatter < StringFormatter    
+    f { |p| p.first_name }
+    F { |p| p.first_name.upcase }
+    l { |p| p.last_name  }
+
+    pipe { |p| 'PIPE' }
+  end
+
+  class UpcaseFormatter < StringFormatter
+    f { |p| p.first_name.upcase }
+    l { |p| p.last_name.upcase  }
+  end
+
+  Person = Struct.new(:first_name, :last_name) do
+    include Formattable
+
+    define_format_string :strf,   :with => PersonFormatter
+    define_format_string :strfup, :with => UpcaseFormatter
+  end
+
+  it "should generate the right string format" do
+    p = Person.new("Bob", "Smith")
+
+    p.strfup('%l, %f').must_equal "SMITH, BOB"
+  end
+
+  it "should handle special characters" do
+    p = Person.new("Bob", "Smith")
+
+    p.strf('%l, %f %|').must_equal "Smith, Bob PIPE"
+  end  
+
+end