Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wilsonsilva/xavier
Imagine DatabaseCleaner for objects in memory.
https://github.com/wilsonsilva/xavier
rspec ruby test
Last synced: 4 months ago
JSON representation
Imagine DatabaseCleaner for objects in memory.
- Host: GitHub
- URL: https://github.com/wilsonsilva/xavier
- Owner: wilsonsilva
- License: mit
- Created: 2018-03-09T17:50:48.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-06-08T20:03:43.000Z (over 4 years ago)
- Last Synced: 2024-03-15T01:55:42.985Z (11 months ago)
- Topics: rspec, ruby, test
- Language: Ruby
- Homepage: https://www.rubydoc.info/gems/xavier
- Size: 59.6 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
Xavier
Tracks and reverts objects internal state mutations (changes in `instance`, `class`, and `class instance` variables).
## Table of contents
* [Motivation](#motivation)
* [Installation](#installation)
* [Usage](#usage)
* [TL;DR](#tldr)
* [With object instances](#with-object-instances)
* [Development](#development)
* [Contributing](#contributing)
## Motivation
In X-men, one of Xavier's goals is to protect society from antagonistic mutants. In Ruby, Xavier's goal is to protect
test cases from failures caused by global state mutations.
Global state can easily lead to interference between test cases and cause random failures. These issues are called
__mystery guests__, because they affect the behavior of the code being tested however the test method fails to show
that relationship.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'xavier'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install xavier
## Usage
### TL;DR
Call `Xavier.observe` with an object (observable) and a block. Modify the state of the observable inside the block.
When the block finishes executing, all the state mutations on the observable are reverted:
```ruby
Xavier.observe(observable) do
# mutate the state of observable inside of this block
end
# all mutations on the observable are reverted outside of the block
```
### With object instances
Consider [Jean Grey](https://en.wikipedia.org/wiki/Jean_Grey), a caring, nurturing human:
```ruby
class JeanGrey
attr_reader :traits
def initialize
@traits = ['caring', 'nurturing']
end
end
jean_grey = JeanGrey.new
jean_grey.traits # => ['caring', 'nurturing']
````
Jean's mutant power of telepathy first manifest when her best friend is hit by a car and killed. The event leaves her
comatose:
```ruby
class JeanGrey
attr_reader :powers, :traits
def initialize
@powers = []
@traits = ['caring', 'nurturing']
end
def witness_friend_die!
powers << 'telepathy'
traits << 'comatose'
end
end
jean_grey = JeanGrey.new
jean_grey.powers # => []
jean_grey.traits # => ['caring', 'nurturing']
jean_grey.witness_friend_die!
jean_grey.powers # => ['telepathy']
jean_grey.traits # => ['caring', 'nurturing', 'comatose']
````
She is brought back to consciousness when her parents seek the help of powerful mutant telepath, Charles Xavier. Xavier
blocks her telepathy until she is old enough to be able to control it:
```ruby
class JeanGrey
attr_reader :powers, :traits
def initialize
@powers = []
@traits = ['caring', 'nurturing']
end
def witness_friend_die!
powers << 'telepathy'
traits << 'comatose'
end
end
jean_grey = JeanGrey.new
jean_grey.powers # => []
jean_grey.traits # => ['caring', 'nurturing']
Xavier.observe(jean_grey) do
jean_grey.witness_friend_die!
jean_grey.powers # => ['telepathy']
jean_grey.traits # => ['caring', 'nurturing', 'comatose']
end
jean_grey.powers # => []
jean_grey.traits # => ['caring', 'nurturing']
````
## 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. The health and maintainability of the codebase is ensured through a set of
Rake tasks to test, lint and audit the gem for security vulnerabilities and documentation:
```
rake rubocop # Lint the codebase with RuboCop
rake rubocop:auto_correct # Auto-correct RuboCop offenses
rake spec # Run RSpec code examples
rake verify_measurements # Verify that yardstick coverage is at least 100%
rake yard # Generate YARD Documentation
rake yard:junk # Check the junk in your YARD Documentation
rake yardstick_measure # Measure docs in lib/**/*.rb with yardstick
```
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/wilsonsilva/xavier.