iceland 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ae1e3906373e1c239fb40a8f2bf9c0dd2d47e7d
-  data.tar.gz: f47e1a806270c771ed7f73d0e0c2f2e8db537420
+  metadata.gz: e68b56b4b9a0f44a408049af626052ae90a77f9c
+  data.tar.gz: be1635676c1ba7878caceeddc82285242ba1e9de
 SHA512:
-  metadata.gz: f41c9b09af2642393e1a10106147c103ef08d05e30dbdce42215688c56e040511667d84f045d14ffb75cf77d21b20ece20a95426f39479124e2448b1fc7212e0
-  data.tar.gz: 11911baf8e643efbb2b2573b69c901b3efd2233cfae15d1d6aacd8aa95bbe0989ec85e0ca6944667d012e0598e57135ce7745b5a3d5e1c589331f4b5afdc9ba7
+  metadata.gz: f3d41d85cf0dc94ce1d2ed1bebb5cc89f0e065890a8534f814857a348ffbe6d880e94a2c822e66c8c444a9807868d260bafcd5c7bda1e391512033b974f56e2d
+  data.tar.gz: 56e62ed486867941cfc7c7c8fe795ba8459d62d71bbde4997a285bbe07eb598956d1dd3e8c9cd0c4c191ee66db7b4451173399de8dd978ac33fb45fc08c48aee

data/README.md

@@ -95,7 +95,7 @@ k = Kennitala.new(' 010130-2989')
 
 # Invalid strings are rejected with an argument error
 f = Kennitala.new('010130-2979')
-# ArgumentError: Kennitala is invalid
+# => ArgumentError: Kennitala is invalid
 
 # If no kennitala string is specified, a random one will be generated
 r = Kennitala.new
@@ -124,11 +124,11 @@ k.pp('🐈')
 k.entity_type
 # => "person"
 
-# It's also possible to use .is_company and .is_person to achieve the same thing
-k.is_company?
+# It's also possible to use .company and .person to achieve the same thing
+k.company?
 # => false
 
-k.is_person?
+k.person?
 # => true
 
 # Cast the kennitala to a Date object

data/lib/iceland/kennitala.rb

@@ -1,10 +1,26 @@
 # The Kennitala Class
 class Kennitala
-  # Description of method
+  # Initialize a Kennitala object
   #
-  # @param [String, Boolean] kt_string = false describe kt_string = false
-  # @param [Boolean] is_company = false describe is_company = false
+  # @note The string provided may include spaces, hyphens and alphabetical
+  #       characters, which will then be erased from the resulting string.
+  #
+  # @param [String, Boolean] kt_string Either Kennitala String or Boolean false.
+  # @param [Boolean] is_company Wether the randomly generated kennitala is
+  #                  for a company
   # @return [Kennitala] description of returned object
+  #
+  # @example Initialize a Kennitala object based on an unsanitized String
+  #          Kennitala.new(' 010130-2989')
+  #          => #<Kennitala:0x007fe35d041bc0 @value="0101302989">
+  #
+  # @example Invalid strings are rejected with an argument error
+  #          Kennitala.new('010130-2979')
+  #          => ArgumentError: Kennitala is invalid
+  #
+  # @example If no kennitala string is specified, a random one will be generated
+  #          Kennitala.new
+  #          => #<Kennitala:0x007fc589339f18 @value="2009155509">
   def initialize(kt_string = false, is_company = false)
     kt_string = fake_kt_string(is_company) if kt_string == false
     unless kt_string.class == String
@@ -19,6 +35,12 @@ class Kennitala
   # Get the type of entity - If it is a person or an organization
   #
   # @return [String] Either 'person' or 'company'
+  #
+  # @example Get the entity type (results in 'person' or 'company')
+  #          k = Kennitala.new('0101302989')
+  #          => #<Kennitala:0x007fe35d041bc0 @value="0101302989">
+  #          k.entity_type
+  #          => "person"
   def entity_type
     date_integer = @value[0, 2].to_i
     return 'person' if date_integer < 32
@@ -72,6 +94,12 @@ class Kennitala
   # Get the age of entity in years. Useful when dealing with age restrictions.
   #
   # @return [Fixnum]
+  #
+  # @example Get the current age of the entity
+  #          k = Kennitala.new('0101302989')
+  #          => #<Kennitala:0x007fe35d041bc0 @value="0101302989">
+  #          k.age
+  #          => 86
   def age
     year_diff = Date.today.year - to_date.year
     month_diff = Date.today.month - to_date.month
@@ -84,23 +112,41 @@ class Kennitala
   # Cast the kennitala to a Date object
   #
   # @return [Date]
+  #
+  # @example Cast the kennitala to a Date object
+  #          k = Kennitala.new('0101302989')
+  #          => #<Kennitala:0x007fe35d041bc0 @value="0101302989">
+  #          k.to_date
+  #          => #<Date: 1930-01-01 ((2425978j,0s,0n),+0s,2299161j)>
   def to_date
     Date.new(year, month, day)
   end
 
   # Cast the kennitala to a String object
   #
-  # @return [Date]
+  # @return [String]
   def to_s
     @value.to_s
   end
 
   # Pretty print a kennitala
   #
-  # Puts a spacer between the 6th and the 7th digit
+  # Adds a space between the 6th and the 7th digits for readability.
   #
   # @param [String] spacer A single space by default
   # @return [String]
+  #
+  # @example Pretty print a Kennitala it its default form
+  #          k = Kennitala.new('0101302989')
+  #          => #<Kennitala:0x007fc589339f18 @value="2009155509">
+  #          k.pp
+  #          => "010130 2989"
+  #
+  # @example Use a hyphen as a spacer instead of the default single space
+  #          k = Kennitala.new('0101302989')
+  #          => #<Kennitala:0x007fc589339f18 @value="2009155509">
+  #          k.pp('-')
+  #          => "010130-2989"
   def pp(spacer = ' ')
     raise ArgumentError 'Spacer must be a string' unless spacer.class == String
     @value[0, 6] + spacer + @value[6, 9]

data/lib/iceland/postal_codes.rb

@@ -1,5 +1,6 @@
 # Postal Codes
 module Iceland
+  # The postal code data as a Hash object
   POSTAL_CODES = YAML.load_file(File.expand_path('../../postcodes.yml',
                                                  __FILE__))
 

data/lib/iceland/version.rb

@@ -1,3 +1,3 @@
 module Iceland
-  VERSION = '0.1.12'.freeze
+  VERSION = '0.1.13'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iceland
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.13
 platform: ruby
 authors:
 - Stefan Vignir