Use GraphqlDevise in included concerns (generator)

Author: mcelicalderon

lib/generators/graphql_devise/install_generator.rb

@@ -10,6 +10,20 @@ def execute_devise_installer
     end
 
     def execute_dta_installer
+      # Necessary in case of a re-run of the generator, for DTA to detect concerns already included
+      if File.exist?(File.expand_path("app/models/#{user_class.underscore}.rb", destination_root))
+        gsub_file(
+          "app/models/#{user_class.underscore}.rb",
+          'GraphqlDevise::Concerns::Model',
+          'DeviseTokenAuth::Concerns::User'
+        )
+      end
+      gsub_file(
+        'app/controllers/application_controller.rb',
+        'GraphqlDevise::Concerns::SetUserByToken',
+        'DeviseTokenAuth::Concerns::SetUserByToken'
+      )
+
       generate 'devise_token_auth:install', "#{user_class} #{mount_path}"
     end
 
@@ -19,13 +33,30 @@ def mount_resource_route
       dta_route   = "mount_devise_token_auth_for '#{user_class}', at: '#{mount_path}'"
 
       if file_contains_str?(routes_file, gem_route)
-        gsub_file(routes_file, /^\s+#{Regexp.escape(dta_route + "\n")}/i, '') if file_contains_str?(routes_file, dta_route)
+        gsub_file(routes_file, /^\s+#{Regexp.escape(dta_route + "\n")}/i, '')
+
         say_status('skipped', "Routes already exist for #{user_class} at #{mount_path}")
       else
         gsub_file(routes_file, /#{Regexp.escape(dta_route)}/i, gem_route)
       end
     end
 
+    def replace_model_concern
+      gsub_file(
+        "app/models/#{user_class.underscore}.rb",
+        /^\s+include DeviseTokenAuth::Concerns::User/,
+        '  include GraphqlDevise::Concerns::Model'
+      )
+    end
+
+    def replace_controller_concern
+      gsub_file(
+        'app/controllers/application_controller.rb',
+        /^\s+include DeviseTokenAuth::Concerns::SetUserByToken/,
+        '  include GraphqlDevise::Concerns::SetUserByToken'
+      )
+    end
+
     private
 
     def file_contains_str?(filename, regex_str)

spec/generators/graphql_devise/install_generator_spec.rb

@@ -3,44 +3,61 @@
 require 'generators/graphql_devise/install_generator'
 
 RSpec.describe GraphqlDevise::InstallGenerator, type: :generator do
-  destination File.expand_path('../../../../dummy', __dir__)
+  destination File.expand_path('../../../../gqld_dummy', __dir__)
+
+  let(:routes_path)    { "#{destination_root}/config/routes.rb" }
+  let(:routes_content) { File.read(routes_path) }
+  let(:dta_route)      { 'mount_devise_token_auth_for' }
+
+  after(:all) { FileUtils.rm_rf(destination_root) }
 
   before do
     prepare_destination
     create_rails_project
+    run_generator(args)
   end
 
-  let(:routes_path)    { "#{destination_root}/config/routes.rb" }
-  let(:routes_content) { File.read(routes_path) }
-  let(:dta_route)      { 'mount_devise_token_auth_for' }
-
   context 'when passing no params to the generator' do
-    before { run_generator }
+    let(:args) { [] }
 
     it 'creates and updated required files' do
-      assert_file 'config/routes.rb', /\s{2,}mount_graphql_devise_for 'User', at: 'auth'/
+      assert_file 'config/routes.rb', /^\s{2}mount_graphql_devise_for 'User', at: 'auth'/
       expect(routes_content).not_to match(dta_route)
 
       assert_file 'config/initializers/devise.rb'
       assert_file 'config/initializers/devise_token_auth.rb'
+      assert_file 'config/locales/devise.en.yml'
+
+      assert_migration 'db/migrate/devise_token_auth_create_users.rb'
+
+      assert_file 'app/models/user.rb', /^\s{2}devise :.+include GraphqlDevise::Concerns::Model/m
+
+      assert_file 'app/controllers/application_controller.rb', /^\s{2}include GraphqlDevise::Concerns::SetUserByToken/
     end
   end
 
   context 'when passing custom params to the generator' do
-    before { run_generator %w[Admin api] }
+    let(:args) { %w[Admin api] }
 
     it 'creates and updated required files' do
-      assert_file 'config/routes.rb', /\s{2,}mount_graphql_devise_for 'Admin', at: 'api'/
+      assert_file 'config/routes.rb', /^\s{2}mount_graphql_devise_for 'Admin', at: 'api'/
       expect(routes_content).not_to match(dta_route)
 
       assert_file 'config/initializers/devise.rb'
       assert_file 'config/initializers/devise_token_auth.rb'
+      assert_file 'config/locales/devise.en.yml'
+
+      assert_migration 'db/migrate/devise_token_auth_create_admins.rb'
+
+      assert_file 'app/models/admin.rb', /^\s{2}devise :.+include GraphqlDevise::Concerns::Model/m
+
+      assert_file 'app/controllers/application_controller.rb', /^\s{2}include GraphqlDevise::Concerns::SetUserByToken/
     end
   end
 
   def create_rails_project
     FileUtils.cd(File.join(destination_root, '..')) do
-      `rails new dummy -S -C --skip-action-mailbox --skip-action-text -T --skip-spring --skip-bundle --skip-keeps -G --skip-active-storage -J --skip-listen --skip-bootsnap`
+      `rails new gqld_dummy -S -C --skip-action-mailbox --skip-action-text -T --skip-spring --skip-bundle --skip-keeps -G --skip-active-storage -J --skip-listen --skip-bootsnap`
     end
   end
 end