nxt_registry 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7580358cb0ea45fffde45350fe3162957158c25a41cabd7a3faeba4e3901515
-  data.tar.gz: 0dd9ff5a3904ca34ab631d405a29fcd0cf6bed1d62f37fff01f425e6e44b5c45
+  metadata.gz: 3643055d95f31f6addec18700fd8d7d9157bc4f97848acef8340c11668cfa3df
+  data.tar.gz: 25018d4d1f657991137e0c94bf8afacaca70dcd44008ff6cb96783ea82aa064d
 SHA512:
-  metadata.gz: a3aa0bec05c05bc39f6db505ef90b29eadd33e750138a00fb21ac21464683de08034ee528343ea3dd775d230d6a7db3b71ea21c21d1e60286aa72c06ac420167
-  data.tar.gz: fe9f8f96fd76c5810638d33a73b4f0052d1b1e5e533d5bb506120a8abe442c466b16ba766d7788c3d2887f4f6fbe9b34a97cbec27a40b96c1f06bdb6f4c0d5bb
+  metadata.gz: 74aefe510917560c5dbc3686834ce64aeb815e8f67d99718f6abf38dd08d639f9a8bba14f3cd2275f7f790b3b853b0207006888ee9303ed4d4b706e99d6e1d8b
+  data.tar.gz: 2225edb2af2a5493b90642934d415115a8577043f69fa329bfe99c0676997d4ad68c023c1c79fc1552519a2ed50a5478ebe440ad936ee5832956a27ebad1caec

data/.circleci/config.yml

@@ -0,0 +1,56 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/ruby:2.6.5-node
+    environment:
+      BUNDLER_VERSION: 2.1.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "Gemfile.lock" }}
+            
+      - run: gem install bundler --version $BUNDLER_VERSION
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | \
+              circleci tests split --split-by=timings)"
+
+            bundle exec rspec \
+              --format progress \
+              --format RspecJunitFormatter \
+              --out /tmp/test-results/rspec.xml \
+              --format progress \
+              $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.editorconfig

@@ -0,0 +1,15 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+
+[*.{rb,yml,json,rake}]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# v0.2.0 2020-07-24
+
+### Added
+
+- [internal] Added NxtRegistry::Singleton
+- Added NxtRegistry::Singleton interface
+- Make name optional and have object_id.to_s as default name 
+- Fix readme
+
+[Compare v0.1.5...v0.2.0](https://github.com/nxt-insurance/nxt_registry/compare/v0.1.5...v0.2.0)

data/Gemfile

@@ -2,3 +2,7 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in nxt_registry.gemspec
 gemspec
+
+group :test do
+  gem 'rspec_junit_formatter' # for CircleCI
+end

data/Gemfile.lock

@@ -1,46 +1,48 @@
 PATH
   remote: .
   specs:
-    nxt_registry (0.1.5)
+    nxt_registry (0.2.0)
       activesupport
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.2.1)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
-    coderay (1.1.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    coderay (1.1.3)
     concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
-    i18n (1.8.2)
+    diff-lcs (1.4.4)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    method_source (0.9.2)
-    minitest (5.14.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
+    method_source (1.0.0)
+    minitest (5.14.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rake (12.3.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
+    rspec-support (3.9.3)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
     thread_safe (0.3.6)
-    tzinfo (1.2.6)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    zeitwerk (2.2.2)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
@@ -51,6 +53,7 @@ DEPENDENCIES
   pry
   rake (~> 12)
   rspec (~> 3.0)
+  rspec_junit_formatter
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,3 +1,5 @@
+[![CircleCI](https://circleci.com/gh/nxt-insurance/nxt_registry.svg?style=svg)](https://circleci.com/gh/nxt-insurance/nxt_registry)
+
 # NxtRegistry
 
 NxtRegistry is a simple implementation of the container pattern. It allows you to register and resolve values in nested 
@@ -21,6 +23,8 @@ Or install it yourself as:
 
 ## Usage
 
+### Instance Level
+
 ```ruby
 class Example
   include NxtRegistry
@@ -73,6 +77,43 @@ example.passengers.from(:a).to(:b).via(:plane) # => ['Nils', 'Rapha']
 
 ```
 
+Alternatively you can create an instance of NxtRegistry::Registry.new('name', **options, &config)
+
+```ruby
+registry = NxtRegistry::Registry.new do
+  register(:andy, 'Andy')
+  register(:anthony, 'Anthony')
+  register(:aki, 'Aki')
+end
+
+registry.resolve(:aki) # => 'Aki'
+
+```
+
+### Class Level
+
+```ruby
+class SimpleExample
+  # By extending NxtRegistry::Singleton you get a super simple class level interface to an underlying instance of a :registry
+  extend NxtRegistry::Singleton
+  
+  registry do
+    # procs are called directly if not defined otherwise 
+    register(KeyError, ->(error) { puts 'KeyError handler' } )
+    register(ArgumentError, ->(error) { puts 'ArgumentError handler' } )
+    # Custom key error handlers
+    on_key_already_registered ->(key) { raise "Key was already registered dude: #{key}" }
+    on_key_not_registered ->(key) { raise "Key was never registered dude: #{key}" }
+  end
+end
+  
+SimpleExample.resolve(KeyError)
+# Alternatively: SimpleExample.registry.resolve(KeyError) 
+# Or: SimpleExample.instance.resolve(KeyError) 
+# KeyError handler
+# => nil
+
+```
 
 ```ruby
 class OtherExample
@@ -113,7 +154,7 @@ registry :example, default: ->(value) { 'default' }
 
 ### Blocks
 
-When you register a block value that can be called, tt will automatically be called when you resolve the value. 
+When you register a block value that can be called, it 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`
 
 ```ruby
@@ -124,7 +165,7 @@ end
 
 ### Memoize
 
-Values are memoized per default. Switch it off with `default false`
+Values are memoized per default. Switch it off with `memoize: false`
 
 ```ruby
 registry :example, memoize: false do
@@ -141,7 +182,8 @@ registry.resolve(:one)
 
 ### Resolver
 
-You can register a resolver block if you want to lay hands on your values after they have been resolved.
+You can register a resolver block if you want to lay hands on your values after they have been resolved. 
+A resolver can be anything that implements `:call` to which the value is passed.  
 
 ```ruby
 registry :example do
@@ -172,7 +214,7 @@ registry.resolve('BOMBSHELL')
 ### Customize registry errors
 
 You can also customize what kind of errors are being raised in case a of a key was not registered or was already registered.
-by providing values for `raise_key_already_registered_error` and `raise_key_not_registered_error`
+by providing blocks or a handler responding to :call for `on_key_already_registered` and `on_key_already_registered`
 
 ## Development
 

data/lib/nxt_registry.rb

@@ -6,6 +6,7 @@ require "nxt_registry/errors"
 require "nxt_registry/nested_registry_builder"
 require "nxt_registry/registry"
 require "nxt_registry/recursive_registry"
+require "nxt_registry/singleton"
 
 module NxtRegistry
   def registry(name, **options, &config)

data/lib/nxt_registry/registry.rb

@@ -1,6 +1,6 @@
 module NxtRegistry
   class Registry
-    def initialize(name, **options, &config)
+    def initialize(name = object_id.to_s, **options, &config)
       @name = name
       @parent = options[:parent]
       @is_leaf = true
@@ -133,7 +133,6 @@ module NxtRegistry
 
       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
 
       store[key] = value

data/lib/nxt_registry/singleton.rb

@@ -0,0 +1,17 @@
+module NxtRegistry
+  module Singleton
+    def self.extended(subclass)
+      subclass.singleton_class.class_eval do
+        default_name = (subclass.name || 'registry')
+
+        define_method :registry do |name = default_name, **options, &block|
+          @registry ||= NxtRegistry::Registry.new(name, **options, &block)
+        end
+
+        delegate_missing_to :registry
+
+        define_method(:instance) { registry }
+      end
+    end
+  end
+end

data/lib/nxt_registry/version.rb

@@ -1,3 +1,3 @@
 module NxtRegistry
-  VERSION = "0.1.5"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nxt_registry
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Andreas Robecke
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-02 00:00:00.000000000 Z
+date: 2020-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -90,10 +90,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
+- ".editorconfig"
 - ".gitignore"
 - ".rakeTasks"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -108,6 +111,7 @@ files:
 - lib/nxt_registry/nested_registry_builder.rb
 - lib/nxt_registry/recursive_registry.rb
 - lib/nxt_registry/registry.rb
+- lib/nxt_registry/singleton.rb
 - lib/nxt_registry/version.rb
 - nxt_registry.gemspec
 homepage: https://github.com/nxt-insurance