magic-lookup 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89553c6220236db6f6b88312bb5a8097718f383a107ab2a85e7c7e9c8ee9ebf1
-  data.tar.gz: 865c7c71973d94e809374270428b2532960a3b4a8a64dfd9393927942d140141
+  metadata.gz: 6c703f8d45523eb9fe156018f415b24d1eef923ae8abe72b549a8f66944b3d02
+  data.tar.gz: 7f473974c2a805aa8bfe766fb1fb0a58692098338a99f09dffbde0b2a6617899
 SHA512:
-  metadata.gz: 6496b67373aada9b47a0e6af847dca2485da0bb2d683b9eeed46dfbb15f55dedb78cf522da5ed03bc428de427ec60701629e377c1d9a786fe98a46a64b13347b
-  data.tar.gz: 9b9fe4f56b6d5ed85e957ec1bba331574a4f38677c0cf5e9c2225808ba00edac760256978b51ebd644a70bf68aee771bbc8dd0ffca519d38c46c6a2565ea30df
+  metadata.gz: 68be2c2fb418fe82891c30e8fbc5e8a8b84bcdc3eed3eee8b696ce2cbbf8f538f92b950af599fd3710d977f15c8c0f8f9816784e55454b0995e333b8fa9d63cc
+  data.tar.gz: b00b16af1e3aedc9a5c900ef9144f3e669fae21d862b0d856819dfb7eac90320597c496a2ff56f1e117f265cb58ec9b337c1c173cc985868e47b87a812b6f433

data/.rubocop.yml

@@ -1,5 +1,7 @@
-inherit_from: https://github.com/Alexander-Senko/Alexander-Senko/raw/refs/heads/main/.rubocop.yml
+inherit_from:
+  - https://github.com/Alexander-Senko/Alexander-Senko/raw/refs/heads/main/.rubocop.yml
+  - https://github.com/Alexander-Senko/Alexander-Senko/raw/refs/heads/main/.rubocop-rspec.yml
 
-require:
+plugins:
   - rubocop-rspec
   - rubocop-rake

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [0.3.0] — 2025-05-20
+
+### Added
+
+- `Magic::Lookup#for` to consider `self` a part of a lookup scope.
+
+
 ## [0.2.0] — 2024-10-19
 
 ### Added

data/README.md

@@ -1,3 +1,6 @@
+![GitHub Actions Workflow Status](
+	https://img.shields.io/github/actions/workflow/status/Alexander-Senko/magic-lookup/ci.yml
+)
 ![Code Climate maintainability](
 	https://img.shields.io/codeclimate/maintainability-percentage/Alexander-Senko/magic-lookup
 )
@@ -17,9 +20,9 @@ Moreover, inconsistencies across these implementations lead to misunderstanding
 
 So, meet
 
-# 🔮 Magic Lookup
+# 🔮 Magic Lookup
 
-It’s meant to be The One to Rule Them All — the library to provide a generic name-based lookup for a plenty of cases.
+It’s meant to be _The One to Rule Them All_ — the library to provide a generic name-based lookup for a plenty of cases.
 
 ## Installation
 
@@ -66,9 +69,10 @@ scope_class = Scope.for(object.class) or
     raise Magic::Lookup::Error.for(object, Scope)
 ```
 
-`Magic::Lookup::Error` is never raised internally and is meant to be used in your code that implements the lookup logic.
+> [!NOTE]
+> `Magic::Lookup::Error` is never raised internally and is meant to be used in your code that implements the lookup logic.
 
-## 🔮 Magic
+## 🔮 Magic
 
 ### Inheritance
 
@@ -97,6 +101,14 @@ Scope.for MyModel               # => MyNamespace::MyScope
 > One can access it by running `rake` in the gem directory.
 > The output is quite descriptive to get familiar with the use cases.
 
+## Known issues
+
+### https://github.com/Alexander-Senko/magic-lookup/issues/1
+
+> [!IMPORTANT]
+> Magic Lookup doesn’t try to autoload any classes, it searches among already loaded ones instead.
+> Thus, one should preload all classes that need to be accessible via the lookup.
+
 ## 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.

data/lib/magic/lookup/authors.rb

@@ -9,8 +9,8 @@ Gem::Author ||= Struct.new(
 end
 
 module Magic
-	module Lookup
-		AUTHORS = [
+	module Lookup # :nodoc:
+		AUTHORS = [ # rubocop:disable Style/MutableConstant
 				Gem::Author.new(
 						name:   'Alexander Senko',
 						email:  'Alexander.Senko@gmail.com',

data/lib/magic/lookup/error.rb

@@ -2,6 +2,17 @@
 
 module Magic
 	module Lookup
+		# = Magic Lookup Error
+		#
+		# When no class is found, `nil` is returned. If you need to raise
+		# an exception in this case, you can use `Magic::Lookup::Error`
+		# like this:
+		#
+		#     scope_class = Scope.for(object.class) or
+		#         raise Magic::Lookup::Error.for(object, Scope)
+		#
+		# `Magic::Lookup::Error` is never raised internally and is meant
+		# to be used by a class implementing the lookup logic.
 		class Error < NameError
 			def self.for object, lookup_class
 				default_name = lookup_class.name_for object.class

data/lib/magic/lookup/namespaces.rb

@@ -2,7 +2,7 @@
 
 module Magic
 	module Lookup
-		module Namespaces
+		module Namespaces # :nodoc:
 			attr_writer :namespaces
 
 			def namespaces = @namespaces ||= [ nil ]

data/lib/magic/lookup/version.rb

@@ -2,6 +2,6 @@
 
 module Magic
 	module Lookup
-		VERSION = '0.2.0'
+		VERSION = '0.3.0'
 	end
 end

data/lib/magic/lookup.rb

@@ -5,6 +5,32 @@ require_relative 'lookup/version'
 require 'memery'
 
 module Magic
+	# = Magic Lookup
+	#
+	# These are the steps to set up an automatic class inference:
+	#
+	# 1. Define a base class extending `Magic::Lookup`.
+	# 2. Define `.name_for` method for that class implementing your
+	#    lookup logic.
+	# 3. From the base class, inherit classes to be looked up.
+	#
+	# Example:
+	#
+	#     class Scope
+	#       extend Magic::Lookup
+	#
+	#       def self.name_for object_class
+	#         object_class.name
+	#             .delete_suffix('Model')
+	#             .concat('Scope')
+	#       end
+	#     end
+	#
+	#     class MyScope < Scope
+	#     end
+	#
+	#     Scope.for MyModel    # => MyScope
+	#     Scope.for OtherModel # => nil
 	module Lookup
 		autoload :Error,      'magic/lookup/error'
 		autoload :Namespaces, 'magic/lookup/namespaces'
@@ -13,6 +39,7 @@ module Magic
 
 		memoize def for object_class, namespace = nil
 			descendants = self.descendants # cache
+					.union([ self ]) # including self
 					.reverse # most specific first
 
 			object_class.ancestors

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: magic-lookup
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Alexander Senko
 bindir: bin
 cert_chain: []
-date: 2024-10-19 00:00:00.000000000 Z
+date: 2025-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: memery
@@ -52,7 +52,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/Alexander-Senko/magic-lookup
   source_code_uri: https://github.com/Alexander-Senko/magic-lookup
-  changelog_uri: https://github.com/Alexander-Senko/magic-lookup/blob/v0.2.0/CHANGELOG.md
+  changelog_uri: https://github.com/Alexander-Senko/magic-lookup/blob/v0.3.0/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -67,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.0.dev
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Related class inference with some magic involved
 test_files: []