rockstart 0.1.0

data/lib/generators/rockstart/devise/templates/spec/requests/users/sessions_spec.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe "Users::Passwords", type: :request do
+  describe "GET /users/sign_in" do
+    context "as a guest" do
+      it "renders a successful response" do
+        get new_user_session_path
+        expect(response).to be_successful
+      end
+    end
+
+    context "as an authenticated user" do
+      let(:authenticated_user) { create(:user) }
+
+      before do
+        sign_in authenticated_user
+      end
+
+      it "redirects back to the user dashboard" do
+        get new_user_session_path
+        expect(response).to redirect_to(url_for_user_dashboard)
+      end
+    end
+
+    context "with a soft deleted user" do
+      let(:soft_deleted_user) { create(:user, :soft_deleted) }
+
+      before do
+        sign_in soft_deleted_user
+      end
+
+      it "redirects back to the landing page" do
+        get new_user_session_path
+        expect(response).to redirect_to(url_for_authentication)
+
+        follow_redirect!
+        expect(response.body).to have_selector(".alert-alert", text: t("devise.failure.deleted_account"))
+      end
+    end
+  end
+
+  describe "POST /users/sign_in", :cache_testing do
+    context "with known user credentials" do
+      let(:valid_password) { Faker::Internet.password }
+      let(:known_user) { create(:user, password: valid_password) }
+
+      let(:valid_sign_in_params) do
+        {
+          user: {
+            email: known_user.email,
+            password: valid_password
+          }
+        }
+      end
+
+      it "redirects to the dashboard" do
+        post new_user_session_path, params: valid_sign_in_params
+        expect(response).to redirect_to(url_for_user_dashboard)
+
+        follow_redirect!
+        expect(controller.current_user).to eq known_user.reload
+        expect(response.body).to have_selector(".alert-notice", text: t("devise.sessions.signed_in"))
+      end
+    end
+
+    context "with known user credentials" do
+      let(:known_user) { create(:user) }
+
+      let(:invalid_sign_in_params) do
+        {
+          user: {
+            email: known_user.email,
+            password: Faker::Internet.password
+          }
+        }
+      end
+
+      it "renders the sign in form with an error" do
+        post new_user_session_path, params: invalid_sign_in_params
+        expect(response).to be_successful
+
+        expect(response.body).to have_selector(".alert-alert", text: t("devise.failure.invalid", authentication_keys: "Email"))
+      end
+    end
+
+    context "with unknown user credentials" do
+      let(:unknown_sign_in_params) do
+        {
+          user: {
+            email: Faker::Internet.email,
+            password: Faker::Internet.password
+          }
+        }
+      end
+
+      it "renders the sign in form with an error" do
+        post new_user_session_path, params: unknown_sign_in_params
+        expect(response).to be_successful
+
+        expect(response.body).to have_selector(".alert-alert", text: t("devise.failure.invalid", authentication_keys: "Email"))
+      end
+    end
+
+    it "rate limits requests based off ip address" do
+      5.times do
+        post new_user_session_path, params: {
+          user: {
+            email: Faker::Internet.email,
+            password: Faker::Internet.password
+          }
+        }
+      end
+
+      post new_user_session_path, params: {
+        user: {
+          email: Faker::Internet.email,
+          password: Faker::Internet.password
+        }
+      }
+      expect(response).to have_http_status(:too_many_requests)
+    end
+
+    it "rate limits requests based off email address" do
+      valid_email_parameters = {
+        user: {
+          email: Faker::Internet.email,
+          password: Faker::Internet.password
+        }
+      }
+
+      5.times do |n|
+        post new_user_session_path, params: valid_email_parameters, headers: {
+          "REMOTE_ADDR" => format("120.0.1.%<n>d", n: n)
+        }
+      end
+
+      post new_user_session_path, params: valid_email_parameters
+      expect(response).to have_http_status(:too_many_requests)
+    end
+  end
+
+  describe "DELETE /users/sign_outs" do
+    context "with an authenticated user" do
+      let(:authenticated_user) { create(:user) }
+
+      before do
+        sign_in(authenticated_user)
+      end
+
+      it "redirects to the login page with a notice" do
+        delete destroy_user_session_path
+        expect(response).to redirect_to(url_for_authentication)
+
+        follow_redirect!
+        expect(response.body).to have_selector(".alert-notice", text: t("devise.sessions.signed_out"))
+      end
+    end
+
+    context "with a guest" do
+      it "redirects to the login page with a notice" do
+        delete destroy_user_session_path
+        expect(response).to redirect_to(url_for_authentication)
+
+        follow_redirect!
+        expect(response.body).to have_selector(".alert-notice", text: t("devise.sessions.signed_out"))
+      end
+    end
+  end
+end

data/lib/generators/rockstart/devise/templates/spec/support/devise_request_spec_helper.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Helpers for Devise Authentication with request specs
+module DeviseRequestSpecHelper
+  include Warden::Test::Helpers
+
+  def self.included(base)
+    base.before(:each) { Warden.test_mode! }
+    base.after(:each) { Warden.test_reset! }
+  end
+
+  def sign_in(resource)
+    login_as(resource, scope: warden_scope(resource))
+  end
+
+  def sign_out(resource)
+    logout(warden_scope(resource))
+  end
+
+  private
+
+  def warden_scope(resource)
+    resource.class.name.underscore.to_sym
+  end
+end
+
+RSpec.configure do |config|
+  config.include DeviseRequestSpecHelper, type: :request
+end

data/lib/generators/rockstart/devise/templates/translations.en.yml

@@ -0,0 +1,4 @@
+en:
+  devise:
+    failure:
+      deleted_account: "You've deleted your account. Please contact support if you want to recover it!"

data/lib/generators/rockstart/docker/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Configures a Rails app to run in Docker
+
+Example:
+    rails generate rockstart:docker
+
+    This will create:
+        A Dockerfile containing the app and test suite
+        A docker-compose.yml with all required resources
+        A docker-compose.test.yml which will run the full test suite

data/lib/generators/rockstart/docker/docker_generator.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+class Rockstart::DockerGenerator < Rails::Generators::Base
+  include Rails::Generators::AppName
+
+  source_root File.expand_path("templates", __dir__)
+
+  desc "This generator configures a Rails Application to work with Docker"
+
+  class_option :root_image, type: :string,
+                            desc: "Docker image to build the container from",
+                            default: "ruby:#{RUBY_VERSION}"
+
+  class_option :app_home, type: :string,
+                          desc: "Mount directory used within Docker image",
+                          default: Rails.application.engine_name
+
+  class_option :assets, type: :boolean,
+                        desc: "Include frontend assets support (node|yarn)",
+                        default: true
+
+  class_option :devise, type: :boolean,
+                        desc: "Include Devise support",
+                        default: true
+
+  class_option :postgres, type: :boolean,
+                          desc: "Include Postgres support",
+                          default: Rockstart::Env.postgres_db?
+
+  def create_dockerignore
+    copy_file "dockerignore", ".dockerignore"
+  end
+
+  def create_dockerfile
+    @root_image = options[:root_image]
+    @app_home = options[:app_home]
+    @postgres = options[:postgres]
+    @assets = options[:assets]
+    template "app/Dockerfile-app", "Dockerfile"
+  end
+
+  def create_nginx_image
+    @root_image = options[:root_image]
+    @app_home = options[:app_home]
+    template "web/Dockerfile-web", "docker/web/Dockerfile"
+    template "web/nginx.conf", "docker/web/nginx.conf"
+  end
+
+  def add_docker_compose
+    @app_home = options[:app_home]
+    template "docker-compose.yml", "docker-compose.yml"
+    template "docker-compose.test.yml", "docker-compose.test.yml"
+  end
+
+  def create_certs_directory
+    FileUtils.mkdir_p(Rails.root.join("docker", "certs", "web"))
+    append_file ".gitignore", "\n# Docker Configuration\ndocker/certs\n"
+  end
+
+  def create_dotenv
+    template "dotenv.docker.tt", ".env.docker"
+  end
+
+  def create_localhost_certificates
+    template "localhost_domains.ext.tt", "docker/certs/web/#{app_name}_localhost.ext"
+    template "setup-localhost.tt", "bin/setup-localhost"
+    File.chmod(0o755, Rails.root.join("bin", "setup-localhost"))
+    append_file ".gitignore", "\n# localhost certificate authority\nlocalhostCA.*\n"
+  end
+
+  private
+
+  def devise?
+    options[:devise]
+  end
+
+  def postgres?
+    options[:postgres]
+  end
+
+  # Generates an example password
+  def example_db_password
+    require "base64"
+    Base64.urlsafe_encode64(Rails.application.engine_name)
+  end
+end

data/lib/generators/rockstart/docker/templates/app/Dockerfile-app

@@ -0,0 +1,47 @@
+FROM <%= @root_image %>
+
+# Install dependencies
+RUN apt-get update -qq \
+    && apt-get install -y build-essential \
+    && apt-get install -y libxml2-dev libxslt1-dev \
+<%- if @postgres -%>
+    && apt-get install -y libpq-dev \
+<%- end -%>
+<%- if @assets -%>
+    && 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 \
+    && apt-get update && apt-get install -y nodejs yarn \
+<%- end -%>
+    && apt-get clean
+
+ENV RACK_ENV=production \
+<%- if @assets -%>
+    NODE_ENV=production \
+<%- end -%>
+    RAILS_LOG_TO_STDOUT=true \
+    RAILS_ENV=production
+
+RUN mkdir /<%= @app_home %>
+WORKDIR /<%= @app_home %>
+
+# Install gems
+ADD Gemfile* /<%= @app_home %>/
+RUN gem install bundler:2.1.4 \
+    && bundle config set deployment 'true' \
+    && bundle config set without 'development' \
+    && bundle install
+
+# Install application
+ADD . /<%= @app_home %>
+
+# Perform post-installation tasks
+RUN bundle exec rake tmp:create \
+<%- if @assets -%>
+    && bundle exec rake assets:precompile \
+<%- end -%>
+    && bundle exec rake tmp:clear
+
+# Start the application server
+EXPOSE 3000
+CMD ["bundle", "exec", "rails", "server", "-p", "3000", "-b", "0.0.0.0"]

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

@@ -0,0 +1,29 @@
+version: '2.0'
+services:
+  sut:
+    build: .
+    command: bash -c "bundle exec rake db:migrate && bundle exec rake"
+    depends_on:
+<%- if postgres? -%>
+      - db
+<%- end -%>
+      - mailcatcher
+    environment:
+      - RAILS_ENV=test
+<%- if postgres? -%>
+      - TEST_DATABASE_URL=postgres://<%= app_name %>:<%= app_name %>_test@db/<%= app_name %>_test
+<%- end -%>
+      - SMTP_SERVER=mailcatcher
+      - SMTP_PORT=1025
+    env_file:
+      - ./.env.test
+<%- if postgres? -%>
+  db:
+    image: postgres
+    environment:
+      - POSTGRES_DB=<%= app_name %>_test
+      - POSTGRES_USER=<%= app_name %>
+      - POSTGRES_PASSWORD=<%= app_name %>_test
+<%- end -%>
+  mailcatcher:
+    image: sj26/mailcatcher

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

@@ -0,0 +1,47 @@
+version: '2.0'
+services:
+  app:
+    build: .
+    environment:
+<%- if postgres? -%>
+      - DATABASE_URL=postgres://<%= app_name %>:<%= example_db_password %>@db/<%= app_name %>_production
+<%- end -%>
+      - SMTP_SERVER=mailcatcher
+      - SMTP_PORT=1025
+    env_file:
+      - ./.env.docker
+<%- if postgres? -%>
+    depends_on:
+      - db
+<%- end -%>
+    volumes:
+    - static-assets:/<%= @app_home %>/public
+<%- if postgres? -%>
+  db:
+    image: postgres
+    environment:
+      - POSTGRES_DB=<%= app_name %>_production
+      - POSTGRES_USER=<%= app_name %>
+      - POSTGRES_PASSWORD=<%= example_db_password %>
+    volumes:
+      - ./tmp/db:/var/lib/postgresql/data
+<%- end -%>
+  mailcatcher:
+    image: sj26/mailcatcher
+    ports:
+      - 1080:1080
+  web:
+    build:
+      context: ./docker/web/
+    depends_on:
+      - app
+    ports:
+      - 80:80
+      - 443:443
+    volumes:
+      - ./docker/certs/web:/<%= @app_home %>/certs
+      - static-assets:/<%= @app_home %>/public
+      - web-logs:/<%= @app_home %>/log
+volumes:
+  static-assets: {}
+  web-logs: {}

data/lib/generators/rockstart/docker/templates/dockerignore

@@ -0,0 +1,16 @@
+/.bundle
+/.git
+/.env
+/.env.*
+/docker
+/docker-compose.yml
+/docker-compose.test.yml
+/log
+/node_modules
+/public/assets
+/tmp
+/vendor/bundle
+
+# Development Scripts
+bin/setup-localhost
+localhostCA.*

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

@@ -0,0 +1,4 @@
+APP_HOST=localhost
+<%- if devise? -%>
+DEVISE_MAILER_SENDER=devise-mailer@<%= app_name %>
+<%- end -%>

data/lib/generators/rockstart/docker/templates/localhost_domains.ext.tt

@@ -0,0 +1,7 @@
+authorityKeyIdentifier=keyid,issuer
+basicConstraints=CA:FALSE
+keyUsage = digitalSignature, nonRepudiation, keyEncipherment, dataEncipherment
+subjectAltName = @alt_names
+[alt_names]
+DNS.1 = localhost
+DNS.1 = <%= app_name %>.local

data/lib/generators/rockstart/docker/templates/setup-localhost.tt

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+set -o errexit
+set -o pipefail
+set -o nounset
+
+echo "=== Creating Certification Authority for localhost ==="
+
+openssl req -x509 -nodes -new -sha256 -days 1024 -newkey rsa:2048 \
+  -keyout localhostCA.key \
+  -out localhostCA.pem \
+  -subj "/C=US/CN=Example-Root-CA"
+
+openssl x509 -outform pem -in localhostCA.pem -out localhostCA.crt
+
+echo "=== Generating Domain Name Certificate ==="
+
+openssl req -new -nodes -newkey rsa:2048 \
+  -keyout docker/certs/web/<%= app_name %>.key \
+  -out docker/certs/web/<%= app_name %>.csr \
+  -subj "/C=US/ST=YourState/L=YourCity/O=Example-Certificates/CN=<%= app_name %>.local"
+
+openssl x509 -req -sha256 -days 1024 \
+  -in docker/certs/web/<%= app_name %>.csr \
+  -CA localhostCA.pem -CAkey localhostCA.key \
+  -CAcreateserial -extfile docker/certs/<%= app_name %>_localhost.ext \
+  -out docker/certs/web/<%= app_name %>.crt

data/lib/generators/rockstart/docker/templates/web/Dockerfile-web

@@ -0,0 +1,15 @@
+FROM nginx
+
+RUN apt-get update -qq && apt-get -y install apache2-utils
+
+ENV RAILS_ROOT /<%= @app_home %>
+
+WORKDIR /<%= @app_home %>
+
+COPY nginx.conf /etc/nginx/conf.d/default.conf
+
+EXPOSE 80
+EXPOSE 443
+
+# Use the "exec" form of CMD so Nginx shuts down gracefully on SIGTERM (i.e. `docker stop`)
+CMD [ "nginx", "-g", "daemon off;" ]

data/lib/generators/rockstart/docker/templates/web/nginx.conf

@@ -0,0 +1,62 @@
+upstream rails_app {
+  server app:3000;
+}
+
+server {
+  listen 80;
+  listen 443 ssl;
+
+  # define your domain
+  # server_name www.example.com;
+
+  ssl_certificate     /<%= @app_home %>/certs/<%= app_name %>.crt;
+  ssl_certificate_key /<%= @app_home %>/certs/<%= app_name %>.key;
+  ssl_protocols       TLSv1 TLSv1.1 TLSv1.2;
+  ssl_ciphers         HIGH:!aNULL:!MD5;
+
+  # define the public application root
+  root /<%= @app_home %>/public;
+  index index.html;
+
+  # define where Nginx should write its logs
+  access_log /<%= @app_home %>/log/nginx.access.log;
+  error_log /<%= @app_home %>/log/nginx.error.log;
+
+  # serve static (compiled) assets directly if they exist
+  location ~ ^/(assets|packs)/ {
+    try_files $uri =404;
+
+    access_log off; # don't save asset requests to access logs
+    gzip_static on; # to serve pre-gzipped version
+
+    # Cache assets for as long as possible
+    expires max;
+    add_header Cache-Control public;
+
+    # Some browsers still send conditional-GET requests if there's a
+    # Last-Modified header or an ETag header even if they haven't
+    # reached the expiry date sent in the Expires header.
+    add_header Last-Modified "";
+    add_header ETag "";
+    break;
+  }
+
+  # send non-static file requests to the app server
+  location / {
+    try_files $uri @rails;
+  }
+
+  location @rails {
+    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;
+  }
+
+  error_page 404 /404.html;
+  error_page 500 502 503 504 /500.html;
+  # client_max_body_size 1m;
+  # keepalive_timeout 10;
+}

data/lib/generators/rockstart/frontend_helpers/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Installs common helpers for Frontend UIs
+
+Example:
+    rails generate rockstart:frontend_helpers
+
+    This will create:
+        Install the titles gem

data/lib/generators/rockstart/frontend_helpers/frontend_helpers_generator.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+class Rockstart::FrontendHelpersGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+
+  class_option :force_url_helpers, type: :boolean,
+                                   desc: "Force creation of blank Application URL Helpers",
+                                   default: false
+
+  def install_simple_form
+    gem "simple_form"
+
+    Bundler.with_clean_env do
+      run "bundle install --quiet"
+
+      generate "simple_form:install"
+    end
+  end
+
+  def install_titles
+    gem "title", github: "calebthompson/title"
+
+    template "titles.en.yml.tt", "config/locales/titles.en.yml"
+
+    gsub_file "app/views/layouts/application.html.erb", %r{\<title(.+)\</title},
+              "<title><%= title %></title"
+  end
+
+  def add_application_urls_concern
+    if force_url_helpers? || !File.exist?(Rails.root.join(application_urls_concern_path))
+      copy_file "application_urls.rb", application_urls_concern_path
+    else
+      say "Skipping #{application_urls_concern_path}"
+    end
+    inject_into_file "app/controllers/application_controller.rb",
+                     "  include ApplicationUrls\n",
+                     before: /^end$/
+  end
+
+  def add_application_urls_helper
+    if force_url_helpers? || !File.exist?(Rails.root.join(application_urls_helper_path))
+      copy_file "application_urls_helper.rb", application_urls_helper_path
+    else
+      say "Skipping #{application_urls_helper_path}"
+    end
+  end
+
+  private
+
+  def default_title
+    Rails.application.class.to_s.split("::").first
+  end
+
+  def force_url_helpers?
+    options.fetch(:force_url_helpers)
+  end
+
+  def application_urls_concern_path
+    File.join("app", "controllers", "concerns", "application_urls.rb")
+  end
+
+  def application_urls_helper_path
+    File.join("spec", "support", "application_urls_helper.rb")
+  end
+end

data/lib/generators/rockstart/frontend_helpers/templates/application_urls.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# ApplicationUrls generated by rockstart:frontend_helpers
+module ApplicationUrls
+  extend ActiveSupport::Concern
+
+  included do
+    helper_method :url_for_authentication
+    helper_method :url_for_landing_page
+    helper_method :url_for_user_dashboard
+  end
+
+  protected
+
+  def url_for_authentication
+    root_url # TODO: Provide url for authentication page
+  end
+
+  def url_for_landing_page
+    root_url # TODO: Provide url for landing page
+  end
+
+  def url_for_user_dashboard
+    root_url # TODO: Provide url for user dashboard link
+  end
+end

data/lib/generators/rockstart/frontend_helpers/templates/application_urls_helper.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# ApplicationUrlsHelper generated by rockstart:frontend_helpers
+module ApplicationUrlsHelper
+  def url_for_authentication
+    root_url # TODO: Provide url for authentication page
+  end
+
+  def url_for_landing_page
+    root_url # TODO: Provide url for landing page
+  end
+
+  def url_for_user_dashboard
+    root_url # TODO: Provide url for user dashboard link
+  end
+end
+
+RSpec.configure do |config|
+  config.include ApplicationUrlsHelper
+end