nxt_registry 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84faa74573904a66ff0f574195ef5ab7e74508d097f04d1e7f43afcfe4867432
-  data.tar.gz: 8f5c04f6eef2f3b7328567d2b1e49fe9e862d915b572e18fdefd32cb71c24fc2
+  metadata.gz: 121af631fa49f89d2b47599adcf3122401409299f65d755f7ba3cb418734cdf4
+  data.tar.gz: e6d94a93edf4bb250186242e5892f0dcda7df9c71c23be5a4b8ddca5420eed0d
 SHA512:
-  metadata.gz: 293d5d1d418152c704ea04aaff4dd392b901c40a9460f1858e5cf6581a0c6fe58041bbe163b8aff3fbcdd9848638f7715e87046b14666f5111677c5241d67eea
-  data.tar.gz: 0475b0d48a589d90ff548d2c7f414bab38e5360fb46cafee35a29e83203a72fcd8fbce4870fbd7862b182ac38558f48567417808c5d400f4a728ff7dbf353a53
+  metadata.gz: b0601a25a8325fe3fb21f2cfdf25e8710c3b219c135999fea2bc0bc325713bf3f20f321f4aadbdffcc50f4d03557c0fc4ba1008d52efe69e3f38400e4dfdf0b9
+  data.tar.gz: 770c75ffca22aa1c7de4af1de955abf2044d9dca121b566e277f5d0fd637e41bc58231ae1edfd38a11af69279c05928f001e98561edae77edd060499bcf9bdf4

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.3.1 2020-09-23
+
+- Allow to define custom accessors for registries
+
 # v0.3.0 2020-09-10
 
 ### Breaking Changes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nxt_registry (0.3.0)
+    nxt_registry (0.3.1)
       activesupport
 
 GEM

data/README.md

@@ -59,7 +59,7 @@ registry.resolve(:aki) # => 'Aki'
 
 ## Class Level
 
-You can register registries on the class level simply by extending your class with `NxtRegistry`
+You can add registries on the class level simply by extending your class with `NxtRegistry`
 
 ```ruby
 class OtherExample
@@ -130,17 +130,41 @@ class Layer
   end
 end
 
+# On every upper level every resolve returns a registry 
 Layer.registry(:from) # => Registry[from]
-
 Layer.registry(:from).resolve(:munich) # => Registry[to] -> {}
 Layer.registry(:from).resolve(:amsterdam) # => Registry[to] -> {}
 Layer.registry(:from).resolve(:any_key) # => Registry[to] -> {}
-
 Layer.registry(:from).resolve(:munich, :amsterdam) # => Registry[via] -> {}
+
+# Register a value on the bottom level
 Layer.registry(:from).resolve(:munich, :amsterdam).register(:train, -> { 'train' })
+# Resolve the complete path 
 Layer.registry(:from).resolve(:munich, :amsterdam, :train) #  => 'train'
 ``` 
 
+For registries with multiple levels the normal syntax for registering and resolving becomes quite weird and unreadable. This is why
+every registry can be accessed through it's name or a custom accessor. The above example then can be simplified as follows.
+
+```ruby
+class Layer
+  extend NxtRegistry
+  
+  registry :path, accessor: :from do # registry named path, can be accessed with .from(...)
+    level :to do
+      level :via
+    end  
+  end
+end
+
+# Register a value
+Layer.registry(:path).from(:munich).to(:amsterdam).via(:train, -> { 'train' })
+# Resolve the complete path
+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
 
 Use `attrs` to restrict which attributes can be registered on a specific level.

data/lib/nxt_registry.rb

@@ -1,31 +1,42 @@
 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"
-require "nxt_registry/recursive_registry"
+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'
+require 'nxt_registry/recursive_registry'
 
 module NxtRegistry
   def registry(name, **options, &config)
-    return registries.fetch(name) if registries.key?(name)
-
-    registry = Registry.new(name, **options, &config)
-    registries[name] ||= registry
-    registry
+    build_registry(Registry, name, **options, &config)
   end
 
   def recursive_registry(name, **options, &config)
-    return registries.fetch(name) if registries.key?(name)
-
-    registry = RecursiveRegistry.new(name, **options, &config)
-    registries[name] ||= registry
-    registry
+    build_registry(RecursiveRegistry, name, **options, &config)
   end
 
   private
 
+  def build_registry(registry_class, name, **options, &config)
+    if registries.key?(name)
+      registry = registries.fetch(name)
+      if registry.configured
+        registry
+      else
+        raise_unconfigured_registry_accessed(name)
+      end
+    else
+      registry = registry_class.new(name, **options, &config)
+      registries[name] ||= registry
+      registry
+    end
+  end
+
+  def raise_unconfigured_registry_accessed(name)
+    raise ArgumentError, "The registry #{name} must be configured before accessed!"
+  end
+
   def registries
     @registries ||= {}
   end

data/lib/nxt_registry/registry.rb

@@ -1,25 +1,27 @@
 module NxtRegistry
   class Registry
     def initialize(name = object_id.to_s, **options, &config)
+      @options = options
       @name = name
       @parent = options[:parent]
       @is_leaf = true
       @namespace = build_namespace
       @config = config
-      @options = options
       @store = {}
       @attrs = nil
+      @configured = false
 
       setup_defaults(options)
-      configure(&config)
+      configure(&config) if block_given? || parent
     end
 
     attr_reader :name
+    attr_accessor :configured
 
     def level(name, **options, &config)
       options = options.merge(parent: self)
 
-      if default.is_a?(Blank)
+      if is_a_blank?(default)
         self.is_leaf = false
 
         self.default = RegistryBuilder.new do
@@ -36,13 +38,13 @@ module NxtRegistry
     end
 
     def registry(name, **options, &config)
-      options = options.merge(parent: self)
-      register(name, Registry.new(name, **options, &config))
+      opts = options.merge(parent: self)
+      register(name, Registry.new(name, **opts, &config))
     end
 
     def registry!(name, **options, &config)
-      options = options.merge(parent: self)
-      register!(name, Registry.new(name, **options, &config))
+      opts = options.merge(parent: self)
+      register!(name, Registry.new(name, **opts, &config))
     end
 
     def attr(name)
@@ -61,37 +63,37 @@ module NxtRegistry
 
     def register(key = Blank.new, value = Blank.new, **options, &block)
       if block_given?
-        if value.is_a?(Blank)
+        if is_a_blank?(value)
           registry(key, **options, &block)
         else
           raise_register_argument_error
         end
       else
-        __register(key, value, raise: true)
+        __register(key, value, raise_on_key_already_registered: true)
       end
     end
 
     def register!(key = Blank.new, value = Blank.new, **options, &block)
       if block_given?
-        if value.is_a?(Blank)
+        if is_a_blank?(value)
           registry!(key, **options, &block)
         else
           raise_register_argument_error
         end
       else
-        __register(key, value, raise: false)
+        __register(key, value, raise_on_key_already_registered: false)
       end
     end
 
     def resolve!(*keys)
       keys.inject(self) do |current_registry, key|
-        current_registry.send(:__resolve, key, raise: true)
+        current_registry.send(:__resolve, key, raise_on_key_not_registered: true)
       end
     end
 
     def resolve(*keys)
       keys.inject(self) do |current_registry, key|
-        current_registry.send(:__resolve, key, raise: false) || break
+        current_registry.send(:__resolve, key, raise_on_key_not_registered: false) || break
       end
     end
 
@@ -141,6 +143,8 @@ module NxtRegistry
           instance_exec(&block)
         end
       end
+
+      self.configured = true
     end
 
     def to_s
@@ -151,33 +155,33 @@ module NxtRegistry
 
     private
 
-    attr_reader :namespace, :parent, :config, :store, :options
+    attr_reader :namespace, :parent, :config, :store, :options, :accessor
     attr_accessor :is_leaf
 
     def is_leaf?
       @is_leaf
     end
 
-    def __register(key, value, raise: true)
+    def __register(key, value, raise_on_key_already_registered: true)
       key = transformed_key(key)
 
       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)
 
-      on_key_already_registered && on_key_already_registered.call(key) if store[key] && raise
+      on_key_already_registered && on_key_already_registered.call(key) if store[key] && raise_on_key_already_registered
 
       store[key] = value
     end
 
-    def __resolve(key, raise: true)
+    def __resolve(key, raise_on_key_not_registered: true)
       key = transformed_key(key)
 
       value = if is_leaf?
         if store.key?(key)
           store.fetch(key)
         else
-          if default.is_a?(Blank)
-            return unless raise
+          if is_a_blank?(default)
+            return unless raise_on_key_not_registered
 
             on_key_not_registered && on_key_not_registered.call(key)
           else
@@ -205,24 +209,28 @@ module NxtRegistry
     end
 
     def define_interface
-      define_singleton_method name do |key = Blank.new, value = Blank.new|
-        return self if key.is_a?(Blank)
+      raise_invalid_accessor_name(accessor) if respond_to?(accessor)
+      accessor_with_bang = "#{accessor}!"
+      raise_invalid_accessor_name(accessor_with_bang) if respond_to?(accessor_with_bang)
+
+      define_singleton_method accessor do |key = Blank.new, value = Blank.new|
+        return self if is_a_blank?(key)
 
         key = transformed_key(key)
 
-        if value.is_a?(Blank)
+        if is_a_blank?(value)
           resolve(key)
         else
           register(key, value)
         end
       end
 
-      define_singleton_method "#{name}!" do |key = Blank.new, value = Blank.new|
-        return self if key.is_a?(Blank)
+      define_singleton_method accessor_with_bang do |key = Blank.new, value = Blank.new|
+        return self if is_a_blank?(key)
 
         key = transformed_key(key)
 
-        if value.is_a?(Blank)
+        if is_a_blank?(value)
           resolve!(key)
         else
           register!(key, value)
@@ -236,6 +244,7 @@ module NxtRegistry
       @call = options.fetch(:call) { true }
       @resolver = options.fetch(:resolver, false)
       @transform_keys = options.fetch(:transform_keys) { ->(key) { key.to_s } }
+      @accessor = options.fetch(:accessor) { name }
 
       @on_key_already_registered = options.fetch(:on_key_already_registered) { ->(key) { raise_key_already_registered_error(key) } }
       @on_key_not_registered = options.fetch(:on_key_not_registered) { ->(key) { raise_key_not_registered_error(key) } }
@@ -246,7 +255,7 @@ module NxtRegistry
         define_singleton_method attribute do |value = Blank.new, &block|
           value = block if block
 
-          if value.is_a?(Blank)
+          if is_a_blank?(value)
             instance_variable_get("@#{attribute}")
           else
             instance_variable_set("@#{attribute}", value)
@@ -284,7 +293,7 @@ module NxtRegistry
     def transformed_key(key)
       @transformed_key ||= {}
       @transformed_key[key] ||= begin
-        if transform_keys && !key.is_a?(Blank)
+        if transform_keys && !is_a_blank?(key)
           transform_keys.call(key)
         else
           key
@@ -305,5 +314,13 @@ module NxtRegistry
     def raise_register_argument_error
       raise ArgumentError, 'Either provide a key value pair or a block to register'
     end
+
+    def is_a_blank?(value)
+      value.is_a?(Blank)
+    end
+
+    def raise_invalid_accessor_name(name)
+      raise ArgumentError, "#{self} already implements a method named: #{name}. Please choose a different accessor name"
+    end
   end
 end

data/lib/nxt_registry/version.rb

@@ -1,3 +1,3 @@
 module NxtRegistry
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/nxt_registry.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.name          = "nxt_registry"
   spec.version       = NxtRegistry::VERSION
   spec.authors       = ["Andreas Robecke", "Nils Sommer", "Raphael Kallensee", "Lütfi Demirci"]
-  spec.email         = ["a.robecke@getsafe.de"]
+  spec.email         = ['a.robecke@hellogetsafe.com', 'andreas@robecke.de']
 
   spec.summary       = %q{nxt_registry is a simple implementation of the container pattern}
   spec.homepage      = "https://github.com/nxt-insurance"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nxt_registry
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Andreas Robecke
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2020-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -85,7 +85,8 @@ dependencies:
         version: '0'
 description: 
 email:
-- a.robecke@getsafe.de
+- a.robecke@hellogetsafe.com
+- andreas@robecke.de
 executables: []
 extensions: []
 extra_rdoc_files: []