kowl 0.0.1

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

@@ -0,0 +1,249 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/rails/app/app_generator'
+require_relative('../../actions')
+require_relative('../../docker')
+# https://github.com/rails/rails/blob/master/railties/lib/rails/generators/rails/app/app_generator.rb
+# https://apidock.com/rails/Rails/Generators/AppGenerator
+# https://www.rubydoc.info/gems/railties/5.0.0/Rails/Generators/AppGenerator#finish_template-instance_method
+# https://doc.bccnsoft.com/docs/rails_3_2_22_api/classes/Rails/Generators/AppBase.html
+# https://github.com/rails/rails/blob/master/guides/source/generators.md
+# List of default rails options -> https://github.com/rails/rails/blob/master/railties/lib/rails/generators/app_base.rb#L27
+module Kowl
+  module Overrides
+    class AppGenerator < Rails::Generators::AppGenerator
+      include Kowl::Actions
+      include Kowl::Docker
+      hide!
+      desc 'A gem for generating Rails applications and still be a step ahead'
+      ##################################################
+      # Options that accept parameters
+      ##################################################
+      class_option :database,           type: :string, aliases: '-d', default: 'sqlite3',
+                                        desc: "Preconfigure for selected database (options: #{DATABASES.join('/')})"
+
+      class_option :framework,          type: :string, default: 'bootstrap', enum: %w[bootstrap semantic none],
+                                        desc: 'Generate the application using a specific CSS Framework'
+
+      class_option :git_repo,           type: :string, default: '',
+                                        desc: 'The remote git repo in which you would like to associate with.'
+
+      class_option :mailer,             type: :string, default: 'sparkpost', enum: %w[postmark sparkpost],
+                                        desc: "Which transactional mailer you'd prefer your application to use."
+
+      class_option :template_engine,    type: :string, default: 'erb', enum: %w[erb slim haml],
+                                        desc: 'The template_engine to use for generating the applications views (Erb, Slim, HAML)'
+
+      class_option :test_engine,        type: :string, default: 'rspec', enum: %w[minitest rspec none],
+                                        desc: 'Which test framework would you like to use with the application'
+
+      ##################################################
+      # Options that are boolean and true if the flag is used
+      ##################################################
+      class_option :docker_distro,      type: :string, default: 'alpine', enum: %w[alpine debian],
+                                        desc: 'Specify if you want your Docker base image to use Alpine or Debian'
+
+      class_option :encrypt,            type: :boolean, default: false,
+                                        desc: 'Do you want user attribues encrypted? (For GDPR compliance, but breaks LIKE queries)'
+
+      class_option :noauth,             type: :boolean, default: false,
+                                        desc: 'Skip adding Devise authentication to the application'
+
+      class_option :simpleform,         type: :boolean, default: false,
+                                        desc: 'Do you want your application to use simpleform to generate forms'
+
+      class_option :skip_docker,        type: :boolean, default: false,
+                                        desc: 'Skip adding basic Dockerfiles to the application'
+
+      class_option :skip_erd,           type: :boolean, default: false,
+                                        desc: 'Skip adding the ERD components to the application'
+
+      class_option :skip_git,           type: :boolean, default: false, aliases: '-G',
+                                        desc: 'Skip commiting the project to a git repo'
+
+      class_option :skip_javascript,    type: :boolean, default: false,
+                                        desc: 'Skip adding javascript assets to the template'
+
+      class_option :skip_mailer,        type: :boolean, default: false,
+                                        desc: 'Skip setting up rails SMTP mailer'
+
+      class_option :skip_pagination,    type: :boolean, default: false,
+                                        desc: 'Do you want to application to skip adding pagination to the views?'
+
+      class_option :skip_pry,           type: :boolean, default: false,
+                                        desc: 'Do you want your application to skip pass on using pry for the rails console?'
+
+      class_option :skip_sidekiq,       type: :boolean, default: false,
+                                        desc: 'Skip adding sidekiq to the rails application'
+
+      class_option :skip_spring,        type: :boolean, default: false,
+                                        desc: 'Do you want to skip'
+
+      # Skipping tests is a dangerous behavior to practice
+      class_option :skip_tests,         type: :boolean, default: false, aliases: '-T',
+                                        desc: 'Determine if you would like to skip building tets for the application'
+
+      class_option :skip_turbolinks,    type: :boolean, default: false,
+                                        desc: 'Determine if you want to skip having turbolinks included in your application'
+
+      # You'll want to set this as true, that way Oracle and/or SQLserver gems can be added to the gemfile
+      # Otherwise you'll get exceptione errors from Psych and Rails causing `rails new` to fail
+      class_option :skip_webpack_install, type: :boolean, default: true
+
+      class_option :uuid,               type: :boolean, default: false,
+                                        desc: 'If database is set as PostgreSQL and UUID is enabled, all primary keys will be generated as UUIDs'
+
+      # If the person wants to use webpack in their application (vuew, react etc)
+      WEBPACKS = %w[react vue angular elm stimulus].freeze
+      class_option :webpack,            type: :string, default: nil, aliases: '-W',
+                                        desc: "Preconfigure for app-like JavaScript with Webpack (options: #{WEBPACKS.join('/')})"
+
+      ### RAILS OVERRIDES
+      # Used to overwrite the the default rails behavior of bundling as soon as an application is generated
+      # => Otherwise the application generator will also do a bundle install after a custom Gemfile has been generated
+      class_option :skip_bundle,        type: :boolean, aliases: '-B', default: true,
+                                        desc: "Don't set as true, this is a RAILS override to prevent extra bundle installs"
+
+      # Used with Rails5 template, or if javascript isn
+      # def finish_template
+      #   invoke :kowl_run_generators
+      #   # used to bundle install or run various bundle commands through the template
+      #   super
+      # end
+
+      # Used with Rails6 v6, because this has the application generate.
+      # => We want it after the applicaton config and assets are generated, otherwise it generates a large number of errors
+      def run_after_bundle_callbacks
+        super
+        invoke :kowl_generators unless options[:skip_javascript]
+      end
+
+      ############################################################
+      # Custom generator actions for processing of the template
+      ############################################################
+
+      # Begin calling all the Kowl application generators to override the default rails application based on the options supplied
+      def kowl_generators
+        build :replace_gemfile
+        build :procfile
+        bundle_command 'install --jobs=4 --retry=3 --quiet'
+        bundle_command 'exec spring stop' unless options[:skip_spring]
+        invoke :install_webpack_assets
+        invoke :setup_staging # Ran afterwards webpack is setup for oracle, because it also createas a staging webpacker file
+
+        generate("kowl:config --database=#{options[:database]} --encrypt=#{options[:encrypt]} --framework=#{options[:framework]} --noauth=#{options[:noauth]} --skip_docker=#{options[:skip_docker]} --skip_erd=#{options[:skip_erd]} --skip_pagination=#{options[:skip_pagination]} --skip_sidekiq=#{options[:skip_sidekiq]} --skip_tests=#{options[:skip_tests]} --template_engine=#{options[:template_engine]} --simpleform=#{options[:simpleform]} --test_engine=#{options[:test_engine]} --uuid=#{options[:uuid]}")
+        generate('kowl:uuid') if options[:database] == 'postgresql' && options[:uuid]
+        generate("kowl:dotfiles --database=#{options[:database]} --encrypt=#{options[:encrypt]} --skip_docker=#{options[:skip_docker]} --skip_erd=#{options[:skip_erd]} --skip_javascript=#{options[:skip_javascript]} --skip_mailer=#{options[:skip_mailer]} --skip_pry=#{options[:skip_pry]} --skip_sidekiq=#{options[:skip_sidekiq]} --skip_tests=#{options[:skip_tests]} --test_engine=#{options[:test_engine]} --template_engine=#{options[:template_engine]} ")
+        generate("kowl:assets --framework=#{options[:framework]} --noauth=#{options[:noauth]} --skip_javascript=#{options[:skip_javascript]} --skip_mailer=#{options[:skip_mailer]} --skip_turbolinks=#{options[:skip_turbolinks]}")
+        generate("kowl:views_and_helpers --framework=#{options[:framework]} --noauth=#{options[:noauth]} --simpleform=#{options[:simpleform]} --skip_javascript=#{options[:skip_javascript]} --skip_pagination=#{options[:skip_pagination]} --skip_turbolinks=#{options[:skip_turbolinks]} --template_engine=#{options[:template_engine]}")
+        generate("kowl:users_and_auth --database=#{options[:database]} --encrypt=#{options[:encrypt]} --framework=#{options[:framework]} --skip_javascript=#{options[:skip_javascript]} --skip_mailer=#{options[:skip_mailer]} --skip_pagination=#{options[:skip_pagination]}  --skip_sidekiq=#{options[:skip_sidekiq]} --template_engine=#{options[:template_engine]}") unless options[:noauth]
+        # tests are generated after users, because devise migrations tries to create empty minitest and rspec migration tests
+        generate("kowl:test --noauth=#{options[:noauth]} --test_engine=#{options[:test_engine]}") unless options[:test_engine] == :none || options[:skip_tests]
+        generate('kowl:staging') unless options[:database] == 'sqlite3'
+        generate("kowl:controller --noauth=#{options[:noauth]}")
+        generate("kowl:database --database=#{options[:database]} --noauth=#{options[:noauth]}")
+        generate("kowl:action --database=#{options[:database]} --simpleform=#{options[:simpleform]} --skip_javascript=#{options[:skip_javascript]}")
+        generate("kowl:mailer --noauth=#{options[:noauth]} --mailer=#{options[:mailer]}") unless options[:skip_mailer]
+        generate("kowl:sidekiq --database=#{options[:database]} --noauth=#{options[:noauth]}") unless options[:skip_sidekiq]
+        generate('kowl:misc') # Generator misc application directores such as serializers, services, workers, etc.
+        generate("kowl:decorators --noauth=#{options[:noauth]}")
+        generate("kowl:text_files --framework=#{options[:framework]} --noauth=#{options[:noauth]}")
+        generate("kowl:pages --framework=#{options[:framework]} --noauth=#{options[:noauth]} --template_engine=#{options[:template_engine]}") # Generate welcome pages and routes for the application
+        generate("kowl:routes --database=#{options[:database]} --noauth=#{options[:noauth]} --skip_mailer=#{options[:skip_mailer]} --skip_sidekiq=#{options[:skip_sidekiq]}")
+        generate('kowl:libs')
+
+        # Generate admin dashboard if user authentication is enabled
+        generate("kowl:docker --database=#{options[:database]} --docker_distro=#{options[:docker_distro]} --encrypt=#{options[:encrypt]} --skip_erd=#{options[:skip_erd]} --skip_javascript=#{options[:skip_javascript]} --skip_sidekiq=#{options[:skip_sidekiq]}") unless options[:skip_docker]
+
+        rake 'db:migrate' unless (options[:database] == 'postgresql' && options[:uuid]) || options[:noauth]
+        generate("kowl:admin --database=#{options[:database]} --skip_javascript=#{options[:skip_javascript]} --skip_turbolinks=#{options[:skip_turbolinks]} --uuid=#{options[:uuid]} ") unless options[:noauth]
+        invoke :add_uuids_to_migrations if options[:database] == 'postgresql' && options[:uuid]
+        invoke :remove_sqlite_yaml unless options[:database] == 'sqlite3'
+        invoke :setup_spring unless options[:skip_spring]
+
+        # Remove the kowl gem, it is initially required to run the rails generators
+        # => Removing the gem removes the generators from application
+        remove_gem('kowl')
+
+        # This should be ran last, thus there will only be 1 commit when application is started
+        # This is a method tather than a generate, because generations can't be called after the gem has been removed
+        invoke :initial_commit unless options[:skip_git]
+      end
+
+      # Setup a staging envirnment for application config and webpacker
+      def setup_staging
+        template 'config/environments/production.rb.tt', 'config/environments/staging.rb'
+        # Enable displaying error messages in staging
+        replace_string_in_file('config/environments/staging.rb',
+                               '^[\s]*?(config.consider_all_requests_local)[\s]*= false[\s]?$',
+                               '  config.consider_all_requests_local       = true')
+        # create a webpacker staging environment
+        return if options[:skip_javascript]
+
+        dup_file('config/webpack/production.js', 'config/webpack/staging.js')
+        webpacker_str = <<~STAGING
+          staging:
+            <<: *default
+            # Production depends on precompilation of packs prior to booting for performance.
+            compile: false
+            # Extract and emit a css file
+            extract_css: true
+            # Cache manifest.json for performance
+            cache_manifest: true
+            # Compile staging packs to a separate directory
+            public_output_path: packs-staging
+        STAGING
+        append_to_file('config/webpacker.yml', "\n#{webpacker_str}")
+      end
+
+      # Create a git initial commit
+      def initial_commit
+        git :init
+        git add: '.'
+        git commit: "-aqm 'Initial Commit' --quiet"
+      end
+
+      # If UUIDs are to be used, add id: :uuid to all migrations
+      def add_uuids_to_migrations
+        return nil unless options[:database] == 'postgresql' && options[:uuid]
+
+        Dir.foreach('db/migrate/') do |migration|
+          next if %w[. ..].include?(migration) || migration.match(/_enable_pgcrypto_extension.rb$/)
+
+          inject_into_file("db/migrate/#{migration}", ', id: :uuid', after: /create_table \:[a-z\_]+/)
+        end
+      end
+
+      # While generating the application the config/database.yml is defaulted to using sqlite3.
+      #  This is because we can't run migrations, and various tasks without a valid database.yml
+      #  but this file should be remove and replace with the config/database[#{database_type}].yml file once the application is ready
+      def remove_sqlite_yaml
+        return nil if options[:database] == 'sqlite3'
+
+        db_file = "config/database[#{options[:database]}].yml"
+        remove_file('config/database.yml')
+        move_file(db_file, 'config/database.yml')
+      end
+
+      # Setup spring for the application unless specified otherwise
+      def setup_spring
+        say 'Springifying binstubs'
+        build :setup_spring unless options[:skip_spring]
+      end
+
+      # Rails6 has issues when genereting a new app using Oracle/sqlserver right away,
+      # this ensures webpack is installed if it previously failed because of the missing ruby-oci8/sqlserver gems
+      # In addition his also prevents a Psych error as the application is generated
+      def install_webpack_assets
+        rails_command('webpacker:install') unless options[:skip_javascript]
+      end
+
+      protected
+
+      def get_builder_class
+        AppBuilder
+      end
+    end
+  end
+end

data/lib/kowl/generators/pages_generator.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require_relative 'base'
+
+module Kowl
+  class PagesGenerator < Kowl::Generators::Base
+    hide!
+    source_root File.expand_path(File.join('..', 'templates', 'app', 'views'), File.dirname(__FILE__))
+    class_option :framework, type: :string, default: 'bootstrap', enum: %w[bootstrap semantic none]
+    class_option :noauth, type: :boolean, default: false
+    class_option :template_engine, type: :string, default: 'erb'
+
+    # Generate a basic welcome page for the application
+    def setup_welcome_page
+      generate('controller Pages welcome --skip')
+
+      # I don't want to skip or remove all tests created for pages, I just want to remove the generated controller test
+      remove_file('spec/requests/pages_request_spec.rb')
+    end
+
+    def make_controller_immuatable
+      inject_into_file 'app/controllers/pages_controller.rb', "# frozen_string_literal: true\n\n", before: "class PagesController < ApplicationController\n"
+    end
+
+    # Copy over a basic welcome page view dependant on the CSS framework and template engine specified for the application
+    def copy_welcome_pages
+      if %w[bootstrap semantic].include? options[:framework]
+        copy_file "pages/welcome/#{options[:framework]}.html.#{options[:template_engine]}", "app/views/pages/welcome.html.#{options[:template_engine]}", force: true
+      else
+        copy_file "pages/welcome/default.html.#{options[:template_engine]}", "app/views/pages/welcome.html.#{options[:template_engine]}", force: true
+      end
+    end
+
+    # Add a skip_before_action for the welcome page if authentication is being used with the application
+    def disable_auth
+      action_str = <<~STR
+        # Allow pages to be displayed without requiring authentication
+        skip_before_action :authenticate_user!
+
+      STR
+
+      inject_into_file 'app/controllers/pages_controller.rb', optimize_indentation(action_str, 2), after: "class PagesController < ApplicationController\n" unless options[:noauth]
+    end
+  end
+end

data/lib/kowl/generators/routes_generator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require_relative 'base'
+
+module Kowl
+  class RoutesGenerator < Kowl::Generators::Base
+    hide!
+    source_root File.expand_path(File.join('..', 'templates', 'config'), File.dirname(__FILE__))
+    class_option :database, type: :string, default: 'sqlite3'
+    class_option :noauth, type: :boolean, default: false
+    class_option :skip_mailer, type: :boolean, default: false
+    class_option :skip_sidekiq, type: :boolean, default: false
+
+    # Generate the applications routes.rb file based on the applications options
+    def setup_routes
+      template('routes.rb.tt', 'config/routes.rb', force: true)
+    end
+  end
+end

data/lib/kowl/generators/sidekiq_generator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require_relative 'base'
+
+module Kowl
+  class SidekiqGenerator < Kowl::Generators::Base
+    hide!
+    source_root File.expand_path(File.join('..', 'templates'), File.dirname(__FILE__))
+    class_option :database, type: :string, default: 'sqlite3'
+    class_option :noauth, type: :boolean, default: false
+
+    # Copy over a basic sidekiq config and sidekiq initializer
+    def copy_config
+      template 'config/sidekiq.yml.tt', 'config/sidekiq.yml'
+      copy_file 'config/initializers/sidekiq.rb', 'config/initializers/sidekiq.rb'
+    end
+
+    # Setup pghero scheduled job, if application will be running with postgresql
+    def pghero_worker
+      copy_file('app/workers/scheduler/pghero_scheduler.rb', 'app/workers/scheduler/pghero_scheduler.rb') if options[:database] == 'postgresql'
+    end
+
+    # Setup the application to use redis as a cache_store
+    def set_redis_as_cache_storage
+      # https://blog.appsignal.com/2018/04/17/rails-built-in-cache-stores.html
+      # https://www.engineyard.com/blog/rails-5-2-redis-cache-store
+      # config.cache_storage = :redis_cache_store, { driver: :hiredis } # , url: "redis://redis:6379/0" }
+    end
+  end
+end

data/lib/kowl/generators/staging_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require_relative 'base'
+
+# This generator is used to create a staging environment
+# => It generates a staging.rb file in the config/environments/ (uses the production environment as a base)
+# => It adds a staging database to the bottom of your config/database.yml file (inherits from &default)
+# https://api.rubyonrails.org/v5.2/classes/Rails/Generators/Base.html#method-c-base_root
+module Kowl
+  class StagingGenerator < Kowl::Generators::Base
+    hide!
+  end
+end

data/lib/kowl/generators/test_generator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require_relative 'base'
+
+module Kowl
+  class TestGenerator < Kowl::Generators::Base
+    hide!
+    source_root File.expand_path(File.join('..', 'templates', 'tests'), File.dirname(__FILE__))
+    class_option :noauth, type: :boolean, default: false
+    class_option :test_engine, type: :string, default: 'rspec'
+
+    # Remove default generate4d test and spec files
+    def remove_old_tests
+      remove_dir('test')
+      remove_dir('spec')
+    end
+
+    # If using minitest copy over a few basic tests and support files
+    def copy_minitest_files
+      directory('minitest', 'test') if options[:test_engine] == 'minitest'
+    end
+
+    # If using rspec copy over a few basic tests and support files
+    def copy_rspec_files
+      directory('rspec', 'spec') if options[:test_engine] == 'rspec'
+    end
+
+    # Copy over basic factory bot files
+    def copy_factories
+      directory 'factories', "#{(options[:test_engine] == 'rspec' ? 'spec' : 'test')}/factories", force: true
+    end
+
+    # If noauth is specified, remove the policies tests
+    def remove_if_no_auth_required
+      return unless options[:noauth]
+
+      remove_dir('spec/policies') if options[:test_engine] == 'rspec'
+      remove_dir('test/policies') if options[:test_engine] == 'minitest'
+    end
+  end
+end

data/lib/kowl/generators/text_files_generator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require_relative 'base'
+
+# Used to generate various markdown textfiles such as README and changelog
+module Kowl
+  class TextFilesGenerator < Kowl::Generators::Base
+    hide!
+    source_root File.expand_path(File.join('..', 'templates', 'text_files'), File.dirname(__FILE__))
+    class_option :framework, type: :string, default: 'bootstrap'
+    class_option :noauth, type: :boolean, default: false
+
+    # Generate a changelog file for project developers
+    def changelog
+      # Add a changelog file to the project
+      template 'CHANGELOG.md.tt', 'CHANGELOG.md'
+    end
+
+    # Generarte numerous project markdown files
+    def copy_markdown_files
+      %w[AUTHORS.md CODE_OF_CONDUCT.md TODO.md].map { |f| copy_file(f, f) }
+    end
+
+    # Generate a project version file
+    def version
+      copy_file('VERSION', 'VERSION')
+    end
+
+    # Generate a security.txt file for application security contact information
+    def copy_securitytxt
+      copy_file('security.txt', 'public/.well-known/security.txt')
+    end
+
+    # Generate human.txt and robots.txt files for human readable project information
+    def public_txt_files
+      template 'humans.txt.tt', 'public/humans.txt'
+      template 'robots.txt.tt', 'public/robots.txt', force: true
+    end
+  end
+end

data/lib/kowl/generators/users_and_auth_generator.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require_relative 'base'
+
+module Kowl
+  class UsersAndAuthGenerator < 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 :encrypt, type: :boolean, default: false
+    class_option :framework, type: :string, default: 'bootstrap'
+    class_option :skip_javascript, type: :boolean, default: false
+    class_option :skip_mailer, type: :boolean, default: false
+    class_option :skip_pagination, type: :boolean, default: false
+    class_option :skip_sidekiq, type: :boolean, default: false
+    class_option :template_engine, type: :string, default: 'erb'
+
+    # Run devise generators unless you don't want authentication allowed in the application
+    def generate_devise
+      # generate devise config
+      generate('devise:install')
+
+      # Generate devise users models
+      generate('devise User role:integer')
+
+      # Generate additional Devise security practices
+      generate('devise_security:install')
+      # Copy initializer for ensure a more secure devise application setup
+      copy_file('config/initializers/devise-security.rb', 'config/initializers/devise-security.rb', force: true) unless options[:noauth]
+
+      # Generate devise authentication log
+      generate('authtrail:install')
+    end
+
+    # Generate Pundit policies for basic authentication policies
+    def generate_and_copy_policies
+      # Begin setting up pundit
+      generate('pundit:install')
+      # these are generated, so they'll also create tests policies
+      generate('pundit:policy user')
+      generate('pundit:policy login_activity')
+
+      # Remove policies and replace with a base policy build
+      remove_dir('app/policies')
+      directory('app/policies', 'app/policies')
+    end
+
+    # Override user model with devise specific settings
+    def overrider_devise_config
+      template 'app/models/user.rb.tt', 'app/models/user.rb', force: true
+    end
+
+    # Update the devise migration to enable trackable and lockable attributes
+    def adjust_devise_migration
+      # Fetch the devise migration file
+      Dir.glob('db/migrate/**_devise_create_users.rb').select { |e| update_devise_migration(e) }
+    end
+
+    # This is because we encrypt certain values being logged into the LoginActivity table
+    #   No not all data is plain text readable in the database
+    def replace_logins_activity_migration
+      Dir.glob('db/migrate/**_create_login_activities.rb').select { |e| update_login_activities_migration(e) }
+    end
+
+    # Change devise lock_strategy
+    def adjust_lock_stragety
+      devise_initialzier = 'config/initializers/devise.rb'
+      content = File.read(devise_initialzier).gsub(/\s?\#\s(config.lock_strategy = :failed_attempts)\n?/i, optimize_indentation('config.lock_strategy = :failed_attempts', 2))
+      File.open(devise_initialzier, 'wb') { |file| file.write(content) }
+    end
+
+    # Update devise/User notificationss
+    def adjust_devise_notifications
+      inject_into_file('config/initializers/devise.rb', optimize_indentation("config.send_email_changed_notification = true\n", 2), after: "  # config.send_email_changed_notification = false\n")
+      inject_into_file('config/initializers/devise.rb', optimize_indentation("config.send_password_change_notification = true\n", 2), after: "  # config.send_password_change_notification = false\n")
+    end
+
+    # Update devise initializer to be paranoid, to prevent credential stuffing with password resets
+    def set_devise_as_paranoid
+      # This displays the visitor with a confirmation even if the user does or doesn't exist
+      gsub_file('config/initializers/devise.rb', '# config.paranoid = true', 'config.paranoid = true')
+    end
+
+    # Generate a model for monitoring user login activity
+    def copy_login_activity_model
+      template 'app/models/login_activity.rb.tt', 'app/models/login_activity.rb', force: true
+    end
+
+    # Generate and copy a Users controller
+    def generate_users_controller
+      generate('controller Users') # copied mainly for testing purposes
+      copy_file 'app/controllers/users_controller.rb', 'app/controllers/users_controller.rb', force: true
+    end
+
+    # Generate administrate viewss
+    def generate_dashboard_views_and_assets
+      # The main reason these are generated, before copying over is some tests may rely on theses generators
+      generate('administrate:views:index User --quiet')
+      generate('administrate:views:edit User --quiet')
+      generate('administrate:assets:stylesheets --quiet')
+      generate('administrate:views:navigation --quiet')
+    end
+
+    # Copy over admin views and layouts
+    def setup_user_dashboard_views
+      remove_dir('app/views/admin')
+      directory('app/views/admin/views', 'app/views/admin')
+      template('app/views/admin/templates/navigation.erb.tt', 'app/views/admin/application/_navigation.html.erb')
+    end
+
+    # Copy over administrate SCSS stylesheet files
+    def setup_dashboard_stylesheets
+      copy_file('app/assets/stylesheets/administrate/application.scss', 'app/assets/stylesheets/administrate/application.scss', force: true)
+    end
+
+    # Add flattpickr to administrate for datetime picker fields
+    def setup_dashbord_javascript
+      return nil if options[:skip_javascript]
+
+      # flatpicker is required for date/time selection components
+      add_package('flatpickr')
+    end
+
+    private
+
+    def update_devise_migration(migration_file)
+      return false unless file_exists?(migration_file)
+
+      # override migration file to enable :trackable && :lockable
+      # copy_file 'db/migrations/devise.rb', migration_file, force: true
+      template 'db/migrations/devise.rb.tt', migration_file, force: true
+    end
+
+    def update_login_activities_migration(migration_file)
+      return false unless file_exists?(migration_file)
+
+      # Override the default migration file to enable :trackable && :lockable
+      # copy_file 'db/migrations/login_activities.rb', migration_file, force: true
+      template 'db/migrations/login_activities.rb.tt', migration_file, force: true
+    end
+  end
+end

data/lib/kowl/generators/uuid_generator.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require_relative 'base'
+
+# https://github.com/rails/rails/blob/master/guides/source/active_record_postgresql.md
+# This generator sets postgres to use UUIDs at the primary keys for your objects
+module Kowl
+  class UuidGenerator < Kowl::Generators::Base
+    hide!
+    source_root File.expand_path(File.join('..', 'templates', 'db'), File.dirname(__FILE__))
+
+    # Generate migration to add pgcrypto_extension to the database
+    def generate_migration
+      generate('migration enable_pgcrypto_extension')
+    end
+
+    # Update pgcrypto migration file to include enable tjhe pgcrypt extension for postgres
+    def add_to_migration
+      Dir.glob('db/migrate/**_enable_pgcrypto_extension.rb').select { |e| update_uuid_migration(e) }
+    end
+
+    private
+
+    # Update the pgcrypto migration file
+    # @param migration_file [String] - The specified migration file for enabling the extension ie: 1234567890_enable_pgcrypto_extension.rb
+    def update_uuid_migration(migration_file)
+      return false unless file_exists?(migration_file)
+
+      uuid_migration_str = <<~UUID_STR
+        if ActiveRecord::Base.connection.adapter_name.downcase.to_sym == :postgresql
+          enable_extension 'pgcrypto' unless extension_enabled?('pgcrypto')
+        end
+      UUID_STR
+
+      insert_into_file migration_file, optimize_indentation(uuid_migration_str, 4), after: /\s+\S+\schange\s?\n/
+    end
+  end
+end