iceland 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f42f027ae1a71f56fdcc9052a3e8a2b942b3ea28
-  data.tar.gz: 84917f55a16b943f3629dfb15a8af44967f7a1b3
+  metadata.gz: 8ae1e3906373e1c239fb40a8f2bf9c0dd2d47e7d
+  data.tar.gz: f47e1a806270c771ed7f73d0e0c2f2e8db537420
 SHA512:
-  metadata.gz: 998925bac18ea0b3054dc0e2e1c01f564e51147d60c34a5285b2ee1d3f116bfcab526413f3587e9238d4910860edeaf1876f3b3ffbeadee508b4699dd5d1168b
-  data.tar.gz: d07f0bb7b26d90fac652c93541f23260761f43f01fcdf30690f71eba78c278ef95710d1843bde09637158ea072f0b06e3a0cd248b4d87d11db2addd4cd304a13
+  metadata.gz: f41c9b09af2642393e1a10106147c103ef08d05e30dbdce42215688c56e040511667d84f045d14ffb75cf77d21b20ece20a95426f39479124e2448b1fc7212e0
+  data.tar.gz: 11911baf8e643efbb2b2573b69c901b3efd2233cfae15d1d6aacd8aa95bbe0989ec85e0ca6944667d012e0598e57135ce7745b5a3d5e1c589331f4b5afdc9ba7

data/README.md

@@ -30,7 +30,7 @@ Icelandic postal codes are 3-digit numeric identifiers, with the first digit ind
 
 Names of locales are provided in dative form by default as per Icelandic postal convention, but nomative forms can be returned by setting the `force_nominative` parameter to `true` when using the `Iceland.all_postal_codes` and `Iceland.locale_by_postal_code` methods.
 
-(Note that we use the term "locale" as per Universal Postal Union convention to name town, city or other location the postal code is assigned to.)
+(Note that we use the term "locale" as per Universal Postal Union convention to name the town, city or other location the postal code is assigned to.)
 
 #### Examples
 
@@ -62,7 +62,7 @@ Iceland.locale_by_postal_code 311, true
 
 The Iceland Gem provides a class to handle "kennitala" identifier codes. The class can be used to sanitize the identifiers and read information like the date of birth (or date of registration in the case of companies and organization), age and the type of entity.
 
-The class does not access external APIs or databases such National Registry or the Company Registry, so names and status (death, bankruptcy, credit rating etc.) cannot be accessed using the class. However, it can be used to sanitize and validate such data before being sent to external APIs, as such services are provided by private companies, which often charge a specific amount for each query.
+The class does not access external APIs or databases such National Registry or the Company Registry, so names and status (sex/gender, death, bankruptcy, credit rating etc.) cannot be accessed using the class. However, it can be used to sanitize and validate such data before being sent to external APIs, as such services are provided by private companies, which often charge a specific amount for each query.
 
 #### Uses of kennitala
 
@@ -88,8 +88,9 @@ The century identifier has 3 legal values. `8` for the 19th century, `9` for the
 
 ```ruby
 # Initialize a Kennitala object.
-# The string provided may include spaces and hyphens.
-k = Kennitala.new('010130-2989')
+# The string provided may include spaces, hyphens and alphabetical characters,
+# which will then be erased from the resulting string.
+k = Kennitala.new(' 010130-2989')
 # => #<Kennitala:0x007fe35d041bc0 @value="0101302989">
 
 # Invalid strings are rejected with an argument error
@@ -143,7 +144,7 @@ k.age
 
 ```ruby
 # Casting a string to a Kennitala object
-'0101302989'.to_kt
+'010130 2989'.to_kt
 # => #<Kennitala:0x007fc5893286a0 @value="0101302989">
 
 # Get the current age based on a String
@@ -155,6 +156,7 @@ k.age
 
 * Administrative Divisions
 * Bank accounts
+* Car plate numbers
 
 ## About the data
 
@@ -172,7 +174,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/stefanvignir/iceland_gem.
 
-Do make sure that the `rspec` unit tests run before sending a pull request (hint: try running `rspec` a couple of times in a row as some tests might fail randomly) and write tests for any new functionality you add. Also run `rubocop` to check if your code adheres to the Ruby Style Guide.
+Do make sure that the `rspec` unit tests run before sending a pull request and write tests for any new functionality you add. Also run `rubocop` to check if your code adheres to the Ruby Style Guide and other conventions.
 
 ## License
 

data/lib/iceland/kennitala.rb

@@ -1,9 +1,15 @@
 # The Kennitala Class
 class Kennitala
+  # Description of method
+  #
+  # @param [String, Boolean] kt_string = false describe kt_string = false
+  # @param [Boolean] is_company = false describe is_company = false
+  # @return [Kennitala] description of returned object
   def initialize(kt_string = false, is_company = false)
     kt_string = fake_kt_string(is_company) if kt_string == false
     unless kt_string.class == String
-      raise ArgumentError, 'Kennitala needs to be provided as a string'
+      raise ArgumentError, 'Kennitala needs to be provided as a String or '\
+                           'Boolean (false)'
     end
     sanitised_kt = sanitize(kt_string)
     raise ArgumentError, 'Kennitala is invalid' if sanitised_kt.nil?
@@ -30,7 +36,7 @@ class Kennitala
 
   # Check if the entity is a person
   #
-  # @return [Type] description of returned object
+  # @return [Boolean]
   def person?
     date_integer = @value[0, 2].to_i
     return true if date_integer < 32
@@ -133,6 +139,8 @@ class Kennitala
 
   # Generate a fake hash that includes randomly generated date elements
   #
+  # @todo Take leap years into account and thus allow for 29 February
+  #
   # @param [Boolean] is_company true if the day string is for a company
   # @return [Hash]
   def fake_date_hash(is_company = false)
@@ -149,6 +157,10 @@ class Kennitala
       month: month.to_s.rjust(2, '0'), day: day.to_s.rjust(2, '0') }
   end
 
+  # Generate a fake, random kennitala string
+  #
+  # @param [Boolean] is_company If the kennitala is for a company, not a person
+  # @return [String] A 10-digit string representing a kennitala
   def fake_kt_string(is_company = false)
     date_hash = fake_date_hash(is_company)
     randoms_hash = fake_randoms(date_hash)
@@ -159,6 +171,10 @@ class Kennitala
     first_six + randoms + date_hash[:century]
   end
 
+  # Get year from a kennitala string
+  #
+  # @param [String] kt_string Sanitized kennitala string
+  # @return [Fixnum] description of returned object
   def get_year_from_string(kt_string)
     century_code = kt_string[9, 1].to_i
     case century_code
@@ -202,6 +218,10 @@ class Kennitala
     checksum
   end
 
+  # Calculate the check digit for a kennitala
+  #
+  # @param [String] kt_string Sanitized kennitala
+  # @return [Fixnum]
   def calculate_check_digit(kt_string)
     remainder = checksum(kt_string).modulo(11)
 

data/lib/iceland/postal_codes.rb

@@ -27,7 +27,7 @@ module Iceland
   #
   # @param [Integer, String] postal_code The postal code
   # @param [Boolean] force_nominative Display locale name in nomative form
-  # @return [String] description of returned object
+  # @return [String]
   def locale_by_postal_code(postal_code, force_nominative = false)
     postal_code = postal_code.to_i
     postal_code_hash = POSTAL_CODES[postal_code]

data/lib/iceland/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iceland
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Stefan Vignir
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-14 00:00:00.000000000 Z
+date: 2016-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler