boring_generators 0.13.0 → 0.14.0

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

@@ -1,7 +1,12 @@
 # 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]
@@ -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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boring_generators
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Abhay Nikam
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-29 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,6 +94,9 @@ 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
@@ -111,15 +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
@@ -128,6 +149,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/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