nxt_registry 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 375f69d800025475bc7dcec1ce58539c4c9f6cd71f672a38f8fdd7fe8bfb7448
-  data.tar.gz: 8fbaab558bc84ae47d9ecec4b2533b9432d336a0d8b1a7ce54d27262da2dac91
+  metadata.gz: 4e448ba3858d3bcce91d1b3974e4d2c1e499b16bae7877af8f49a6b61c0a720d
+  data.tar.gz: 25d4f5043520610b28d6b500fb7991eaba19be54496a9b5646f87a60468b8d01
 SHA512:
-  metadata.gz: 74407964a5919ffc06cede9a498110cddffcf5c7821471be6d7352ec6b0267c84972c1369c23e6d1560e113cf3487bc4e100b87ea79e46fedd9d0a9a71e15a8f
-  data.tar.gz: 680c9259e6a733dd580109413274d28a5a1961b7819a60ba20c7b4f84ba60dda899604f71bac74f4aa81ed9e7d0690a898b15884ab890477b9460dc9bd5f0ef4
+  metadata.gz: 367941027e67c9b6c316769cfa31d633e3e84fd590954801ebb8860de66479609334f4421a53d5e7342106d38627cee37aa25f82c87cdf518979b3b091735394
+  data.tar.gz: 0bca415d8164a8bd2d567b2c4aefb8082842fbcf050c19ee7c72fa822b7ab9022877e02d82ce3ca597c1fc8f8461c5a131a454e899c2acd17634b84129f5f902

data/Gemfile.lock

@@ -1,14 +1,25 @@
 PATH
   remote: .
   specs:
-    nxt_registry (0.1.0)
+    nxt_registry (0.1.1)
+      activesupport
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
     coderay (1.1.2)
+    concurrent-ruby (1.1.5)
     diff-lcs (1.3)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
     method_source (0.9.2)
+    minitest (5.13.0)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -26,6 +37,10 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    zeitwerk (2.2.2)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,8 +1,7 @@
 # NxtRegistry
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/nxt_registry`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+NxtRegistry is a simple implementation of the container pattern. It allows you to register and resolve values.
+It allows to register and resolve values in nested structures by allowing to nest registries into each other.
 
 ## Installation
 
@@ -22,6 +21,34 @@ Or install it yourself as:
 
 ## Usage
 
+## Restrict attributes to a certain set
+
+Use `attrs` to restrict which attributes can be registered on a specific level.
+
+## Default values
+
+Use `default` to register a default value that will be resolved in case an attribute was not registered.
+
+## Block
+
+When you register a block value that can be called, tt will automatically be called when you resolve the value. 
+If that's not what you want, you can configure your registry (on each level) not to call blocks directly by defining `call false`
+
+## Memoize
+
+Values are memoized per default. Switch it off with `default false`
+
+## Resolver
+
+You can register a resolver block if you want to lay hands on your values after they have been resolved.
+
+## Transform keys
+
+NxtRegistry uses a plain ruby hash to store values internally. Per default all keys used are transformed with `&:to_s`.
+Thus you can use symbols or strings to register and resolve values. If it's not what you want, switch it off with `transform_keys false`
+or define your own key transformer by assigning a block `transform_keys ->(key) { key.upcase }`   
+ 
+
 ```ruby
 class MyClass
   include NxtRegistry
@@ -35,6 +62,8 @@ class MyClass
             default -> { [] }
             memoize true 
             call true
+            resolver ->(value) { value } # do something with your registered value here
+            transform_keys ->(key) { key.upcase } # transform keys 
           end
         end
       end
@@ -51,6 +80,20 @@ subject.passengers.from(:a).to(:b).via(:plane) << 'Rapha'
 subject.passengers.from(:a).to(:b).via(:plane) # => ['Nils', 'Rapha']
 
 subject.passengers.from(:a).to(:b).via(:hyperloop) # => KeyError
+
+
+class MyClass
+  extend NxtRegistry
+
+  REGISTRY = registry(:errors) do 
+    register(KeyError, ->(error) { puts 'KeyError handler' } )
+  end
+end
+
+MyClass::REGISTRY.resolve(KeyError)
+# KeyError handler
+# => nil
+
 ```
 
 ## Development

data/lib/nxt_registry.rb

@@ -1,4 +1,4 @@
-require 'active_support/all'
+require 'active_support/core_ext'
 require "nxt_registry/version"
 require "nxt_registry/blank"
 require "nxt_registry/attribute"

data/lib/nxt_registry/registry.rb

@@ -153,17 +153,17 @@ module NxtRegistry
         store[key] ||= default.call
       end
 
-      resolver.call(value)
-    end
+      value = if value.respond_to?(:call) && call && !value.is_a?(NxtRegistry::Registry)
+        value.call(*[value].take(value.arity))
+      else
+        value
+      end
 
-    def setup_defaults(options)
-      @default = options.fetch(:default) { Blank.new }
-      @memoize = options.fetch(:memoize) { true }
-      @call = options.fetch(:call) { true }
-      @resolver = options.fetch(:resolver) { ->(value) { value } }
-      @transform_keys = options.fetch(:transform_keys) { ->(key) { key.to_s } }
-      @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) } }
+      if resolver
+        resolver.call(value)
+      else
+        value
+      end
     end
 
     def define_interface
@@ -192,6 +192,16 @@ module NxtRegistry
       end
     end
 
+    def setup_defaults(options)
+      @default = options.fetch(:default) { Blank.new }
+      @memoize = options.fetch(:memoize) { true }
+      @call = options.fetch(:call) { true }
+      @resolver = options.fetch(:resolver, false)
+      @transform_keys = options.fetch(:transform_keys) { ->(key) { key.to_s } }
+      @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) } }
+    end
+
     def define_accessors
       %w[default memoize call resolver transform_keys on_key_already_registered on_key_not_registered].each do |attribute|
         define_singleton_method attribute do |value = Blank.new, &block|

data/lib/nxt_registry/version.rb

@@ -1,3 +1,3 @@
 module NxtRegistry
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/nxt_registry.gemspec

@@ -32,6 +32,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "activesupport"
+
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nxt_registry
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andreas Robecke
@@ -13,6 +13,20 @@ bindir: exe
 cert_chain: []
 date: 2020-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement