boring_generators 0.13.0 → 0.15.0

data/lib/generators/boring/ci/gitlab_ci/install/templates/ci.yml.tt

@@ -0,0 +1,94 @@
+image: ruby:<%= @ruby_version %>
+
+variables:
+  MASTER_KEY: $MASTER_KEY
+
+cache:
+  paths:
+    - vendor/
+    <%- if File.exist?("package.json") -%>
+    - node_modules/
+    - yarn.lock
+    <%- end -%>
+
+stages:
+  - test
+
+.base_db:
+<%- if @database == "postgresql" -%>
+  services:
+    - postgres:latest
+<%- elsif @database == "mysql" -%>
+  services:
+    - mysql:latest
+<%- end -%>
+  variables:
+    RAILS_ENV: test
+  <%- if @database == "postgresql" -%>
+    POSTGRES_HOST_AUTH_METHOD: trust
+  <%- end -%>
+  <%- if @database == "mysql" -%>
+    MYSQL_ALLOW_EMPTY_PASSWORD: true
+  <%- end -%>
+  before_script:
+    - gem install bundler -v "$(grep -A 1 "BUNDLED WITH" Gemfile.lock | tail -n 1)" --no-document
+    - bundle config set --local path 'vendor'
+    <%- if File.exist?("package.json") -%>
+    - apt-get update -qq && apt-get install -y -qq nodejs
+    - curl -o- -L https://yarnpkg.com/install.sh | bash
+    - export PATH="$HOME/.yarn/bin:$HOME/.config/yarn/global/node_modules/.bin:$PATH"
+    - yarn install --pure-lockfile
+    <%- end -%>
+    <%- if @database == "sqlite3" -%>
+    - apt-get update && apt-get install --no-install-recommends -y sqlite3
+    <%- end -%>
+    - apt-get update && apt-get install --no-install-recommends -y cmake
+    - bundle install --jobs $(nproc)
+    - cp config/database.yml.ci config/database.yml
+    <%- if @environment_variable_manager == "dotenv" -%>
+    - cat $env > .env
+    <%- elsif @environment_variable_manager == "figjam" -%>
+    - cat $env > config/application.yml
+    <%- end -%>
+    - bundle exec rails db:test:prepare
+
+unit_and_integration_tests:
+  extends: .base_db
+  stage: test
+  only:
+    - merge_requests
+  script:
+  <%- if @app_test_framework == "rspec" -%>
+    - bundle exec rspec --exclude-pattern "spec/system/**/*.rb"
+  <%- else -%>
+    - bundle exec rails test
+  <%- end -%>
+
+system_tests:
+  extends: .base_db
+  stage: test
+  services:
+    - name: selenium/standalone-chrome:latest
+      alias: selenium
+  <%- if @database == "postgresql" -%>
+    - postgres:latest
+  <%- elsif @database == "mysql" -%>
+    - mysql:latest
+  <%- end -%>
+  variables:
+    RAILS_ENV: test
+    SELENIUM_REMOTE_URL: http://selenium:4444/wd/hub
+  only:
+    - merge_requests
+  script:
+  <%- if @app_test_framework == "rspec" -%>
+    - bundle exec rspec spec/system
+  <%- else -%>
+    - bundle exec rails test:system
+  <%- end -%>
+  artifacts:
+    when: on_failure
+    paths:
+      - log/test.log
+      - tmp/screenshots/
+    expire_in: 1 week

data/lib/generators/boring/ci/gitlab_ci/install/templates/database.yml.ci.tt

@@ -0,0 +1,20 @@
+test:
+<%- if @database == "postgresql" -%>
+  adapter: postgresql
+  encoding: unicode
+  host: postgres
+  username: postgres
+<%- elsif @database == "mysql" -%>
+  adapter: mysql2
+  encoding: utf8mb4
+  host: mysql
+  username: root
+  socket: /tmp/mysql.sock
+<%- else -%>
+  adapter: sqlite3
+  database: db/test.sqlite3
+<%- end -%>
+<%- unless @database == "sqlite3" -%>
+  database: ci_db
+<%- end -%>
+  pool: <%%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>

data/lib/generators/boring/ci/gitlab_ci/install/templates/system_sample_spec.rb.tt

@@ -0,0 +1,14 @@
+require "rails_helper"
+
+RSpec.describe "Sample System Test", type: :system, js: true do
+  it "checks if the system test is configured correctly" do
+    visit rails_health_check_path
+
+    # expect page body to have green background
+    expect(
+      page.evaluate_script(
+        "window.getComputedStyle(document.body).backgroundColor"
+      )
+    ).to eq("rgb(0, 128, 0)")
+  end
+end

data/lib/generators/boring/ci/gitlab_ci/install/templates/system_sample_test.rb.tt

@@ -0,0 +1,13 @@
+require "application_system_test_case"
+
+class SampleTest < ApplicationSystemTestCase
+  test "checks if the system test is configured correctly" do
+    visit rails_health_check_path
+
+    # assert page body has green background
+    assert_equal "rgb(0, 128, 0)",
+                 page.evaluate_script(
+                   "window.getComputedStyle(document.body).backgroundColor"
+                 )
+  end
+end

data/lib/generators/boring/ci/gitlab_ci/install/templates/unit_sample_spec.rb.tt

@@ -0,0 +1,7 @@
+require "rails_helper"
+
+RSpec.describe("Sample", type: :model) do
+  it "tests the truth" do
+    expect(true).to be_truthy
+  end
+end

data/lib/generators/boring/ci/gitlab_ci/install/templates/unit_sample_test.rb.tt

@@ -0,0 +1,7 @@
+require "test_helper"
+
+class SampleTest < ActiveSupport::TestCase
+  test "the truth" do
+    assert true
+  end
+end

data/lib/generators/boring/devise/doorkeeper/install/install_generator.rb

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+require 'boring_generators/generator_helper'
+
+module Boring
+  module Devise
+    module Doorkeeper
+      class InstallGenerator < Rails::Generators::Base
+        include BoringGenerators::GeneratorHelper
+
+        desc "Adds doorkeeper with devise to the application"
+
+        class_option :model_name, type: :string, aliases: "-m", default: "User",
+                     desc: "Tell us the user model name which will be used for authentication. Defaults to User"
+        class_option :grant_flows, type: :array, aliases: "-gf", default: %w[authorization_code client_credentials],
+                     enum: %w[authorization_code client_credentials password],
+                     desc: "Tell us the grant flows you want to use separated by space. Defaults to authorization_code and client_credentials"
+        class_option :api_only, type: :boolean, aliases: "-a", default: false,
+                     desc: "Tell us if you want to setup doorkeeper for API only application. Defaults to false"
+        class_option :skip_applications_routes, type: :boolean, aliases: "-sr", default: false,
+                     desc: "Tell us if you want to skip adding doorkeeper routes to manage applications. Defaults to false"
+        class_option :use_refresh_token, type: :boolean, aliases: "-rt", default: false,
+                     desc: "Keep user logged in with refresh tokens. Defaults to false"
+
+        def verify_presence_of_devise_gem
+          return if gem_installed?("devise")
+
+          say "We couldn't find devise gem. Please configure devise gem and rerun the generator. Consider running `rails generate boring:devise:install` to set up Devise.",
+              :red
+
+          abort
+        end
+
+        def verify_presence_of_devise_model
+          return if File.exist?("app/models/#{options[:model_name].underscore}.rb")
+
+          say "We couldn't find the #{options[:model_name]} model. Maybe there is a typo? Please provide the correct model name and run the generator again.",
+              :red
+
+          abort
+        end
+
+        def add_doorkeeper_gem
+          say "Adding doorkeeper gem", :green
+          
+          check_and_install_gem "doorkeeper"
+        end
+
+        def run_doorkeeper_generators
+          say "Running doorkeeper generators", :green
+
+          Bundler.with_unbundled_env do
+            run "bundle exec rails generate doorkeeper:install"
+            run "bundle exec rails generate doorkeeper:migration"
+          end
+        end
+
+        def add_doorkeeper_related_association_to_model
+          model_name = options[:model_name].underscore
+          say "Adding doorkeeper related associations to the model file app/models/#{model_name}.rb",
+              :green
+          model_content = <<~RUBY
+            has_many :access_grants,
+                     class_name: 'Doorkeeper::AccessGrant',
+                     foreign_key: :resource_owner_id,
+                     dependent: :delete_all # or :destroy if you need callbacks
+
+            has_many :access_tokens,
+                     class_name: 'Doorkeeper::AccessToken',
+                     foreign_key: :resource_owner_id,
+                     dependent: :delete_all # or :destroy if you need callbacks
+          RUBY
+
+          inject_into_file "app/models/#{model_name}.rb",
+                           optimize_indentation(model_content, 2),
+                           after: "ApplicationRecord\n"
+        end
+
+        def update_doorkeeper_initializer
+          say "Updating doorkeeper initializer", :green
+
+          configure_resource_owner_authenticator if options[:grant_flows].include?("authorization_code")
+          configure_admin_authenticator unless options[:api_only] || options[:skip_applications_routes]
+          configure_resource_owner_from_credentials if options[:grant_flows].include?("password")
+
+          gsub_file "config/initializers/doorkeeper.rb",
+                    /# grant_flows %w\[authorization_code client_credentials\]/,
+                    "grant_flows %w[#{options[:grant_flows].uniq.join(' ')}]"
+
+          if options[:api_only]
+            gsub_file "config/initializers/doorkeeper.rb",
+                      /# api_only/,
+                      "api_only"
+          end
+
+          if options[:skip_applications_routes]
+            doorkeeper_routes_content = <<~RUBY
+              use_doorkeeper do
+                skip_controllers :applications, :authorized_applications
+              end
+            RUBY
+            
+            gsub_file "config/routes.rb",
+                      /.*use_doorkeeper/,
+                      optimize_indentation(doorkeeper_routes_content, 2)
+          end
+
+          if options[:use_refresh_token]
+            uncomment_lines "config/initializers/doorkeeper.rb",
+                            /use_refresh_token/
+          end
+        end
+
+        def update_doorkeeper_migration
+          say "Updating doorkeeper migration", :green
+          model_name = options[:model_name].underscore
+
+          uncomment_lines Dir["db/migrate/*_create_doorkeeper_tables.rb"].first,
+                          /add_foreign_key :oauth/
+
+          gsub_file Dir["db/migrate/*_create_doorkeeper_tables.rb"].first,
+                    /<model>/,
+                    ":#{model_name.pluralize}"
+
+          return unless (%w[password client_credentials] & options[:grant_flows]).any?
+
+          gsub_file Dir["db/migrate/*_create_doorkeeper_tables.rb"].first,
+                    /t.text    :redirect_uri, null: false/,
+                    "t.text    :redirect_uri"
+        end
+
+        def show_message
+          return if options[:api_only] || options[:skip_applications_routes]
+
+          model_name = options[:model_name].underscore
+          admin_authenticator_content = "current_#{model_name} || warden.authenticate!(scope: :#{model_name})"
+
+          say "\nWe've implemented `#{admin_authenticator_content}` in the admin_authenticator block of config/initializers/doorkeeper.rb to manage access to application routes. Please adjust it as necessary to suit your requirements.",
+              :yellow
+        end
+
+        private
+
+        def configure_resource_owner_authenticator
+          model_name = options[:model_name].underscore
+          resource_owner_authenticator_content = <<~RUBY
+            resource_owner_authenticator do
+              current_#{model_name} || warden.authenticate!(scope: :#{model_name})
+            end
+          RUBY
+
+          gsub_file "config/initializers/doorkeeper.rb",
+                    /.*resource_owner_authenticator do\n(?:\s|.)*?end/,
+                    optimize_indentation(resource_owner_authenticator_content, 2)
+        end
+
+        def configure_admin_authenticator
+          model_name = options[:model_name].underscore
+          gsub_file "config/initializers/doorkeeper.rb",
+                    /(?:# admin_authenticator do\n*)((?:\s|.)*?)(?:# end)/,
+                    "admin_authenticator do\n" + "\\1" + "end"
+
+          admin_authenticator_content = "current_#{model_name} || warden.authenticate!(scope: :#{model_name})"
+          inject_into_file "config/initializers/doorkeeper.rb",
+                           optimize_indentation(admin_authenticator_content, 4),
+                           after: /admin_authenticator do\n/,
+                           force: true
+
+        end
+
+        def configure_resource_owner_from_credentials
+          model_name = options[:model_name].underscore
+          resource_owner_for_credentials_content = <<~RUBY
+            resource_owner_from_credentials do |routes|
+              #{model_name} = #{options[:model_name]}.find_for_database_authentication(email: params[:email])
+              if #{model_name}&.valid_for_authentication? { #{model_name}.valid_password?(params[:password]) } && #{model_name}&.active_for_authentication?
+                request.env['warden'].set_user(#{model_name}, scope: :#{model_name}, store: false)
+                #{model_name}
+              end
+            end
+          RUBY
+
+          inject_into_file "config/initializers/doorkeeper.rb",
+                           optimize_indentation(resource_owner_for_credentials_content, 2),
+                           after: /resource_owner_authenticator do\n(?:\s|.)*?end\n/
+        end
+      end
+    end
+  end
+end

data/lib/generators/boring/devise/install/install_generator.rb

@@ -7,18 +7,28 @@ module Boring
 
       DEFAULT_DEVISE_MODEL_NAME = "User"
 
-      class_option :model_name, type: :string, aliases: "-m",
-                   desc: "Tell us the user model name which will be used for authentication. Defaults to #{DEFAULT_DEVISE_MODEL_NAME}"
-      class_option :skip_devise_view, type: :boolean, aliases: "-sv",
+      class_option :model_name,
+                   type: :string,
+                   aliases: "-m",
+                   desc:
+                     "Tell us the user model name which will be used for authentication. Defaults to #{DEFAULT_DEVISE_MODEL_NAME}"
+      class_option :skip_devise_view,
+                   type: :boolean,
+                   aliases: "-sv",
                    desc: "Skip generating devise views"
-      class_option :skip_devise_model, type: :boolean, aliases: "-sm",
+      class_option :skip_devise_model,
+                   type: :boolean,
+                   aliases: "-sm",
                    desc: "Skip generating devise model"
+      class_option :run_db_migrate,
+                   type: :boolean,
+                   aliases: "-rdm",
+                   desc: "Run migrations after generating user table",
+                   default: false
 
       def add_devise_gem
         say "Adding devise gem", :green
-        Bundler.with_unbundled_env do
-          run "bundle add devise"
-        end
+        Bundler.with_unbundled_env { run "bundle add devise" }
       end
 
       def generating_devise_defaults
@@ -30,10 +40,12 @@ module Boring
 
       def add_devise_action_mailer_development_config
         say "Adding devise Action Mailer development configuration", :green
-        insert_into_file "config/environments/development.rb", <<~RUBY, after: /Rails.application.configure do/
+        insert_into_file "config/environments/development.rb",
+                         <<~RUBY,
           \n
           \tconfig.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
         RUBY
+                         after: /Rails.application.configure do/
       end
 
       def add_devise_user_model
@@ -45,13 +57,28 @@ module Boring
         Bundler.with_unbundled_env do
           run "DISABLE_SPRING=1 bundle exec rails generate devise #{model_name}"
         end
+
+        # make the email unique
+        if File.exist?("test/fixtures/users.yml")
+          email_content = <<~FIXTURE
+            one:
+              email: example-$LABEL@email.com
+          FIXTURE
+
+          gsub_file "test/fixtures/users.yml",
+                    /one: {}/,
+                    optimize_indentation(email_content, 0)
+        end
       end
 
       def add_devise_authentication_filter_to_application_controller
-        insert_into_file "app/controllers/application_controller.rb", <<~RUBY, after: /class ApplicationController < ActionController::Base/
+        insert_into_file "app/controllers/application_controller.rb",
+                         <<~RUBY,
           \n
           \tbefore_action :authenticate_user!
         RUBY
+                         after:
+                           /class ApplicationController < ActionController::Base/
       end
 
       def add_devise_views
@@ -64,6 +91,12 @@ module Boring
           run "DISABLE_SPRING=1 bundle exec rails generate devise:views #{model_name.pluralize}"
         end
       end
+
+      def run_db_migrate
+        return unless options[:run_db_migrate]
+
+        Bundler.with_unbundled_env { rails_command "db:migrate" }
+      end
     end
   end
 end

data/lib/generators/boring/dotenv/install/install_generator.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "boring_generators/generator_helper"
+
+module Boring
+  module Dotenv
+    class InstallGenerator < Rails::Generators::Base
+      include BoringGenerators::GeneratorHelper
+
+      desc "Adds dotenv gem to the application"
+      source_root File.expand_path("templates", __dir__)
+
+      def add_dotenv_gem
+        return if gem_installed?("dotenv-rails")
+
+        say "Adding dotenv gem", :green
+
+        check_and_install_gem "dotenv-rails", group: :development
+      end
+
+      def configure_dotenv_gem
+        say "Configuring dotenv gem", :green
+
+        template ".env", ".env"
+
+        create_file ".gitignore" unless File.exist?(".gitignore")
+
+        FileUtils.cp(".env", ".env.sample")
+
+        add_env_files_to_gitignore
+      end
+
+      private
+
+      def add_env_files_to_gitignore
+        if File.readlines(".gitignore").any? { |line| line.include?(".env") }
+          return
+        end
+
+        ignore_content = <<~ENV_FILE_NAMES
+          \n
+          # Ignore all environment files (except templates).
+          /.env
+          !/.env.*
+        ENV_FILE_NAMES
+
+        insert_into_file(".gitignore", ignore_content)
+      end
+    end
+  end
+end

data/lib/generators/boring/dotenv/install/templates/.env

@@ -0,0 +1,3 @@
+# Add your environment variables here
+# Example:
+# SECRET_KEY_BASE=your_secret_key

data/lib/generators/boring/factory_bot/install/install_generator.rb

@@ -14,7 +14,7 @@ module Boring
       def add_factory_bot_gem
         log :adding, "FactoryBot"
         Bundler.with_unbundled_env do
-          run "bundle add factory_bot_rails --group='developement,test'"
+          run "bundle add factory_bot_rails --group='development,test'"
         end
       end
 

data/lib/generators/boring/faker/install/install_generator.rb

@@ -9,7 +9,7 @@ module Boring
       def add_faker_gem
         log :adding, "faker"
         Bundler.with_unbundled_env do
-          run "bundle add faker --group='developement,test'"
+          run "bundle add faker --group='development,test'"
         end
       end
     end

data/lib/generators/boring/favicon/build/build_generator.rb

@@ -39,7 +39,7 @@ module Boring
       end
 
       def create_favicon_directory
-        unless File.exists?(FILE_FAVICO_DIR)
+        unless File.exist?(FILE_FAVICO_DIR)
           Dir.mkdir FILE_FAVICO_DIR
         end
       end

data/lib/generators/boring/figjam/install/install_generator.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Boring
+  module Figjam
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Adds figjam gem to the app'
+
+      def add_figjam_gem
+        say 'Adding figjam gem', :green
+
+        Bundler.with_unbundled_env do
+          run 'bundle add figjam'
+        end
+      end
+
+      def configure_figjam
+        say 'Configuring figjam', :green
+
+        Bundler.with_unbundled_env do
+          run 'bundle exec figjam install'
+        end
+
+        FileUtils.cp('config/application.yml', 'config/application.yml.sample')
+
+        unless File.exist?('.gitignore')
+          create_file '.gitignore'
+        end
+
+        insert_into_file('.gitignore', "\n/config/application.yml\n")
+      end
+    end
+  end
+end

data/lib/generators/boring/honeybadger/install/install_generator.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Boring
+  module Honeybadger
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+      desc 'Adds honeybadger to the app'
+
+      class_option :use_env_variable, type: :boolean, aliases: "-ev",
+                   desc: 'Use ENV variable for devise_jwt_secret_key. By default Rails credentials will be used.'
+
+      def add_honeybadger_gem
+        say 'Adding Honeybadger gem', :green
+
+        Bundler.with_unbundled_env do
+          run 'bundle add honeybadger'
+        end
+      end
+
+      def configure_honeybadger_gem
+        say 'Setting up Honeybadger', :green
+
+        @api_key = honeybadger_api_key
+
+        template 'honeybadger.yml', 'config/honeybadger.yml'
+
+        show_readme
+      end
+
+      private
+
+      def show_readme
+        readme_template = File.read(File.join(self.class.source_root, 'README'))
+        readme_content = ERB.new(readme_template).result(binding)
+        say readme_content
+      end
+
+      def honeybadger_api_key
+        if options[:use_env_variable]
+          "ENV['HONEYBADGER_API_KEY']"
+        else
+          "Rails.application.credentials.dig(:honeybadger, :api_key)"
+        end
+      end
+    end
+  end
+end

data/lib/generators/boring/honeybadger/install/templates/README

@@ -0,0 +1,6 @@
+===============================================================================
+
+The API key for Honeybadger will be used from <%= @api_key %>.
+You can change these values if they don't match with your app.
+
+===============================================================================

data/lib/generators/boring/honeybadger/install/templates/honeybadger.yml.tt

@@ -0,0 +1,26 @@
+---
+# For more options, see https://docs.honeybadger.io/lib/ruby/gem-reference/configuration
+
+api_key: <%= @api_key %>
+
+# The environment your app is running in.
+env: "<%= Rails.env %>"
+
+# The absolute path to your project folder.
+root: "<%= Rails.root.to_s %>"
+
+# Honeybadger won't report errors in these environments.
+development_environments:
+- test
+- development
+- cucumber
+
+# By default, Honeybadger won't report errors in the development_environments.
+# You can override this by explicitly setting report_data to true or false.
+# report_data: true
+
+# The current Git revision of your project. Defaults to the last commit hash.
+# revision: null
+
+# Enable verbose debug logging (useful for troubleshooting).
+debug: false