magic-lookup 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 165ed4c613f3808aa064d20eecc5137a20b74ffca108e4b4edaab39e1de5c710
+  data.tar.gz: 8c57c00e753425063568765d62f4879a3848de727431663b4199c1e2cc119cd2
+SHA512:
+  metadata.gz: a42291c47d5e2c2d4545f0c7cbb842c03c39ae4f683b177c339832864c1a33fc98b1cc2deadb15e16e87b069cf557fce80e5f8b70ee6bb479921b658704ae208
+  data.tar.gz: 04b6aaf11baa0644333869e36a0045503b996f13bb1854cc8670d2510220865310e8f01a8b406b56d424328dde9e0690d3d5d5b81cf58cd9c59079fa9eda56fa

data/.rspec

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

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-10-07
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at Alexander.Senko@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Alexander Senko
+
+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,104 @@
+![Code Climate maintainability](
+	https://img.shields.io/codeclimate/maintainability-percentage/Alexander-Senko/magic-lookup
+)
+![Code Climate coverage](
+	https://img.shields.io/codeclimate/coverage/Alexander-Senko/magic-lookup
+)
+
+## What is it for?
+
+A bit of history: this gem was inspired by digging deeper into [Draper](https://github.com/drapergem/draper) with an eye on refactoring.
+
+A common task for an application is to match its parts against each other, be it inferring a default model class for a controller, or looking up a decorator for a model, or whatever else.
+
+Modern frameworks tend to use naming conventions over configuration to achieve that.
+Unfortunately, every one has to implement them on its own struggling through numerous bugs.
+Moreover, inconsistencies across these implementations lead to misunderstanding and endless tickets when actual behavior fails to meet user expectations based on other frameworks.
+
+So, meet
+
+# 🔮 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.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+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.
+
+```ruby
+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
+```
+
+### Exception handling
+
+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:
+
+```ruby
+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.
+
+## Features
+
+### Inheritance
+
+Lookup is provided not only for the class itself, but to any of its ancestors as well.
+
+### Namespaces
+
+Both of matching classes — the target and its match — may be namespaced independently.
+
+> [!TIP]
+> Until a comprehensive documentation on all the use cases is released, the spec is recommended as further reading.
+> One can access it by running `rake` in the gem directory.
+> The output is quite descriptive to get familiar with the use cases.
+
+## 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Alexander-Senko/magic-lookup. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Alexander-Senko/magic-lookup/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Magic Lookup project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Alexander-Senko/magic-lookup/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/magic/lookup/authors.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+Gem::Author ||= Struct.new(
+		:name,
+		:email,
+		:github,
+) do
+	def github_url = github && "https://github.com/#{github}"
+end
+
+module Magic
+	module Lookup
+		AUTHORS = [
+				Gem::Author.new(
+						name:   'Alexander Senko',
+						email:  'Alexander.Senko@gmail.com',
+						github: 'Alexander-Senko',
+				),
+		]
+
+		class << AUTHORS
+			def names      = filter_map &:name
+			def emails     = filter_map &:email
+			def github_url = filter_map(&:github_url).first
+		end
+	end
+end

data/lib/magic/lookup/error.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Magic
+	module Lookup
+		class Error < NameError
+			def self.for object, lookup_class
+				default_name = lookup_class.name_for object.class
+
+				new "no #{lookup_class} found for #{object.class}, default name is #{default_name}",
+						default_name, receiver: object
+			end
+		end
+	end
+end

data/lib/magic/lookup/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Magic
+	module Lookup
+		VERSION = '0.1.0'
+	end
+end

data/lib/magic/lookup.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lookup/version'
+
+require 'memery'
+
+module Magic
+	module Lookup
+		autoload :Error, 'magic/lookup/error'
+
+		include Memery
+
+		memoize def for object_class
+			descendants = self.descendants # cache
+					.reverse # most specific first
+
+			object_class.ancestors
+					.lazy # optimization
+					.filter(&:name)
+					.map { name_for _1 }
+					.filter_map do |class_name|
+						descendants.find { _1.name == class_name }
+					end
+					.first
+		end
+
+		def name_for(object_class) = raise NotImplementedError
+
+		def descendants
+			[
+					*subclasses,
+					*subclasses.flat_map(&__method__),
+			]
+		end
+	end
+end

data/sig/gem.rbs

@@ -0,0 +1,5 @@
+module Gem
+	class Author
+		def github_url: () -> String?
+	end
+end

data/sig/magic/lookup/error.rbs

@@ -0,0 +1,7 @@
+module Magic
+	module Lookup
+		class Error < NameError
+			def self.for: (any) -> Error
+		end
+	end
+end

data/sig/magic/lookup.rbs

@@ -0,0 +1,12 @@
+module Magic
+	module Lookup
+		VERSION: String
+		AUTHORS: Array[Gem::Author]
+
+		def for: (Class) -> Class?
+
+		def name_for: (Module) -> String
+
+		def descendants: -> Array[Class]
+	end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: magic-lookup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Senko
+bindir: bin
+cert_chain: []
+date: 2024-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: memery
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Find a related class for an object (ex., a decorator, a presenter, a
+  controller, or whatever).
+email:
+- Alexander.Senko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/magic/lookup.rb
+- lib/magic/lookup/authors.rb
+- lib/magic/lookup/error.rb
+- lib/magic/lookup/version.rb
+- sig/gem.rbs
+- sig/magic/lookup.rbs
+- sig/magic/lookup/error.rbs
+homepage: https://github.com/Alexander-Senko/magic-lookup
+licenses:
+- MIT
+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.1.0/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.0.dev
+specification_version: 4
+summary: Related class inference with some magic involved
+test_files: []