kowl 0.0.1

data/lib/kowl/generators/views_and_helpers_generator.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require_relative 'base'
+
+module Kowl
+  class ViewsAndHelpersGenerator < Kowl::Generators::Base
+    hide!
+    source_root File.expand_path(File.join('..', 'templates', 'app', 'views'), File.dirname(__FILE__))
+    class_option :framework, type: :string, default: 'bootstrap'
+    class_option :skip_pagination, type: :boolean, default: false
+    class_option :simpleform, type: :boolean, default: false
+    class_option :skip_javascript, type: :boolean, default: false
+    class_option :skip_turbolinks, type: :boolean, default: false
+    class_option :template_engine, type: :string, default: 'erb'
+    class_option :noauth, type: :boolean, default: false
+
+    # Generate templates with framework and templae_engine with required application options
+    def generate_templates
+      # Generate views using bootstrap and semanic view generators
+      gen_tags = []
+      gen_tags.push("--template-engine=#{options[:template_engine]}")
+      gen_tags.push('--simpleform') if options[:simpleform]
+      gen_tags.push('--pagination') unless options[:skip_pagination]
+      gen_tags.push('--devise') unless options[:noauth]
+      gen_tags.push('--skip_javascript') if options[:skip_javascript]
+      gen_tags.push('--skip_turbolinks') if options[:skip_turbolinks]
+      gen_tags.push('--metatags')
+      gen_tags.push('--layout')
+      generate("#{options[:framework]}:install #{gen_tags.join(' ')}") if %w[bootstrap semantic].include? options[:framework]
+    end
+
+    # If template engine isn't set for erb remove application.erb
+    def remove_application_layout
+      remove_file 'app/views/layouts/application.html.erb' if %w[slim haml].include? options[:template_engine]
+    end
+
+    # Inject navigation header into application layout file based on template_engine/framework
+    def inject_header_into_layout
+      # prefix, includes, postfix
+      # Pre and Postfix is determined if the template engine is ERB, Slim, or HAML
+      nav_str = "#{template_prefix}= render 'shared/navigation'#{template_postfix}\n"
+      match = { 'erb' => /\s\<body\>\n/,
+                'haml' => /\s%body\n/,
+                'slim' => /\sbody\n/ }
+      insert_into_file "app/views/layouts/application.html.#{options[:template_engine]}", optimize_indentation(nav_str, 4), after: match[options[:template_engine]]
+    end
+
+    # Generate an application navigation view based on framework/template_engine
+    def copy_navigation
+      template("shared/navigation/#{options[:framework]}.html.#{options[:template_engine]}.tt", "app/views/shared/_navigation.html.#{options[:template_engine]}") if %w[bootstrap semantic].include? options[:framework]
+    end
+
+    # Generate an application footer view based on framework/template_engine
+    def copy_footer
+      template("shared/footer/#{options[:framework]}.html.#{options[:template_engine]}.tt", "app/views/shared/_footer.html.#{options[:template_engine]}") if %w[bootstrap semantic].include? options[:framework]
+    end
+
+    # Inject view template partial into application layout
+    def inject_footer_into_layout
+      footer_str = "#{template_prefix}= render 'shared/footer'#{template_postfix}\n"
+      if options[:template_engine] == 'erb'
+        insert_into_file 'app/views/layouts/application.html.erb', optimize_indentation(footer_str, 4), before: "  </body>\n"
+      else
+        append_to_file "app/views/layouts/application.html.#{options[:template_engine]}", optimize_indentation(footer_str, 4)
+      end
+    end
+
+    # Skip a flash type if the key is a cookie/session timeone, since this can occure so regularly
+    def update_application_helpers
+      flash_str = <<~STR
+        \n# remove any blank devise timeout errors
+        flash.delete(:timedout)
+      STR
+
+      # User to prevent blank devise timeout error from flashing up
+      insert_into_file 'app/helpers/application_helper.rb', "\n#{optimize_indentation(flash_str.strip, 4)}", after: "return '' unless flash.any?\n" if options[:framework] == 'bootstrap'
+
+      # Make applicaction_helper immutable
+      insert_into_file 'app/helpers/application_helper.rb', "# frozen_string_literal: true\n\n", before: "module ApplicationHelper\n"
+    end
+
+    private
+
+    # Returns the application erb ruby tag prefix based on the views template_engine
+    def template_prefix
+      return '' unless options[:template_engine] == 'erb'
+
+      '<%'
+    end
+
+    # Returns the application erb ruby tag postfix based on the views template_engine
+    def template_postfix
+      return '' unless options[:template_engine] == 'erb'
+
+      ' %>'
+    end
+
+    # Check to see if the current application will be using erb or not
+    def using_erb?
+      options[:template_engine] == 'erb'
+    end
+  end
+end

data/lib/kowl/geodb.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+# https://github.com/gitcoinco/code_fund_ads/blob/b87cc931f167dadc96904cec8d653d76bc55b021/app/jobs/download_and_extract_maxmind_file_job.rb
+# https://cobwwweb.com/download-collection-of-images-from-url-using-ruby
+require 'net/http'
+require 'fileutils'
+require 'zlib'
+require 'rubygems/package'
+
+# Used for fetching the GeoLite db from maxmind
+class GeoDB
+  GEOLITE_URL = 'http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.tar.gz'
+
+  # Begin creating folders and being downloadding the GeoLite db
+  # @param path [String] the applications relative path
+  # @return [Boolean] if the GeoLite2 database was successfully downloaded and decompressed
+  def self.perform(path)
+    const_set('GEOLIB_DIR', File.join(path, 'db/maxmind'))
+    const_set('GEOLIB_PATH', File.join(GEOLIB_DIR, 'GeoLite2-City.tar.gz'))
+
+    FileUtils.mkdir_p GEOLIB_DIR
+    download
+    extract
+  rescue => e
+    puts "Error while setting up GeoLite DB - #{e.message}"
+  end
+
+  # Download the file from the GEOLITE url
+  # @return [Boolean] returns if the the file was succcessfully downloaded
+  def self.download
+    FileUtils.rm_f GEOLIB_PATH
+    res = Net::HTTP.get_response(URI.parse(GEOLITE_URL))
+    File.open(GEOLIB_PATH, 'wb') do |f|
+      f.write(res.body)
+    end
+  rescue => e
+    puts 'GeoLite2 database could not be downloaded at this time.'
+    puts e.message if e.message
+  end
+
+  private
+
+  # Extract the GEOLIB tar.gz file into the application
+  # @return [Boolean] if the file was sucessfully decompressed
+  def self.extract
+    untar(unzip(GEOLIB_PATH))
+  end
+
+  # Uncompress the zipfile
+  #  https://www.rubydoc.info/gems/folio/0.4.0/ZipUtils.ungzip
+  # @param file [String] the specific file path/name
+  # @param options [Hash] any specific options required for decompressing the file [:dryrun] || [:noop]
+  # @return [Boolean] if the File was sucessfully decompressed
+  def self.unzip(file, options = {})
+    # Decompress the file to the specified location
+    fname = File.join(GEOLIB_DIR, File.basename(file).chomp(File.extname(file)))
+    # Remove unzipped file if it already exists for any reason
+    FileUtils.rm_f fname
+    Zlib::GzipReader.open(file) do |gz|
+      File.open(fname, 'wb'){ |f| f << gz.read }
+    end unless options[:dryrun] || options[:noop]
+    FileUtils.rm_f GEOLIB_PATH
+    File.expand_path(fname)
+  rescue => e
+    puts "Error occured while extracting the geolite database #{e}"
+  end
+
+  # Untar the specified file
+  # @param tarred_path [String] the specific filename/path for the tar file
+  # @return [Boolean] if the file was successfully decompressed
+  def self.untar(tarred_path)
+    Gem::Package::TarReader.new File.open(tarred_path) do |tar|
+      tar.each do |tarfile|
+        next if tarfile.directory?
+
+        destination = db_destinsation(tarfile.full_name)
+        FileUtils.mkdir_p File.dirname(destination)
+        File.open destination, 'wb' do |f|
+          f.print tarfile.read
+        end
+      end
+    end
+    FileUtils.rm_rf tarred_path
+  rescue => e
+    puts "And error occurred while decompressing the database: #{e}"
+  end
+
+  # The destination of where the tarfile is loaded
+  # @param file [String] the specific geolite database file locattion
+  # @return [String] to the GEOLIB database file
+  def self.db_destinsation(file)
+    file_arr = file.split('/')
+    file = (file_arr.count > 1 ? file_arr.last : file_arr)
+    File.join(GEOLIB_DIR, file)
+  end
+end

data/lib/kowl/helpers.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+##################################################
+# Helper methods used to assist through the template building
+# => similar to the functions used in Rails::Generators::AppBase
+##################################################
+
+# Method required when processing the gemfile
+#   - https://raw.githubusercontent.com/liukun-lk/rails_start_template/master/template.rb
+#   - https://github.com/manuelvanrijn/rails-template/blob/master/template.rb
+# @param name [String] Specific gem you are wanting to check the requirements for
+def gemfile_requirement(name)
+  @original_gemfile ||= IO.read('Gemfile')
+  req = @original_gemfile[/gem\s+['"]#{name}['"]\s*(,[><~= \t\d\.\w'"]*)?.*$/, 1]
+  req && req.tr("'", %(")).strip.sub(/^,\s*"/, ', "')
+end
+
+# Determine which gem will be used for the projects CSS framework
+# @param css_framework [String] Which CSSFramework the developer wants to use with the application
+# @return [String] The specific gem that will be used for the applications CSS framework
+def template_engine_gem_str(css_framework = '')
+  case css_framework.to_s
+  when 'semantic'
+    'semantic_ui'
+  else
+    'bootstrap'
+  end
+end
+
+# https://github.com/rails/rails/blob/master/railties/lib/rails/generators/rails/app/templates/Gemfile.tt#L9
+# Add a gem to the Gemfile
+# @param gem [String] Specfic gem name that you want to add to the gemfile
+# @return [String] Returns the gem entry for the gemfile
+def gem_to_gemfile(gem)
+  gem_str = <<~GEM
+    #{gem.comment ? "# #{gem.comment}" : ''}
+    #{(gem.commented_out ? '#' : '')}gem '#{gem.name}'#{gem_version_str(gem)}#{gem_options(gem)}
+  GEM
+
+  gem_str.strip
+end
+
+# If the gem requires a specific version, determine it
+# @param gem [String] - To determine if the specified gems requires a specific version to run with the application
+# @return [String] - If the gem require a specific version, it will return that version entry for the gemfile
+def gem_version_str(gem)
+  return '' unless gem.version
+
+  # "#{gem.version ? ", '#{gem.version}'" : ''}"
+  ", '#{gem.version}'"
+end
+
+# If the requested gem requires additional options (ie: require: false) return this
+# @param gem [String] The specified gem you want to use
+# @return [String] If the gem requires additional opotions in the gemfile, return these as a string
+def gem_options(gem)
+  return '' unless gem.options.any?
+
+  options_str = gem.options.map { |k, v| "#{k}: #{v.inspect}" }.join(', ')
+  ", #{options_str}" unless options_str.blank?
+end
+
+# Make a directory in the applications directory path
+# @param dir [String] The name of the directory you want to create
+def mk_appdir(dir)
+  path = Rails.root.join(dir)
+  FileUtils.mkdir(path) unless File.directory?(path)
+end
+
+# If you want all lines of the string to be indented a specific amount
+# @param str [String] - The multiline string in which you want to indent
+# @return [String] - An indented version of thee string that was passed to the function
+def indent_all_lines(str, spaces = 2)
+  return '' if str.nil? || str.blank?
+
+  str.strip.split(/\n/).map { |line| optimize_indentation(line, spaces.to_i) }.join('')
+end
+
+# Used to add additional assets to be considered when compiling your assets
+# @param str [String] Asset string file to add to the file, ie: `application-mailer.scss`
+def add_to_assets(asset_str)
+  append_to_file('config/initializers/assets.rb', "Rails.application.config.assets.precompile += %w( #{asset_str} )\n") unless asset_str.blank?
+end
+
+# Add a specific line to the config/routes.rb file
+# @param route_str [String] The specific route you want to add to the applications route file
+def add_to_routes(route_str = '')
+  inject_into_file('config/routes.rb', optimize_indentation("#{route_str.strip}\n", 2), after: "\s# For details on the DSL available within this file, see https://guides.rubyonrails.org/routing.html\n")
+end
+
+##################################################
+# Used to create highlights when running `kowl -h` (usage summary displayed by the binstub)
+##################################################
+
+# Highlight the specific string
+# @param str [String] The string in which you wish to highlight
+# @return [String] The specified string concatenated between terminal encoded character sequences
+def highlight(str = '')
+  return '' if str.blank?
+
+  str = str.split('=')
+  str.count > 1 ? "\e[32m#{str[0]}=\e[33m#{str[1]}\e[0m" : "\e[32m#{str[0]}\e[0m"
+end
+
+# Highlight the default values for specified flag
+# @param str [String] The default values for the specified parameter
+# @return [String] the specified text string surrounded by terminal string highlights
+def dh(str = '')
+  return '' if str.blank?
+
+  str = str.split(': ')
+  str.count > 1 ? "\e[36m#{str[0]}: \e[31m#{str[1]}\e[0m" : "\e[34m#{str[0]}\e[0m"
+end
+
+# Used to create and return the .env file database configuration for the specific environment
+# @param database [String] the database adapater in which the application will be connecting to
+# @param env [String] the environment which the env file is bring created for
+# @return [String] a list of database parameters for the specific database connection
+def dotfile_databases(database, env)
+  return '' if database == 'sqlite3'
+
+  db = { username: "DB_USER=appUser123\n",
+         password: "DB_PASSWORD=App($)Password\n",
+         sid: '',
+         host: '' }
+
+  case database
+  when 'oracle'
+    db = { username: "DB_USER=system\n",
+           password: "DB_PASSWORD=oracle\n",
+           sid: "DB_SID=xe\n" }
+  when 'sqlserver'
+    db[:username] = "DB_USER=SA\n"
+    db[:password] = "DB_PASSWORD=yourStrong(!)Password\n"
+  end
+  db[:host] = "DB_HOST=localhost\n" unless env == 'docker'
+
+  "#{db[:username]}#{db[:password]}#{db[:host]}#{db[:sid]}"
+end

data/lib/kowl/templates/Gemfile.erb.tt

@@ -0,0 +1,253 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# ruby '<%= RUBY_VERSION %>'
+gem 'rails', '<%= Kowl::RAILS_VERSION %>'
+gem 'puma', '~> 4.3'                            # Use Puma as the applications web server
+# gem 'iodine', '~> 0.7'                        # An extremely fast and concurrent Application Server (works well with websockets)
+# gem 'falcon'                                  # A high-performance web server for Ruby, supporting HTTP/1, HTTP/2 and TLS
+# Falon => https://www.codeotaku.com/journal/2019-02/falcon-early-hints/index
+gem 'rack', '~> 2.2'
+
+# Gems required for running rails with RUBY_VERSION >= 2.7
+if RUBY_VERSION >= '2.7'
+  gem 'e2mmap'
+  gem 'thwait'
+end
+
+##############################
+### Database
+##############################
+<%- if options[:database] != 'sqlite3' -%>
+<% if options[:database] == 'oracle' -%>
+gem 'ruby-oci8' #, github: 'kubo/ruby-oci8', platforms: :ruby  # only for CRuby users
+gem 'activerecord-oracle_enhanced-adapter', '~> 6.0.0'
+<% elsif options[:database] == 'sqlserver' -%>gem 'activerecord-sqlserver-adapter', github: 'rails-sqlserver/activerecord-sqlserver-adapter', branch: '6-0-dev'
+<% elsif database_gemfile_entry -%>
+<%= indent_all_lines(gem_to_gemfile(database_gemfile_entry)) -%>
+<% end -%>
+<% end -%>
+<%- if options[:database] == 'postgresql' -%>
+gem 'pghero', '>= 2.4'                          # https://github.com/ankane/pghero/blob/master/guides/Rails.md
+gem 'pg_query'                                  # Used by pghero to suggest recommended indexes
+<% end -%>
+gem 'sqlite3'<%= gemfile_requirement('sqlite3') %>
+gem 'strong_migrations'                         # Catch unsafe migrations
+<%- unless options[:skip_erd] -%>
+gem 'rails-erd', group: :development            # Generate an application ERD
+<%- end -%>
+
+##############################
+### Assets
+##############################
+gem 'autoprefixer-rails'                        # add vendor prefixes to particular css properties
+gem 'font-awesome-sass'
+<%- if options[:framework] == 'bootstrap' -%>
+gem 'bootstrap', '~> 4.4'
+<% elsif options[:framework] == 'semantic' -%>
+gem 'semantic-ui-sass'#, github: 'doabit/semantic-ui-sass'
+<%- end -%>
+gem 'sass-rails', '~> 6.0'                      # Libsass for rails pipeline (fast sass-rails replacement)
+<%- unless options[:skip_turbolinks] -%>
+gem 'turbolinks'<%= gemfile_requirement('turbolinks') %>          # turbolinks for browsing your application faster
+<%- end -%>
+<%- if %w[bootstrap semantic].include? options[:framework] -%>
+gem '<%= template_engine_gem_str(options[:framework]) %>_views_generator', group: :development
+<%- end -%>
+<%- unless options[:skip_javascript] -%>
+gem 'webpacker', '~> <%= Kowl::WEBPACKER_VERSION %>'
+<%- end -%>
+
+##############################
+# ActionText/ActiveStorage
+# Used because some gems such as administate still have assets build into the gem
+##############################
+gem 'image_processing'                          # Used for processing ActionStorage uploads with imagemagick and/or vip
+# gem 'active_storage_validations'              # Used for validating active storage uploads
+
+<%- unless options[:noauth] -%>
+##############################
+# Admin/Dashboard
+##############################
+gem 'administrate', github: 'thoughtbot/administrate' # Admin dashboard
+
+##############################
+# Authorization, Authentication [Roles], and permissions
+##############################
+gem 'argon2', '>= 2'            # https://ankane.org/devise-argon2
+gem 'authtrail'                 # For tracking devise login activity
+gem 'devise', github: 'plataformatec/devise' # Rails based user authentication
+gem 'devise-security'           # Additional security measures for devise
+gem 'valid_email2'              # Stronger email validator (Includes RFC, blackist, and whitelist validations)
+gem 'pretender'                 # Allows superusers to emulate being another user
+gem 'pundit'                    # A slim user authorization library
+gem 'maxminddb'                 # Used by AuthTrail, used to prevent geocoder from making remote API Requests to geocoder service
+
+# Additional devise plugins to consider
+# gem 'devise-i18n'             # For i18n translation support
+# gem 'devise_invalidatable`, github: 'madkins/devise_invalidatable'
+# gem 'devise-uncommon_password', github: 'HCLarsen/devise-uncommon_password'
+# -> Avatars
+# gem 'gravatar_image_tag'
+# gem 'letter_avatar', github: 'ksz2k/letter_avatar'
+# -> User Profile data
+# gem 'name_of_person'          # Official bootcamp gem for presenting user names
+<%- end -%>
+
+<%- unless options[:skip_sidekiq] -%>
+##############################
+# Background jobs and Redis
+##############################
+gem 'hiredis'                   # C based adapter for connecting to redis
+gem 'sidekiq', '>= 6.0'         # For scheduling background jobs
+gem 'sidekiq-failures'          # Shows you a list of failed sidekiq jobs
+gem 'sidekiq-scheduler'         # Lightweight job scheduler (mimicks cron scheduling)
+gem 'sidekiq-status'            # View the status of any currently running sidekiq jobs
+# gem 'sidekiq-bulk'            # Easy bulk processing
+# gem 'sidekiq-unique-jobs'     # Ensures only unique jobs are being ran at any given time
+<%- end -%>
+
+<%- unless options[:skip_mailer] -%>
+##############################
+# Mailers
+##############################
+gem 'bootstrap-email'
+<%= mailer_gems(options[:mailer]) %>, group: :production
+group :development do
+  gem 'letter_opener'
+  gem 'letter_opener_web', '~> 1.0'
+end
+<%- end -%>
+
+
+##############################
+# Misc
+##############################
+gem 'auto_strip_attributes', '~> 2.5' # Reduce needing to add before_validation hooks to the models to cleanup attributes
+gem 'fast_jsonapi', github: 'fast-jsonapi/fast_jsonapi' # A lightening fast json serializer
+gem 'jbuilder'<%= gemfile_requirement('jbuilder') %>      # Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'meta-tags'                 # Used for adding dynamic titles when switching between pages.
+gem 'oj'                        # For faster json generating and parsing
+<% if options[:simpleform] -%>
+gem 'simple_form', '~> 5.0'     # A DSL to make forms easier to work with
+<% end -%>
+<% unless options[:skip_pagination] -%>
+gem 'pagy', '~> 3.7'            # An extremely fast pagination alternative
+<% end -%>
+<%- unless options[:template_engine].to_s == 'erb' -%>
+gem '<%= options[:template_engine] %>-rails'
+<%- end -%>
+
+##############################
+### Performance Optimizations
+##############################
+gem 'attendance'                 # Speed up for ActiveRecord#present? (removes additional query requests)
+gem 'bootsnap', require: false   # Reduces boot times through caching
+gem 'fast_blank', platform: :mri # fast implementation of .blank?
+
+##############################
+### Responses, Errors, and Security
+##############################
+gem 'dotenv-rails', groups: [:development, :test]
+gem 'rack-attack'               # Rack middleware for blocking & throttling
+# gem 'rack-protection', github: 'https://github.com/sinatra/sinatra/tree/master/rack-protection'
+# gem 'secure_headers'          # Manages application of security headers with many safe defaults
+gem 'slowpoke'                  # Utilize Rack::Timeout to kill long running requests
+
+##############################
+### Security (Data Security)
+##############################
+<%- if options[:encrypt] %>
+gem 'blind_index'               # Securely search encrypted database fields
+gem 'lockbox'                   # Modern encryption for Rails (For encrypting sensitive information within the database)
+gem 'rbnacl'                    # Ruby binding for libsodium
+<%- end -%>
+gem 'lograge'                   # For cleaning up your application logs
+gem 'logstop'                   # Keep personally identifiable information (PII) out of your logs
+# gem 'honeybadger'             # For Exception logging (logs the applications backtrace)
+
+##############################
+### Structure [Presentors, Decorators, etc.]
+##############################
+gem 'active_decorator'
+
+##############################
+### Development/Testing gems
+##############################
+group :development, :test do
+  gem 'brakeman'
+  gem 'bundler-audit', github: 'rubysec/bundler-audit'
+  gem 'byebug', platforms: %i[mri mingw x64_mingw]
+<%- unless options[:test_engine] == 'none' -%>
+  gem 'factory_bot_rails'       # For building objects associated with your models
+  gem 'faker'                   # for generating sample data
+<%- end -%>
+<%= pry_gems(options[:skip_pry]) -%>
+
+  # --- Linters (Asset testing, Static Code Analyzers)
+  # gem 'inquisition', github: 'rubygarage/inquisition'
+  <%= template_linter_gems(options[:template_engine]) %>
+  gem 'scss_lint', require: false
+  gem 'rails_best_practices'    # for testing for rails best practice methods
+  gem 'rubocop', require: false # github: 'rubocop-hq/rubocop'
+  gem 'rubocop-performance', '~> 1.5', require: false
+  gem 'rubocop-rails', '~> 2.3', require: false
+  <%= robocop_test_engine(options[:test_engine], options[:skip_tests]) %>
+  # gem 'rubycritic', require: false # Code Quality analyzer
+end
+
+group :development do
+  gem 'annotate'
+  gem 'better_errors'           # dev: better error messages
+  # gem 'binding_of_caller'
+  gem 'bullet'                  # For logging all unnecessary N+1 queries and unused eager_loaded associations
+  gem 'listen'<%= gemfile_requirement('listen') %>
+<%- unless options[:skip_spring] -%>
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+  gem 'spring-watcher-listen'<%= gemfile_requirement('spring-watcher-listen') %>
+<%- end -%>
+  gem 'web-console'<%= gemfile_requirement('web-console') %>
+end
+
+<%- unless options[:test_engine] == 'none' || options[:skip_tests] -%>
+group :test do
+  gem 'database_cleaner'        # For flushing the database between tests
+<%- if options[:test_engine] == 'minitest' -%>
+  gem 'minitest'
+  gem 'minitest-reporters'      # used to enhance basic minitest capibilities
+<%- elsif options[:test_engine] == 'rspec' -%>
+  gem 'cucumber-rails', require: false
+  gem 'formulaic'               # For generating form based test submissions
+  gem 'fuubar'                  # RSpec progress bar
+  # gem 'parallel_tests'        # needs to be ran against a database other than sqlite3
+  gem 'pig-ci-rails'            # For displaying application memory metrics while running tests
+<%- unless options[:noauth] -%>
+  gem 'pundit-matchers'         # RSpec matchers for testing Pundit authorization policies
+<%- end -%>
+  gem 'rspec-rails', '>= 3.9'
+<%- unless options[:skip_sidekiq] -%>
+  gem 'rspec-sidekiq'
+<%- end -%>
+<%- end -%>
+  gem 'rails-controller-testing' # , github: 'rails/rails-controller-testing'
+  gem 'simplecov'               # generate html report on the applications test results
+  gem 'shoulda'                 # Write easy to understand and maintainable tests
+  gem 'test-prof'               # For profiling tests, rspec, and factories
+  gem 'timecop'                 # For time based testing (time travel)
+
+  ##############################
+  ### integration testing
+  ##############################
+  # Adds support for Capybara system testing and selenium driver
+  gem 'capybara'<%= gemfile_requirement('capybara') %>
+  gem 'selenium-webdriver'
+  gem 'webdrivers', '~> 4.0'
+end
+<%- end -%>
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+gem 'kowl'

data/lib/kowl/templates/README.md.erb

@@ -0,0 +1,33 @@
+# <%= app_name %>
+
+## Rails Build Environment
+
+**Ruby:** <%= RUBY_VERSION %>
+
+**Rails:** <%= Rails::VERSION::STRING %>
+
+**Database:** <%= options[:database] %>
+
+**Additional Info**
+
+<%- unless options[:skip_erd] -%>
+## Database Structure (ERD)
+
+![](<%= app_name.parameterize %>_erd.png)
+
+<%- end -%>
+## Getting Started
+
+### Prerequisites
+
+Things you need to do in order for the software to run.
+
+```shell
+bundle install
+rails db:migrate db:seed
+rails s
+```
+
+### Installing
+
+A step-by-step guide on how to install the software to run and function as intended.

data/lib/kowl/templates/app/assets/javascripts/semantic.js.tt

@@ -0,0 +1,26 @@
+//= require rails-ujs
+//= require jquery3
+//= require jquery_ujs
+//= require semantic-ui
+//= require activestorage
+<%- unless options[:skip_javascript] -%>
+//= require turbolinks
+<%- end -%>
+//= require_tree .
+
+<%- if options[:skip_javascript] -%>
+$(document).ready(function() {
+<%- else -%>
+$(document).on("turbolinks:load",function(){
+<%- end -%>
+  // Allow the user to close the flash messages
+  $('.message .close')
+    .on('click', function(){
+      $(this).closest('.message').transition('fade');
+  });
+
+  // Automatically close flash messages after 3 seconds
+  window.setTimeout(function() {
+    $('.message').transition('fade');
+  }, 3000);
+});