lib/kilza.rb in kilza-1.0.2 vs lib/kilza.rb in kilza-1.0.4

@@ -1,27 +1,42 @@
-require "kilza/version"
+require 'kilza/version'
 
 require 'kilza/source'
 require 'kilza/class'
 require 'kilza/property'
 require 'kilza/language'
 require 'kilza/language/objc'
 require 'kilza/language/java'
 
+# Ruby class
 class String
-  def is_number?
+  # Test if the string can be a number
+  #
+  # @param str [String] string to be tested
+  #
+  # @return [Boolean] true in case of success
+  def number?
     true if Float(self) rescue false
   end
 end
 
+# Tranforms a JSON string into Objects
 module Kilza
+  # Removes everything except numbers and letters.
+  #
+  # @param str [String] string to be cleaned
+  #
+  # @return [String] cleaned string
   def self.clean(str)
-    if str[0].is_number?
-      str = '_' + str
-    end
-    str = str.gsub(/[^a-zA-Z0-9]/, '_')
+    str = '_' + str if str[0].number?
+    str.gsub(/[^a-zA-Z0-9]/, '_')
   end
 
+  # Cleans the string and make it lowercase.
+  #
+  # @param str [String] string to be cleaned
+  #
+  # @return [String] cleaned string
   def self.normalize(str)
-    str = Kilza::clean(str).downcase
+    Kilza.clean(str).downcase
   end
 end