nicetitle 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d5b9964e2b7b9a8adce1471dc741fa73b203dbb2f93029514ccfd95f01cdcad
-  data.tar.gz: 77a597415ea22bbc23083f9b772c97878dcce8fa1bcf2677aa68bd41bd64f8ef
+  metadata.gz: acdf70e5f6210b7dc71ec29abbe687d930fbf6545ac94b5497685efe0f9f7cfc
+  data.tar.gz: ef8ef1482ba1048733fbbf240c2265ecbd6541bb5d79874e76716616318494bb
 SHA512:
-  metadata.gz: f46c3fc6be32ad7fefd0d32116b6a91635f74c700a305cf1c2e6d2ed084c931b757810b44557d2cccb2939b6e063295b7cc5d4ed35db107a53e1a6c1a573c7a2
-  data.tar.gz: 8ece349e479c3034bf185264d1f0d4193d172d43f66d0d5d7d7faf959601459381ebd87efe5740c80de38dd5b0f20c1e480be8f5d47582cefd0ac2129fc681b6
+  metadata.gz: 95dbfaee5c62af9e4c91ead24e1b5c780747856c69f46452d61fd8bbcaae69ed21e405d74013173f1a1e5c7d65f4317dcc5d215eb4e146af73402cdd091e555a
+  data.tar.gz: '0591667493b91dc4947164dfbfe7750f379edfef3a2e4acc8365eb28257955f7316b06242eb5c532282aed09864a9c6016319469fd2554bc2e8518e497eb676f'

data/README.md

@@ -17,7 +17,7 @@ The rule set is:
 - Words containing dots are not capitalized.
 - All caps sentences are down-cased before applying above mentioned rules.
 
-Check out the [test cases](https://github.com/evaneykelen/nicetitle/test/nicetitle_test.rb) for a detailed overview.
+Check out the [test cases](https://github.com/evaneykelen/nicetitle/blob/master/test/nicetitle_test.rb) for a detailed overview.
 
 ## Installation
 
@@ -39,7 +39,7 @@ Or install it yourself as:
 
 Calling
 
-`Nicetitle::Titlecase.titlecase('What am I reading/listing/applying these days?')`
+`Nice.title('What am I reading/listing/applying these days?')`
 
 outputs
 

data/lib/nicetitle.rb

@@ -1,2 +1,8 @@
 require "nicetitle/version"
 require "nicetitle/titlecase"
+
+class Nice
+  def self.title(str)
+    Nicetitle::Titlecase.titlecase(str)
+  end
+end

data/lib/nicetitle/titlecase.rb

@@ -0,0 +1,70 @@
+module Nicetitle
+  class Titlecase
+    SMALL_WORDS = Regexp.new('\b(a(nd|n|s|t)?|b(ut|y)|en|for|i(f|n)|o(f|n|r)|t(he|o)|vs?\.?)\b').freeze
+
+    def self.is_small_word?(word)
+      SMALL_WORDS.match(word)
+    end
+
+    # "__foo" => "__Foo"
+    def self.upcase_first_real_letter(word)
+      word.sub(/[a-zA-Z0-9]/, &:upcase)
+    end
+
+    # step-by-step => Step-by-Step
+    def self.upcase_word_with_dashes(word)
+      word.split('-').map { |part| is_small_word?(part) ? part : part.capitalize }.join("-")
+    end
+
+    # before/after => Before/After
+    def self.upcase_word_with_slashes(word)
+      word.split('/').map(&:capitalize).join('/')
+    end
+
+    def self.titlecase(str)
+      # Replace tabs by single space
+      # Replace weird spaces by regular space
+      str = (str || '').gsub(/\t/, ' ').gsub("\u{2011}", ' ').strip
+      return '' if str.empty?
+
+      # Downcase an all-upcase sentence
+      str.downcase! if str.scan(/[A-Z]|\s|\W/).length == str.length
+
+      # Split sentence at space boundaries
+      word_arr = str.split(' ')
+
+      # Initialize operand array
+      operand_arr = Array.new(word_arr.size, :capitalize)
+
+      word_arr.each_with_index do |word, idx|
+        # Don't capitalize small words...
+        # ... unless it's first word
+        # ... unless it's last word
+        # ... unless word is preceded by word ending with colon
+        operand_arr[idx] = :do_not_upcase  if idx != 0 && idx != word_arr.size - 1 && is_small_word?(word) && word_arr[idx - 1][-1] != ':'
+        # Don't simply capitalize first letter if word starts with (, _, ', or "
+        operand_arr[idx] = :upcase_later   if word[0].match(/\(|_|'|"/)
+        # Capitalize first letter and letters preceded by -
+        operand_arr[idx] = :upcase_dashed  if word.count('-') > 0
+        # Capitalize letters preceded by / inside word
+        operand_arr[idx] = :upcase_slashed if word[1..].count('/') > 0
+        # Don't capitalize word if it starts with /
+        operand_arr[idx] = :do_not_upcase  if word[0] == '/'
+        # Don't capitalize URLs
+        operand_arr[idx] = :do_not_upcase  if word.match(/https?:\/\//i)
+        # Don't capitalize words containing capitals besides first letter
+        # Don't capitalize words containing dots inside word
+        operand_arr[idx] = :do_not_upcase  if word[1..].match(/[A-Z]/) || word[1..-3].match(/\.|&/)
+      end
+
+      word_arr.each_with_index do |word, idx|
+        word_arr[idx] = upcase_first_real_letter(word) if operand_arr[idx] == :upcase_later
+        word_arr[idx] = upcase_word_with_dashes(word)  if operand_arr[idx] == :upcase_dashed
+        word_arr[idx] = upcase_word_with_slashes(word) if operand_arr[idx] == :upcase_slashed
+        word_arr[idx] = word.capitalize                if operand_arr[idx] == :capitalize
+      end
+
+      word_arr.join(' ')
+    end
+  end
+end

data/lib/nicetitle/version.rb

@@ -1,3 +1,3 @@
 module Nicetitle
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nicetitle
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Erik van Eykelen
@@ -60,7 +60,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -68,6 +67,7 @@ files:
 - bin/console
 - bin/setup
 - lib/nicetitle.rb
+- lib/nicetitle/titlecase.rb
 - lib/nicetitle/version.rb
 - nicetitle.gemspec
 homepage: https://www.msgtrail.com/articles/20190525-1530-title-casing-is-harder-than-i-thought/

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.1
-before_install: gem install bundler -v 2.0.1