titlecase 0.1.0

data/README

@@ -0,0 +1,37 @@
+Ruby String Extensions To Add Title Case Support
+================================================
+
+A set of methods added onto the String class to allow easy title casing of strings.
+
+This extension is available as a gem via GitHub:
+
+    $ sudo gem install samsouder-titlecase --source=http://gems.github.com
+
+Usage:
+
+    require 'rubygems'
+    require 'titlecase'
+    
+    puts "this is a test".titlecase
+
+Derived from the rules set by John Gruber at <http://daringfireball.net/2008/05/title_case>. I also derived my test cases from his set. If you find any edge cases, please feel free to add them to the examples.yaml file.
+
+Rules from John Gruber:
+-----------------------
+  - capitalize each word
+  - downcase each of the small_words
+  - words with capitals after the first character are left alone
+  - words with periods are left alone
+  - first and last word always capitalized
+  - small words after colons are capitalized
+
+Sam Souder <samsouder@gmail.com>
+Created May 22, 2008
+
+Perl version created by:
+
+  John Gruber  
+  http://daringfireball.net/  
+  May 10 2008
+
+License: http://www.opensource.org/licenses/mit-license.php

data/lib/titlecase.rb

@@ -0,0 +1,36 @@
+class String
+  def titlecase
+    small_words = %w(a an and as at but by en for if in of on or the to v v. via vs vs.)
+    
+    x = split(" ").map do |word|
+      # note: word could contain non-word characters!
+      # downcase all small_words, capitalize the rest
+      small_words.include?(word.gsub(/\W/, "").downcase) ? word.downcase! : word.smart_capitalize!
+      word
+    end
+    # capitalize first and last words
+    x.first.to_s.smart_capitalize!
+    x.last.to_s.smart_capitalize!
+    # small words after colons are capitalized
+    x.join(" ").gsub(/:\s?(\W*#{small_words.join("|")}\W*)\s/) { ": #{$1.smart_capitalize} " }
+  end
+  
+  def titlecase!
+    replace(titlecase)
+  end
+  
+  def smart_capitalize
+    # ignore any leading crazy characters and capitalize the first real character
+    if self =~ /^['"\(\[']*([a-z])/
+      i = index($1)
+      x = self[i,self.length]
+      # word with capitals and periods mid-word are left alone
+      self[i,1] = self[i,1].upcase unless x =~ /[A-Z]/ or x =~ /\.\w+/
+    end
+    self
+  end
+  
+  def smart_capitalize!
+    replace(smart_capitalize)
+  end
+end

data/spec/examples.yaml

@@ -0,0 +1,45 @@
+should_pass:
+  - example: | Q&A with Steve Jobs: 'That's what happens in technology'
+    expect:  | Q&A With Steve Jobs: 'That's What Happens in Technology'
+  - example: | what is AT&T's problem?
+    expect:  | What Is AT&T's Problem?
+  - example: | Apple deal with AT&T falls through
+    expect:  | Apple Deal With AT&T Falls Through
+  - example: | this v that
+    expect:  | This v That
+  - example: | this vs that
+    expect:  | This vs That
+  - example: | this v. that
+    expect:  | This v. That
+  - example: | this vs. that
+    expect:  | This vs. That
+  - example: | The SEC's Apple probe: what you need to know
+    expect:  | The SEC's Apple Probe: What You Need to Know
+  - example: | 'by the way, small word at the start but within quotes.'
+    expect:  | 'By the Way, Small Word at the Start but Within Quotes.'
+  - example: | small word at end is nothing to be afraid of
+    expect:  | Small Word at End Is Nothing to Be Afraid Of
+  - example: | Starting Sub-Phrase with a small word: a trick, perhaps?
+    expect:  | Starting Sub-Phrase With a Small Word: A Trick, Perhaps?
+  - example: | Sub-Phrase With a Small Word in Quotes: 'a trick, perhaps?'
+    expect:  | Sub-Phrase With a Small Word in Quotes: 'A Trick, Perhaps?'
+  - example: | Sub-Phrase With a Small Word in Quotes: "a trick, perhaps?"
+    expect:  | Sub-Phrase With a Small Word in Quotes: "A Trick, Perhaps?"
+  - example: | "nothing to be afraid of?"
+    expect:  | "Nothing to Be Afraid Of?"
+  - example: | a thing
+    expect:  | A Thing
+  - example: | 2lmc Spool: 'Gruber on OmniFocus and Vapo(u)rware'
+    expect:  | 2lmc Spool: 'Gruber on OmniFocus and Vapo(u)rware'
+  - example: | a complex thing
+    expect:  | A Complex Thing
+  - example: | de.licio.us: the new hotness?
+    expect:  | de.licio.us: The New Hotness?
+  - example: | introducing: de.licio.us bookmarks
+    expect:  | Introducing: de.licio.us Bookmarks
+  - example: | i end in a period.
+    expect:  | I End in a Period.
+  - example: | this is a test.com!?
+    expect:  | This Is a test.com!?
+  - example: | 
+    expect:  | 

data/spec/titlecase_spec.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(__FILE__), *%w[../lib/titlecase.rb])
+require "yaml"
+
+describe String do
+  File.open(File.join(File.dirname(__FILE__), *%w[examples.yaml])) do |file|
+    examples = YAML.load(file)
+    examples["should_pass"].each do |e|
+      it "should be the expected value (#{e["expect"]})" do
+        e["example"].titlecase.should == e["expect"]
+      end
+    end
+  end
+  
+  # Ensure the self-modifying version works correctly
+  it "should self-modify the original value in place" do
+    string = 'a complex thing'
+    string.titlecase!
+    string.should == 'A Complex Thing'
+  end
+end

data/titlecase.gemspec

@@ -0,0 +1,12 @@
+Gem::Specification.new do |s|
+  s.name = "titlecase"
+  s.version = "0.1.0"
+  s.date = "2008-05-23"
+  s.summary = "String methods to properly title case a headline."
+  s.email = "samsouder@gmail.com"
+  s.homepage = "http://github.com/samsouder/titlecase"
+  s.description = "titlecase is a set of methods on the Ruby String class to add title casing support as seen on Daring Fireball <http://daringfireball.net/2008/05/title_case>."
+  s.authors = ["Samuel Souder"]
+  s.files = ["README", "titlecase.gemspec", "lib/titlecase.rb", "spec/examples.yaml", "spec/titlecase_spec.rb"]
+  s.has_rdoc = false
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: titlecase
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Samuel Souder
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-23 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: titlecase is a set of methods on the Ruby String class to add title casing support as seen on Daring Fireball <http://daringfireball.net/2008/05/title_case>.
+email: samsouder@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- titlecase.gemspec
+- lib/titlecase.rb
+- spec/examples.yaml
+- spec/titlecase_spec.rb
+has_rdoc: true
+homepage: http://github.com/samsouder/titlecase
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: String methods to properly title case a headline.
+test_files: []
+