title_case 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6520a30961251756fa27f58ef65ae05e3f741700
+  data.tar.gz: b9b0b74909e8906d8bd5823933262367c01167dc
+SHA512:
+  metadata.gz: 8d27296244fe8273f23e446a788b31036fc86a6b64247d44c8878e9e04f5ff384c45c5a3c1c9e928c2fff219249896c2dc34d9f53a06d86bab66e5eb8783e19b
+  data.tar.gz: cf788e6391772dd0c2b19a3a825bc2347cf12c9c489fbaa1cbf329ce97720e6a16fb6e13f00d656ed840b278fc239afcc0898986654617cc43d69576fcd13625

data/README.md

@@ -0,0 +1,43 @@
+title_case
+---------
+
+A ruby gem consisting of String methods to title case strings,
+including a command-line demonstration utility.
+
+Method Usage:
+
+  require 'rubygems'
+  require 'title_case'
+
+  FIXME this is not done yet.
+
+Command Line Usage:
+
+  $ echo capitalize a phrase like a newspaper editor would  | titlecase
+
+  Capitalize a Phrase Like a Newspaper Editor Would
+
+Inspiration and History
+---------
+
+This is partially inspired and informed by John Gruber's titlecase: 
+<http://daringfireball.net/2008/05/title_case>
+and Sam Souder's ruby implementation:
+FIXME
+
+I didn't like a few of the rules in Gruber's version, though.
+Major differences are:
+  - don't ever dowcase anything
+  - the last word doesn't get upcased if it is on the exclude list
+  - the exclude list is slightly different
+  - colons get no special treatment
+
+
+License
+---------
+© 2014 Noah Birnel
+Do whatever you want to with this code.
+
+
+
+

data/bin/titlecase

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'title_case'
+
+# Boilerplate for adding flags.
+loop { case ARGV[0]
+  when /--/ then ARGV.shift; break
+  when /^-/ then usage("Unknown option: #{ARGV[0].inspect}")
+  else break
+end; }
+
+while gets() do
+  line = $_.chomp
+  tced = line.title_case_line
+  puts tced
+end   

data/lib/title_case.rb

@@ -0,0 +1,27 @@
+class String
+
+  def title_case_word
+    # the non-alpha beginning lets us capitalize "'the'" to "'The'",
+    self.sub(/^[^[:alpha:]]*[[:alpha:]]/){|first| first.upcase}
+  end
+
+  def title_case_line
+    art  = "(a)|(an)|(the)"
+    prep = "(on)|(in)|(to)|(by)|(for)|(at)|(of)|(as)|(off)|(as)|(out)|(up)"
+    part = "(if)"
+    conj = "(and)|(but)|(nor)|(or)|(yet)|(so)"
+    abbr = "(re)|(w)|(etc)|(v)|(vs)"
+    ignore_raw = '(' + [art, prep, part, conj, abbr].join('|') + ')'
+    punct_wrap = "[^[:alpha:]]*"
+    ignore = Regexp.new('^' + punct_wrap + ignore_raw + punct_wrap + '$')
+
+    title_case_words =  self.split.map.with_index do |word, index|
+      (word =~ /[[:upper:][:digit:]]/) || ( index > 0 && ignore.match(word)) \
+        ? word \
+        : word.title_case_word
+    end
+
+    title_case_words.join(' ')
+  end
+
+end

data/spec/title_case_spec.rb

@@ -0,0 +1,58 @@
+load  "#{File.dirname(__FILE__)}/../lib/title_case.rb"
+
+#FIXME can't seem to do the fancy ruby native relative path thing
+# without naming our program title_case.rb, which I don't want
+
+describe "title_case_word" do
+  it "title_cases a single word" do
+    "foo".title_case_word.should eq "Foo"
+  end
+  
+  it "Ignores external apostrophes" do
+    "'thing'".title_case_word.should eq "'Thing'"
+  end
+
+  it "sees internal apostrophes" do
+    "don't".title_case_word.should eq "Don't"
+  end
+
+end
+
+describe "title_case_line" do
+  it "basically works" do
+    "do it".title_case_line.should eq "Do It"
+  end
+
+  it "ignores short preposition, conjunction, and articles in middle " do
+    "go to".title_case_line.should eq "Go to"
+  end
+
+  it "ignores 'words' with mixed numbers" do
+    "buy me a x0xb0x".title_case_line.should eq "Buy Me a x0xb0x"
+  end
+
+  it "capitalizes the first word even it it's on the ignore list" do
+    "to France".title_case_line.should eq "To France"
+  end
+
+  it "but doesn't capitalize the first word if it's camelcased" do
+    "eTrade is still around".title_case_line.should eq "eTrade Is Still Around"
+  end
+
+  it "Ignores external apostrophes in exceptions" do
+    "don't go 'to' Chicago".title_case_line.should eq "Don't Go 'to' Chicago"
+  end
+
+  it "retains punctuation" do
+    "shazam! what? don't go, young man...".title_case_line.should eq "Shazam! What? Don't Go, Young Man..."
+  end
+
+  it "ignores mixed case even as first word" do
+    "iPhone".title_case_line.should eq "iPhone"
+  end
+
+  it "doesn't falsely capitalize Dutch abbreviations" do
+    pending
+    "Mr 't Horne went to 's Grave".title_case_line.should eq "Mr 't Horne went to 's Grave"
+  end
+end

data/title_case.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name        = 'title_case'
+  s.version     = '0.1.1'
+  s.date        = '2014-02-14'
+  s.summary     = 'String methods and CLI to properly title case a headline.'
+  s.description = 'title_case is a set of Ruby String methods for title casing,
+                    and a command-line utility using those methods.'
+  s.authors     = ['Noah Birnel']
+  s.email       = 'nbirnel@gmail.com'
+  s.homepage    = 'http://github.com/nbirnel/titlecase'
+  s.files       = ['README.md', 'title_case.gemspec', 'lib/title_case.rb', 'spec/title_case_spec.rb', 'bin/titlecase']
+  s.has_rdoc    = false
+  s.executables = ['titlecase']
+  s.license     = 'MIT'
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: title_case
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Noah Birnel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-14 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  title_case is a set of Ruby String methods for title casing,
+                      and a command-line utility using those methods.
+email: nbirnel@gmail.com
+executables:
+- titlecase
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/titlecase
+- lib/title_case.rb
+- spec/title_case_spec.rb
+- title_case.gemspec
+homepage: http://github.com/nbirnel/titlecase
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: String methods and CLI to properly title case a headline.
+test_files: []