activepesel 0.1.1 → 0.2.0

data/lib/activepesel/pesel_generator.rb

@@ -1,33 +1,46 @@
+# frozen_string_literal: true
+
 module Activepesel
   class PeselGenerator
-    
+    DATE_RANGE = (Date.new(1800, 1, 1)..Date.new(2299, 12, 31)).freeze
     SEX_CODES = {
       1 => [1, 3, 5, 7, 9],
-      2 => [0, 2, 4, 6, 8]
+      2 => [0, 2, 4, 6, 8],
     }.freeze
-    
+
     class << self
-      
-      def generate(*args)
-        raise(::ArgumentError, "Bad argument! You can pass :all or :one") unless [:all, :one].include?(args[0])
-        options = args.extract_options!
-        raise(::ArgumentError, "Date of birth can only be from range: (1800-01-01..2299-12-31)") if !options[:date_of_birth].respond_to?(:to_date) || !(Date.new(1800,1,1)..Date.new(2299,12,31)).include?(options[:date_of_birth].to_date)
-        raise(::ArgumentError, "Sex can only be set to 1 - males and 2 - females") if !options[:sex].respond_to?(:to_i) || ![1,2].include?(options[:sex].to_i)
-        send(args.first, options)
+      def generate_one(date_of_birth:, sex:)
+        validate_params(date_of_birth, sex)
+        one(date_of_birth, sex)
+      end
+
+      def generate_all(date_of_birth:, sex:)
+        validate_params(date_of_birth, sex)
+        all(date_of_birth, sex)
       end
-      
+
       private
 
-      def one(options)
-        incomplete_pesel = "#{date_of_birth_code(options[:date_of_birth])}#{varying_codes[rand(998)]}#{sex_codes(options[:sex])[rand(4)]}"
+      def validate_params(date_of_birth, sex)
+        if !date_of_birth.respond_to?(:to_date) || !DATE_RANGE.cover?(date_of_birth.to_date)
+          raise(::ArgumentError, 'Date of birth can only be from range: (1800-01-01..2299-12-31)')
+        end
+
+        return unless !sex.respond_to?(:to_i) || ![1, 2].include?(sex.to_i)
+
+        raise(::ArgumentError, 'Sex can only be set to 1 - males and 2 - females')
+      end
+
+      def one(date_of_birth, sex)
+        incomplete_pesel = "#{date_of_birth_code(date_of_birth)}#{varying_codes[rand(998)]}#{sex_codes(sex)[rand(4)]}"
         Pesel.new("#{incomplete_pesel}#{control_digit(incomplete_pesel)}")
       end
 
-      def all(options)
+      def all(date_of_birth, sex)
         [].tap do |pesels|
           varying_codes.each do |varying_code|
-            sex_codes(options[:sex]).each do |sex_code|
-              incomplete_pesel = "#{date_of_birth_code(options[:date_of_birth])}#{varying_code}#{sex_code}"
+            sex_codes(sex).each do |sex_code|
+              incomplete_pesel = "#{date_of_birth_code(date_of_birth)}#{varying_code}#{sex_code}"
               pesels << Pesel.new("#{incomplete_pesel}#{control_digit(incomplete_pesel)}")
             end
           end
@@ -35,38 +48,44 @@ module Activepesel
       end
 
       def control_digit(incomplete_pesel)
-        digits = incomplete_pesel.split("").map(&:to_i)
-        (10 - Pesel::DIGIT_WEIGHTS[0..-2].each_with_index.inject(0){|sum, (factor, idx)| sum + factor * digits[idx]})%10
+        digits = incomplete_pesel.chars.map(&:to_i)
+
+        (10 - Pesel::DIGIT_WEIGHTS[0..-2].each_with_index.reduce(0) do |sum, (factor, idx)|
+          sum + (factor * digits[idx])
+        end) % 10
       end
-      
+
       def sex_codes(sex)
         SEX_CODES[sex.to_i]
       end
-      
+
       def varying_codes
-        (0..999).to_a.map{|code| sprintf("%03d", code)}
+        (0..999).to_a.map { |code| format('%03d', code) }
       end
-      
+
       def date_of_birth_code(date_of_birth)
-        [year_code(date_of_birth.to_date.year), month_code(date_of_birth.to_date.year, date_of_birth.to_date.month), day_code(date_of_birth.to_date.day)].join
+        [
+          year_code(date_of_birth.to_date.year),
+          month_code(date_of_birth.to_date.year, date_of_birth.to_date.month),
+          day_code(date_of_birth.to_date.day),
+        ].join
       end
-      
+
       def century(year)
         year / 100
       end
 
       def year_code(year)
-        sprintf("%02d", year - 100 * century(year))
+        format('%02d', year - (100 * century(year)))
       end
 
       def month_code(year, month)
-        sprintf("%02d", month + PersonalData::DELTA[century(year)])
+        format('%02d', month + PersonalData::DELTA[century(year)])
       end
 
       def day_code(day)
-        sprintf("%02d", day)
+        format('%02d', day)
       end
-
     end
   end
 end

data/lib/activepesel/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Activepesel
-  VERSION = "0.1.1"
+  VERSION = '0.2.0'
 end

data/lib/activepesel.rb

@@ -1,8 +1,15 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2023
+# Author: Wojciech Pasternak / voytee
+# Email: wpasternak@gmail.com
+# License: MIT
+
 require 'activepesel/pesel'
 require 'activepesel/pesel_attr'
 require 'activepesel/personal_data'
 require 'activepesel/pesel_generator'
-require 'active_model/validations/pesel_validator'
+require 'active_model/validations/pesel_validator' if defined?(ActiveModel)
 
 module Activepesel
 end

data/spec/activepesel/pesel_attr_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+RSpec.describe Activepesel::PeselAttr do
+  let(:dummy) do
+    Class.new do
+      include Activepesel::PeselAttr
+
+      pesel_attr :pesel_a, :pesel_b
+
+      attr_reader :pesel_a, :pesel_b
+
+      def initialize(pesel_a, pesel_b)
+        @pesel_a = pesel_a
+        @pesel_b = pesel_b
+      end
+    end
+  end
+
+  subject(:dummy_obj) { dummy.new(pesel_a, pesel_b) }
+
+  let(:pesel_a) { '88061654752' }
+  let(:pesel_b) { '88061654752' }
+
+  it 'returns extracted personal data' do
+    expect(dummy_obj.pesel_a_personal_data).to be_kind_of(Activepesel::PersonalData)
+    expect(dummy_obj.pesel_b_personal_data).to be_kind_of(Activepesel::PersonalData)
+  end
+end

data/spec/activepesel/pesel_generator_spec.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+RSpec.describe Activepesel::PeselGenerator do
+  describe '.generate_one' do
+    subject(:pesel) { described_class.generate_one(**options) }
+
+    context 'with date_of_birth not covered by PESEL system' do
+      let(:options) { { sex: 1, date_of_birth: '3033-01-01' } }
+
+      specify { expect { pesel }.to raise_exception(ArgumentError) }
+    end
+
+    context 'with sex not covered by PESEL system' do
+      let(:options) { { sex: 3, date_of_birth: '1982-06-01' } }
+
+      specify { expect { pesel }.to raise_exception(ArgumentError) }
+    end
+
+    let(:options) { { sex: sex, date_of_birth: date_of_birth } }
+    { 1 => 'men', 2 => 'women' }.each do |sex_code, sex_name|
+      context "for #{sex_name}" do
+        let(:sex) { sex_code }
+
+        context 'for year 18XX' do
+          let(:date_of_birth) { '1801-12-12' }
+          specify { expect(pesel.valid?).to be_truthy }
+          specify { expect(pesel.date_of_birth.to_s).to eq(date_of_birth) }
+          specify { expect(pesel.sex).to eq(sex) }
+        end
+
+        context 'for year 19XX' do
+          let(:date_of_birth) { '1901-12-12' }
+          specify { expect(pesel.valid?).to be_truthy }
+          specify { expect(pesel.date_of_birth.to_s).to eq(date_of_birth) }
+          specify { expect(pesel.sex).to eq(sex) }
+        end
+
+        context 'for year 20XX' do
+          let(:date_of_birth) { '2001-12-12' }
+          specify { expect(pesel.valid?).to be_truthy }
+          specify { expect(pesel.date_of_birth.to_s).to eq(date_of_birth) }
+          specify { expect(pesel.sex).to eq(sex) }
+        end
+
+        context 'for year 21XX' do
+          let(:date_of_birth) { '2101-12-12' }
+          specify { expect(pesel.valid?).to be_truthy }
+          specify { expect(pesel.date_of_birth.to_s).to eq(date_of_birth) }
+          specify { expect(pesel.sex).to eq(sex) }
+        end
+
+        context 'for year 22XX' do
+          let(:date_of_birth) { '2201-12-12' }
+          specify { expect(pesel.valid?).to be_truthy }
+          specify { expect(pesel.date_of_birth.to_s).to eq(date_of_birth) }
+          specify { expect(pesel.sex).to eq(sex) }
+        end
+      end
+    end
+  end
+
+  describe '.generate_all' do
+    subject(:pesels) { described_class.generate_all(sex: 1, date_of_birth: '1983-06-04') }
+
+    specify { expect(pesels.count).to eq(5000) }
+    specify { expect(pesels.map(&:valid?).uniq.first).to be_truthy }
+    specify { expect(pesels.map(&:date_of_birth).uniq.first.to_s).to eq('1983-06-04') }
+    specify { expect(pesels.map(&:sex).uniq.first).to eq(1) }
+  end
+end

data/spec/activepesel/pesel_spec.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+RSpec.describe Activepesel::Pesel do
+  subject(:pesel) { described_class.new(pesel_number) }
+  describe '#valid?' do
+    context 'with valid pesel number' do
+      let(:pesel_number) { '88061654752' }
+      it 'returns true' do
+        expect(pesel.valid?).to be_truthy
+      end
+    end
+
+    context 'with invalid pesel number' do
+      let(:pesel_number) { '88061654751' }
+      it 'returns false' do
+        expect(pesel.valid?).to be_falsey
+      end
+    end
+
+    context 'with completely gibberish pesel number' do
+      let(:pesel_number) { 'sdfljklsrtbr' }
+      it 'returns false' do
+        expect(pesel.valid?).to be_falsey
+      end
+    end
+  end
+
+  describe '.generate_all' do
+    it 'responds to the generate method' do
+      expect(described_class).to respond_to :generate_all
+    end
+  end
+
+  describe '.generate_one' do
+    it 'responds to the generate method' do
+      expect(described_class).to respond_to :generate_one
+    end
+  end
+
+  describe '#sex' do
+    subject { pesel.sex }
+
+    context 'with invalid pesel' do
+      let(:pesel_number) { '88061654751' }
+      it { is_expected.to eq(9) }
+    end
+
+    context 'with valid pesel' do
+      context 'with male sex' do
+        let(:pesel_number) { '10240474019' }
+
+        it { is_expected.to eq(1) }
+      end
+
+      context 'with female sex' do
+        let(:pesel_number) { '10240428209' }
+
+        it { is_expected.to eq(2) }
+      end
+    end
+  end
+
+  describe '#date_of_birth' do
+    subject { pesel.date_of_birth }
+
+    context 'with invalid pesel' do
+      let(:pesel_number) { '88061654751' }
+      it { is_expected.to be_nil }
+    end
+
+    context 'with valid pesel' do
+      context 'with year 18XX' do
+        let(:pesel_number) { '01852014407' }
+        it { is_expected.to eq(Date.new(1801, 5, 20)) }
+      end
+
+      context 'with year 19XX' do
+        let(:pesel_number) { '88061654752' }
+        it { is_expected.to eq(Date.new(1988, 6, 16)) }
+      end
+
+      context 'with year 20XX' do
+        let(:pesel_number) { '10240428209' }
+        it { is_expected.to eq(Date.new(2010, 4, 4)) }
+      end
+
+      context 'with year 21XX' do
+        let(:pesel_number) { '34433088405' }
+        it { is_expected.to eq(Date.new(2134, 3, 30)) }
+      end
+
+      context 'with year 22XX' do
+        let(:pesel_number) { '22682152604' }
+        it { is_expected.to eq(Date.new(2222, 8, 21)) }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'activepesel'
+Bundler.setup
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  config.profile_examples = 10
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

metadata

@@ -1,60 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: activepesel
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - voytee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-03 00:00:00.000000000 Z
+date: 2023-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: A simple, ORM agnostic, Ruby 1.9 compatible PESEL (polish personal id
-  number) validator and personal data extractor for Rails 3, based on ActiveModel.
+        version: '3.0'
+description: A simple, ORM agnostic, PESEL (polish personal id number) validator and
+  personal data extractor
 email:
 - wpasternak@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rvmrc
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -66,122 +48,32 @@ files:
 - lib/activepesel/pesel_attr.rb
 - lib/activepesel/pesel_generator.rb
 - lib/activepesel/version.rb
-- lib/tasks/activepesel_tasks.rake
-- test/activepesel_test.rb
-- test/dummy/README.rdoc
-- test/dummy/Rakefile
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/mailers/.gitkeep
-- test/dummy/app/models/.gitkeep
-- test/dummy/app/models/user.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/db/migrate/20121114223156_create_users.rb
-- test/dummy/db/schema.rb
-- test/dummy/lib/assets/.gitkeep
-- test/dummy/log/.gitkeep
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/script/rails
-- test/dummy/test/fixtures/users.yml
-- test/dummy/test/unit/user_test.rb
-- test/pesel_attr_test.rb
-- test/pesel_generator_test.rb
-- test/pesel_test.rb
-- test/pesel_validator_test.rb
-- test/test_helper.rb
-- test/dummy/app/models/#user.rb#
-- test/dummy/db/development.sqlite3
-- test/dummy/db/test.sqlite3
-- test/dummy/log/development.log
-- test/dummy/log/test.log
+- media/id.jpg
+- spec/activepesel/pesel_attr_spec.rb
+- spec/activepesel/pesel_generator_spec.rb
+- spec/activepesel/pesel_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/voytee/activepesel
 licenses: []
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.5
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 3.1.6
 signing_key: 
-specification_version: 3
-summary: A simple, ORM agnostic, Ruby 1.9 compatible PESEL validator and personal
-  data extractor for Rails 3, based on ActiveModel.
-test_files:
-- test/activepesel_test.rb
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/models/#user.rb#
-- test/dummy/app/models/user.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/config.ru
-- test/dummy/db/development.sqlite3
-- test/dummy/db/migrate/20121114223156_create_users.rb
-- test/dummy/db/schema.rb
-- test/dummy/db/test.sqlite3
-- test/dummy/log/development.log
-- test/dummy/log/test.log
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/Rakefile
-- test/dummy/README.rdoc
-- test/dummy/script/rails
-- test/dummy/test/fixtures/users.yml
-- test/dummy/test/unit/user_test.rb
-- test/pesel_attr_test.rb
-- test/pesel_generator_test.rb
-- test/pesel_test.rb
-- test/pesel_validator_test.rb
-- test/test_helper.rb
+specification_version: 4
+summary: A simple, ORM agnostic, PESEL validator and personal data extractor
+test_files: []

data/.rvmrc

@@ -1 +0,0 @@
-rvm use 1.9.3@activepesel --create

data/Gemfile.lock

@@ -1,94 +0,0 @@
-PATH
-  remote: .
-  specs:
-    activepesel (0.1.0)
-      rails (>= 3.0.0)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    actionmailer (3.2.9)
-      actionpack (= 3.2.9)
-      mail (~> 2.4.4)
-    actionpack (3.2.9)
-      activemodel (= 3.2.9)
-      activesupport (= 3.2.9)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      journey (~> 1.0.4)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.2.1)
-    activemodel (3.2.9)
-      activesupport (= 3.2.9)
-      builder (~> 3.0.0)
-    activerecord (3.2.9)
-      activemodel (= 3.2.9)
-      activesupport (= 3.2.9)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.9)
-      activemodel (= 3.2.9)
-      activesupport (= 3.2.9)
-    activesupport (3.2.9)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    arel (3.0.2)
-    builder (3.0.4)
-    erubis (2.7.0)
-    hike (1.2.1)
-    i18n (0.6.1)
-    journey (1.0.4)
-    json (1.7.5)
-    mail (2.4.4)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.19)
-    multi_json (1.3.7)
-    polyglot (0.3.3)
-    rack (1.4.1)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.2)
-      rack (>= 1.0)
-    rails (3.2.9)
-      actionmailer (= 3.2.9)
-      actionpack (= 3.2.9)
-      activerecord (= 3.2.9)
-      activeresource (= 3.2.9)
-      activesupport (= 3.2.9)
-      bundler (~> 1.0)
-      railties (= 3.2.9)
-    railties (3.2.9)
-      actionpack (= 3.2.9)
-      activesupport (= 3.2.9)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (>= 0.14.6, < 2.0)
-    rake (10.0.0)
-    rdoc (3.12)
-      json (~> 1.4)
-    sprockets (2.2.1)
-      hike (~> 1.2)
-      multi_json (~> 1.0)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.6)
-    thor (0.16.0)
-    tilt (1.3.3)
-    treetop (1.4.12)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.35)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activepesel!
-  sqlite3

data/lib/tasks/activepesel_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :activepesel do
-#   # Task goes here
-# end