launch_base 0.1.0

data/templates/.eslintrc.json

@@ -0,0 +1,19 @@
+{
+  "parser": "babel-eslint",
+
+  "parserOptions": {
+    "sourceType": "module"
+  },
+
+  "env": {
+    "amd": true,
+    "browser": true,
+    "es6": true
+  },
+
+  "extends": "airbnb",
+
+  "rules": {
+    "max-len": [2, 120, 2]
+  }
+}

data/templates/.mdlrc

@@ -0,0 +1 @@
+rules "~MD026", "~MD013"

data/templates/.rspec

@@ -0,0 +1,3 @@
+--require rails_helper
+--format Fuubar
+--color

data/templates/.rubocop.yml

@@ -0,0 +1,133 @@
+# https://rubocop.readthedocs.io/
+AllCops:
+  Include:
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - config.ru
+     - '**/*.gemspec'
+  Exclude:
+    - db/schema.rb
+
+# Longer line length
+Metrics/LineLength:
+  Max: 120
+
+Metrics/ClassLength:
+  Max: 150
+  CountComments: false
+
+# Methods can be 15 lines long
+Metrics/MethodLength:
+  Max: 15
+
+# Prefer raise over fail
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Make literal hashes act like arrays
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: space
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented_relative_to_receiver
+
+# Disable the documentation requirement
+Style/Documentation:
+  Enabled: false
+
+# Allow the usage of begin blocks
+Style/BeginBlock:
+  Enabled: false
+
+# Allow usage of regular array notation, which is familiar to non rubyists as well
+Style/WordArray:
+  Enabled: true
+  EnforcedStyle: brackets
+
+Style/SymbolArray:
+  Enabled: true
+  EnforcedStyle: brackets
+
+# Enforce nested module/class notation.
+# Note: We decided this may be disabled for controllers, add an rubocop file in the controller folder, that inherits from this file and disable the rule if preferred
+Style/ClassAndModuleChildren:
+  Enabled: true
+
+# Disable check for emptymethod. It would enforce semicolons otherwise, and we are allergic to those
+Style/EmptyMethod:
+  Enabled: false
+
+# Force Ruby 1.9 syntax and do not mix key types
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+# Array indentation has to be consistent, but it is more flexible
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+# Hash indentation has to be consistent, but it is more flexible
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+# Use rails indentation
+Layout/IndentationConsistency:
+  EnforcedStyle: normal
+
+# Do not trail do end blocks with extra function calls
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+# Do not enforce the use of `next if <condition>` instead of `unless <condition> ... end`
+Style/Next:
+  Enabled: false
+
+# Complex inline ifs need ()
+Style/TernaryParentheses:
+  EnforcedStyle: require_parentheses_when_complex
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+  # Use consistent quotes when multi-lining strings
+  ConsistentQuotesInMultiline: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Allow usage :"symbol"
+Style/SymbolLiteral:
+  Enabled: false
+
+# We usually only flatten only level so we can enable this feature
+Performance/FlatMap:
+  EnabledForFlattenWithoutParams: true
+
+# Force strict date getting to it handles better with activerecord dates
+Rails/Date:
+  EnforcedStyle: strict
+
+# Rails 5 cop
+Rails/HttpPositionalArguments:
+  Enabled: false
+
+# No need to sort gems in the bundle file
+Bundler/OrderedGems:
+  Enabled: false
+
+# Don't check on block length in spec files.
+# `describe` and `context` blocks can be large.
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Security/Eval:
+  Exclude:
+    - 'spec/*.rb'
+    - 'spec/**/*.rb'
+
+# Do not suggest to rename `has_x?` to `x?`
+Naming:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver

data/templates/.ruby-gemset

@@ -0,0 +1 @@
+launch-base

data/templates/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/templates/Jenkinsfile.erb

@@ -0,0 +1,94 @@
+projectId = "<%= @app_id %>"
+
+pipeline {
+  agent any
+
+  options {
+    ansiColor("xterm")
+  }
+
+  stages {
+    stage("Tests") {
+      agent {
+        dockerfile {
+          filename "dockerfiles/ci/Dockerfile"
+          additionalBuildArgs support.ciDockerFileBuildArgs()
+          args "${support.ciDockerFileRunArgs(projectId)} -u root"
+        }
+      }
+
+      environment {
+        RAILS_ENV = 'test'
+        CODECLIMATE_REPO_TOKEN = credentials('<%= @app_id %>_codeclimate_test_reporter_id')
+      }
+
+      steps {
+        sh "service postgres start"
+        sh "bundle config --global jobs \$(cat /proc/cpuinfo | grep -c processor)"
+        sh "bin/ci"
+      }
+
+      post {
+        always {
+          script {
+            support.restoreWorkspacePermissions()
+          }
+        }
+      }
+    }
+
+    stage("Set APP_ENV for staging") {
+      when {
+        branch 'staging/*'
+      }
+      steps {
+        script {
+          env.APP_ENV = 'staging'
+        }
+      }
+    }
+
+    stage("Deploy to Dokku staging") {
+      when {
+        branch 'staging/*'
+      }
+      steps {
+        sh 'ssh-keyscan -H <%= @app_id %>.staging.kabisa.nl >> ~/.ssh/known_hosts # only needed on the first run'
+        sh 'git remote | grep dokku-staging >/dev/null || git remote add dokku-staging dokku@<%= @app_id %>.staging.kabisa.nl:<%= @app_id %>-staging'
+        sh 'git push dokku-staging HEAD:master --force'
+      }
+      post {
+        always {
+          script { support.slackNotification(channel: "#<%= @app_id %>") }
+        }
+      }
+    }
+
+    stage("Set APP_ENV for production") {
+      when {
+        branch 'master'
+      }
+      steps {
+        script {
+          env.APP_ENV = 'production'
+        }
+      }
+    }
+
+    stage("Deploy to Dokku production") {
+      when {
+        branch 'master'
+      }
+      steps {
+        // sh 'ssh-keyscan -H <%= @app_id %>.production.kabisa.nl >> ~/.ssh/known_hosts # only needed on the first run'
+        sh 'git remote | grep dokku-production >/dev/null || git remote add dokku-production dokku@<%= @app_id %>.production.kabisa.nl:<%= @app_id %>-production'
+        sh 'git push dokku-production HEAD:master --force'
+      }
+      post {
+        always {
+          script { support.slackNotification(channel: "#<%= @app_id %>") }
+        }
+      }
+    }
+  }
+}

data/templates/README.md.erb

@@ -0,0 +1,66 @@
+# Rails app generated by Kabisa LaunchBase :rocket:
+
+## What's in it?
+
+For specific version numbers please refer to
+[the LaunchBase template](https://github.com/kabisa/launch-base/tree/master/templates/launch_base_default_template.rb)
+
+- Rails with Spring and Bootsnap
+- RSpec with Capybara, FactoryBot and Headless Chrome (via Selenium)
+- SimpleCov including sending the coverage report to Code Climate
+- SASS
+- Pry
+- database: PostgreSQL
+- web server: puma
+- lint configuration for CodeClimate, ESLint, Rubocop and Reek
+
+## First steps
+
+- create GitHub repository
+- create Dokku repository
+- setup the server provisioning
+- add this project to Jenkins
+- add the project to CodeClimate
+- create Jenkins credential `<%= @app_id %>_codeclimate_test_reporter_id` containing the CodeClimate test
+  coverage reporter ID
+
+## Basic usage
+
+Run web server:
+
+```
+bundle exec rails s
+```
+
+Run tests:
+
+```
+bundle exec rspec spec
+```
+
+## CodeClimate
+
+To analyze your code locally, install the CodeClimate CLI:
+
+For OS X:
+
+```
+brew install codeclimate
+```
+
+Other systems:
+
+```
+curl -L https://github.com/codeclimate/codeclimate/archive/master.tar.gz | tar xvz
+cd codeclimate-* && sudo make install
+```
+
+and run:
+
+```
+codeclimate analyze
+```
+
+More info about CodeClimate: [codeclimate.com](https://codeclimate.com)
+
+More info about the CodeClimate CLI: [github.com/codeclimate/codeclimate](https://github.com/codeclimate/codeclimate)

data/templates/app.json.erb

@@ -0,0 +1,15 @@
+{
+  "name": "<%= @app_id %>",
+  "description": "<%= @app_description %>",
+  "keywords": [
+    "dokku",
+    "rails",
+    "<%= @app_id %>"
+  ],
+  "scripts": {
+    "dokku": {
+      "predeploy": "echo $RAILS_ENV",
+      "postdeploy": "bin/post_deploy"
+    }
+  }
+}

data/templates/app/controllers/homepage_controller.rb

@@ -0,0 +1,4 @@
+class HomepageController < ApplicationController
+  def show
+  end
+end

data/templates/bin/ci

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+service postgresql start
+
+# Bundle gems
+bundle check || bundle install --path="/cache"
+
+set -eu -o pipefail
+
+env
+
+bundle exec rake db:drop db:create db:schema:load assets:precompile
+cc-test-reporter before-build
+bundle exec rspec spec
+rspec_exit_code=$?
+cc-test-reporter after-build
+exit $rspec_exit_code

data/templates/bin/post_deploy

@@ -0,0 +1,4 @@
+#!/bin/sh
+set -xe
+
+bundle exec rake db:migrate

data/templates/config.reek

@@ -0,0 +1,60 @@
+# Do not require a descriptive comment for classes and modules
+# See: https://github.com/troessner/reek/blob/master/docs/Irresponsible-Module.md
+IrresponsibleModule:
+  enabled: false
+
+# Allow 2 occurrences of a method call. When adding the third, it should be
+# extracted to a variable or method.
+# See: https://github.com/troessner/reek/blob/master/docs/Duplicate-Method-Call.md
+#
+# == Examples:
+#
+# Allowed:
+#
+#   def search
+#     if params[:query].present?
+#       @results = Model.search(params[:query])
+#     end
+#   end
+#
+# Not allowed:
+#
+#   def search
+#     if params[:query].present?
+#       @results = Model.search(params[:query])
+#       session[:last_search_query] = params[:query]
+#     end
+#   end
+#
+# Refactor to:
+#
+#   def search
+#     if search_query.present?
+#       @results = Model.search(search_query)
+#       session[:last_search_query] = search_query
+#     end
+#   end
+#
+#   private
+#
+#   def search_query
+#     params[:query]
+#   end
+DuplicateMethodCall:
+  enabled: true
+  max_calls: 2
+
+# Allow modules named "V1", because that is fairly common for Rails apps to have
+UncommunicativeModuleName:
+  accept:
+    - V1
+
+# Allow Rails helpers that do not depend on instance state
+"app/helpers":
+  UtilityFunction:
+    enabled: false
+
+# Allow spec helpers that do not depend on instance state
+"spec/support":
+  UtilityFunction:
+    enabled: false

data/templates/config/database.yml.erb

@@ -0,0 +1,20 @@
+default: &default
+  adapter: postgresql
+  port: 5432
+  pool: 5
+  timeout: 5000
+  user: postgres
+  password: postgres
+  template: template0
+
+development:
+  <<: *default
+  database: <%= app_name %>_development
+
+test:
+  <<: *default
+  database: <%= app_name %>_test
+
+production:
+  <<: *default
+  database: <%= app_name %>_production