https://github.com/iftheshoefritz/solargraph-rails
Solargraph plugin to add awareness of Rails-specific code
https://github.com/iftheshoefritz/solargraph-rails
Last synced: 5 months ago
JSON representation
Solargraph plugin to add awareness of Rails-specific code
- Host: GitHub
- URL: https://github.com/iftheshoefritz/solargraph-rails
- Owner: iftheshoefritz
- License: mit
- Created: 2020-11-03T04:52:16.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-23T19:33:15.000Z (10 months ago)
- Last Synced: 2024-11-17T14:14:15.300Z (5 months ago)
- Language: Ruby
- Size: 7.74 MB
- Stars: 322
- Watchers: 10
- Forks: 30
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
- stars - iftheshoefritz/solargraph-rails - Solargraph plugin to add awareness of Rails-specific code (Ruby)
README
# Solargraph::Rails - Help solargraph with Rails
## Models
Given a typical Rails model like this:```ruby
# == Schema Information
#
# Table name: my_books
#
# id :integer not null, primary key
# author :string
# name :string
# created_at :datetime not null
# updated_at :datetime not null
#
class MyBook < ApplicationRecord
def my_method
"hello"
end...
end
```The various Ruby intellisense tools are ok at knowing that there is a `MyBook` constant, and some (including Solargraph) are aware that objects like `MyBook.new` have a method `.my_method`. But what about those magical dynamic attributes that ActiveRecord creates when Rails starts up? You can see these listed at the top of the file under `# == Schema Information`, the comments helpfully added by the Annotate gem.
Since these attributes are only created at runtime, static analysis alone can't identify them. Your editor has no idea that these attributes exist, but they're amongst the most common things that you will work with in any Rails app.
That's where this plugin for Solargraph comes in: it parses the database schema and YARD docs of various gems to give Solargraph some extra hints. For instance database attributes:
... or ActiveRecord finders:
... or associations:
... or routes file:
and more!
## Installation
### Install `solargraph` and `solargraph-rails`
If you add them to your Gemfile, you'll have to tell your IDE plugin to use bundler to load the right version of solargraph.
### Add `solargraph-rails` to your `.solargraph.yml`
(if you don't have a `.solargraph.yml` in your project root, you can run `solargraph config` to add one)
```
plugins:
- solargraph-rails
```### Build YARD docs
In the project root, run `yard gems`.## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/iftheshoefritz/solargraph_rails.1. create fork and clone the repo
2. install gem deps `bundle install`
3. install dummy rails app deps and build the yard cache:
```
$ cd spec/rails5
$ bundle install && yard gems
$ cd ../../
```(and the same for rails 6 and rails 7)
4. now tests should pass locally and you can try different changes
5. submit PR
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).