What has changed
Corinna here. Brian built an amazing generator but it needed a serious update for 2021. I removed the
database-cleaner gem, pulled the version number out of SQLite and updated ActiveRecord to 5.2 (due to the compatibility issues with SQLite and ActiveRecord 6.1). I also added in Pry as a
rake console as that's a common add in that we use at Flatiron School. Please feel free to change it if you prefer a different console, like tux. That's still in the gemfile! I also updated the ActiveRecord migration error to be compatible with the newer version of ActiveRecord.
Why this exists
rails new APP-NAME
Hazel was the closest thing I could find and this gem is based largely off of it. While it did provide a pretty good initial setup, I still had to tweak some things. The views were sitting in the root directory while I wanted them to reside in an app folder along with my models and controllers. There was also no environment.rb in the config folder as I had become accustom to having.
I also wanted to create a gem for future Learn students so they could easily get started building their projects. Although built with them in mind, this can get you off and running with any Sinatra app.
Install the gem, run
corneal new APP-NAME, run
bundle install, and you're all set! You can start up your server with
shotgun and verify everything is working. It is as simple as that.
It uses a file structure similar to what you would see with Rails.
gem install corneal
corneal -v # Show Corneal version number corneal help [COMMAND] # Describe available commands or one specific command corneal new APP-NAME # Creates a new Sinatra application corneal model NAME # Generate a model corneal controller NAME # Generate a controller corneal scaffold NAME # Generate a model with its associated views and controllers
The controller generator also have an optional views flag
--no-views to create controllers without views.
To generate your app:
corneal new APP-NAME
After Corneal is done generating your app, run
bundle install from your app's directory:
cd APP-NAME bundle install
You can then start your server with
You can generate a model and migration file:
corneal model NAME
You can also generate an entire MVC structure complete with a migration file:
corneal scaffold NAME
The resulting structure will look like this:
└─app ├── controllers │ ├──application_controller.rb │ └──new_model_controller.rb ├── models │ └──new_model.rb └── views ├──new_models │ ├──index.html.rb.erb │ ├──show.html.rb.erb │ ├──new.html.rb.erb │ └──edit.html.rb.erb ├── layout.erb └── welcome.erb
You can also add your model attributes when you generate the scaffold structure and have them added to your migration file:
corneal [model/scaffold] NAME name:string age:integer
class CreateUsers < ActiveRecord::Migration def change create_table :users do |t| t.string :name t.age :integer t.timestamps null: false end end end
Visit http://localhost:9393/ to verify your app is running.
You can also verify it is working by running
rspec to see the passing test:
1 example, 0 failures
Bug reports and pull requests are welcome on GitHub at https://github.com/thebrianemory/corneal 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.
Copyright (c) 2016 Brian Emory Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.