egn 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aaa91f142c103922352ec9dab24a75fe6792d543
-  data.tar.gz: 143517ba61c8705aae880eb1a5450df57a76e08c
+  metadata.gz: 6ece6e3fe8e7fc520d7833f9256610261b9e4622
+  data.tar.gz: 5ca30adca2f40f3731eee66d98b3a45e344025cc
 SHA512:
-  metadata.gz: a5c8f9beceef676cd25cde8f364cef28a9fe9a0271e0cbdce8372f85baa0e021b29f15f4116301d4394583118b51b8a37bfa5862595ec31f8545928211565fdd
-  data.tar.gz: 522bd6ab3ea7dc0ba3ea4168ce0a5f14077f4ec2f2e735f522d7f1f3b7e5b0d2b265eb7a501414786c26f7a78ec249527c5dd0bd8796c681617a3b0dc787902f
+  metadata.gz: 05ac63f17dc43b25e440243b54da13442795cf7a7c70303537110a0ed5ae4553c360fecc77e51ff16ecaf5a8c91514a30be0837917ddb3577755cbafbae5bcc7
+  data.tar.gz: 3f3180fb9357bc264e0a33f341b2316c1806a91cd99b240aa0dba99bb6d166f1c67c767d41a43c0eaf552ba5b5c15ad185b58c60b31b1f72bedb280ebb72dad7

data/README.md

@@ -57,13 +57,13 @@ Or install it yourself as:
     egn.day
     # => 10
 
-    egn.sex
+    egn.gender # egn.sex can also be used
     # => :male
 
-    egn.sex(format: :char)
+    egn.gender(format: :char)
     # => 'm'
 
-    egn.sex(format: :number)
+    egn.gender(format: :number)
     # => 1
 
     egn.valid?

data/lib/egn/generator.rb

@@ -15,10 +15,12 @@ module Egn
     end
 
     # The generated EGN will be completely random if no opitons are given.
-    # options is a hash that may have the following keys: :year, :month and :date
+    # options is a hash that may have the following keys: :year, :month, :day, :gender
     def generate
-      #     YY                       MM                        DD                      REST
-      egn = format(options[:year]) + format(options[:month]) + format(options[:day]) + format(options[:region], 3)
+      egn = format(options[:year]) +
+            format(options[:month]) +
+            format(options[:day]) +
+            format(options[:region], 3)
 
       egn + Util.egn_checksum(egn).to_s
     end
@@ -44,7 +46,7 @@ module Egn
       raise ArgumentError, "Year out of bounds" if options[:year] && !(1800..2099).include?(options[:year])
       raise ArgumentError, "Month out of bounds" if options[:month] && !(1..12).include?(options[:month])
       raise ArgumentError, "Day out of bounds" if options[:day] && !(1..31).include?(options[:day])
-      raise ArgumentError, "Sex should be one of #{sexes}" if options[:sex] && !sexes.include?(options[:sex])
+      raise ArgumentError, "Gender should be one of #{genders}" if options[:gender] && !genders.include?(options[:gender])
     end
 
     # Random defaults
@@ -54,27 +56,27 @@ module Egn
         year:    date.year,
         month:   date.month,
         day:     date.day,
-        sex:     sexes.sample,
+        gender:  genders.sample,
         region:  Random.rand(0..999)
       }
     end
 
     def process!
-      # Get random century, region and sex
+      # Get random century, region and gender
       century = determine_century(options[:year])
 
       options[:month] += month_delta(century)
 
-      options[:region] += region_delta(options[:sex], options[:region])
+      options[:region] += region_delta(options[:gender], options[:region])
 
       options[:year] = options[:year] - century
     end
 
-    # Recalculate region based on sex
-    def region_delta(sex, region)
-      if sex == :male && region.odd?
+    # Recalculate region based on gender
+    def region_delta(gender, region)
+      if gender == :male && region.odd?
         -1
-      elsif sex == :female && region.even?
+      elsif gender == :female && region.even?
         1
       else
         0
@@ -95,7 +97,7 @@ module Egn
       year - (year % 100)
     end
 
-    def sexes
+    def genders
       [:male, :female]
     end
 

data/lib/egn/util.rb

@@ -3,12 +3,12 @@ module Egn
   module Util
     WEIGHTS = [2,4,8,5,10,9,7,3,6]
 
-    # The EGN can have three different formats depending on the century. It can 
+    # The EGN can have three different formats depending on the century. It can
     # be determined by examining the month.
     # The rules are as follows:
     # * For people born in 1900..1999 the month does not change
-    # * For people born in 1800..1899 the month is +20 (e.g January is 21)
-    # * For people born in 2000..2099 the month is +40 (e.g December is 52)
+    # * For people born in 1800..1899 the month increases by 20 (e.g January is 21)
+    # * For people born in 2000..2099 the month increases by 40 (e.g December is 52)
     def self.determine_date(year, month)
       case month
       when (1..12)
@@ -24,9 +24,9 @@ module Egn
       [year.to_i, month]
     end
 
-    # The checksum is calculated from the first 9 digits.
+    # More information on the formula: http://www.grao.bg/esgraon.html
     def self.egn_checksum(egn)
-      sum = egn.split('').map(&:to_i).zip(WEIGHTS).map { |n| n.reduce(:*) }.reduce(:+)
+      sum = egn.chars.map(&:to_i).zip(WEIGHTS).map { |n| n.reduce(:*) }.reduce(:+)
 
       rest = sum % 11
       rest < 10 ? rest : 0

data/lib/egn/validator.rb

@@ -2,7 +2,7 @@ module Egn
   class Validator
     attr_reader :egn
 
-    # Convinience method
+    # Convenience method
     def self.validate(egn)
       Validator.new(egn).validate
     end

data/lib/egn/version.rb

@@ -1,3 +1,3 @@
 module Egn
-  VERSION = "1.3.1"
+  VERSION = "1.3.2"
 end

data/spec/egn/generator_spec.rb

@@ -22,7 +22,7 @@ describe Egn::Generator do
 
     context "invoked with arguments" do
       it "generates a new EGN considering the given options" do
-        number = Egn::Generator.generate(year: 1990, month: 12, day: 30, sex: :male)
+        number = Egn::Generator.generate(year: 1990, month: 12, day: 30, gender: :male)
         egn = Egn::Egn.new(number)
 
         expect(egn).to be_valid
@@ -58,22 +58,22 @@ describe Egn::Generator do
       end
 
       it "generates female EGNs" do
-        number = Egn::Generator.generate(sex: :female)
+        number = Egn::Generator.generate(gender: :female)
         egn = Egn::Egn.new(number)
 
-        expect(egn.sex).to eq(:female)
+        expect(egn.gender).to eq(:female)
       end
 
       it "generates male EGNs" do
-        number = Egn::Generator.generate(sex: :male)
+        number = Egn::Generator.generate(gender: :male)
         egn = Egn::Egn.new(number)
 
-        expect(egn.sex).to eq(:male)
+        expect(egn.gender).to eq(:male)
       end
 
       it "validates the options" do
 
-        options = {year: 1960, month: 6, day: 3, sex: :male, region: 333}
+        options = {year: 1960, month: 6, day: 3, gender: :male, region: 333}
 
         Egn::Generator.any_instance.should_receive(:validate!)
 
@@ -103,9 +103,9 @@ describe Egn::Generator do
       }.to raise_error ArgumentError
     end
 
-    it "raises an exception if invalid sex is given" do
+    it "raises an exception if invalid gender is given" do
       expect{
-        Egn::Generator.generate(sex: :none)
+        Egn::Generator.generate(gender: :none)
       }.to raise_error ArgumentError
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: egn
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - gmitrev