rockstart 0.1.0 → 0.1.1

data/lib/generators/rockstart/{docker → deployment/docker}/templates/app/Dockerfile-app

@@ -4,10 +4,10 @@ FROM <%= @root_image %>
 RUN apt-get update -qq \
     && apt-get install -y build-essential \
     && apt-get install -y libxml2-dev libxslt1-dev \
-<%- if @postgres -%>
+<%- if postgres? -%>
     && apt-get install -y libpq-dev \
 <%- end -%>
-<%- if @assets -%>
+<%- if frontend? -%>
     && curl -sL https://deb.nodesource.com/setup_10.x | bash - \
     && curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - \
     && echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list \
@@ -16,7 +16,7 @@ RUN apt-get update -qq \
     && apt-get clean
 
 ENV RACK_ENV=production \
-<%- if @assets -%>
+<%- if frontend? -%>
     NODE_ENV=production \
 <%- end -%>
     RAILS_LOG_TO_STDOUT=true \
@@ -37,11 +37,12 @@ ADD . /<%= @app_home %>
 
 # Perform post-installation tasks
 RUN bundle exec rake tmp:create \
-<%- if @assets -%>
+<%- if frontend? -%>
     && bundle exec rake assets:precompile \
+    && bundle exec rake assets:clean \
 <%- end -%>
     && bundle exec rake tmp:clear
 
 # Start the application server
 EXPOSE 3000
-CMD ["bundle", "exec", "rails", "server", "-p", "3000", "-b", "0.0.0.0"]
+CMD ["bin/web"]

data/lib/generators/rockstart/{docker → deployment/docker}/templates/docker-compose.test.yml

@@ -10,11 +10,14 @@ services:
       - mailcatcher
     environment:
       - RAILS_ENV=test
-<%- if postgres? -%>
-      - TEST_DATABASE_URL=postgres://<%= app_name %>:<%= app_name %>_test@db/<%= app_name %>_test
+<%- if rollbar? -%>
+      - ROLLBAR_ENV=test-docker
 <%- end -%>
       - SMTP_SERVER=mailcatcher
       - SMTP_PORT=1025
+<%- if postgres? -%>
+      - TEST_DATABASE_URL=postgres://<%= app_name %>:<%= app_name %>_test@db/<%= app_name %>_test
+<%- end -%>
     env_file:
       - ./.env.test
 <%- if postgres? -%>

data/lib/generators/rockstart/deployment/docker/templates/docker-compose.yml

@@ -0,0 +1,74 @@
+version: '2.0'
+services:
+  web:
+    build: .
+    env_file:
+      - ./.env
+      - ./.env.docker
+    depends_on:
+<%- if postgres? -%>
+      - db
+<%- end -%>
+<%- if memcached? -%>
+      - memcached
+<%- end -%>
+<%- if sidekiq? -%>
+      - redis
+<%- end -%>
+    volumes:
+    - static-assets:/<%= @app_home %>/public
+    - local-storage:/<%= @app_home %>/storage
+<%- if postgres? -%>
+  db:
+    image: postgres
+    env_file:
+      - ./.env.docker-db
+    volumes:
+      - ./tmp/db:/var/lib/postgresql/data
+<%- end -%>
+  mailcatcher:
+    image: sj26/mailcatcher
+    ports:
+      - 1080:1080
+<%- if memcached? -%>
+  memcached:
+    image: memcached:alpine
+<%- end -%>
+<%- if sidekiq? -%>
+  redis:
+    image: redis:alpine
+<%- end -%>
+<%- if sidekiq? -%>
+  worker:
+    build: .
+    command: ./bin/worker
+    env_file:
+      - ./.env
+      - ./.env.docker
+    depends_on:
+<%- if postgres? -%>
+      - db
+<%- end -%>
+<%- if memcached? -%>
+      - memcached
+<%- end -%>
+      - redis
+<%- end -%>
+  web-nginx:
+    build:
+      context: ./docker/web/
+    depends_on:
+      - web
+    ports:
+      - 80:80
+      - 443:443
+      - 8000:443 # for development
+    volumes:
+      - ./certs/localhost:/<%= @app_home %>/certs
+      - static-assets:/<%= @app_home %>/public
+      - local-storage:/<%= @app_home %>/storage
+      - web-logs:/<%= @app_home %>/log
+volumes:
+  static-assets: {}
+  local-storage: {}
+  web-logs: {}

data/lib/generators/rockstart/deployment/docker/templates/dotenv.docker-db.tt

@@ -0,0 +1,3 @@
+POSTGRES_DB=<%= app_name %>_production
+POSTGRES_USER=<%= app_name %>
+POSTGRES_PASSWORD=<%= example_db_password %>

data/lib/generators/rockstart/deployment/docker/templates/dotenv.docker.tt

@@ -0,0 +1,20 @@
+APP_HOST=localhost
+<%- if postgres? -%>
+DATABASE_URL=postgres://<%= app_name %>:<%= example_db_password %>@db/<%= app_name %>_production
+<%- end -%>
+<%- if devise? -%>
+DEVISE_MAILER_SENDER=devise-mailer@<%= app_name %>
+<%- end -%>
+<%- if memcached? -%>
+MEMCACHE_SERVERS=memcached
+<%- end -%>
+OKCOMPUTER_USERNAME=okcomputer
+OKCOMPUTER_PASSWORD=okcomputer
+<%- if sidekiq? -%>
+REDIS_URL=redis://redis
+<%- end -%>
+<%- if rollbar? -%>
+ROLLBAR_ENV=development-docker
+<%- end -%>
+SMTP_SERVER=mailcatcher
+SMTP_PORT=1025

data/lib/generators/rockstart/{docker → deployment/docker}/templates/web/nginx.conf

@@ -1,5 +1,5 @@
 upstream rails_app {
-  server app:3000;
+  server web:3000;
 }
 
 server {
@@ -41,6 +41,25 @@ server {
     break;
   }
 
+  # Serve Sidekiq UI along with its assets
+  location /sidekiq/ {
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header X-Forwarded-Proto $scheme;
+    proxy_set_header Host $http_host;
+
+    proxy_redirect off;
+    proxy_pass http://rails_app/sidekiq/;
+  }
+
+  # Defines the internal location to support the X-Sendfile feature
+  # for the delivery of static files from the folder: /<%= @app_home %>/storage
+  # http://wiki.nginx.org/XSendfile
+  location /__storage/ {
+    internal;
+    alias /<%= @app_home %>/storage/;
+  }
+
   # send non-static file requests to the app server
   location / {
     try_files $uri @rails;
@@ -51,6 +70,10 @@ server {
     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
     proxy_set_header X-Forwarded-Proto $scheme;
     proxy_set_header Host $http_host;
+
+    proxy_set_header X-Sendfile-Type X-Accel-Redirect;
+    proxy_set_header X-Accel-Mapping /<%= @app_home %>/storage/=/__storage/;
+
     proxy_redirect off;
     proxy_pass http://rails_app;
   }

data/lib/generators/rockstart/deployment/heroku/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Configures a Rails app for quick deployment on Heroku
+
+Example:
+    rails generate rockstart:deployment:heroku
+
+    This will create:
+        A Procfile that runs the bin/hooks-release script
+        An app.json that prepares an app for a review build

data/lib/generators/rockstart/deployment/heroku/heroku_generator.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "rockstart/generators/class_option_helpers"
+require "rockstart/generators/template_helpers"
+
+module Rockstart::Deployment
+  class HerokuGenerator < Rails::Generators::Base
+    include Rails::Generators::AppName
+    include Rockstart::Generators::ClassOptionHelpers
+    include Rockstart::Generators::TemplateHelpers
+
+    source_root File.expand_path("templates", __dir__)
+
+    class_option :free_tier, type: :boolean,
+                             desc: "Prioritizes configratons and addons for the free tier",
+                             default: true
+
+    auth0_class_option
+    memcached_class_option
+    postgres_class_option
+    rollbar_class_option
+    sidekiq_class_option
+
+    def create_procfile
+      template "Procfile"
+    end
+
+    def create_app_json
+      template "app.json"
+    end
+
+    def add_slugignore
+      copy_file "slugignore", ".slugignore"
+    end
+
+    def add_rack_task
+      template "heroku.rake", "lib/tasks/heroku.rake"
+    end
+
+    def add_deploy_script
+      script_template "deploy-heroku"
+    end
+
+    private
+
+    def free_tier?
+      options.fetch(:free_tier)
+    end
+  end
+end

data/lib/generators/rockstart/deployment/heroku/templates/Procfile.tt

@@ -0,0 +1,5 @@
+release: ./bin/hooks-release
+web: ./bin/web
+<%- if sidekiq? -%>
+worker: ./bin/worker
+<%- end -%>

data/lib/generators/rockstart/deployment/heroku/templates/app.json.tt

@@ -0,0 +1,50 @@
+{
+  "name": "<%= app_name %>",
+  "addons": [
+<%- if auth0? -%>
+    {
+      "plan": "auth0:free",
+      "options": {
+        "type": "rails"
+      }
+    },
+<%- end -%>
+<% if free_tier? -%>
+    "cloudcube:free",
+<% end -%>
+<%- if postgres? -%>
+    "heroku-postgresql:hobby-dev",
+<%- end -%>
+<%- if sidekiq? -%>
+    "heroku-redis:hobby-dev",
+<%- end -%>
+<%- if memcached? -%>
+    "memcachier:dev",
+<%- end -%>
+    "papertrail:choklad",
+<%- if rollbar? -%>
+    "rollbar:free",
+<%- end -%>
+  ],
+  "env": {
+<% if free_tier? -%>
+    "DB_CONNECT_TIMEOUT": "5",
+<% end -%>
+    "OKCOMPUTER_USERNAME": {
+      "description": "The username for accessing the /health endpoint.",
+      "value": "okcomputer"
+    },
+    "OKCOMPUTER_PASSWORD": {
+      "description": "The password for accessing the /health endpoint.",
+      "generator": "secret"
+    },
+    "RAILS_ENV": "production",
+<%- if rollbar? -%>
+    "ROLLBAR_ENV": "development-heroku",
+<%- end -%>
+  },
+  "stack": "heroku-18",
+  "scripts": {
+    "postdeploy": "./bin/hooks-postdeploy"
+  },
+}

data/lib/generators/rockstart/deployment/heroku/templates/deploy-heroku.tt

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "fileutils"
+
+# deployment script generated by rockstart:deployment
+
+# path to your application root.
+APP_ROOT = File.expand_path("..", __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  puts "== Installing Heroku CLI =="
+  system! "which heroku && brew upgrade heroku/brew/heroku || " \
+          "(brew tap heroku/brew && brew install heroku)"
+
+  puts "\n== Creating Development App =="
+  system! "git remote show heroku || heroku create"
+
+  puts "\n== Configuring APP_HOST =="
+  current_app_host = `heroku config:get APP_HOST -s`.split("=").last
+  if current_app_host.strip.empty?
+    require "json"
+    app_host = JSON.parse(`heroku domains --json`).first.fetch("hostname")
+    system! "heroku config:set APP_HOST=#{app_host}"
+  else
+    puts "Skipping: APP_HOST has already been set to #{current_app_host}"
+  end
+
+  puts "\n== Pushing to Heroku =="
+  system! "git push heroku master"
+
+  puts "\n== Dumping Heroku Config =="
+  if !File.exists?(File.join(APP_ROOT, ".env"))
+    system! "bundle exec rake heroku:dump_config"
+  else
+    puts "Skipping: a .env file already exists."
+  end
+end

data/lib/generators/rockstart/deployment/heroku/templates/heroku.rake.tt

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+namespace :heroku do
+  ENV_VARIABLES = %w[
+<%- if auth0? -%>
+    AUTH0_CLIENT_ID
+    AUTH0_CLIENT_SECRET
+    AUTH0_DOMAIN
+<%- end -%>
+    CLOUDCUBE_ACCESS_KEY_ID
+    CLOUDCUBE_SECRET_ACCESS_KEY
+    CLOUDCUBE_URL
+<%- if rollbar? -%>
+    ROLLBAR_ACCESS_TOKEN
+<%- end -%>
+  ].freeze
+
+  def system!(*args)
+    system(*args) || abort("\n== Command #{args} failed ==")
+  end
+
+  task :dump_config do
+    system! "heroku config -s | grep '#{ENV_VARIABLES.join('\|')}' | tee -a .env"
+  end
+end

data/lib/generators/rockstart/deployment/heroku/templates/slugignore

@@ -0,0 +1,3 @@
+.env.*
+spec/
+tmp/

data/lib/generators/rockstart/deployment/nginx/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Configures a Rails app to work with NGINX
+
+Example:
+    rails generate rockstart:deployment:nginx
+
+    This will create:
+        Configure sendfile parameters in environments/production.rb

data/lib/generators/rockstart/deployment/nginx/nginx_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Rockstart::Deployment
+  class NginxGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    SENDFILE_REGEX = /#.+\.x_sendfile_header.+# for NGINX$/.freeze
+
+    def configure_sendfiles
+      inject_into_file "config/environments/production.rb", after: SENDFILE_REGEX do
+        <<~'SENDFILE'.split("\n").map { |line| "  #{line}".rstrip }.join("\n")
+
+          unless ENV['RAILS_SERVE_STATIC_FILES'].present?
+            config.action_dispatch.x_sendfile_header = "X-Accel-Redirect" # for NGINX
+          end
+        SENDFILE
+      end
+    end
+  end
+end

data/lib/generators/rockstart/deployment/templates/hooks-postdeploy.tt

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+
+# hooks-postdeploy script generated by rockstart:deployment
+# Run this script after provisioning a new App
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  puts '== Creating Database =='
+  system! 'bundle exec rake db:create'
+<%- if rollbar? -%>
+
+  puts "\n== Testing Rollbar ==
+  system "bundle exec rake rollbar:test" || puts("\n-- Rollbar test failed --")
+<%- end -%>
+end