An open API service indexing awesome lists of open source software.

https://github.com/praveenram/activerecord_flow

Generate Flow type classes from ActiveRecord Models
https://github.com/praveenram/activerecord_flow

activerecord flowtype gem rails ruby

Last synced: about 2 months ago
JSON representation

Generate Flow type classes from ActiveRecord Models

Awesome Lists containing this project

README

          

[![Build Status](https://travis-ci.org/praveenram/activerecord_flow.svg?branch=master)](https://travis-ci.org/praveenram/activerecord_flow)

# ActiverecordFlow

Generate flow types from ActiveRecord models.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'activerecord_flow'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install activerecord_flow

## Usage

Available rake tasks in rails projects:

- `flow:generate`: Generates the flow type classes for the current project's activerecord types.

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/praveenram/activerecord_flow. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the ActiverecordFlow project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/activerecord_flow/blob/master/CODE_OF_CONDUCT.md).