rundoc 0.0.1 → 0.0.2

data/test/fixtures/rails_5/rundoc.md

@@ -0,0 +1,443 @@
+```
+:::- rundoc
+email = ENV['HEROKU_EMAIL'] || `heroku auth:whoami`
+
+Rundoc.configure do |config|
+  config.project_root = "myapp"
+  config.filter_sensitive(email => "developer@example.com")
+end
+```
+<!--
+  rundoc src:
+  https://github.com/schneems/rundoc/blob/master/test/fixtures/rails_5/rundoc.md
+
+  Command:
+  $ bin/rundoc build --path test/fixtures/rails_5/rundoc.md
+-->
+
+Ruby on Rails is a popular web framework written in [Ruby](http://www.ruby-lang.org/). This guide covers using Rails 5 on Heroku. For information about running previous versions of Rails on Heroku, see [Getting Started with Rails 4.x on Heroku](getting-started-with-rails4) or [Getting Started with Rails 3.x on Heroku](getting-started-with-rails3).
+
+For this guide you will need:
+
+- Basic Ruby/Rails knowledge.
+- A locally installed version of Ruby 2.2.0+, Rubygems, Bundler, and Rails 5+.
+- Basic Git knowledge.
+- A Heroku user account: [Signup is free and instant](https://signup.heroku.com/devcenter).
+
+## Local workstation setup
+
+Install the [Heroku Toolbelt](https://toolbelt.heroku.com/) on your local workstation. This ensures that you have access to the [Heroku command-line client](/categories/command-line), Heroku Local, and the Git revision control system. You will also need [Ruby and Rails installed](http://guides.railsgirls.com/install).
+
+Once installed, you'll have access to the `$ heroku` command from your command shell. Log in using the email address and password you used when creating your Heroku account:
+
+
+> callout Note that `$` symbol before commands indicates they should be run on the command line, prompt, or terminal with appropriate permissions. Do not copy the `$` symbol.
+
+```term
+$ heroku login
+Enter your Heroku credentials.
+Email: schneems@example.com
+Password:
+Could not find an existing public key.
+Would you like to generate one? [Yn]
+Generating new SSH public key.
+Uploading ssh public key /Users/adam/.ssh/id_rsa.pub
+```
+
+Press enter at the prompt to upload your existing `ssh` key or create a new one, used for pushing code later on.
+
+## Write your app
+
+> callout To run on Heroku, your app must be configured to use the Postgres database, have all dependencies declared in your `Gemfile`.
+
+
+If you are starting from an existing app, [upgrade to Rails 5](http://edgeguides.rubyonrails.org/upgrading_ruby_on_rails.html#upgrading-from-rails-4-2-to-rails-5-0) before continuing. If not, a vanilla Rails 5 app will serve as a suitable sample app. To build a new app make sure that you're using the Rails 5.x using `$ rails -v`. You can get the new version of rails by running,
+
+```term
+:::>> $ gem install rails --no-ri --no-rdoc
+```
+
+Then create a new app:
+
+```term
+:::> $ rails new myapp --database=postgresql
+```
+
+Then move into your application directory.
+
+```term
+:::> $ cd myapp
+```
+
+> callout If you experience problems or get stuck with this tutorial, your questions may be answered in a later part of this document. If you experience a problem, try reading through the entire document and then go back to your issue. It can also be useful to review your previous steps to ensure they all executed correctly.
+
+## Database
+
+If you already have an app that was created without specifying `--database=postgresql` you will need to add the `pg` gem to your Rails project. Edit your `Gemfile` and change this line:
+
+```ruby
+gem 'sqlite3'
+```
+
+To this:
+
+```ruby
+gem 'pg'
+```
+
+> callout We highly recommend using PostgreSQL during development. Maintaining [parity between your development](http://www.12factor.net/dev-prod-parity) and deployment environments prevents subtle bugs from being introduced because of differences between your environments. [Install Postgres locally](https://devcenter.heroku.com/articles/heroku-postgresql#local-setup) now if it is not already on your system.
+
+Now re-install your dependencies (to generate a new `Gemfile.lock`):
+
+```ruby
+$ bundle install
+```
+
+To get more information on why this change is needed and how to configure your app to run Postgres locally, see [why you cannot use Sqlite3 on Heroku](https://devcenter.heroku.com/articles/sqlite3).
+
+In addition to using the `pg` gem, you'll also need to ensure the `config/database.yml` is using the `postgresql` adapter.
+
+The development section of your `config/database.yml` file should look something like this:
+
+```term
+:::>>  $ cat config/database.yml
+```
+
+Be careful here. If you omit the `sql` at the end of `postgresql` in the `adapter` section, your application will not work.
+
+## Welcome page
+
+Rails 5 no longer has a static index page in production. When you're using a new app, there will not be a root page in production, so we need to create one. We will first create a controller called `welcome` for our home page to live:
+
+```term
+:::> $ rails generate controller welcome
+```
+
+Next we'll add an index page.
+
+```html
+:::>> file.write app/views/welcome/index.html.erb
+<h2>Hello World</h2>
+<p>
+  The time is now: <%= Time.now %>
+</p>
+```
+
+Now we need to make Rails route to this action. We'll edit `config/routes.rb` to set the index page to our new method:
+
+```ruby
+:::>> file.append config/routes.rb#2
+  root 'welcome#index'
+```
+
+You can verify that the page is there by running your server:
+
+```term
+$ rails server
+```
+
+And visiting [http://localhost:3000](http://localhost:3000) in your browser. If you do not see the page, [use the logs](#view-the-logs) that are output to your server to debug.
+
+## Heroku gems
+
+Previous versions of Rails required you to add a gem to your project [rails_12factor](https://github.com/heroku/rails_12factor) to enable static asset serving and logging on Heroku. If you are deploying a new application this gem is not needed. If you are upgrading an existing application you can remove this gem provided you have the apprpriate configuration in your `config/environments/production.rb` file:
+
+```ruby
+# config/environments/production.rb
+config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+if ENV["RAILS_LOG_TO_STDOUT"].present?
+  logger           = ActiveSupport::Logger.new(STDOUT)
+  logger.formatter = config.log_formatter
+  config.logger = ActiveSupport::TaggedLogging.new(logger)
+end
+```
+
+## Specify Ruby version in app
+
+Rails 5 requires Ruby 2.2.0 or above. Heroku has a recent version of Ruby installed by default, however you can specify an exact version by using the `ruby` DSL in your `Gemfile`.
+
+```ruby
+:::>> file.append Gemfile
+ruby "2.4.1"
+```
+
+You should also be running the same version of Ruby locally. You can check this by running `$ ruby -v`. You can get more information on [specifying your Ruby version on Heroku here](https://devcenter.heroku.com/articles/ruby-versions).
+
+## Store your app in Git
+
+Heroku relies on [Git](http://git-scm.com/), a distributed source control management tool, for deploying your project. If your project is not already in Git, first verify that `git` is on your system:
+
+```term
+:::>  $ git --help
+:::>> | $ head -n 5
+```
+
+If you don't see any output or get `command not found` you will need to install it on your system. Verify that the [Heroku toolbelt](https://toolbelt.heroku.com/) is installed.
+
+Once you've verified that Git works, first make sure you are in your Rails app directory by running `$ ls`:
+
+The output should look like this:
+
+```term
+:::>> $ ls
+```
+
+Now run these commands in your Rails app directory to initialize and commit your code to Git:
+
+```term
+:::> $ git init
+:::> $ git add .
+:::> $ git commit -m "init"
+```
+
+You can verify everything was committed correctly by running:
+
+```term
+:::>> $ git status
+```
+
+Now that your application is committed to Git you can deploy to Heroku.
+
+## Deploy your application to Heroku
+
+Make sure you are in the directory that contains your Rails app, then create an app on Heroku:
+
+```term
+:::>> $ heroku create
+```
+
+You can verify that the remote was added to your project by running:
+
+```term
+:::>> $ git config --list | grep heroku
+```
+
+If you see `fatal: not in a git directory` then you are likely not in the correct directory. Otherwise you may deploy your code. After you deploy your code, you will need to migrate your database, make sure it is properly scaled, and use logs to debug any issues that come up.
+
+Deploy your code:
+
+```term
+:::>> $ git push heroku master
+```
+
+It is always a good idea to check to see if there are any warnings or errors in the output. If everything went well you can migrate your database.
+
+## Migrate your database
+
+If you are using the database in your application you need to manually migrate the database by running:
+
+```term
+$ heroku run rake db:migrate
+```
+
+Any commands after the `heroku run` will be executed on a Heroku [dyno](dynos). You can obtain an interactive shell session by running `$ heroku run bash`.
+
+## Visit your application
+
+You've deployed your code to Heroku. You can now instruct Heroku to execute a process type. Heroku does this by running the associated command in a [dyno](dynos), which is a lightweight container that is the basic unit of composition on Heroku.
+
+Let's ensure we have one dyno running the `web` process type:
+
+```term
+:::> $ heroku ps:scale web=1
+```
+
+You can check the state of the app's dynos. The `heroku ps` command lists the running dynos of your application:
+
+```term
+:::>> $ heroku ps
+```
+
+Here, one dyno is running.
+
+We can now visit the app in our browser with `heroku open`.
+
+```term
+:::>> $ heroku open
+```
+
+You should now see the "Hello World" text we inserted above.
+
+Heroku gives you a default web URL for simplicity while you are developing. When you are ready to scale up and use Heroku for production you can add your own [custom domain](https://devcenter.heroku.com/articles/custom-domains).
+
+## View the logs
+
+If you run into any problems getting your app to perform properly, you will need to check the logs.
+
+You can view information about your running app using one of the [logging commands](logging), `heroku logs`:
+
+```term
+:::>> $ heroku logs
+```
+
+You can also get the full stream of logs by running the logs command with the `--tail` flag option like this:
+
+```term
+$ heroku logs --tail
+```
+
+## Dyno sleeping and scaling
+
+By default, new applications are deployed to a free dyno. Free apps will "sleep" to conserve resources. You can find more information about this behavior by reading about [free dyno behavior](https://devcenter.heroku.com/articles/free-dyno-hours).
+
+To avoid dyno sleeping, you can upgrade to a hobby or professional dyno type as described in the [Dyno Types](dyno-types) article. For example, if you migrate your app to a professional dyno, you can easily scale it by running a command telling Heroku to execute a specific number of dynos, each running your web process type.
+
+## Rails console
+
+Heroku allows you to run commands in a [one-off dyno](one-off-dynos) - scripts and applications that only need to be executed when needed - using the `heroku run` command. Use this to launch a Rails console process attached to your local terminal for experimenting in your app's environment:
+
+```term
+$ heroku run rails console
+irb(main):001:0> puts 1+1
+2
+```
+
+Another useful command for debugging is `$ heroku run bash` which will spin up a new dyno and give you access to a bash session.
+
+## Rake
+
+Rake can be run as an attached process exactly like the console:
+
+```term
+$ heroku run rake db:migrate
+```
+
+## Webserver
+
+By default, your app's web process runs `rails server`, which uses Puma in Rails 5. If you are upgrading an app you'll need to add `puma` to your application `Gemfile`:
+
+```ruby
+gem 'puma'
+```
+
+Then run
+
+```term
+:::> $ bundle install
+```
+
+Now you are ready to configure your app to use Puma. For this tutorial we will use the default `config/puma.rb` of that ships with Rails 5, but we recommend reading more about configuring your application for maximum performance by [reading the Puma documentation](https://devcenter.heroku.com/articles/deploying-rails-applications-with-the-puma-web-server).
+
+Finally you will need to tell Heroku how to run your Rails app by creating a `Procfile` in the root of your application directory.
+
+### Procfile
+
+Change the command used to launch your web process by creating a file called [Procfile](procfile) and entering this:
+
+```
+:::>> file.write Procfile
+web: bundle exec puma -t 5:5 -p ${PORT:-3000} -e ${RACK_ENV:-development}
+```
+
+> Note: The case of `Procfile` matters, the first letter must be uppercase.
+
+We recommend generating a Puma config file based on [our Puma documentation](https://devcenter.heroku.com/articles/deploying-rails-applications-with-the-puma-web-server) for maximum performance.
+
+To use the Procfile locally you can use `heroku local`.
+
+In addition to running commands in your `Procfile` `heroku local` can also help you manage environment variables locally through a `.env` file. Set the local `RACK_ENV` to development in your environment and a `PORT` to connect to. Before pushing to Heroku you'll want to test with the `RACK_ENV` set to production since this is the environment your Heroku app will run in.
+
+```term
+:::>> $ echo "RACK_ENV=development" >>.env
+:::>> $ echo "PORT=3000" >> .env
+```
+
+> Note: Another alternative to using environment variables locally with a `.env` file is the [dotenv](https://github.com/bkeepers/dotenv) gem.
+
+You'll also want to add `.env` to your `.gitignore` since this is for local environment setup.
+
+```term
+:::> $ echo ".env" >> .gitignore
+:::> $ git add .gitignore
+:::> $ git commit -m "add .env to .gitignore"
+```
+
+Test your Procfile locally using Foreman. You can now start your web server by running:
+
+```term
+$ heroku local
+[OKAY] Loaded ENV .env File as KEY=VALUE Format
+11:06:35 AM web.1   |  [18878] Puma starting in cluster mode...
+11:06:35 AM web.1   |  [18878] * Version 3.8.2 (ruby 2.4.1-p111), codename: Sassy Salamander
+11:06:35 AM web.1   |  [18878] * Min threads: 5, max threads: 5
+11:06:35 AM web.1   |  [18878] * Environment: development
+11:06:35 AM web.1   |  [18878] * Process workers: 2
+11:06:35 AM web.1   |  [18878] * Preloading application
+```
+
+Looks good, so press `Ctrl+C` to exit and you can deploy your changes to Heroku:
+
+```term
+:::> $ git add .
+:::> $ git commit -m "use puma via procfile"
+:::> $ git push heroku master
+```
+
+Check `ps`. You'll see that the web process uses your new command specifying Puma as the web server.
+
+```term
+:::>> $ heroku ps
+```
+
+The logs also reflect that we are now using Puma.
+
+```term
+$ heroku logs
+```
+
+## Rails asset pipeline
+
+There are several options for invoking the [Rails asset pipeline](http://guides.rubyonrails.org/asset_pipeline.html) when deploying to Heroku. For general information on the asset pipeline please see the [Rails 3.1+ Asset Pipeline on Heroku Cedar](rails-asset-pipeline) article.
+
+The `config.assets.initialize_on_precompile` option has been removed is and not needed for Rails 5. Also, any failure in asset compilation will now cause the push to fail. For Rails 5 asset pipeline support see the [Ruby Support](https://devcenter.heroku.com/articles/ruby-support#rails-5-x-applications) page.
+
+## Troubleshooting
+
+If you push up your app and it crashes (`heroku ps` shows state `crashed`), check your logs to find out what went wrong. Here are some common problems.
+
+### Runtime dependencies on development/test gems
+
+If you're missing a gem when you deploy, check your Bundler groups. Heroku builds your app without the `development` or `test` groups, and if your app depends on a gem from one of these groups to run, you should move it out of the group.
+
+One common example is using the RSpec tasks in your `Rakefile`. If you see this in your Heroku deploy:
+
+```term
+$ heroku run rake -T
+Running `bundle exec rake -T` attached to terminal... up, ps.3
+rake aborted!
+no such file to load -- rspec/core/rake_task
+```
+Then you've hit this problem. First, duplicate the problem locally:
+
+```term
+$ bundle install --without development:test
+…
+$ bundle exec rake -T
+rake aborted!
+no such file to load -- rspec/core/rake_task
+```
+
+> Note: The `--without` option on bundler is sticky. You can get rid of this option by running `bundle config --delete without`.
+
+Now you can fix it by making these Rake tasks conditional on the gem load. For example:
+
+```ruby
+begin
+  require "rspec/core/rake_task"
+
+  desc "Run all examples"
+
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = %w[--color]
+    t.pattern = 'spec/**/*_spec.rb'
+  end
+rescue LoadError
+end
+```
+
+Confirm it works locally, then push to Heroku.
+
+## Done
+
+You have deployed your first application to Heroku. The next step is to deploy your own application. You can read more about Ruby on Heroku at the [Dev Center](https://devcenter.heroku.com/categories/ruby).