ay9.netlify.com

• Rails Secret Key Base
• Rails 5 Generate Secret Key Code
• Rails 5 Generate Secret Key Card
• Rails Generate Model Foreign Key
• Rails 5 Generate Secret Key Generator

This tutorial assumes you have basic Rails knowledge from reading the Getting Started with Rails Guide.

1 Command Line Basics

There are a few commands that are absolutely critical to your everyday usage of Rails. In the order of how much you'll probably use them are:

Mar 24, 2018 In Rails 5.1 there were two files secrets.yml.enc and secrets.yml and it was creating confusion for our beloved SECRETBASEKEY. To remove this dilemma Rails core team decided to remove those two files and having only one file where you can store your all secret stuff like AWS key, database password, API keys and whatever which you want to make. RandomKeygen is a free mobile-friendly tool that offers randomly generated keys and passwords you can use to secure any application, service or device. KEY RandomKeygen - The Secure Password & Keygen Generator.

• rails console
• rails server
• rails test
• rails generate
• rails db:migrate
• rails db:create
• rails routes
• rails dbconsole
• rails new app_name

You can get a list of rails commands available to you, which will often depend on your current directory, by typing rails --help. Each command has a description, and should help you find the thing you need.

Let's create a simple Rails application to step through each of these commands in context.

1.1 rails new

The first thing we'll want to do is create a new Rails application by running the rails new command after installing Rails.

You can install the rails gem by typing gem install rails, if you don't have it already.

Rails will set you up with what seems like a huge amount of stuff for such a tiny command! You've got the entire Rails directory structure now with all the code you need to run our simple application right out of the box.

1.2 rails server

The rails server command launches a web server named Puma which comes bundled with Rails. You'll use this any time you want to access your application through a web browser.

With no further work, rails server will run our new shiny Rails app:

With just three commands we whipped up a Rails server listening on port 3000. Go to your browser and open http://localhost:3000, you will see a basic Rails app running.

You can also use the alias 's' to start the server: rails s.

The server can be run on a different port using the -p option. The default development environment can be changed using -e.

The -b option binds Rails to the specified IP, by default it is localhost. You can run a server as a daemon by passing a -d option.

1.3 rails generate

The rails generate command uses templates to create a whole lot of things. Running rails generate by itself gives a list of available generators:

You can also use the alias 'g' to invoke the generator command: rails g.

You can install more generators through generator gems, portions of plugins you'll undoubtedly install, and you can even create your own!

Using generators will save you a large amount of time by writing boilerplate code, code that is necessary for the app to work.

Let's make our own controller with the controller generator. But what command should we use? Let's ask the generator:

All Rails console utilities have help text. As with most *nix utilities, you can try adding --help or -h to the end, for example rails server --help.

The controller generator is expecting parameters in the form of generate controller ControllerName action1 action2. Let's make a Greetings controller with an action of hello, which will say something nice to us.

What all did this generate? It made sure a bunch of directories were in our application, and created a controller file, a view file, a functional test file, a helper for the view, a JavaScript file, and a stylesheet file.

Check out the controller and modify it a little (in app/controllers/greetings_controller.rb):

Then the view, to display our message (in app/views/greetings/hello.html.erb):

Fire up your server using rails server.

The URL will be http://localhost:3000/greetings/hello.

With a normal, plain-old Rails application, your URLs will generally follow the pattern of http://(host)/(controller)/(action), and a URL like http://(host)/(controller) will hit the index action of that controller.

Rails comes with a generator for data models too.

For a list of available field types for the type parameter, refer to the API documentation for the add_column method for the SchemaStatements module. The index parameter generates a corresponding index for the column.

But instead of generating a model directly (which we'll be doing later), let's set up a scaffold. A scaffold in Rails is a full set of model, database migration for that model, controller to manipulate it, views to view and manipulate the data, and a test suite for each of the above.

We will set up a simple resource called 'HighScore' that will keep track of our highest score on video games we play.

The generator checks that there exist the directories for models, controllers, helpers, layouts, functional and unit tests, stylesheets, creates the views, controller, model and database migration for HighScore (creating the high_scores table and fields), takes care of the route for the resource, and new tests for everything.

The migration requires that we migrate, that is, run some Ruby code (living in that 20130717151933_create_high_scores.rb) to modify the schema of our database. Which database? The SQLite3 database that Rails will create for you when we run the rails db:migrate command. We'll talk more about that command below.

Let's talk about unit tests. Unit tests are code that tests and makes assertionsabout code. In unit testing, we take a little part of code, say a method of a model,and test its inputs and outputs. Unit tests are your friend. The sooner you makepeace with the fact that your quality of life will drastically increase when you unittest your code, the better. Seriously. Please visitthe testing guide for an in-depthlook at unit testing.

Let's see the interface Rails created for us.

Go to your browser and open http://localhost:3000/high_scores, now we can create new high scores (55,160 on Space Invaders!)

1.4 rails console

The console command lets you interact with your Rails application from the command line. On the underside, rails console uses IRB, so if you've ever used it, you'll be right at home. This is useful for testing out quick ideas with code and changing data server-side without touching the website.

You can also use the alias 'c' to invoke the console: rails c.

You can specify the environment in which the console command should operate.

If you wish to test out some code without changing any data, you can do that by invoking rails console --sandbox.

1.4.1 The app and helper objects

Inside the rails console you have access to the app and helper instances.

With the app method you can access named route helpers, as well as do requests.

With the helper method it is possible to access Rails and your application's helpers.

1.5 rails dbconsole

rails dbconsole figures out which database you're using and drops you into whichever command line interface you would use with it (and figures out the command line parameters to give to it, too!). It supports MySQL (including MariaDB), PostgreSQL, and SQLite3.

You can also use the alias 'db' to invoke the dbconsole: rails db.

1.6 rails runner

runner runs Ruby code in the context of Rails non-interactively. For instance:

You can also use the alias 'r' to invoke the runner: rails r.

You can specify the environment in which the runner command should operate using the -e switch.

You can even execute ruby code written in a file with runner.

1.7 rails destroy

Think of destroy as the opposite of generate. It'll figure out what generate did, and undo it.

You can also use the alias 'd' to invoke the destroy command: rails d.

1.8 rails about

rails about gives information about version numbers for Ruby, RubyGems, Rails, the Rails subcomponents, your application's folder, the current Rails environment name, your app's database adapter, and schema version. It is useful when you need to ask for help, check if a security patch might affect you, or when you need some stats for an existing Rails installation.

1.9 rails assets:

You can precompile the assets in app/assets using rails assets:precompile, and remove older compiled assets using rails assets:clean. The assets:clean command allows for rolling deploys that may still be linking to an old asset while the new assets are being built.

If you want to clear public/assets completely, you can use rails assets:clobber.

1.10 rails db:

The most common commands of the db: rails namespace are migrate and create, and it will pay off to try out all of the migration rails commands (up, down, redo, reset). rails db:version is useful when troubleshooting, telling you the current version of the database.

More information about migrations can be found in the Migrations guide.

1.11 rails notes

rails notes searches through your code for comments beginning with a specific keyword. You can refer to rails notes --help for information about usage.

By default, it will search in app, config, db, lib, and test directories for FIXME, OPTIMIZE, and TODO annotations in files with extension .builder, .rb, .rake, .yml, .yaml, .ruby, .css, .js, and .erb.

1.11.1 Annotations

You can pass specific annotations by using the --annotations argument. By default, it will search for FIXME, OPTIMIZE, and TODO.Note that annotations are case sensitive.

1.11.2 Tags

You can add more default tags to search for by using config.annotations.register_tags. It receives a list of tags.

1.11.3 Directories

You can add more default directories to search from by using config.annotations.register_directories. It receives a list of directory names.

1.11.4 Extensions

Rails Secret Key Base

You can add more default file extensions to search from by using config.annotations.register_extensions. It receives a list of extensions with its corresponding regex to match it up.

1.12 rails routes

rails routes will list all of your defined routes, which is useful for tracking down routing problems in your app, or giving you a good overview of the URLs in an app you're trying to get familiar with.

1.13 rails test

A good description of unit testing in Rails is given in A Guide to Testing Rails Applications

Rails comes with a test framework called minitest. Rails owes its stability to the use of tests. The commands available in the test: namespace helps in running the different tests you will hopefully write.

1.14 rails tmp:

The Rails.root/tmp directory is, like the *nix /tmp directory, the holding place for temporary files like process id files and cached actions.

The tmp: namespaced commands will help you clear and create the Rails.root/tmp directory:

• rails tmp:cache:clear clears tmp/cache.
• rails tmp:sockets:clear clears tmp/sockets.
• rails tmp:screenshots:clear clears tmp/screenshots.
• rails tmp:clear clears all cache, sockets, and screenshot files.
• rails tmp:create creates tmp directories for cache, sockets, and pids.

1.15 Miscellaneous

• rails stats is great for looking at statistics on your code, displaying things like KLOCs (thousands of lines of code) and your code to test ratio.
• rails secret will give you a pseudo-random key to use for your session secret.
• rails time:zones:all lists all the timezones Rails knows about.

1.16 Custom Rake Tasks

Custom rake tasks have a .rake extension and are placed inRails.root/lib/tasks. You can create these custom rake tasks with therails generate task command.

To pass arguments to your custom rake task:

You can group tasks by placing them in namespaces:

Invocation of the tasks will look like:

If you need to interact with your application models, perform database queries, and so on, your task should depend on the environment task, which will load your application code.

2 The Rails Advanced Command Line

More advanced use of the command line is focused around finding useful (even surprising at times) options in the utilities, and fitting those to your needs and specific work flow. Listed here are some tricks up Rails' sleeve.

2.1 Rails with Databases and SCM

When creating a new Rails application, you have the option to specify what kind of database and what kind of source code management system your application is going to use. This will save you a few minutes, and certainly many keystrokes.

Let's see what a --git option and a --database=postgresql option will do for us:

We had to create the gitapp directory and initialize an empty git repository before Rails would add files it created to our repository. Let's see what it put in our database configuration:

It also generated some lines in our database.yml configuration corresponding to our choice of PostgreSQL for database.

The only catch with using the SCM options is that you have to make your application's directory first, then initialize your SCM, then you can run the rails new command to generate the basis of your app.

Feedback

You're encouraged to help improve the quality of this guide.

Please contribute if you see any typos or factual errors. To get started, you can read our documentation contributions section.

You may also find incomplete content or stuff that is not up to date. Please do add any missing documentation for master. Make sure to check Edge Guides first to verify if the issues are already fixed or not on the master branch. Check the Ruby on Rails Guides Guidelines for style and conventions.

If for whatever reason you spot something to fix but cannot patch it yourself, please open an issue.

And last but not least, any kind of discussion regarding Ruby on Rails documentation is very welcome on the rubyonrails-docs mailing list.

This article is a translation from https://qiita.com/kawasaki/items/dcaf5716c3fd5e2fe69f

Rails 5 Generate Secret Key Code

Digest version to set up the secret key in the production environment in Rails 5.1

1. $ rails secrets:setup -> copy the long secret key in the first line and set it as an environment variable RAILS_MASTER_KEY when executing rails
2. $ rails secret -> you will get the longer key; copy it
3. $ EDITOR=vim rails secrets:edit write the following and save it from vim

Errors in the production environment when I run 'rails server'

I've developped my application happily in the development environment. But it's high time I prepared for the production environment, and I tried

$ rails server --environment production

and got
An unhandled lowlevel error occurred. The application logs may have details.

Oh, no..
Next, I tried
$ rails secrets:setup

which was introduced in Rails 5.1. But the error still remained. Going down in to the rails library, I got the point where I was wrong.

Anyway, you'll get the following output wehn you run rails secrets:setup

Rails 5 Generate Secret Key Card

The encryption key 'a1e98ed29c40d7453a06bebeb815c0f3' in the first line is the most important key to protect the whole application and you must keep it secret. The key is automatically written down to config/secrets.yml.key.
Never commit it to your git repository, NEVER!
But usually you'll not commit it because the file config/secrets.yml.key is automatically added to .gitignore, so that the file is not to be committed.

For rails execution, you need either to import config/secrets.yml.key from somewhere or to set the secret key in the environment variable RAILS_MASTER_KEY.

Actually, this in only the half of the necessary settings because what you did is to make a key to lock config/secrets.yml.enc, you treasure box. You still need to store your treasure.
This file, secrets.yml.enc is an encrypted yml file using your key. It looks like as follows.

Rails Generate Model Foreign Key

To edit this file (if you use vim),
$ EDITOR=vim rails secrets:edit

The file looks like as follows.

Everything is commented out and nothing is specified above. You have to specify secret_key_base beneath production which is a secret key used for Cookie encryption. It is recommended to generate the secret key by using 'rails secret'.

Then, save it in your config/secrets.yml.enc by doing

Now, you have no error regarding the secret key in Rails.

By the way, you can store any kind of secret information here including database passwords. e.g.

Rails 5 Generate Secret Key Generator

You can use the encrypted database password from your code by
Rails.application.secrets.postgresql_password
e.g. in config/database.yml.