schienenzeppelin 0.1 → 0.2

data/lib/schienenzeppelin/app_generator.rb

@@ -2,84 +2,76 @@
 
 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
+    include GeneratorUtils
+    overwrite_default_options!
+
+    generate_addon_options!
+
+    generate_addon_skips!
+
+    def initialize(*args)
       super
-      Schienenzeppelin::Helpers::Generators.apply
+
+      return unless options[:api]
+
+      self.options = options.merge(
+        skip_errors: true,
+        skip_high_voltage: true,
+        skip_stimulus: true,
+        skip_tailwind: true,
+        skip_views: true
+      ).freeze
     end
 
     def create_root_files
       super
 
-      build(:irbrc)
-      build(:foreman)
-      build(:dotenv)
-      build(:docker)
-      build(:docker_compose)
-      # TODO: Make optional
-      # Schienenzeppelin::Helpers::Rubocop.apply
+      add(:irbrc)
+      add(:foreman)
+      add(:dotenv)
+      add(:docker)
+      add(:docker_compose)
+      add(:rubocop)
     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]
+      return if options[:skip_test]
+
+      super if options[:testing_framework] == 'minitest'
+
+      add(:rspec) if options[:testing_framework] == 'rspec'
     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)
+      add(:annotate)
+      add(:continuous_integration)
+      add(:high_voltage)
+      add(:generators)
+      add(:lograge)
+      add(:pundit)
+      add(:services)
+      add(:sidekiq)
+      add(:views, :errors, :scaffold)
+
+      add(:factory_bot)
+      add(:shoulda)
     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
+      add(:tailwind, :stimulus, :stimulus_components)
+      add(:devise)
+      add(:capistrano)
+    end
+
+    no_tasks do
+      def uses?(addon)
+        return false if options["skip_#{addon}".to_sym]
+
+        addon = AddOn.get(addon)
+        Dependencies.new(addon, context).satisfied?
+      end
     end
 
     def self.banner

data/lib/schienenzeppelin/context.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  class Context
+    attr_reader :options, :callbacks
+
+    def initialize(options = {})
+      @options = options
+      @callbacks = []
+    end
+
+    def addons
+      AddOns.constants
+        .select { |clazz| AddOns.const_get(clazz).is_a?(Class) }
+        .map(&:name)
+        .map(&:underscore)
+    end
+
+    # Skippable parts of the default Rails generator, e.g. active_record, active_job...
+    def default_addons
+      addon_options = addons.map { |option| "skip_#{option}".to_sym }
+      skip_options = Schienenzeppelin::AppGenerator.class_options.keys.select { |key| key =~ /skip_/ }
+      (skip_options - addon_options).map { |option| option.to_s.delete_prefix('skip_').to_sym }
+    end
+  end
+end

data/lib/schienenzeppelin/dependencies.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  class Dependencies
+    def initialize(addon, context)
+      @addon = addon
+      @context = context
+      @options = context.options
+    end
+
+    def satisfied?
+      @addon.dependencies.each do |dependency|
+        return false unless dependencies_satisfied?(dependency)
+      end
+
+      true
+    end
+
+    private
+
+    def dependencies_satisfied?(addon, visited = [])
+      return false if @options["skip_#{addon}".to_sym]
+
+      return true if @context.default_addons.include?(addon)
+
+      visited << addon
+      dependencies = AddOn.get(addon).dependencies - visited
+      dependencies.each do |dependency|
+        return false unless dependencies_satisfied?(dependency, visited)
+      end
+    end
+  end
+end

data/lib/schienenzeppelin/generator_utils.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Schienenzeppelin
+  module GeneratorUtils
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    protected
+
+    def context
+      @context ||= Context.new(options)
+    end
+
+    private
+
+    def add(*addons)
+      addons.each do |addon|
+        addon = addon.to_s.capitalize.camelize
+        "Schienenzeppelin::AddOns::#{addon}"
+          .constantize
+          .apply(context)
+      end
+    end
+
+    module ClassMethods
+      def overwrite_default_options!
+        databases = Rails::Generators::Database::DATABASES
+        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'
+      end
+
+      def generate_addon_options!
+        test_frameworks = %w[minitest rspec]
+        class_option :test_framework,
+                     type: :string,
+                     default: 'rspec',
+                     desc: "Select a testing framework (options: #{test_frameworks.join('/')})"
+
+        background_jobs = %w[sidekiq].freeze
+        class_option :background_jobs,
+                     type: :string,
+                     default: 'sidekiq',
+                     desc: "Select a background processing (options: #{background_jobs.join('/')})"
+
+        deployments = %w[capistrano].freeze
+        class_option :deployment,
+                     type: :string,
+                     default: 'capistrano',
+                     desc: "Select a deployment option (options: #{deployments.join('/')})"
+
+        version_managers = %w[asdf].freeze
+        class_option :version_manger,
+                     type: :string,
+                     default: 'asdf',
+                     desc: "Select your Version Manager (options: #{version_managers.join('/')})"
+      end
+
+      def generate_addon_skips!
+        Context.new.addons.each do |addon|
+          class_option "skip_#{addon}".to_sym,
+                       type: :boolean,
+                       default: false,
+                       desc: "Skip #{addon.underscore.titleize}"
+        end
+      end
+    end
+  end
+end

data/lib/schienenzeppelin/version.rb

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

data/schienenzeppelin.gemspec

@@ -8,7 +8,6 @@ Gem::Specification.new do |spec|
   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

data/templates/.irbrc.erb

@@ -7,6 +7,6 @@ IRB.conf[:SAVE_HISTORY] = 1000
 IRB.conf[:HISTORY_FILE] = "#{ENV['HOME']}/.irb-history"
 IRB.conf[:PROMPT_MODE] = :SIMPLE
 
-<% unless options[:skip_factory_bot] %>
+<% if uses?(:factory_bot) -%>
 include FactoryBot::Syntax::Methods
-<% end %>
+<% end -%>

data/templates/Dockerfile.erb

@@ -22,7 +22,7 @@ RUN bundle install --without development
 RUN yarn install
 
 FROM cache
-COPY . /bookstore
+COPY . /<%= app_name %>
 
 ARG DATABASE_HOST=db
 ARG RAILS_ENV=production

data/templates/Gemfile.erb

@@ -26,30 +26,49 @@ ruby <%= "'#{RUBY_VERSION}'" -%>
 # gem 'image_processing', '~> 1.2'
 <% end -%>
 
+# Schienenzeppelin
+gem 'schienenzeppelin', '<%= Gem::Version.new(Schienenzeppelin::VERSION).approximate_recommendation %>'
+<% if uses?(:jb) -%>
 # Jb is a faster alternative to jbuilder"
 gem 'jb', '~> 0.8'
+<% end -%>
+<% if uses?(:oj) -%>
 # A fast JSON parser and Object marshaller
 gem 'oj', '~> 3.11'
+<% end -%>
+<% if uses?(:lograge) -%>
 # An attempt to tame noisy Rails logs
 gem "lograge"
+<% end -%>
+<% if uses?(:pundit) -%>
 # Minimal and simple authorization through OO
 gem 'pundit', '~> 2.1'
+<% end -%>
+<% if uses?(:devise) -%>
 # Flexible authentication solution for Rails with Warden
 gem 'devise', '~> 4.7'
+<% end -%>
 
+<% if uses?(:high_voltage) -%>
 # A Rails engine for static pages
 gem 'high_voltage', '~> 3.1'
-# Hotwire is an alternative approach to building modern web applications
-gem 'hotwire-rails'
+<% end -%>
+<% if uses?(:stimulus) -%>
 # Add javascript sprinkles to your views
 gem 'stimulus-rails'
+<% end -%>
+<% if uses?(:tailwind) -%>
 # Tailwind CSS for Rails
 gem 'tailwindcss-rails'
+<% end -%>
+<% if uses?(:inline_svg) -%>
 # Embedded SVGs for easy styling
 gem 'inline_svg'
-
+<% end -%>
+<% if uses?(:sidekiq) -%>
 # Simple, efficient background processing alternative to ActiveJob
 gem 'sidekiq', '~> 6.1'
+<% end -%>
 
 <% if depend_on_bootsnap? -%>
 # Reduces boot times through caching; required in config/boot.rb
@@ -65,21 +84,24 @@ gem 'bootsnap', '>= 1.4.4', require: false
 group :development, :test do
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console
   gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+<% if uses?(:dotenv) -%>
   # A convenient way to manage environment variables
   gem 'dotenv-rails'
-  gem 'rubocop', '~> 1.10', require: false
-<%- unless options[:skip_rspec] -%>
-  gem "rspec-rails"
 <% end -%>
-<%- unless options[:skip_factory_bot] -%>
+
+<% if uses?(:factory_bot) -%>
   gem "factory_bot_rails"
 <% end -%>
+<% if uses?(:rspec) -%>
+  gem "rspec-rails"
+<% end -%>
+<% if uses?(:rubocop) -%>
+  gem 'rubocop', '~> 1.10', require: false
+<% end -%>
 end
 
 <% end -%>
 group :development do
-  # Add a comment summarizing the current schema to  your code
-  gem 'annotate', '~> 3.1'
 <%- unless options.api? || options.skip_dev_gems? -%>
   # Access an interactive console on exception pages or by calling 'console' anywhere in the code.
   <%- if options.dev? || options.edge? || options.main? -%>
@@ -98,15 +120,22 @@ group :development do
   # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
   gem 'spring'
 <% end -%>
+
+<%if uses?(:annotate) -%>
+  # Add a comment summarizing the current schema to  your code
+  gem 'annotate', '~> 3.1'
+<%end -%>
+<% if uses?(:capistrano) -%>
   # Capistrano is used to deploy your application
   gem "capistrano", "~> 3.15", require: false
   gem "capistrano-rails", "~> 1.6", require: false
   gem 'capistrano-passenger', '~> 0.2.0', require: false
   gem 'capistrano-rbenv', '~> 2.2', '>= 2.1.4', require: false
+<% end -%>
 end
 
 group :test do
-<%- unless options[:skip_shoulda] -%>
+<% if uses?(:shoulda) -%>
   gem "shoulda-matchers"
 <% end -%>
 <%- if depends_on_system_test? -%>

data/templates/Procfile.dev.erb

@@ -1,6 +1,10 @@
+<% if uses?(:docker_compose) -%>
 docker: docker-compose up --scale <%= app_name %>=0
-<%- unless options[:skip_sidekiq] -%>
+<% end -%>
+<% if uses?(:sidekiq) -%>
 sidekiq: bundle exec sidekiq
 <% end -%>
+<% if uses?(:webpack_install) -%>
 webpack: bundle exec bin/webpack-dev-server
+<% end -%>
 web: bundle exec rails server -p 3000

data/templates/Procfile.erb

@@ -1,2 +1,4 @@
 web: rails server
+<% if uses?(:sidekiq) -%>
 worker: sidekiq
+<% end -%>

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

@@ -1,19 +1,30 @@
 <header class="shadow">
   <nav
+    <%-if uses?(:stimulus_components) -%>
     data-controller="dropdown"
+    <%- end -%>
     class="container mx-auto flex flex-wrap justify-between items-center p-5">
     <div>
       <a
         class="flex items-center mr-2"
-        href="<%%= root_path %>">
+        <%- if uses?(:high_voltage) -%>
+        href="<%%= root_path %>"
+        <%- else -%>
+        href="/"
+        <%- end -%>
+      >
+        <%- if uses?(:inline_svg) -%>
         <%%= inline_svg_pack_tag('media/images/logo.svg', class: "rounded mx-2", size: "3rem * 3rem") %>
+        <%- end -%>
         <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"
-      >
+      <button
+        <%- if uses?(:stimulus_components) -%>
+        data-action="click->dropdown#toggle click@window->dropdown#hide"
+        <%- end -%>
+        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"/>
@@ -21,11 +32,14 @@
       </button>
     </div>
     <div
+      <%-if uses?(:stimulus_components) -%>
       data-dropdown-target="menu"
+      <%- end -%>
       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>
+      <%-if uses?(:devise) -%>
       <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>
@@ -35,6 +49,7 @@
           <li><%%= link_to "Sign Up", new_user_registration_path, class: "btn btn-blue" %></li>
         <%% end %>
       </ul>
+      <%- end -%>
     </div>
   </nav>
 </header>