regstry 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 88580d89a97da7be18987bc9cfa2f58ccd732441ebc8cd8425d79c452f77cb2a
+  data.tar.gz: a0a62267b523ae5bce7f724ab1c7ce0e2b8523ee38572890400aa66b3762c6b1
+SHA512:
+  metadata.gz: 1b63293ff56e37486909227d53a9d15004fba7db60e282e79bff32aa573f3bc19e840fc1ad743688c5ac6cf92e331290cbb103bf4512e5e8715f380617ef7ffd
+  data.tar.gz: 75de7e7d1fbc9be9c07242ea222c49aec09aeb742a51e954a51746a15add945b43a2f9cd3ffc778db186ba3329666d164bc169c0e62515942e489040c65a6ecb

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT LICENSE
+
+Copyright (c) 2017 Sven Fuchs <me@svenfuchs.com>
+
+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,23 @@
+# Registry
+
+Ruby class registry for registering, and looking up classes using a key, rather
+than the class name. Decouples looking up classes from their name and namespace.
+
+## Usage
+
+```ruby
+class Obj
+  include Registry
+end
+
+class One < Obj
+  register :one
+end
+
+class Two < Obj
+  register :two
+end
+
+one = Obj[:one].new
+two = Obj[:two].new
+```

data/lib/registry/version.rb

@@ -0,0 +1,3 @@
+module Registry
+  VERSION = '1.0.0'
+end

data/lib/registry.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+require 'forwardable'
+
+module Registry
+  MSGS = {
+    unknown: 'can not use unregistered object %p. known objects are: %p'
+  }
+
+  class UnknownKey < StandardError
+  end
+
+  class Registries
+    extend Forwardable
+    include Enumerable
+
+    def_delegators :registries, :each, :keys, :values
+
+    def [](key)
+      registry = values.detect { |registry| registry.key?(key) }
+      obj = registry[key] if registry
+      obj || raise(UnknownKey, MSGS[:unknown] % [key, all_keys])
+    end
+
+    def registry(key)
+      registries[key]
+    end
+
+    def registries
+      @registries ||= Hash.new { |registries, key| registries[key] = Registry.new }
+    end
+
+    def all_keys
+      values.map(&:keys).flatten.sort
+    end
+  end
+
+  class Registry
+    extend Forwardable
+    include Enumerable
+
+    def_delegators :objects, :each, :key?, :keys, :values
+
+    def []=(key, object)
+      objects[key.to_sym] = object
+    end
+
+    def [](key)
+      key && objects[key.to_sym] || raise(UnknownKey, MSGS[:unknown] % [key, objects.keys.sort])
+    end
+
+    def objects
+      @objects ||= {}
+    end
+  end
+
+  class << self
+    def included(base)
+      base.send(:extend, ClassMethods)
+      base.send(:include, InstanceMethods)
+
+      name = base.name.to_s.split('::').last&.downcase&.to_sym || :default
+      base.instance_variable_set(:@registry_name, name)
+
+      base.instance_variable_set(:@registries, Registries.new)
+    end
+  end
+
+  module ClassMethods
+    attr_reader :registry_key
+
+    def register(key, obj = self)
+      obj.instance_variable_set(:@registry_key, key)
+      registry[key] = obj
+    end
+
+    def registered?(key)
+      registry.key?(key)
+    end
+
+    def lookup(key)
+      registries[key]
+    end
+
+    def [](key)
+      registry[key&.to_sym] || fail(MSGS[:unknown] % [key, registry.keys.sort])
+    end
+
+    def registry
+      @registry ||= registries.registry(registry_name)
+    end
+
+    def registry_name(name = nil)
+      name.nil? ? @registry_name ||= superclass.registry_name : @registry_name = name
+    end
+
+    def registries
+      @registries ||= superclass.registries
+    end
+  end
+
+  module InstanceMethods
+    def registry_key
+      self.class.registry_key
+    end
+
+    def registry_name
+      self.class.registry_name
+    end
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: regstry
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sven Fuchs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-22 00:00:00.000000000 Z
+dependencies: []
+description: Allows registering Ruby classes for lookup using a key.
+email:
+- me@svenfuchs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.md
+- README.md
+- lib/registry.rb
+- lib/registry/version.rb
+homepage: https://github.com/svenfuchs/registry
+licenses:
+- MIT
+metadata: {}
+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.3
+signing_key: 
+specification_version: 4
+summary: Ruby class registry
+test_files: []