clever_title 0.0.4 → 0.0.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OThmZTk5M2Y0YzdkNTg4M2U4YzU2MTgyMmQyZWEwODlmZTEwYTcwNw==
+    ZDc5MDM5ZmQ1MWZkZWNhOWM5OGNmMjkxZDY4ODAzYWJmMTRjOWFiMw==
   data.tar.gz: !binary |-
-    ZDgzN2QzMTFhNmZjOTc3ZmVjMWFmYmMwZWYyY2Q3YzBiZmUzNzRlZg==
-!binary "U0hBNTEy":
+    MGU1Y2U2NmVlMTQ4Y2Q2YmU0ZGUxM2Y0NDkwMjEwNTU4NTczOThkZA==
+SHA512:
   metadata.gz: !binary |-
-    NGU4OTFkZjY5NGFjNWY5NjY3M2IzZTkyMWM2N2IwOWNhM2Q2YTFiM2RlY2Qx
-    YjI0MDk3NDU3Njk4YzE5MGExY2E4NWUzN2VkYjEwNTJjOGY4OGVlYzk4MDRk
-    MWVjM2JlOGVhZGE1NDEyYWE3NDMzOGQ2MTk2MjlkYjAyZWY0ZjE=
+    MDVkMjQ2ZDgzOTNiZjlkMjBmNDc1MWQ0MDMwYmQzZDU4NzZjNmJiY2FlYTk4
+    ZDg5M2FhM2MwMTBlMTc5MDg2ZmJkZTU2NDA4OWE5NTU3MTgxZTE5YzgzNmE0
+    NzllMzY5NDc2MWM3YmE3OTIzOTMwOGQ2YWYzNThjOWYyN2JhMGU=
   data.tar.gz: !binary |-
-    MzM2ZmYxNDYwZTM0Y2U2MmRlNmUwZWJlNTA0ODM5MTkyNWRiM2VjYjJiNjZm
-    MDZmZGE3MDZkOTVmZWRlZjIxN2M5NTJmMGZkM2U0YWQ3OGY4MmVjZGVlNTk4
-    M2M3MzRmZWI5ODQxZmViYjkwOTM4MDM2YTY3YjgzNzk2NmIzNDU=
+    YjAwZjIxNThjYWVlZTY2OTgwNjY0MTEyMDZkYjZhYWUyMjZmOGIyMzJkNzFm
+    NzIwMWYxYmM0NDZkODViOTJlZmQ3OWE3Zjk5ODIwMzQwZGQyMWU5MjkwODI0
+    MDU0ZjE1M2VjMTRjYmUyMzEwNjQyMDUxNmYwYmJjOGMyZjMzMmM=

data/lib/clever_title.rb

@@ -1,31 +1,70 @@
+# A module for more accurate titles
 module CleverTitle
-  attr_accessor :title, :max_downcase_conversion, :capitalize_first_letter
+	# The string that needs to be title case
+  attr_accessor :title
+	# The maximum amount of letters to lower case conjunctions and prepositions
+	attr_accessor :max_downcase_conversion
+	# Whether to capitalise the first letter of the string
+	attr_accessor :capitalize_first_letter
+	# Capitalize after full stop and atleast 1 space
+	attr_accessor :capitalize_after_period
+
+	# A list of conjunctions for lowercase
   @@conjunctions = %w(and or but nor so for yet after although long as because before even if even though if once provided since that though till unless until what when whenever wherever whether while)
 
+	# A list of prepositions for lowercase
   @@prepositions = %w(aboard about above across after against along amid among anti around as at before behind below beneath beside besides between beyond but by concerning considering despite down during except excepting excluding following for from in inside into like minus near of off on onto opposite outside over past per plus regarding round save since than through to toward towards under underneath unlike until up upon versus via with within without)
 
-  def clever_title args = {}
+	#Call this function on a string to add title case
+	#
+	#Optionally configure max_downcase_conversion and capitalize_first_letter
+	#
+	#== Example #1
+	#
+	#	"hello world".clever_title # "Hello World"
+	#
+	#== Example #2
+	#
+	#	"hello world".clever_title(max_downcase_conversion: 5) # "Hello World"
+  def clever_title args = {} # :args: :max_downcase_conversion, :capitalize_first_letter
+    @title = self
+    @max_downcase_conversion = 4
+    @max_downcase_conversion = args[:max_downcase_conversion] if args[:max_downcase_conversion]
+    @capitalize_first_letter = true unless args[:capitalize_first_letter] == false
+    @capitalize_after_period = true unless args[:capitalize_after_period ] == false
+    self.run
+    @title
+  end
+
+	# Call this function to replace the current string permanently
+  def clever_title! args = {} # :args: :max_downcase_conversion, :capitalize_first_letter
     @title = self
     @max_downcase_conversion = 4
     @max_downcase_conversion = args[:max_downcase_conversion] if args[:max_downcase_conversion]
     @capitalize_first_letter = true unless args[:capitalize_first_letter] == false
+    @capitalize_after_period = true unless args[:capitalize_after_period ] == false
     self.run
+		self.replace(@title)
     @title
   end
 
   protected
 
+	# Called from the clever_title method to run through functionality
   def run
     capitalise
     # lower_conjunctions
     lower_words
     capitalise_first_word if @capitalize_first_letter
+		capitalise_after_period if @capitalize_after_period
   end
 
+	# capitalise each word
   def capitalise
     @title = @title.split.map(&:capitalize).join(' ')
   end
 
+	# Find conjunctions and prepositions that need to be lower case
   def lower_words
     all_words = (@@conjunctions << @@prepositions).flatten!
     all_words = all_words.uniq
@@ -36,9 +75,14 @@ module CleverTitle
     @title = fixed.join ' '
   end
 
+	# Capitalise first word in the string
   def capitalise_first_word
     @title = @title.slice(0,1).upcase + @title.slice(1..-1)
   end
+	# Capitalise first word after a period
+  def capitalise_after_period
+		@title = @title.gsub(/(\.(\s+)([a-z]))/) {|word| word.upcase }
+  end
 
   def seperate_words
     @title.split(/\W+/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clever_title
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Mitch Stanley
@@ -19,7 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/clever_title.rb
-homepage: http://rubygems.org/gems/clever_title
+homepage: https://github.com/acoustep/clever_title
 licenses:
 - MIT
 metadata: {}
@@ -39,7 +39,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.1.2
 signing_key: 
 specification_version: 4
 summary: A more accurate way of handling titles