boring_generators 0.11.0 → 0.13.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/rubocop/install/install_generator.rb

@@ -9,20 +9,24 @@ module Boring
       DEFAULT_RUBY_VERSION = "2.7.1"
 
       class_option :skip_adding_rubocop_rules, type: :boolean, aliases: "-s",
-                                               desc: "Skip adding rubocop rules and add empty file."
-      class_option :ruby_version,              type: :string, aliases: "-v",
-                                               desc: "Tell us the ruby version which you use for the application. Default to Ruby #{DEFAULT_RUBY_VERSION}"
+                   desc: "Skip adding rubocop rules and add empty file."
+      class_option :ruby_version, type: :string, aliases: "-v",
+                   desc: "Tell us the ruby version which you use for the application. Default to Ruby #{DEFAULT_RUBY_VERSION}", default: DEFAULT_RUBY_VERSION
+      class_option :test_gem, type: :string,
+                   desc: "Tell us the framework you use for writing tests in your application. Supported options are ['rspec', 'minitest']"
 
       def add_rubocop_gems
         say "Adding rubocop gems", :green
-        bullet_gem_content = <<~RUBY
+        rubocop_gem_content = <<~RUBY
           \n
           \t# A Ruby static code analyzer, based on the community Ruby style guide
           \tgem "rubocop",  require: false
           \tgem "rubocop-rails",  require: false
           \tgem "rubocop-performance", require: false
+          \tgem "rubocop-rake", require: false
+          #{rubocop_test_gem_content}
         RUBY
-        insert_into_file "Gemfile", bullet_gem_content, after: /group :development do/
+        insert_into_file "Gemfile", rubocop_gem_content, after: /group :development do/
         Bundler.with_unbundled_env do
           run "bundle install"
         end
@@ -31,9 +35,31 @@ module Boring
       def add_rails_prefered_rubocop_rules
         say "Adding rubocop style guides", :green
         @skip_adding_rules = options[:skip_adding_rubocop_rules]
-        @target_ruby_version = options[:ruby_version] ? options[:ruby_version] : DEFAULT_RUBY_VERSION
+        @target_ruby_version = options[:ruby_version]
         template(".rubocop.yml", ".rubocop.yml")
       end
+
+      private
+
+      def rubocop_test_gem_content
+        test_gem = options[:test_gem]
+
+        return if test_gem.blank?
+
+        if %w[rspec minitest].exclude?(test_gem)
+          raise(NotImplementedError, "#{test_gem} is not supported as a test_gem option! Supported options are ['rspec', 'minitest']")
+        end
+
+        if test_gem.eql?('rspec')
+          @test_gem_extension = 'rubocop-rspec'
+
+          "\tgem \"rubocop-rspec\", require: false"
+        else
+          @test_gem_extension = 'rubocop-minitest'
+
+          "\tgem \"rubocop-minitest\", require: false"
+        end
+      end
     end
   end
 end

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

@@ -1,8 +1,12 @@
 require:
   - rubocop-performance
   - rubocop-rails
+  - rubocop-rake
+<%- if @test_gem_extension -%>
+  - <%= @test_gem_extension %>
+<%- end -%>
 
-<%- unless @skip_adding_rules %>
+<%- unless @skip_adding_rules -%>
 AllCops:
   TargetRubyVersion: <%= @target_ruby_version %>
   # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
@@ -258,5 +262,4 @@ Performance/DeletePrefix:
 
 Performance/DeleteSuffix:
   Enabled: true
-  
-<% end %>
+<%- end -%>

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+module Boring
+  module Webmock
+    class InstallGenerator < Rails::Generators::Base
+      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
+
+        gem "webmock"
+
+        Bundler.with_unbundled_env do
+          run "bundle install"
+        end
+      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.