nxt_error_registry 0.1.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5e4747e5ca829838f0977c5fc22d6968694db1bd68b0893cd9477962db25e21
-  data.tar.gz: 00a3e42521ae209cf531dfa34c4247f1659a2af1ee3bcb1a8b216ed356683e13
+  metadata.gz: bda52fd0450bbea61e8dd04ae0056754de913a89035d271bd95e1e597c3fd9f5
+  data.tar.gz: d0e38001db61d3c2095d0383bd553c8851cf79afafbdd7c68e2c7877c072de2e
 SHA512:
-  metadata.gz: 598eb012588cd6d2dc748ed66043aac228d78397712f42a0ea72390e495bf7aebac8fc05ddf5b401c2d172c087bd4aa7f2c518c487181aed67b1298947585369
-  data.tar.gz: 67f6b433945347d037d4e354347a7d21794f75fdae34d0b59ec7252efa037082c688708316f78b5fc024e218b0c7f5409004c856f8583144bf8c96bb8c24e158
+  metadata.gz: b6114f3f6c8f53e0f6c9d47c088bac6b02b9bce405c376bb4d9c3e8c569edaa5781af8509b32bd88c860768f8868ffbd61a21faef19abe5db3a78073722ef6a0
+  data.tar.gz: e726218ec04e307db59869b9e839d287fd5a79e9467ba721472f1e6a60ddb8594df7f88dec9f5e58e3c2b7094a65c944fa3063d37accac51fca0a66d2ff0d897

data/.circleci/config.yml

@@ -4,7 +4,7 @@ jobs:
   build:
     working_directory: /home/circleci/app
     docker:
-      - image: circleci/ruby:2.6.2-node
+      - image: circleci/ruby:2.7.2-node
     environment:
       RACK_ENV: test
       RAILS_ENV: test

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+2.7.2

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+# v0.2.5 2022-01-27
+
+### Updated
+
+- Relax dependencies to Railties and ActiveSupport to allow Rails 7.x
+
+# v0.2.4 2021-03-26
+
+### Updated
+
+- Switched Rails dependency to railties
+
+# v0.2.3 2021-01-05
+
+### Updated
+
+- Loosen Rails and ActiveSupport version constraint to allow 6.1
+
+# v0.2.2 2020-12-28
+
+### Changed
+
+- Updated dependencies
+
+[Compare v0.2.1...v0.2.2](https://github.com/nxt-insurance/nxt_error_registry/compare/v0.2.1...v0.2.2)
+
+# v0.2.1 2020-08-28
+
+### Fixed
+
+- Allow legacy codes of format /\A\d{3}\.\d{3}\z/
+
+[Compare v0.2.0...v0.2.1](https://github.com/nxt-insurance/nxt_error_registry/compare/v0.2.0...v0.2.1)
+
+# v0.2.0 2020-08-25
+
+### Added
+
+- Use uuids as codes instead of numeric codes in sequence
+
+[Compare v0.1.6...v0.2.0](https://github.com/nxt-insurance/nxt_error_registry/compare/v0.1.6...v0.2.0)

data/Gemfile.lock

@@ -1,156 +1,87 @@
 PATH
   remote: .
   specs:
-    nxt_error_registry (0.1.4)
-      activesupport (< 6.1)
-      rails (< 6.1)
+    nxt_error_registry (0.2.5)
+      activesupport (< 8.0)
+      railties (< 8.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      activejob (= 6.0.2.1)
-      activerecord (= 6.0.2.1)
-      activestorage (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
-      mail (>= 2.7.1)
-    actionmailer (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      actionview (= 6.0.2.1)
-      activejob (= 6.0.2.1)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 2.0)
-    actionpack (6.0.2.1)
-      actionview (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
-      rack (~> 2.0, >= 2.0.8)
+    actionpack (7.0.1)
+      actionview (= 7.0.1)
+      activesupport (= 7.0.1)
+      rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      activerecord (= 6.0.2.1)
-      activestorage (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
-      nokogiri (>= 1.8.5)
-    actionview (6.0.2.1)
-      activesupport (= 6.0.2.1)
+    actionview (7.0.1)
+      activesupport (= 7.0.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.2.1)
-      activesupport (= 6.0.2.1)
-      globalid (>= 0.3.6)
-    activemodel (6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activerecord (6.0.2.1)
-      activemodel (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
-    activestorage (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      activejob (= 6.0.2.1)
-      activerecord (= 6.0.2.1)
-      marcel (~> 0.3.1)
-    activesupport (6.0.2.1)
+    activesupport (7.0.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     builder (3.2.4)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.6)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
     crass (1.0.6)
-    diff-lcs (1.3)
-    erubi (1.9.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
-    i18n (1.8.2)
+    diff-lcs (1.5.0)
+    erubi (1.10.0)
+    i18n (1.9.0)
       concurrent-ruby (~> 1.0)
-    loofah (2.4.0)
+    loofah (2.13.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    mail (2.7.1)
-      mini_mime (>= 0.1.1)
-    marcel (0.3.3)
-      mimemagic (~> 0.3.2)
-    method_source (0.9.2)
-    mimemagic (0.3.4)
-    mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.0)
-    nio4r (2.5.2)
-    nokogiri (1.10.9)
-      mini_portile2 (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rack (2.2.2)
+    method_source (1.0.0)
+    mini_portile2 (2.7.1)
+    minitest (5.15.0)
+    nokogiri (1.13.1)
+      mini_portile2 (~> 2.7.0)
+      racc (~> 1.4)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.6.0)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.0.2.1)
-      actioncable (= 6.0.2.1)
-      actionmailbox (= 6.0.2.1)
-      actionmailer (= 6.0.2.1)
-      actionpack (= 6.0.2.1)
-      actiontext (= 6.0.2.1)
-      actionview (= 6.0.2.1)
-      activejob (= 6.0.2.1)
-      activemodel (= 6.0.2.1)
-      activerecord (= 6.0.2.1)
-      activestorage (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
-      bundler (>= 1.3.0)
-      railties (= 6.0.2.1)
-      sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (6.0.2.1)
-      actionpack (= 6.0.2.1)
-      activesupport (= 6.0.2.1)
+    railties (7.0.1)
+      actionpack (= 7.0.1)
+      activesupport (= 7.0.1)
       method_source
-      rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
-    rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
-    rspec_junit_formatter (0.4.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rspec_junit_formatter (0.5.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    sprockets (4.0.0)
+    thor (1.2.1)
+    tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.2.1)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
-    thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.6)
-      thread_safe (~> 0.1)
-    websocket-driver (0.7.1)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.4)
-    zeitwerk (2.2.2)
+    zeitwerk (2.5.3)
 
 PLATFORMS
   ruby
@@ -161,7 +92,7 @@ DEPENDENCIES
   pry
   rake (~> 13.0)
   rspec (~> 3.0)
-  rspec_junit_formatter (~> 0.4.1)
+  rspec_junit_formatter (~> 0.5.1)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -25,9 +25,9 @@ Or install it yourself as:
 ```ruby
 class LevelOne
   extend NxtErrorRegistry
-  register_error :LevelOneError, type: StandardError, code: '100.100'
+  register_error :LevelOneError, type: StandardError, code: '84b67c94-efb4-48e8-a5e9-ed1fa1beb988'
   # This will set the LevelOne::LevelOneError constant that you can raise anywhere
-  register_error :LevelTwoError, type: LevelOneError, code: '100.101', capture: true, reraise: false
+  register_error :LevelTwoError, type: LevelOneError, code: 'a7fc9a8c-9f83-4a2d-8808-75dbef8e376f', capture: true, reraise: false
   # You can also pass in additional options when registering your errors. These will be available on you error class 
   
   def raise_level_one_error
@@ -48,7 +48,7 @@ All arguments are optional and will be set to a placeholder if not provided
 
 ```ruby
 rails g register_error --name NewErrorName --type SomeKindOfError 
-# => register_error :NewErrorName, type: SomeKindOfError, code: '100.000'
+# => register_error :NewErrorName, type: SomeKindOfError, code: 'fa7afa83-6c68-4186-ada4-a573b6a72bd9'
 ``` 
 
 ### Or use the rake task instead. 
@@ -57,7 +57,7 @@ All arguments are optional and will be set to a placeholder if not provided
 
 ```ruby
 rake nxt_error_registry:generate_code\[ErrorName,ParentType\] 
-# => register_error :ErrorName, type: ParentType, code: '100.000'
+# => register_error :ErrorName, type: ParentType, code: '5c8152cd-b8b9-4fb0-a5fe-5c11d200affc'
 ```
 ## Development
 

data/lib/nxt_error_registry/codes_harness.rb

@@ -2,43 +2,28 @@ require 'singleton'
 
 module NxtErrorRegistry
   class CodesHarness
+    CodeAlreadyRegistered = Class.new(StandardError)
     include Singleton
 
     def generate_code
-      puts "WARNING: Codes are not in sequence: #{codes_not_in_sequence}" if codes_not_in_sequence.any?
-
-      last_id = codes_as_ids.last
-      return '100.000' unless last_id
-
-      next_id = last_id + 1
-      id_to_code(next_id)
+      generate_next_code
+    rescue CodeAlreadyRegistered
+      retry
     end
 
-    def codes_not_in_sequence
-      previous_id = nil
-
-      codes_as_ids.inject([]) do |acc, id|
-        if !previous_id || previous_id + 1 == id
-          previous_id = id
-          acc
-        else
-          acc << [previous_id, id]
-          previous_id = id
-          acc
-        end
-      end
-    end
+    def generate_next_code
+      new_code = SecureRandom.uuid
+      return new_code unless registered_codes.include?(new_code)
 
-    def codes_as_ids
-      registry.codes.map { |code| Integer(code.delete('.')) }.sort
+      raise CodeAlreadyRegistered, "#{new_code} already registered"
     end
 
-    def id_to_code(code)
-      "#{code.to_s[0..2]}.#{code.to_s[3..-1]}"
+    def registered_codes
+      registry.codes
     end
 
     def registry
       NxtErrorRegistry::Registry.instance
     end
   end
-end
+end

data/lib/nxt_error_registry/default_code_validator.rb

@@ -3,7 +3,8 @@ module NxtErrorRegistry
     CodeAlreadyTakenError = Class.new(StandardError)
     InvalidCodeFormatError = Class.new(StandardError)
 
-    FORMAT = /\A\d{3}\.\d{3}\z/
+    LEGACY_FORMAT = /\A\d{3}\.\d{3}\z/
+    FORMAT = /\A[a-zA-Z0-9-]{36}|#{LEGACY_FORMAT}\z/
 
     def initialize(name, type, code, context)
       @name = name
@@ -25,11 +26,12 @@ module NxtErrorRegistry
 
     def validate_code_format
       return if code =~ FORMAT
+
       raise InvalidCodeFormatError, "Code #{code} for name #{name} violates format #{FORMAT} in context: #{context}"
     end
 
     def validate_code_uniqueness
-      duplicates = registry.duplicate_codes
+      duplicates = registry.duplicated_codes
       return if duplicates.empty?
 
       raise CodeAlreadyTakenError, "The following codes are duplicated: #{duplicates.keys.join(',')}"
@@ -39,4 +41,4 @@ module NxtErrorRegistry
       NxtErrorRegistry::Registry.instance
     end
   end
-end
+end

data/lib/nxt_error_registry/registry.rb

@@ -32,8 +32,8 @@ module NxtErrorRegistry
       end
     end
 
-    def duplicate_codes
+    def duplicated_codes
       entries_by_codes.select { |_, v| v.size > 1 }
     end
   end
-end
+end

data/lib/nxt_error_registry/version.rb

@@ -1,3 +1,3 @@
 module NxtErrorRegistry
-  VERSION = "0.1.4".freeze
+  VERSION = "0.2.5".freeze
 end

data/lib/nxt_error_registry.rb

@@ -22,6 +22,10 @@ module NxtErrorRegistry
     end
 
     const_set(name, error_class)
+    # Calling `delegate` before `const_set` would rip off the modules from the error class.
+    # e.g. `Module1::Module2::MyError` would become `MyError`.
+    error_class.delegate :code, to: :class
+
     entry = { code: code, error_class: error_class, type: type, name: name, namespace: self.to_s, opts: opts }
     error_registry[name.to_s] = entry
 

data/nxt_error_registry.gemspec

@@ -5,11 +5,10 @@ require "nxt_error_registry/version"
 Gem::Specification.new do |spec|
   spec.name          = "nxt_error_registry"
   spec.version       = NxtErrorRegistry::VERSION
-  spec.authors       = ["Andreas Robecke", "Nils Sommer", "Raphael Kallensee"]
+  spec.authors       = ["Andreas Robecke", "Nils Sommer", "Raphael Kallensee", "Akihiko Ito"]
   spec.email         = ["a.robecke@getsafe.de"]
 
-  spec.summary       = %q{Write a short summary, because RubyGems requires one.}
-  spec.description   = %q{Write a longer description or delete this line.}
+  spec.summary       = %q{Registry to register errors with unique codes and more.}
   spec.homepage      = "https://github.com/nxt-insurance"
   spec.license       = "MIT"
 
@@ -20,6 +19,7 @@ Gem::Specification.new do |spec|
 
     spec.metadata["homepage_uri"] = spec.homepage
     spec.metadata["source_code_uri"] = "https://github.com/nxt-insurance/nxt_error_registry"
+    spec.metadata["changelog_uri"] = "https://github.com/nxt-insurance/nxt_error_registry/CHANGELOG.md"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
       "public gem pushes."
@@ -37,8 +37,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rspec_junit_formatter", "~> 0.4.1"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.5.1"
   spec.add_development_dependency "pry"
-  spec.add_dependency "activesupport", "< 6.1"
-  spec.add_dependency "rails", "< 6.1"
+  spec.add_dependency 'activesupport', '< 8.0'
+  spec.add_dependency "railties", "< 8.0"
 end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: nxt_error_registry
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Andreas Robecke
 - Nils Sommer
 - Raphael Kallensee
+- Akihiko Ito
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-02 00:00:00.000000000 Z
+date: 2022-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,14 +61,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -88,29 +89,29 @@ dependencies:
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
-description: Write a longer description or delete this line.
+        version: '8.0'
+description: 
 email:
 - a.robecke@getsafe.de
 executables: []
@@ -121,6 +122,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -144,6 +146,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/nxt-insurance
   source_code_uri: https://github.com/nxt-insurance/nxt_error_registry
+  changelog_uri: https://github.com/nxt-insurance/nxt_error_registry/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -159,8 +162,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: Write a short summary, because RubyGems requires one.
+summary: Registry to register errors with unique codes and more.
 test_files: []