boring_generators 0.13.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3e2cf89c148c10914b919c1f9be41275681aa3ba8eaed7a22df5beb6adbef55
-  data.tar.gz: '083314c373aeb284b779aba16629fa36cbbeb9f60521161d0f1de081b7c1f99a'
+  metadata.gz: 69a40221e1b2d89fde7e887f6f0b92f8d972548c000b363b4eab025f613844bc
+  data.tar.gz: c0f61c22deabdb64366d9d11b9e01f8cd6f09ca6b576f01342c0c455e70325ba
 SHA512:
-  metadata.gz: a2f943d1a4fdda23f2a1905a3491f11e5aa8adde05371b24f91c20daa3dc7355a4d1a51e9d82243b642c2ddb5e738a5885369b034c79e87f801078186cf645b5
-  data.tar.gz: 4b1f672d170a27bd8782e423b228a45974ad5c6a2e8262adbfe91a109cc29b10f449d20176c8113201db119363fa3b035ce7707a71365ecfb391ee1a18a77cb8
+  metadata.gz: 65ac7ade20d72cc641bda7282f66fca33e330ff891fad2f4eaffce20914a0776e02e7afba1da2553308c54b56bd46362e1dd3c0c76ddae36c632013b72f36dc8
+  data.tar.gz: fc30ecc6102379477e7c05a97657318ed2e22560acf3098154a1da45d9d0ad2426677caa90a86e755b7a2080f0183be92f345aada6f89f8b39d923a61bbf4208

data/CHANGELOG.md

@@ -2,81 +2,113 @@
 
 ## master (unreleased)
 
+## 0.15.0 (Aug 4th, 2024)
+
+* Adds Gitlab CI generator. ([@coolprobn][])
+
+## 0.14.0 (Aug 4th, 2024)
+
+- Adds Figjam generator. ([@mausamp][])
+- Adds Pronto Generator with Gitlab CI ([@coolprobn][])
+- Adds Rack Mini Profiler generator. ([@mausamp][])
+- Adds VCR generator. ([@TheZero0-ctrl][])
+- Adds Pronto Generator with Gihub Action. ([@TheZero0-ctrl][])
+- Adds Doorkeeper Generator with Devise. ([@TheZero0-ctrl][])
+- Adds Avo generator. ([@mausamp][])
+- Adds Sentry generator. ([@mausamp][])
+- Adds Dotenv generator. ([@mausamp][])
+- Adds Honeybadger generator. ([@mausamp][])
+- Adds Rails ERD generator. ([@mausamp][])
+- Adds Annotate Generator. ([@TheZero0-ctrl][])
+- Adds CanCanCan generator. ([@TheZero0-ctrl][])
+
 ## 0.13.0 (March 26th, 2024)
-* Adds Letter Opener generator. ([@coolprobn][])
-* Adds Whenever generator. ([@aadil][])
-* Adds Rswag generator. ([@coolprobn][])
-* Adds Webmock generator. ([@aadil][])
+
+- Adds Letter Opener generator. ([@coolprobn][])
+- Adds Whenever generator. ([@aadil][])
+- Adds Rswag generator. ([@coolprobn][])
+- Adds Webmock generator. ([@aadil][])
 
 ## 0.12.0 (May 8th, 2023)
-* Adds Flipper generator. ([@abhaynikam][])
-* Adds FactoryBot generator. ([@abhaynikam][])
-* Adds Faker generator. ([@abhaynikam][])
-* Adds RSpec generator. ([@abhaynikam][])
-* Update default node-version for GitHub Action generator and fixes PG setup issues. ([@abhaynikam][])
-* Updates Bootstrap generator for supporting Bootstrap 5 with popper.js. ([@abhaynikam][])
-* Adds Overcommit generator for RuboCop. ([@coolprobn][])
-* Updates RuboCop generator to add rubocop-rake extension and support test frameworks ([@coolprobn][])
+
+- Adds Flipper generator. ([@abhaynikam][])
+- Adds FactoryBot generator. ([@abhaynikam][])
+- Adds Faker generator. ([@abhaynikam][])
+- Adds RSpec generator. ([@abhaynikam][])
+- Update default node-version for GitHub Action generator and fixes PG setup issues. ([@abhaynikam][])
+- Updates Bootstrap generator for supporting Bootstrap 5 with popper.js. ([@abhaynikam][])
+- Adds Overcommit generator for RuboCop. ([@coolprobn][])
+- Updates RuboCop generator to add rubocop-rake extension and support test frameworks ([@coolprobn][])
 
 ## 0.11.0 (June 23rd, 2021)
-* Adds Stimulus generator. ([@abhaynikam][])
-* Adds Rails Admin generator. ([@abhaynikam][])
-* Adds Paper Trail generator. ([@abhaynikam][])
+
+- Adds Stimulus generator. ([@abhaynikam][])
+- Adds Rails Admin generator. ([@abhaynikam][])
+- Adds Paper Trail generator. ([@abhaynikam][])
 
 ## 0.10.0 (May 26th, 2021)
-* Updates Stripe payment generator. ([@abhaynikam][])
-* Fixes many generators which install ruby gems to not hardcode gem version. ([@abhaynikam][])
+
+- Updates Stripe payment generator. ([@abhaynikam][])
+- Fixes many generators which install ruby gems to not hardcode gem version. ([@abhaynikam][])
 
 ## 0.9.0 (April 14th, 2021)
-* Adds Ahoy generator. ([@abhaynikam][])
-* Adds Stripe payment generator. ([@abhaynikam][])
+
+- Adds Ahoy generator. ([@abhaynikam][])
+- Adds Stripe payment generator. ([@abhaynikam][])
 
 ## 0.8.0 (February 28th, 2021)
-* Adds Devise Google Omniauth generator. ([@abhaynikam][])
-* Adds Devise Twitter Omniauth generator. ([@abhaynikam][])
-* Adds Twilio generator. ([@abhaynikam][])
+
+- Adds Devise Google Omniauth generator. ([@abhaynikam][])
+- Adds Devise Twitter Omniauth generator. ([@abhaynikam][])
+- Adds Twilio generator. ([@abhaynikam][])
 
 ## 0.7.0 (January 30th, 2021)
-* Upgrade the Tailwind CSS generator to support Tailwind V2.0. ([@abhaynikam][])
-* Adds Devise GitHub Omniauth generator. ([@abhaynikam][])
+
+- Upgrade the Tailwind CSS generator to support Tailwind V2.0. ([@abhaynikam][])
+- Adds Devise GitHub Omniauth generator. ([@abhaynikam][])
 
 ## 0.6.0 (January 10th, 2021)
-* Updates default ruby version of GitHub Actions install generator. ([@jamesglover][])
-* Simplify generated GitHub Actions install ([@jamesglover][])
-* Adds boring generator CLI ([@luathn][])
-* Adds Devise Facebook Omniauth generator. ([@abhaynikam][])
+
+- Updates default ruby version of GitHub Actions install generator. ([@jamesglover][])
+- Simplify generated GitHub Actions install ([@jamesglover][])
+- Adds boring generator CLI ([@luathn][])
+- Adds Devise Facebook Omniauth generator. ([@abhaynikam][])
 
 ## 0.5.0 (December 20th, 2020)
-* Adds favicon build generator. ([@abhaynikam][])
-* Adds Pundit install generator. ([@CiTroNaK][])
-* Adds GraphQL generator. ([@abhaynikam][])
-* Adds SimpleForm generator. ([@abhaynikam][])
-* Adds Devise generator. ([@abhaynikam][])
+
+- Adds favicon build generator. ([@abhaynikam][])
+- Adds Pundit install generator. ([@CiTroNaK][])
+- Adds GraphQL generator. ([@abhaynikam][])
+- Adds SimpleForm generator. ([@abhaynikam][])
+- Adds Devise generator. ([@abhaynikam][])
 
 ## 0.4.0 (October 23rd, 2020)
-* Adds CircleCI install generator. ([@abhaynikam][])
-* Adds GitHub Actions install generator. ([@abhaynikam][])
-* Adds Travis CI install generator. ([@abhaynikam][])
-* Adds Rubocop install generator. ([@abhaynikam][])
+
+- Adds CircleCI install generator. ([@abhaynikam][])
+- Adds GitHub Actions install generator. ([@abhaynikam][])
+- Adds Travis CI install generator. ([@abhaynikam][])
+- Adds Rubocop install generator. ([@abhaynikam][])
 
 ## 0.3.0 (September 19th, 2020)
-* Adds Bullet install generator. ([@abhaynikam][])
-* Adds Audit gems(bundler-audit, ruby_audit) install generator. ([@abhaynikam][])
-* Adds Pry install generator. ([@abhaynikam][])
-* Adds Active Storage Google install generator. ([@abhaynikam][])
-* Adds Active Storage AWS install generator. ([@abhaynikam][])
-* Adds Active Storage Microsoft Azure install generator. ([@abhaynikam][])
+
+- Adds Bullet install generator. ([@abhaynikam][])
+- Adds Audit gems(bundler-audit, ruby_audit) install generator. ([@abhaynikam][])
+- Adds Pry install generator. ([@abhaynikam][])
+- Adds Active Storage Google install generator. ([@abhaynikam][])
+- Adds Active Storage AWS install generator. ([@abhaynikam][])
+- Adds Active Storage Microsoft Azure install generator. ([@abhaynikam][])
 
 ## 0.2.0 (September 16th, 2020)
-* Adds JQuery install generator. ([@abhaynikam][])
-* Adds Bootstrap install generator. ([@abhaynikam][])
-* Adds FontAwesome install generator via Yarn. ([@abhaynikam][])
-* Adds FontAwesome install generator via RubyGems. ([@abhaynikam][])
+
+- Adds JQuery install generator. ([@abhaynikam][])
+- Adds Bootstrap install generator. ([@abhaynikam][])
+- Adds FontAwesome install generator via Yarn. ([@abhaynikam][])
+- Adds FontAwesome install generator via RubyGems. ([@abhaynikam][])
 
 ## 0.1.0 (September 5th, 2020)
 
-* Adds Tailwind CSS install generator. ([@abhaynikam][])
-* Initial release. ([@abhaynikam][])
+- Adds Tailwind CSS install generator. ([@abhaynikam][])
+- Initial release. ([@abhaynikam][])
 
 [@abhaynikam]: https://github.com/abhaynikam
 [@CiTroNaK]: https://github.com/CiTroNaK
@@ -84,3 +116,5 @@
 [@luathn]: https://github.com/luathn
 [@coolprobn]: https://github.com/coolprobn
 [@aadil]: https://github.com/AdilRT
+[@mausamp]: https://github.com/mausamp
+[@TheZero0-ctrl]: https://github.com/TheZero0-ctrl

data/Gemfile.lock

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

data/README.md

@@ -84,6 +84,20 @@ The boring generator introduces following generators:
 - Install Whenever: `rails generate boring:whenever:install`
 - Install Rswag: `rails generate boring:rswag:install --rails_port=<rails_app_port> --authentication_type=<api_authentication_type> --skip_api_authentication=<skip_api_authentication> --api_authentication_options=<api_authentication_options> --enable_swagger_ui_authentication=<enable_swagger_ui_authentication>`
 - Install Webmock: `rails generate boring:webmock:install --app_test_framework=<test_framework>`
+- Install Figjam: `rails generate boring:figjam:install`
+- Install Pronto with Gitlab CI: `rails generate boring:pronto:gitlab_ci:install`
+- Install Pronto with Github Action: `rails generate boring:pronto:github_action:install`
+- Install Rack Mini Profiler: `rails generate boring:rack_mini_profiler:install`
+- Install VCR: `rails generate boring:vcr:install --testing_framework=<testing_framework> --stubbing_libraries=<stubbing_libraries>`
+- Install Avo: `rails generate boring:avo:install`
+- Install Doorkeeper with devise: `rails generate boring:devise:doorkeeper:install`
+- Install Sentry: `rails generate boring:sentry:install --use_env_variable --breadcrumbs_logger=<breadcrumbs_logger_options>`
+- Install Dotenv: `rails generate boring:dotenv:install`
+- Install Honeybadger: `rails generate boring:honeybadger:install`
+- 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

@@ -0,0 +1,46 @@
+module BoringGenerators
+  module GeneratorHelper
+    include Rails::Generators::Actions
+
+    def app_ruby_version
+      with_ruby_string = File.read("Gemfile")[/^ruby\s+["']?([\d.]+)["']?/] || File.read(".ruby-version").strip
+
+      # only keep 3.3.0 from ruby-3.3.0
+      with_ruby_string.gsub(/[^\d\.]/, "").squish
+    end
+
+    def gem_installed?(gem_name)
+      gem_regex = /^\s*gem\s*['"]#{gem_name}['"]/
+
+      File.read("Gemfile").match?(gem_regex)
+    end
+
+    def bundle_install
+      Bundler.with_unbundled_env { run "bundle install" }
+    end
+
+    def check_and_install_gem(*args)
+      gem_name, = args
+
+      if gem_installed?(gem_name)
+        say "#{gem_name} is already in the Gemfile, skipping it...", :yellow
+      else
+        gem *args unless gem_installed?(gem_name)
+      end
+
+      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.13.0"
+  VERSION = "0.15.0"
 end

data/lib/generators/boring/active_storage/azure/install/install_generator.rb

@@ -2,7 +2,7 @@ module Boring
   module ActiveStorage
     module Azure
       class InstallGenerator < Rails::Generators::Base
-        desc "Adds ActiveStorage Mircosoft Azure the application"
+        desc "Adds ActiveStorage Microsoft Azure the application"
 
         class_option :skip_active_storage, type: :boolean, aliases: "-s",
                                            desc: "Skips running ActiveStorage installer"

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'boring_generators/generator_helper'
+
+module Boring
+  module Annotate
+    class InstallGenerator < Rails::Generators::Base
+      include BoringGenerators::GeneratorHelper
+
+      desc "Adds Annotate gem to the application"
+
+      class_option :skip_on_db_migrate,
+                   type: :boolean,
+                   alias: "-sm",
+                   default: false,
+                   desc: "Skip annotate on db:migrate. Defaults to false"
+
+      def add_annotate_gem
+        if gem_installed?("annotate")
+          say "annotate is already in the Gemfile, skipping it ...", :yellow
+        else
+          say "Adding annotate gem", :green
+          gem_content = <<~RUBY
+            \n
+            \tgem "annotate"
+          RUBY
+          insert_into_file "Gemfile", gem_content, after: /group :development do/
+          bundle_install
+        end
+      end
+
+      def configure_annotate
+        say "Configuring annotate", :green
+
+        Bundler.with_unbundled_env do
+          run "bundle exec rails g annotate:install"
+        end
+      end
+
+      def update_auto_annotate_models_rake
+        return unless options[:skip_on_db_migrate]
+
+        say "Setting skip_on_db_migrate to false on file 'lib/tasks/auto_annotate_models.rake'",
+            :green
+
+        gsub_file "lib/tasks/auto_annotate_models.rake",
+                  "'skip_on_db_migrate'          => 'false'",
+                  "'skip_on_db_migrate'          => 'true'"
+      end
+    end
+  end
+end

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

@@ -13,7 +13,7 @@ module Boring
             \n
             \t# Patch-level verification for Bundler. https://github.com/rubysec/bundler-audit
             \tgem "bundler-audit", require: false
-            \t# vulnerabity checker for Ruby itself. https://github.com/civisanalytics/ruby_audit
+            \t# vulnerability checker for Ruby itself. https://github.com/civisanalytics/ruby_audit
             \tgem "ruby_audit", require: false
           RUBY
           insert_into_file "Gemfile", audit_gems_content, after: /group :development do/

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Boring
+  module Avo
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Adds Avo to the application'
+
+      def add_avo_gem
+        say 'Adding Avo gem', :green
+
+        Bundler.with_unbundled_env do
+          run 'bundle add avo'
+        end
+      end
+
+      def configure_avo
+        say 'Setting up Avo', :green
+
+        Bundler.with_unbundled_env do
+          run 'bundle exec rails generate avo:install'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'boring_generators/generator_helper'
+
+module Boring
+  module Cancancan
+    class InstallGenerator < Rails::Generators::Base
+      include BoringGenerators::GeneratorHelper
+
+      desc "Adds cancancan gem to the application"
+
+      class_option :skip_config,
+                   type: :boolean,
+                   default: false,
+                   desc: "Skip adding cancancan configuration. Default to false"
+
+      def add_cancancan_gem
+        say "Adding cancancan gem", :green
+        check_and_install_gem("cancancan")
+        bundle_install
+      end
+
+      def configure_cancancan
+        return if options[:skip_config]
+
+        say "Configuring cancancan", :green
+
+        Bundler.with_unbundled_env do
+          run "bundle exec rails g cancan:ability"
+        end
+      end
+    end
+  end
+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 -%>