lib/itax_code.rb in itax_code-0.1.2 vs lib/itax_code.rb in itax_code-0.1.3
- old
+ new
@@ -6,47 +6,47 @@
require "itax_code/validator"
module ItaxCode
class << self
##
- # This method encodes citizen tax code
+ # This method encodes user tax code.
#
# @example
#
- # ItaxCode.generate({
+ # ItaxCode.encode({
# surname: [String]
# name: [String]
# gender: [String]
# birthdate: [Date, DateTime, Time]
# birthplace: [String]
# })
#
- # @param [Hash] data The citizen data attributes
+ # @param [Hash] data The user data attributes
#
# @return [String]
def encode(data)
Encoder.new(data).encode
end
##
- # This method decodes tax code in its components
+ # This method decodes tax code in its components.
#
# @example
#
# ItaxCode.decode("CCCFBA85D03L219P")
#
- # @param [String] tax_code The citizen tax code
+ # @param [String] tax_code The user tax code
#
# @return [Hash]
def decode(tax_code)
Parser.new(tax_code).decode
end
##
# This method check given tax code validity
- # against new one generated by citizen informations
+ # against new one encoded from user informations.
#
# @example
#
# ItaxCode.valid?(tax_code [String], {
# surname: [String]