activepesel 0.0.2 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '02738e059a1bbedb639b461ea980a2b1b6d4501e84589ef51725f8b7e0625945'
+  data.tar.gz: f8d7d1639e109ffb5c41014ae7aeca384cc0b80b0e0c8abc1f3e78b73987ee1e
+SHA512:
+  metadata.gz: d26e1884df6aec08ca3ab40d8d9e6a1da0029704a75e432368ac4986c527977be243a46835185f3a7f5aea0a65813ad584ed32f1d52c12aaa01b16c28c540c42
+  data.tar.gz: 2edd6225b3310920707b3bcba8a43443bed39081e3ab83dbbfdad0abba2e745e5397f6967eb17d1298cca111fe9934463d23d88d150dee5e5b18e64490a23b80

data/.gitignore

@@ -1,21 +1,15 @@
-.bundle/
-log/*.log
+# bundler
+.bundle
+Gemfile.lock
+Gemfile.local
+vendor/
 pkg/
-test/dummy/db/*.sqlite3
-test/dummy/log/*.log
-test/dummy/tmp/
-test/dummy/.sass-cache
 
-auto-save-list
-custom.el
-url/
-.org-id-locations
-\#*
-org-mode-config.el
-*~
-.#*
-\#*\#
-*.log
+# rbenv
+.ruby-version
+
+# byebug
+.byebug_history
+
+# For MacOS:
 .DS_Store
-org-clock-save.el
-emacs-config.el

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,176 @@
+AllCops:
+  TargetRubyVersion: 2.7.5
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'
+    - 'test/fixtures/**/*'
+    - 'db/**/*'
+    - 'bin/**/*'
+    - 'log/**/*'
+    - 'tmp/**/*'
+    - 'app/views/**/*'
+    - 'config/environments/*'
+    - 'node_modules/**/*'
+
+# Metrics Cops
+
+Metrics/ClassLength:
+  Description: 'Avoid classes longer than 100 lines of code.'
+  Max: 100
+  Enabled: true
+
+Metrics/ModuleLength:
+  Description: 'Avoid modules longer than 100 lines of code.'
+  Max: 100
+  Enabled: true
+
+Metrics/ParameterLists:
+  Description: 'Pass no more than four parameters into a method.'
+  Max: 4
+  Enabled: true
+
+Metrics/MethodLength:
+  Description: 'Avoid methods longer than 10 lines of code.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#short-methods'
+  Max: 10
+  Enabled: true
+
+Metrics/BlockLength:
+  CountComments: false
+  Max: 10
+  Exclude:
+    - 'spec/**/*'
+    - '*.gemspec'
+  AllowedMethods:
+    - context
+    - describe
+    - it
+    - shared_examples
+    - shared_examples_for
+    - namespace
+    - draw
+    - configure
+    - group
+
+# Style Cops
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*'
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Description: 'Checks style of children classes and modules.'
+  Enabled: false
+  EnforcedStyle: nested
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    find: detect
+    inject: reduce
+    collect: map
+    find_all: select
+
+Style/Documentation:
+  Description: 'Document classes and non-namespace modules.'
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Description: >-
+    Add the frozen_string_literal comment to the top of files
+    to help transition from Ruby 2.3.0 to Ruby 3.0.
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Description: >-
+                 Favor modifier if/unless usage when you have a
+                 single-line body.
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier'
+  Enabled: false
+
+Style/InlineComment:
+  Description: 'Avoid inline comments.'
+  Enabled: false
+
+Style/LineEndConcatenation:
+  Description: >-
+                 Use \ instead of + or << to concatenate two string literals at
+                 line end.
+  Enabled: true
+
+Style/StringLiterals:
+  Description: 'Checks if uses of quotes match the configured preference.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-string-literals'
+  EnforcedStyle: single_quotes
+  Enabled: true
+
+Style/TrailingCommaInArguments:
+  Description: 'Checks for trailing comma in argument lists.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  EnforcedStyleForMultiline: comma
+  SupportedStylesForMultiline:
+    - comma
+    - consistent_comma
+    - no_comma
+  Enabled: true
+
+Style/TrailingCommaInArrayLiteral:
+  Description: 'Checks for trailing comma in array literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  EnforcedStyleForMultiline: comma
+  SupportedStylesForMultiline:
+    - comma
+    - consistent_comma
+    - no_comma
+  Enabled: true
+
+Style/TrailingCommaInHashLiteral:
+  Description: 'Checks for trailing comma in hash literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  EnforcedStyleForMultiline: comma
+  SupportedStylesForMultiline:
+    - comma
+    - consistent_comma
+    - no_comma
+  Enabled: true
+
+# Layout Cops
+
+Layout/ArgumentAlignment:
+  Exclude:
+    - 'config/initializers/*'
+
+Layout/FirstArgumentIndentation:
+  Enabled: false
+
+Layout/DotPosition:
+  Description: 'Checks the position of the dot in multi-line method calls.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains'
+  Enabled: false
+
+Layout/LineLength:
+  Description: 'Limit lines to 120 characters.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#80-character-limits'
+  Max: 120
+
+Layout/MultilineOperationIndentation:
+  Description: >-
+                 Checks indentation of binary operations that span more than
+                 one line.
+  Enabled: true
+  EnforcedStyle: indented
+
+Layout/MultilineMethodCallIndentation:
+  Description: >-
+                 Checks indentation of method calls with the dot operator
+                 that span more than one line.
+  Enabled: true
+  EnforcedStyle: indented
+
+# Bundler Cops
+
+Bundler/OrderedGems:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.2.0 (Jan, 25th 2023)
+ - Replace tests with specs
+ - Stop including `Activepesel::PeselAttr` `to ActiveRecord::Base`, it should be included explicitly to a model instead
+ - Replace `Activepesel::Pesel#generate` with `Activepesel::Pesel#generate_one` and `Activepesel::Pesel#generate_all`
+ - Add Ruby 3.X support
+ - Fix styling and add rubocop
+ - Reduce dependencies

data/Gemfile

@@ -1,4 +1,10 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
 
-gemspec
+source 'http://rubygems.org'
+
+group :development do
+  gem 'rspec'
+  gem 'rubocop', '~> 1.44'
+end
 
+gemspec

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2012 YOURNAME
+Copyright 2012-2023 by Wojciech Pasternak
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,6 +1,13 @@
 # Activepesel
 
-A simple PESEL (polish personal ID number) validator and personal data extractor for Rails 3. Compatible with Ruby 1.9 (Tested with 1.9.3)
+[![Gem Version](https://badge.fury.io/rb/activepesel.svg)](https://badge.fury.io/rb/activepesel)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
+
+A simple PESEL (polish personal ID number) validator (ActiveModel based), generator and personal data extractor.
+
+![](./media/id.jpg)
+
+----------
 
 Activepesel library is available as a gem. In your Gemfile add:
 
@@ -8,24 +15,24 @@ Activepesel library is available as a gem. In your Gemfile add:
 gem 'activepesel'
 ```
 
-#In your model:
+# In your model:
 
 ```ruby
 class User < ActiveRecord::Base
+  # you have to explicitly include it since version 0.2.0
+  include Activepesel::PeselAttr
 
-  attr_accessible :dads_pesel, :mums_pesel
-  
+  # let's say we have dads_pesel and mums_pesel columns in the database
   # this will give the access to methods: 
   # dads_pesel_personal_data, mums_pesel_personal_data
   pesel_attr :dads_pesel, :mums_pesel
 
   # keep in mind that pesel validator is not performing a presence test
   # so you need another (standard) validation for this one
-  validates :dads_pesel, :presence => true
-  validates :dads_pesel, :pesel    => true
-  validates :mums_pesel, :pesel    => true
+  validates :dads_pesel, presence: true
+  validates :dads_pesel, pesel: true
+  validates :mums_pesel, pesel: true
   # pesel validator returns standard rails :invalid key error message
-
 end
 ```
 
@@ -36,9 +43,15 @@ When using ```attr_pesel :name_of_attr``` in your model you will get new instanc
 The method returns ```Activepesel::PersonalData``` object which has the following attributes:
 
 ```ruby
-date_of_birth:Date
-sex:Integer
+date_of_birth: Date
+sex: Integer
 ```
+See the example:
+
+```ruby
+User.find(1).dads_pesel_personal_data => Activepesel::PersonalData(...)
+```
+
 
 Sex attribute can take 3 values. 1 - for men, 2 - for women, 9 - not applicable ([ISO/IEC 5218](http://en.wikipedia.org/wiki/ISO/IEC_5218))
 
@@ -46,23 +59,24 @@ For the invalid PESEL numbers the ```date_of_birth``` attribute is set to ```nil
 
 # Saving personal data into database
 
-It is a common practise that you want to save the personal data extracted from the PESEL number to be able for example to query your records against all female persons. To do this you can use ActiveModel callbacks like in the example:
+It is a common practice that you'd want to save the personal data extracted from the PESEL number to be able for example to query your records against all female persons. To do this you can do something like this:
 
 ```ruby
 class User < ActiveRecord::Base
+  include Activepesel::PeselAttr
 
-  attr_accessible :pesel
   pesel_attr :pesel
   
-  validates :pesel, :pesel => true
+  validates :pesel, pesel: true
 
+  # we all don't like callbacks but for the sake of this simple example we can live with it
   before_save :set_personal_data
 
   private
 
   def set_personal_data
     self.date_of_birth = pesel_personal_data.date_of_birth
-    self.sex           = pesel_personal_data.sex
+    self.sex = pesel_personal_data.sex
   end
   
 end
@@ -74,13 +88,38 @@ end
 You can use it like in the given example
 
 ```ruby
-pesel = Activepesel::Pesel.new("82060202039")
+pesel = Activepesel::Pesel.new('82060202039')
 pesel.valid? => true
 pesel.personal_data => Activepesel::PersonalData(...)
 # or even quicker
 pesel.date_of_birth => Wed, 02 Jun 1982
 pesel.sex => 1
 ```  
+# Generating PESEL numbers
+
+Since version 0.1.0 you can generate valid PESEL numbers for a given date of birth and sex of a person.
+
+To generate one randomly picked PESEL number for let's say a male born on November 3rd 1975:
+
+```ruby
+# picks one random number for the given personal data
+Activepesel::Pesel.generate_one(sex: 1, date_of_birth: Date.new(1975,11,3))
+````
+
+To generate all (5000) PESEL numbers valid for a person of a given sex and date of birth for example a female born on May 20th 2010:
+
+```ruby
+# returns all possible numbers for the given personal data in a lexicographic order
+# notice that you can pass a stringified date.
+Activepesel::Pesel.generate_all, sex: 2, date_of_birth: '2010-05-20')
+```
+
+# Copyright
+
+Copyright (c) 2012 - 2023 Wojciech Pasternak released under the MIT license
+
+
+
 
 
 

data/Rakefile

@@ -1,38 +1 @@
-#!/usr/bin/env rake
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-begin
-  require 'rdoc/task'
-rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
-  RDoc::Task = Rake::RDocTask
-end
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Activepesel'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-
-
-
-Bundler::GemHelper.install_tasks
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-
-task :default => :test
+require 'bundler/gem_tasks'

data/activepesel.gemspec

@@ -1,23 +1,23 @@
-$:.push File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 
 # Maintain your gem's version:
-require "activepesel/version"
+require 'activepesel/version'
 
 # Describe your gem and declare its dependencies:
 Gem::Specification.new do |s|
-  s.name        = "activepesel"
+  s.required_ruby_version = '>= 2.7.5'
+  s.name        = 'activepesel'
   s.version     = Activepesel::VERSION
-  s.platform    = Gem::Platform::RUBY	
-  s.authors     = ["voytee"]
-  s.email       = ["wpasternak@gmail.com"]
-  s.homepage    = "http://github.com/voytee/activepesel"
-  s.summary     = %q{A simple, ORM agnostic, Ruby 1.9 compatible PESEL validator and personal data extractor for Rails 3, based on ActiveModel.}
-  s.description = %q{A simple, ORM agnostic, Ruby 1.9 compatible PESEL (polish personal id number) validator and personal data extractor for Rails 3, based on ActiveModel.}
-
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['voytee']
+  s.email       = ['wpasternak@gmail.com']
+  s.homepage    = 'http://github.com/voytee/activepesel'
+  s.summary     = 'A simple, ORM agnostic, PESEL validator and personal data extractor'
+  s.description = 'A simple, ORM agnostic, PESEL (polish personal id number) validator and personal data extractor'
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = Dir["test/**/*"]
-  s.require_paths = ["lib"]
-
-  s.add_dependency "rails", "~> 3.2.9"
-  s.add_development_dependency "sqlite3"
+  s.require_paths = ['lib']
+  s.add_dependency 'activesupport', '>= 3.0'
+  s.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/active_model/validations/pesel_validator.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module ActiveModel
   module Validations
     class PeselValidator < ActiveModel::EachValidator
       def validate_each(record, attr_name, value)
-        unless value.blank?
-          record.errors.add(attr_name, :invalid, options) unless Activepesel::Pesel.new(value).valid?
-        end
+        return if value.blank?
+
+        record.errors.add(attr_name, :invalid) unless Activepesel::Pesel.new(value).valid?
       end
     end
   end

data/lib/activepesel/personal_data.rb

@@ -1,24 +1,26 @@
+# frozen_string_literal: true
+
 module Activepesel
   class PersonalData
-    
     DELTA = {
       18 => 80,
-      19 =>  0,
+      19 => 0,
       20 => 20,
       21 => 40,
-      22 => 60
+      22 => 60,
     }.freeze
 
-    attr_reader :date_of_birth, 
+    attr_reader :date_of_birth,
                 :sex
 
     def initialize(pesel)
-      @date_of_birth, @sex = get_date_of_birth(pesel), get_sex(pesel)
+      @date_of_birth = get_date_of_birth(pesel)
+      @sex = get_sex(pesel)
     end
 
     private
-    
-    def get_century(pesel)
+
+    def get_century(pesel) # rubocop:disable Metrics/MethodLength
       case pesel.number[2..3].to_i
       when (81..92)
         18
@@ -34,31 +36,34 @@ module Activepesel
     end
 
     def year(pesel)
-      pesel.number[0..1].to_i + 100 * get_century(pesel)
+      pesel.number[0..1].to_i + (100 * get_century(pesel))
     end
 
     def month(pesel)
       pesel.number[2..3].to_i - DELTA[get_century(pesel)]
     end
-    
+
     def day(pesel)
       pesel.number[4..5].to_i
     end
 
     def get_date_of_birth(pesel)
-      if pesel.valid?
-        begin
-          Date.new(year(pesel), month(pesel), day(pesel)) 
-        rescue ArgumentError
-          return nil
-        end
+      return unless pesel.valid?
+
+      begin
+        Date.new(year(pesel), month(pesel), day(pesel))
+      rescue ArgumentError
+        nil
       end
     end
-    
+
     # ISO/IEC 5218
     def get_sex(pesel)
-      pesel.valid? ? (pesel.digits[9] % 2 == 0 ? 2 : 1) : 9
+      if pesel.valid?
+        pesel.digits[9].even? ? 2 : 1
+      else
+        9
+      end
     end
-    
   end
 end

data/lib/activepesel/pesel.rb

@@ -1,33 +1,40 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/core_ext'
+
 module Activepesel
   class Pesel
+    class << self
+      delegate :generate_all, :generate_one, to: :'Activepesel::PeselGenerator'
+    end
 
-    DIGIT_WEIGHTS = [1, 3, 7, 9, 1, 3 ,7, 9, 1, 3, 1].freeze
+    DIGIT_WEIGHTS = [1, 3, 7, 9, 1, 3, 7, 9, 1, 3, 1].freeze
 
     attr_reader :number
 
-    delegate :date_of_birth, :sex,  :to => :personal_data
-    
+    delegate :date_of_birth, :sex, to: :personal_data
+
     def initialize(number)
-      @number = number 
+      @number = number
     end
-    
+
     def valid?
-      digits.size == 11 && control_value % 10 == 0
-    end
-    
-    def digits
-      @number.split("").select{|digit| digit.to_i.to_s == digit}.map(&:to_i)
+      digits.size == 11 && (control_value % 10).zero?
     end
-    
+
     def personal_data
-      PersonalData.new(self)
+      @personal_data ||= PersonalData.new(self) if @number
+    end
+
+    def digits
+      @number.chars.select { |digit| digit.to_i.to_s == digit }.map(&:to_i)
     end
 
     private
-    
+
     def control_value
-      DIGIT_WEIGHTS.each_with_index.inject(0){|sum, (factor, idx)| sum + factor * digits[idx]}
+      DIGIT_WEIGHTS.each_with_index.reduce(0) { |sum, (factor, idx)| sum + (factor * digits[idx]) }
     end
-    
   end
 end

data/lib/activepesel/pesel_attr.rb

@@ -1,20 +1,17 @@
+# frozen_string_literal: true
+
 module Activepesel
   module PeselAttr
     extend ActiveSupport::Concern
-    
-    included do
-    end
-    
+
     module ClassMethods
       def pesel_attr(*attr_names)
         attr_names.each do |attr_name|
-          define_method("#{attr_name}_personal_data") do 
-            Pesel.new(send(attr_name)).personal_data
+          define_method("#{attr_name}_personal_data") do
+            Pesel.new(__send__(attr_name)).personal_data
           end
         end
       end
     end
   end
 end
-
-ActiveRecord::Base.send :include, Activepesel::PeselAttr