swedish-pin 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb6a746d0ef33cae631f59b11006ee17a98cc38af65b69b35a0f025a22beeae1
-  data.tar.gz: c9e0ca8008e77aab92808afee2e619bf6a7ed8d9461319449a304128a50237d5
+  metadata.gz: 8dd38e3a23539a5d2c44a2f47dca405748640377ff60f4f5f64359ccf78739b2
+  data.tar.gz: c03e1cd7d9d34ab5739a5e9e7647621138c3a7cb7e0ef8c9d12cd14d0ae28b57
 SHA512:
-  metadata.gz: cd9f5e5328d76e4d709a4d0b8e688b3e13fd186fb57c66eb82a8793215e01231cb1799d41a4e16a75b306d1d37c9cb3d7a2c1cb98a0ae79dec18ea5bc9cf554e
-  data.tar.gz: 4b7ed29721a100dc98515d181748f47d0c3957d677a19fb93a6ee287837a270dd845ccdaf20ec504735d7e20ad4d03629dc48cdb052d112380fafb3315ced81a
+  metadata.gz: 8c44152a32e0f99508dd754ab975e7bf8bb28dc5029c6d37f0f193edf82c7b0a410807c00e9beee2a8377fd3acc295ee4a5b15453dc3f9783151c9d9d0fa9df2
+  data.tar.gz: 13f23fd9dac7c68c6dc2227a7ada375f4ed335d1caf3f42496cf947932054e39c5b0a71c5a1183b55d6a13160071aefe0a9c402ef5a91d7bdc96ca52d95ba803

data/.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+# yaml-language-server: $schema=https://github.com/SchemaStore/schemastore/raw/master/src/schemas/json/github-workflow.json
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "2.7"
+          bundler-cache: true
+      - run: bundle exec standardrb --no-fix
+
+  tests:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: ["2.7", "3.0", "3.1", "3.2"]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: rake

data/.solargraph.yml

@@ -0,0 +1,16 @@
+---
+include:
+- "**/*.rb"
+exclude:
+- spec/**/*
+- test/**/*
+- vendor/**/*
+- ".bundle/**/*"
+require: []
+domains: []
+plugins:
+- solargraph-standardrb
+reporters:
+- standardrb
+require_paths: []
+max_files: 5000

data/CHANGELOG.md

@@ -7,9 +7,50 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+Nothing yet.
+
+## [2.0.0] - 2023-01-11
+
+### Breaking changes
+
+* Minimum supported Ruby version bumped from 2.5 to 2.7.
+
+### Fixed
+
+* PINs with future birthdates are now parsed as long as they are for the
+  current year.
+    * **Example:** `20xyab-nnnn` used to be parsed as `1920` until `2020-xy-ab`,
+    but now it's parsed as `2020` from 2020-01-01 and onwards. This is more
+    correct, since all 1920s PINs should be written with a `+` after
+    2020-01-01.
+* Parsing of 10-digit PINs were improved so it is always consistent so
+  `parse(pin.to_s(10)) == pin`.
+
+### Removed
+
+* Explicit installation of `rake` and `minitest` as development dependencies
+  removed. Now relying on the versions bundled with Ruby.
+
+### Other
+
+* Travis CI setup changed into Github Actions.
+
+## [1.1.0] - 2022-07-04
+
+### Fixed
+
+* `rake test` actually runs tests now.
+
+### Added
+
+* `Personnummer` can now be compared and sorted.
+* `Personnummer` works as hash keys by value.
+
 ## [1.0.0] - 2020-09-09
 
 Initial release.
 
-[Unreleased]: https://github.com/Mange/swedish-pin-ruby/compare/v1.0.0...HEAD
 [1.0.0]: https://github.com/Mange/swedish-pin-ruby/releases/tag/v1.0.0
+[1.1.0]: https://github.com/Mange/swedish-pin-ruby/releases/tag/v1.1.0
+[2.0.0]: https://github.com/Mange/swedish-pin-ruby/releases/tag/v2.0.0
+[Unreleased]: https://github.com/Mange/swedish-pin-ruby/compare/v2.0.0...HEAD

data/Gemfile.lock

@@ -1,47 +1,48 @@
 PATH
   remote: .
   specs:
-    swedish-pin (1.0.0)
+    swedish-pin (2.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.1)
-    minitest (5.14.2)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    ast (2.4.2)
+    json (2.6.3)
+    language_server-protocol (3.17.0.2)
+    parallel (1.22.1)
+    parser (3.2.0.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.7.1)
-    rexml (3.2.4)
-    rubocop (0.90.0)
+    rainbow (3.1.1)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rubocop (1.42.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
-      rexml
-      rubocop-ast (>= 0.3.0, < 1.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.3.0)
-      parser (>= 2.7.1.4)
-    rubocop-performance (1.8.0)
-      rubocop (>= 0.87.0)
-    ruby-progressbar (1.10.1)
-    standard (0.6.0)
-      rubocop (~> 0.90)
-      rubocop-performance (~> 1.8.0)
-    unicode-display_width (1.7.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.21.1)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (= 1.42.0)
+      rubocop-performance (= 1.15.2)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  minitest
-  rake
   standard
   swedish-pin!
 
 BUNDLED WITH
-   2.1.4
+   2.2.22

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2020 - Personnummer, Magnus Bergmark and Contributors
+Copyright (c) 2017-2022 - Personnummer, Magnus Bergmark and Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,6 @@
 # swedish-pin
 
-[![Build Status](https://secure.travis-ci.org/Mange/swedish-pin-ruby.png?branch=master)](http://travis-ci.org/Mange/swedish-pin-ruby) [![Inline docs](http://inch-ci.org/github/Mange/swedish-pin-ruby.svg?branch=master)](http://inch-ci.org/github/Mange/swedish-pin-ruby)
+[![Inline docs](http://inch-ci.org/github/Mange/swedish-pin-ruby.svg?branch=master)](http://inch-ci.org/github/Mange/swedish-pin-ruby)
 
 Validate, parse, and generate [Swedish Personal Identity
 Numbers](https://en.wikipedia.org/wiki/Personal_identity_number_(Sweden))

data/Rakefile

@@ -3,8 +3,6 @@ require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
 end
 
 task default: :test

data/bin/standardrb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'standardrb' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("standard", "standardrb")

data/lib/swedish_pin/generator.rb

@@ -8,37 +8,37 @@ module SwedishPIN
   #
   # Generator for PINs.
   class Generator
-    # The date all generated PINs will be based on.
-    attr_reader :date
-
     # Creates a new generator for a particular date.
-    def initialize(date)
-      @date = date || random_date
+    def initialize(random: Random)
+      @random = random
     end
 
     # Generate a {Personnummer} with the given sequence number.
-    def generate(sequence_number)
+    def generate(date: random_date, sequence_number: random_sequence_number)
+      # Handle someone explicitly passing `nil`.
+      date ||= random_date
       sequence_number ||= random_sequence_number
+
       Personnummer.new(
         year: date.year,
         month: date.month,
         day: date.day,
         sequence_number: sequence_number,
-        control_digit: control_digit(sequence_number)
+        control_digit: control_digit(date, sequence_number)
       )
     end
 
     private
 
     def random_date
-      Date.today - Random.rand(0..(110 * 365))
+      Date.today - @random.rand(0..(110 * 365))
     end
 
     def random_sequence_number
-      Random.rand(0..999)
+      @random.rand(0..999)
     end
 
-    def control_digit(sequence_number)
+    def control_digit(date, sequence_number)
       padded = ("%03d" % sequence_number)
       SwedishPIN.luhn("#{date.strftime("%y%m%d")}#{padded}")
     end

data/lib/swedish_pin/parser.rb

@@ -17,7 +17,7 @@ module SwedishPIN
       (?<sequence_number>\d{3})
       (?<control_digit>\d)
       \z
-    /x.freeze
+    /x
     private_constant :MATCHER
 
     # Setup a new parser.
@@ -105,19 +105,30 @@ module SwedishPIN
     end
 
     def guess_century
-      guessed_year = (now.year / 100) * 100 + year
-
-      # Don't guess future dates; skip back a century when that happens.
-      if Time.new(guessed_year, month, real_day) > now
-        guessed_year -= 100
+      century = now.year / 100
+
+      # Century could take up to three different values, depending on
+      # combination of "future" dates and `+` separators.
+      #
+      #   For example, on year 2010:
+      #     100101-nnnn => 2010-01-01
+      #     110101-nnnn => 1911-01-01 (because 2011 has not happened yet)
+      #     110101+nnnn => 1811-01-01 (1911 - 100 years)
+      #     090101+nnnn => 1909-01-01 (2009 - 100 years)
+      #
+      # One step comes from using the `+` separator, which means "remove
+      # another 100 years", despite what the rest of the date seems to imply.
+
+      # Assume previous century on future years
+      if (century * 100) + year > now.year
+        century -= 1
       end
 
-      # The "+" separator means another century back.
       if @matches["separator"] == "+"
-        guessed_year -= 100
+        century -= 1
       end
 
-      guessed_year / 100
+      century
     end
 
     def validate_match

data/lib/swedish_pin/personnummer.rb

@@ -8,6 +8,8 @@ module SwedishPIN
   #
   # @see https://en.wikipedia.org/wiki/Personal_identity_number_(Sweden) Personnummer on Wikipedia.
   class Personnummer
+    include Comparable
+
     attr_reader :year, :month, :day, :sequence_number, :control_digit
     # @!attribute [r] year
     #   The full year of the _personnummer_. For example +1989+.
@@ -42,7 +44,7 @@ module SwedishPIN
       @year = year
       @month = month
       @coordination_number = day > 60
-      @day = (day > 60 ? day - 60 : day)
+      @day = ((day > 60) ? day - 60 : day)
       @sequence_number = sequence_number
       @control_digit = control_digit
     end
@@ -175,9 +177,32 @@ module SwedishPIN
       sequence_number.even?
     end
 
+    def ==(other)
+      if other.is_a?(self.class)
+        format_long == other.format_long
+      else
+        super
+      end
+    end
+
+    def <=>(other)
+      if other.is_a?(self.class)
+        format_long <=> other.format_long
+      else
+        super
+      end
+    end
+
+    def hash
+      [self.class, format_long].hash
+    end
+    alias_method :eql?, :==
+
     private
 
     def short_separator(now)
+      # Turn into `+` on the same year as the PINs 100th birthday, even before
+      # the actual date.
       if year <= (now.year - 100)
         "+"
       else

data/lib/swedish_pin/version.rb

@@ -2,5 +2,5 @@
 
 module SwedishPIN
   # The version number of this library.
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 end

data/lib/swedish_pin.rb

@@ -81,7 +81,7 @@ module SwedishPIN
   # @param [Date, Time, nil] birthday The birthday of the person the PIN identifies, or +nil+ for a random date in the past.
   # @param [String, Integer, nil] sequence_number The sequence number that correspond to the three digits after the birthday, or +nil+ to pick a random one.
   def self.generate(birthday = nil, sequence_number = nil)
-    Generator.new(birthday).generate(sequence_number)
+    Generator.new.generate(date: birthday, sequence_number: sequence_number)
   end
 
   # @api private

data/personnummer.gemspec

@@ -3,7 +3,7 @@ require_relative "lib/swedish_pin/version"
 Gem::Specification.new do |s|
   s.name = "swedish-pin"
   s.version = SwedishPIN::VERSION
-  s.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  s.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   s.license = "MIT"
   s.summary = "Work with Swedish PINs (Personnummer)"
@@ -22,7 +22,5 @@ Gem::Specification.new do |s|
   s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "rake"
-  s.add_development_dependency "minitest"
   s.add_development_dependency "standard"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swedish-pin
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Magnus Bergmark
@@ -10,36 +10,8 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-09-09 00:00:00.000000000 Z
+date: 2023-01-11 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
@@ -64,14 +36,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
+- ".solargraph.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
+- bin/standardrb
 - lib/swedish-pin.rb
 - lib/swedish_pin.rb
 - lib/swedish_pin/errors.rb
@@ -92,14 +66,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Work with Swedish PINs (Personnummer)

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-before_script:
-  bundle install
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
-sudo: false