titleize_pt 0.0.1

data/.gitignore

@@ -0,0 +1,10 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ruby specifics
+Gemfile.lock
+pkg/*
+.yardoc

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David Francisco
+
+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,46 @@
+### Properly capitalize titles in Portuguese
+
+ActiveSupport gives us the `titleize` method to create nice looking titles, but sometimes the result may not be what you excepted:
+
+```ruby
+"GUIA DE SOBREVIVÊNCIA".titleize # => "Guia De SobrevivÊncia"
+"órgão emissor".titleize # => "órgão Emissor"
+"HTTP request".titleize  # => "Http Request"
+```
+
+Though this may not be hard to solve:
+
+```ruby
+"GUIA DE SOBREVIVÊNCIA".mb_chars.titleize   # => "Guia De Sobrevivência"
+"órgão emissor".mb_chars.titleize # => "Órgão Emissor"
+ActiveSupport::Inflector.inflections { |inflect| inflect.acronym "HTTP" }
+"HTTP request".titleize # => "HTTP Request"
+```
+
+The [`titleize`](https://github.com/granth/titleize) gem does some extra work to properly capitalize titles in English:
+
+```ruby
+# ActiveSupport titleize method
+"a lovely and talented title".titleize # => "A Lovely And Talented Title"
+
+# Using the titleize gem
+"a lovely and talented title".titleize # => "A Lovely and Talented Title"
+```
+
+This gem is not nearly as advanced as the `titleize` gem but knows how to deal with characters and handles titles in Portuguese:
+
+```ruby
+"GUIA DE SOBREVIVÊNCIA".titleize_pt # => "Guia de Sobrevivência"
+"proposta para uma directiva da UE".titleize_pt # => "Proposta para uma Directiva da UE"
+"a lovely and talented title".titleize_locale(:en) # => "A Lovely and Talented Title"
+```
+
+### Usage
+
+The gem requires ActiveSupport, so it's more suitable for Ruby on Rails projects. Add to your Gemfile and run `bundle`:
+
+    gem "titleize_pt"
+
+### Credits
+
+Some tests and code copied from [granth/titleize](https://github.com/granth/titleize).

data/Rakefile

@@ -0,0 +1,21 @@
+#!/usr/bin/env rake
+
+# To turn specs with verbose output:
+#   bundle exec rake test:spec TESTOPTS="--verbose"
+#
+# For additional help:
+#   rake --tasks
+#
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+Rake::TestTask.new(:spec) do |t|
+  ENV["RACK_ENV"] = "test"
+  t.libs << "spec"
+  t.pattern = "spec/**/*_spec.rb"
+end
+
+desc "Uninstall the current version of titleize_pt"
+task :uninstall do
+  puts `gem uninstall -x titleize_pt` # -x flag uninstalls executables too without confirmation
+end

data/lib/titleize_pt/version.rb

@@ -0,0 +1,3 @@
+module TitleizePT
+  VERSION = '0.0.1'
+end

data/lib/titleize_pt.rb

@@ -0,0 +1,75 @@
+# -*- encoding: utf-8 -*-
+
+require 'active_support/multibyte'
+require 'active_support/core_ext/string'
+
+# Creates properly capitalized titles (original implementation found at git.io/i0UnkA).
+# For example, "a lovely and talented title" becomes "A Lovely and Talented Title".
+#
+# Supports unicode characters (using ActiveSupport::Multibyte::Chars).
+# For example, "OLÁ MUNDO" becomes "Olá Mundo" instead of "OlÁ Mundo".
+#
+module TitleizePT
+  WORDS = {
+    # List of words from the "New York Times Manual of Style"
+    en: %w{ a an and as at but by en for if in of on or the to v v. via vs vs. },
+
+    # Portuguese words that should not be capitalized. To improve the list, the
+    # "Acordo Ortográfico de 1945" document may be a good resource.
+    # Wikipedia also has guidelines on this: http://goo.gl/28T0h
+    pt: %w{ a as da das de do dos e o os para por sobre um uns uma umas }
+  }
+
+  def self.titleize_pt(title)
+    titleize_locale(title, :pt)
+  end
+
+  def self.titleize_locale(title, locale = nil)
+    locale = (WORDS.key?(I18n.locale) ? I18n.locale : :pt) if locale.blank?
+
+    if title[/[[:lower:]]/]
+      # Similar to the existent `titleize` method from ActiveSupport but respect acronyms
+      title = title.split.map { |w| /^\p{Upper}*$/.match(w) ? w : w.downcase }.join(' ')
+    else
+      title.downcase! # If the entire title is all-uppercase, assume it needs to be fixed
+    end
+
+    title = title.to_s.gsub(/\b('?[\S])/u) { ActiveSupport::Multibyte::Unicode.apply_mapping $1, :uppercase_mapping }
+    words = title.split
+    first = words.shift
+
+    if words.empty?
+      first # The first word should always be capitalized
+    else
+      first +" "+ words.map { |w| WORDS[locale].include?(w.downcase) ? w.downcase : w }.join(' ')
+    end
+  end
+end
+
+class String
+  def titleize_pt
+    TitleizePT.titleize_pt(self.mb_chars)
+  end
+
+  def titleize_locale(locale = nil)
+    TitleizePT.titleize_locale(self.mb_chars, locale)
+  end
+
+  alias_method :titlecase_pt, :titleize_pt
+  alias_method :titlecase_locale, :titleize_locale
+end
+
+module ActiveSupport::Multibyte
+  class Chars
+    def titleize_pt
+      chars TitleizePT.titleize_pt(self)
+    end
+
+    def titleize_locale(locale = nil)
+      chars TitleizePT.titleize_locale(self, locale)
+    end
+
+    alias_method :titlecase_pt, :titleize_pt
+    alias_method :titlecase_locale, :titleize_locale
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require 'titleize_pt'

data/spec/titleize_pt/titleize_spec.rb

@@ -0,0 +1,70 @@
+# -*- encoding: utf-8 -*-
+
+require "spec_helper"
+
+# Some of the following tests were taken from the original module (git.io/i0UnkA)
+describe "TitleizePT module" do
+  it "should return a string if a string is given" do
+    "this".titleize_locale.must_be_instance_of String
+  end
+
+  it "should return an ActiveSupport::Multibyte::Chars object if one is given" do
+    "this".mb_chars.titleize_locale.must_be_instance_of ActiveSupport::Multibyte::Chars
+  end
+
+  it "should properly capitalize titles that contain unicode characters" do
+    "café périferôl".titleize_pt.must_equal "Café Périferôl"
+    "órgão partidário".titleize_pt.must_equal "Órgão Partidário"
+  end
+
+  it "should return the same result for `string.titleize_pt` and `mb_chars.titleize_pt`" do
+    "café périferôl".titleize_pt.must_equal "café périferôl".mb_chars.titleize_pt.to_s
+  end
+
+  it "should fix all-caps titles" do
+    "GUIA DE SOBREVIVÊNCIA".titleize_pt.must_equal "Guia de Sobrevivência"
+  end
+
+  it "should capitalize the first letter of regular words" do
+    "cat beats monkey".titleize_locale.must_equal "Cat Beats Monkey"
+  end
+
+  it "should not capitalize listed words" do
+    TitleizePT::WORDS[:en].each do |word|
+      "first #{ word } last".titleize_locale.must_equal "First #{ word } Last"
+    end
+  end
+
+  it "should downcase a listed word if it is capitalized" do
+    TitleizePT::WORDS[:en].each do |word|
+      "first #{ word.capitalize } last".titleize_locale.must_equal "First #{ word } Last"
+    end
+  end
+
+  it "should not think a quotation mark makes a dot word" do
+    "'quoted.' yes.".titleize_locale.must_equal "'Quoted.' Yes."
+    "ends with 'quotation.'".titleize_locale.must_equal "Ends With 'Quotation.'"
+  end
+
+  it "should not capitalize words that start with a number" do
+    "2lmc".titleize_locale.must_equal "2lmc"
+  end
+
+  it "should handle hyphenated words" do
+    "the la-la land".titleize_locale.must_equal "The La-La Land"
+  end
+
+  it "should handle non-breaking hyphens" do
+    "non‑breaking hyphen".titleize_locale.must_equal "Non‑Breaking Hyphen"
+  end
+
+  it "should capitalize a listed word if it is the first word" do
+    TitleizePT::WORDS[:en].each do |word|
+      "#{ word } is listed".titleize_locale.must_equal "#{ word.capitalize } Is Listed"
+    end
+  end
+
+  it "should leave all-uppercase words untouched" do
+    "um pedido HTTP".titleize_pt.must_equal "Um Pedido HTTP"
+  end
+end

data/titleize_pt.gemspec

@@ -0,0 +1,18 @@
+require File.expand_path('../lib/titleize_pt/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name     = 'titleize_pt'
+  gem.version  = TitleizePT::VERSION
+  gem.authors  = ['David Francisco']
+  gem.email    = 'titleize@dmfranc.com'
+  gem.summary  = 'Properly capitalize titles in Portuguese'
+  gem.platform = Gem::Platform::RUBY
+  gem.required_ruby_version = '>= 1.9.3'
+
+  gem.files = `git ls-files`.split($\)
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rake", "~> 10.0.4"
+  gem.add_runtime_dependency "activesupport", "~> 3.2.13"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: titleize_pt
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Francisco
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-20 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: 10.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.4
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+description: 
+email: titleize@dmfranc.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/titleize_pt.rb
+- lib/titleize_pt/version.rb
+- spec/spec_helper.rb
+- spec/titleize_pt/titleize_spec.rb
+- titleize_pt.gemspec
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Properly capitalize titles in Portuguese
+test_files:
+- spec/spec_helper.rb
+- spec/titleize_pt/titleize_spec.rb