summaryrefslogtreecommitdiffhomepage
path: root/lib/axlsx/util/validators.rb
diff options
context:
space:
mode:
authorRandy Morgan <[email protected]>2012-03-28 23:31:38 +0900
committerRandy Morgan <[email protected]>2012-03-28 23:31:38 +0900
commit30621f2ce9c88b242524929b184dfeebf89181aa (patch)
tree83139e5a068e9512eb2e28d19f2331804eecf0e2 /lib/axlsx/util/validators.rb
parentec9d3b896a2b07cdcb8198c2227df8dac3b83cdb (diff)
downloadcaxlsx-30621f2ce9c88b242524929b184dfeebf89181aa.tar.gz
caxlsx-30621f2ce9c88b242524929b184dfeebf89181aa.zip
doc fix
Diffstat (limited to 'lib/axlsx/util/validators.rb')
-rw-r--r--lib/axlsx/util/validators.rb12
1 files changed, 6 insertions, 6 deletions
diff --git a/lib/axlsx/util/validators.rb b/lib/axlsx/util/validators.rb
index ce810e54..d4913074 100644
--- a/lib/axlsx/util/validators.rb
+++ b/lib/axlsx/util/validators.rb
@@ -5,11 +5,11 @@ module Axlsx
# Perform validation
# @param [String] name The name of what is being validatied. This is included in the error message
# @param [Array] choices The list of choices to validate against
- # @param [Any] v The value to be validated
+ # @param [Any] v The value to be validated
# @raise [ArgumentError] Raised if the value provided is not in the list of choices.
# @return [Boolean] true if validation succeeds.
def self.validate(name, choices, v)
- raise ArgumentError, (ERR_RESTRICTION % [v.to_s, name, choices.inspect]) unless choices.include?(v)
+ raise ArgumentError, (ERR_RESTRICTION % [v.to_s, name, choices.inspect]) unless choices.include?(v)
true
end
end
@@ -55,7 +55,7 @@ module Axlsx
# Requires that the value is a Fixnum Integer or Float and is greater or equal to 0
# @param [Any] v The value validated
- # @raise [ArgumentError] raised if the value is not a Fixnum or Integer value greater or equal to 0
+ # @raise [ArgumentError] raised if the value is not a Fixnun, Integer, Float value greater or equal to 0
# @return [Boolean] true if the data is valid
def self.validate_unsigned_numeric(v)
DataTypeValidator.validate("Invalid column width", [Fixnum, Integer, Float], v, lambda { |arg| arg.respond_to?(:>=) && arg >= 0 })
@@ -68,7 +68,7 @@ module Axlsx
end
# Requires that the value is a form that can be evaluated as a boolean in an xml document.
- # The value must be an instance of Fixnum, String, Integer, Symbol, TrueClass or FalseClass and
+ # The value must be an instance of Fixnum, String, Integer, Symbol, TrueClass or FalseClass and
# it must be one of 0, 1, "true", "false", :true, :false, true, false, "0", or "1"
# @param [Any] v The value validated
def self.validate_boolean(v)
@@ -79,13 +79,13 @@ module Axlsx
# @param [Any] v The value validated
def self.validate_string(v)
DataTypeValidator.validate :string, String, v
- end
+ end
# Requires that the value is a Float
# @param [Any] v The value validated
def self.validate_float(v)
DataTypeValidator.validate :float, Float, v
- end
+ end
# Requires that the value is valid pattern type.
# valid pattern types must be one of :none, :solid, :mediumGray, :darkGray, :lightGray, :darkHorizontal, :darkVertical, :darkDown,