kowl 0.0.1

data/lib/kowl/generators/controller_generator.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require_relative 'base'
+
+module Kowl
+  class ControllerGenerator < Kowl::Generators::Base
+    hide!
+    source_root File.expand_path(File.join('..', 'templates', 'app', 'controllers'), File.dirname(__FILE__))
+    class_option :noauth, type: :boolean, default: false
+
+    # Add application_controller callbacks depending on if the application requires user auth or not
+    def app_controller_auth
+      if options[:noauth]
+        app_str = <<~APP
+          protect_from_forgery with: :exception
+          include ErrorHandlers     # Application fallbacks
+          helper :all
+        APP
+        inject_into_file 'app/controllers/application_controller.rb', optimize_indentation(app_str, 2), after: "class ApplicationController < ActionController::Base\n"
+        copy_file('concerns/noauth/error_handlers.rb', 'app/controllers/concerns/error_handlers.rb')
+      else
+        app_str = <<~APP
+          protect_from_forgery with: :exception
+          before_action :authenticate_user!
+          impersonates :user
+
+          include Authentication    # Devise/Authentication stuff
+          include Authorization     # To determine if a user is authorized to do a specific action
+          include ErrorHandlers     # Application fallbacks
+          helper :all
+        APP
+
+        inject_into_file 'app/controllers/application_controller.rb', optimize_indentation(app_str, 2), after: "class ApplicationController < ActionController::Base\n"
+        directory 'concerns/auth', 'app/controllers/concerns', force: true
+      end
+    end
+
+    def make_controller_immuatable
+      inject_into_file 'app/controllers/application_controller.rb', "# frozen_string_literal: true\n\n", before: "class ApplicationController < ActionController::Base\n"
+    end
+
+    # This allows the application to dynamically assign the mail delivery host when running in development and staging
+    def set_default_url_options
+      mailer_str = <<~MAILER_STR
+        before_action :mailer_set_url_options unless Rails.env.production?
+
+        private
+
+        def mailer_set_url_options
+          ActionMailer::Base.default_url_options[:host] = request.host_with_port
+        end
+      MAILER_STR
+      inject_into_file 'app/controllers/application_controller.rb', optimize_indentation(mailer_str, 2), after: "helper :all\n"
+    end
+
+    # Enable additional flash_types to the application_controller
+    def enable_additional_flash_types
+      flash_str = "add_flash_types :success, :error # Enable additional flash types across the application\n"
+
+      inject_into_file 'app/controllers/application_controller.rb', optimize_indentation(flash_str, 2), after: "class ApplicationController < ActionController::Base\n"
+    end
+  end
+end

data/lib/kowl/generators/database_generator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require_relative 'base'
+
+# Database configurations
+# https://api.rubyonrails.org/v5.1/classes/ActiveRecord/ConnectionAdapters/ConnectionPool.html
+# https://devcenter.heroku.com/articles/concurrency-and-database-connections
+module Kowl
+  class DatabaseGenerator < Kowl::Generators::Base
+    hide!
+    source_root File.expand_path(File.join('..', 'templates'), File.dirname(__FILE__))
+    class_option :database, type: :string, aliases: '-d', default: 'sqlite3'
+    class_option :noauth, type: :boolean, default: false
+    class_option :uuid, type: :boolean, default: false
+
+    # Used to generate the config for automatically generating annotated models
+    def setup_annotate
+      generate('annotate:install')
+    end
+
+    # If the application is using postgresql this will add pghero to the application
+    def setup_pghero
+      return unless options[:database] == 'postgresql'
+
+      generate('pghero:config') # generate PGhero config
+      generate('pghero:query_stats') # generate pghero stats migrations
+      generate('pghero:space_stats')
+      add_to_assets('pghero/application.js pghero/application.css')
+    end
+
+    # Copy a base seef file to the application with sample users
+    def copy_seed_file
+      template('db/seeds.rb.tt', 'db/seeds.rb', force: true)
+    end
+
+    # Add frozen_string_literal to application_record.rb
+    def make_ar_immutable
+      inject_into_file('app/models/application_record.rb', "# frozen_string_literal: true\n\n", before: "class ApplicationRecord < ActiveRecord::Base\n")
+    end
+  end
+end

data/lib/kowl/generators/decorators_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require_relative 'base'
+
+module Kowl
+  class DecoratorsGenerator < Kowl::Generators::Base
+    hide!
+    class_option :noauth, type: :boolean, default: false
+
+    # Generate a user decorator file for the applications users model
+    def users_decorator
+      generate('decorator user') unless options[:noauth]
+    end
+  end
+end

data/lib/kowl/generators/docker_generator.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require_relative 'base'
+
+module Kowl
+  class DockerGenerator < Kowl::Generators::Base
+    hide!
+    source_root File.expand_path(File.join('..', 'templates', 'docker'), File.dirname(__FILE__))
+    class_option :encrypt, type: :boolean, default: false
+    class_option :database, type: :string, default: 'sqlite3'
+    class_option :docker_distro, type: :string, default: 'alpine'
+    class_option :skip_erd, type: :boolean, default: false
+    class_option :skip_javascript, type: :boolean, default: false
+    class_option :skip_sidekiq, type: :boolean, default: false
+
+    # Generate the applications Dockerfile depending on the the specified distro
+    def setup_dockerfile
+      if options[:docker_distro] == 'debian' || options[:database] == 'oracle'
+        # This is here because Debian is very compatible with most Ruby/Rails gems
+        # => The Oracle InstantClient does have a number of issues when trying to build with Alpine
+        template 'Dockerfile.debian.tt', 'Dockerfile'
+      else
+        template 'Dockerfile.alpine.tt', 'Dockerfile'
+      end
+    end
+
+    # Generate an applications docker-compose.yml file based on all it's specified requirements
+    def setup_docker_compose
+      template 'docker-compose.yml.tt', 'docker-compose.yml'
+    end
+
+    # If one of the specified databases are being used, generate a specific Dockerfile to generate the required tables
+    def setup_database_dockerfile
+      return nil unless options[:database] == 'mysql'
+
+      template 'mysql/Dockerfile.tt', 'docker/Dockerfile'
+    end
+  end
+end

data/lib/kowl/generators/dotfiles_generator.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require_relative 'base'
+
+module Kowl
+  class DotfilesGenerator < Kowl::Generators::Base
+    hide!
+    source_root File.expand_path(File.join('..', 'templates', 'dotfiles'), File.dirname(__FILE__))
+    class_option :encrypt, type: :boolean
+    class_option :template_engine, type: :string
+    class_option :test_engine, type: :string
+    class_option :database, type: :string
+    class_option :mailer, type: :string
+    class_option :skip_docker, type: :boolean, default: false
+    class_option :skip_erd, type: :boolean, default: false
+    class_option :skip_javascript, type: :boolean
+    class_option :skip_mailer, type: :boolean
+    class_option :skip_sidekiq, type: :boolean
+    class_option :skip_pry, type: :boolean
+    class_option :skip_tests, type: :boolean
+
+    # Copy basic application linter dotfiles to the applications ROOT_PATH
+    def copy_dotfiles
+      files = %w[codeclimate.yml coffeelint.json coffeelintignore dockerignore editorconfig fasterer.yml foreman gitattributes mailmap nvmrc rspec scss-lint.yml simplecov slugignore yamllint]
+      files.reject! { |e| e =~ /dockerignore/ } if options[:skip_docker]
+      files.map { |dotfile| copy_file dotfile, ".#{dotfile}" }
+    end
+
+    # Copy JS dotfiles for linterers over the applications ROOT_PATH
+    def copy_js_dotfiles
+      return if options[:skip_javascript]
+
+      js_files = %w[eslintignore eslintrc.js jsbeautifyrc jshintrc prettierignore prettierrc.js yarnclean]
+      js_files.map { |dotfile| copy_file dotfile, ".#{dotfile}" }
+    end
+
+    # Setup Rubocop and ERD dotfiles for the application
+    def setup_application_dotfiles
+      files = %w[erdconfig rubocop.yml]
+      files.reject! { |e| e =~ /erdconfig/ } if options[:skip_erd]
+      files.map { |dotfile| template "#{dotfile}.tt", ".#{dotfile}" }
+    end
+
+    # Setup application dotfiles for the applications specific template_engine [Erb, Slim, HAML]
+    def setup_linter_dotfiles
+      copy_file "#{options[:template_engine]}-lint.yml", ".#{options[:template_engine]}-lint.yml"
+    end
+
+    # Generate a Brewfile for the application based on it's specific requirerments (for macOS)
+    def setup_brewfile
+      template 'Brewfile.tt', 'Brewfile'
+    end
+
+    # Generate an Aptfile for the application based on it's specific requirements (for Debian/Ubuntu)
+    def setup_aptfile
+      template 'Aptfile.tt', 'Aptfile'
+    end
+
+    # Setup .env file for the application, which makes it easier to use this config with docker-compose as well
+    # Note: An .env file is setup instead of an .env.docker file because of the way env_file works with docker-compose
+    # => At the moment, when running a build with docker-compose if an env_file is anything other than .env the variables won't be consumed by the container build process
+    def setup_env_file
+      %w[development staging production test].map { |env| template 'env.tt', ".env.#{env}", env: env }
+      template 'env.tt', '.env', env: 'docker' unless options[:skip_docker]
+    end
+
+    # Generate a basic pry config file for the application
+    def pryrc
+      copy_file('pryrc', '.pryrc') unless options[:skip_pry]
+    end
+  end
+end

data/lib/kowl/generators/libs_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require_relative 'base'
+
+module Kowl
+  class LibsGenerator < Kowl::Generators::Base
+    hide!
+    source_root File.expand_path(File.join('..', 'templates', 'lib', 'tasks'), File.dirname(__FILE__))
+    class_option :simpleform, type: :boolean, default: false
+    class_option :skip_javascript, type: :boolean, default: false
+    hide!
+
+    # Generate a Rake file for viewing additional Rails applications stats
+    def stats_task
+      copy_file 'stats.rake', 'lib/tasks/stats.rake', force: true
+    end
+  end
+end

data/lib/kowl/generators/mailer_generator.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require_relative 'base'
+
+# This class is for setting up the bootstrap mailer when using bootstrap framework and devise
+module Kowl
+  class MailerGenerator < Kowl::Generators::Base
+    hide!
+    source_root File.expand_path(File.join('..', 'templates'), File.dirname(__FILE__))
+    class_option :encrypt, type: :boolean, default: false
+    class_option :mailer, type: :string, default: 'sparkpost', enum: %w[postmark sparkpost]
+    class_option :noauth, type: :boolean, default: false
+
+    # Add DeviseMailer layout view, to cleanup devise emails
+    def copy_mailer_layouts
+      copy_file('app/views/layouts/devise_mailer.html.erb', 'app/views/layouts/devise_mailer.html.erb') unless options[:noauth]
+    end
+
+    # Override the applications default application_mailer file with some basic config
+    def override_application_mailer
+      copy_file 'app/mailers/application_mailer.rb', 'app/mailers/application_mailer.rb', force: true
+    end
+
+    # Add a devise mailer layout the application if devise is to be used
+    def copy_devise_mailer_config
+      copy_file('app/mailers/devise_mailer.rb', 'app/mailers/devise_mailer.rb') unless options[:noauth]
+    end
+
+    # Add the applications assets that need to be compiled for the mailer
+    def add_mailer_assets
+      copy_file('app/assets/stylesheets/bootstrap/application-mailer.scss')
+      add_to_assets('application-mailer.scss')
+    end
+
+    # Setup letter_opener config and initializer to catch emails in development
+    def setup_letter_opener
+      smtp_config = <<~LETTER_OPENER
+        # Specify if you you have a preference which method you want SMTP responses to be handled in dev
+        # config.action_mailer.delivery_method = :letter_opener
+        config.action_mailer.delivery_method = :letter_opener_web
+        config.action_mailer.perform_deliveries = true
+        config.action_mailer.raise_delivery_errors = false
+      LETTER_OPENER
+      dev_config(smtp_config)
+      copy_file('config/initializers/letter_opener.rb', 'config/initializers/letter_opener.rb')
+    end
+
+    # Setup a mailer initializer for production, based on the application config
+    def setup_production_mailer
+      if options[:mailer] == 'postmark'
+        copy_file('config/initializers/postmark.rb', 'config/initializers/postmark.rb', force: true)
+      else
+        copy_file('config/initializers/sparkpost.rb', 'config/initializers/sparkpost.rb', force: true)
+      end
+    end
+  end
+end

data/lib/kowl/generators/misc_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require_relative 'base'
+
+module Kowl
+  class MiscGenerator < Kowl::Generators::Base
+    hide!
+    source_root File.expand_path(File.join('..', 'templates'), File.dirname(__FILE__))
+
+    # Create variables folders in the /apps path for services, workers, etc
+    def create_app_folders
+      folders = %w[serializers services workers]
+
+      folders.each do |d|
+        mk_appdir("app/#{d}")
+      end
+    end
+  end
+end

data/lib/kowl/generators/overrides/app_base.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+require 'rails/generators/app_base'
+require_relative('../../actions')
+
+# https://github.com/rails/rails/blob/master/railties/lib/rails/generators/app_base.rb
+module Kowl
+  module Overrides
+    class AppBase < Rails::Generators::AppBase
+      # More stuff coming soon
+    end
+  end
+end

data/lib/kowl/generators/overrides/app_builder.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# https://www.rubydoc.info/gems/railties/5.0.0/Rails/AppBuilder
+# https://github.com/rails/rails/blob/b2eb1d1c55a59fee1e6c4cba7030d8ceb524267c/railties/lib/rails/generators/rails/app/app_generator.rb#L45
+# https://api.rubyonrails.org/v5.1/classes/Rails/AppBuilder.html
+module Kowl
+  module Overrides
+    class AppBuilder < Rails::AppBuilder
+      # Override the applications .gitignore file with a more rails specific one
+      def gitignore
+        copy_file 'dotfiles/gitignore', '.gitignore', force: true
+      end
+
+      # Override the rails applications README with a new one (displaying application specific information in the readme)
+      def readme
+        template 'README.md.erb', 'README.md'
+        # This is here, because if --skip_tests is added, it skips running the gitignore function
+        # => since all projects have a readme this should just overwrite the gitignore file
+        copy_file 'dotfiles/gitignore', '.gitignore', force: true
+      end
+
+      # Generate procfile for anyone who uses foreman to run their rails application, sidekiq, and various other services at once
+      def procfile
+        # Generate base Procfile
+        template 'dotfiles/Procfile.tt', 'Procfile'
+        # Generate Procfile running foreman in development
+        template 'dotfiles/Procfile.tt', 'Procfile.dev', env: 'development'
+      end
+
+      # Regenerate the applications spring based binstubs
+      def setup_spring
+        bundle_command 'exec spring binstub --all'
+      end
+
+      # Replace the applications Gemfile with gems that are made to get you started faster
+      def replace_gemfile
+        # Gemfile template needs to be 'Gemfile.erb' otherwise it attempts to fetch Gemfile template from the Rails gem
+        # https://github.com/rails/rails/blob/master/railties/lib/rails/generators/rails/app/templates/Gemfile.tt#L9
+        template 'Gemfile.erb', 'Gemfile', force: true
+      end
+
+      # Override the default generated database.yml file
+      def database_yml
+        # Application will be defaulted to using sqlite3, until ready
+        # => Application will also have a database[database].yml file to replace and run once the application is read
+        template 'config/db/sqlite3.yml', 'config/database.yml', force: true
+
+        # The directory config/databases/** is already used by Rails. We don't want to override this, because it won't pull from the gems template files, because they already exist in the rails gem
+        # /Users/username/.rvm/gems/ruby-2.6.2/gems/railties-6.0.0/lib/rails/generators/rails/app/templates/config/databases
+        if %w[mysql oracle postgresql sqlite3 sqlserver].include? options[:database]
+          template "config/db/#{options[:database]}.yml", "config/database[#{options[:database]}].yml" unless options[:database] == 'sqlite3'
+        else
+          template "config/databases/#{options[:database]}.yml", "config/database[#{options[:database]}].yml"
+        end
+      end
+    end
+  end
+end