No release in over 3 years
Low commit activity in last 3 years
Generates: controller file with actions specified in arguments, schema file for param validation written using dry-validation gem, use case class for handling logic of the request, presenter class for serialization of objects, request rspec specs for proper testing
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
 Dependencies

Development

~> 1.16
~> 10.0
~> 3.0
 Project Readme

rails-api-controller-generator

Description

This generator was developed to speed up the process of your boilercode writing in terms of your rest-api Rails app.

The generator itself is highly opinionated. It creates files that fit the way I manage my files and directories inside a Rails project. Also, it assumes you are using: rspec, dry-validation, use cases pattern and presenter pattern.

Installation

Add this line to your application's Gemfile:

group :development do
  gem 'rails-api-controller-generator'
end

And then execute:

$ bundle

Usage

In your project root folder execute:

$ bundle exec rails generate api_controller model_name action1 action2

So for example running:

$ bundle exec rails generate api_controller post index create

will create following files:

  • app/controllers/api/v1/posts_controller.rb
  • app/schemas/posts_index_schema.rb
  • app/use_cases/posts/index.rb
  • app/schemas/posts_create_schema.rb
  • app/use_cases/posts/create.rb
  • app/presenters/post_presenter.rb
  • app/presenters/posts_presenter.rb
  • spec/requests/posts_spec.rb

Each of these files will be filled with code. Model name needs to be singular!

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails-api-controller-generator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the rails-api-controller-generator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.