toolcase 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be3b662dfb690e6efe28a29f6f71be36875a97b46db08b64dcd3e8567aa97191
-  data.tar.gz: ff85f0cf1911494e70209b1f65a34dd20e4efbf0dd79293fe8a1a33fd266dc39
+  metadata.gz: 42ab4cde5229fee97fb5723d029c109caa0f20932fa4b9e6dbc17e7a1aec22ed
+  data.tar.gz: 5bb7a33c4b6c9ec54c5d456d705f78a4ec1b642bba831428daa78b32357733a5
 SHA512:
-  metadata.gz: 8980d73de1ff37211cd66de46b8f3fc78f4edcad93cdae6bdbbb625b5452344c0c53990423abac7684608aadef6a18b8c664b6e1d79261d6b2b8ac9ad68dece0
-  data.tar.gz: 5f9e7d32cf5dd1c35872dfbe7e10b59355bcb00e85097ed8ed44115ab5176dbcfd94662c783d97cdf19bef5f99f6d823d60f2ff8adf0e9e97e48ed59dfcdd6ff
+  metadata.gz: 229e6fc407eae590b1403245be100df24839c66614e3dfcbaccb9fc43365eb35286e0e494d7f453e25e5ffec0bc29146474caf01a1c60cd1c67a2956d513cb27
+  data.tar.gz: 4668874433002a46ed9b173b1d3e8735500d0c64513b8ed42d1c3a19147fc3b8fcdddeb3a62b9d00f296244d2cc81c513b366c6cc79680cac770d38a28a36655

data/.rubocop.yml

@@ -1,16 +1,5 @@
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120
-
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.5
   NewCops: enable
 
 Style/StringLiterals:
@@ -29,3 +18,7 @@ Style/SingleLineMethods:
 
 Metrics/AbcSize:
   Max: 20
+
+Metrics/MethodLength:
+  Exclude:
+    - 'test/registry_modifications_test.rb'

data/README.md

@@ -19,7 +19,90 @@ And then execute:
 
 ## Usage
 
-TODO: Write usage instructions here
+Extend a class to convert it into a strategy factory:
+
+```ruby
+class Factory
+  extend Toolcase::Registry
+
+  register Linux
+  register Windows
+  register MacOS
+  register { |it| it.do_something }
+
+  default InvalidOS
+end
+```
+
+The `register` method adds an object to the registry. It can be a block or proc.
+
+A default object can be assigned using the `default` method.
+The default object, if present, will be returned by default in any search that no object is found.
+This applies for the `find_by` and `[]` methods.
+
+`register` methods has the following options:
+
+```ruby
+class Factory
+  extend Toolcase::Registry
+
+  register Linux, tag: :OS                # Registries can be classified with a tag.
+  register OtherStuff, id: :otherstuff    # An item can have an identifier.
+end
+```
+
+An object can be located in different ways:
+
+```ruby
+# By id.
+Factory[:otherstuff]
+
+# Using the find_by function, which will search through all registries.
+Factory.find_by { |object| object.handle?(*args) }
+
+# Search only through items with a specific tag.
+Factory.find_by(:OS) { |object| object.handle?(*args) }
+
+# Look up if an specific object belongs to the registry.
+Factory.include?(object)
+
+# Look up if an specific object is present in a specific tag.
+Factory.include?(object, :OS)
+
+# Get all registries.
+Factory.registries
+
+# Get all tagged registries.
+Factory.registries(:OS)
+```
+
+If another class inherits from the Factory, its registries are inherited too.
+An useful use case is a validator registry, with common validators in base classes,
+and specific validators in concrete classes.
+
+```ruby
+class BaseRegistry
+  extend Toolcase::Registry
+
+  register BaseValidator
+  register NonEmpty
+end
+
+class SpecificRegistry < BaseRegistry
+  register SpecificValidator
+end
+
+SpecificRegistry.size   # Returns 3.
+```
+
+An item can be replaced or removed using the item id or the item directly.
+
+```ruby
+Factory.replace(:linux, Ubuntu)
+Factory.replace(Linux, Ubuntu)
+Factory.remove(:windows)
+Factory.remove(Windows)
+```
 
 ## Development
 

data/lib/toolcase/registry.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Toolcase
+  # Registry mixin. Allows to convert a class into a registrable container.
+  # It can then be used to register strategies/handlers and use the class as an abstract factory.
+  module Registry
+    def register(object = nil, id: nil, tag: :nil, &block)
+      element = nil
+      element = object unless object.nil?
+      element = block if block_given?
+
+      return if element.nil? || include?(element)
+
+      elements << element
+      tagged_elements[tag] << element
+      identifiers[id] = element unless id.nil?
+
+      element
+    end
+
+    def default(object = nil)
+      @default = object unless object.nil?
+      defined?(@default) ? @default : nil
+    end
+
+    def [](id)
+      identifiers.fetch(id, default)
+    end
+
+    def find_by(tag = nil, &block)
+      container(tag).find(-> { default }, &block)
+    end
+
+    def include?(object, tag = nil)
+      container(tag).include?(object)
+    end
+
+    def size(tag = nil)
+      container(tag).size
+    end
+
+    def replace(old_object_or_id, new_object)
+      resolve_object_or_id(old_object_or_id) do |id, element|
+        identifiers[id] = new_object unless id.nil?
+        elements[elements.index(element)] = new_object
+
+        tagged_list = find_in_tagged(element)
+        tagged_list[tagged_list.index(element)] = new_object unless tagged_list.nil?
+      end
+    end
+
+    def remove(object_or_id)
+      resolve_object_or_id(object_or_id) do |id, element|
+        identifiers.delete(id)
+        elements.delete(element)
+        find_in_tagged(element)&.delete(element)
+      end
+    end
+
+    def inherited(child)
+      super
+      child.elements.concat(registries)
+      child.tagged_elements.merge!(tagged_elements)
+      child.identifiers.merge!(identifiers)
+      child.default(default)
+    end
+
+    def registries(tag = nil)
+      container(tag).clone.freeze
+    end
+
+    protected
+
+    EMPTY = [].freeze
+
+    def elements
+      @elements ||= []
+    end
+
+    def resolve_object_or_id(obj_or_id)
+      id = identifiers.key?(obj_or_id) ? obj_or_id : identifiers.find { |_, value| value == obj_or_id }&.first
+      element = id.nil? ? obj_or_id : identifiers[id]
+      return unless include?(element)
+
+      yield(id, element)
+    end
+
+    def tagged_elements
+      @tagged_elements ||= Hash.new { |hash, key| hash[key] = [] }
+    end
+
+    def find_in_tagged(element)
+      tagged_elements.find { |_, list| list.include?(element) }&.last
+    end
+
+    def identifiers
+      @identifiers ||= {}
+    end
+
+    def container(tag)
+      return elements if tag.nil?
+
+      tagged_elements.key?(tag) ? tagged_elements[tag] : EMPTY
+    end
+  end
+end

data/lib/toolcase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Toolcase
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/toolcase.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "toolcase/version"
+require_relative "toolcase/registry"
 
+# Main module
 module Toolcase
-  class Error < StandardError; end
-  # Your code goes here...
 end

data/toolcase.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "Registry for handlers as a Strategy pattern implementation"
   spec.homepage      = "https://github.com/enchf/toolcase"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toolcase
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - enchf
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-24 00:00:00.000000000 Z
+date: 2021-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -110,6 +110,7 @@ files:
 - bin/console
 - bin/setup
 - lib/toolcase.rb
+- lib/toolcase/registry.rb
 - lib/toolcase/version.rb
 - toolcase.gemspec
 homepage: https://github.com/enchf/toolcase
@@ -127,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="