Ruby 코드의 가독성을 높이기 위해 (인터페이스 편)

가독성

당연하게 해야 할 일.

Formitter/Litter 사용

다른 사람이 생각해줬으면 하는 거.

명확한 인터페이스

class AuthTokenRepository
  def create(params)
    Faraday.new.post('/api/v1/auth_token', params.to_json)
  end
end

매개변수의 정의를 자세히 설명해 주세요.

class AuthTokenRepository
  def create(user_id:, password:)
    Faraday.new.post('/api/v1/auth_token', { user_id: user_id, password: password }.to_json)
  end
end

params가 끼면 어떡해요.

    Faraday.new.post('/api/v1/auth_token', { user: { id: user_id, password: password } }.to_json)

class AuthTokenRepository
  def create(user_id:, user_password:)
    Faraday.new.post('/api/v1/auth_token', { user: { id: user_id, password: user_password } }.to_json)
  end
end

class AuthTokenRepository
  class ValidationError < ::StandardError; end

  def create(params)
    raise ValidationError unless valid_params_for_create?(params)

    Faraday.new.post('/api/v1/auth_token', params.to_json)
  end

  private

  def valid_params_for_create?(params)
    !(params.dig(:user, :id).nil? || params.dig(:user, :password).nil?)
  end
end

정상계의 반환값을 포장하다

class AuthToken
  def initialize(token:, expired_at:)
    ...
  end
end

class AuthTokenRepository
  def create(user_id:, password:)
    response = Faraday.new.post('/api/v1/auth_token', { user_id: user_id, password: password }.to_json)
    AuthToken.new(token: response.body['token'], expired_at: response.body['expired_at'])
  end
end

정상적인 시스템 / 비정상적인 시스템의 오류를 압축합니다.

class AuthTokenRepository
  class Error < ::StandardError; end
  class FailedToCreateError < Error; end
  class UnexpectedError < Error; end

  def create(user_id:, password:)
    response = Faraday.new.post('/api/v1/auth_token', { user_id: user_id, password: password }.to_json)
    AuthToken.new(response.body)
  rescue Faraday::ClientError => e
    raise FailedToCreateError, e.message
  rescue => e
    raise UnexpectedError, e.message
  end
end

부가: 캡슐화된 기쁜 부작용

# WebAPI のレスポンスフォーマットが変わった
class AuthTokenRepository
  def create(user_id:, password:)
    response = Faraday.new.post('/api/v1/auth_token', { user_id: user_id, password: password }.to_json)
    AuthToken.new(
      token: response.body['authToken']['token'],
      expired_at: response.body['authToken']['expired_at']
    )
  rescue => e
    # 省略
  end
end

# DB を使いたい
class AuthTokenRepository
  def create(user_id:, password:)
    hashed_password = hash(password)
    user = User.find_by!(user_id: user_id, password: hashed_password)
    token, expired_at = create_token_for_user(user)

    AuthToken.new(token: token, expired_at: expired_at)
  rescue ActiveRecode::RecordNotFound => e
    raise FailedToCreateError, e.message
  rescue => e
    raise UnexpectedError, e.message
  end
end