boring_generators 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee57d89d7ab8e0ffa351d54ae30a52a5d8adeb1a2fdfd7c99910be78599c104e
-  data.tar.gz: 759e5b5f00ec406743075950bdb5637274c1364d9f74674b92408dc49aa7c193
+  metadata.gz: e3e2cf89c148c10914b919c1f9be41275681aa3ba8eaed7a22df5beb6adbef55
+  data.tar.gz: '083314c373aeb284b779aba16629fa36cbbeb9f60521161d0f1de081b7c1f99a'
 SHA512:
-  metadata.gz: db02ff1b7c2503b3cbc61a525d8c22557ea703c50821a7c62de5a807d0d9778aaaca9bfc816884576c593d076a681c7d14aa4f185034c740da41596be5f61df7
-  data.tar.gz: 935f71b5e4ed6ba413698addf56884b473458966a4350fbb071fa2667d4c99240d9ead01936236a585b2e70bace03cdab94b85212bdeb3e0e95d9e70e8b75602
+  metadata.gz: a2f943d1a4fdda23f2a1905a3491f11e5aa8adde05371b24f91c20daa3dc7355a4d1a51e9d82243b642c2ddb5e738a5885369b034c79e87f801078186cf645b5
+  data.tar.gz: 4b1f672d170a27bd8782e423b228a45974ad5c6a2e8262adbfe91a109cc29b10f449d20176c8113201db119363fa3b035ce7707a71365ecfb391ee1a18a77cb8

data/.github/workflows/ci.yml

@@ -10,11 +10,11 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7.0
+          ruby-version: 2.7.3
           bundler-cache: true
       - name: Install Imagemagick
         run: |
-          wget https://raw.githubusercontent.com/discourse/discourse_docker/master/image/base/install-imagemagick
+          wget https://raw.githubusercontent.com/discourse/discourse_docker/main/image/base/install-imagemagick
           chmod +x install-imagemagick
           sudo ./install-imagemagick
       - name: Install gems

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '41 1 * * 3'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript', 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

data/.gitignore

@@ -8,3 +8,6 @@
 /tmp/
 /log/
 .byebug_history
+
+*.log
+.idea

data/CHANGELOG.md

@@ -2,11 +2,26 @@
 
 ## master (unreleased)
 
+## 0.13.0 (March 26th, 2024)
+* 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][])
+
 ## 0.11.0 (June 23rd, 2021)
 * Adds Stimulus generator. ([@abhaynikam][])
 * Adds Rails Admin generator. ([@abhaynikam][])
 * Adds Paper Trail generator. ([@abhaynikam][])
-* Update default node-version for GitHub Action generator and fixes PG setup issues. ([@abhaynikam][])
 
 ## 0.10.0 (May 26th, 2021)
 * Updates Stripe payment generator. ([@abhaynikam][])
@@ -67,3 +82,5 @@
 [@CiTroNaK]: https://github.com/CiTroNaK
 [@jamesglover]: https://github.com/JamesGlover
 [@luathn]: https://github.com/luathn
+[@coolprobn]: https://github.com/coolprobn
+[@aadil]: https://github.com/AdilRT

data/CONTRIBUTING.md

@@ -18,3 +18,20 @@ Push to your fork. Write a [good commit message][commit]. Submit a pull request.
 
 Please do not self reject your thoughts. Let's discuss even smallest feature request as well and make
 this package better for everybody's use.
+
+## Notes for Local Development of the Gem
+
+### While running Tests
+
+When running tests, we normally do `bundle exec ruby -w -I test test/generators/rswag_install_generator_test.rb` to run a single test where "rswag_install_generator_test.rb" is the file name of the test we want to run.
+
+And if your global ruby version is not the same as the "tmp/templates/app_template" where we run tests and make changes, tests might fail due to mismatch of ruby version and required gems not being installed correctly.
+
+To tackle this issue you can add `.ruby-version` to the gem root by specifying the ruby version app_template is using. If you use rbenv this can be done with `rbenv local 2.7.0` where "2.7.0" is the app_template ruby-version at the moment.
+
+We shouldn't commit this ".ruby-version" file to git since it's only intended for running tests. So to ignore this file from the git just for you, you can do the following:
+
+- Open the git exclude file `nano .git/info/exclude`
+- Add the file name ".ruby-version" to the end of the file and save it.
+
+Now .ruby-version will be ignored by the git in your local machine just for this project.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    boring_generators (0.10.0)
+    boring_generators (0.12.0)
       railties
 
 GEM
@@ -71,7 +71,7 @@ GEM
       activesupport (>= 4.2.0)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    loofah (2.9.1)
+    loofah (2.20.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -79,14 +79,12 @@ GEM
     marcel (1.0.1)
     method_source (1.0.0)
     mini_mime (1.1.0)
-    mini_portile2 (2.5.0)
+    mini_portile2 (2.4.0)
     minitest (5.14.4)
     nio4r (2.5.7)
-    nokogiri (1.11.3)
-      mini_portile2 (~> 2.5.0)
-      racc (~> 1.4)
-    racc (1.5.2)
-    rack (2.2.3)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    rack (2.2.6.4)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails (6.0.3.6)
@@ -107,8 +105,8 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
-      loofah (~> 2.3)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
     railties (6.0.3.6)
       actionpack (= 6.0.3.6)
       activesupport (= 6.0.3.6)
@@ -126,7 +124,7 @@ GEM
     sqlite3 (1.4.2)
     thor (1.1.0)
     thread_safe (0.3.6)
-    tzinfo (1.2.9)
+    tzinfo (1.2.10)
       thread_safe (~> 0.1)
     websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)

data/README.md

@@ -37,9 +37,14 @@ And then you can use it this way:
     $ boring generate boring:simple_form:install --css_framework=<css_framework>
     $ boring g boring:pry:install
 
+To see options provided by each generator with their descriptions and accepted values, you can hit the following command for example:
+
+    $ boring generate boring:simple_form:install --help
+
 ## Usage
 
 The boring generator introduces following generators:
+
 - [Install Tailwind CSS](https://www.boringgenerators.com/blog/2020-10-18-install-tailwind/): `rails generate boring:tailwind:install`
 - [Install Bootstrap](https://www.boringgenerators.com/blog/2020-11-15-install-bootstrap/): `rails generate boring:bootstrap:install`
 - Install JQuery: `rails generate boring:jquery:install`
@@ -54,7 +59,7 @@ The boring generator introduces following generators:
 - [Install CircleCI](https://www.boringgenerators.com/blog/2021-01-02-configure-circleci/): `rails generate boring:ci:circleci:install --repository_name=<name> --ruby_version=<version>`
 - [Install GitHub Actions](https://www.boringgenerators.com/blog/2020-12-17-configure-github-actions/): `rails generate boring:ci:github_action:install --repository_name=<name> --ruby_version=<version>`
 - Install Travis CI: `rails generate boring:ci:travisci:install --ruby_version=<version>`
-- Install Rubocop: `rails generate boring:rubocop:install --ruby_version=<version>`
+- Install Rubocop: `rails generate boring:rubocop:install --ruby_version=<version> --test_gem=<test_framework_name>`
 - Build Favicon: `rails generate boring:favicon:build --application_name=<application_name> --favico_letter=<favico_letter> --primary_color=<color>`
 - Install Pundit: `rails generate boring:pundit:install`
 - Install GraphQL: `rails generate boring:graphql:install`
@@ -70,6 +75,15 @@ The boring generator introduces following generators:
 - Install Stimulus: `rails generate boring:stimulus:install`
 - Install Rails Admin: `rails generate boring:rails_admin:install`
 - Install Paper Trail: `rails generate boring:paper_trail:install`
+- Install Flipper: `rails generate boring:flipper:install`
+- Install RSpec: `rails generate boring:rspec:install`
+- Install FactoryBot: `rails generate boring:factory_bot:install`
+- Install Faker: `rails generate boring:faker:install`
+- Install Overcommit with RuboCop: `rails generate boring:overcommit:pre_commit:rubocop:install`
+- Install Letter Opener: `rails generate boring:letter_opener:install`
+- 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>`
 
 ## Screencasts
 

data/lib/boring_generators/version.rb

@@ -1,3 +1,3 @@
 module BoringGenerators
-  VERSION = "0.11.0"
+  VERSION = "0.13.0"
 end

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

@@ -8,7 +8,7 @@ module Boring
 
       def add_bootstrap_package
         say "Adding bootstrap packages", :green
-        run "yarn add bootstrap jquery popper.js"
+        run "yarn add bootstrap jquery @popperjs/core"
       end
 
       def add_jquery_plugin_provider_to_webpack_environment
@@ -48,6 +48,20 @@ module Boring
             \n
             import "bootstrap"
             import "stylesheets/application"
+            import { Tooltip, Popover } from "bootstrap"
+
+            document.addEventListener("turbolinks:load", () => {
+              // Both of these are from the Bootstrap 5 docs
+              var tooltipTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="tooltip"]'))
+              var tooltipList = tooltipTriggerList.map(function(tooltipTriggerEl) {
+                  return new Tooltip(tooltipTriggerEl)
+              })
+
+              var popoverTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="popover"]'))
+              var popoverList = popoverTriggerList.map(function(popoverTriggerEl) {
+                  return new Popover(popoverTriggerEl)
+              })
+            })
           RUBY
           append_to_file "app/javascript/packs/application.js", application_js_content
         else

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Boring
+  module FactoryBot
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds FactoryBot to the application"
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :skip_factory, type: :boolean, aliases: "-s",
+                                  desc: "Skips adding sample factory"
+      class_option :skip_faker, type: :boolean, aliases: "-s",
+                                desc: "Skips faker install"
+
+      def add_factory_bot_gem
+        log :adding, "FactoryBot"
+        Bundler.with_unbundled_env do
+          run "bundle add factory_bot_rails --group='developement,test'"
+        end
+      end
+
+      def add_sample_factory
+        return if options[:skip_factory]
+
+        log :adding, "Sample users factory"
+        copy_file "users.rb", "test/factories/users.rb"
+      end
+
+      def add_factory_bot_helper_method
+        log :adding, "factory_bot helper"
+        data = <<~RUBY
+          include FactoryBot::Syntax::Methods
+        RUBY
+
+        inject_into_file "test/test_helper.rb", optimize_indentation(data, 2),
+                                                after: /ActiveSupport::TestCase*\n/,
+                                                verbose: false
+      end
+
+      def add_faker_gem
+        return if options[:skip_faker]
+
+        Rails::Command.invoke :generate, ["boring:faker:install"]
+      end
+    end
+  end
+end

data/lib/generators/boring/factory_bot/install/templates/users.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :user do
+    email { "boring+generators@example.com" }
+    password { "boring+generators" }
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Boring
+  module Faker
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds Faker to the application"
+      source_root File.expand_path("templates", __dir__)
+
+      def add_faker_gem
+        log :adding, "faker"
+        Bundler.with_unbundled_env do
+          run "bundle add faker --group='developement,test'"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Boring
+  module Flipper
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds Active Record Flipper to the application"
+      source_root File.expand_path("templates", __dir__)
+
+      def add_flipper_gem
+        say "Adding Flipper gem", :green
+        Bundler.with_unbundled_env do
+          run "bundle add flipper-active_record flipper-ui"
+        end
+      end
+
+      def run_flipper_active_record_generator
+        say "Running Active Record Flipper generator", :green
+        Bundler.with_unbundled_env do
+          run "bundle exec rails generate flipper:active_record"
+          run "bundle exec rails db:migrate"
+        end
+      end
+
+      def add_flipper_initializer
+        say "Adding Flipper initializer", :green
+        copy_file "initializer.rb", "config/initializers/flipper.rb"
+      end
+
+      def add_flipper_routes
+        say "Adding Flipper UI routes", :green
+        route <<~ROUTE
+          mount Flipper::UI.app(Flipper) => '/admins/flipper'
+        ROUTE
+      end
+    end
+  end
+end

data/lib/generators/boring/flipper/install/templates/initializer.rb.tt

@@ -0,0 +1,19 @@
+require 'flipper/ui'
+require "flipper/adapters/active_record"
+
+Flipper::UI.configure do |config|
+  if Rails.env.production?
+    config.banner_text = "Production Environment"
+  else
+    config.banner_text = "Non-Production Environment"
+    config.banner_class = "primary"
+  end
+
+  config.fun = false
+  config.cloud_recommendation = false
+end
+
+# - Define All Actor here -
+Flipper.register(:admins) do |actor, context|
+  actor.respond_to?(:admin?) && actor.admin?
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Boring
+  module LetterOpener
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds letter_opener gem for previewing email in development environment"
+
+      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"
+        RUBY
+
+        insert_into_file "Gemfile", gem_content, after: /group :development do/
+
+        Bundler.with_unbundled_env do
+          run "bundle install"
+        end
+      end
+
+      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
+        RUBY
+
+        gsub_file "config/environments/development.rb",
+                  /end\Z/,
+                  configuration_content
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'bundler'
+
+module Boring
+  module Overcommit
+    class BaseGenerator < Rails::Generators::Base
+      desc "Adds and configures overcommit gem in the application"
+
+      class_option :skip_configuration,
+                   type: :boolean, aliases: "-s",
+                   desc: "Skips adding overcommit development configuration"
+
+      def add_overcommit_gem
+        say "Adding overcommit gem", :green
+
+        if overcommit_gem_exists?
+          say "Overcommit gem is already installed!", :yellow
+        else
+          Bundler.with_unbundled_env do
+            run "bundle add overcommit --group development,test"
+          end
+        end
+      end
+
+      def add_git_hooks_with_overcommit
+        return if options[:skip_configuration]
+
+        say "\nInstalling git hooks to your project", :green
+
+        Bundler.with_unbundled_env do
+          run "bundle exec overcommit --install"
+        end
+      end
+
+      private
+
+      def overcommit_gem_exists?
+        gem_file_content_array = File.readlines("Gemfile")
+
+        gem_file_content_array.any? { |line| line.include?("overcommit") }
+      end
+    end
+  end
+end

data/lib/generators/boring/overcommit/pre_commit/rubocop/install/install_generator.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "generators/boring/overcommit/base_generator"
+
+module Boring
+  module Overcommit
+    module PreCommit
+      module Rubocop
+        class InstallGenerator < Boring::Overcommit::BaseGenerator
+          DEFAULT_RUBY_VERSION = "2.7.1"
+
+          class_option :ruby_version, type: :string, aliases: "-v",
+                       desc: "Tell us the ruby version you use for the application. Defaults to Ruby #{DEFAULT_RUBY_VERSION}"
+
+          def check_and_install_rubocop
+            return if rubocop_gem_exists?
+
+            say "\nRuboCop gem is not installed. Running the generator to install it!\n", :red
+
+            ruby_version = options[:ruby_version].presence || DEFAULT_RUBY_VERSION
+
+            run "bundle exec rails generate boring:rubocop:install --ruby_version=#{ruby_version}"
+          end
+
+          def configure_rubocop
+            say "\nAdding configurations for running RuboCop on pre-commit", :green
+
+            uncomment_lines(".overcommit.yml", /PreCommit:/)
+
+            gsub_file(".overcommit.yml", /PreCommit:/) do
+              <<~YAML
+                PreCommit:
+                  RuboCop:
+                    enabled: true
+                    on_warn: fail # Treat all warnings as failures
+                    problem_on_unmodified_line: ignore # run RuboCop only on modified code'
+              YAML
+            end
+          end
+
+          def enable_overcommit_configurations
+            say "\nEnabling new configurations", :green
+
+            run "git add .overcommit.yml"
+
+            Bundler.with_unbundled_env do
+              run "bundle exec overcommit --sign"
+            end
+          end
+
+          private
+
+          def rubocop_gem_exists?
+            gem_file_content_array = File.readlines("Gemfile")
+
+            gem_file_content_array.any? { |line| line.include?("rubocop") }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Boring
+  module Rspec
+    class InstallGenerator < Rails::Generators::Base
+      desc "Adds RSpec to the application"
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :skip_factory_bot, type: :boolean, aliases: "-sfb",
+                                      desc: "Skips installing factory bot"
+      class_option :skip_faker, type: :boolean, aliases: "-sf",
+                                desc: "Skips faker install"
+
+      def add_rspec_gem
+        log :adding, "rspec-rails"
+        Bundler.with_unbundled_env do
+          run "bundle add rspec-rails --group='developement,test'"
+        end
+      end
+
+      def run_rspec_active_record_generator
+        log :running, "rspec generator"
+        Bundler.with_unbundled_env do
+          run "rails generate rspec:install"
+        end
+      end
+
+      def add_rspec_initializer
+        log :override, "test_framework to rspec"
+        environment <<~end_of_config
+          config.generators do |g|
+            g.test_framework :rspec
+          end
+        end_of_config
+      end
+
+      def add_factory_bot
+        return if options[:skip_factory_bot]
+
+        Rails::Command.invoke :generate, ["boring:factory_bot:install"]
+      end
+
+      def add_faker_gem
+        return if options[:skip_faker]
+
+        Rails::Command.invoke :generate, ["boring:faker:install"]
+      end
+    end
+  end
+end