titleize 1.2.1 → 1.3.0

data/History.txt

@@ -1,3 +1,13 @@
+=== 1.3.0 / 2013-03-07
+
+* add String#titleize! [Scott Pullen]
+* allow disabling of humanize/underscore in ActiveSupport#titleize [Jayme Deffenbaugh]
+* RSpec 2
+
+=== 1.2.1 / 2011-04-15
+
+* Bundler
+
 === 1.2.0 / 2010-07-22
 
 * Ruby 1.9 compatibility. [Jason Weathered]

data/{README.txt → README.md}

@@ -1,30 +1,32 @@
-= Titleize
+# Titleize
 
-* http://rubygems.org/gems/titleize
+http://rubygems.org/gems/titleize
 
-== DESCRIPTION:
+### Description
 
-Adds String#titleize for creating properly capitalized titles.
-It can be called as Titleize.titleize or "a string".titleize. It is also
-aliased as titlecase.
+Adds `String#titleize` for creating properly capitalized titles.
+It can be called as `Titleize.titleize` or `"a string".titleize`. It is also
+aliased as `titlecase`.
 
-The list of "small words" which are not capped comes from the New York Times 
+The list of "small words" which are not capped comes from the New York Times
 Manual of Style, plus 'vs' and 'v'.
 
-If loaded in a Rails environment, it modifies Inflector.titleize.
+If loaded in a Rails environment, it modifies `Inflector#titleize`. By default
+ActiveSupport calls `Inflector#underscore` and `Inflector#humanize`. This however
+can be problematic with words like "iPod", "GPS", and "McArthur". To disable
+this behavior, use the options `:underscore => false` and `:humanize => false`.
 
-Based on TitleCase.pl by John Gruber.
-http://daringfireball.net/2008/05/title_case
+Based on [TitleCase.pl](http://daringfireball.net/2008/05/title_case) by John Gruber.
 
-== SYNOPSIS:
+### Synopsis
 
-  "a lovely and talented title".titleize # => "A Lovely and Talented Title"
+`"a lovely and talented title".titleize # => "A Lovely and Talented Title"`
 
-== INSTALL:
+### Install
 
-* gem install titleize
+`gem install titleize`
 
-== LICENSE:
+### License
 
 (The MIT License)
 

data/Rakefile

@@ -1,11 +1,11 @@
 require 'bundler'
-require 'spec/rake/spectask'
+require 'rspec/core/rake_task'
 Bundler::GemHelper.install_tasks
 
 desc "Run all specs"
-Spec::Rake::SpecTask.new('spec') do |t|
-  t.spec_files = FileList['spec/*_spec.rb']
-  t.spec_opts = ['--options', "spec/spec.opts"]
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/*_spec.rb'
+  spec.rspec_opts = '--format documentation --colour --backtrace'
 end
 
 task :default => [:spec]

data/lib/titleize.rb

@@ -81,14 +81,19 @@ class String
   #
   #   "notes on a scandal" # => "Notes on a Scandal"
   #   "the good german"    # => "The Good German"
-  def titleize
+  def titleize(opts={})
     if defined? ActiveSupport
-      ActiveSupport::Inflector.titleize(self)
+      ActiveSupport::Inflector.titleize(self, opts)
     else
       Titleize.titleize(self)
     end
   end
   alias_method :titlecase, :titleize
+
+  def titleize!
+    replace(titleize)
+  end
+  alias_method :titlecase!, :titleize!
 end
 
 if defined? ActiveSupport
@@ -102,14 +107,20 @@ if defined? ActiveSupport
     #
     # This replaces the default Rails titleize. Like the default, it uses
     # Inflector.underscore and Inflector.humanize to convert
-    # underscored_names and CamelCaseNames to a more human form.
+    # underscored_names and CamelCaseNames to a more human form. However, you can change
+    # this behavior by passing :humanize => false or :underscore => false as options. 
+    # This can be useful when dealing with words like "iPod" and "GPS".
     #
     # titleize is also aliased as titlecase.
     #
     #   "notes on an active_record" # => "Notes on an Active Record"
     #   "the GoodGerman"            # => "The Good German"
-    def titleize(title)
-      Titleize.titleize(ActiveSupport::Inflector.humanize(ActiveSupport::Inflector.underscore(title)))
+    def titleize(title, opts={})
+      opts = {:humanize => true, :underscore => true}.merge(opts)
+      title = ActiveSupport::Inflector.underscore(title) if opts[:underscore]
+      title = ActiveSupport::Inflector.humanize(title) if opts[:humanize]
+
+      Titleize.titleize(title)
     end
     alias_method :titlecase, :titleize
   end

data/lib/titleize/version.rb

@@ -1,3 +1,3 @@
 module Titleize
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

data/spec/titleize_spec.rb

@@ -241,6 +241,20 @@ describe ActiveSupport::Inflector do
       titleize(@title).should == "Active Record and Active Resource"
     end
 
+    it "should allow disabling of Inflector#underscore" do
+      humanized_title = "Active record and activeresource"
+      ActiveSupport::Inflector.should_not_receive(:underscore)
+      ActiveSupport::Inflector.should_receive(:humanize).with(@title).and_return(humanized_title)
+      titleize(@title, :underscore => false).should == "Active Record and Activeresource"
+    end
+
+    it "should allow disabling of Inflector#humanize" do
+      underscored_title = "active_record and active_resource"
+      ActiveSupport::Inflector.should_not_receive(:humanize)
+      ActiveSupport::Inflector.should_receive(:underscore).with(@title).and_return(underscored_title)
+      titleize(@title, :humanize => false).should == "Active_record and Active_resource"
+    end
+
     it "should replace Inflector.titleize" do
       Titleize.should_receive(:titleize).with(@title)
       ActiveSupport::Inflector.stub!(:underscore).and_return(@title)
@@ -262,6 +276,10 @@ describe String do
     String.instance_methods.map(&:to_sym).should include(:titleize)
   end
 
+  it "should have a titleize! method" do
+    String.instance_methods.map(&:to_sym).should include(:titleize!)
+  end
+
   it "should work" do
     "this is a test".titleize.should == "This Is a Test"
   end
@@ -272,11 +290,35 @@ describe String do
     title.titlecase.should == title.titleize
   end
 
+  context 'when using the self modified version of titleize' do
+    it 'should work' do
+      test_str = 'this is a test'
+      test_str.titleize!
+      test_str.should == 'This Is a Test'
+    end
+
+    it 'should be aliased as #titlecase!' do
+      test_str = 'this is a test'
+      test_str.titlecase!
+      test_str.should == 'This Is a Test'
+    end
+  end
+
   context "when ActiveSupport is loaded" do
     it "should act the same as Inflector#titleize" do
-      ActiveSupport::Inflector.should_receive(:titleize).with("title")
+      ActiveSupport::Inflector.should_receive(:titleize).with("title", {})
       "title".titleize
     end
+
+    it "should allow disabling of Inflector#underscore" do
+      ActiveSupport::Inflector.should_not_receive(:underscore)
+      "title".titleize(:underscore => false)
+    end
+
+    it "should allow disabling of Inflector#humanize" do
+      ActiveSupport::Inflector.should_not_receive(:humanize)
+      "title".titleize(:humanize => false)
+    end
   end
 
   context "when ActiveSupport is not loaded" do

data/titleize.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 1.3.6") if s.respond_to? :required_rubygems_version=
   s.rubyforge_project = "titleize"
 
-  s.add_development_dependency "rspec", "~> 1.3"
+  s.add_development_dependency "rspec", "~> 2.13"
   s.add_development_dependency "rake"
 
   s.files         = `git ls-files`.split("\n")

metadata

@@ -1,111 +1,90 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: titleize
-version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
-  segments: 
-  - 1
-  - 2
-  - 1
-  version: 1.2.1
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Grant Hollingworth
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-04-15 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 1
-        - 3
-        version: "1.3"
+      - !ruby/object:Gem::Version
+        version: '2.13'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-description: Adds String#titleize for creating properly capitalized titles. Replaces ActiveSupport::Inflector.titleize if ActiveSupport is present.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds String#titleize for creating properly capitalized titles. Replaces
+  ActiveSupport::Inflector.titleize if ActiveSupport is present.
+email:
 - grant@antiflux.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - History.txt
-- Manifest.txt
-- README.txt
+- README.md
 - Rakefile
 - lib/titleize.rb
 - lib/titleize/version.rb
-- spec/spec.opts
 - spec/spec_helper.rb
 - spec/titleize_spec.rb
 - titleize.gemspec
-has_rdoc: true
 homepage: http://rubygems.org/gems/titleize
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: titleize
-rubygems_version: 1.3.7
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Adds String#titleize for creating properly capitalized titles.
-test_files: 
-- spec/spec.opts
+test_files:
 - spec/spec_helper.rb
 - spec/titleize_spec.rb

data/Manifest.txt

@@ -1,8 +0,0 @@
-History.txt
-Manifest.txt
-README.txt
-Rakefile
-lib/titleize.rb
-spec/spec.opts
-spec/titleize_spec.rb
-spec/spec_helper.rb

data/spec/spec.opts

@@ -1,3 +0,0 @@
---format specdoc --colour
---backtrace
-