string_formatter 1.0.0

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,3 @@
+=== 1.0.0 / 2011-01-11
+
+* First (test) release!  Yay!

data/Manifest.txt

@@ -0,0 +1,7 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/string_formatter.rb
+test/test_string_formatter.rb

data/README.txt

@@ -0,0 +1,92 @@
+= string_formatter
+
+* http://github.com/mark/string_formatter
+
+== DESCRIPTION:
+
+A gem for creating strf-style methods in any Ruby object.
+
+== FEATURES/PROBLEMS:
+
+* Creates strf-style methods
+
+== SYNOPSIS:
+
+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
+
+class Person
+  attr_accessor :first_name, :last_name
+
+  define_format_string :strf,   :with => PersonFormatter
+  define_format_string :strfup, :with => UpcaseFormatter
+  
+  def initialize(*names)
+    @first_name, @last_name = names
+  end
+  
+end
+
+p = Person.new("Bob", "Smith")
+
+p.strf('%l, %f %|')
+# => "Smith, Bob PIPE"
+
+p.strfup('%l, %f')
+# => "SMITH, BOB"
+
+
+== REQUIREMENTS:
+
+* None
+
+== INSTALL:
+
+* gem install string_formatter
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Mark Josef
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,21 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+# Hoe.plugin :compiler
+# Hoe.plugin :gem_prelude_sucks
+# Hoe.plugin :inline
+# Hoe.plugin :racc
+# Hoe.plugin :rubyforge
+
+Hoe.spec 'string_formatter' do
+  # HEY! If you fill these out in ~/.hoe_template/Rakefile.erb then
+  # you'll never have to touch them again!
+  # (delete this comment too, of course)
+
+  developer('Mark Josef', 'McPhage@gmail.com')
+
+end
+
+# vim: syntax=ruby

data/lib/string_formatter.rb

@@ -0,0 +1,132 @@
+class StringFormatter
+
+  ################
+  #              #
+  # Declarations #
+  #              #
+  ################
+  
+  VERSION = "1.0.0"
+  
+  #############
+  #           #
+  # Constants #
+  #           #
+  #############
+  
+  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' => "'",
+    'right_bracket' => ']',
+    'right_chevron' => '>',
+    'right_paren' => ')',
+    'right_stache' => '}',
+    'semicolon' => ';',
+    'seven' => '7',
+    'six' => '6',
+    'slash' => '/',
+    'splat' => '*',
+    'three' => '3',
+    'tilde' => '~',
+    'two' => '2',
+    'underscore' => '_',
+    'what' => '?',
+    'zero' => '0'
+  }
+  
+  ###############
+  #             #
+  # Constructor #
+  #             #
+  ###############
+  
+  def initialize(object, format_string)
+    @object = object
+    @format_string = format_string
+  end
+  
+  #################
+  #               #
+  # Class Methods #
+  #               #
+  #################
+  
+  def self.escape_character(object, char)
+    escape_method = @escapes[char]
+    escape_method ? escape_method[object] : char
+  end
+  
+  def self.method_missing(meth, *args, &block)
+    str = meth.to_s
+    if str.length == 1
+      @escapes ||= {}
+      @escapes[str] = block
+    elsif SPECIAL_CHARACTER_FORMATS[str]
+      @escapes ||= {}
+      @escapes[ SPECIAL_CHARACTER_FORMATS[str] ] = block
+    else
+      super
+    end
+  end
+  
+  ####################
+  #                  #
+  # Instance Methods #
+  #                  #
+  ####################
+  
+  def to_s
+    split_string = @format_string.scan STRING_FORMAT_REGEX
+    
+    split_string.map { |str| translate_component(str) }.join
+  end
+  
+  def translate_component(string)
+    if string[0...1] == '%'
+      char = string[1..-1]
+      self.class.escape_character(@object, char)
+    else
+      string
+    end
+  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

data/test/test_string_formatter.rb

@@ -0,0 +1,8 @@
+require "test/unit"
+require "string_formatter"
+
+class TestStringFormatter < Test::Unit::TestCase
+  def test_sanity
+    flunk "write tests or I will kneecap you"
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: string_formatter
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Mark Josef
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-11 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 2
+        - 8
+        - 0
+        version: 2.8.0
+  type: :development
+  version_requirements: *id001
+description: A gem for creating strf-style methods in any Ruby object.
+email: 
+- McPhage@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- .autotest
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/string_formatter.rb
+- test/test_string_formatter.rb
+has_rdoc: true
+homepage: http://github.com/mark/string_formatter
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: string_formatter
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: A gem for creating strf-style methods in any Ruby object.
+test_files: 
+- test/test_string_formatter.rb