loi_parser 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bd1b7478112fcb89c4e2dbe1488e0ba2ad80660a4961bd653fbe7e13808125d
-  data.tar.gz: c91e18d7a6eb9aba55ae689bb6e9755998157cbf720d3106713617e245fad7a7
+  metadata.gz: 717100c3240b162307dc6349e8bca4a99d1d9af4079c05b97663f84a298add77
+  data.tar.gz: 9899e509a951ba72c602f73e1bc519b1f27a553b14927d303fd79a380b3a90d1
 SHA512:
-  metadata.gz: 4ac95c4499e291bcb0e18aea849423c06fe761bf482dc43954358bffb842704fae5f9ce07d671201a44344fcf8caa46d5766d8428587d1e462e6f349d34a5006
-  data.tar.gz: a01c90bd3eeb38575f7070e293c6ade131d46ed0b6ad04d55ccc05910589ab0ae263a8f2bbdc9fb32467457412776c7a442ebbb69bb9e9550b06b6e1cf0dd8e0
+  metadata.gz: 5d67325b298b6c980f91d0899460f7920239d2b57bb741e0afd60a66924b1aeb149b5a1db4d2f90cb20472fc504bce48f2d83472dea0b75b778ab7bb676a0a63
+  data.tar.gz: e2b4acece31219290fa3b715bbb431fe6f33cd103f9304e12fb783b0a3179a5418c46f50aab778ff6b1860528edcde038f5c2c63c104d7aedaa059712de59d58

data/CHANGELOG.md

@@ -6,9 +6,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.1.0] - 2023-03-14
+### Added
+- Configurable file.read length
+- Thousands formater on the "founds" result
+
+### Changed
+- Reading 5 000 bytes by default in order to speed up the reading process
+- Logging data
+
 ## [1.0.0] - 2023-03-13
 ### Added
 - Initial import
 
-[Unreleased]: https://gitlab.com/pharmony/loi-parser/compare/v1.0.0...master
+[Unreleased]: https://gitlab.com/pharmony/loi-parser/compare/v1.1.0...master
+[1.1.0]: https://gitlab.com/pharmony/loi-parser/compare/v1.0.0...v1.1.0
 [1.0.0]: https://gitlab.com/hydrana/hydrana/tags/v1.0.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    loi_parser (1.0.0)
+    loi_parser (1.1.0)
       logger
 
 GEM

data/README.md

@@ -42,17 +42,25 @@ Or install it yourself as:
 
 # 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-14T14:33:12.606494 #135]  INFO -- LoiParser: 0% Found: 0 (Elapsed: 0 ms)
+I, [2023-03-14T14:33:12.610240 #135]  INFO -- LoiParser: 1% Found: 0 (Elapsed: 3 ms)
+I, [2023-03-14T14:33:12.616639 #135]  INFO -- LoiParser: 2% Found: 0 (Elapsed: 10 ms)
+I, [2023-03-14T14:33:12.621245 #135]  INFO -- LoiParser: 3% Found: 0 (Elapsed: 14 ms)
+I, [2023-03-14T14:33:12.625052 #135]  INFO -- LoiParser: 4% Found: 0 (Elapsed: 18 ms)
 ...
-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, ...]
+I, [2023-03-14T14:33:13.116982 #135]  INFO -- LoiParser: 99% Found: 50 (Elapsed: 510 ms)
+I, [2023-03-14T14:33:13.120837 #135]  INFO -- LoiParser: 100% Found: 50 (Elapsed: 514 ms)
+I, [2023-03-14T14:33:13.130306 #135]  INFO -- LoiParser: Gathered 5113 serial number(s) in opposition in 523 ms.
 ```
 
+**WARNING:** This gem doesn't have a _callback_ mechanism to pass found serial
+numbers on the go. Instead it stores all the serial numbers found in an Array
+which leads to a overflow failure depending on the machine's memory size.
+
+Extracting all the serial numbers was an experiment we did in order to store
+the serial numbers in a database, but we have abondonned this way since it is
+very slow.
+
 ## 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.

data/lib/loi_parser/configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module LoiParser
+  #
+  # LoiParser gem configuration class
+  #
+  class Configuration
+    # file.read length to be used to read the LOI file
+    attr_accessor :read_length
+
+    def initialize
+      @read_length = 5000
+    end
+  end
+end

data/lib/loi_parser/helpers.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module LoiParser
+  #
+  # This module contain various helper methods
+  #
+  module Helpers
+    def self.elapsed_time(elapsed)
+      if elapsed < 1
+        "#{(elapsed * 1000).to_i} ms"
+      elsif elapsed <= 60
+        "#{elapsed.to_i} seconds"
+      else
+        min, sec = elapsed.divmod(60)
+
+        "#{min} minutes #{sec.to_i} seconds"
+      end
+    end
+
+    # 1000 #=> 1,000
+    def self.formatted_thousands(number)
+      number.to_s.gsub(/\B(?=(...)*\b)/, ',')
+    end
+  end
+end

data/lib/loi_parser/reader.rb

@@ -69,9 +69,8 @@ module LoiParser
 
       LoiParser.logger.info(
         "Gathered #{serial_numbers.size} serial number(s) " \
-        "in opposition in #{elapsed_time_in_minutes} minutes."
+        "in opposition in #{elapsed_time_in_minutes}."
       )
-      LoiParser.logger.info "Serials in opposition: #{serial_numbers.inspect}"
 
       serial_numbers
     end
@@ -93,43 +92,46 @@ module LoiParser
       header
     end
 
-    def current_byte_pos
+    def current_bytes_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
+      Helpers.elapsed_time(
+        Process.clock_gettime(Process::CLOCK_MONOTONIC) - @starting
+      )
+    end
 
-      if elapsed <= 60
-        "#{elapsed.to_i} seconds"
-      else
-        min, sec = elapsed.divmod(60)
+    def extract_serial_mumbers_from(bytes)
+      # Splits bytes in groups of 8 chars
+      splited_bytes = bytes.scan(/.{1,8}/)
 
-        # https://stackoverflow.com/a/33684387/1996540
-        "#{min} minutes #{sec.to_i} seconds"
-      end
-    end
+      splited_bytes.each.with_index(1).flat_map do |byte, bindex|
+        # Calculates the position in file for the current byte
+        current_byte_pos = current_bytes_pos - (splited_bytes.size - bindex)
 
-    def extract_serial_mumbers_from(byte)
-      byte.each_char.with_index(1).map do |bit, index|
-        next if bit == '0'
+        # Go through the 8 bites looking for '1'
+        byte.each_char.with_index(1).map do |bit, index|
+          next if bit == '0'
 
-        ((current_byte_pos * 8) + (8 - index))
+          # Calculates the serial number from the position in the file plus the
+          # offset of the bit
+          ((current_byte_pos * 8) + (8 - index))
+        end
       end.compact
     end
 
     def find_all_serial_numbers_in_opposition
       serial_numbers = []
 
-      until (readed = @file.read(1)).nil?
-        byte = readed.unpack1('B*')
+      until (readed = @file.read(LoiParser.configuration.read_length)).nil?
+        bytes = readed.unpack1('B*')
 
         print_percentage(serial_numbers.size)
 
-        next if byte == '00000000'
+        next unless bytes.include?('1')
 
-        serial_numbers |= extract_serial_mumbers_from(byte)
+        serial_numbers |= extract_serial_mumbers_from(bytes)
       end
 
       serial_numbers
@@ -149,8 +151,8 @@ module LoiParser
       return if percentage == @current_percentage
 
       LoiParser.logger.info(
-        "(#{percentage}%) pos: #{@file.pos} (Elapsed: " \
-        "#{elapsed_time_in_minutes} | Found: #{found}) ..."
+        "#{percentage}% Found: #{Helpers.formatted_thousands(found)} (" \
+        "Elapsed: #{elapsed_time_in_minutes})"
       )
 
       @current_percentage = percentage

data/lib/loi_parser/version.rb

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

data/lib/loi_parser.rb

@@ -2,6 +2,8 @@
 
 require 'logger'
 
+require_relative 'loi_parser/configuration'
+require_relative 'loi_parser/helpers'
 require_relative 'loi_parser/reader'
 require_relative 'loi_parser/version'
 
@@ -9,6 +11,14 @@ module LoiParser # rubocop:disable Style/Documentation
   class << self
     attr_writer :logger
 
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
     def logger
       @logger ||= Logger.new($stdout).tap do |log|
         log.progname = name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loi_parser
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Pharmony
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-13 00:00:00.000000000 Z
+date: 2023-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger
@@ -46,6 +46,8 @@ files:
 - bin/console
 - bin/setup
 - lib/loi_parser.rb
+- lib/loi_parser/configuration.rb
+- lib/loi_parser/helpers.rb
 - lib/loi_parser/reader.rb
 - lib/loi_parser/version.rb
 - loi_parser.gemspec