component.rb in crowdskout-0.0.5

- old
+ new

@@ -1,17 +1,28 @@
+#
+# component.rb
+# Crowdskout
+#
+# Copyright (c) 2016 Kyle Schutt. All rights reserved.
+
 module Crowdskout
   module Components
     class Component
 
+      # Return the object as hash
+      # @return [Hash]
       def to_hash
         hash = Hash.new
         self.instance_variables.collect do |var|
           hash[var.to_s[1..-1]] = self.class.to_hash_value(self.instance_variable_get(var))
         end
         hash
       end
 
+      # Get the nested value as a hash
+      # @param [Object] an object to change into a hash
+      # @return [Hash] hash of the val
       def self.to_hash_value(val)
         if val.is_a? Crowdskout::Components::Component
           return val.to_hash
         elsif val.is_a? Array
           return val.collect{|subval| Component.to_hash_value(subval) }
@@ -20,14 +31,14 @@
         else
           return val
         end
       end
 
+      # Object to a json string
+      # @return [String] the hash of the object to a json string
       def to_json(val = nil)
         self.to_hash.to_json
       end
-
-      protected
 
       # Get the requested value from a hash, or return the default
       # @param [Hash] hsh - the hash to search for the provided hash key
       # @param [String] key - hash key to look for
       # @param [String] default - value to return if the key is not found, default is null
\ No newline at end of file