Merge pull request #102 from TruemarkDev/generator-for-avo

Generator for Avo

CHANGELOG.md

@@ -6,6 +6,7 @@
 * Adds VCR generator. ([@TheZero0-ctrl][])
 * Adds Pronto Generator with Gihub Action. ([@TheZero0-ctrl][])
 * Adds Doorkeeper Generator with Devise. ([@TheZero0-ctrl][])
+* Adds Avo generator. ([@mausamp][])
 
 ## 0.13.0 (March 26th, 2024)
 * Adds Letter Opener generator. ([@coolprobn][])

README.md

@@ -85,9 +85,10 @@ The boring generator introduces following generators:
 - 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>`
 - Install Pronto with Gitlab CI: `rails generate boring:pronto:gitlab_ci:install`
+- Install Pronto with Github Action: `rails generate boring:pronto:github_action:install`
 - Install Rack Mini Profiler: `rails generate boring:rack_mini_profiler:install`
 - Install VCR: `rails generate boring:vcr:install --testing_framework=<testing_framework> --stubbing_libraries=<stubbing_libraries>`
-- Install Pronto with Github Action: `rails generate boring:pronto:github_action:install`
+- Install Avo: `rails generate boring:avo:install`
 - Install Doorkeeper with devise: `rails generate boring:devise:doorkeeper:install`
 
 ## Screencasts

lib/generators/boring/avo/install/install_generator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Boring
+  module Avo
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Adds Avo to the application'
+
+      def add_avo_gem
+        say 'Adding Avo gem', :green
+
+        Bundler.with_unbundled_env do
+          run 'bundle add avo'
+        end
+      end
+
+      def configure_avo
+        say 'Setting up Avo', :green
+
+        Bundler.with_unbundled_env do
+          run 'bundle exec rails generate avo:install'
+        end
+      end
+    end
+  end
+end

test/generators/avo_install_generator_test.rb

@@ -0,0 +1,33 @@
+# frozen_string-literal: true
+
+require 'test_helper'
+require 'generators/boring/avo/install/install_generator'
+
+class AvoInstallGeneratorTest < Rails::Generators::TestCase
+  tests Boring::Avo::InstallGenerator
+  setup :build_app
+  teardown :teardown_app
+
+  include GeneratorHelper
+
+  def destination_root
+    app_path
+  end
+
+  def test_should_configure_avo_gem
+    Dir.chdir(app_path) do
+      quietly { run_generator }
+
+      assert_gem 'avo'
+
+      assert_file 'config/initializers/avo.rb' do |content|
+        assert_match(/Avo.configure do |config|/, content)
+        assert_match(/config.root_path = '\/avo'/, content)
+      end
+
+      assert_file 'config/routes.rb' do |content|
+        assert_match(/mount Avo::Engine, at: Avo.configuration.root_path/, content)
+      end
+    end
+  end
+end