Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/IFTTT/polo
Polo travels through your database and creates sample snapshots so you can work with real world data in development.
https://github.com/IFTTT/polo
activerecord database productivity snapshot
Last synced: 3 months ago
JSON representation
Polo travels through your database and creates sample snapshots so you can work with real world data in development.
- Host: GitHub
- URL: https://github.com/IFTTT/polo
- Owner: IFTTT
- License: mit
- Created: 2015-07-28T23:57:57.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2023-10-11T19:03:59.000Z (over 1 year ago)
- Last Synced: 2024-07-31T17:23:27.224Z (5 months ago)
- Topics: activerecord, database, productivity, snapshot
- Language: Ruby
- Homepage: http://ifttt.github.io
- Size: 103 KB
- Stars: 770
- Watchers: 34
- Forks: 49
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-ruby - Polo - Creates sample database snapshots to work with real world data in development. (Database Tools)
README
[](http://ifttt.github.io)
[](https://travis-ci.org/IFTTT/polo)
# Polo
Polo travels through your database and creates sample snapshots so you can work with real world data in any environment.
Polo takes an `ActiveRecord::Base` seed object and traverses every whitelisted `ActiveRecord::Association` generating SQL `INSERTs` along the way.
You can then save those SQL `INSERTS` to .sql file and import the data to your favorite environment.
## Motivation
Read our [blog post](https://medium.com/engineering-at-ifttt/happier-rails-development-with-polo-9df6819136d3#.f8ll3azeq) or check out this [presentation](https://speakerdeck.com/nettofarah/polo-working-with-real-world-data-in-development).
## Usage
Given the following data model:
```ruby
class Chef < ActiveRecord::Base
has_many :recipes
has_many :ingredients, through: :recipes
end
class Recipe < ActiveRecord::Base
has_many :recipes_ingredients
has_many :ingredients, through: :recipes_ingredients
end
class Ingredient < ActiveRecord::Base
end
class RecipesIngredient < ActiveRecord::Base
belongs_to :recipe
belongs_to :ingredient
end
```
### Simple ActiveRecord Objects
```ruby
inserts = Polo.explore(Chef, 1)
```
```sql
INSERT INTO `chefs` (`id`, `name`) VALUES (1, 'Netto')
```
Where `Chef` is the seed object class, and `1` is the seed object id.
### Simple Associations
```ruby
inserts = Polo.explore(Chef, 1, :recipes)
```
```sql
INSERT INTO `chefs` (`id`, `name`) VALUES (1, 'Netto')
INSERT INTO `recipes` (`id`, `title`, `num_steps`, `chef_id`) VALUES (1, 'Turkey Sandwich', NULL, 1)
INSERT INTO `recipes` (`id`, `title`, `num_steps`, `chef_id`) VALUES (2, 'Cheese Burger', NULL, 1)
```
### Complex nested associations
```ruby
inserts = Polo.explore(Chef, 1, :recipes => :ingredients)
```
```sql
INSERT INTO `chefs` (`id`, `name`) VALUES (1, 'Netto')
INSERT INTO `recipes` (`id`, `title`, `num_steps`, `chef_id`) VALUES (1, 'Turkey Sandwich', NULL, 1)
INSERT INTO `recipes` (`id`, `title`, `num_steps`, `chef_id`) VALUES (2, 'Cheese Burger', NULL, 1)
INSERT INTO `recipes_ingredients` (`id`, `recipe_id`, `ingredient_id`) VALUES (1, 1, 1)
INSERT INTO `recipes_ingredients` (`id`, `recipe_id`, `ingredient_id`) VALUES (2, 1, 2)
INSERT INTO `recipes_ingredients` (`id`, `recipe_id`, `ingredient_id`) VALUES (3, 2, 3)
INSERT INTO `recipes_ingredients` (`id`, `recipe_id`, `ingredient_id`) VALUES (4, 2, 4)
INSERT INTO `ingredients` (`id`, `name`, `quantity`) VALUES (1, 'Turkey', 'a lot')
INSERT INTO `ingredients` (`id`, `name`, `quantity`) VALUES (2, 'Cheese', '1 slice')
INSERT INTO `ingredients` (`id`, `name`, `quantity`) VALUES (3, 'Patty', '1')
INSERT INTO `ingredients` (`id`, `name`, `quantity`) VALUES (4, 'Cheese', '2 slices')
```
## Advanced Usage
Occasionally, you might have a dataset that you want to refresh. A production database that has data that might be useful on your local copy of the database. Polo doesn't have an opinion about your data; if you try to import data with a key that's already in your local database, Polo doesn't necessarily know how you want to handle that conflict.
Advanced users will find the `on_duplicate` option to be helpful in this context. It gives Polo instructions on how to handle collisions.
*Note: This feature is currently only supported for MySQL databases. (PRs for other databases are welcome!)*
There are two possible values for the `on_duplicate` key: `:ignore` and `:override`. Ignore keeps the old data. Override keeps the new data. If there's a collision and the on_duplicate param is not set, Polo will simpy stop importing the data.
### Ignore
A.K.A the Ostrich Approach: stick your head in the sand and pretend nothing happened.
```ruby
Polo.configure do
on_duplicate :ignore
end
Polo::Traveler.explore(Chef, 1, :recipes)
```
```sql
INSERT IGNORE INTO `chefs` (`id`, `name`) VALUES (1, 'Netto')
INSERT IGNORE INTO `recipes` (`id`, `title`, `num_steps`, `chef_id`) VALUES (1, 'Turkey Sandwich', NULL, 1)
INSERT IGNORE INTO `recipes` (`id`, `title`, `num_steps`, `chef_id`) VALUES (2, 'Cheese Burger', NULL, 1)
```
### Override
Use the option `on_duplicate: :override` to override your local data with new data from your Polo script.
```ruby
Polo.configure do
on_duplicate :override
end
Polo::Traveler.explore(Chef, 1, :recipes)
```
```sql
INSERT INTO `chefs` (`id`, `name`) VALUES (1, 'Netto')
ON DUPLICATE KEY UPDATE id = VALUES(id), name = VALUES(name)
...
```
### Sensitive Fields
You can use the `obfuscate` option to obfuscate sensitive fields like emails or
user logins.
```ruby
Polo.configure do
obfuscate :email, :credit_card
end
Polo::Traveler.explore(AR::Chef, 1)
```
```sql
INSERT INTO `chefs` (`id`, `name`, `email`) VALUES (1, 'Netto', 'eahorctmaagfo.nitm@l')
```
Warning: This is not a security feature. Fields can still easily be rearranged back to their original format. Polo will simply scramble the order of strings so you don't accidentally end up causing side effects when using production data in development. It is not a good practice to use highly sensitive data in development.
#### Advanced Obfuscation
For more advanced obfuscation, you can pass in a custom obfuscation strategy. Polo will take in a lambda that can be used to transform sensitive data.
Using a `:symbol` as an obfuscate key targets all columns of that name. Passing an SQL selector as a `String` will target columns within the specified table.
````ruby
Polo.configure do
email_strategy = lambda do |email|
first_part = email.split("@")[0]
"#{first_part}@test.com"
end
credit_card_strategy = lambda do |credit_card|
"4123 4567 8910 1112"
end
# If you need the context of the record for its fields, it is accessible
# in the second argument of the strategy
social_security_strategy = lambda do |ssn, instance|
sprintf("%09d", instance.id)
end
obfuscate({
'chefs.email' => email_strategy, # This only applies to the "email" column in the "chefs" table
:credit_card => credit_card_strategy, # This applies to any column named "credit_card" across every table
:ssn_strategy => social_security_strategy
})
end
Polo::Traveler.explore(AR::Chef, 1)
````
```sql
INSERT INTO `chefs` (`id`, `name`, `email`) VALUES (1, 'Netto', '[email protected]')
```
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'polo'
```
And then execute:
```bash
$ bundle
```
Or install it yourself as:
```bash
$ gem install polo
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/IFTTT/polo. 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/IFTTT/polo/blob/master/CODE_OF_CONDUCT.md).
To run the specs across all supported version of Rails, check out the repo and
follow these steps:
```bash
$ bundle install
$ bundle exec appraisal install
$ bundle exec appraisal rake
```
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).