Adding the generator_spec gem to help with generator spec testing

Adding tests for the generator

Author: msquance-stem

Gemfile

@@ -105,6 +105,7 @@ group :test do
   gem "axe-matchers", ">= 2.5.0", require: false
   gem "capybara"
   gem "climate_control"
+  gem "generator_spec"
   gem "guard-rspec", require: false
   gem "rails-controller-testing"
   gem "rspec-json_expectations"

Gemfile.lock

@@ -276,6 +276,9 @@ GEM
       fog-core
       nokogiri (>= 1.5.11, < 2.0.0)
     formatador (1.1.0)
+    generator_spec (0.10.0)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
     geocoder (1.8.2)
     globalid (1.2.1)
       activesupport (>= 6.1)
@@ -777,6 +780,7 @@ DEPENDENCIES
   faker
   faraday
   fog-aws
+  generator_spec
   geocoder (>= 1.6.6)
   graphlient
   graphql

lib/generators/strapi/component_generator.rb

@@ -2,23 +2,23 @@ module Strapi
   class ComponentGenerator < Rails::Generators::Base
     source_root File.expand_path("component_templates", __dir__)
 
-    class_option :component_name, type: :string
-    class_option :component_type, type: :string
+    argument :component_name, type: :string, required: true
+    argument :component_type, type: :string, required: true
     class_option :strapi_params, type: :array, default: []
 
     COMPONENT_TYPES = %w[blocks content_blocks buttons email_content]
     PROVIDER = "providers/strapi/"
     BASE_PATH = "app/services/cms/"
     STRAPI_PATH = "#{BASE_PATH}#{PROVIDER}"
-    TEST_PATH = "app/sevices/spec/#{PROVIDER}"
+    TEST_PATH = "spec/services/cms/#{PROVIDER}"
 
     def setup_params
-      raise StandardError unless COMPONENT_TYPES.include?(options["component_type"])
-      @component_name_class = options["component_name"].classify
-      @component_type_class = options["component_type"].camelize
-      @component_filename = options["component_name"].underscore
-      @component_type_filename = options["component_type"].underscore
-      @component_strapi_name = options["component_name"].underscore.tr("_", "-")
+      raise StandardError unless COMPONENT_TYPES.include?(component_type)
+      @component_name_class = component_name.classify
+      @component_type_class = component_type.camelize
+      @component_filename = component_name.underscore
+      @component_type_filename = component_type.underscore
+      @component_strapi_name = component_name.underscore.tr("_", "-")
       @strapi_params = options["strapi_params"]
       @rails_param_names = options["strapi_params"].map { _1.underscore }
     end
@@ -39,8 +39,23 @@ def create_data_file
       template("mapping_template.rb.tt", "#{BASE_PATH}dynamic_components/#{@component_type_filename}/#{@component_filename}.rb")
     end
 
-    def run_other_generators
-      generate "component Cms::#{@component_name_class} #{@rails_param_names.join(" ")} --test-framework=rspec"
+    def run_view_component_generator
+      params = @rails_param_names.join(" ").presence
+      Rails::Generators.invoke(
+        "component",
+        ["Cms::#{@component_name_class}", params, "--test-framework=rspec", "--sidecar"].compact,
+        behaviour: :invoke,
+        destination_root:
+      )
+    rescue
+      puts <<~HEREDOC
+        #{"*" * 80}
+        Unable to create component, please run this command seperatly
+
+        rails generate component Cms::#{@component_name_class} #{@rails_param_names.join(" ")} --test-framework=rspec
+        #{"*" * 80}
+
+      HEREDOC
     end
 
     def print_method_defintions

spec/lib/generators/strapi/component_generator_spec.rb

@@ -0,0 +1,58 @@
+require "rails_helper"
+require "generator_spec"
+require "generators/strapi/component_generator"
+
+RSpec.describe Strapi::ComponentGenerator, type: :generator do
+  let(:tmp_dir) { Rails.root.join("tmp/gen_test") }
+  tests Strapi::ComponentGenerator
+  destination Rails.root.join("tmp/gen_test")
+
+  before do
+    FileUtils.rm_rf(tmp_dir)
+    prepare_destination
+  end
+
+  after do
+    FileUtils.rm_rf(tmp_dir)
+  end
+
+  context "with all arguments" do
+    before do
+      run_generator %w[gen_test blocks --strapi-params=title textContent]
+    end
+
+    it "creates the query file" do
+      expect(File).to exist(file_path("app/services/cms/providers/strapi/queries/components/blocks/gen_test.rb"))
+    end
+
+    it "creates the query test file" do
+      expect(File).to exist(file_path("spec/services/cms/providers/strapi/queries/components/blocks/gen_test_spec.rb"))
+    end
+
+    it "creates data file" do
+      expect(File).to exist(file_path("app/services/cms/dynamic_components/blocks/gen_test.rb"))
+    end
+
+    it "creates mock file" do
+      expect(File).to exist(file_path("app/services/cms/providers/strapi/mocks/dynamic_components/blocks/gen_test.rb"))
+    end
+
+    it "creates component file" do
+      expect(File).to exist(file_path("app/components/cms/gen_test_component.rb"))
+      expect(File).to exist(file_path("app/components/cms/gen_test_component/gen_test_component.html.erb"))
+      expect(File).to exist(file_path("spec/components/cms/gen_test_component_spec.rb"))
+    end
+
+    def file_path(file)
+      "tmp/gen_test/#{file}"
+    end
+  end
+
+  context "with invalid type" do
+    it "creates the query file" do
+      expect {
+        run_generator %w[gen_test not-a-type --strapi-params=title textContent]
+      }.to raise_error
+    end
+  end
+end