schienenzeppelin 0.1

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/TODO.md

@@ -0,0 +1,32 @@
+
+# TODO
+
+## Phase 2
+- Schienenzeppelin Repo CI (notify gem releases, tests)
+- Loads of testing
+- Hide generators and scaffolds in sz gem, don't copy as templates. See JB, use railtie
+
+## Phase 3
+- Make everything skippable, manage dependencies between items
+- Take advantage of saved config (as rails new does)
+- Licensing? 
+- Homepage & Newsletter
+- Goodies for Business: 
+    - Admin pages
+    - Social Logins
+    - Cloud Storage ?
+    - Payments
+    - Monitoring (Skylight, ...)
+    - Email Providers (Mailgun, ...)
+    - Reporting (Bugsnag, ...)
+    - Dockerfile
+    - https://dev.to/citronak/modern-rails-flash-messages-part-1-viewcomponent-stimulus-tailwind-css-3alm
+- Configuration wizard via command line
+- Alternative configurations:
+    - Differernt DB
+    - Different BG Jobs
+    - Different Deployment
+  
+- Additional Gems:
+  - Pagy
+- Ansible repo setup if deploy is Capistrano

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'schienenzeppelin'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/sz

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'pathname'
+
+source_path = File.expand_path("#{Pathname.new(__FILE__).dirname}/../lib")
+$LOAD_PATH << source_path
+
+require 'schienenzeppelin'
+
+if ARGV.empty?
+  puts 'Please provide a path for the new application'
+  puts
+  puts 'See --help for more info'
+  exit 0
+elsif %w[-v --version].include? ARGV[0]
+  puts Schienenzeppelin::VERSION
+  exit 0
+end
+
+templates_root = File.expand_path(File.join('..', 'templates'), File.dirname(__FILE__))
+Schienenzeppelin::AppGenerator.source_root templates_root
+Schienenzeppelin::AppGenerator.source_paths << Rails::Generators::AppGenerator.source_root << templates_root
+
+Schienenzeppelin::AppGenerator.start

data/lib/schienenzeppelin.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'rails/command/base'
+require 'rails/generators/app_base'
+require 'rails/generators'
+require 'rails/generators/app_name'
+require 'rails/generators/rails/app/app_generator'
+require 'bundler'
+
+require_relative 'schienenzeppelin/version'
+require_relative 'schienenzeppelin/helper_base'
+Dir[File.join(__dir__, 'schienenzeppelin', 'helpers', '*.rb')].sort.each { |file| require file }
+require_relative 'schienenzeppelin/app_generator'
+require_relative 'schienenzeppelin/app_builder'
+
+module Schienenzeppelin
+  class Error < StandardError; end
+end

data/lib/schienenzeppelin/app_builder.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  class AppBuilder < Rails::AppBuilder
+    def bin
+      super
+      template 'bin/setup.erb', 'bin/setup', force: true
+    end
+
+    def credentials
+      super
+      # This sets up credentials using a custom template for both development and production use
+      Schienenzeppelin::Helpers::Credentials.apply
+    end
+
+    def readme
+      template 'README.md.erb', 'README.md'
+    end
+
+    def ruby_version
+      template '.tool-versions.erb', '.tool-versions'
+    end
+
+    def gemfile
+      template 'Gemfile.erb', 'Gemfile'
+    end
+
+    def gitignore
+      template '.gitignore.erb', '.gitignore'
+    end
+
+    def irbrc
+      template '.irbrc.erb', '.irbrc'
+    end
+
+    def docker
+      template 'Dockerfile.erb', 'Dockerfile'
+      template '.dockerignore.erb', '.dockerignore'
+      template 'docker-compose.yml.erb', 'docker-compose.yml'
+    end
+
+    def dotenv
+      template '.env.development.erb', '.env.development'
+    end
+
+    def foreman
+      template '.foreman.erb', '.foreman'
+      template 'Procfile.erb', 'Procfile'
+      template 'Procfile.dev.erb', 'Procfile.dev'
+    end
+
+    def database_yml
+      if options[:database] == 'postgresql'
+        template 'config/postgresql.yml.erb', 'config/database.yml'
+      else
+        super
+      end
+    end
+
+    def lograge
+      template 'config/initializers/lograge.rb'
+    end
+
+    def sidekiq
+      Schienenzeppelin::Helpers::Sidekiq.apply
+    end
+
+    def pundit
+      Schienenzeppelin::Helpers::Pundit.apply
+    end
+
+    def rspec
+      Schienenzeppelin::Helpers::Rspec.apply
+    end
+
+    def shoulda
+      template 'spec/support/shoulda_matchers.rb'
+    end
+
+    def high_voltage
+      Schienenzeppelin::Helpers::HighVoltage.apply
+    end
+
+    def factory_bot
+      Schienenzeppelin::Helpers::FactoryBot.apply
+    end
+  end
+end

data/lib/schienenzeppelin/app_generator.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  class AppGenerator < Rails::Generators::AppGenerator
+    class_option :database,
+                 type: :string,
+                 aliases: '-d',
+                 default: 'postgresql',
+                 desc: "Preconfigure for selected database (options: #{DATABASES.join('/')})"
+
+    class_option :skip_active_job,
+                 type: :boolean, default: true,
+                 desc: 'Skip Active Job'
+
+    class_option :skip_jbuilder,
+                 type: :boolean,
+                 default: true,
+                 desc: 'Skip jbuilder gem'
+
+    class_option :skip_test,
+                 type: :boolean,
+                 aliases: '-T', default: true,
+                 desc: 'Skip test files'
+
+    class_option :skip_sidekiq,
+                 type: :boolean, default: false,
+                 desc: 'Skip sidekiq'
+
+    class_option :skip_rspec,
+                 type: :boolean,
+                 aliases: '-T', default: false,
+                 desc: 'Skip rspec'
+
+    def create_config_files
+      super
+      Schienenzeppelin::Helpers::Generators.apply
+    end
+
+    def create_root_files
+      super
+
+      build(:irbrc)
+      build(:foreman)
+      build(:dotenv)
+      build(:docker)
+      build(:docker_compose)
+      # TODO: Make optional
+      # Schienenzeppelin::Helpers::Rubocop.apply
+    end
+
+    def create_test_files
+      build(:test) unless options[:skip_test]
+      build(:rspec) unless options[:skip_rspec]
+      build(:factory_bot) unless options[:skip_factory_bot]
+      build(:shoulda) unless options[:skip_shoulda]
+    end
+
+    def finish_template
+      super
+      # These require the presence of config/controllers, so they must be done after everything else
+      Schienenzeppelin::Helpers::Annotate.apply
+      build(:lograge)
+      build(:high_voltage)
+      build(:pundit)
+      Schienenzeppelin::Helpers::Services.apply unless options[:skip_services]
+      build(:sidekiq)
+    end
+
+    def after_install
+      Schienenzeppelin::Helpers::Devise.apply
+      Schienenzeppelin::Helpers::Stimulus.apply
+      # TODO: Re-enable with Rails 6.2
+      # Schienenzeppelin::Helpers::Hotwire.apply
+      Schienenzeppelin::Helpers::Tailwind.apply
+      Schienenzeppelin::Helpers::StimulusComponents.apply
+
+      Schienenzeppelin::Helpers::Home.apply
+      Schienenzeppelin::Helpers::Errors.apply
+      Schienenzeppelin::Helpers::Scaffold.apply
+
+      Schienenzeppelin::Helpers::ContinuousIntegration.apply
+      Schienenzeppelin::Helpers::Capistrano.apply
+    end
+
+    def self.banner
+      "sz new #{arguments.map(&:usage).join(' ')} [options]"
+    end
+
+    protected
+
+    def get_builder_class
+      Schienenzeppelin::AppBuilder
+    end
+  end
+end

data/lib/schienenzeppelin/helper_base.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  class HelperBase < Rails::Generators::Base
+    include Thor::Actions
+    include Rails::Generators::Actions
+    include Rails::Generators::AppName
+
+    def self.apply(options = {})
+      new(options).apply
+    end
+
+    def initialize(options, *)
+      super
+      @options = options
+    end
+
+    private_class_method :new
+
+    def apply
+      raise NotImplementedError
+    end
+
+    def self.default_source_root
+      File.expand_path(File.join('..', '..', 'templates'), __dir__)
+    end
+  end
+end

data/lib/schienenzeppelin/helpers/annotate.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  module Helpers
+    class Annotate < HelperBase
+      def apply
+        template('lib/tasks/auto_annotate_models.rake', force: true)
+      end
+    end
+  end
+end

data/lib/schienenzeppelin/helpers/capistrano.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  module Helpers
+    class Capistrano < HelperBase
+      def apply
+        say 'Installing and configuring Capistrano'
+        run('bundle exec cap install', capture: true)
+        directory('lib/capistrano', 'lib/capistrano')
+
+        configure_deploy
+
+        template('Capfile.erb', 'Capfile', force: true)
+      end
+
+      private
+
+      def configure_deploy
+        gsub_file('config/deploy.rb', /set :application, .+/, "set :application, '#{app_name}'")
+        uncomment_lines('config/deploy.rb', /set :deploy_to/)
+        gsub_file('config/deploy.rb', /set :deploy_to, .+"/, 'set :deploy_to, "/home/deploy/#{fetch :application}"') # rubocop:disable Lint/InterpolationCheck
+
+        uncomment_lines('config/deploy.rb', /set :keep_releases/)
+        uncomment_lines('config/deploy.rb', /append :linked_dirs/)
+        uncomment_lines('config/deploy.rb', /ask :branch/)
+        gsub_file('config/deploy.rb', /ask :branch/, 'set :branch')
+        append_to_file('config/deploy.rb') do
+          <<~RUBY
+            set :passenger_restart_with_sudo, true
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/schienenzeppelin/helpers/continuous_integration.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  module Helpers
+    class ContinuousIntegration < HelperBase
+      def apply
+        say 'Setting up GitHub CI'
+        template('.github/workflows/build.yml.erb', '.github/workflows/build.yml')
+      end
+    end
+  end
+end

data/lib/schienenzeppelin/helpers/credentials.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  module Helpers
+    class Credentials < HelperBase
+      def apply
+        key_path = Pathname.new('config/credentials/production.key')
+        create_credential_files(key_path, 'config/credentials/production.yml.enc')
+      end
+
+      private
+
+      def create_credential_files(key_path, file_path)
+        key = ActiveSupport::EncryptedFile.generate_key
+        encryption_key_file_generator.add_key_file_silently(key_path, key)
+        require 'active_support/encrypted_file'
+        ActiveSupport::EncryptedFile.new(
+          content_path: file_path,
+          key_path: key_path,
+          env_key: 'RAILS_MASTER_KEY',
+          raise_if_missing_key: true
+        ).write(credentials_template)
+      end
+
+      def encryption_key_file_generator
+        require 'rails/generators/rails/encrypted_file/encrypted_file_generator'
+        Rails::Generators::EncryptionKeyFileGenerator.new
+      end
+
+      def credentials_template
+        context = instance_eval('binding', __FILE__, __LINE__)
+        source = File.expand_path(find_in_source_paths('config/credentials.yml.erb'))
+        match = ERB.version.match(/(\d+\.\d+\.\d+)/)
+        capturable_erb = capturable_erb(match, source)
+        capturable_erb.tap do |erb|
+          erb.filename = source
+        end.result(context)
+      end
+
+      def capturable_erb(match, source)
+        if match && match[1] >= '2.2.0' # Ruby 2.6+
+          CapturableERB.new(::File.binread(source), trim_mode: '-', eoutvar: '@output_buffer')
+        else
+          CapturableERB.new(::File.binread(source), nil, '-', '@output_buffer')
+        end
+      end
+    end
+  end
+end