harukizaemon-titleizer 1.0.1

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+== 1.0.1 released 2009-02-01
+
+* Initial revision adapted almost entirely from code written by Marshall Elfstrand (http://vengefulcow.com/titlecase/) with some minor changes here and there to package it as a gem.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Simon Harris
+
+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/README.rdoc

@@ -0,0 +1,33 @@
+= Titleizer
+
+Titleizer is a gem that adds String#titleize (aliased as String#titlecase) to perform smart capitalisation of titles:
+
+  "terms of reference".titleize # => "Terms of Reference"
+  "my name is barron von sampy pants and you shall refer to me as such".titleize # => "My Name is Barron Von Sampy Pants and You Shall Refer to Me as Such"
+
+Titleizer also converts underscores and dashes to spaces:
+
+  "a-slug-from-a-url".titleize  # => "A Slug From a Url"
+
+Titleizer also preserves the capitalisation of any word it would capitalise itself:
+
+  "THIS IS A TITLE".titleize  # => THIS is a TITLE"
+
+And lastly, String#titleize is aliased as String#titlecase.
+
+Oh, one last, last thing, there are self-updating versions as well: String#titleize!, and String#titlecase!
+
+== Installation
+
+For plain Ruby, simply install the gem and you're good to go.
+
+  sudo gem sources -a http://gems.github.com
+  sudo gem install harukizaemon-titleizer
+
+For Rails, update environment.rb to include the gem:
+
+  config.gem "harukizaemon-titleizer", :lib => "titleizer", :source => "http://gems.github.com"
+
+=== License
+
+This plugin is copyright 2009 Simon Harris and is released under the MIT license.

data/lib/haruki_zaemon/titleizer/string.rb

@@ -0,0 +1,62 @@
+#   This filter changes all words to Title Caps, and attempts to be clever
+#   about *un*capitalizing small words like a/an/the in the input.
+#
+#   The list of "small words" which are not capped comes from
+#   the New York Times Manual of Style, plus 'vs' and 'v'.
+#
+#   Original Perl version by:
+#     John Gruber
+#     http://daringfireball.net/
+#     10 May 2008
+#
+#   Adapted to Ruby by:
+#     Marshall Elfstrand
+#     http://vengefulcow.com/
+#     21 May 2008
+#
+#   License: http://www.opensource.org/licenses/mit-license.php
+#
+module HarukiZaemon
+  module Titleizer
+    module String
+      SMALL_WORDS = %w( is a an and as at but by en for if in of on or the to v[.]? via vs[.]? )
+      SMALL_RE = SMALL_WORDS.join('|')
+
+      def titleize
+        result = ""
+        self.gsub(/[_-]/, ' ').split(/( [:.;?!][ ] | (?:[ ]|^)["“] )/x).each do |s|
+          s.gsub!(/ \b( [[:alpha:]] [[:lower:].'’]* )\b /x) do |w|
+            # Skip words with inresult dots, e.g. "del.icio.us" or "example.com"
+            (w =~ / [[:alpha:]] [.] [[:alpha:]] /x) ? w : w.capitalize
+          end #gsub!
+
+          # Lowercase our list of small words:
+          s.gsub!(/\b(#{SMALL_RE})\b/io) { |w| w.downcase }
+
+          # If the first word in the title is a small word, then capitalize it:
+          s.gsub!(/\A([[:punct:]]*)(#{SMALL_RE})\b/io) { |w| $1 + $2.capitalize }
+
+          # If the last word in the title is a small word, then capitalize it:
+          s.gsub!(/\b(#{SMALL_RE})([[:punct:]]*)\Z/io) { |w| $1.capitalize + $2 }
+
+          # Append current substring to output
+          result += s
+        end #each
+
+        # Special Cases:
+        result.gsub!(/ V(s?)\. /, ' v\1. ')               # "v." and "vs."
+        result.gsub!(/(['’])S\b/, '\1s')                  # 'S (otherwise you get "the SEC'S decision")
+        result.gsub!(/\b(AT&T|Q&A)\b/i) { |w| w.upcase }  # "AT&T" and "Q&A", which get tripped up by
+                                                        # self-contained small words "at" and "a"
+
+        result
+      end
+      alias_method :titlecase, :titleize
+      
+      def titleize!
+        self.replace(self.titleize)
+      end
+      alias_method :titlecase!, :titleize!
+    end
+  end
+end

data/lib/titleizer.rb

@@ -0,0 +1 @@
+String.send(:include, HarukiZaemon::Titleizer::String)

data/titleizer.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name     = "titleizer"
+  s.version  = "1.0.1"
+  s.date     = "2009-02-01"
+  s.summary  = "Smart capitalisation of titles"
+  s.email    = "haruki.zaemon@gmail.com"
+  s.homepage = "http://github.com/harukizaemon/titleizer"
+  s.description = "Adds String#titleize and String#titlecase! to perform smart capitalisation of titles"
+  s.has_rdoc = true
+  s.authors  = ["Simon Harris"]
+  s.files    = ["CHANGELOG.rdoc",
+                "MIT-LICENSE",
+                "README.rdoc",
+                "titleizer.gemspec",
+                "lib/titleizer.rb",
+                "lib/haruki_zaemon/titleizer/string.rb"]
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.extra_rdoc_files = ["CHANGELOG.rdoc", "README.rdoc"]
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: harukizaemon-titleizer
+version: !ruby/object:Gem::Version 
+  version: 1.0.1
+platform: ruby
+authors: 
+- Simon Harris
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-01 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Adds String#titleize and String#titlecase! to perform smart capitalisation of titles
+email: haruki.zaemon@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG.rdoc
+- README.rdoc
+files: 
+- CHANGELOG.rdoc
+- MIT-LICENSE
+- README.rdoc
+- titleizer.gemspec
+- lib/titleizer.rb
+- lib/haruki_zaemon/titleizer/string.rb
+has_rdoc: true
+homepage: http://github.com/harukizaemon/titleizer
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Smart capitalisation of titles
+test_files: []
+