unicode_titlecase 0.0.1

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# Ignore /vendor directory, including gems vendored by bundle install --path
+/vendor
+
+# Ignore binstubs generated by bundle install --binstubs
+/bin

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p448

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in unicode_titlecase.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chong-Yee Khoo
+
+MIT License
+
+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.md

@@ -0,0 +1,103 @@
+# unicode_titlecase gem
+
+A set of methods added onto the String class to allow easy title casing of strings with Unicode text.
+
+## Features
+
+* handles Unicode text
+* specify words that should always be left capitalised
+* specify words that should always be left in lower case
+	
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'unicode_titlecase'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install unicode_titlecase e'.
+
+## Usage
+
+This gem patches the String class to provide a unicode_titlecase method, which returns a string that is 'title cased': the first letter in each significant word is in capitals with the rest in lowercase.
+
+To use, just call the unicode_titlecase method on any string you want to titlecase.
+
+For example,
+
+    require 'unicode_titlecase'
+    
+    s = "the rain in spain stays mainly in the plain"
+    puts s.unicode_titlecase
+    
+gives
+
+    "The Rain in Spain Stays Mainly in the Plain"
+
+More examples are set out in the YAML files in the /spec/examples directory.
+
+## Unicode Text
+
+With the help of the unicode-utils gem, we can properly handle title casing of Unicode text.
+
+For example, the string 'W Hiszpanii mży, gdy dżdżyste przyjdą dni' will be titlecased to 'W Hiszpanii Mży, Gdy Dżdżyste Przyjdą Dni'.
+
+Note: the source text may contain Unicode, or it may consist solely of ASCII. The unicode_titlecase method will work with either.
+
+## 'Big Words'
+
+In some circumstances, you may have source text that contains words that should remain capitalised. These include Roman numerals ('VIII'), legal entity designations ('SA', 'AB', 'LLC') or technical abbreviations ('RNA', DNA', 'HIV').
+
+The unicode_titlecase gem allows you to set up a list of 'big words' which it will keep upper-cased.
+
+## 'Small Words'
+
+Similarly, you source text may contain words that should always be in lower case.
+
+By convention, a number of short words such as 'is', 'of' and 'by' are considered to look better in text if they remain in lower case.
+
+For example, the phrase 'a government by the people for the people' might be title cased to 'A Government by the People for the People'.
+
+## Sources and Acknowledgements
+
+Much of the source is based on Sam Souder's 'titlecase' gem at [samsouder/titlecase] (http://github.com/samsouder/titlecase) which in turn is derived from the [rules] (http://daringfireball.net/2008/05/title_case) formulated by John Gruber.
+
+#### Gruber's Rules
+  - 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
+
+#### titlecase gem by samsouder
+
+  - implemented rules in Ruby
+  - [Github repo] (http://github.com/samsouder/titlecase)
+  - [Rubygems.org] (http://rubygems.org/gems/titlecase)
+ 
+#### Others
+  - Jim Nanney ([Github](https://github.com/jimnanney)) contributed to some of the code (go remote pairing!)
+  
+## Further Features?
+Here's a list of things we'd like to see in a future version of the unicode_titlecase gem. Please feel free to take any of these on (see [Contributing] (http://github.com/cantab/unicode_titlecase#contributing) below).
+  - handle strings with 'mixed case words' such as GmbH
+  - place exceptions into separate files in e.g., YAML (instead of storing in local variables)
+
+## Contributing
+Feel free to drop us a line to let us know you would like to work on something or if you have an idea. Otherwise, fork, code, commit, push and create pull request, *viz*:
+
+1. Create a fork of the repo from http://github.com/cantab/unicode_titlecase.
+2. Create your feature branch (`git checkout -b new-feature`).
+2. Write some tests (in RSpec, if you please).
+3. Write the code that allows the tests to pass.
+3. Commit your changes (`git commit -am 'Add some feature'`).
+4. Push to the branch (`git push origin new-feature`).
+5. Create a new [Pull Request] (https://help.github.com/articles/using-pull-requests).
+
+More details on how to contribute can be found at this great Thoughtbot blogpost [8 (new) steps for fixing other people's code] (http://robots.thoughtbot.com/8-new-steps-for-fixing-other-peoples-code).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/unicode_titlecase/core_ext/string.rb

@@ -0,0 +1,73 @@
+#encoding: UTF-8
+
+require 'unicode_utils'
+
+module UnicodeTitlecase
+  module CoreExt
+    module String
+
+      def unicode_titlecase
+        # List of exceptions: small_words are words that should always be in lowercase; big_words are words that should always be in uppercase
+        small_words = %w(a an and as at but by be for if in is of on or the to v v. via vs vs.)
+        big_words = %w(AB A.B. A/B AS A.S. A/S S.A. KG LLC LLP DNA RNA HBV HIV I II III IV V VI VII VIII IX X AC DC Q&A AT&T)
+
+        x = split(" ").map do |word|
+          # note: word could contain non-word characters!
+          # downcase all small_words, upcase all big words, smart capitalize the rest
+
+          word.replace(UnicodeUtils.downcase(word)) if word.all_caps? and not big_words.include?(word)
+
+          if small_words.include?(UnicodeUtils.downcase(word.gsub(/\W/, "")))
+            word.replace(UnicodeUtils.downcase(word))
+          else
+            if big_words.include?(UnicodeUtils.upcase(word.gsub(/\W/, "")))
+              word.replace(UnicodeUtils.upcase(word))
+            else
+              word.smart_capitalize!
+            end
+          end
+        end
+
+        x = x - [' ']
+
+        # capitalize first and last words
+        x.first.to_s.smart_capitalize!
+        # Uncomment the next line if you want the last word to be always initial caps
+        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 unicode_titlecase!
+        replace(unicode_titlecase)
+      end
+
+      def smart_capitalize
+        # ignore any leading crazy characters and capitalize the first real character
+        if self =~ /^['"\(\[']*(\S)/
+          i = index($1)
+          x = self[i,self.length]
+          # word with capitals and periods mid-word are left alone
+          self[i,1] = UnicodeUtils.upcase(self[i,1]) unless self.has_caps? or x =~ /\.\w+/
+        end
+        self
+      end
+
+      def smart_capitalize!
+        replace(smart_capitalize)
+      end
+
+      def has_caps?
+        return !UnicodeUtils.downcase(self) == self
+      end
+
+      def all_caps?
+        return UnicodeUtils.upcase(self) == self
+      end
+
+    end
+  end
+end
+
+String.send :include, UnicodeTitlecase::CoreExt::String

data/lib/unicode_titlecase/version.rb

@@ -0,0 +1,3 @@
+module UnicodeTitlecase
+  VERSION = "0.0.1"
+end

data/lib/unicode_titlecase.rb

@@ -0,0 +1,2 @@
+require "unicode_titlecase/version"
+require "unicode_titlecase/core_ext/string"

data/spec/examples/bigword_examples.yaml

@@ -0,0 +1,28 @@
+should_pass:
+  -
+    example: "Scientists discover DNA body clock"
+    expect:  "Scientists Discover DNA Body Clock"
+  -
+    example: "Swedish firm Fingerprint Cards AB"
+    expect:  "Swedish Firm Fingerprint Cards AB"
+  -
+    example: "Swedish firm Fingerprint Cards A.B."
+    expect:  "Swedish Firm Fingerprint Cards A.B."
+  -
+    example: "Swedish firm Fingerprint Cards A/B"
+    expect:  "Swedish Firm Fingerprint Cards A/B"
+  -
+    example: "Liver cancer often diagnosed late with poor survival in people with HIV"
+    expect:  "Liver Cancer Often Diagnosed Late With Poor Survival in People With HIV"
+  -
+    example: "A limited liability company (LLC) is legal entity"
+    expect: "A Limited Liability Company (LLC) is Legal Entity"
+  -
+    example: "Cantab LLP; small but perfectly formed"
+    expect:  "Cantab LLP; Small but Perfectly Formed"
+  -
+    example: "a limited liability company (llc) is a legal entity"
+    expect:  "A Limited Liability Company (LLC) is a Legal Entity"
+  -
+    example: "cantab llp. small but perfectly formed"
+    expect:  "Cantab LLP. Small but Perfectly Formed"

data/spec/examples/capitalisation_examples.yaml

@@ -0,0 +1,31 @@
+should_pass:
+  -
+    example: "THIS IS AN EXAMPLE OF A SENTENCE THAT STARTS OFF IN ALL CAPS"
+    expect:  "This is an Example of a Sentence That Starts Off in All Caps"
+  -
+    example: "This is an example of the same sentence that does not start off in all caps"
+    expect:  "This is an Example of the Same Sentence That Does Not Start Off in All Caps"
+  -
+    example: "THE RAIN IN SPAIN STAYS MAINLY IN THE PLAIN"
+    expect:  "The Rain in Spain Stays Mainly in the Plain"
+  -
+    example: "The rain in Spain stays mainly in the plain"
+    expect:  "The Rain in Spain Stays Mainly in the Plain"
+  -
+    example: "THE VITAMINS ARE IN MY FRESH CALIFORNIA RAISINS"
+    expect:  "The Vitamins Are in My Fresh California Raisins"
+  -
+    example: "MULTI-LAYER OPTICAL DISC"
+    expect:  "Multi-layer Optical Disc"
+  -
+    example: "Multi-layer optical disc"
+    expect:  "Multi-layer Optical Disc"
+  -
+    example: "SUN, Yat-Sen"
+    expect:  "Sun, Yat-Sen"
+  -
+    example: "SUN, Yat-sen"
+    expect:  "Sun, Yat-sen"
+  -
+    example: "SUN, YAT-SEN"
+    expect:  "Sun, Yat-sen"

data/spec/examples/smallword_examples.yaml

@@ -0,0 +1,4 @@
+should_pass:
+  -
+    example: "a government by the people for the people"
+    expect:  "A Government by the People for the People"

data/spec/examples/standard_examples.yaml

@@ -0,0 +1,70 @@
+should_pass:
+  -
+    example: "The rain in spain stays mainly on the plain"
+    expect:  "The Rain in Spain Stays Mainly on the Plain"
+  -
+    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/examples/unicode_examples.yaml

@@ -0,0 +1,31 @@
+should_pass:
+  -
+    example: "W Hiszpanii mży, gdy dżdżyste przyjdą dni"
+    expect:  "W Hiszpanii Mży, Gdy Dżdżyste Przyjdą Dni"
+  -
+    example: "AVANGART KURUTMA TEKNOLOJİLERİ SANAYİ İÇ VE DIŞ TİCARET LİMİLED ŞİRKETİ"
+    expect:  "Avangart Kurutma Teknoloji̇leri̇ Sanayi̇ İÇ Ve Diş Ti̇caret Li̇mi̇led Şi̇rketi̇"
+  -
+    example: "МНОГОСЛОЙНЫЙ ОПТИЧЕСКИЙ ДИСК"
+    expect:  "Многослойный Оптический Диск"
+  -
+    example: "УСТРОЙСТВО ДЛЯ ЗАПИСИ-СТИРАНИЯ-СЧИТЫВАНИЯ ИНФОРМАЦИИ В МНОГОСЛОЙНОМ ОПТИЧЕСКОМ ДИСКЕ"
+    expect:  "Устройство Для Записи-стирания-считывания Информации В Многослойном Оптическом Диске"
+  -
+    example: "УСТРОЙСТВО ДЛЯ СБОРА СОСУЛЕК"
+    expect:  "Устройство Для Сбора Сосулек"
+  -
+    example: "KIYKO, Vаdim Vеniаminоviсh, dеr. Khоdаеvо, 75, Сhеkhоvsky r-n, Моskоvskауа оbl., 142302"
+    expect:  "Kiyko, Vаdim Vеniаminоviсh, Dеr. Khоdаеvо, 75, Сhеkhоvsky R-n, Моskоvskауа Оbl., 142302"
+  -
+    example: "hyvää huomenta"
+    expect:  "Hyvää Huomenta"
+  -
+    example: "孫中山"
+    expect:  "孫中山"
+  -
+    example: "Sūn Zhōngshān"
+    expect:  "Sūn Zhōngshān"
+  -
+    example: "sūn zhōngshān nányáng jìniàn guǎn"
+    expect:  "Sūn Zhōngshān Nányáng Jìniàn Guǎn"

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+#encoding: UTF-8
+
+require 'unicode_titlecase'
+require 'yaml'
+require 'rspec'
+
+def run_examples_from_file(filename)
+
+  File.open(File.join(File.dirname(__FILE__), "examples/", *filename)) do |file|
+    examples = YAML.load(file)
+    examples["should_pass"].each do |e|
+      it "#{e["example"]} when titlecased is the expected value (#{e["expect"]})" do
+        expect(e["example"].unicode_titlecase).to eq(e["expect"])
+      end
+    end
+  end
+end
+

data/spec/unicode_titlecase_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe String do
+
+  let(:string) { 'the rain in spain' }
+
+  describe "unicode_titlecase method" do
+
+    it "returns a title cased version of the string" do
+      expect(string.unicode_titlecase).to eq('The Rain in Spain')
+    end
+
+    it "does not modify the original string" do
+      string.unicode_titlecase
+      expect(string).to eq('the rain in spain')
+    end
+  end
+
+  describe "unicode_titlecase! method" do
+
+    it "returns a title cased version of the string" do
+      expect(string.unicode_titlecase!).to eq('The Rain in Spain')
+    end
+
+    it "self-modifies the original value in place" do
+      string.unicode_titlecase!
+      expect(string).to eq('The Rain in Spain')
+    end
+  end
+
+  describe "examples" do
+
+    describe "bigword examples" do
+      run_examples_from_file('bigword_examples.yaml')
+    end
+
+    describe "capitalisation examples" do
+      run_examples_from_file('capitalisation_examples.yaml')
+    end
+
+    describe "smallword examples" do
+      run_examples_from_file('smallword_examples.yaml')
+    end
+
+    describe "standard examples" do
+      run_examples_from_file('standard_examples.yaml')
+    end
+
+    describe "unicode examples" do
+      run_examples_from_file('unicode_examples.yaml')
+    end
+  end
+end

data/unicode_titlecase.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'unicode_titlecase/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "unicode_titlecase"
+  gem.version       = UnicodeTitlecase::VERSION
+  gem.authors       = ["Chong-Yee Khoo"]
+  gem.email         = ["mail@cykhoo.com"]
+  gem.description   = %q{Titlecaser with Unicode smarts}
+  gem.summary       = %q{Change text, including in Unicode, to title case}
+  gem.homepage      = "http://github.com/cykhoo/unicode_titlecase"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+
+  gem.add_runtime_dependency 'unicode_utils'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: unicode_titlecase
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chong-Yee Khoo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: unicode_utils
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Titlecaser with Unicode smarts
+email:
+- mail@cykhoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/unicode_titlecase.rb
+- lib/unicode_titlecase/core_ext/string.rb
+- lib/unicode_titlecase/version.rb
+- spec/examples/bigword_examples.yaml
+- spec/examples/capitalisation_examples.yaml
+- spec/examples/smallword_examples.yaml
+- spec/examples/standard_examples.yaml
+- spec/examples/unicode_examples.yaml
+- spec/spec_helper.rb
+- spec/unicode_titlecase_spec.rb
+- unicode_titlecase.gemspec
+homepage: http://github.com/cykhoo/unicode_titlecase
+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'
+      segments:
+      - 0
+      hash: -1860229550247952293
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1860229550247952293
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Change text, including in Unicode, to title case
+test_files:
+- spec/examples/bigword_examples.yaml
+- spec/examples/capitalisation_examples.yaml
+- spec/examples/smallword_examples.yaml
+- spec/examples/standard_examples.yaml
+- spec/examples/unicode_examples.yaml
+- spec/spec_helper.rb
+- spec/unicode_titlecase_spec.rb