Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/siposdani87/mongoid-fixture-kit
This package is a Ruby gem that provides a way to load sample data into a MongoDB database for testing purposes. It provides a simple and convenient way to manage test data by defining fixtures in YAML files, which can be loaded into the database before running tests.
https://github.com/siposdani87/mongoid-fixture-kit
minitest mongoid-plugin rails7
Last synced: 14 days ago
JSON representation
This package is a Ruby gem that provides a way to load sample data into a MongoDB database for testing purposes. It provides a simple and convenient way to manage test data by defining fixtures in YAML files, which can be loaded into the database before running tests.
- Host: GitHub
- URL: https://github.com/siposdani87/mongoid-fixture-kit
- Owner: siposdani87
- License: mit
- Created: 2023-02-09T09:52:26.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-10-22T16:06:09.000Z (about 1 year ago)
- Last Synced: 2024-10-17T09:46:48.714Z (about 1 month ago)
- Topics: minitest, mongoid-plugin, rails7
- Language: Ruby
- Homepage:
- Size: 43 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mongoid-fixture_kit
[](https://rubygems.org/gems/mongoid-fixture_kit)
[](https://rubygems.org/gems/mongoid-fixture_kit)
[](./LICENSE)
This package is a Ruby gem that provides a way to load sample data into a MongoDB database for testing purposes. It provides a simple and convenient way to manage test data by defining fixtures in YAML files, which can be loaded into the database before running tests.
This library aims to provide fixtures for Mongoid the same way you have them with ActiveRecord.
## Getting Started
### Installing
```ruby
gem 'mongoid-fixture_kit'
```
### Usage
In your tests, add:
```ruby
class ActiveSupport::TestCase
include Mongoid::FixtureKit::TestHelper
self.fixture_path = "#{Rails.root}/test/fixtures"
end
```
This is also done by `ActiveRecord`, but magically in the railties.
Then when you want to access a fixture:
```ruby
class UsersControllerTest < ActionController::TestCase
setup do
@user = users(:user_1)
end
test 'should show user' do
get :show, id: @user
assert_response :success
end
end
```
### Features
- Creation of a document from a YAML file.
- ERB inside YAML files
- `belongs_to` relations
- Polymorphic `belongs_to`
- `has_many` relations
- `has_and_belongs_to_many` relations
- `TestHelper` module to include in your tests
### Notes
Documents are stored with a special attribute `__fixture_name` which is used to retrieve it and establish relations.
`Mongoid::Document` has a `attr_accessor` defined for `__fixture_name`, so it doesn't pose any problem if you try to `dup` a document for example.
### Changes compared to ActiveRecord
- There is an option to load fixtures only once.
- Fixture accessor methods are defined publicly.
These changes are here to let you create another class holding persistent data inside your tests.
```ruby
class TestData
include Mongoid::FixtureKit::TestHelper
self.fixture_path = "#{Rails.root}/test/fixtures_universes"
self.load_fixtures_once = true
def TestData.instance
@instance ||= ->(){
instance = new
instance.setup_fixtures
instance
}.call
end
private_class_method :new
end
class ActiveSupport::TestCase
include Mongoid::FixtureKit::TestHelper
self.fixture_path = "#{Rails.root}/test/fixtures"
def data
TestData.instance
end
end
# somewhere else
test 'should validate complex data structure' do
assert_nothing_raised do
DataStructure.process(data.structures(:complex))
end
end
```
## License
The original version of this library is [mongoid-fixture_set](https://github.com/Aethelflaed/mongoid-fixture_set) by Geoffroy Planquart in 2014
## Bugs or Requests
If you encounter any problems feel free to open an [issue](https://github.com/siposdani87/mongoid-fixture-kit/issues/new?template=bug_report.md). If you feel the library is missing a feature, please raise a [ticket](https://github.com/siposdani87/mongoid-fixture-kit/issues/new?template=feature_request.md). Pull request are also welcome.
[](https://www.digitalocean.com/?refcode=b992bb656478&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge)
## Developer
[Dániel Sipos](https://siposdani87.com)
## Sponsors
This project is generously supported by [TrophyMap](https://trophymap.org), [I18Nature](https://i18nature.com), and several other amazing organizations.