nxt_registry 0.3.6 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f951682f16517cd63a1424d95c52f0db75271bebc61c7fe2cde5a72821f3381e
-  data.tar.gz: 1fd0496e6736a35e2a489c8791b9dfbf932fb5ba08c99d9213b908748b2a67e3
+  metadata.gz: 14c7e9fb583ad7e0962ad09933c359dd60d3d13e1dd701cc4d4b971ed408ed08
+  data.tar.gz: 879f214a0ce868bcf28fae668d7572ee2c680785749970b74bb2702074a02715
 SHA512:
-  metadata.gz: 30d0f4d39292e592b6622d4f670a004ba5a801730b2e21f03bad0214615076ac5bba6d40b9849f1413f22c5463336e371f79bb60f74df40d19bdcdded743b8d5
-  data.tar.gz: 29ba8e6fd7cae939e5e3ac171b5810153867c0a2c3da15f709d63ca536c3f90beff8c1e62cb5d29da7560152d55c73316b0e6921afe0b96ec7a06630163947ad
+  metadata.gz: ed961d75f5531d6cdf38ce49c72b7d06aaa836b32114b3e5df9508ea4250d099d0e559a78fae9bdd90093d312e00060d0c418994dd8ec2184557743e740ab0f9
+  data.tar.gz: 31e1e1ad67e6d59f1f95bd7b31a12f357333ea9542c51eaf5d4ff7bfabcc7542edf2a61033944f89447d13a8f23667a9a38c97cabab18d493c59e619f764353b

data/Gemfile.lock

@@ -1,25 +1,25 @@
 PATH
   remote: .
   specs:
-    nxt_registry (0.3.6)
+    nxt_registry (0.3.8)
       activesupport
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.0)
+    activesupport (6.1.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     diff-lcs (1.4.4)
-    i18n (1.8.5)
+    i18n (1.8.8)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    minitest (5.14.2)
+    minitest (5.14.3)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -28,15 +28,15 @@ GEM
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
       rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.0)
+    rspec-core (3.10.1)
       rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.0)
+    rspec-mocks (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.0)
+    rspec-support (3.10.1)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
     tzinfo (2.0.4)
@@ -56,4 +56,4 @@ DEPENDENCIES
   rspec_junit_formatter
 
 BUNDLED WITH
-   2.2.0
+   2.2.4

data/README.md

@@ -205,12 +205,21 @@ Layer.registry(:path).from(:munich).to(:amsterdam).via(:train) #  => 'train'
 
 *Note that this feature is also available for registries with a single level only.*
 
-### Restrict attributes to a certain set
+### Restrict keys to a certain set
 
-Use `attrs` to restrict which attributes can be registered on a specific level.
+Use `allowed_keys` to restrict which keys can be registered on a specific level.
 
 ```ruby
-registry :example, attrs: %w[one two three]
+registry :example, allowed_keys: %w[one two three]
+```
+
+### Require a certain set of keys to be registered
+
+Use `required_keys` to enforce a certain set of keys to be registered on a specific level. This is especially helpful
+if you use registries in multiple places and you want to ensure they all register the same set of keys. 
+
+```ruby
+registry :example, required_keys: %w[one two three]
 ```
 
 ### Default values

data/lib/nxt_registry/errors.rb

@@ -2,5 +2,7 @@ module NxtRegistry
   module Errors
     KeyAlreadyRegisteredError = Class.new(KeyError)
     KeyNotRegisteredError = Class.new(KeyError)
+    RequiredKeyMissing = Class.new(KeyError)
+    KeyNotAllowed = Class.new(KeyError)
   end
 end

data/lib/nxt_registry/registry.rb

@@ -8,11 +8,10 @@ module NxtRegistry
       @namespace = build_namespace
       @config = config
       @store = {}
-      @attrs = nil
       @configured = false
       @patterns = []
+      @config = config
 
-      setup_defaults(options)
       configure(&config)
     end
 
@@ -48,18 +47,24 @@ module NxtRegistry
       register!(name, Registry.new(name, **opts, &config))
     end
 
-    def attr(name)
-      key = transformed_key(name)
-      raise KeyError, "Attribute #{key} already registered in #{namespace}" if attrs[key]
+    def required_keys(*keys)
+      @required_keys ||= []
+      return @required_keys if keys.empty?
+
+      @required_keys += keys.map { |key| transformed_key(key) }
+    end
+
+    def allowed_keys(*keys)
+      @allowed_keys ||= []
+      return @allowed_keys if keys.empty?
 
-      attrs[key] = Attribute.new(key, self)
+      @allowed_keys += keys.map { |key| transformed_key(key) }
     end
 
-    def attrs(*args)
-      @attrs ||= {}
-      return @attrs unless args.any?
+    alias attrs allowed_keys # @deprecated
 
-      args.each { |name| attr(name) }
+    def attr(key)
+      allowed_keys(key) # @deprecated
     end
 
     def register(key = Blank.new, value = Blank.new, **options, &block)
@@ -134,9 +139,11 @@ module NxtRegistry
     delegate :size, :values, :each, :freeze, to: :store
 
     def configure(&block)
+      setup_defaults(options)
       define_accessors
       define_interface
-      attrs(*Array(options.fetch(:attrs, [])))
+      allowed_keys(*Array(options.fetch(:allowed_keys, [])))
+      required_keys(*Array(options.fetch(:required_keys, [])))
 
       if block.present?
         if block.arity == 1
@@ -146,6 +153,7 @@ module NxtRegistry
         end
       end
 
+      validate_required_keys_given
       self.configured = true
     end
 
@@ -153,7 +161,7 @@ module NxtRegistry
       "Registry[#{name}] -> #{store.to_s}"
     end
 
-    alias_method :inspect, :to_s
+    alias inspect to_s
 
     private
 
@@ -165,6 +173,14 @@ module NxtRegistry
       base.merge(opts).merge(parent: self)
     end
 
+    def validate_required_keys_given
+      required_keys.each do |key|
+        next if store.key?(key)
+
+        raise Errors::RequiredKeyMissing, "Required key '#{key}' missing in #{self}"
+      end
+    end
+
     def is_leaf?
       @is_leaf
     end
@@ -178,7 +194,7 @@ module NxtRegistry
       end
 
       raise ArgumentError, "Not allowed to register values in a registry that contains nested registries" unless is_leaf
-      raise KeyError, "Keys are restricted to #{attrs.keys}" if attribute_not_allowed?(key)
+      raise KeyError, "Keys are restricted to #{allowed_keys}" if key_not_allowed?(key)
 
       on_key_already_registered && on_key_already_registered.call(key) if store[key] && raise_on_key_already_registered
 
@@ -303,10 +319,10 @@ module NxtRegistry
       end
     end
 
-    def attribute_not_allowed?(key)
-      return if attrs.empty?
+    def key_not_allowed?(key)
+      return if allowed_keys.empty?
 
-      attrs.keys.exclude?(transformed_key(key))
+      allowed_keys.exclude?(transformed_key(key))
     end
 
     def resolve_default(key)
@@ -336,13 +352,6 @@ module NxtRegistry
       end
     end
 
-    def initialize_copy(original)
-      super
-      @store = original.send(:store).deep_dup
-      @options = original.send(:options).deep_dup
-      @patterns = original.send(:patterns).dup
-    end
-
     def build_namespace
       parent ? name.to_s.prepend("#{parent.send(:namespace)}.") : name.to_s
     end
@@ -358,5 +367,15 @@ module NxtRegistry
     def raise_invalid_accessor_name(name)
       raise ArgumentError, "#{self} already implements a method named: #{name}. Please choose a different accessor name"
     end
+
+    def initialize_copy(original)
+      super
+
+      containers = %i[store options]
+      variables = %i[patterns required_keys allowed_keys namespace on_key_already_registered on_key_not_registered]
+
+      containers.each { |c| instance_variable_set("@#{c}", original.send(c).deep_dup) }
+      variables.each { |v| instance_variable_set("@#{v}", original.send(v).dup) }
+    end
   end
 end

data/lib/nxt_registry/version.rb

@@ -1,3 +1,3 @@
 module NxtRegistry
-  VERSION = "0.3.6"
+  VERSION = '0.3.8'
 end

data/lib/nxt_registry.rb

@@ -2,7 +2,6 @@ require 'active_support'
 require 'active_support/core_ext'
 require 'nxt_registry/version'
 require 'nxt_registry/blank'
-require 'nxt_registry/attribute'
 require 'nxt_registry/errors'
 require 'nxt_registry/registry_builder'
 require 'nxt_registry/registry'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nxt_registry
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.8
 platform: ruby
 authors:
 - Andreas Robecke
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-23 00:00:00.000000000 Z
+date: 2021-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -106,7 +106,6 @@ files:
 - bin/console
 - bin/setup
 - lib/nxt_registry.rb
-- lib/nxt_registry/attribute.rb
 - lib/nxt_registry/blank.rb
 - lib/nxt_registry/errors.rb
 - lib/nxt_registry/recursive_registry.rb

data/lib/nxt_registry/attribute.rb

@@ -1,17 +0,0 @@
-module NxtRegistry
-  class Attribute
-    def initialize(name, registry, **options)
-      @name = name
-      @registry = registry
-      @namespace = [name, registry.send(:namespace)].join('.')
-    end
-
-    def eql?(other)
-      { name => registry.object_id } == { other.send(:name) => other.send(:registry).object_id }
-    end
-
-    private
-
-    attr_reader :name, :registry
-  end
-end