Merge pull request #2347 from NCCE/3010-component-generator-fixes

Improving Strapi Component generator

Author: msquance-stem

lib/generators/strapi/component_generator.rb

@@ -2,15 +2,18 @@ module Strapi
   class ComponentGenerator < Rails::Generators::Base
     source_root File.expand_path("component_templates", __dir__)
 
-    argument :component_name, type: :string, required: true
-    argument :component_type, type: :string, required: true
-    class_option :strapi_params, type: :array, default: []
+    desc "Generates a Strapi component and related files"
+
+    argument :component_name, type: :string, required: true, desc: "Name of your component, do not include Cms:: namespace, we automatically add this"
+    argument :component_type, type: :string, required: true, desc: "Name of the type you assigned your component to, e,g blocks"
+    class_option :strapi_params, type: :array, default: [], desc: "A list of params you want to include from strapi, please provide these matching the case you have used in Strapi"
 
     COMPONENT_TYPES = %w[blocks content_blocks buttons email_content]
     PROVIDER = "providers/strapi/"
     BASE_PATH = "app/services/cms/"
-    STRAPI_PATH = "#{BASE_PATH}#{PROVIDER}"
-    TEST_PATH = "spec/services/cms/#{PROVIDER}"
+    STRAPI_PATH = File.join(BASE_PATH, PROVIDER)
+    TEST_BASE_PATH = "spec/services/cms/"
+    TEST_PATH = File.join(TEST_BASE_PATH, PROVIDER)
 
     def setup_params
       raise StandardError unless COMPONENT_TYPES.include?(component_type)
@@ -24,19 +27,23 @@ def setup_params
     end
 
     def create_query_file
-      template("query_template.rb.tt", "#{STRAPI_PATH}queries/components/#{@component_type_filename}/#{@component_filename}.rb")
+      template("query_template.rb.tt", File.join(STRAPI_PATH, "queries/components", @component_type_filename, "#{@component_filename}.rb"))
     end
 
     def create_query_test
-      template("query_test_template.rb.tt", "#{TEST_PATH}queries/components/#{@component_type_filename}/#{@component_filename}_spec.rb")
+      template("query_test_template.rb.tt", File.join(TEST_PATH, "queries/components", @component_type_filename, "#{@component_filename}_spec.rb"))
     end
 
     def create_mock_file
-      template("mock_template.rb.tt", "#{STRAPI_PATH}mocks/dynamic_components/#{@component_type_filename}/#{@component_filename}.rb")
+      template("mock_template.rb.tt", File.join(STRAPI_PATH, "mocks/dynamic_components", @component_type_filename, "#{@component_filename}.rb"))
     end
 
     def create_data_file
-      template("mapping_template.rb.tt", "#{BASE_PATH}dynamic_components/#{@component_type_filename}/#{@component_filename}.rb")
+      template("mapping_template.rb.tt", File.join(BASE_PATH, "dynamic_components", @component_type_filename, "#{@component_filename}.rb"))
+    end
+
+    def create_data_text
+      template("mapping_test_template.rb.tt", File.join(TEST_BASE_PATH, "dynamic_components", @component_type_filename, "#{@component_filename}_spec.rb"))
     end
 
     def run_view_component_generator

lib/generators/strapi/component_templates/mapping_test_template.rb.tt

@@ -0,0 +1,13 @@
+require "rails_helper"
+
+RSpec.describe Cms::DynamicComponents::<%= @component_type_class %>::<%= @component_name_class %> do
+  before do
+    @comp = Cms::Providers::Strapi::Factories::<%= @component_type_class %>Factory.process_component(
+      Cms::Mocks::DynamicComponents::<%= @component_type_class %>::<%= @component_name_class %>.generate_raw_data
+    )
+  end
+
+  it "should render as Cms::<%= @component_name_class %>Component" do
+    expect(@comp.render).to be_a(Cms::<%= @component_name_class %>Component)
+  end
+end

lib/generators/strapi/component_templates/query_template.rb.tt

@@ -5,7 +5,7 @@ module Cms
         module Components
           module <%= @component_type_class %>
             class <%= @component_name_class %> < BaseComponentQuery
-              def self.name = "Component<%= @component_name_class %>"
+              def self.name = "Component<%= @component_type_class %><%= @component_name_class %>"
 
               def self.base_fields
                 <<~GRAPHQL.freeze

spec/lib/generators/strapi/component_generator_spec.rb

@@ -4,6 +4,12 @@
 
 RSpec.describe Strapi::ComponentGenerator, type: :generator do
   let(:tmp_dir) { Rails.root.join("tmp/gen_test") }
+  let(:query_file_path) { file_path("app/services/cms/providers/strapi/queries/components/blocks/gen_test.rb") }
+  let(:query_test_path) { file_path("spec/services/cms/providers/strapi/queries/components/blocks/gen_test_spec.rb") }
+  let(:mapping_file_path) { file_path("app/services/cms/dynamic_components/blocks/gen_test.rb") }
+  let(:mapping_test_path) { file_path("spec/services/cms/dynamic_components/blocks/gen_test_spec.rb") }
+  let(:mock_path) { file_path("app/services/cms/providers/strapi/mocks/dynamic_components/blocks/gen_test.rb") }
+
   tests Strapi::ComponentGenerator
   destination Rails.root.join("tmp/gen_test")
 
@@ -21,20 +27,59 @@
       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"))
+    context "query file" do
+      it "is created" do
+        expect(File).to exist(query_file_path)
+      end
+
+      it "should contain the component name" do
+        expect(File.read(query_file_path)).to match(/ComponentBlocksGenTest/)
+      end
+
+      it "should include params" do
+        expect(File.read(query_file_path)).to match(/title/)
+        expect(File.read(query_file_path)).to match(/textContent/)
+      end
+    end
+
+    context "query test file" do
+      it "is created" do
+        expect(File).to exist(query_test_path)
+      end
+
+      it "should contain the correct example" do
+        expect(File.read(query_test_path)).to match(/a strapi graphql component/)
+      end
     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"))
+    context "mapping file" do
+      it "is created" do
+        expect(File).to exist(mapping_file_path)
+      end
+
+      it "should contain the correct component name" do
+        expect(File.read(mapping_file_path)).to match(/Cms::GenTestComponent/)
+      end
     end
 
-    it "creates data file" do
-      expect(File).to exist(file_path("app/services/cms/dynamic_components/blocks/gen_test.rb"))
+    context "mapping test file" do
+      it "is created" do
+        expect(File).to exist(mapping_test_path)
+      end
+
+      it "should contain the correct component name" do
+        expect(File.read(mapping_test_path)).to match(/Cms::GenTestComponent/)
+      end
     end
 
-    it "creates mock file" do
-      expect(File).to exist(file_path("app/services/cms/providers/strapi/mocks/dynamic_components/blocks/gen_test.rb"))
+    context "mock file" do
+      it "is created" do
+        expect(File).to exist(mock_path)
+      end
+
+      it "should contain strapi component name" do
+        expect(File.read(mock_path)).to match(/strapi_component "blocks.gen-test"/)
+      end
     end
 
     it "creates component file" do
@@ -44,7 +89,7 @@
     end
 
     def file_path(file)
-      "tmp/gen_test/#{file}"
+      File.join(tmp_dir, file)
     end
   end