boring_generators 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 359acba051da88cd0afd42b265845dd57da2ac688e57466cfca79a87fdba8dec
-  data.tar.gz: cf6b4543e010b57774ce160a49e02c962b4c90b1764cd6ff504725dffeced453
+  metadata.gz: e3e2cf89c148c10914b919c1f9be41275681aa3ba8eaed7a22df5beb6adbef55
+  data.tar.gz: '083314c373aeb284b779aba16629fa36cbbeb9f60521161d0f1de081b7c1f99a'
 SHA512:
-  metadata.gz: a0895d2a677ff5c80e2249a0f5dca86f6f1ab1b74b0d53e2d08d5c2f8f437daef054511e4b6a6c15854e40721e5a21e81a41dec74267a072031628ecb86332fa
-  data.tar.gz: 5e31f9a9804338af68046deb67f081e5754a9a09b2b61c651eb0191e259936878af814ff67241234ea802a4311887a8ed81cf7e5354514ba88333f8c585d6674
+  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/.gitignore

@@ -10,3 +10,4 @@
 .byebug_history
 
 *.log
+.idea

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## 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][])
@@ -77,3 +83,4 @@
 [@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.11.0)
+    boring_generators (0.12.0)
       railties
 
 GEM
@@ -143,4 +143,4 @@ DEPENDENCIES
   sqlite3 (~> 1.4)
 
 BUNDLED WITH
-   2.3.12
+   2.1.4

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`
@@ -75,6 +80,10 @@ The boring generator introduces following generators:
 - 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.12.0"
+  VERSION = "0.13.0"
 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/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/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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boring_generators
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Abhay Nikam
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-08 00:00:00.000000000 Z
+date: 2024-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -87,6 +87,7 @@ files:
 - lib/generators/boring/graphql/install/templates/base_resolver.rb
 - lib/generators/boring/graphql/install/templates/hello_world_resolver.rb
 - 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
@@ -115,6 +116,8 @@ files:
 - lib/generators/boring/pundit/install/install_generator.rb
 - lib/generators/boring/rails_admin/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/simple_form/install/install_generator.rb
@@ -125,6 +128,8 @@ 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/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