titlify 0.2.0

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+
+# Yard
+doc/*
+.yardoc
+
+# OS X Crap
+.DS_Store

data/.yaropts

@@ -0,0 +1 @@
+--no-private lib/**/*.rb - README.markdown

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+gemspec
+
+group :test do
+  gem "rspec"
+  gem "guard"
+  gem "guard-rspec"
+  gem "rake"
+end

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    titlify (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    ffi (1.0.11)
+    guard (1.0.0)
+      ffi (>= 0.5.0)
+      thor (~> 0.14.6)
+    guard-rspec (0.6.0)
+      guard (>= 0.10.0)
+    rake (0.8.7)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  guard
+  guard-rspec
+  rake
+  rspec
+  titlify!

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :cli => "--color --format nested --drb" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end

data/README.markdown

@@ -0,0 +1,48 @@
+Titlify
+=======
+
+The best damn titlecase function. (Or at least on its way.)
+
+Credits
+-------
+The most thorough titlecasing function I found was Patrick Hogan's in his [sterile gem](https://github.com/pbhogan/sterile). I started with his titlecasing function and expanded to include some more logic to bring it closer to the AP guidelines and handle more fringe cases.
+
+Usage
+-----
+
+Titlify provides functionality both as class methods on the Titlify module and as extensions to the String class. 
+
+    Titlify.titlify("make title") # => "Make Title"
+
+    "make title".titlify # => "Make Title"
+
+    title = "make title"
+    title.titlify!
+    title # => "Make Title"
+
+
+Titlecase
+---------
+
+Format text appropriately for titles. This method is much smarter than ActiveSupport's titlecase. The algorithm is based on work done by John Gruber et al (http://daringfireball.net/2008/08/title_case_update). It gets closer to the AP standard for title capitalization, including proper support for small words and handles a variety of edge cases.
+
+	"Q&A with Steve Jobs: 'That's what happens in technology'".titlify
+	# => "Q&A With Steve Jobs: 'That's What Happens in Technology'"
+	
+	"Small word at end is nothing to be afraid of".titlify
+	# => "Small Word at End Is Nothing to Be Afraid Of"
+
+
+Installation
+------------
+__Not Yet Published__
+
+Install with RubyGems:
+
+    gem install titlify
+
+License
+-------
+
+Copyright (c) 2012 Josh Hepworth, released under the MIT License.
+http://www.opensource.org/licenses/mit-license

data/lib/titlify.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+# Copyright (c) 2011 Patrick Hogan
+#
+# 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.
+
+
+require "titlify/titlecase"
+
+require "titlify/string_extensions"

data/lib/titlify/data/smart_format_rules.rb

@@ -0,0 +1,45 @@
+# encoding: UTF-8
+
+module Titlify
+  # @private
+  class Data
+    def self.smart_format_rules
+      [
+        ["'tain't", "’tain’t"],
+        ["'twere", "’twere"],
+        ["'twas", "’twas"],
+        ["'tis", "’tis"],
+        ["'twill", "’twill"],
+        ["'til", "’til"],
+        ["'bout", "’bout"],
+        ["'nuff", "’nuff"],
+        ["'round", "’round"],
+        ["'cause", "’cause"],
+        ["'cos", "’cos"],
+        ["i'm", "i’m"],
+        ['--"', "—”"],
+        ["--'", "—’"],
+        ["--", "—"],
+        ["...", "…"],
+        ["(tm)", "™"],
+        ["(TM)", "™"],
+        ["(c)", "©"],
+        ["(r)", "®"],
+        ["(R)", "®"],
+        [/s\'([^a-zA-Z0-9])/, "s’\\1"],
+        [/"([:;])/, "”\\1"],
+        [/\'s$/, "’s"],
+        [/\'(\d\d(?:’|\')?s)/, "’\\1"],
+        [/(\s|\A|"|\(|\[)\'/, "\\1‘"],
+        [/(\d+)"/, "\\1′"],
+        [/(\d+)\'/, "\\1″"],
+        [/(\S)\'([^\'\s])/, "\\1’\\2"],
+        [/(\s|\A|\(|\[)"(?!\s)/, "\\1“\\2"],
+        [/"(\s|\S|\Z)/, "”\\1"],
+        [/\'([\s.]|\Z)/, "’\\1"],
+        [/(\d+)x(\d+)/, "\\1×\\2"],
+        [/([a-z])'(t|d|s|ll|re|ve)(\b)/i, "\\1’\\2\\3"]
+      ]
+    end
+  end
+end

data/lib/titlify/string_extensions.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+
+module Titlify
+
+  module StringExtensions
+    def self.included(base)
+      Titlify.methods(false).each do |method|
+        eval("def #{method}(*args, &block); Titlify.#{method}(self, *args, &block); end")
+        eval("def #{method}!(*args, &block); replace Titlify.#{method}(self, *args, &block); end")
+      end
+    end
+  end
+
+end
+
+
+class String
+  include Titlify::StringExtensions
+end

data/lib/titlify/titlecase.rb

@@ -0,0 +1,134 @@
+# encoding: UTF-8
+
+module Titlify
+
+  class << self
+
+    # Format text appropriately for titles. This method is much smarter
+    # than ActiveSupport's +titlecase+. The algorithm is based on work done
+    # by John Gruber et al (http://daringfireball.net/2008/08/title_case_update)
+    def titlify(string)
+
+      lsquo = [8216].pack("U")
+      rsquo = [8217].pack("U")
+      ldquo = [8220].pack("U")
+      rdquo = [8221].pack("U")
+      ndash = [8211].pack("U")
+
+      string.strip!
+      string.gsub!(/\s+/, " ")
+      string.downcase! unless string =~ /[[:lower:]]/
+
+      small_words = %w{ a an and as at(?!&t) but by en for if in nor of on or the to v[.]? via vs[.]? }.join("|")
+      apos = / (?: ['#{rsquo}] [[:lower:]]* )? /xu
+
+      string.gsub!(
+        /
+          \b
+          ([_\*]*)
+          (?:
+            ([A-Z][\.]) # Acronyms with periods in them
+          ){2,100}
+          ([_\*]*)
+          \b?
+        /xi
+      ) do |m|
+        m.gsub(/\./, "").upcase
+      end
+
+      string.gsub!(
+        /
+          \b
+          ([_\*]*)
+          (?:
+            ( [-\+\w]+ [@.\:\/] [-\w@.\:\/]+ #{apos} )      # URL, domain, or email
+            |
+            ( (?i: #{small_words} ) #{apos} )               # or small word, case-insensitive
+            |
+            ( [[:alpha:]] [[:lower:]'#{rsquo}()\[\]{}]* #{apos} )  # or word without internal caps
+            |
+            ( [[:alpha:]] [[:alpha:]'#{rsquo}()\[\]{}]* #{apos} )  # or some other word
+          )
+          ([_\*]*)
+          \b
+        /xu
+      ) do
+        ($1 ? $1 : "") +
+        ($2 ? $2 : ($3 ? $3.downcase : ($4 ? $4.downcase.capitalize : $5))) +
+        ($6 ? $6 : "")
+      end
+
+      if RUBY_VERSION < "1.9.0"
+        string.gsub!(
+          /
+            \b
+            ([:alpha:]+)
+            (#{ndash})
+            ([:alpha:]+)
+            \b
+          /xu
+        ) do
+          $1.downcase.capitalize + $2 + $1.downcase.capitalize
+        end
+      end
+
+      string.gsub!(
+        /
+          (
+            \A [[:punct:]]*     # start of title
+            | [:.;?!][ ]+       # or of subsentence
+            | [ ]['"#{ldquo}#{lsquo}(\[][ ]*  # or of inserted subphrase
+          )
+          ( #{small_words} )    # followed by a small-word
+          \b
+        /xiu
+      ) do
+        $1 + $2.downcase.capitalize
+      end
+
+      string.gsub!(
+        /
+          \b
+          ( #{small_words} )    # small-word
+          (?=
+            [[:punct:]]* \Z     # at the end of the title
+            |
+            ['"#{rsquo}#{rdquo})\]] [ ]       # or of an inserted subphrase
+          )
+        /xu
+      ) do
+        $1.downcase.capitalize
+      end
+
+      string.gsub!(
+        /
+          (
+            \b
+            [[:alpha:]]         # single first letter
+            [\-#{ndash}]               # followed by a dash
+          )
+          ( [[:alpha:]] )       # followed by a letter
+        /xu
+      ) do
+        $1 + $2.downcase
+      end
+
+      string.gsub!(/q&a/i, 'Q&A')
+
+      string
+    end
+    alias_method :titlecase, :titlify
+
+
+    private
+
+    # Lazy load smart formatting rules
+    def smart_format_rules
+      @smart_format_rules ||= begin
+        require "titlify/data/smart_format_rules"
+        Data.smart_format_rules
+      end
+    end
+
+  end
+end

data/lib/titlify/version.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+
+module Titlify
+  VERSION = "0.2.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'titlify'

data/spec/titlify_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Titlify do
+  it "titlecases a string object" do
+    title = "this is the title of the post".titlify
+    title.should eq("This Is the Title of the Post")
+  end
+
+  it "titlecases a string object in place" do
+    title = "this is the title of the post"
+    title.titlify!
+    title.should eq("This Is the Title of the Post")
+  end
+
+  it "properly titlecases a mixed-case word" do
+    title = "the iPhone is the bestest phone".titlify
+    title.should eq("The iPhone Is the Bestest Phone")
+  end
+
+  it "properly titlecases a word with abbreviations with and without periods" do
+    title = "there's a big AT&T monster in DOD for the DOJ".titlify
+    title.should eq("There's a Big AT&T Monster in DOD for the DOJ")
+    title = "there's a big AT&T monster in d.o.d. for the n.a.s.a.".titlify
+    title.should eq("There's a Big AT&T Monster in DOD for the NASA")
+  end
+
+  it "capitalizes the first letter after a hyphen" do
+    title = "that shit-faced guy fell over the curb".titlify
+    title.should eq("That Shit-Faced Guy Fell Over the Curb")
+  end
+
+  it "capitalizes the first word following a colon" do
+    title = "the big guns: a little man's tale".titlify
+    title.should eq("The Big Guns: A Little Man's Tale")
+  end
+end

data/titlify.gemspec

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+
+$:.push File.expand_path("../lib", __FILE__)
+require "titlify/version"
+
+Gem::Specification.new do |s|
+  s.name        = "titlify"
+  s.version     = Titlify::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Josh Hepworth"]
+  s.email       = ["josh@friendsoftheweb.com"]
+  s.homepage    = "http://github.com/fotw/titlify"
+  s.summary     = %q{Gonna be the best damn titlecasing function around.}
+  s.description = s.summary
+
+  s.rubyforge_project = "titlify"
+
+  # s.add_dependency("nokogiri")
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths  = ["lib"]
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: titlify
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Josh Hepworth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-14 00:00:00.000000000 Z
+dependencies: []
+description: Gonna be the best damn titlecasing function around.
+email:
+- josh@friendsoftheweb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .yaropts
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.markdown
+- lib/titlify.rb
+- lib/titlify/data/smart_format_rules.rb
+- lib/titlify/string_extensions.rb
+- lib/titlify/titlecase.rb
+- lib/titlify/version.rb
+- spec/spec_helper.rb
+- spec/titlify_spec.rb
+- titlify.gemspec
+homepage: http://github.com/fotw/titlify
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: titlify
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Gonna be the best damn titlecasing function around.
+test_files:
+- spec/spec_helper.rb
+- spec/titlify_spec.rb
+has_rdoc: