boring_generators 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1c4e7578120facf94b1e17cadcb9e62f008ffec728658d650842d19ee931b82
-  data.tar.gz: 7a026a5987aec9f8e3ee38dd1218e48908e0df5891fcb0d8e9f91a904f9985f9
+  metadata.gz: 69a40221e1b2d89fde7e887f6f0b92f8d972548c000b363b4eab025f613844bc
+  data.tar.gz: c0f61c22deabdb64366d9d11b9e01f8cd6f09ca6b576f01342c0c455e70325ba
 SHA512:
-  metadata.gz: aae856dd9081e7ab70e7d750f585474de515baf8a09c79d0ffef180162aeb1bb5317703ffc0f392ca6bc997ee36775ac1fe5f12e442339a73b5d50ac1df1fa5d
-  data.tar.gz: d4cce2e4bf333a907e7ace4fdb56c0218c4832f047aa644f019246fa3504ab6d21c2c49713d95df289d6507c76e9772a80dec965eb2657445d641833a3e69a00
+  metadata.gz: 65ac7ade20d72cc641bda7282f66fca33e330ff891fad2f4eaffce20914a0776e02e7afba1da2553308c54b56bd46362e1dd3c0c76ddae36c632013b72f36dc8
+  data.tar.gz: fc30ecc6102379477e7c05a97657318ed2e22560acf3098154a1da45d9d0ad2426677caa90a86e755b7a2080f0183be92f345aada6f89f8b39d923a61bbf4208

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master (unreleased)
 
+## 0.15.0 (Aug 4th, 2024)
+
+* Adds Gitlab CI generator. ([@coolprobn][])
+
 ## 0.14.0 (Aug 4th, 2024)
 
 - Adds Figjam generator. ([@mausamp][])

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    boring_generators (0.13.0)
+    boring_generators (0.14.0)
       railties
 
 GEM
@@ -143,4 +143,4 @@ DEPENDENCIES
   sqlite3 (~> 1.4)
 
 BUNDLED WITH
-   2.2.33
+   2.4.10

data/README.md

@@ -97,6 +97,7 @@ The boring generator introduces following generators:
 - Install Rails ERD: `rails generate boring:rails_erd:install`
 - Install Annotate: `rails generate boring:annotate:install`
 - Install CanCanCan: `rails generate boring:cancancan:install`
+- Install Gitlab CI: `rails generate boring:ci:gitlab_ci:install`
 
 ## Screencasts
 

data/lib/boring_generators/generator_helper.rb

@@ -3,9 +3,9 @@ module BoringGenerators
     include Rails::Generators::Actions
 
     def app_ruby_version
-      with_ruby_string = `grep "^ruby.*$" Gemfile` || `cat .ruby-version`
+      with_ruby_string = File.read("Gemfile")[/^ruby\s+["']?([\d.]+)["']?/] || File.read(".ruby-version").strip
 
-      # only keep 3.3.0
+      # only keep 3.3.0 from ruby-3.3.0
       with_ruby_string.gsub(/[^\d\.]/, "").squish
     end
 
@@ -30,5 +30,17 @@ module BoringGenerators
 
       bundle_install
     end
+
+    def inject_into_file_if_new(*args)
+      file_name, content_to_add, = args
+
+      file_content = File.read(file_name)
+
+      content_exists = file_content.include?(content_to_add)
+
+      return if content_exists
+
+      inject_into_file *args
+    end
   end
 end

data/lib/boring_generators/version.rb

@@ -1,3 +1,3 @@
 module BoringGenerators
-  VERSION = "0.14.0"
+  VERSION = "0.15.0"
 end

data/lib/generators/boring/ci/gitlab_ci/install/install_generator.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require "boring_generators/generator_helper"
+
+module Boring
+  module Ci
+    module GitlabCi
+      class InstallGenerator < Rails::Generators::Base
+        desc "Adds Gitlab CI to the application"
+        source_root File.expand_path("templates", __dir__)
+
+        class_option :ruby_version,
+                     aliases: "-rv",
+                     type: :string,
+                     desc:
+                       "Ruby version used by your app. Defaults to .ruby_version or the version specified in your Gemfile."
+        class_option :app_test_framework,
+                     aliases: "-tf",
+                     type: :string,
+                     enum: %w[minitest rspec],
+                     default: "minitest",
+                     desc:
+                       "Tell us the test framework you use for the application. Defaults to Minitest."
+        class_option :environment_variable_manager,
+                     aliases: "-evm",
+                     type: :string,
+                     enum: %w[rails_credentials dotenv figjam],
+                     default: "rails_credentials",
+                     desc:
+                       "Tell us the environment variable manager you use. Defaults to Rails Credentials"
+        class_option :database,
+                     aliases: "-d",
+                     type: :string,
+                     enum: %w[sqlite3 postgresql mysql],
+                     default: "sqlite3",
+                     desc: "Tell us the database you use in your app"
+        class_option :skip_sample_tests,
+                     aliases: "-stt",
+                     type: :boolean,
+                     default: false,
+                     desc:
+                       "Skip sample tests. Useful when you are configuring Gitlab CI for existing Rails app"
+
+        include BoringGenerators::GeneratorHelper
+
+        def add_gitlab_ci_configurations
+          @ruby_version = options[:ruby_version] || app_ruby_version
+          @app_test_framework = options[:app_test_framework]
+          @environment_variable_manager = options[:environment_variable_manager]
+          @database = options[:database]
+
+          template("ci.yml", ".gitlab-ci.yml")
+          template("database.yml.ci", "config/database.yml.ci")
+        end
+
+        def add_gems_for_system_test
+          check_and_install_gem "capybara", group: :test
+          check_and_install_gem "selenium-webdriver", group: :test
+        end
+
+        def add_capybara_configurations
+          if options[:app_test_framework] == "minitest"
+            template("capybara_helper.rb", "test/helpers/capybara.rb")
+
+            inject_into_file_if_new "test/application_system_test_case.rb",
+                                    "require \"helpers/capybara\"\n",
+                                    before: "class ApplicationSystemTestCase"
+            gsub_file "test/application_system_test_case.rb",
+                      /driven_by :selenium, using: :(?:chrome|headless_chrome).*\n/,
+                      "driven_by :selenium_chrome_custom"
+
+            capybara_setup = <<-RUBY
+            \n
+            def setup
+              Capybara.server_host = "0.0.0.0" # bind to all interfaces
+              Capybara.server_port = 3000
+
+              if ENV["SELENIUM_REMOTE_URL"].present?
+                ip = Socket.ip_address_list.detect(&:ipv4_private?).ip_address
+                Capybara.app_host = "http://\#{ip}:\#{Capybara.server_port}"
+              end
+
+              super
+            end
+            RUBY
+
+            inject_into_file_if_new "test/application_system_test_case.rb",
+                                    optimize_indentation(
+                                      capybara_setup,
+                                      amount = 2
+                                    ),
+                                    after: "driven_by :selenium_chrome_custom"
+          else
+            template("capybara_helper.rb", "spec/support/capybara.rb")
+
+            inject_into_file_if_new "spec/rails_helper.rb",
+                                    "require_relative \"./support/capybara\"\n\n",
+                                    before: "RSpec.configure do |config|"
+          end
+        end
+
+        def add_sample_tests
+          return if options[:skip_sample_tests]
+
+          if options[:app_test_framework] == "minitest"
+            template("unit_sample_test.rb", "test/models/sample_test.rb")
+            template("system_sample_test.rb", "test/system/sample_test.rb")
+          else
+            template("unit_sample_spec.rb", "spec/models/sample_spec.rb")
+            template("system_sample_spec.rb", "spec/system/sample_spec.rb")
+          end
+        end
+
+        def show_readme
+          readme "README"
+        end
+      end
+    end
+  end
+end

data/lib/generators/boring/ci/gitlab_ci/install/templates/README

@@ -0,0 +1,10 @@
+
+===============================================================================
+
+You need to update your project's Gitlab CI variable configurations for the Gitlab CI to work correctly. Please take care of the following:
+
+- Add your Gitlab personal access token under the variable `PRONTO_ACCESS_TOKEN`
+- Copy your application's environment variables under `env` variable in CI/CD
+- Add your Master Key required for decoding secret values under the variable `MASTER_KEY`
+
+===============================================================================

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

@@ -0,0 +1,42 @@
+require "selenium-webdriver"
+
+Capybara.register_driver :selenium_chrome_custom do |app|
+  options = Selenium::WebDriver::Chrome::Options.new
+
+  options.add_argument("--headless=new") unless ENV["SELENIUM_HEADFUL"]
+
+  options.add_argument("--window-size=1400,1400")
+  options.add_argument("--no-sandbox")
+  options.add_argument("--disable-dev-shm-usage")
+
+  remote_url = ENV.fetch("SELENIUM_REMOTE_URL", nil)
+
+  if remote_url
+    Capybara::Selenium::Driver.new(
+      app,
+      browser: :remote,
+      url: remote_url,
+      options:
+    )
+  else
+    Capybara::Selenium::Driver.new(app, browser: :chrome, options:)
+  end
+end
+
+<%- if @app_test_framework == "rspec" -%>
+RSpec.configure do |config|
+  config.before(:each, type: :system, js: true) do
+    # Make the test app listen to outside requests, required for the remote Selenium instance
+    Capybara.server_host = "0.0.0.0"
+    Capybara.server_port = 3000
+
+    if ENV.fetch("SELENIUM_REMOTE_URL", nil)
+      # Use the application container's IP instead of localhost so Capybara knows where to direct Selenium
+      ip = Socket.ip_address_list.detect(&:ipv4_private?).ip_address
+      Capybara.app_host = "http://#{ip}:#{Capybara.server_port}"
+    end
+
+    driven_by :selenium_chrome_custom
+  end
+end
+<%- end -%>

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/install/install_generator.rb

@@ -7,21 +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",
+      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
@@ -33,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
@@ -48,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
@@ -71,9 +95,7 @@ module Boring
       def run_db_migrate
         return unless options[:run_db_migrate]
 
-        Bundler.with_unbundled_env do
-          rails_command "db:migrate"
-        end
+        Bundler.with_unbundled_env { rails_command "db:migrate" }
       end
     end
   end

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

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'boring_generators/generator_helper'
+require "boring_generators/generator_helper"
 
 module Boring
   module Vcr
     class InstallGenerator < Rails::Generators::Base
       include BoringGenerators::GeneratorHelper
-      
+
       desc "Adds VCR to the application"
       source_root File.expand_path("templates", __dir__)
 
@@ -46,7 +46,7 @@ module Boring
 
       def add_vcr_gem
         say "Adding VCR gems to Gemfile", :green
-        
+
         check_and_install_gem "vcr", group: :test
       end
 
@@ -83,9 +83,10 @@ module Boring
           require "vcr"
 
           VCR.configure do |c|
-            c.cassette_library_dir = "test/vcr"
+            c.cassette_library_dir = "test/vcr_cassettes"
             c.hook_into #{format_stubbing_libraries}
             c.ignore_localhost = true
+            c.allow_http_connections_when_no_cassette = true
           end
         RUBY
 

data/lib/generators/boring/vcr/install/templates/rspec/vcr.rb.tt

@@ -1,8 +1,9 @@
 require "vcr"
 
 VCR.configure do |c|
-  c.cassette_library_dir = "spec/cassettes"
+  c.cassette_library_dir = "spec/vcr_cassettes"
   c.hook_into <%= @stubbing_libraries %>
   c.configure_rspec_metadata!
   c.ignore_localhost = true
+  c.allow_http_connections_when_no_cassette = true
 end

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

@@ -11,7 +11,7 @@ module Boring
 
       SUPPORTED_TEST_FRAMEWORKS = %w[rspec minitest]
 
-      # can't use "test_framework" option which would be a good naming for this because it's being used by Rails::Generator::Base. It's better not to have any conflict with the base class so prefixing with "app_" here
+      # can't use "test_framework" option which would be a good naming for this because it's being used by Rails::Generator::Base. Rails will override this value if we use test_framework so prefixing with "app_" here
       class_option :app_test_framework,
                    type: :string,
                    desc: "Tell us the framework you use for writing tests in your application. Supported options are #{SUPPORTED_TEST_FRAMEWORKS}",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boring_generators
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Abhay Nikam
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-04 00:00:00.000000000 Z
+date: 2024-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -74,6 +74,15 @@ files:
 - lib/generators/boring/ci/circleci/install/templates/database.yml.ci.tt
 - lib/generators/boring/ci/github_action/install/install_generator.rb
 - lib/generators/boring/ci/github_action/install/templates/ci.yml.tt
+- lib/generators/boring/ci/gitlab_ci/install/install_generator.rb
+- lib/generators/boring/ci/gitlab_ci/install/templates/README
+- lib/generators/boring/ci/gitlab_ci/install/templates/capybara_helper.rb.tt
+- lib/generators/boring/ci/gitlab_ci/install/templates/ci.yml.tt
+- lib/generators/boring/ci/gitlab_ci/install/templates/database.yml.ci.tt
+- lib/generators/boring/ci/gitlab_ci/install/templates/system_sample_spec.rb.tt
+- lib/generators/boring/ci/gitlab_ci/install/templates/system_sample_test.rb.tt
+- lib/generators/boring/ci/gitlab_ci/install/templates/unit_sample_spec.rb.tt
+- lib/generators/boring/ci/gitlab_ci/install/templates/unit_sample_test.rb.tt
 - lib/generators/boring/ci/travisci/install/install_generator.rb
 - lib/generators/boring/ci/travisci/install/templates/.travis.yml.tt
 - lib/generators/boring/devise/doorkeeper/install/install_generator.rb