loi_parser 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3bd1b7478112fcb89c4e2dbe1488e0ba2ad80660a4961bd653fbe7e13808125d
+  data.tar.gz: c91e18d7a6eb9aba55ae689bb6e9755998157cbf720d3106713617e245fad7a7
+SHA512:
+  metadata.gz: 4ac95c4499e291bcb0e18aea849423c06fe761bf482dc43954358bffb842704fae5f9ce07d671201a44344fcf8caa46d5766d8428587d1e462e6f349d34a5006
+  data.tar.gz: a01c90bd3eeb38575f7070e293c6ade131d46ed0b6ad04d55ccc05910589ab0ae263a8f2bbdc9fb32467457412776c7a442ebbb69bb9e9550b06b6e1cf0dd8e0

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+spec/fixtures/202002131019.loi

data/.gitlab-ci.yml

@@ -0,0 +1,9 @@
+image: ruby:3.0.4
+
+before_script:
+  - gem install bundler -v 2.2.6
+  - bundle install
+
+build:
+  script:
+    - bundle exec rake

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.4
+
+Layout/LineLength:
+  Max: 80

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2023-03-13
+### Added
+- Initial import
+
+[Unreleased]: https://gitlab.com/pharmony/loi-parser/compare/v1.0.0...master
+[1.0.0]: https://gitlab.com/hydrana/hydrana/tags/v1.0.0

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in loi-parser.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 1.7'
+gem 'rubocop-rake', '~> 0.6', require: false
+gem 'rubocop-rspec', '~> 2.19', require: false
+gem 'rubyzip', '~> 2.3.2'

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    loi_parser (1.0.0)
+      logger
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    logger (1.5.3)
+    parallel (1.22.1)
+    parser (3.2.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.48.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.17.1)
+      rubocop (~> 1.41)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.19.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.13.0)
+    rubyzip (2.3.2)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  loi_parser!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+  rubocop-rake (~> 0.6)
+  rubocop-rspec (~> 2.19)
+  rubyzip (~> 2.3.2)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Pharmony
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# LOI Parser
+
+This gem reads the `.loi` file format, parses its header and bitmap allowing you
+to:
+* retrieve the file's application, date, range, and version
+* check if s serial number is in opposition
+* grab all the serial numbers being marked in opposition
+
+So far this gem only support "LOI" application files, not "dLOI" application
+files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'loi_parser'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install loi_parser
+
+## Usage
+
+```ruby
+> loi = LoiParser::Reader.new('/path/to/your/file.loi')
+
+# Check the file header:
+> loi.header
+ => {:length=>"0042", :application=>"LOI", :version=>"01", :date=>"20200213", :date_range=>"1019", :list_format=>"BTMP", :bitmap_size=>32000000}
+
+# Checking a given serial number being in opposition
+> loi.in_opposition?(99_999_999)
+ => true
+> loi.in_opposition?(12_345_678)
+ => false
+
+# Grabbing all the serial numbers being in opposition
+> loi.serials_in_opposition
+I, [2023-03-08T16:04:19.286193 #317]  INFO -- LoiParser: (0%) current_sn: 255999999/256000000 (Elapsed: 0 seconds | Found: 0) ...
+I, [2023-03-08T16:04:25.387373 #317]  INFO -- LoiParser: (1%) current_sn: 253440000/256000000 (Elapsed: 6 seconds | Found: 0) ...
+I, [2023-03-08T16:04:31.418921 #317]  INFO -- LoiParser: (2%) current_sn: 250880000/256000000 (Elapsed: 12 seconds | Found: 0) ...
+...
+I, [2023-03-08T11:02:13.052564 #99340]  INFO -- LoiParser: (99%) current_sn: 2560000/256000000 ...
+I, [2023-03-08T11:02:18.651785 #99340]  INFO -- LoiParser: (100%) current_sn: 0/256000000 ...
+I, [2023-03-08T11:02:18.651856 #99340]  INFO -- LoiParser: Gathered 50 serial number(s) in opposition in 578.848939881
+I, [2023-03-08T11:02:18.651881 #99340]  INFO -- LoiParser: Serials in opposition: [99999999, ...]
+ => [99999999, ...]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/pharmony/loi-parser.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'loi_parser'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/loi_parser/reader.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+module LoiParser
+  #
+  # Read about the Ruby's String#unpack method:
+  # https://ruby-doc.org/3.0.4/String.html#method-i-unpack
+  #
+  # Read about the Ruby's IO#seek method:
+  # https://ruby-doc.org/3.0.4/IO.html#method-i-seek
+  #
+  # Ruby Bitwise Operators
+  # https://medium.com/rubycademy/ruby-bitwise-operators-da57763fa368
+  #
+  class Reader
+    class InvalidLoiFile < StandardError; end
+
+    attr_reader :header, :path
+
+    HEADER_COLUMNS = [
+      { field: :length, length: 4 },
+      { field: :application, length: 20 },
+      { field: :version, length: 2 },
+      { field: :date, length: 8 },
+      { field: :date_range, length: 4 },
+      { field: :list_format, length: 4 },
+      { field: :bitmap_size, length: 8 }
+    ].freeze
+
+    def initialize(path)
+      @path = path
+
+      open_file!
+
+      @header = build_header
+      @list_start_position = @file.pos
+    end
+
+    def in_opposition?(serial_number)
+      unless serial_number.is_a?(Integer)
+        raise ArgumentError, 'serial_number must be an Integer'
+      end
+
+      # Reading the bitmap list
+      position = serial_number / 8
+
+      # When position is out of bitmap range, the serial number is in opposition
+      return true if position > header[:bitmap_size]
+
+      # Moves to the serial number position from the bitmap
+      @file.seek(position, IO::SEEK_CUR)
+
+      # Read the byte as binary
+      byte = @file.read(1).unpack1('B*')
+
+      # Checks for opposition
+      opposition = serial_in_opposition_from?(serial_number, byte)
+
+      # Moves back to the initial position
+      @file.seek(@list_start_position, IO::SEEK_SET)
+
+      opposition
+    end
+
+    def serials_in_opposition
+      # https://blog.dnsimple.com/2018/03/elapsed-time-with-ruby-the-right-way/
+      @starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
+      serial_numbers = find_all_serial_numbers_in_opposition
+
+      LoiParser.logger.info(
+        "Gathered #{serial_numbers.size} serial number(s) " \
+        "in opposition in #{elapsed_time_in_minutes} minutes."
+      )
+      LoiParser.logger.info "Serials in opposition: #{serial_numbers.inspect}"
+
+      serial_numbers
+    end
+
+    private
+
+    def serial_in_opposition_from?(serial_number, byte)
+      byte.to_i(2) & (1 << (serial_number % 8)) != 0
+    end
+
+    def build_header
+      header = read_header_from_file
+
+      header[:application] = header[:application].strip
+      header[:bitmap_size] = header[:bitmap_size].to_i
+
+      raise InvalidLoiFile unless %w[LOI dLOI].include?(header[:application])
+
+      header
+    end
+
+    def current_byte_pos
+      @file.pos - @list_start_position - 1
+    end
+
+    def elapsed_time_in_minutes
+      # https://blog.dnsimple.com/2018/03/elapsed-time-with-ruby-the-right-way/
+      elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - @starting
+
+      if elapsed <= 60
+        "#{elapsed.to_i} seconds"
+      else
+        min, sec = elapsed.divmod(60)
+
+        # https://stackoverflow.com/a/33684387/1996540
+        "#{min} minutes #{sec.to_i} seconds"
+      end
+    end
+
+    def extract_serial_mumbers_from(byte)
+      byte.each_char.with_index(1).map do |bit, index|
+        next if bit == '0'
+
+        ((current_byte_pos * 8) + (8 - index))
+      end.compact
+    end
+
+    def find_all_serial_numbers_in_opposition
+      serial_numbers = []
+
+      until (readed = @file.read(1)).nil?
+        byte = readed.unpack1('B*')
+
+        print_percentage(serial_numbers.size)
+
+        next if byte == '00000000'
+
+        serial_numbers |= extract_serial_mumbers_from(byte)
+      end
+
+      serial_numbers
+    end
+
+    def open_file!
+      unless File.exist?(@path)
+        raise "#{self.class} ERROR: #{@path} doesn't exist."
+      end
+
+      @file = File.open(@path)
+    end
+
+    def print_percentage(found)
+      percentage = (@file.pos * 100) / header[:bitmap_size]
+
+      return if percentage == @current_percentage
+
+      LoiParser.logger.info(
+        "(#{percentage}%) pos: #{@file.pos} (Elapsed: " \
+        "#{elapsed_time_in_minutes} | Found: #{found}) ..."
+      )
+
+      @current_percentage = percentage
+    end
+
+    def read_header_from_file
+      HEADER_COLUMNS.each_with_object({}) do |column, acc|
+        acc[column[:field]] = @file.read(column[:length]).unpack1('M')
+      end
+    end
+  end
+end

data/lib/loi_parser/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LoiParser
+  VERSION = '1.0.0'
+end

data/lib/loi_parser.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+require_relative 'loi_parser/reader'
+require_relative 'loi_parser/version'
+
+module LoiParser # rubocop:disable Style/Documentation
+  class << self
+    attr_writer :logger
+
+    def logger
+      @logger ||= Logger.new($stdout).tap do |log|
+        log.progname = name
+      end
+    end
+  end
+end

data/loi_parser.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'lib/loi_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'loi_parser'
+  spec.version       = LoiParser::VERSION
+  spec.authors       = ['Pharmony']
+  spec.email         = ['dev@pharmony.eu']
+
+  spec.summary       = 'LOI (Liste d’Opposition Incrémentale) file reader'
+  spec.description   = 'This gem parses the `.loi` file format and allows ' \
+                       'to check if a given National Insurance Number card ' \
+                       "serial number is marked as 'in opposition', or to " \
+                       'extract all the serial numbers in opposition.'
+  spec.homepage      = 'https://gitlab.com/pharmony/loi-parser'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/-/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:spec)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'logger'
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: loi_parser
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pharmony
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem parses the `.loi` file format and allows to check if a given
+  National Insurance Number card serial number is marked as 'in opposition', or to
+  extract all the serial numbers in opposition.
+email:
+- dev@pharmony.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/loi_parser.rb
+- lib/loi_parser/reader.rb
+- lib/loi_parser/version.rb
+- loi_parser.gemspec
+homepage: https://gitlab.com/pharmony/loi-parser
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://gitlab.com/pharmony/loi-parser
+  source_code_uri: https://gitlab.com/pharmony/loi-parser
+  changelog_uri: https://gitlab.com/pharmony/loi-parser/-/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: LOI (Liste d’Opposition Incrémentale) file reader
+test_files: []