nxt_registry 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 375f69d800025475bc7dcec1ce58539c4c9f6cd71f672a38f8fdd7fe8bfb7448
+  data.tar.gz: 8fbaab558bc84ae47d9ecec4b2533b9432d336a0d8b1a7ce54d27262da2dac91
+SHA512:
+  metadata.gz: 74407964a5919ffc06cede9a498110cddffcf5c7821471be6d7352ec6b0267c84972c1369c23e6d1560e113cf3487bc4e100b87ea79e46fedd9d0a9a71e15a8f
+  data.tar.gz: 680c9259e6a733dd580109413274d28a5a1961b7819a60ba20c7b4f84ba60dda899604f71bac74f4aa81ed9e7d0690a898b15884ab890477b9460dc9bd5f0ef4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build nxt_registry-0.1.0.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Remove any temporary products" fullCmd="clean" taksId="clean" /><RakeTask description="Remove any generated files" fullCmd="clobber" taksId="clobber" /><RakeTask description="Build and install nxt_registry-0.1.0.gem into system gems" fullCmd="install" taksId="install" /><RakeGroup description="" fullCmd="" taksId="install"><RakeTask description="Build and install nxt_registry-0.1.0.gem into system gems without network access" fullCmd="install:local" taksId="local" /></RakeGroup><RakeTask description="Create tag v0.1.0 and build and push nxt_registry-0.1.0.gem to TODO: Set to 'http://mygemserver.com'" fullCmd="release[remote]" taksId="release[remote]" /><RakeTask description="Run RSpec code examples" fullCmd="spec" taksId="spec" /><RakeTask description="" fullCmd="default" taksId="default" /><RakeTask description="" fullCmd="release" taksId="release" /><RakeGroup description="" fullCmd="" taksId="release"><RakeTask description="" fullCmd="release:guard_clean" taksId="guard_clean" /><RakeTask description="" fullCmd="release:rubygem_push" taksId="rubygem_push" /><RakeTask description="" fullCmd="release:source_control_push" taksId="source_control_push" /></RakeGroup></RakeGroup></Settings>

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in nxt_registry.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    nxt_registry (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  nxt_registry!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Andreas Robecke
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nxt_registry'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nxt_registry
+
+## Usage
+
+```ruby
+class MyClass
+  include NxtRegistry
+  
+  def passengers
+    @passengers ||= begin
+      registry :from do
+        nested :to do
+          nested :via do
+            attrs :train, :car, :plane, :horse
+            default -> { [] }
+            memoize true 
+            call true
+          end
+        end
+      end
+    end
+  end
+end
+
+subject = MyClass.new
+subject.passengers.from(:a).to(:b).via(:train) # => []
+subject.passengers.from(:a).to(:b).via(:train) << 'Andy'
+subject.passengers.from(:a).to(:b).via(:car) << 'Lütfi'
+subject.passengers.from(:a).to(:b).via(:plane) << 'Nils'
+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
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nxt_registry.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nxt_registry"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nxt_registry/attribute.rb

@@ -0,0 +1,17 @@
+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

data/lib/nxt_registry/blank.rb

@@ -0,0 +1,4 @@
+module NxtRegistry
+  class Blank
+  end
+end

data/lib/nxt_registry/errors.rb

@@ -0,0 +1,6 @@
+module NxtRegistry
+  module Errors
+    KeyAlreadyRegisteredError = Class.new(KeyError)
+    KeyNotRegisteredError = Class.new(KeyError)
+  end
+end

data/lib/nxt_registry/nested_registry_builder.rb

@@ -0,0 +1,7 @@
+module NxtRegistry
+  class NestedRegistryBuilder < Proc
+    def initialize(&block)
+      super(&block)
+    end
+  end
+end

data/lib/nxt_registry/recursive_registry.rb

@@ -0,0 +1,26 @@
+module NxtRegistry
+  class RecursiveRegistry < Registry
+    def initialize(name, **options, &config)
+      @level = options.fetch(:level) { 0 }
+
+      @name = name
+      @options = options
+      @config = config
+
+      super(name, **options, &config)
+      set_nested_builder_as_default
+    end
+
+    attr_reader :name
+
+    private
+
+    attr_reader :options, :config, :level
+
+    def set_nested_builder_as_default
+      self.default = NestedRegistryBuilder.new do
+        RecursiveRegistry.new("level_#{(level + 1)}", **options.merge(level: (level + 1)), &config)
+      end
+    end
+  end
+end

data/lib/nxt_registry/registry.rb

@@ -0,0 +1,247 @@
+module NxtRegistry
+  class Registry
+    def initialize(name, **options, &config)
+      @name = name
+      @parent = options[:parent]
+      @is_leaf = true
+      @namespace = [parent, self].compact.map(&:name).join('.')
+      @config = config
+      @store = {}
+      @attrs = nil
+
+      setup_defaults(options)
+      configure(&config)
+    end
+
+    attr_reader :name
+
+    def nested(name, **options, &config)
+      options = options.merge(parent: self)
+
+      if default.is_a?(Blank)
+        self.is_leaf = false
+
+        self.default = NestedRegistryBuilder.new do
+          Registry.new(name, **options, &config)
+        end
+
+        default.call
+      elsif default.is_a?(NestedRegistryBuilder)
+        raise ArgumentError, "Multiple nestings on the same level"
+      else
+        raise ArgumentError, "Default values cannot be defined on registries that nest others"
+      end
+    end
+
+    def attr(name)
+      key = transformed_key(name)
+      raise KeyError, "Attribute #{key} already registered in #{namespace}" if attrs[key]
+
+      attrs[key] = Attribute.new(key, self)
+    end
+
+    def attrs(*args)
+      @attrs ||= {}
+      return @attrs unless args.any?
+
+      args.each { |name| attr(name) }
+    end
+
+    def register(key, value)
+      __register(key, value, raise: true)
+    end
+
+    def register!(key, value)
+      __register(key, value, raise: false)
+    end
+
+    def resolve(key)
+      __resolve(key, raise: true)
+    end
+
+    def resolve!(key)
+      __resolve(key, raise: false)
+    end
+
+    def to_h
+      store
+    end
+
+    def [](key)
+      store[transformed_key(key)]
+    end
+
+    def []=(key, value)
+      store[transformed_key(key)] = value
+    end
+
+    def keys
+      store.keys.map(&method(:transformed_key))
+    end
+
+    def key?(key)
+      store.key?(transformed_key(key))
+    end
+
+    def include?(key)
+      store.include?(transformed_key(key))
+    end
+
+    def exclude?(key)
+      store.exclude?(transformed_key(key))
+    end
+
+    def fetch(key, **opts, &block)
+      store.fetch(transformed_key(key), **opts, &block)
+    end
+
+    delegate :size, :values, :each, to: :store
+
+    def configure(&block)
+      define_accessors
+      define_interface
+
+      if block.present?
+        if block.arity == 1
+          instance_exec(self, &block)
+        else
+          instance_exec(&block)
+        end
+      end
+    end
+
+    private
+
+    attr_reader :namespace, :parent, :config, :store
+    attr_accessor :is_leaf
+
+    def is_leaf?
+      @is_leaf
+    end
+
+    def __register(key, value, raise: 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.call(key) if store[key] && raise
+
+      store[key] = value
+    end
+
+    def __resolve(key, raise: true)
+      key = transformed_key(key)
+
+      value = if is_leaf?
+        if store[key]
+          store.fetch(key)
+        else
+          if default.is_a?(Blank)
+            return unless raise
+
+            on_key_not_registered.call(key)
+          else
+            value = resolve_default
+            return value unless memoize
+
+            store[key] ||= value
+          end
+        end
+      else
+        # Call nested registry builder when we are not a leaf
+        store[key] ||= default.call
+      end
+
+      resolver.call(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) } }
+    end
+
+    def define_interface
+      define_singleton_method name do |key = Blank.new, value = Blank.new|
+        return self if key.is_a?(Blank)
+
+        key = transformed_key(key)
+
+        if value.is_a?(Blank)
+          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)
+
+        key = transformed_key(key)
+
+        if value.is_a?(Blank)
+          resolve!(key)
+        else
+          register!(key, value)
+        end
+      end
+    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|
+          # TODO: Allowing a block does not make sense for memoize and call?!
+          value = block if block
+
+          if value.is_a?(Blank)
+            instance_variable_get("@#{attribute}")
+          else
+            instance_variable_set("@#{attribute}", value)
+          end
+        end
+
+        define_singleton_method "#{attribute}=" do |value|
+          instance_variable_set("@#{attribute}", value)
+        end
+      end
+    end
+
+    def attribute_not_allowed?(key)
+      return if attrs.empty?
+
+      attrs.keys.exclude?(transformed_key(key))
+    end
+
+    def resolve_default
+      if call && default.respond_to?(:call)
+        default.call
+      else
+        default
+      end
+    end
+
+    def raise_key_already_registered_error(key)
+      raise NxtRegistry::Errors::KeyAlreadyRegisteredError, "Key '#{key}' already registered in registry '#{namespace}'"
+    end
+
+    def raise_key_not_registered_error(key)
+      raise NxtRegistry::Errors::KeyNotRegisteredError, "Key '#{key}' not registered in registry '#{namespace}'"
+    end
+
+    def transformed_key(key)
+      @transformed_key ||= {}
+      @transformed_key[key] ||= begin
+        if transform_keys && !key.is_a?(Blank)
+          transform_keys.call(key)
+        else
+          key
+        end
+      end
+    end
+  end
+end

data/lib/nxt_registry/version.rb

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

data/lib/nxt_registry.rb

@@ -0,0 +1,18 @@
+require 'active_support/all'
+require "nxt_registry/version"
+require "nxt_registry/blank"
+require "nxt_registry/attribute"
+require "nxt_registry/errors"
+require "nxt_registry/nested_registry_builder"
+require "nxt_registry/registry"
+require "nxt_registry/recursive_registry"
+
+module NxtRegistry
+  def registry(name, &config)
+    Registry.new(name, &config)
+  end
+
+  def recursive_registry(name, &config)
+    RecursiveRegistry.new(name, &config)
+  end
+end

data/nxt_registry.gemspec

@@ -0,0 +1,39 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nxt_registry/version"
+
+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.summary       = %q{nxt_registry is a simple implementation of the container pattern}
+  spec.homepage      = "https://github.com/nxt-insurance"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/nxt-insurance/nxt_registry"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: nxt_registry
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andreas Robecke
+- Nils Sommer
+- Raphael Kallensee
+- Lütfi Demirci
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- a.robecke@getsafe.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rakeTasks"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- 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/nested_registry_builder.rb
+- lib/nxt_registry/recursive_registry.rb
+- lib/nxt_registry/registry.rb
+- lib/nxt_registry/version.rb
+- nxt_registry.gemspec
+homepage: https://github.com/nxt-insurance
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/nxt-insurance
+  source_code_uri: https://github.com/nxt-insurance/nxt_registry
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: nxt_registry is a simple implementation of the container pattern
+test_files: []