stringub-commons 0.0.1 → 0.0.2

data/.gitignore

@@ -3,3 +3,4 @@
 Gemfile.lock
 pkg/*
 coverage*
+doc*

data/README.markdown

@@ -1,18 +1,40 @@
-# serradura-stringub-commons
+# serradura/stringub-commons
 
 ## Links
 
-<a href='http://rubygems.org/gems/stringub_commons'>http://rubygems.org/gems/stringub_commons</a>
+<a href='https://rubygems.org/gems/stringub-commons'>https://rubygems.org/gems/stringub-commons</a>
 
-<a href="http://github.com/serradura/stringub_commons">http://github.com/serradura/stringub_commons</a>
+<a href="https://github.com/serradura/stringub-commons">https://github.com/serradura/stringub-commons</a>
 
 ## Description
 This library borned from the early versions of string_utility_belt gem, this gem adds new common purpose methods to String class. E.g: split a string in words, replace a sequence of spaces per a unique space.
 
 ## Install
 
-  gem install stringub_commons
+    gem install stringub_commons
 
 ## Examples
-  Examples can be founds in the tests.  
+### Method: words
+Split strings into an array of words.
+
+    # Ex:
+    "Ruby on Rails".words
+    # >> ["Ruby", "on", "Rails"]
+
+    "Serradura's house".words
+    # >> ["Serradura's", "house"]
+
+### Method: unique_spaces
+Removes a sequence of any kind of space characters per a unique whitespace.
+
+    "       \n    abc    ".unique_spaces
+    # >> " abc "
+  
+    #Tip:
+    #If do you need remove trailing whitespaces. chain the String#strip method:
+
+    "       \n    abc    ".unique_spaces.strip
+    # >> "abc"
+
+More examples can be founds in the tests.
 

data/lib/stringub-commons.rb

@@ -1,20 +1,46 @@
 require "stringub-commons/version"
 
+# Stringub::Commons provides new methods for strings.
 module Stringub
   module Commons
+    # Regexp pattern used to define words.
     WORD_PATTERN      = /\w[\w\'\-]*/
+    # Regexp pattern used to match any kind of space, ex: ' ', \n, \r, \t
     ANY_SPACE_PATTERN = /\s+/
 
     UNIQUE_SPACE = " "
 
+    # Split strings into an array of words.
+    #   # Ex:
+    #   "Ruby on Rails".words
+    #   # >> ["Ruby", "on", "Rails"]
+    #
+    #   "Serradura's house".words
+    #   # >> ["Serradura's", "house"]
+    #
+    #   "Module and sub-module".words
+    #   # >> ["Module", "and",  "aub-module"]
     def words
       self.scan(WORD_PATTERN)
     end
 
+    # Removes a sequence of any kind of space characters per a unique whitespace.
+    #   # Ex:
+    #   "       \n    abc    ".unique_spaces
+    #   # >> " abc "
+    #
+    #   "\o/   \n\r\t     ".unique_spaces
+    #   # >> "\o/ "
+    # ===Tip:
+    # If do you need remove trailing whitespaces. chain the String#strip method:
+    #   "       \n    abc    ".unique_spaces.strip
+    #   # >> "abc"
     def unique_spaces
       self.gsub(ANY_SPACE_PATTERN, UNIQUE_SPACE)
     end
 
+    # Removes a sequence of any kind of space characters per a unique whitespace.
+    # Returns nil if str was not altered.
     def unique_spaces!
       self.gsub!(ANY_SPACE_PATTERN, UNIQUE_SPACE)
     end

data/lib/stringub-commons/version.rb

@@ -1,5 +1,5 @@
 module Stringub
   module Commons
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: stringub-commons
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Rodrigo Serradura
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-24 00:00:00 -07:00
-default_executable: 
+date: 2011-07-27 00:00:00 Z
 dependencies: []
 
 description: "This library borned from the early versions of string_utility_belt gem, this gem adds new common purpose methods to String class. E.g: split a string in words, replace a sequence of spaces per a unique space."
@@ -38,7 +37,6 @@ files:
 - stringub-commons.gemspec
 - test/stringub-commons_test.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: ""
 licenses: []
 
@@ -68,10 +66,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: stringub-commons
-rubygems_version: 1.5.3
+rubygems_version: 1.8.2
 signing_key: 
 specification_version: 3
 summary: Useful methods for strings
-test_files: 
-- test/stringub-commons_test.rb
-- test/test_helper.rb
+test_files: []
+