headingify 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46b07b6c0913390f5e8e0d9b977ce499df45adb1
-  data.tar.gz: 1b9f9823622578038a93d367bd40735ca3e33467
+  metadata.gz: 19c230f8069815d774ce08c44c8ce9fae9a8e5f9
+  data.tar.gz: 9f57a53a7b61750b719ff9c709bb9e9eade595bf
 SHA512:
-  metadata.gz: 91a60d1388ba154dead5f07eac78da6bec1786648aafa207da1710238204b4f895366248fc6db1893c7f4a68ff43889f956f714a105ea6a7f7b0735468ae8461
-  data.tar.gz: 6b1852d5fa94bcffe0c0789fbf3dd29a4c5290d971bebf4423a5421de6da2d496f5444ffa804e7b1af5f6b619ddf351949ddc353eee38b526fb0f12938a82814
+  metadata.gz: 738d7bf6f2fa74a28f0a6a60fde36b026eb3c38e52c1448d0daf45ea09ece2922d55d49c3badcc83f2d5af80f1f4bc35fff152f1ad4e08286a097f60747f3c4e
+  data.tar.gz: ac8b0bd78765728901be8fb2d6a01f36b1c8cd94d6513f69a6ccc785451f96895d64762764647af043add06c6bb1a576a8bb1716265c9c80cc616fd6951dc561

data/README.rdoc

@@ -14,7 +14,7 @@ The latest version of Headingify can be installed with RubyGems:
 
 Add this line to your application's Gemfile:
 
-  gem 'headingify'
+  gem 'headingify', '~> 1.2.0'
     
 == Usage
 
@@ -33,6 +33,32 @@ Headingify works on the String class, and can also be used in code:
   s = "a simple string, including the preposition 'with'.".headingify
   title = "folding of the \%CheY\% protein."; title.headingify!
 
+To check if a String has already been headingified:
+  
+  % s.headingify; s.headingified?
+    > true
+
+This is beneficial when a String may be headingified twice, where the initial String contained escaped content:
+
+  s = "using the \%PI\% constant to access the Float variable".headingify
+    > "Using the PI Constant to Access the Float Variable"
+
+  # without safety (note the word "Pi" changes in case)
+  s.headingify
+    > "Using the Pi Constant to Access the Float Variable"
+
+  # with safety (nothing is changed, if previously headingified)
+  s.headingify! unless s.headingified?
+    > nil
+
+  # ...or more easily
+  s.headingify_safe # or #headingify_safe! for replacement
+    > nil
+
+  # ...and we still have our initial String, ta-da!
+  puts s
+    > "Using the PI Constant to Access the Float Variable"
+
 == License
 
 Headingify is released under the MIT license:

data/lib/headingify/core_ext/string.rb

@@ -1,6 +1,9 @@
 # encoding: utf-8
 
 class String
+  attr_accessor :headingified
+  alias_method :headingified?, :headingified
+
   def headingify
     #
     # built to syntactically supercede String.[titlecase|titleize]
@@ -68,10 +71,27 @@ class String
       end
     end
 
-    working.join(" ")
+    result = working.join(" ")
+    result.headingified = true
+
+    return result
   end
   
   def headingify!
     replace self.headingify
+    self.headingified = true
+    return self
+  end
+
+  def headingify_safe
+    return self.headingify unless self.headingified?; nil
+  end
+
+  def headingify_safe!
+    unless self.headingified?
+      replace self.headingify
+      self.headingified = true
+      return self
+    end
   end
 end

data/lib/headingify/info.rb

@@ -1,8 +1,8 @@
 module Headingify
   TITLE          = "Ruby String.headingify Core Extension"
-  VERSION        = "1.1.2"
-  UPDATE         = "2014-11-19"
-  REVISION       = "41"
+  VERSION        = "1.2.0"
+  UPDATE         = "2014-12-29"
+  REVISION       = "42"
   USAGE          = "headingify \"string\" | \"an \\%ESCAPED\\% string\""
   EXAMPLE_INPUT  = "\"garlic is as \\%GOOD\\% as ten mothers\""
   EXAMPLE_OUTPUT = "Garlic Is as GOOD as Ten Mothers"

data/spec/headingify_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Headingify do
-  it "should return the input String as a proper title (in code)" do
+  it "should return the input String as a proper title" do
     input = ["i'm dale, but you have to call me dragon.", 
     "i swear, i'm so pissed off at my mom.", 
     "as soon as she's of age, i'm putting her in a home.", 
@@ -26,8 +26,18 @@ describe Headingify do
     "This Is a QuIcK Test",
     "PI"]
 
+    # test regular headingify and positive safety correlation
     input.each_with_index do |s, i|
       expect(s.headingify).to eq(output[i])
+      expect(s.headingify.headingified?).to be true
+      expect(s.headingify.headingify_safe).to be nil
+    end
+
+    # test safe headingify
+    input.each_with_index do |s, i|
+      expect(s.headingify_safe).to eq(output[i])
+      expect(s.headingify_safe.headingified?).to be true
+      expect(s.headingify_safe.headingify_safe).to be nil
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: headingify
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Chris Calo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-19 00:00:00.000000000 Z
+date: 2014-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec