boring_generators 0.13.0 → 0.15.0

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

@@ -8,9 +8,9 @@ module Boring
       def add_letter_opener_gem
         say "Adding letter_opener gem", :green
 
-        gem_content = <<~RUBY
-          \t# Preview email in the default browser instead of sending it to real mailbox
-          \tgem "letter_opener"
+        gem_content = <<~RUBY.indent(2)
+          \n# Preview email in the default browser instead of sending it to real mailbox
+          gem "letter_opener"
         RUBY
 
         insert_into_file "Gemfile", gem_content, after: /group :development do/
@@ -23,16 +23,15 @@ module Boring
       def configure_letter_opener
         say "Configuring letter_opener", :green
 
-        configuration_content = <<~RUBY.chomp
-          \n\t# Preview email in the browser instead of sending it
-          \tconfig.action_mailer.delivery_method = :letter_opener
-          \tconfig.action_mailer.perform_deliveries = true
-          end
+        configuration_content = <<~RUBY.chomp.indent(2)
+          \n# Preview email in the browser instead of sending it
+          config.action_mailer.delivery_method = :letter_opener
+          config.action_mailer.perform_deliveries = true
         RUBY
 
         gsub_file "config/environments/development.rb",
                   /end\Z/,
-                  configuration_content
+                  "#{configuration_content}\nend"
       end
     end
   end

data/lib/generators/boring/oauth/google/install/install_generator.rb

@@ -14,8 +14,8 @@ module Boring
         desc "Adds Google OmniAuth to the application"
         source_root File.expand_path("templates", __dir__)
 
-        def add_github_omniauth_gem
-          say "Adding GitHub OmniAuth gem", :green
+        def add_google_omniauth_gem
+          say "Adding Google OmniAuth gem", :green
           Bundler.with_unbundled_env do
             run "bundle add omniauth-google-oauth2"
           end

data/lib/generators/boring/pronto/base_generator.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "boring_generators/generator_helper"
+
+module Boring
+  module Pronto
+    class BaseGenerator < Rails::Generators::Base
+      desc "Adds Pronto gem with various extensions"
+
+      class_option :skip_extensions,
+                   type: :array,
+                   aliases: "-se",
+                   desc:
+                     "List of extensions to skip. Available options: brakeman, flay, reek, rubocop",
+                   enum: %w[brakeman flay reek rubocop],
+                   default: []
+
+      include BoringGenerators::GeneratorHelper
+
+      def add_pronto_gems
+        say "Adding pronto gems", :green
+
+        gem_content = <<~RUBY.strip
+          #{pronto_gem_content}
+          #{pronto_brakemen_gem_content}
+          #{pronto_flay_gem_content}
+          #{pronto_reek_gem_content}
+          #{pronto_rubocop_gem_content}
+        RUBY
+
+        return if gem_content.blank?
+
+        insert_into_file "Gemfile", "\n#{gem_content}\n"
+
+        Bundler.with_unbundled_env { run "bundle install" }
+      end
+
+      private
+
+      def pronto_gem_content
+        return if gem_installed?("pronto")
+
+        <<~RUBY.strip
+          # Pronto is a code linter runner that can be used with git and GitHub pull requests
+          gem "pronto"
+        RUBY
+      end
+
+      def pronto_brakemen_gem_content
+        return if options[:skip_extensions].include?("brakeman")
+        return if gem_installed?("pronto-brakeman")
+
+        "gem \"pronto-brakeman\", require: false"
+      end
+
+      def pronto_flay_gem_content
+        return if options[:skip_extensions].include?("flay")
+        return if gem_installed?("pronto-flay")
+
+        "gem \"pronto-flay\", require: false"
+      end
+
+      def pronto_reek_gem_content
+        return if options[:skip_extensions].include?("reek")
+        return if gem_installed?("pronto-reek")
+
+        "gem \"pronto-reek\", require: false"
+      end
+
+      def pronto_rubocop_gem_content
+        return if options[:skip_extensions].include?("rubocop")
+        return if gem_installed?("pronto-rubocop")
+
+        "gem \"pronto-rubocop\", require: false"
+      end
+    end
+  end
+end

data/lib/generators/boring/pronto/github_action/install/install_generator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "generators/boring/pronto/base_generator"
+require "boring_generators/generator_helper"
+
+module Boring
+  module Pronto
+    module GithubAction
+      class InstallGenerator < Boring::Pronto::BaseGenerator
+        desc "Adds Pronto configurations to Github Action"
+        source_root File.expand_path("templates", __dir__)
+
+        class_option :ruby_version, type: :string, aliases: "-rv"
+
+        include BoringGenerators::GeneratorHelper
+
+        def add_pronto_configuration_for_github_action
+          say "Adding Pronto configurations to .github/workflows/pronto.yml", :green
+
+          @ruby_version = options.ruby_version || app_ruby_version
+          
+          template("pronto.yml", ".github/workflows/pronto.yml")
+        end
+      end
+    end
+  end
+end

data/lib/generators/boring/pronto/github_action/install/templates/pronto.yml.tt

@@ -0,0 +1,53 @@
+on: [pull_request]
+
+name: Pronto
+
+jobs:
+  pronto:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+      statuses: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: <%= @ruby_version %>
+      - name: Ruby gem cache
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-
+      - name: Install gems
+        run: |
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      - name: Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: 10.13.0
+      - name: Find yarn cache location
+        id: yarn-cache
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+      - name: JS package cache
+        uses: actions/cache@v1
+        with:
+          path: ${{ steps.yarn-cache.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+      - name: Install packages
+        run: |
+          yarn install --pure-lockfile
+      - name: Run Pronto
+        run: |
+          PRONTO_PULL_REQUEST_ID="${{ github.event.pull_request.number }}" PRONTO_GITHUB_ACCESS_TOKEN="${{ github.token }}" bundle exec pronto run -f github_status github_pr -c origin/${{ github.base_ref }}

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

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require "generators/boring/pronto/base_generator"
+require "boring_generators/generator_helper"
+
+module Boring
+  module Pronto
+    module GitlabCi
+      class InstallGenerator < Boring::Pronto::BaseGenerator
+        desc "Adds Pronto gem with various extensions and configures it for Gitlab CI"
+        source_root File.expand_path("templates", __dir__)
+
+        class_option :ruby_version, type: :string, aliases: "-rv"
+
+        include BoringGenerators::GeneratorHelper
+
+        def add_configuration
+          @ruby_version = options.ruby_version || app_ruby_version
+
+          if File.exist?(".gitlab-ci.yml")
+            add_pronto_configuration
+            add_lint_stage
+            show_readme
+          else
+            create_gitlab_ci_with_pronto
+          end
+        end
+
+        private
+
+        def create_gitlab_ci_with_pronto
+          say "Creating .gitlab-ci.yml with Pronto configurations", :yellow
+          template ".gitlab-ci.yml", ".gitlab-ci.yml"
+        end
+
+        def add_pronto_configuration
+          return if pronto_configuration_exists?
+
+          say "Adding Pronto configurations to .gitlab-ci.yml", :green
+          inject_into_file ".gitlab-ci.yml", pronto_ci_content, before: /\Z/
+        end
+
+        def add_lint_stage
+          return if lint_stage_exists?
+
+          if stages_exists?
+            inject_into_file ".gitlab-ci.yml",
+                             optimize_indentation("\n- lint", 2).chomp,
+                             after: /stages:/
+          else
+            inject_into_file ".gitlab-ci.yml",
+                             stages_configuration,
+                             before: /pronto:/
+          end
+        end
+
+        def show_readme
+          readme "README"
+        end
+
+        def pronto_configuration_exists?
+          gitlab_ci_file_content["pronto"]
+        end
+
+        def lint_stage_exists?
+          gitlab_ci_file_content["stages"] &&
+            gitlab_ci_file_content["stages"].include?("lint")
+        end
+
+        def stages_exists?
+          gitlab_ci_file_content["stages"]
+        end
+
+        def gitlab_ci_file_content
+          @gitlab_ci_file_content ||=
+            YAML.safe_load(File.open(".gitlab-ci.yml"), aliases: true) || {}
+        end
+
+        def pronto_ci_content
+          <<~RUBY
+              pronto:
+                image: ruby:#{@ruby_version}
+                stage: lint
+                only:
+                  # run pronto on merge requests and when new changes are pushed to it
+                  - merge_requests
+                variables:
+                  PRONTO_GITLAB_API_PRIVATE_TOKEN: $PRONTO_ACCESS_TOKEN
+                before_script:
+                    # Install cmake required for rugged gem (Pronto depends on it)
+                    - apt-get update && apt-get install -y cmake
+                    # use bundler version same as the one that bundled the Gemfile
+                    - gem install bundler -v "$(grep -A 1 "BUNDLED WITH" Gemfile.lock | tail -n 1)" --no-document
+                    - bundle install --jobs $(nproc)
+                script:
+                  # Pronto fails with the error "revspec 'origin/{target_branch}' because Gitlab fetches changes with git depth set to 20 by default. You can remove this line if you update Gitlab CI setting to clone the full project.
+                  - git fetch origin $CI_MERGE_REQUEST_TARGET_BRANCH_NAME
+                  # Run pronto on branch of current merge request
+                  - bundle exec pronto run -f gitlab_mr -c origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME
+            RUBY
+        end
+
+        def stages_configuration
+          <<~RUBY
+              stages:
+                - lint
+            RUBY
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+stages:
+  - lint
+
+pronto:
+  image: ruby:<%= @ruby_version %>
+  stage: lint
+  only:
+    # run pronto on merge requests and when new changes are pushed to it
+    - merge_requests
+  variables:
+    PRONTO_GITLAB_API_PRIVATE_TOKEN: $PRONTO_ACCESS_TOKEN
+  before_script:
+    # Install cmake required for rugged gem (Pronto depends on it)
+    - apt-get update && apt-get install -y cmake
+    # use bundler version same as the one that bundled the Gemfile
+    - gem install bundler -v "$(grep -A 1 "BUNDLED WITH" Gemfile.lock | tail -n 1)" --no-document
+    - bundle install --jobs $(nproc)
+  script:
+    # Pronto fails with the error "revspec 'origin/{target_branch}' because Gitlab fetches changes with git depth set to 20 by default. You can remove this line if you update Gitlab CI setting to clone the full project.
+    - git fetch origin $CI_MERGE_REQUEST_TARGET_BRANCH_NAME
+    # Run pronto on branch of current merge request
+    - bundle exec pronto run -f gitlab_mr -c origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME

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

@@ -0,0 +1,7 @@
+
+===============================================================================
+
+❗️❗️
+Pronto needs your Private Gitlab API token for posting comments in the merge request. It is configured as "PRONTO_ACCESS_TOKEN" inside .gitlab-ci.yml, don't forget to configure this variable in your Gitlab Project settings before pushing your new changes to git.
+
+===============================================================================

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'boring_generators/generator_helper'
+
+module Boring
+  module RackMiniProfiler
+    class InstallGenerator < Rails::Generators::Base
+      include BoringGenerators::GeneratorHelper
+      
+      desc "Adds rack-mini-profiler to the application"
+
+      def add_rack_mini_profiler_gem
+        say "Adding rack-mini-profiler gem", :green
+        
+        return if gem_installed?("rack-mini-profiler")
+
+        rack_mini_profiler_gems_content = <<~RUBY
+        \t# Profiler for your Rails application
+        \tgem 'rack-mini-profiler', require: false\n
+        RUBY
+
+        insert_into_file "Gemfile",
+                         rack_mini_profiler_gems_content,
+                         after: /group :development do\n/
+
+        Bundler.with_unbundled_env { run "bundle install" }
+      end
+
+      def configure_rack_mini_profiler
+        say "Configuring rack mini profiler", :green
+
+        Bundler.with_unbundled_env do
+          run "bundle exec rails g rack_mini_profiler:install"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'boring_generators/generator_helper'
+
+module Boring
+  module RailsErd
+    class InstallGenerator < Rails::Generators::Base
+      include BoringGenerators::GeneratorHelper
+
+      desc 'Adds rails-erd gem to the  app for generating ERD diagrams'
+
+      def add_rails_erd_gem
+        if gem_installed?("rails-erd")
+          say "rails-erd is already in the Gemfile, skipping it ...", :yellow
+        else
+          say "Adding rails-erd gem", :green
+          gem_content = <<~RUBY
+            \n
+            \tgem "rails-erd"
+          RUBY
+          insert_into_file "Gemfile", gem_content, after: /group :development do/
+          bundle_install
+        end
+      end
+
+      def configure_rails_erd_gem
+        say 'Configuring rails-erd gem', :green
+
+        Bundler.with_unbundled_env do
+          run 'bundle exec rails g erd:install'
+        end
+      end
+    end
+  end
+end

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

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

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,126 @@
+# 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_cassettes"
+            c.hook_into #{format_stubbing_libraries}
+            c.ignore_localhost = true
+            c.allow_http_connections_when_no_cassette = 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,9 @@
+require "vcr"
+
+VCR.configure do |c|
+  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

@@ -1,12 +1,17 @@
 # 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
+      # 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}",
@@ -29,11 +34,7 @@ module Boring
       def add_webmock_gem
         say "Adding webmock gem", :green
 
-        gem "webmock"
-
-        Bundler.with_unbundled_env do
-          run "bundle install"
-        end
+        check_and_install_gem "webmock", group: :test
       end
 
       def configure_webmock