monq 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '049e17df27a39b7710e1793ad8aa2bbceea1cac5781c952c604f05569e0c5e3a'
+  data.tar.gz: 2d1b3d71bfbf2f666116004d75cc96963576d10570926788672a8943774a814a
+SHA512:
+  metadata.gz: b40814534a5516dd367c70a706500df2b3ca91a5313eb1544c94ddc05204e247ddc33ff54b8934731f748454dc149b4dacb924894eaf073e90684e49a9c5f86f
+  data.tar.gz: 7260f9a2eeb283c07a7bd4e19755897afbc44a4267896b1b58518256749bb0ffe5dd2479296cd20eef38e67b610f3304946fed4ddccb4cf7e96e7467e22721bb

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"monq" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["liuxiang921@gmail.com"](mailto:"liuxiang921@gmail.com").

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Liu Xiang
+
+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,108 @@
+# Monq: Mongoid + Pry MongoDB workbench
+
+Load user-authored Mongoid models from `~/.monq.d` and query MongoDB from a Pry REPL.
+
+## Install
+
+```bash
+gem install monq
+```
+
+From this repo:
+
+```bash
+bundle exec exe/monq
+```
+
+## Config
+
+`~/.monq.d/init.yml`:
+
+```yaml
+blog.dev:
+  uri: mongodb://USER:PASSWORD@db.example.com:27017/?authSource=admin
+  database: blog_dev
+  namespace: Blog
+```
+
+`USER` and `PASSWORD` are placeholders. Put real credentials only in your local YAML or in `MONQ_TEST_URI` / `MONQ_TEST_DB` for the optional integration spec. Do not commit them.
+
+Start with `monq -e blog.dev`. The environment prefix (`blog`) loads `~/.monq.d/blog.rb` inside the `Blog` namespace.
+
+## Models
+
+`~/.monq.d/blog.rb`:
+
+```ruby
+class User
+  include Mongoid::Document
+  store_in collection: "users"
+  field :name, type: String
+  field :status, type: String
+  embeds_one :meta, class_name: "UserMeta", store_as: "_meta"
+
+  def posts
+    Post.where(author_name: name)
+  end
+end
+
+class UserMeta
+  include Mongoid::Document
+  embedded_in :user, class_name: "User"
+  field :source, type: String
+end
+
+class Post
+  include Mongoid::Document
+  store_in collection: "posts"
+  field :author_name, type: String
+  field :title, type: String
+  field :published_on, type: String
+end
+```
+
+Write `class User`, not `class Blog::User`. The file is already evaluated inside the namespace, so the class becomes `Blog::User`.
+
+String dates such as `published_on` (`YYYY-MM-DD`) sort lexicographically. Associations can be query methods on natural keys, not only ObjectId `belongs_to` / `has_many`. Non-pluralized collection names must be set with `store_in collection:`.
+
+## Commands
+
+| Command | What it does |
+|---------|----------------|
+| `info` | Matching environments: database, client, ping, masked URI, SSH |
+| `m` / `l` | Loaded models: collection, class, abbreviation |
+| `show-sql` / `hide-sql` | Toggle Mongo command logging |
+| `reconnect` / `reconnect!` | Rebuild a dead client, or force a rebuild. Refused while a sandbox is open |
+| `redefine` | Reload prefix model files. Refused while a sandbox is open |
+| `sandbox-enter` / `sandbox-quit` | Open or abort a transaction on every environment |
+
+## Display
+
+- `record.t` prints one document as a table. `criteria.t` materializes the criteria first.
+- Criteria and collection views without your own `limit` are capped at 500 rows (`showing N rows (capped at 500)`).
+- `.v` returns table data (`[keys, nil, *rows]`). `.vd` sends rows to visidata.
+- `write_csv` and `write_excel` are not capped. `limit` large results yourself.
+
+## SSH
+
+A tunnel forwards a single seed and connects with `direct_connection: true`. `replicaSet` (and other topology options) are stripped. `mongodb+srv` together with `ssh` is rejected.
+
+## Sandbox
+
+Transactions need a replica set or mongos. Model `save` / `update` / `delete` / `create` are intended to run inside that session. A raw `client[:c].insert_one` is not guaranteed to be inside the transaction. `sandbox-quit` aborts; there is no commit.
+
+## Multiple environments
+
+```bash
+monq -e a,b
+```
+
+A bare top-level constant resolves to the first environment in that list.
+
+## Contributing
+
+Bug reports and pull requests are welcome at https://github.com/lululau/monq. Contributors are expected to follow the [code of conduct](https://github.com/lululau/monq/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+MIT. See [LICENSE.txt](LICENSE.txt).

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