msgtrail 0.9.3 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28e7072fe3ebdebc29a89edccec28b74522208f82be5aeef20ad627564b37d07
-  data.tar.gz: 2e1eab46f795631e71f00f9125afb82bff67f67e2cdc58cf684b61d862b1a375
+  metadata.gz: 37b3e65f039cda9ff376bbea5476a4e2ed3f867cf65cf7454366280d433b587e
+  data.tar.gz: 3cec58c5e959057b87d17ad66453e96beb4b6c87efae0b78472992e4f626b6a6
 SHA512:
-  metadata.gz: 4bc9b1f3bd053300bab75a40ea78ba82451f604c431b38a07dd8978dfcc889dd4fcbde208d96b822171c1d8292f411429a760fd92a637c8ad4f2d26445f4bf05
-  data.tar.gz: 58a263140a89b1b189ecbc56c90190ddf1e96552095591f56cc0d5426862529b2f53749934ae57a62a6acd28a0c9b3ddd755a390d1c1491537569f9649ec02ed
+  metadata.gz: 10141e2815729de2799466e5e8b02b7b5ee9960ba87f327bf76f83aae02ae14cc715ba940f9e67d6d2444d8f06b85187600f2b126f215e86a485b6804ad8593b
+  data.tar.gz: 72503d1dec88d0794977667838591c2b923d0aaefca49765e9af750e79f5dccc3b879f1be68b5d139ff07c108c01cdf6bb286ee014cdba509bf27b77b3237f2a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Version 0.9.4
+
+- Add `titlecase` method based on [John Gruber's title casing](https://daringfireball.net/2008/08/title_case_update) rules.
+
 ## Version 0.9.3
 
 - Make published and updated date/time datestamps explicit

data/lib/msgtrail/publish.rb

@@ -11,6 +11,7 @@ require 'msgtrail/markdown_file'
 require 'msgtrail/renderers'
 require 'msgtrail/site'
 require 'msgtrail/slug'
+require 'msgtrail/titlecase'
 require 'msgtrail/twitter'
 require 'multi_json'
 require 'ostruct'

data/lib/msgtrail/renderers.rb

@@ -1,9 +1,5 @@
 module RenderHelper
 
-  def now_as_rfc3339
-    DateTime.now.rfc3339
-  end
-
   def as_rfc3339(published, updated = nil)
     updated.nil? ? datestamp = published : datestamp = updated
     ymd = datestamp[:date].split(/\D/).map(&:to_i)
@@ -11,6 +7,14 @@ module RenderHelper
     DateTime.new(ymd[0], ymd[1], ymd[2], hm[0], hm[1], 0, datestamp[:utc_offset]).rfc3339
   end
 
+  def now_as_rfc3339
+    DateTime.now.rfc3339
+  end
+
+  def titlecase(word)
+    Msgtrail::Titlecase.titlecase(word)
+  end
+
   def xml_safe(str)
     str.gsub("&", "&amp;").gsub("<", "&lt;").gsub(">", "&gt;").gsub("\"", "&quot;").gsub("'", "&apos;")
   end

data/lib/msgtrail/titlecase.rb

@@ -0,0 +1,82 @@
+module Msgtrail
+  class Titlecase
+
+    SMALL_WORDS = [
+      /\Aa(nd|n|s|t)?\z/,
+      /\Ab(ut|y)\z/,
+      /\Aen\z/,
+      /\Afor\z/,
+      /\Ai(f|n)\z/,
+      /\Ao(f|n|r)\z/,
+      /\At(he|o)\z/,
+      /\Avs?\.?\z/
+    ].freeze
+
+    RE = 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)
+      !RE.match(word).nil?
+    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 { |part| part.capitalize }.join('/')
+    end
+
+    def self.titlecase(str)
+      return if (str || '').strip.empty?
+
+      # Downcase an all-upcase sentence
+      str.downcase! if str.scan(/[A-Z]|\s|\W/).length == str.length
+
+      # Replace tabs by single space
+      # Replace weird spaces by regular space
+      # Split sentence at space boundaries
+      word_arr = str.gsub(/\t/, ' ').gsub("\u{2011}", ' ').split(' ')
+
+      # Initialize operand array
+      operand_arr = Array.new(word_arr.size, :nop)
+
+      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] == :nop
+      end
+
+      return word_arr.join(' ')
+    end
+
+  end
+end

data/lib/msgtrail/version.rb

@@ -1,3 +1,3 @@
 module Msgtrail
-  VERSION = "0.9.3"
+  VERSION = "0.9.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: msgtrail
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors:
 - Erik van Eykelen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-22 00:00:00.000000000 Z
+date: 2019-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -148,6 +148,7 @@ files:
 - lib/msgtrail/renderers.rb
 - lib/msgtrail/site.rb
 - lib/msgtrail/slug.rb
+- lib/msgtrail/titlecase.rb
 - lib/msgtrail/twitter.rb
 - lib/msgtrail/version.rb
 - msgtrail.gemspec