boring_generators 0.12.0 → 0.14.0

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

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+module Boring
+  module Rswag
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds rswag gem to the application"
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :rails_port,
+                   type: :string,
+                   desc: "Tell us the port number where you normally run your rails app. Defaults to PORT 3000",
+                   default: "3000"
+      class_option :authentication_type,
+                   type: :string,
+                   desc: "Tell us the authentication type you use in your rails app. Options: ['basic', 'bearer', 'api_key']. Defaults to 'basic'",
+                   default: 'basic'
+      class_option :skip_api_authentication,
+                   type: :boolean,
+                   desc: "Use this option with value 'true' if you don't want to add Authentication when making API calls via swagger docs.",
+                   default: false
+      class_option :api_authentication_options,
+                   type: :hash,
+                   desc: 'Use together with authentication_type. Required for "api_key" authentication which has dynamic set of options. See: https://swagger.io/docs/specification/authentication. Example: "--api_authentication_options=name:api_key in:header"'
+      class_option :enable_swagger_ui_authentication,
+                   type: :boolean,
+                   desc: "Use this option with value 'true' for securing your API docs behind a basic authentication to block unauthorized access",
+                   default: false
+
+      def verify_presence_of_rspec_gem
+        gem_file_content_array = File.readlines("Gemfile")
+
+        rspec_is_installed = gem_file_content_array.any? { |line| line.include?("rspec-rails") }
+
+        return if rspec_is_installed
+
+        say "We couldn't find rspec-rails gem which is a dependency for the rswag gem. Please configure rspec and run the generator again!"
+
+        abort
+      end
+
+      def add_rswag_gems
+        say "Adding rswag gems to Gemfile", :green
+
+        gem 'rswag-api'
+        gem 'rswag-ui'
+        gem 'rswag-specs', group: [:development, :test]
+      end
+
+      def install_rswag
+        say "\nRunning rswag install generator to add required files", :green
+
+        Bundler.with_unbundled_env do
+          run 'bundle install'
+
+          generate 'rswag:api:install'
+          generate 'rswag:ui:install'
+          generate 'rswag:specs:install', [env: 'test']
+        end
+      end
+
+      def update_api_host
+        say "\nUpdating API Host URL", :green
+
+        rails_port = options[:rails_port]
+
+        gsub_file "spec/swagger_helper.rb",
+                  "url: 'https://{defaultHost}'",
+                  "url: 'http://{defaultHost}'"
+        gsub_file "spec/swagger_helper.rb",
+                  "default: 'www.example.com'",
+                  "default: 'localhost:#{rails_port}'"
+      end
+
+      def add_authentication_scheme
+        if options[:skip_api_authentication]
+          return
+        end
+
+        say "\nAdding Authentication for APIs", :green
+
+        authentication_type = options[:authentication_type]
+
+        if authentication_type == 'api_key'
+          validate_api_authentication_options
+
+          authentication_options = options[:api_authentication_options]
+        end
+
+        authentication_content = case authentication_type
+        when 'bearer'
+          <<~RUBY.chomp.indent(0)
+            type: :http,
+            scheme: :bearer
+          RUBY
+        when 'api_key'
+          <<~RUBY
+            type: :apiKey,
+            name: "#{authentication_options['name']}",
+            in: "#{authentication_options['in']}",
+          RUBY
+        else
+          <<~RUBY
+            type: :http,
+            scheme: :basic
+          RUBY
+        end
+
+        gsub_file "spec/swagger_helper.rb",
+                  /servers: \[.*\]/m do |match|
+          configuration_content = <<~RUBY.indent(6)
+          components: {
+            securitySchemes: {
+              authorization: {\n#{authentication_content.chomp.indent(6)}
+              }
+            }
+          },
+          security: [
+            authorization: []
+          ]
+          RUBY
+
+          match << ",\n#{configuration_content.chomp}"
+        end
+      end
+
+      def enable_swagger_ui_authentication
+        return unless options[:enable_swagger_ui_authentication]
+
+        say "\nAdding Basic Authentication to secure the UI", :green
+
+        uncomment_lines 'config/initializers/rswag_ui.rb', /c.basic_auth_enabled/
+        uncomment_lines 'config/initializers/rswag_ui.rb', /c.basic_auth_credentials/
+        gsub_file "config/initializers/rswag_ui.rb",
+                  "c.basic_auth_credentials 'username', 'password'",
+                  'c.basic_auth_credentials Rails.application.credentials.dig(:swagger_ui, :username), Rails.application.credentials.dig(:swagger_ui, :password)'
+
+        say "❗️❗️\nusername will be used from `Rails.application.credentials.dig(:swagger_ui, :username)` and password from `Rails.application.credentials.dig(:swagger_ui, :password)`. You can change these values if they don't match with your app.\n", :yellow
+      end
+
+      def show_readme
+        readme "README"
+      end
+
+      private
+
+      def validate_api_authentication_options
+        api_authentication_options = options[:api_authentication_options]
+
+        if api_authentication_options.blank?
+          say "api_authentication_options args should be provided for api_key authentication", :red
+
+          abort
+        end
+
+        missing_options = %w[name in] - api_authentication_options.keys
+
+        if missing_options.length.positive?
+          say "Option/s '#{missing_options.join(', ')}' should be present for api_key authentication!", :red
+          say 'Example of valid options: "--api_authentication_options=name:api_key in:query"', :yellow
+
+          abort
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+===============================================================================
+
+To get up and running with rswag you can do the following next:
+
+1. Write a rswag spec by following instructions from Getting Started guide at https://github.com/rswag/rswag#getting-started
+2. Once the spec is ready, generate the swagger file with `rails rswag`
+3. Run the rails server with `rails s`
+4. Assuming your app is at "localhost:3000", you will find your API docs at `http://localhost:3000/api-docs/index.html`
+
+===============================================================================

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Boring
+  module Sentry
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+      desc 'Adds Sentry to the app'
+
+      class_option :use_env_variable, type: :boolean, aliases: '-ev',
+                   desc: 'Use ENV variable for Sentry. By default Rails credentials will be used.' 
+      class_option :breadcrumbs_logger, type: :array, aliases: '-bl', default: [:active_support_logger, :http_logger],
+                   desc: 'Set the breadcrumbs logger. By default [:active_support_logger, :http_logger] will be used.'
+
+      def add_sentry_gems
+        say 'Adding Sentry gem', :green
+
+        Bundler.with_unbundled_env do
+          run 'bundle add sentry-ruby sentry-rails'
+        end
+      end
+
+      def configure_sentry_gem
+        say 'Configuring Sentry gem', :green
+
+        @sentry_dsn_key = sentry_dsn_key
+        @breadcrumbs_logger_options = options[:breadcrumbs_logger].map(&:to_sym)
+
+        template 'sentry.rb', 'config/initializers/sentry.rb'
+
+        show_alert_message
+      end
+
+      private
+
+      def sentry_dsn_key
+        if options[:use_env_variable]
+          "ENV['SENTRY_DSN_KEY']"
+        else
+          "Rails.application.credentials.dig(:sentry, :dsn_key)"
+        end
+      end
+
+      def show_alert_message
+        say "❗️❗️\nThe DSN key for Sentry will be used from `#{sentry_dsn_key}`. You can change this value if it doesn't match with your app.\n", :yellow
+      end
+    end
+  end
+end

data/lib/generators/boring/sentry/install/templates/sentry.rb

@@ -0,0 +1,7 @@
+Sentry.init do |config|
+  config.dsn = <%= @sentry_dsn_key %>
+  # enable performance monitoring
+  config.enable_tracing = true
+  # get breadcrumbs from logs
+  config.breadcrumbs_logger = <%= @breadcrumbs_logger_options %>
+end

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

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+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__)
+
+      class_option :testing_framework,
+                   type: :string,
+                   alias: "-tf",
+                   default: "minitest",
+                   enum: %w[rspec minitest],
+                   desc:
+                     "Tell us which test framework you are using. Defaults to minitest"
+
+      class_option :stubbing_libraries,
+                   type: :array,
+                   alias: "-sl",
+                   default: ["webmock"],
+                   enum: %w[webmock typhoeus faraday excon],
+                   desc:
+                     "Tell us stubbing library you want to use separated by space. Defaults to webmock"
+
+      def verify_presence_of_test_helper
+        return if rspec? || (minitest? && File.exist?("test/test_helper.rb"))
+
+        say "We couldn't find test/test_helper.rb. Please configure Minitest and rerun the generator.",
+            :red
+
+        abort
+      end
+
+      def verify_presence_of_rails_helper
+        return if minitest? || (rspec? && File.exist?("spec/rails_helper.rb"))
+
+        say "We couldn't find spec/rails_helper.rb. Please configure RSpec and rerun the generator. Consider running `rails generate boring:rspec:install` to set up RSpec.",
+            :red
+
+        abort
+      end
+
+      def add_vcr_gem
+        say "Adding VCR gems to Gemfile", :green
+        
+        check_and_install_gem "vcr", group: :test
+      end
+
+      def add_stubbing_library_gems
+        say "Adding stubbing library gems to Gemfile", :green
+
+        options[:stubbing_libraries].uniq.each do |stubbing_library|
+          check_and_install_gem stubbing_library, group: :test
+        end
+      end
+
+      def setup_vcr_for_rspec
+        return unless rspec?
+
+        say "Setting up VCR for RSpec", :green
+
+        @stubbing_libraries = format_stubbing_libraries
+
+        template("rspec/vcr.rb", "spec/support/vcr.rb")
+
+        unless all_support_files_are_required?
+          inject_into_file "spec/rails_helper.rb",
+                           "require 'support/vcr'\n\n",
+                           before: /\A/
+        end
+      end
+
+      def setup_vcr_for_minitest
+        return unless minitest?
+
+        say "Setting up VCR for Minitest", :green
+
+        vcr_config = <<~RUBY
+          require "vcr"
+
+          VCR.configure do |c|
+            c.cassette_library_dir = "test/vcr"
+            c.hook_into #{format_stubbing_libraries}
+            c.ignore_localhost = true
+          end
+        RUBY
+
+        inject_into_file "test/test_helper.rb", vcr_config, end: /^end\s*\Z/m
+      end
+
+      private
+
+      def format_stubbing_libraries
+        options[:stubbing_libraries]
+          .map { |stubbing_library| ":#{stubbing_library}" }
+          .join(", ")
+      end
+
+      def rspec?
+        options[:testing_framework].to_s == "rspec"
+      end
+
+      def minitest?
+        options[:testing_framework].to_s == "minitest"
+      end
+
+      def all_support_files_are_required?
+        line_to_check =
+          "Rails.root.glob('spec/support/**/*.rb').sort.each { |f| require f }"
+        rails_file_content_array = File.readlines("spec/rails_helper.rb")
+        rails_file_content_array.any? do |line|
+          line !~ /^\s*#/ &&
+            (
+              line.include?(line_to_check) ||
+                line.include?(line_to_check.gsub("'", '"'))
+            )
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'boring_generators/generator_helper'
+
+module Boring
+  module Webmock
+    class InstallGenerator < Rails::Generators::Base
+      include BoringGenerators::GeneratorHelper
+      
+      desc "Adds webmock gem to the application"
+
+      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
+      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}",
+                   default: "minitest"
+
+      def verify_test_framework_configurations
+        app_test_framework = options[:app_test_framework]
+
+        if app_test_framework.blank?
+          say <<~WARNING, :red
+           ERROR: Unsupported test framework: #{app_test_framework}
+          WARNING
+
+          abort
+        else
+          verify_presence_of_test_framework
+        end
+      end
+
+      def add_webmock_gem
+        say "Adding webmock gem", :green
+
+        check_and_install_gem "webmock", group: :test
+      end
+
+      def configure_webmock
+        app_test_framework = options[:app_test_framework]
+
+        say "Configuring webmock", :green
+
+        if app_test_framework == "minitest"
+          configure_minitest
+        else
+          configure_rspec
+        end
+      end
+
+      private
+
+      def verify_presence_of_test_framework
+        app_test_framework = options[:app_test_framework]
+        test_framework_folder = { minitest: "test", rspec: "spec" }.dig(app_test_framework.to_sym) || ''
+
+        test_folder_is_present = Dir.exist?(test_framework_folder) && Dir.entries(test_framework_folder).length.positive?
+
+        return if test_folder_is_present
+
+        say "We couldn't find #{test_framework_folder} in your project. Please make sure #{app_test_framework} is configured correctly and run the generator again!", :red
+
+        abort
+      end
+
+      def configure_minitest
+        inject_into_file 'test/test_helper.rb',
+                          before: /\n(class|module) ActiveSupport/ do
+                            <<~RUBY
+                              \nrequire 'webmock/minitest'
+                              WebMock.disable_net_connect!(allow_localhost: true)
+                            RUBY
+                          end
+      end
+
+      def configure_rspec
+        inject_into_file "spec/spec_helper.rb",
+                          "require 'webmock/rspec'\n\n",
+                          before: /\A/
+        inject_into_file "spec/spec_helper.rb",
+                          "\tWebMock.disable_net_connect!(allow_localhost: true)\n\n",
+                          after: "RSpec.configure do |config|\n"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Boring
+  module Whenever
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds whenever gem to the application for managing cron jobs"
+
+      def add_whenever_gem
+        say "Adding whenever gem", :green
+
+        Bundler.with_unbundled_env do
+          run "bundle add whenever"
+        end
+      end
+
+      def add_schedule_file
+          say "Create schedule.rb file", :green
+
+          Bundler.with_unbundled_env do
+            run "bundle exec wheneverize ."
+          end
+      end
+    end
+  end
+end

data/tmp/templates/app_template/.ruby-version

@@ -1 +1 @@
-2.7.0
+2.7.3

data/tmp/templates/app_template/Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
-ruby '2.7.0'
+ruby '2.7.3'
 
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
 gem 'rails', '~> 6.0.3', '>= 6.0.3.2'

data/tmp/templates/app_template/config/boot.rb

@@ -1 +1 @@
-require "rails/all"
+require "bundler/setup" # Set up gems listed in the Gemfile.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boring_generators
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Abhay Nikam
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-08 00:00:00.000000000 Z
+date: 2024-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -53,17 +53,21 @@ files:
 - exe/boring
 - lib/boring_generators.rb
 - lib/boring_generators/cli.rb
+- lib/boring_generators/generator_helper.rb
 - lib/boring_generators/version.rb
 - lib/generators/boring/active_storage/aws/install/install_generator.rb
 - lib/generators/boring/active_storage/azure/install/install_generator.rb
 - lib/generators/boring/active_storage/google/install/install_generator.rb
 - lib/generators/boring/ahoy/install/install_generator.rb
 - lib/generators/boring/ahoy/install/templates/README
+- lib/generators/boring/annotate/install/install_generator.rb
 - lib/generators/boring/audit/install/install_generator.rb
+- lib/generators/boring/avo/install/install_generator.rb
 - lib/generators/boring/bootstrap/install/install_generator.rb
 - lib/generators/boring/bootstrap/install/templates/application.scss
 - lib/generators/boring/bullet/install/install_generator.rb
 - lib/generators/boring/bullet/install/templates/bullet.rb
+- lib/generators/boring/cancancan/install/install_generator.rb
 - lib/generators/boring/ci/circleci/install/install_generator.rb
 - lib/generators/boring/ci/circleci/install/templates/config.psql.yml.tt
 - lib/generators/boring/ci/circleci/install/templates/config.sql.yml.tt
@@ -72,12 +76,16 @@ files:
 - lib/generators/boring/ci/github_action/install/templates/ci.yml.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
 - lib/generators/boring/devise/install/install_generator.rb
+- lib/generators/boring/dotenv/install/install_generator.rb
+- lib/generators/boring/dotenv/install/templates/.env
 - lib/generators/boring/factory_bot/install/install_generator.rb
 - lib/generators/boring/factory_bot/install/templates/users.rb
 - lib/generators/boring/faker/install/install_generator.rb
 - lib/generators/boring/favicon/build/build_generator.rb
 - lib/generators/boring/favicon/build/templates/favicon.html.erb.tt
+- lib/generators/boring/figjam/install/install_generator.rb
 - lib/generators/boring/flipper/install/install_generator.rb
 - lib/generators/boring/flipper/install/templates/initializer.rb.tt
 - lib/generators/boring/font_awesome/ruby_gem/install/install_generator.rb
@@ -86,7 +94,11 @@ files:
 - lib/generators/boring/graphql/install/install_generator.rb
 - lib/generators/boring/graphql/install/templates/base_resolver.rb
 - lib/generators/boring/graphql/install/templates/hello_world_resolver.rb
+- lib/generators/boring/honeybadger/install/install_generator.rb
+- lib/generators/boring/honeybadger/install/templates/README
+- lib/generators/boring/honeybadger/install/templates/honeybadger.yml.tt
 - lib/generators/boring/jquery/install/install_generator.rb
+- lib/generators/boring/letter_opener/install/install_generator.rb
 - lib/generators/boring/oauth/base_generator.rb
 - lib/generators/boring/oauth/facebook/install/install_generator.rb
 - lib/generators/boring/oauth/facebook/install/templates/README
@@ -110,13 +122,25 @@ files:
 - lib/generators/boring/payments/stripe/install/templates/stripe.rb
 - lib/generators/boring/payments/stripe/install/templates/views/stripe/checkouts/create.js.erb
 - lib/generators/boring/payments/stripe/install/templates/views/stripe/checkouts/show.html.erb
+- lib/generators/boring/pronto/base_generator.rb
+- lib/generators/boring/pronto/github_action/install/install_generator.rb
+- lib/generators/boring/pronto/github_action/install/templates/pronto.yml.tt
+- lib/generators/boring/pronto/gitlab_ci/install/install_generator.rb
+- lib/generators/boring/pronto/gitlab_ci/install/templates/.gitlab-ci.yml.tt
+- lib/generators/boring/pronto/gitlab_ci/install/templates/README
 - lib/generators/boring/pry/install/install_generator.rb
 - lib/generators/boring/pry/install/templates/pryrc
 - lib/generators/boring/pundit/install/install_generator.rb
+- lib/generators/boring/rack_mini_profiler/install/install_generator.rb
 - lib/generators/boring/rails_admin/install/install_generator.rb
+- lib/generators/boring/rails_erd/install/install_generator.rb
 - lib/generators/boring/rspec/install/install_generator.rb
+- lib/generators/boring/rswag/install/install_generator.rb
+- lib/generators/boring/rswag/install/templates/README
 - lib/generators/boring/rubocop/install/install_generator.rb
 - lib/generators/boring/rubocop/install/templates/.rubocop.yml.tt
+- lib/generators/boring/sentry/install/install_generator.rb
+- lib/generators/boring/sentry/install/templates/sentry.rb
 - lib/generators/boring/simple_form/install/install_generator.rb
 - lib/generators/boring/stimulus/install/install_generator.rb
 - lib/generators/boring/tailwind/install/install_generator.rb
@@ -125,6 +149,10 @@ files:
 - lib/generators/boring/twilio/install/install_generator.rb
 - lib/generators/boring/twilio/install/templates/README
 - lib/generators/boring/twilio/install/templates/twilio.rb
+- lib/generators/boring/vcr/install/install_generator.rb
+- lib/generators/boring/vcr/install/templates/rspec/vcr.rb.tt
+- lib/generators/boring/webmock/install/install_generator.rb
+- lib/generators/boring/whenever/install/install_generator.rb
 - tmp/templates/app_template/.ruby-version
 - tmp/templates/app_template/Gemfile
 - tmp/templates/app_template/README.md