Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pocke/arpry
Pry with Active Record. Without Rails.
https://github.com/pocke/arpry
Last synced: about 2 months ago
JSON representation
Pry with Active Record. Without Rails.
- Host: GitHub
- URL: https://github.com/pocke/arpry
- Owner: pocke
- License: apache-2.0
- Created: 2018-12-31T10:06:12.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-01-18T06:24:59.000Z (almost 5 years ago)
- Last Synced: 2024-05-01T23:20:55.829Z (8 months ago)
- Language: Ruby
- Homepage:
- Size: 38.1 KB
- Stars: 10
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Arpry
Pry with Active Record. Without Rails.
## What's this?
Rails Console is a powerful tool for exploring database, but it works only with Rails.
Arpry works like Rails Console without Rails.
You can get the same experience as Rails Console to explore database with not-Rails project!
## Installation
Requirements: Ruby 2.4 or higher
```bash
$ gem install arpry
# Install adapter gem(s) you need
$ gem install sqlite3 # Or pg, mysql2, ...
```
## Usage
Explore database with `arpry` command.
```bash
# For sqlite3
$ arpry /path/to/databasefile.sqlite3
# For postgresql
$ arpry --adapter postgresql --host localhost --user YOUR_USER_NAME --password YOUR_PASSWORD --database YOUR_DB_NAME
# Probably it works with other RDBMS such as MySQL.
```
See `arpry --help` for more information of command line options.
Arpry defines classes for each table. For example:
```ruby
[1] pry(Arpry::Namespace)> User.first
D, [2018-12-31T22:07:45.652956 #8470] DEBUG -- : Arpry::Namespace::User Load (0.2ms) SELECT "users".* FROM "users" ORDER BY "users"."id" ASC LIMIT ? [["LIMIT", 1]]
=> #
```
Arpry defines has_many, belongs_to, and has_many through relations automatically. For example:
```sql
-- test.sqlite3
-- Schema
CREATE TABLE articles ( id int primary key not null, title text not null, content text not null);
CREATE TABLE comments ( id int primary key not null, article_id int not null, content text not null);
CREATE TABLE tags ( id int primary key not null, name text not null);
CREATE TABLE article_tags ( id int primary key not null, article_id int not null, tag_id int not null);
-- Data
INSERT INTO articles(id, title, content) VALUES (1, 'Awesome Article', 'Hello, world!');
INSERT INTO comments(id, article_id, content) VALUES (1, 1, 'It is fantastic!');
INSERT INTO tags(id, name) VALUES (1, 'tech'), (2, 'hobby'), (3, 'game');
INSERT INTO article_tags(id, article_id, tag_id) VALUES (1, 1, 1), (2, 1, 2);
```
```bash
$ sqlite3 db < test.sqlite3
```
```ruby
$ arpry db
[1] pry(Arpry::Namespace)> a = Article.first
D, [2018-12-31T22:27:02.801294 #10176] DEBUG -- : Arpry::Namespace::Article Load (0.2ms) SELECT "articles".* FROM "articles" ORDER BY "articles"."id" ASC LIMIT ? [["LIMIT", 1]]
=> #
[2] pry(Arpry::Namespace)> a.comments
D, [2018-12-31T22:27:08.291179 #10176] DEBUG -- : Arpry::Namespace::Comment Load (0.3ms) SELECT "comments".* FROM "comments" WHERE "comments"."article_id" = ? [["article_id", 1]]
=> [#]
[3] pry(Arpry::Namespace)> a.tags
D, [2018-12-31T22:27:11.505179 #10176] DEBUG -- : Arpry::Namespace::Tag Load (0.2ms) SELECT "tags".* FROM "tags" INNER JOIN "article_tags" ON "tags"."id" = "article_tags"."tag_id" WHERE "article_tags"."article_id" = ? [["article_id", 1]]
=> [#, #]
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/pocke/arpry.