add snippet rails/convert_to_params_expect

Author: flyerhzm

lib/rails/convert_to_params_expect.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+Synvert::Rewriter.new 'rails', 'convert_to_params_expect' do
+  configure(parser: Synvert::PRISM_PARSER)
+
+  description <<~EOS
+    It converts `params.require(...).permit(...)` to `params.expect(...)`.
+
+    ```ruby
+    params.require(:post).permit(:title, :summary, categories: [:name])
+    ```
+
+    =>
+
+    ```ruby
+    params.expect(post: [:title, :summary, categories: [[:name]]])
+    ```
+  EOS
+
+  if_gem 'actionpack', '>= 8.0'
+
+  within_files Synvert::RAILS_CONTROLLER_FILES do
+    with_node node_type: 'call_node',
+              receiver: { node_type: 'call_node', receiver: 'params', name: 'require' },
+              name: 'permit' do
+      goto_node :arguments do
+        with_node node_type: 'array_node' do
+          wrap prefix: '[', suffix: ']'
+        end
+      end
+    end
+  end
+
+  within_files Synvert::RAILS_CONTROLLER_FILES do
+    with_node node_type: 'call_node',
+              receiver: { node_type: 'call_node', receiver: 'params', name: 'require' },
+              name: 'permit' do
+      replace_with 'params.expect({{receiver.arguments.arguments.first.value.to_s}}: [{{arguments}}])'
+    end
+  end
+end

spec/rails/convert_to_params_expect_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'Convert to params.expect' do
+  let(:rewriter_name) { 'rails/convert_to_params_expect' }
+  let(:fake_file_path) { 'app/controllers/posts_controller.rb' }
+  let(:test_content) { <<~EOS }
+    class PostsController < ApplicationController
+      def post_params
+        params.require(:post).permit(:title, :summary)
+      end
+
+      def post_params
+        params.require(:post).permit(:title, :summary, categories: [:name])
+      end
+    end
+  EOS
+  let(:test_rewritten_content) { <<~EOS }
+    class PostsController < ApplicationController
+      def post_params
+        params.expect(post: [:title, :summary])
+      end
+
+      def post_params
+        params.expect(post: [:title, :summary, categories: [[:name]]])
+      end
+    end
+  EOS
+
+  include_examples 'convertable'
+end