rest-api-generator 0.1.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7576268dec99ae0feafe5da3a552dae8d0609ccd244f5e62a99007e2f54090b
-  data.tar.gz: 0f8a227490885ada7b83f1373c854857889e710b1d24285a81b45490308419a6
+  metadata.gz: a42f65c1630afe3db2bc1acb7c66272b9703e61ac761d509b0561e6c9369d7df
+  data.tar.gz: 898e903b7b81efa687f272a18ec7179f42ac566da404b1f046002b74345c9f77
 SHA512:
-  metadata.gz: 19bbdd850d24d6168fda588274287ad8645b255165487261dd6413420ab395fdc150675d97ed57ac6e2d395f2bf7cc5d48632f3b43bfe2a11f06964aae71b1d7
-  data.tar.gz: 4653ea0a74f2377c9052eba66bb16230096598f5f3e5d52f42ff5ad5141b763b4054359c7bf360083d7e08b517249bf44b17a9a6e64765f51861961075068c65
+  metadata.gz: 83e49d124a05cee3c742a69d5d2b1f798014e331c2a662a2bd7b0b19cb99ca45d66bdd290fa996e0c7e969d302fc9ecd49e9c69554836fe582d55adbb06f8f66
+  data.tar.gz: 14bd2117229d7cc2cb6b17371f7d0767720e3b6051ddcfc5fa6fb95aec438c29db25800ec5d44505284e4c56ba817e36666fa9118262228d5ab6086d740b0016

data/Gemfile

@@ -12,3 +12,9 @@ gem "rspec", "~> 3.0"
 gem "switchcop"
 
 gem "sqlite3"
+
+# Serializers
+
+gem "panko_serializer"
+
+gem "active_model_serializers", "~> 0.10.0"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rest-api-generator (0.1.7)
+    rest-api-generator (0.3.0)
       anyway_config (>= 2.0.0)
       pagy
       rails (>= 5.0)
@@ -9,86 +9,93 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.0.4)
-      actionpack (= 7.0.4)
-      activesupport (= 7.0.4)
+    actioncable (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.4)
-      actionpack (= 7.0.4)
-      activejob (= 7.0.4)
-      activerecord (= 7.0.4)
-      activestorage (= 7.0.4)
-      activesupport (= 7.0.4)
+    actionmailbox (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       mail (>= 2.7.1)
       net-imap
       net-pop
       net-smtp
-    actionmailer (7.0.4)
-      actionpack (= 7.0.4)
-      actionview (= 7.0.4)
-      activejob (= 7.0.4)
-      activesupport (= 7.0.4)
+    actionmailer (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      actionview (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       mail (~> 2.5, >= 2.5.4)
       net-imap
       net-pop
       net-smtp
       rails-dom-testing (~> 2.0)
-    actionpack (7.0.4)
-      actionview (= 7.0.4)
-      activesupport (= 7.0.4)
+    actionpack (7.0.4.3)
+      actionview (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.4)
-      actionpack (= 7.0.4)
-      activerecord (= 7.0.4)
-      activestorage (= 7.0.4)
-      activesupport (= 7.0.4)
+    actiontext (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.0.4)
-      activesupport (= 7.0.4)
+    actionview (7.0.4.3)
+      activesupport (= 7.0.4.3)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.4)
-      activesupport (= 7.0.4)
+    active_model_serializers (0.10.13)
+      actionpack (>= 4.1, < 7.1)
+      activemodel (>= 4.1, < 7.1)
+      case_transform (>= 0.2)
+      jsonapi-renderer (>= 0.1.1.beta1, < 0.3)
+    activejob (7.0.4.3)
+      activesupport (= 7.0.4.3)
       globalid (>= 0.3.6)
-    activemodel (7.0.4)
-      activesupport (= 7.0.4)
-    activerecord (7.0.4)
-      activemodel (= 7.0.4)
-      activesupport (= 7.0.4)
-    activestorage (7.0.4)
-      actionpack (= 7.0.4)
-      activejob (= 7.0.4)
-      activerecord (= 7.0.4)
-      activesupport (= 7.0.4)
+    activemodel (7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activerecord (7.0.4.3)
+      activemodel (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activestorage (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       marcel (~> 1.0)
       mini_mime (>= 1.1.0)
-    activesupport (7.0.4)
+    activesupport (7.0.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    addressable (2.8.1)
+    addressable (2.8.4)
       public_suffix (>= 2.0.2, < 6.0)
     ammeter (1.1.5)
       activesupport (>= 3.0)
       railties (>= 3.0)
       rspec-rails (>= 2.2)
-    anyway_config (2.4.0)
+    anyway_config (2.4.1)
       ruby-next-core (>= 0.14.0)
     ast (2.4.2)
     builder (3.2.4)
-    concurrent-ruby (1.1.10)
+    case_transform (0.2)
+      activesupport
+    concurrent-ruby (1.2.2)
     crass (1.0.6)
-    database_cleaner (2.0.1)
-      database_cleaner-active_record (~> 2.0.0)
-    database_cleaner-active_record (2.0.1)
+    database_cleaner (2.0.2)
+      database_cleaner-active_record (>= 2, < 3)
+    database_cleaner-active_record (2.1.0)
       activerecord (>= 5.a)
       database_cleaner-core (~> 2.0.0)
     database_cleaner-core (2.0.1)
@@ -97,14 +104,15 @@ GEM
     erubi (1.12.0)
     globalid (1.1.0)
       activesupport (>= 5.0)
-    i18n (1.12.0)
+    i18n (1.13.0)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
     json-schema (3.0.0)
       addressable (>= 2.8)
-    loofah (2.19.1)
+    jsonapi-renderer (0.2.2)
+    loofah (2.21.2)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
+      nokogiri (>= 1.12.0)
     mail (2.8.1)
       mini_mime (>= 0.1.1)
       net-imap
@@ -113,8 +121,8 @@ GEM
     marcel (1.0.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
-    mini_portile2 (2.8.1)
-    minitest (5.16.3)
+    mini_portile2 (2.8.2)
+    minitest (5.18.0)
     net-imap (0.3.4)
       date
       net-protocol
@@ -125,136 +133,148 @@ GEM
     net-smtp (0.3.3)
       net-protocol
     nio4r (2.5.9)
-    nokogiri (1.13.10)
+    nokogiri (1.14.4)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    nokogiri (1.13.10-x86_64-linux)
+    nokogiri (1.14.4-x86_64-linux)
       racc (~> 1.4)
-    pagy (6.0.3)
-    parallel (1.22.1)
-    parser (3.1.3.0)
+    oj (3.14.3)
+    pagy (6.0.4)
+    panko_serializer (0.7.9)
+      activesupport
+      oj (> 3.11.0, < 4.0.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
       ast (~> 2.4.1)
     public_suffix (5.0.1)
     racc (1.6.2)
-    rack (2.2.4)
-    rack-test (2.0.2)
+    rack (2.2.7)
+    rack-test (2.1.0)
       rack (>= 1.3)
-    rails (7.0.4)
-      actioncable (= 7.0.4)
-      actionmailbox (= 7.0.4)
-      actionmailer (= 7.0.4)
-      actionpack (= 7.0.4)
-      actiontext (= 7.0.4)
-      actionview (= 7.0.4)
-      activejob (= 7.0.4)
-      activemodel (= 7.0.4)
-      activerecord (= 7.0.4)
-      activestorage (= 7.0.4)
-      activesupport (= 7.0.4)
+    rails (7.0.4.3)
+      actioncable (= 7.0.4.3)
+      actionmailbox (= 7.0.4.3)
+      actionmailer (= 7.0.4.3)
+      actionpack (= 7.0.4.3)
+      actiontext (= 7.0.4.3)
+      actionview (= 7.0.4.3)
+      activejob (= 7.0.4.3)
+      activemodel (= 7.0.4.3)
+      activerecord (= 7.0.4.3)
+      activestorage (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       bundler (>= 1.15.0)
-      railties (= 7.0.4)
+      railties (= 7.0.4.3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.4)
+    rails-html-sanitizer (1.5.0)
       loofah (~> 2.19, >= 2.19.1)
-    railties (7.0.4)
-      actionpack (= 7.0.4)
-      activesupport (= 7.0.4)
+    railties (7.0.4.3)
+      actionpack (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
       zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.1)
+    regexp_parser (2.8.0)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.1)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.1)
+    rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-rails (6.0.1)
+    rspec-rails (6.0.2)
       actionpack (>= 6.1)
       activesupport (>= 6.1)
       railties (>= 6.1)
-      rspec-core (~> 3.11)
-      rspec-expectations (~> 3.11)
-      rspec-mocks (~> 3.11)
-      rspec-support (~> 3.11)
+      rspec-core (~> 3.12)
+      rspec-expectations (~> 3.12)
+      rspec-mocks (~> 3.12)
+      rspec-support (~> 3.12)
     rspec-support (3.12.0)
-    rswag (2.8.0)
-      rswag-api (= 2.8.0)
-      rswag-specs (= 2.8.0)
-      rswag-ui (= 2.8.0)
-    rswag-api (2.8.0)
+    rswag (2.9.0)
+      rswag-api (= 2.9.0)
+      rswag-specs (= 2.9.0)
+      rswag-ui (= 2.9.0)
+    rswag-api (2.9.0)
       railties (>= 3.1, < 7.1)
-    rswag-specs (2.8.0)
+    rswag-specs (2.9.0)
       activesupport (>= 3.1, < 7.1)
       json-schema (>= 2.2, < 4.0)
       railties (>= 3.1, < 7.1)
       rspec-core (>= 2.14)
-    rswag-ui (2.8.0)
+    rswag-ui (2.9.0)
       actionpack (>= 3.1, < 7.1)
       railties (>= 3.1, < 7.1)
-    rubocop (1.40.0)
+    rubocop (1.51.0)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.23.0, < 2.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.24.0)
-      parser (>= 3.1.1.0)
-    rubocop-performance (1.15.2)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.22.0)
+      rubocop (~> 1.33)
+    rubocop-performance (1.17.1)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.17.4)
+    rubocop-rails (2.19.1)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.33.0, < 2.0)
-    rubocop-rspec (2.16.0)
+    rubocop-rspec (2.22.0)
       rubocop (~> 1.33)
-    rubocop-shopify (2.10.1)
-      rubocop (~> 1.35)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    rubocop-shopify (2.13.0)
+      rubocop (~> 1.50)
     ruby-next-core (0.15.3)
-    ruby-progressbar (1.11.0)
-    sqlite3 (1.5.4)
+    ruby-progressbar (1.13.0)
+    sqlite3 (1.6.2)
       mini_portile2 (~> 2.8.0)
-    sqlite3 (1.5.4-x86_64-linux)
-    switchcop (0.1.2)
-      rubocop (~> 1.40.0)
-      rubocop-performance (~> 1.15.1)
-      rubocop-rails (~> 2.17.3)
-      rubocop-rspec (~> 2.16.0)
-      rubocop-shopify (~> 2.10.1)
-    thor (1.2.1)
+    sqlite3 (1.6.2-x86_64-linux)
+    switchcop (0.1.3)
+      rubocop (~> 1.48)
+      rubocop-performance (~> 1.16)
+      rubocop-rails (~> 2.18)
+      rubocop-rspec (~> 2.19)
+      rubocop-shopify (~> 2.12)
+    thor (1.2.2)
     timeout (0.3.2)
-    tzinfo (2.0.5)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.3.0)
+    unicode-display_width (2.4.2)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.6.6)
+    zeitwerk (2.6.8)
 
 PLATFORMS
   ruby
   x86_64-linux
 
 DEPENDENCIES
+  active_model_serializers (~> 0.10.0)
   ammeter (~> 1.1.5)
   database_cleaner
+  panko_serializer
   rake (~> 13.0)
   rest-api-generator!
   rspec (~> 3.0)

data/README.md

@@ -3,6 +3,11 @@
 This gem helps you to build a Ruby on Rails REST API faster, using a scaffold-like generator that follows the best
 practices.
 
+## Get started
+
+:zap: **Quick Start**: [docs](https://rest-api-generator.switchdreams.com.br/quick-start)\
+:books: **Documentation**: [docs](https://rest-api-generator.switchdreams.com.br/)
+
 ## How it works?
 
 The gems use vanilla Rails generators in combination with our templates to create all the resources needed to build a
@@ -25,319 +30,16 @@ Following [Switch Dreams's](https://www.switchdreams.com.br/]) coding practices,
 - [Resource ordering](#ordering)
 - [Resource filter](#filtering)
 - [Resource pagination](#pagination)
+- [Resource serialization](#serialization)
 - [Configurable](#configuration)
+- [Callbacks](#callbacks)
 
 ## Next Features
 
-- Serialization https://github.com/SwitchDreams/rest-api-generator/issues/14
-  https://github.com/SwitchDreams/rest-api-generator/issues/11
-- Pagination https://github.com/SwitchDreams/rest-api-generator/issues/15
 - Integration with AVO
 - Select fields
 - User auth module
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-# Build a Ruby on Rails REST API faster
-gem 'rest-api-generator'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install rest-api-generator
-
-## Requirements
-
-1. You need to have installed RSpec and FactoryBot in your application.
-
-<ul>
-  <li>RSpec: https://github.com/rspec/rspec-rails</li>
-  <li>Factory bot: https://github.com/thoughtbot/factory_bot_rails</li>
-</ul>
-
-2. Include in ApplicationController the error handler module:
-
-```ruby
-
-class ApplicationController < ActionController::API
-  include RestApiGenerator::ErrorHandler
-end
-```
-
-This error handler will rescue from: `ActiveRecord::RecordNotFound`
-, `ActiveRecord::ActiveRecordError`, `ActiveRecord::RecordInvalid`, `ActiveModel::ValidationError`
-, `RestApiGenerator::CustomError`.
-
-## Usage
-
-### Generate Resource
-
-```bash
-$ rails g rest_api_generator:resource table_name attributes
-```
-
-This command will create:
-
-- **Model and Migration**: Using rails default model generator
-- **Controller**: A controller that implementes CRUD by inheritance of `RestApiGenerator::ResourceController`, or you
-  can use eject option for create a controller
-  that implements index, show, create, update and destroy methods.
-- **Specs for the created controller**
-- **Factory bot factory for created model**
-- **Routes**: with rails resources
-
-### Example
-
-```bash
-$ rails g rest_api_generator:resource car name:string color:string
-```
-
-Will generate following controller and the other files:
-
-```ruby
-# app/controllers/cars_controller.rb
-class CarsController < RestApiGenerator::ResourceController
-end
-```
-
-For a better experience you can override some methods from the
-[default controller](https://github.com/SwitchDreams/rest-api-generator/blob/main/lib/rest_api_generator/resource_controller.rb)
-
-### Options
-
-| Option | Goal                                                         | Default | Usage Example   |
-|--------|--------------------------------------------------------------|---------|-----------------|
-| father | Generate nested resource                                     | nil     | --father Users  |
-| scope  | Scope the resource for other route or namespace organization | nil     | --scope Api::V1 |
-| eject  | Eject the controller to high customization                   | false   | true            |
-| spec   | Choose the spec format. Current options: "rspec" or "rswag"  | rspec   | --spec rswag    |
-
-#### Scope
-
-In REST api one of the best practices is versioning the end-points, and you can achieve this using scope options,
-example:
-
-```bash
-# Command
-rails g rest_api_generator:resource car name:string color:string --scope Api::V1
-```
-
-```ruby
-# GET api/v1/cars
-module Api::V1
-  class CarsController < RestApiGenerator::ResourceController
-  end
-end
-```
-
-For this option you need to manually setup routes, for this example:
-
-```ruby
-# routes.rb
-namespace :api do
-  namespace :v1 do
-    resources :cars
-  end
-end
-```
-
-#### Nested resource
-
-In REST api sometimes we need to build a nested resource, for example when we need to get all devices from a user, for
-this we have nested resource option:
-
-```bash
-# Command
-rails g rest_api_generator:resource Devices name:string color:string users:references --scope Users
-```
-
-```ruby
-# GET users/:user_id/devices
-module Users
-  class DevicesController < RestApiGenerator::ChildResourceController
-  end
-end
-```
-
-For this option you need to manually setup routes, for this example:
-
-```ruby
-# routes.rb
-resources :users do
-  resources :devices, controller: 'users/devices'
-end
-```
-
-Considerations:
-
-- The children model needs to belongs_to parent model and parent model needs to have has_many children model
-
-#### Eject
-
-Or you can use the `eject` option for create the controller with the implemented methods:
-
-```bash
-rails g rest_api_generator:resource car name:string color:string --eject true
-```
-
-```ruby
-
-class CarsController < ApplicationController
-  before_action :set_car, only: %i[show update destroy]
-
-  def index
-    @car = Car.all
-    render json: @car, status: :ok
-  end
-
-  def show
-    render json: @car, status: :ok
-  end
-
-  def create
-    @car = Car.create!(car_params)
-    render json: @car, status: :created
-  end
-
-  def update
-    @car = Car.update!(car_params)
-    render json: @car, status: :ok
-  end
-
-  def destroy
-    @car.destroy!
-  end
-
-  private
-
-  def set_car
-    @car = Car.find(params[:id])
-  end
-
-  def car_params
-    params.require(:car).permit(:name, :color)
-  end
-end
-```
-
-#### Specs/Docs
-
-The default generated spec for this gem is using plain rspec, but you can choose rswag, for scaffold you specs and docs
-at the same time:
-
-For this you need to setup https://github.com/rswag/rswag and you the following flag when generating resources.
-
-```shell
-rails g rest_api_generator:resource Car name:string color:string --spec rswag
-```
-
-This spec options work as generators too, so you can call them individually:
-
-```shell
-# rest_api_generator:spec:rswag or rest_api_generator:spec:rspec
-rails g rest_api_generator:spec:rswag Car name:string color:string
-```
-
-#### Configuration for specs
-
-By default, the plain rspec and rswag specs are going to be generated in the _spec/requests_ and _spec/docs_
-directories, respectively. You can override using the (config options)[#configuration]]. :
-
-
-### Resource Features
-
-#### Modular Error Handler
-
-The error module will return a json in this following format when any active record or custom error raises.
-
-```json
-{
-  "status": 422,
-  "error": "",
-  "message": ""
-}
-```
-
-This is good to padronize the error handler in front-end too.
-
-#### Ordering
-
-For ordering use this format:
-
-- Ordering asc: `GET /cars?sort=+name or GET /cars?sort=name`
-- Ordering desc: `GET /card?sort=-name`
-
-By default, every resource column can be the key for ordering.
-
-#### Filtering
-
-For filter is needed to add some scopes in Model file, example:
-
-```ruby
-# app/models/car.rb
-
-class Car < ApplicationRecord
-  include RestApiGenerator::Filterable
-
-  filter_scope :filter_by_color, ->(color) { where(color: color) }
-  filter_scope :filter_by_name, ->(name) { where("name LIKE ?", "%#{name}%") }
-end
-```
-
-And It's done, you can filter your index end-point:
-
-- `GET /cars?color=blue or GET /cars?color=red&name=Ferrari`
-
-### Pagination
-
-For pagination, you need to create pagy initialializer file (pagy.rb) in the config directory of your project. Follow [pagy's example](https://ddnexus.github.io/pagy/quick-start/) for more information.
-
-Next, you should add some lines on top of the previously created pagy file:
-
-```ruby
-# config/initializers/pagy.rb
-require "pagy"
-require "pagy/extras/headers"
-```
-
-At last, change the pagination variable on RestApiGenerator initializer to true;
-
-```rb
-# config/initializers/rest_api_generator.rb 
-config.pagination = true # default: false
-```
-
-Note, if the parent controller is changed, it is necessary to include Pagy::Backend in the new parent.
-
-```rb
-# new_parent_controller.rb 
-class NewParentController < ActionController::Base
-  include Pagy::Backend
-end
-```
-
-## Configuration
-
-You can override this gem configuration using the initializer or any other method from [anyway_config](https://github.com/palkan/anyway_config):
-
-```rb
-# config/initializers/rest_api_generator.rb 
-
-RestApiGenerator.configure do |config|
-  config.test_path = "custom_test_dir/requests" # default: spec/requests
-  config.docs_path = "custom_docs_dir/rswag" # default: spec/docs
-  config.parent_class = "ApplicationController" # default: RestApiGenerator::ResourceController
-  config.pagination = true # default: false
-end
-```
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can

data/app/controllers/rest_api_generator/child_resource_controller.rb

@@ -2,7 +2,9 @@
 
 module RestApiGenerator
   class ChildResourceController < RestApiGenerator.configuration.parent_controller.constantize
+    include ControllerCallbacks
     include Orderable
+    include Serializable
 
     before_action :set_parent_resource
     before_action :set_resource, only: [:show, :update, :destroy]
@@ -15,21 +17,21 @@ module RestApiGenerator
         @pagy, @resources = pagy(@resources)
         pagy_headers_merge(@pagy)
       end
-      render json: @resources, status: :ok
+      render json: index_serializer(@resources), status: :ok
     end
 
     def show
-      render json: @resource, status: :ok
+      render json: serializer(@resource), status: :ok
     end
 
     def create
       @resource = resources.create!(resource_created_params)
-      render json: @resource, status: :created
+      render json: serializer(@resource), status: :created
     end
 
     def update
       @resource.update!(resource_updated_params)
-      render json: @resource, status: :ok
+      render json: serializer(@resource), status: :ok
     end
 
     def destroy
@@ -73,11 +75,15 @@ module RestApiGenerator
 
     # Before actions
     def set_parent_resource
-      @parent_resource = parent_resource_class.find(parent_record_id)
+      run_callbacks :set_parent_resource do
+        @parent_resource = parent_resource_class.find(parent_record_id)
+      end
     end
 
     def set_resource
-      @resource = resources.find(record_id)
+      run_callbacks :set_resource do
+        @resource = resources.find(record_id)
+      end
     end
 
     # UsersController => User

data/app/controllers/rest_api_generator/resource_controller.rb

@@ -2,10 +2,11 @@
 
 module RestApiGenerator
   class ResourceController < RestApiGenerator.configuration.parent_controller.constantize
+    include ControllerCallbacks
     include Orderable
+    include Serializable
 
     before_action :set_resource, only: [:show, :update, :destroy]
-
     def index
       @resources = resource_class.all
       @resources = @resources.filter_resource(params_for_filter) if resource_class.include?(Filterable)
@@ -14,21 +15,21 @@ module RestApiGenerator
         @pagy, @resources = pagy(@resources)
         pagy_headers_merge(@pagy)
       end
-      render json: @resources, status: :ok
+      render json: index_serializer(@resources), status: :ok
     end
 
     def show
-      render json: @resource, status: :ok
+      render json: serializer(@resource), status: :ok
     end
 
     def create
       @resource = resource_class.create!(resource_created_params)
-      render json: @resource, status: :created
+      render json: serializer(@resource), status: :created
     end
 
     def update
       @resource.update!(resource_updated_params)
-      render json: @resource, status: :ok
+      render json: serializer(@resource), status: :ok
     end
 
     def destroy
@@ -62,7 +63,9 @@ module RestApiGenerator
     end
 
     def set_resource
-      @resource = resource_class.find(record_id)
+      run_callbacks :set_resource do
+        @resource = resource_class.find(record_id)
+      end
     end
 
     # UsersController => User

data/lib/rest_api_generator/controller_callbacks.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RestApiGenerator
+  module ControllerCallbacks
+    extend ActiveSupport::Concern
+    include ActiveSupport::Callbacks
+
+    included do
+      define_callbacks :set_resource
+      define_callbacks :set_parent_resource
+    end
+
+    module ClassMethods
+      # Code from rails source code
+      [:before, :after, :around].each do |callback|
+        define_method "#{callback}_set_resource" do |*names, &blk|
+          _insert_callbacks(names, blk) do |name, options|
+            set_callback(:set_resource, callback, name, options)
+          end
+        end
+
+        define_method "#{callback}_set_parent_resource" do |*names, &blk|
+          _insert_callbacks(names, blk) do |name, options|
+            set_callback(:set_parent_resource, callback, name, options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rest_api_generator/serializable.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/concern"
+
+module RestApiGenerator
+  module Serializable
+    extend ActiveSupport::Concern
+
+    def serializer(resource)
+      resource
+    end
+
+    def index_serializer(resources)
+      serializer(resources)
+    end
+  end
+end

data/lib/rest_api_generator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RestApiGenerator
-  VERSION = "0.1.7"
+  VERSION = "0.3.0"
 end

data/lib/rest_api_generator.rb

@@ -8,6 +8,8 @@ require_relative "rest_api_generator/custom_error"
 require_relative "rest_api_generator/helpers/render"
 require_relative "rest_api_generator/filterable"
 require_relative "rest_api_generator/orderable"
+require_relative "rest_api_generator/serializable"
+require_relative "rest_api_generator/controller_callbacks"
 
 module RestApiGenerator
   class Error < StandardError; end

data/rest-api-generator.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/SwitchDreams/rest-api-generator"
   spec.metadata["changelog_uri"] = "https://github.com/SwitchDreams/rest-api-generator"
+  spec.metadata["github_repo"] = "https://github.com/SwitchDreams/rest-api-generator"
 
   spec.files = Dir["{bin,sig,lib,public,app}/**/*",
     "MIT-LICENSE",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest-api-generator
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.3.0
 platform: ruby
 authors:
 - PedroAugustoRamalhoDuarte
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-26 00:00:00.000000000 Z
+date: 2023-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -155,12 +155,14 @@ files:
 - lib/rest-api-generator.rb
 - lib/rest_api_generator.rb
 - lib/rest_api_generator/config.rb
+- lib/rest_api_generator/controller_callbacks.rb
 - lib/rest_api_generator/custom_error.rb
 - lib/rest_api_generator/error_handler.rb
 - lib/rest_api_generator/filterable.rb
 - lib/rest_api_generator/helpers/render.rb
 - lib/rest_api_generator/orderable.rb
 - lib/rest_api_generator/rails.rb
+- lib/rest_api_generator/serializable.rb
 - lib/rest_api_generator/version.rb
 - rest-api-generator.gemspec
 - sig/rest_api_generator.rbs
@@ -172,6 +174,7 @@ metadata:
   homepage_uri: https://github.com/SwitchDreams/rest-api-generator
   source_code_uri: https://github.com/SwitchDreams/rest-api-generator
   changelog_uri: https://github.com/SwitchDreams/rest-api-generator
+  github_repo: https://github.com/SwitchDreams/rest-api-generator
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []