mongory 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76d9dbc1cf7704258a68da00e955a295c66d6f0c53b1bcfa8becf505315daa14
+  data.tar.gz: 6492e6f3371fc402153abc0bb0368490a15f88f483ccdfce0912dc2249d9efe5
+SHA512:
+  metadata.gz: 9a8139f2288b78943b1e4d0f68433d8383d359877bef277dd760e2dc08486fedf3ebccb8d914a243e0f836ff61f7d307d00df8dbd5187e260b57f3cc7eadc0d0
+  data.tar.gz: 6317bad45fcc0ceb4d5b96316319090b6ca72e75db3ae34fd77fd799c8e1d4324d0cbb5a06b413eab2a74c89ca6494e4fc26b4ac082bfc2a2720bad373eb86b4

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--profile

data/.rubocop.yml

@@ -0,0 +1,84 @@
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'pre_release/**/*'
+    - 'vendor/**/*'
+    - 'node_modules/**/*'
+    - 'tmp/**/*'
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: '()'
+    '%i':    '()'
+    '%w':    '()'
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Lint/MissingSuper:
+  Enabled: false
+
+Style/SelectByRegexp:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Layout/FirstArrayElementIndentation:
+  Enabled: false
+
+Lint/StructNewOverride:
+  Enabled: false
+
+Style/Proc:
+  Enabled: false
+
+Lint/RescueException:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Naming/PredicateName:
+  Enabled: false
+
+Lint/UselessMethodDefinition:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Style/Documentation:
+  Exclude:
+    - 'lib/mongory/matchers/**/*'
+    - 'spec/**/*'

data/.yardopts

@@ -0,0 +1,7 @@
+--markup markdown
+--markup-provider redcarpet
+--output-dir doc
+--readme README.md
+--exclude spec/**/*
+
+lib/**/*.rb

data/CHANGELOG.md

@@ -0,0 +1,246 @@
+# Changelog
+
+## v0.3.0
+
+### New Features
+- Added matcher generator (`rails g mongory:matcher`)
+  - Automatically generates matcher class
+  - Automatically generates test files
+  - Automatically updates initializer
+- Added performance test suite
+  - Provides performance data for different data sizes
+  - Includes both simple and complex query tests
+
+### Improvements
+- Improved code style configuration
+- Updated documentation structure
+- Optimized matcher-related code
+- Enhanced key converter functionality
+  - Added support for escaped dots in string keys (e.g., `"user\\.name"` or `'user\.name'`)
+  - Fixed key converter registry method error
+- Enhanced error handling
+  - Modified error class structure
+- Improved documentation generation
+  - Fixed yardoc issues
+  - Expanded README content
+
+### Performance Data
+- Simple queries:
+  - 1000 records: ~2.5ms
+  - 10000 records: ~24.5ms
+  - 100000 records: ~242.5ms
+- Complex queries:
+  - 1000 records: ~3.2ms
+  - 10000 records: ~31.5ms
+  - 100000 records: ~323.0ms
+
+### Bug Fixes
+- Fixed require insertion position in matcher generator
+- Fixed key converter registry method error in Mongoid patch
+- Fixed support for escaped dots in key converter
+
+## [0.2.0] 2025-04-17
+
+### ✨ Added
+- `Matchers.register(method_sym, operator, klass)` API for registering custom operator matchers
+- `Matchers.enable_symbol_snippets!` opt-in method to enable query snippets like `:age.gt`
+- `Matchers::Validator` module for safe matcher registration validation
+- `Matchers::Registry` struct to encapsulate method/operator mapping with Symbol patching
+- All built-in matchers (`$regex`, `$or`, `$present`, etc.) now use declarative self-registration via `register(...)`
+
+### 🛠️ Changed
+- Matcher lookup is now routed through `Matchers.lookup(operator)` instead of hardcoded branches
+- Symbol snippet patching is now explicitly opt-in and will never override existing methods
+
+### 💥 Breaking (if applies)
+- If any external code relies on internal matcher instantiation logic, it should switch to using `Matchers.register`
+
+### 🔒 Security / Safety
+- All Symbol patching is guarded via `method_defined?` check to prevent conflict with Mongoid or user extensions
+
+## [0.1.0] 2025-04-17
+- Rename Mongory to Mongory-rb and reset version to v0.1.0
+
+## [2.0.0-beta.2] - 2025-04-16
+
+### Changed
+- Refactored all converter classes (`DataConverter`, `KeyConverter`, `ValueConverter`, `ConditionConverter`) into singleton classes inheriting from `AbstractConverter`
+- Introduced `default_registrations` hook method to encapsulate converter setup logic internally
+- Migrated fallback logic into `initialize`, removed reliance on `instance_eval`
+- Renamed `converter_builder.rb` to `abstract_converter.rb`
+- Refactored `Debugger` into a singleton class with `include Singleton`
+- Moved `Debugger`'s setup logic into `initialize`
+- All references to converters and debugger updated to use `.instance`
+
+### Breaking Changes
+- Removed support for direct `.convert(...)` calls on converter constants (e.g., `KeyConverter.convert`); use `.instance.convert(...)` instead
+- Removed `.configure` DSL on `ConditionConverter`; use `default_registrations` override instead
+- Replaced `Debugger.method` access with `Debugger.instance.method`
+
+## [2.0.0-beta.1] - Unreleased - 2025-4-16
+
+### ⚠️ Breaking Changes
+- Renamed `DefaultMatcher` to `LiteralMatcher`
+- Renamed `ConditionMatcher` to `HashConditionMatcher`
+- Renamed `CollectionMatcher` to `ArrayRecordMatcher`
+- Matcher behavior now enforces diggable structure for field access
+- Query no longer matches `nil` as a valid document; field conditions (like `a: nil`) require diggable structure
+
+### ✨ Features
+- Support for `$in` and `$nin` operators in query conditions
+- Delegated `nil` conditions to `OrMatcher` to improve MongoDB compatibility
+
+### 🧠 Debugger & Trace
+- Introduced structured matcher trace logging for better debugging
+- Tree-based trace visualization implemented
+- Removed dependency on Ruby's PrettyPrint module
+
+### 🛠 Refactors
+- Unified matcher dispatch logic in `dispatched_matcher`
+- Simplified `render_tree` logic
+- Improved fallback handling for symbol/string keys in field matchers
+- Improved trace indent level calculation logic
+- Removed all internal sort helpers: `#asc`, `#desc`, and `#sort_by_key`
+- Sorting is no longer supported in Mongory query builder
+- If needed, use `query.sort_by { |record| ... }` instead
+
+### ✅ Fixes
+- `$every => []` now correctly returns `false` instead of `true`
+
+### 🧪 Test & Docs
+- Refined RSpec matcher test coverage
+- Updated YARD documentation across matchers
+- Matcher converter display now includes full namespace
+
+### 📄 Planning
+- Added draft design notes for the upcoming `aggregate` system
+
+## [1.8.0] - 2025-04-14
+
+### Changed
+
+- **Refactored Matcher Architecture**
+  - `DigValueMatcher` has been renamed to `FieldMatcher` to better reflect its behavior.
+  - All matchers now use `enable_unwrap!` to explicitly control matcher flattening logic in multi-match contexts.
+  - `ConditionMatcher`, `CollectionMatcher`, and `DefaultMatcher` routing logic now reflects the new matcher structure.
+
+- **Improved Matcher Trace & Tree Introspection**
+  - All matchers now support `.render_tree` and `.tree_title` to integrate with `QueryBuilder#explain`.
+  - `FieldMatcher`, `RegexMatcher`, `InMatcher`, and `NinMatcher` now display accurate introspection trees.
+  - Enhanced `uniq_key` implementations across matchers to prevent duplication and support correct tree merging.
+
+- **Operator Behavior Refinement**
+  - `InMatcher` and `NinMatcher` now clearly distinguish between single value vs. array inputs.
+  - `RegexMatcher` now accepts both literal `/regex/` and `"$regex"` formats; fallback from `DefaultMatcher` is supported.
+
+### Documentation
+
+- Added or improved YARD documentation across all matchers.
+- All public APIs, including `render_tree`, `match`, `uniq_key`, and `tree_title` are now documented with examples and usage notes.
+- `matchers/README.md` updated to reflect renames and structural clarity.
+
+## [1.7.0] - 2025-04-13
+
+### Added
+
+- `QueryBuilder#explain` prints a tree-structured matcher breakdown using `PP`, useful for debugging.
+- Matchers now support `#render_tree` and `#tree_title`, enabling structured introspection.
+- `QueryBuilder#any_of` added as a semantic alias for `.and('$or' => [...])`.
+
+### Changed
+
+- Filter logic restructured to use immediately-parsed matchers (`set_matcher`) instead of building on `result`.
+- `.each` now directly filters via matcher tree evaluation, removing dependency on an internal condition hash.
+- Removed legacy `.result` method.
+- `.or(...)` now wraps existing conditions intelligently when merging mixed operator states.
+- `.pluck` and `.sort_by_keys` no longer convert keys to strings, fixing inconsistency with native Mongoid behavior.
+
+### Deprecated
+
+- `.asc` and `.desc` now emit deprecation warnings; they will be removed in v2.0.0.
+
+## [1.6.4] - 2025-04-11
+
+### Fixed
+
+- `MongoidPatch` now references `Mongory::Converters::KeyConverter` directly instead of lazily accessing it through `.condition_converter`.
+- Restored missing `Mongory.configure` method accidentally removed in earlier documentation refactor.
+- Ensured all `.configure` entrypoints are consistently available for all converters.
+
+## [1.6.1] - 2025-04-11
+
+### Added
+
+- **Rails Integration via Railtie**  
+  Mongory now auto-integrates with Rails if present, using a new `Mongory::Railtie` and `RailsPatch` module.
+
+- **Mongoid Integration Module**  
+  Added `mongory/mongoid` which registers `Mongoid::Criteria::Queryable::Key` for symbolic query operators (e.g. `:age.gt`).
+
+- **Conditional Auto-Require**  
+  `mongory.rb` now conditionally requires `rails` and `mongoid` integration modules when Rails or Mongoid is detected.
+
+- **YARD Documentation**  
+  Improved YARD docstrings for all public APIs, including `QueryOperator`, `InstallGenerator`, and matchers.
+
+### Changed
+
+- **Generator Initializer Cleanup**  
+  Removed direct Mongoid-specific converter registration from generator output. This logic is now encapsulated in `mongory/mongoid.rb`.
+
+- **Improved Symbol DSL Activation**  
+  Symbol snippets (`:age.gt => 30`) are now opt-in, via `Mongory.enable_symbol_snippets!`, and properly isolated from default runtime.
+
+- **Safer Core Patch for present?/blank?**  
+  When in Rails, Mongory will use `Object#present?` and `Object#blank?` instead of internal implementations, for better semantic consistency.
+
+## [1.6.0] - 2025-04-11
+
+### Added
+- **Custom Operator: `$every`**
+  Added support for `$every`, a new matcher that succeeds only if *all* elements in an array satisfy the condition.
+- **Custom Error Class: `Mongory::TypeError`**
+  Replaces Ruby's `TypeError` for internal validation, enabling cleaner and safer error handling.
+- **Internal API: `SingletonBuilder`**
+  Introduced a unified abstraction for building singleton converters and utilities (used by `Debugger`, all Converters, etc.).
+
+### Changed
+- **Unified Matcher Construction**
+  All matchers now use `.build(...)` instead of `.new(...)` for consistent instantiation.
+- **Simplified Matcher Dispatch**
+  Multi-matchers (`$and`, `$or`, etc.) now unwrap themselves when only one submatcher is present.
+- **Centralized Matcher Responsibility**
+  `ConditionMatcher` replaces `DefaultMatcher` as the default dispatcher for query conditions.
+- **Consistent Data Conversion**
+  All nested matchers (e.g. `FieldMatcher`, `ElemMatchMatcher`) now apply `data_converter` at match-time.
+
+### Fixed
+- **Validation Improvements**
+  Introduced `deep_check_validity!` to ensure all nested matchers are properly verified.
+- **Edge Case Consistency**
+  Cleaner fallback handling and key traversal behavior under complex or mixed-type query structures.
+
+---
+
+## [1.5.0] - 2025-04-09
+
+### Added
+- **YARD Documentation**: Added `.yardopts` configuration file for generating documentation.
+- **Converters Module**: Introduced `Mongory::Converters` module with `DataConverter` and `ConditionConverter` classes for better data and condition normalization.
+- **Debugger**: Exposed `Utils::Debugger` for better debug control and query tracing.
+
+### Changed
+- **QueryBuilder Refactor**: Simplified `build_query` method to use `QueryBuilder` directly without namespace.
+- **Data and Condition Converters**: Directly exposed `data_converter` and `condition_converter` via `Mongory` module for easier access and configuration.
+- **Removed Config Class**: Removed `Config` class and replaced with direct configuration in `Mongory`.
+
+### Fixed
+- **Bug Fixes**: Corrected issues with array comparisons and query operator behaviors.
+
+---
+
+## [Prior Versions Summary]
+
+- `1.0.1`: Initial release
+- `1.1.0 ~ 1.3.3`: Refactored matcher architecture, added class inheritance structure, separated key/value matcher logic.
+- `1.4.x`: Skipped

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 koten0224@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) 2025 frank0224
+
+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.