Skip to content

Move both controller and request specs on controller move #175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Envek wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Move both controller and request specs on controller move #175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/packs/private.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ def self.move_to_pack!(pack_name:, paths_relative_to_root:, per_file_processors:
)
[
file_move_operation,
file_move_operation.spec_file_move_operation
*file_move_operation.spec_file_move_operations
]
end
file_move_operations.each do |file_move_operation|
Expand Down Expand Up @@ -358,7 +358,7 @@ def self.make_public!(paths_relative_to_root:, per_file_processors:)

[
file_move_operation,
file_move_operation.spec_file_move_operation
*file_move_operation.spec_file_move_operations
]
end

Expand Down
50 changes: 43 additions & 7 deletions lib/packs/private/file_move_operation.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ def self.destination_pathname_for_new_public_api(origin_pathname)
).cleanpath
end

sig { returns(FileMoveOperation) }
def spec_file_move_operation
sig { returns(T::Array[FileMoveOperation]) }
def spec_file_move_operations
path_parts = filepath_without_pack_name.split('/')
folder = T.must(path_parts[0])
file_extension = T.must(filepath_without_pack_name.split('.').last)
Expand All @@ -67,11 +67,20 @@ def spec_file_move_operation
new_destination_pathname = spec_pathname_for_non_app(destination_pathname, file_extension, folder)
end

FileMoveOperation.new(
origin_pathname: new_origin_pathname,
destination_pathname: new_destination_pathname,
destination_pack: destination_pack
)
ops = [
FileMoveOperation.new(
origin_pathname: new_origin_pathname,
destination_pathname: new_destination_pathname,
destination_pack: destination_pack
)
]

# For controllers, also include the request spec (spec/requests/<name>_spec.rb) if it exists.
# Request specs are named without "controller" suffix (e.g. my_controller -> my_spec)
request_spec_op = request_spec_file_move_operation
ops << request_spec_op if request_spec_op

ops
end

sig { params(filepath: Pathname, pack: T.nilable(Packs::Pack)).returns(String) }
Expand Down Expand Up @@ -106,6 +115,33 @@ def spec_pathname_for_non_app(pathname, file_extension, folder)
.sub(".#{file_extension}", '_spec.rb')
end

# Maps app/controllers/<namespaces/>*_controller.rb to spec/requests/<namespaces/>*_spec.rb.
# Returns nil if the path is not a controller path.
sig { params(pathname: Pathname).returns(T.nilable(Pathname)) }
def pathname_to_request_spec(pathname)
return nil unless pathname.to_s.end_with?('_controller.rb')

pathname
.sub('app/controllers/', 'spec/requests/')
.sub(/_controller\.rb\z/, '_spec.rb')
.cleanpath
end

sig { returns(T.nilable(FileMoveOperation)) }
def request_spec_file_move_operation
request_spec_origin = pathname_to_request_spec(origin_pathname)
return if request_spec_origin.nil? || !request_spec_origin.exist?

request_spec_destination = pathname_to_request_spec(destination_pathname)
return if request_spec_destination.nil?

FileMoveOperation.new(
origin_pathname: request_spec_origin,
destination_pathname: request_spec_destination,
destination_pack: destination_pack
)
end

sig { params(path: Pathname).returns(FileMoveOperation) }
def relative_to(path)
FileMoveOperation.new(
Expand Down
51 changes: 51 additions & 0 deletions spec/packs_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,57 @@ def write_codeownership_config
])
end

it 'moves the request spec when moving a controller if spec/requests/<name>_spec.rb exists (name = controller minus "controller")' do
write_file('app/controllers/my_controller.rb')
write_file('spec/requests/my_spec.rb')
write_package_yml('packs/my_pack')
Packs.move_to_pack!(
pack_name: 'packs/my_pack',
paths_relative_to_root: ['app/controllers/my_controller.rb']
)

expect_files_to_not_exist([
'app/controllers/my_controller.rb',
'spec/requests/my_spec.rb'
])
expect_files_to_exist([
'packs/my_pack/app/controllers/my_controller.rb',
'packs/my_pack/spec/requests/my_spec.rb'
])
end

it 'moves namespaced request spec when moving a namespaced controller' do
write_file('app/controllers/api/v1/users_controller.rb')
write_file('spec/requests/api/v1/users_spec.rb')
write_package_yml('packs/my_pack')
Packs.move_to_pack!(
pack_name: 'packs/my_pack',
paths_relative_to_root: ['app/controllers/api/v1/users_controller.rb']
)

expect_files_to_not_exist([
'app/controllers/api/v1/users_controller.rb',
'spec/requests/api/v1/users_spec.rb'
])
expect_files_to_exist([
'packs/my_pack/app/controllers/api/v1/users_controller.rb',
'packs/my_pack/spec/requests/api/v1/users_spec.rb'
])
end

it 'does not move a request spec when no file exists at spec/requests/<name>_spec.rb' do
write_file('app/controllers/my_controller.rb')
# no spec/requests/my_spec.rb
write_package_yml('packs/my_pack')
Packs.move_to_pack!(
pack_name: 'packs/my_pack',
paths_relative_to_root: ['app/controllers/my_controller.rb']
)

expect_files_to_not_exist(['app/controllers/my_controller.rb'])
expect_files_to_exist(['packs/my_pack/app/controllers/my_controller.rb'])
end

it 'can move files from non-pack packages into a pack' do
target_pack = 'packs/animals'
file_to_move = 'lib/tasks/donkey.rake'
Expand Down