schienenzeppelin 0.1

data/lib/schienenzeppelin/helpers/devise.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  module Helpers
+    class Devise < HelperBase
+      def apply
+        generate('devise:install', capture: true)
+        generate(:devise, 'User', 'name', 'admin:boolean', capture: true)
+        directory('app/views/devise', 'app/views/devise')
+
+        inject_into_file 'config/environments/development.rb', before: /^end/ do
+          <<-RUBY
+
+  # Enable devise mailer
+  config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
+          RUBY
+        end
+
+        gsub_file 'config/initializers/devise.rb', /# config.pepper = .+/, "  # config.pepper = 'pepper'"
+        gsub_file 'config/initializers/devise.rb', /# config.secret_key = .+/, "  # config.secret_key = 'secret_key'"
+
+        db_changes
+      end
+
+      private
+
+      def db_changes
+        in_root do
+          migration = Dir.glob('db/migrate/*').max_by { |f| File.mtime(f) }
+          gsub_file migration, /:admin/, ':admin, default: false'
+        end
+        insert_into_file 'db/seeds.rb' do
+          <<~RUBY
+            # Create an initial admin user for development
+            User.find_or_create_by(email: "admin@admin.com") do |user|
+              user.name = 'Admin'
+              user.password = 'password'
+              user.admin = true
+            end
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/schienenzeppelin/helpers/errors.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  module Helpers
+    class Errors < HelperBase
+      def apply
+        say 'Setting up custom error pages'
+        add_errors
+        setup_public
+        add_routes
+        patch_turbolinks
+      end
+
+      private
+
+      def setup_public
+        template('public/500.html.erb', 'public/500.html', force: true)
+        remove_file('public/404.html')
+        remove_file('public/422.html')
+      end
+
+      def add_errors
+        directory('app/views/errors', 'app/views/errors')
+        template('app/controllers/errors_controller.rb.erb', 'app/controllers/errors_controller.rb')
+        inject_into_file 'config/application.rb', before: /^ {2}end\n/ do
+          <<-RUBY
+    # Enable custom error pages
+    config.exceptions_app = routes
+          RUBY
+        end
+      end
+
+      def add_routes
+        inject_into_file 'config/routes.rb', before: /^end/ do
+          <<-RUBY
+  get '/404', to: 'errors#not_found'
+  get '/422', to: 'errors#unacceptable'
+  get '/500', to: 'errors#internal_error'
+          RUBY
+        end
+      end
+
+      def patch_turbolinks
+        inject_into_file 'app/javascript/packs/application.js' do
+          <<~JS
+            // Patching turbolinks to allow custom errors
+            // See https://github.com/turbolinks/turbolinks/issues/179
+            window.Turbolinks.HttpRequest.prototype.requestLoaded = function() {
+              return this.endRequest(function() {
+                var code = this.xhr.status;
+                if (200 <= code && code < 300 ||
+                    code === 403 || code === 404 || code === 500) {
+                  this.delegate.requestCompletedWithResponse(
+                      this.xhr.responseText,
+                      this.xhr.getResponseHeader("Turbolinks-Location"));
+                } else {
+                  this.failed = true;
+                  this.delegate.requestFailedWithStatusCode(code, this.xhr.responseText);
+                }
+              }.bind(this));
+            };
+          JS
+        end
+      end
+    end
+  end
+end

data/lib/schienenzeppelin/helpers/factory_bot.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  module Helpers
+    class FactoryBot < HelperBase
+      def apply
+        # TODO: Make this work for minitest
+        empty_directory 'spec/factories'
+        template('spec/support/factory_bot.rb')
+      end
+    end
+  end
+end

data/lib/schienenzeppelin/helpers/generators.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  module Helpers
+    class Generators < HelperBase
+      def apply
+        directory('lib/generators', 'lib/generators')
+        generators = <<-RUBY
+    config.generators do |generate|
+        require_relative '../lib/generators/rails/scaffold_controller_generator'
+        generate.helper false
+        generate.javascripts false
+        generate.request_specs false
+        generate.routing_specs false
+        generate.stylesheets false
+        generate.test_framework :rspec
+        generate.view_specs false
+        generate.jb true
+        generate.factory_bot true
+    end
+        RUBY
+        inject_into_file 'config/application.rb', generators, before: /^ {2}end\n/
+      end
+    end
+  end
+end

data/lib/schienenzeppelin/helpers/high_voltage.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  module Helpers
+    class HighVoltage < HelperBase
+      def apply
+        template('config/initializers/high_voltage.rb')
+      end
+    end
+  end
+end

data/lib/schienenzeppelin/helpers/home.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  module Helpers
+    class Home < HelperBase
+      def apply
+        say 'Setting up custom landing page'
+        directory 'app/views/layouts', 'app/views/layouts', force: true
+        directory 'app/views/pages', 'app/views/pages'
+        directory 'app/views/shared', 'app/views/shared'
+        # Make sure we can access any images put into the images folder
+        inject_into_file('app/javascript/packs/application.js', "require.context('../images', true)")
+        directory 'app/javascript/images', 'app/javascript/images'
+      end
+    end
+  end
+end

data/lib/schienenzeppelin/helpers/hotwire.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  module Helpers
+    class Hotwire < HelperBase
+      def apply
+        rails_command('hotwire:install')
+      end
+    end
+  end
+end

data/lib/schienenzeppelin/helpers/pundit.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  module Helpers
+    class Pundit < HelperBase
+      def apply
+        directory 'app/policies', 'app/policies'
+        template 'app/controllers/authorized_controller.rb.erb', 'app/controllers/authorized_controller.rb'
+      end
+    end
+  end
+end

data/lib/schienenzeppelin/helpers/rspec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  module Helpers
+    class Rspec < HelperBase
+      def apply
+        create_file('.rspec', '--require spec_helper')
+        template('spec/rails_helper.rb')
+        template('spec/spec_helper.rb')
+      end
+    end
+  end
+end

data/lib/schienenzeppelin/helpers/rubocop.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  module Helpers
+    class Rubocop < HelperBase
+      def apply
+        template '.rubocop.yml.erb', '.rubocop.yml'
+      end
+    end
+  end
+end

data/lib/schienenzeppelin/helpers/scaffold.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  module Helpers
+    class Scaffold < HelperBase
+      def apply
+        directory 'lib', 'lib'
+      end
+    end
+  end
+end

data/lib/schienenzeppelin/helpers/services.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  module Helpers
+    class Services < HelperBase
+      def apply
+        directory 'app/services', 'app/services'
+      end
+    end
+  end
+end

data/lib/schienenzeppelin/helpers/sidekiq.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  module Helpers
+    class Sidekiq < HelperBase
+      def apply
+        say 'Setting up sidekiq'
+        empty_directory('app/workers')
+        create_file('app/workers/.keep')
+      end
+    end
+  end
+end

data/lib/schienenzeppelin/helpers/stimulus.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  module Helpers
+    class Stimulus < HelperBase
+      def apply
+        rails_command('stimulus:install')
+      end
+    end
+  end
+end

data/lib/schienenzeppelin/helpers/stimulus_components.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  module Helpers
+    class StimulusComponents < HelperBase
+      def apply
+        run('yarn add tailwindcss-stimulus-components')
+        inject_into_file('app/javascript/packs/application.js') do
+          <<~JS
+            import { Application } from "stimulus"
+            import { definitionsFromContext } from "stimulus/webpack-helpers"
+
+            const application = Application.start();
+            const context = require.context("controllers", true, /.js$/);
+            application.load(definitionsFromContext(context));
+
+            import { Dropdown, Modal, Tabs, Popover, Toggle, Slideover } from "tailwindcss-stimulus-components"
+            application.register('dropdown', Dropdown)
+            application.register('modal', Modal)
+            application.register('tabs', Tabs)
+            application.register('popover', Popover)
+            application.register('toggle', Toggle)
+            application.register('slideover', Slideover)
+          JS
+        end
+      end
+    end
+  end
+end

data/lib/schienenzeppelin/helpers/tailwind.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  module Helpers
+    class Tailwind < HelperBase
+      def apply
+        rails_command('tailwindcss:install')
+        template('app/javascript/stylesheets/components.scss')
+        insert_into_file 'app/javascript/stylesheets/application.scss' do
+          <<~CSS
+
+            @import "components";
+          CSS
+        end
+      end
+    end
+  end
+end

data/lib/schienenzeppelin/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  VERSION = '0.1'
+  RAILS_VERSION = '~> 6.1.2'
+  RUBY_VERSION = '3.0.0'
+end

data/schienenzeppelin.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'date'
+require_relative 'lib/schienenzeppelin/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'schienenzeppelin'
+  spec.version = Schienenzeppelin::VERSION
+  spec.authors = ['Hans-Jörg Schnedlitz']
+  spec.email = ['hans.schnedlitz@gmail.com']
+  spec.date = Date.today.strftime('%Y-%m-%d')
+
+  spec.summary = 'The Rails app generator that gets you started quickly'
+  spec.description = <<~HEREDOC
+    Schienenzeppelin is the Ruby on Rails app generator to get you started quickly. Includes TailwindCSS,
+    Devise, Capistrano and much more.
+  HEREDOC
+  spec.license = 'MIT'
+  spec.homepage = 'https://github.com/hschne/schienenzeppelin'
+
+  spec.required_ruby_version = Gem::Requirement.new(">= #{Schienenzeppelin::RUBY_VERSION}")
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/hschne/schienenzeppelin'
+  spec.metadata['changelog_uri'] = 'https://github.com/hschne/schienenzeppelin/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rails', Schienenzeppelin::RAILS_VERSION
+end

data/script.md

@@ -0,0 +1,104 @@
+
+# Script
+
+## Prep
+
+- SSH agent eval
+- Empty GH repo
+- Reset local docker
+- Droplet reset database (but make sure DB exists!)
+- Make sure spring boot is not on
+
+## Steps
+
+When you start a new application with Rails, I usually spend ours adding things to make it production ready. From database configuration, to little 
+development tweaks, to thing like authentication and styling. Wouldn't it be nice if generating a new application gave you 
+all these things out of the box?
+
+Schienenzeppelin was made to create a production ready app that you can deploy within minutes. And that's exactly what I'll show here.
+
+After you've installed the gem, just run it to create a new application.
+
+```bash
+sz tweeter
+```
+
+This generates a new application, like rails new, but with some tweaks. The focus here is to get a nice looking, functional 
+application to production as quick as possible. 
+
+That includes
+- Basic styling - using Tailwind
+- Authentication using Devise
+- A production ready database and credential setup
+- And capistrano deployment out of the box
+
+There are tons of little details and utilities included, I'll leave a link in the description for you to check out.
+
+Now that that's done, let's have a look at what we got.
+```bash
+cd tweeter
+```
+
+Now the first nice thing is that although we depend on things like postgres and redis for example for Sidekiq, there's no need to install
+any of that if you have docker and docker compose. Foreman start to start everything
+```ruby
+foreman start
+```
+We still have to do the usual first time setup
+```
+rails db:setup
+rails db:migrate
+```
+Out of the box we get a responsive homepage, and devise integration, with custom views to boot. A seedfile is provided
+to generate an admin user
+```
+rails db:seed
+```
+So we can login, and edit our profile if we want. 
+
+Let's add a new model and see how that looks.
+```bash
+rails g scaffold tweet
+rails db:migrate
+```
+We can see that that generates a new link, and the scaffold is styled too.
+
+That's dandy and all, let's deploy that thing. We have to edit some files for that.
+```
+vim config/deploy.rb
+set :repo_url, "git@github.com:hschne/tweeter.git"
+```
+
+This assumes you already have set up a server. I'll also leave a link how to set one up.
+```
+vim config/production.rb
+server "207.154.218.89", user: "deploy", roles: %w{app db web}
+```
+
+Before we can deploy, let's push our changes:
+```
+git add . && git commit -m "Initial commit"
+git remote add origin git@github.com:hschne/tweeter.git
+git branch -M main
+git push -f -u origin main 
+```
+
+And deploy
+```
+cap production deploy
+```
+
+Get secret key
+
+```
+cat config/credentials/production.key | xclip -sel clipboard
+```
+
+BREAK
+
+Once that is finished, we can check out the deployed version.
+
+And that is how you deploy a nice looking production ready app using Schienenzeppelin. 
+
+Let me know what you think, and have fun!
+