Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Inflect API #527

Merged
merged 1 commit into from
Nov 27, 2023
Merged

Inflect API #527

merged 1 commit into from
Nov 27, 2023

Conversation

santib
Copy link
Member

@santib santib commented Nov 23, 2023

API vs Api

@santib santib requested a review from a team November 23, 2023 18:50
@github-actions github-actions bot added the api_docs API Documentation label Nov 23, 2023
blacksam07
blacksam07 reviewed Nov 23, 2023
View reviewed changes
README.md
@@ -4,7 +4,7 @@
[![Code Climate](https://codeclimate.com/github/rootstrap/rails_api_base/badges/gpa.svg)](https://codeclimate.com/github/rootstrap/rails_api_base)
[![Test Coverage](https://api.codeclimate.com/v1/badges/63de7f82c79f5fe82f46/test_coverage)](https://codeclimate.com/github/rootstrap/rails_api_base/test_coverage)

Rails Api Base is a boilerplate project for JSON RESTful APIs. It follows the community best practices in terms of standards, security and maintainability, integrating a variety of testing and code quality tools. It's based on Rails 7.0 and Ruby 3.2.
Rails API Base is a boilerplate project for JSON RESTful APIs. It follows the community best practices in terms of standards, security and maintainability, integrating a variety of testing and code quality tools. It's based on Rails 7.0 and Ruby 3.2.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the latest change to include the ability to create fullstack project is possible that we need to update this description

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch

@santib santib requested a review from a team November 24, 2023 13:16
@TimoPeraza
Copy link
Contributor

Just to be curious, why is necessary this change?

@santib
Copy link
Member Author

santib commented Nov 27, 2023

Just to be curious, why is necessary this change?

Not necessary, I think it's just nicer to use API (which is an acronym) instead of Api.

For example Rails uses API
https://github.com/rails/rails/blob/f4b08457a4ab40418da9aa2155880fea32caf0fe/activemodel/lib/active_model/api.rb#L59.

But yeah in the end is just a matter of taste. Maybe we can do a poll?

Vote 👍 for API and 👎 for Api.

@megatux
Copy link
Contributor

megatux commented Nov 27, 2023

Just to be curious, why is necessary this change?

Not necessary, I think it's just nicer to use API (which is an acronym) instead of Api.

For example Rails uses API https://github.com/rails/rails/blob/f4b08457a4ab40418da9aa2155880fea32caf0fe/activemodel/lib/active_model/api.rb#L59.

But yeah in the end is just a matter of taste. Maybe we can do a poll?

Vote 👍 for API and 👎 for Api.

Definitely all in uppercase. There are several examples in the Ruby standard classes. Also, in Rubocop. I saw some old posts talking about defining the ActiveSupport::Inflector in the Rails init and talking about the convention for the autoloading. We should check if it still applies to Zeitwerk now.

@santib santib merged commit 7c28e78 into main Nov 27, 2023
3 checks passed
@santib santib deleted the inflect-api branch November 27, 2023 16:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@blacksam07 blacksam07 blacksam07 left review comments

@enzofab91 enzofab91 enzofab91 approved these changes

@axelpontetto axelpontetto axelpontetto approved these changes

@JulianPasquale JulianPasquale JulianPasquale approved these changes

Assignees
No one assigned
Labels
api_docs API Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@santib @TimoPeraza @megatux @enzofab91 @axelpontetto @JulianPasquale @blacksam07