doc: Add doc strings

Author: oakbani

changes.patch

@@ -273,34 +273,54 @@ def substring_evaluator(condition)
     end
 
     def semver_equal_evaluator(condition)
+      # Evaluate the given semantic version equal match target version for the user version.
+      # Returns boolean true if the user version is equal to the target version,
+      #                 false if the user version is not equal to the target version
+
       target_version = condition['value']
       user_version = @user_attributes[condition['name']]
 
       SemanticVersion.compare_user_version_with_target_version(target_version, user_version).zero?
     end
 
     def semver_greater_than_evaluator(condition)
+      # Evaluate the given semantic version greater than match target version for the user version.
+      # Returns boolean true if the user version is greater than the target version,
+      #                 false if the user version is less than or equal to the target version
+
       target_version = condition['value']
       user_version = @user_attributes[condition['name']]
 
       SemanticVersion.compare_user_version_with_target_version(target_version, user_version).positive?
     end
 
     def semver_greater_than_or_equal_evaluator(condition)
+      # Evaluate the given semantic version greater than or equal to match target version for the user version.
+      # Returns boolean true if the user version is greater than or equal to the target version,
+      #                 false if the user version is less than the target version
+
       target_version = condition['value']
       user_version = @user_attributes[condition['name']]
 
       SemanticVersion.compare_user_version_with_target_version(target_version, user_version) >= 0
     end
 
     def semver_less_than_evaluator(condition)
+      # Evaluate the given semantic version less than match target version for the user version.
+      # Returns boolean true if the user version is less than the target version,
+      #                 false if the user version is greater than or equal to the target version
+
       target_version = condition['value']
       user_version = @user_attributes[condition['name']]
 
       SemanticVersion.compare_user_version_with_target_version(target_version, user_version).negative?
     end
 
     def semver_less_than_or_equal_evaluator(condition)
+      # Evaluate the given semantic version less than or equal to match target version for the user version.
+      # Returns boolean true if the user version is less than or equal to the target version,
+      #                 false if the user version is greater than the target version
+
       target_version = condition['value']
       user_version = @user_attributes[condition['name']]
 

lib/optimizely/custom_attribute_condition_evaluator.rb

@@ -27,10 +27,24 @@ module SemanticVersion
     module_function
 
     def pre_release?(target)
+      # Method to check if the given version contains "-"
+      #
+      # target - String representing semantic version
+      #
+      # Returns true if the given version does contain "-"
+      #         false if it doesn't
+
       target.include? SEMVER_PRE_RELEASE
     end
 
     def split_semantic_version(target)
+      # Method to split the given version.
+      #
+      # target - String representing semantic version
+      #
+      # Returns List The array of version split into smaller parts i.e major, minor, patch etc,
+      #         Exception if the given version is invalid.
+
       target_prefix = target
       target_suffix = ''
       target_parts = []
@@ -65,6 +79,15 @@ def split_semantic_version(target)
     end
 
     def compare_user_version_with_target_version(target_version, user_version)
+      # Compares target and user versions
+      #
+      # target_version - String representing target version
+      # user_version - String representing user version
+
+      # Returns boolean 0 if user version is equal to target version,
+      #                 1 if user version is greater than target version,
+      #                -1 if user version is less than target version.
+
       raise InvalidAttributeType unless target_version.is_a? String
       raise InvalidAttributeType unless user_version.is_a? String