schienenzeppelin 0.1

data/templates/app/views/pages/home.html.erb.tt

@@ -0,0 +1,20 @@
+<div class="py-20 bg-gray-100">
+  <div class="container mx-auto px-6">
+    <h2 class="text-6xl font-bold mb-2">
+      <%= camelized %>
+    </h2>
+    <h3 class="text-2xl mb-8 text-gray-800">
+      Created with <a class="underline" href="https://github.com/hschne/schienenzeppelin">Schienenzeppelin</a>
+    </h3>
+    <button class="btn btn-blue">
+      View Documentation
+    </button>
+  </div>
+</div>
+
+<section class="container mx-auto px-6 p-10 text-center">
+  <h2 class="text-2xl font-bold text-gray-800 mb-2">Ready to do some magic?</h2>
+  <p>Edit this page in <code class="bg-gray-100">app/views/pages/home.html.erb</code></p>
+</section>
+
+

data/templates/app/views/shared/_flashes.html.erb.tt

@@ -0,0 +1,12 @@
+<%% flash.each do |type, message| %>
+  <%% if type == "alert" %>
+    <div class="bg-red-500">
+      <div class="container px-2 py-4 mx-auto font-sans font-medium text-center text-white"><%%= message %></div>
+    </div>
+  <%% end %>
+  <%% if type == "notice" %>
+    <div class="bg-green-500">
+      <div class="container px-2 py-4 mx-auto font-sans font-medium text-center text-white"><%%= message %></div>
+    </div>
+  <%% end %>
+<%% end %>

data/templates/app/views/shared/_footer.html.erb.tt

@@ -0,0 +1,21 @@
+<footer class="bg-gray-100">
+  <div class="container mx-auto  px-8">
+
+    <div class="w-full flex py-6 justify-between">
+      <div class="flex align-middle">
+        © <%%= Date.current.year %> <%= app_name.capitalize %>
+      </div>
+      <div class="flex w-1/3 justify-end">
+        <ul class="list-reset w-full flex justify-around align-middle items-center mb-6">
+          <li class="mt-2 mr-2 md:mr-0">
+            <a href="#" class="no-underline hover:underline">About</a>
+          </li>
+          <li class="mt-2 mr-2  md:mr-0">
+            <a href="#" class="no-underline hover:underline">Contact</a>
+          </li>
+        </ul>
+      </div>
+    </div>
+  </div>
+</footer>
+

data/templates/app/views/shared/_navbar.html.erb.tt

@@ -0,0 +1,40 @@
+<header class="shadow">
+  <nav
+    data-controller="dropdown"
+    class="container mx-auto flex flex-wrap justify-between items-center p-5">
+    <div>
+      <a
+        class="flex items-center mr-2"
+        href="<%%= root_path %>">
+        <%%= inline_svg_pack_tag('media/images/logo.svg', class: "rounded mx-2", size: "3rem * 3rem") %>
+        <p class="font-bold text-lg"><%= app_name.capitalize %> </p>
+      </a>
+    </div>
+    <div class="flex md:hidden">
+      <button data-action="click->dropdown#toggle click@window->dropdown#hide"
+        class="px-3 py-2 border border-gray-500 rounded text-grey hover:text-gray-600 hover:border-gray-600"
+      >
+        <svg class="w-3 h-3 fill-current" viewBox="0 0 20 20" xmlns="http://www.w3.org/2000/svg">
+          <title>Menu</title>
+          <path d="M0 3h20v2H0V3zm0 6h20v2H0V9zm0 6h20v2H0v-2z"/>
+        </svg>
+      </button>
+    </div>
+    <div
+      data-dropdown-target="menu"
+      class="hidden md:flex-grow md:flex w-full md:w-auto text-right md:text-left text-bold mt-5 md:mt-0 border-t-2 border-gray-200 md:border-none">
+      <div class="justify-start flex-grow">
+        <!-- SZ Link Placeholder -->
+      </div>
+      <ul class="w-full flex-col md:flex md:flex-row items-center justify-end md:w-auto">
+        <%% if user_signed_in? %>
+          <li><%%= link_to "Edit account", edit_user_registration_path, class: "btn btn-default md:mr-2 my-2 md:my-0 " %></li>
+          <li><%%= link_to "Log out", destroy_user_session_path, method: :delete, class: "btn btn-default" %></li>
+        <%% else %>
+          <li><%%= link_to "Login", new_user_session_path, class: "btn btn-blue md:mr-2 my-2 md:my-0" %></li>
+          <li><%%= link_to "Sign Up", new_user_registration_path, class: "btn btn-blue" %></li>
+        <%% end %>
+      </ul>
+    </div>
+  </nav>
+</header>

data/templates/bin/setup.erb

@@ -0,0 +1,146 @@
+#!/usr/bin/env bash
+
+set -e
+
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[0;33m'
+NO_COLOR='\033[0m'
+CLEAR_LINE='\r\033[K'
+
+LOG_FILE=$(mktemp /tmp/<%= app_name %>-setup-XXXXXX)
+
+# Emojis from https://graphemica.com/
+main() {
+  progress 1 🔎 "Checking dependencies"
+
+  if [[ ! $(command -v ruby) ]]; then
+    clear
+    error "Ruby <%= RUBY_VERSION %> is required but not currently installed"
+    exit 101
+  fi
+
+  if [[ ! $(ruby --version) =~ <%= RUBY_VERSION %> ]]; then
+    clear
+    error "Your version of ruby does not match the required version <%= RUBY_VERSION %>"
+    exit 101
+  fi
+
+  if [[ ! $(command -v node) ]]; then
+    clear
+    error "Node is required but not currently installed"
+    exit 101
+  fi
+
+  if [[ ! $(command -v yarn) ]]; then
+    clear
+    error "Yarn is required but not currently installed"
+    exit 101
+  fi
+
+  clear
+  progress 2 📦 "Installing bundler"
+  gem install bundler 2> "$LOG_FILE" 1> /dev/null
+
+  clear
+  progress 3 💎 "Installing gems"
+  bundle install 2> "$LOG_FILE" 1> /dev/null
+
+  clear
+  progress 4 ⏳ "Installing yarn packages"
+  yarn 2> "$LOG_FILE" 1> /dev/null
+
+  clear
+  progress 5 🌐 "Checking database"
+  <% db_port = { postgresql: 5432, mysql: 3306}[options[:database].to_sym] %>
+  if ! is_port_open <%= db_port %>; then
+    clear
+    error "Database be running under port <%= db_port %> but was not found"
+    info "In order to continue the setup you require a running database server"
+    exit 101
+  fi
+
+  clear
+  progress 6 💾 "Setting up databases"
+  rails db:setup 2> "$LOG_FILE" 1> /dev/null
+}
+
+libary_exists() {
+  local name=$1
+  libs=$(ldconfig -p | grep -c "$name")
+  [[ "$libs" -ge 1 ]]
+  return $?
+}
+
+is_port_open() {
+  local port=$1
+  # Adapted from here: https://www.commandlinefu.com/commands/view/14651/determine-if-a-port-is-open-with-bash
+  (: < /dev/tcp/127.0.0.1/"$port") &>/dev/null && return 0 || return 1
+}
+
+error() {
+  local message=$1
+  printf "💀 ${RED}  $message${NO_COLOR}\n"
+}
+
+warning() {
+  local message=$1
+  printf "⚠️  ${YELLOW}  $message ${NO_COLOR}\n"
+}
+
+info() {
+  local message=$1
+  printf "ℹ️    $message\n"
+}
+
+progress() {
+  total=6
+  step=$1
+  icon=$2
+  message=$3
+  printf "[%s/%s] %s %s" "$step" "$total" "$icon" "$message"
+}
+
+clear() {
+  printf "${CLEAR_LINE}"
+}
+
+on_exit() {
+  local exit_code=$?
+  clear
+  if [[ "$exit_code" -eq 0 ]]; then
+    on_success
+  elif [[ "$exit_code" -eq 101 ]]; then
+    printf "\n❌${RED}   Setup failed${NO_COLOR}\n"
+  else
+    on_error
+  fi
+}
+
+on_error() {
+  local errors
+  errors=$(cat "$LOG_FILE")
+  rm "$LOG_FILE"
+  local colored_errors
+  colored_errors=$(printf "${YELLOW}$errors${NO_COLOR}")
+  echo
+  printf "❌${RED}  Setup exited with errors:${NO_COLOR}\n"
+  cat <<EOF
+  ------
+  $colored_errors
+  ------
+  Setup has failed with errors.
+EOF
+}
+
+on_success() {
+  printf "\n🎉${GREEN}  Setup finished!${NO_COLOR}\n"
+  cat <<EOF
+  In case you haven't already, check out the Meistertask Backend section in the
+handbook for more information about this project. Happy coding!
+EOF
+}
+
+trap on_exit EXIT
+
+main "$@"

data/templates/config/credentials.yml.erb

@@ -0,0 +1,7 @@
+# custom credentials
+# aws:
+#   access_key_id: 123
+#   secret_access_key: 345
+
+# Used as the base secret for all MessageVerifiers in Rails, including the one protecting cookies.
+secret_key_base: <%= SecureRandom.hex(64) %>

data/templates/config/initializers/high_voltage.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+HighVoltage.configure do |config|
+  config.route_drawer = HighVoltage::RouteDrawers::Root
+  config.home_page = 'home'
+end

data/templates/config/initializers/lograge.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Rails.application.configure do
+  config.lograge.enabled = true
+end

data/templates/config/initializers/sidekiq.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+Sidekiq.configure_server do |config|
+  # Add additional sidekiq configuration here
+
+  config.logger.level = Logger::INFO
+  # This enables you to use Rails.logger inside a Sidekiq worker
+  # See: https://github.com/mperham/sidekiq/issues/1682
+  Rails.logger = Sidekiq.logger
+end

data/templates/config/postgresql.yml.erb

@@ -0,0 +1,23 @@
+default: &default
+  adapter: postgresql
+  encoding: utf8
+  host: <%%= ENV['DATABASE_HOST'] %>
+  username: <%%= ENV['DATABASE_USERNAME'] %>
+  password: <%%= ENV['DATABASE_PASSWORD'] %>
+  pool: <%%= Integer(ENV.fetch("DB_POOL", 5)) %>
+  reaping_frequency: <%%= Integer(ENV.fetch("DB_REAPING_FREQUENCY", 10)) %>
+  timeout: 5000
+
+development:
+  <<: *default
+  database: <%= app_name %>_development
+
+test:
+  <<: *default
+  database: <%= app_name %>_test
+
+production:
+  <<: *default
+  database: <%%= ENV.fetch('DATABASE_NAME','<%= app_name %>_production') %>
+  pool: <%%= [Integer(ENV.fetch('MAX_THREADS', 5)), Integer(ENV.fetch("DB_POOL", 5))].max %>
+  min_messages: warning

data/templates/docker-compose.yml.erb

@@ -0,0 +1,21 @@
+version: "3"
+services:
+  <%= app_name %>-db:
+    image: postgres
+    volumes:
+      - <%= app_name %>-data:/var/lib/postgresql/data
+    ports:
+      - 5432:5432
+    environment:
+      POSTGRES_PASSWORD: <%= app_name %>
+      POSTGRES_USER: <%= app_name %>
+
+    <% unless options[:skip_sidekiq] %>
+  <%= app_name %>-redis:
+    image: redis
+    ports:
+      - 6379:6379
+    <% end %>
+
+volumes:
+  <%= app_name %>-data:

data/templates/lib/capistrano/tasks/seeds.rake

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+namespace :deploy do
+  desc 'Reload the database with seed data'
+  task :seeds do
+    on roles(:all) do
+      within current_path do
+        execute :bundle, :exec, 'rails', 'db:seed', 'RAILS_ENV=production'
+      end
+    end
+  end
+end

data/templates/lib/capistrano/tasks/sidekiq.rake

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+namespace :sidekiq do
+  desc 'Quiet sidekiq (stop fetching new tasks from Redis)'
+  task :quiet do
+    on roles fetch(:sidekiq_roles) do
+      # See: https://github.com/mperham/sidekiq/wiki/Signals#tstp
+      execute :systemctl, '--user', 'kill', '-s', 'SIGTSTP', 'sidekiq.service',
+              raise_on_non_zero_exit: false
+    end
+  end
+
+  desc 'Stop sidekiq (graceful shutdown within timeout, put unfinished tasks back to Redis)'
+  task :stop do
+    on roles fetch(:sidekiq_roles) do
+      # See: https://github.com/mperham/sidekiq/wiki/Signals#tstp
+      execute :systemctl, '--user', 'kill', '-s', 'SIGTERM', 'sidekiq.service',
+              raise_on_non_zero_exit: false
+    end
+  end
+
+  desc 'Start sidekiq'
+  task :start do
+    on roles fetch(:sidekiq_roles) do
+      execute :systemctl, '--user', 'enable', 'sidekiq.service'
+      execute :systemctl, '--user', 'start', 'sidekiq.service'
+    end
+  end
+
+  desc 'Restart sidekiq'
+  task :restart do
+    on roles fetch(:sidekiq_roles) do
+      execute :systemctl, '--user', 'restart', 'sidekiq.service'
+    end
+  end
+end

data/templates/lib/generators/rails/navigation/USAGE

@@ -0,0 +1,6 @@
+Description:
+    This adds a link to the specified resource to your home page
+
+Example:
+    bin/rails generate navigation resource
+

data/templates/lib/generators/rails/navigation/navigation_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Rails
+  class NavigationGenerator < Rails::Generators::NamedBase
+    def add_link
+      append_to_file 'app/views/shared/_navbar.html.erb',
+                     after: '<!-- SZ Link Placeholder -->' do
+        <<-HTML
+
+        <%= link_to "#{plural_name.capitalize}", #{plural_name}_path, class: "block md:inline-block p-3 border-b-2 border-gray-100 md:border-none" %>
+        HTML
+      end
+    end
+  end
+end

data/templates/lib/generators/rails/scaffold_controller_generator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/rails/scaffold_controller/scaffold_controller_generator'
+
+module Rails
+  module Generators
+    class ScaffoldControllerGenerator
+      hook_for :navigation, type: :boolean, default: true
+    end
+  end
+end

data/templates/lib/tasks/auto_annotate_models.rake

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+if Rails.env.development?
+  require 'annotate'
+  task set_annotation_options: :environment do
+    # You can override any of these by setting an environment variable of the
+    # same name.
+    Annotate.set_defaults(
+      'active_admin' => 'false',
+      'additional_file_patterns' => [],
+      'routes' => 'false',
+      'models' => 'true',
+      'position_in_routes' => 'before',
+      'position_in_class' => 'before',
+      'position_in_test' => 'before',
+      'position_in_fixture' => 'before',
+      'position_in_factory' => 'before',
+      'position_in_serializer' => 'before',
+      'show_foreign_keys' => 'true',
+      'show_complete_foreign_keys' => 'false',
+      'show_indexes' => 'true',
+      'simple_indexes' => 'false',
+      'model_dir' => 'app/models',
+      'root_dir' => '',
+      'include_version' => 'false',
+      'require' => '',
+      'exclude_tests' => 'true',
+      'exclude_fixtures' => 'true',
+      'exclude_factories' => 'true',
+      'exclude_serializers' => 'true',
+      'exclude_scaffolds' => 'true',
+      'exclude_controllers' => 'true',
+      'exclude_helpers' => 'true',
+      'exclude_sti_subclasses' => 'false',
+      'ignore_model_sub_dir' => 'false',
+      'ignore_columns' => nil,
+      'ignore_routes' => nil,
+      'ignore_unknown_models' => 'false',
+      'hide_limit_column_types' => 'integer,bigint,boolean',
+      'hide_default_column_types' => 'json,jsonb,hstore',
+      'skip_on_db_migrate' => 'false',
+      'format_bare' => 'true',
+      'format_rdoc' => 'false',
+      'format_yard' => 'false',
+      'format_markdown' => 'false',
+      'sort' => 'false',
+      'force' => 'false',
+      'frozen' => 'false',
+      'classified_sort' => 'true',
+      'trace' => 'false',
+      'wrapper_open' => nil,
+      'wrapper_close' => nil,
+      'with_comment' => 'true'
+    )
+  end
+
+  Annotate.load_tasks
+end