AskOverflow.Dev

AskOverflow.Dev Logo AskOverflow.Dev Logo

AskOverflow.Dev Navigation

  • Início
  • system&network
  • Ubuntu
  • Unix
  • DBA
  • Computer
  • Coding
  • LangChain

Mobile menu

Close
  • Início
  • system&network
    • Recentes
    • Highest score
    • tags
  • Ubuntu
    • Recentes
    • Highest score
    • tags
  • Unix
    • Recentes
    • tags
  • DBA
    • Recentes
    • tags
  • Computer
    • Recentes
    • tags
  • Coding
    • Recentes
    • tags
Início / coding / Perguntas / 79488556
Accepted
Ricky883249
Ricky883249
Asked: 2025-03-06 15:28:50 +0800 CST2025-03-06 15:28:50 +0800 CST 2025-03-06 15:28:50 +0800 CST

Como refatorar o método do controlador com várias mensagens de falha diferentes

  • 772

Eu tenho um método "destroy" do controlador que verifica vários objetos dependentes e falha com mensagens de alerta correspondentes. A exclusão também é impedida no lado do banco de dados, has_many :invoices, dependent: :restrict_with_errormas falha silenciosamente para o usuário.

Rubocop acha que "Tamanho da Condição de Ramificação de Atribuição é muito alto" e eu gostaria de refatorar isso também porque parece meio repetitivo. No entanto, tenho dificuldades com os retornos. Quando movo verificações para uma função privada, o retorno retorna da função, mas também preciso que ele encerre o método "destroy". Preciso de um retorno duplo.

def destroy
    unless Current.user.default_entity.owner == Current.user ||
           Current.user.default_entity.user_privileged?('manage_contacts')

      redirect_back(fallback_location: contacts_path, alert: t('errors.no_access_rights')) and return
    end

    unless @contact.invoices.count.zero?
      redirect_back(fallback_location: contacts_path,
                    alert: t('errors.cant_delete_contact_with_invoices')) and return
    end

    unless @contact.offers.count.zero?
      redirect_back(fallback_location: contacts_path,
                    alert: t('errors.cant_delete_contact_with_offers')) and return
    end

    @contact.destroy

    redirect_to contacts_path, status: :see_other
  end

Tenho métodos semelhantes em outros controladores em toda a minha aplicação. Talvez haja um padrão para refatorar esses tipos de métodos?

ruby-on-rails
  • 3 3 respostas
  • 37 Views

3 respostas

  • Voted
  1. janpeterka
    2025-03-06T23:43:57+08:002025-03-06T23:43:57+08:00

    Sempre há (especialmente com Ruby) muitas maneiras de estruturar código. Aqui está minha abordagem e o que considero melhorias, mas suas opiniões e preferências podem ser diferentes. Além disso, você pode decidir ignorar o Rubocop. Este aviso não diz que é um código errado, apenas que talvez seja possível escrevê-lo melhor.

    Código original

    def destroy
      unless Current.user.default_entity.owner == Current.user ||
              Current.user.default_entity.user_privileged?('manage_contacts')
    
        redirect_back(fallback_location: contacts_path, alert: t('errors.no_access_rights')) and return
      end
    
      unless @contact.invoices.count.zero?
        redirect_back(fallback_location: contacts_path,
                      alert: t('errors.cant_delete_contact_with_invoices')) and return
      end
    
      unless @contact.offers.count.zero?
        redirect_back(fallback_location: contacts_path,
                      alert: t('errors.cant_delete_contact_with_offers')) and return
      end
    
      @contact.destroy
    
      redirect_to contacts_path, status: :see_other
    end
    

    Variação 1

    Vamos nos livrar da duplicação: podemos definir um alerta quando houver um problema e, se o definirmos, retornaremos e redirecionaremos.

    def destroy
      alert = nil
      unless Current.user.default_entity.owner == Current.user || Current.user.default_entity.user_privileged?('manage_contacts')
        alert = t('errors.no_access_rights')
      end
    
      unless @contact.invoices.count.zero?
        alert = t('errors.cant_delete_contact_with_invoices')
      end
    
      unless @contact.offers.count.zero?
        alert = t('errors.cant_delete_contact_with_offers')
      end
    
      return redirect_back(fallback_location: contacts_path, alert:) if alert
    
      @contact.destroy
    
      redirect_to contacts_path, status: :see_other
    end
    

    Na verdade, não tornamos o código mais curto ou menos ramificado, mas obtivemos algumas informações: há lógica para encontrar possíveis problemas e há duas maneiras pelas quais esse método termina: redirect_back com erro ou destruição do contato.

    Variação 2

    Vamos mover a configuração de alerta para um método privado separado, tornando a ação mais limpa

    def destroy
      return redirect_back(fallback_location: contacts_path, alert:) if alert
    
      @contact.destroy
    
      redirect_to contacts_path, status: :see_other
    end
    
    private
    
    def alert
      unless Current.user.default_entity.owner == Current.user || Current.user.default_entity.user_privileged?('manage_contacts')
        return t('errors.no_access_rights')
      end
    
      unless @contact.invoices.count.zero?
        return t('errors.cant_delete_contact_with_invoices')
      end
    
      unless @contact.offers.count.zero?
        return t('errors.cant_delete_contact_with_offers')
      end
    end
    

    O nome aqui pode não ser muito bom, mas foi apenas uma ideia rápida.

    Isso novamente melhorou a legibilidade do destroymétodo principal e tornou mais simples mover os detalhes, o que leva a:

    Variação 3

    Por que estamos verificando se o modelo pode ser excluído? O controlador não precisa saber disso, esse conhecimento possivelmente está no modelo. Além disso, os modelos ActiveRecord têm uma ótima maneira nativa de gerenciar validações e erros, o que nos ajudará a criar um ponto de extremidade Rails mais padrão. Aqui para referência - Documentação do Rails e Guia do Rails

    # app/models/contact.rb
    class Contact < ApplicationRecord
      ...
    
      before_destroy :validate_destruction, prepend: true
    
    
      private
    
      def validate_destruction
        unless Current.user.default_entity.owner == Current.user || Current.user.default_entity.user_privileged?('manage_contacts')
          errors.add t('errors.no_access_rights')
          return false
        end
    
        unless invoices.count.zero?
          errors.add t('errors.cant_delete_contact_with_invoices')
          return false
        end
    
        unless offers.count.zero?
          errors.add t('errors.cant_delete_contact_with_offers')
          return false
        end
      end
    end
    
    # app/controllers/contracts_controller.rb
    
    def destroy
      if  @contact.destroy
        redirect_to contacts_path, status: :see_other
      else
        redirect_back(fallback_location: contacts_path, alert:) if alert
      end
    end
    

    Agradável e limpo.

    Eu realmente não testei todo o código, então não garanto que funcione exatamente dessa maneira, estou apenas tentando apontar a direção

    Algumas reflexões gerais:

    • É sua decisão quanta lógica reside no controlador. No entanto, o código no controlador é muito mais difícil de testar e reutilizar. Ter código no modelo torna muito simples escrever testes unitários para Contact com estados diferentes, verificando se isso nos permitirá excluí-lo.
    • Existe até uma abordagem um pouco extrema: faça com que seus controladores sempre executem apenas uma ação em um objeto e retornem uma resposta ok ou não ok.
    • Pergunte "quem deve saber/fazer isso?". O controlador deve saber sobre o contato que tem faturas? Somente se for necessário. Aqui, não é.
    • Você sempre pode tentar mover o código, agrupá-lo em funções/métodos/ajudantes/.. e ver como fica. Experimente, brinque e tenha uma intuição para um bom código.
    • 2
  2. Best Answer
    max
    2025-03-07T03:37:32+08:002025-03-07T03:37:32+08:00

    Rubucop está certo em reclamar. A complexidade cíclica está, na verdade, indicando alguns problemas com esse código. Em geral, se seu método contiver mais de um return explícito, pare e refaça-o.

    1. A autorização é importante. Trate-a adequadamente.

    Fazer uma autorização "inline" dessa forma é uma péssima ideia:

    unless Current.user.default_entity.owner == Current.user || Current.user.default_entity.user_privileged?('manage_contacts')
        alert = t('errors.no_access_rights')
    end
    
    • Ele não protege adequadamente e impede futuras execuções quando não autorizado.
    • Você está repetindo a lógica de autorização.
    • Você está retornando o código de status errado, então o cliente acha que estava OK Dory, exceto pela mensagem flash. Isso é realmente ruim para testabilidade.
    • Há muitas peças penduradas para fora do modelo e muitas violações da lei de Deméter nessas três linhas.

    Embora a melhor solução seja adicionar uma camada de autorização como o Pundit, você deve pelo menos seguir o exemplo do Pundit/CanCan e gerar uma exceção quando a solicitação não for autorizada, para garantir que ela seja desativada e que quaisquer retornos de chamada futuros sejam interrompidos.

    # app/errors/authorization_error.rb
    class AuthorizationError < StandardError
    end
    
    class ContactsController
      # you probably want to reuse this for creating and editing
      before_action :authorize_contact, only: [:destroy]
    
      private
    
      def authorize_contact
        # This still stinks but fixing it completely is out of scope
        if entity_owner? || manage_contacts?
          @contact = Contact.find(params[:id])
        else
          raise AuthorizationError      
        end
      end
    
      def default_entity
        Current.user.default_entity
      end
    
      def entity_owner?
        default_entity.owner == Current.user
      end
    
      def manage_contacts?
       default_entity.user_privileged?('manage_contacts')
      end
    end
    
    class ApplicationController < ActionController::Base
      rescue_from AuthorizationError, with: :deny_access
    
      def current_user
        Current.user
      end 
    
      def deny_access
        # either redirect to the login or render an error page
        render plain: "Oh uh. You can't do that silly bear!",
          status: :forbidden
      end
    end
    

    Como bônus adicional, você pode ignorar rescue_from em seus testes/especificações para afirmar/esperar que uma exceção seja gerada.

    Melhor ainda seria extrair Current.user.default_entity.owner == Current.user || Current.user.default_entity.user_privileged?('manage_contacts')para que seu controlador não tenha muito conhecimento dos modelos. O Pundit faz isso com classes Policy que você pode emular com um PORO.

    2. Você está tornando mais difícil do que deveria ser

    Em vez de apenas assumir que @contact.destroyterá sucesso, basta verificar o valor de retorno. Se a destruição falhar, essas restrict_withassociações de erro preencherão o objeto de erros.

    E assim como ao criar/editar o objeto, você pode usá-los para fornecer feedback ao usuário. Com a diferença aqui de que você quer colocá-los no flash ("alerta" é realmente apenas uma tecla no flash) em vez de exibi-los em um formulário.

    class ContactsController < ApplicationController
      before_action :authorize_contact, only: [:destroy]
    
      def destroy
        if @contact.destroy
          redirect_to contacts_path, status: :see_other
        else
          flash[:alert] = @contact.errors.full_messages.join(', ')
          redirect_back(fallback_location: contacts_path)
        end
      end
    end
    

    Como alternativa, em vez da concatenação de strings da mensagem flash, você pode usar uma matriz.

    class ContactsController < ApplicationController
      before_action :authorize_contact, only: [:destroy]
    
      def destroy
        if @contact.destroy
          redirect_to contacts_path, status: :see_other
        else
          flash[:alert] = @contact.errors.full_messages
          redirect_back(fallback_location: contacts_path)
        end
      end
    
      # ...
    end
    

    No entanto, isso exigirá algumas alterações no seu layout para lidar com a exibição de mensagens flash do array, o que deixo para o leitor.

    • 1
  3. Jasjeet Singh
    2025-03-06T15:51:27+08:002025-03-06T15:51:27+08:00

    Você pode refatorar seu método destroy usando um before_action ou um método auxiliar que retorna um valor booleano indicando se a exclusão deve prosseguir. Você pode usar um método de cláusula guard que retorna true se a exclusão for bloqueada e executa o redirecionamento dentro dela.

    before_action :authorize_destroy, only: :destroy
    before_action :check_dependent_records, only: :destroy
    
    def destroy
      @contact.destroy
      redirect_to contacts_path, status: :see_other
    end
    
    private
    
    def authorize_destroy
      return if Current.user.default_entity.owner == Current.user ||
                Current.user.default_entity.user_privileged?('manage_contacts')
    
      redirect_back(fallback_location: contacts_path, alert: t('errors.no_access_rights')) and return
    end
    
    def check_dependent_records
      if @contact.invoices.exists?
        redirect_back(fallback_location: contacts_path, alert: t('errors.cant_delete_contact_with_invoices')) and return
      end
    
      if @contact.offers.exists?
        redirect_back(fallback_location: contacts_path, alert: t('errors.cant_delete_contact_with_offers')) and return
      end
    end

    • -1

relate perguntas

  • Exibir informações do servidor Rails no Active Admin

  • Grape api (rails) - constante não inicializada Endpoints::TodoAPI (NameError)

  • Qual retorno de chamada devo usar para obter o valor anterior?

  • Rails - Pare de servir qualquer visualização de front-end

  • Obtendo erro de método indefinido em ruby ​​on rails enquanto o método é definido

Sidebar

Stats

  • Perguntas 205573
  • respostas 270741
  • best respostas 135370
  • utilizador 68524
  • Highest score
  • respostas
  • Marko Smith

    Reformatar números, inserindo separadores em posições fixas

    • 6 respostas
  • Marko Smith

    Por que os conceitos do C++20 causam erros de restrição cíclica, enquanto o SFINAE antigo não?

    • 2 respostas
  • Marko Smith

    Problema com extensão desinstalada automaticamente do VScode (tema Material)

    • 2 respostas
  • Marko Smith

    Vue 3: Erro na criação "Identificador esperado, mas encontrado 'import'" [duplicado]

    • 1 respostas
  • Marko Smith

    Qual é o propósito de `enum class` com um tipo subjacente especificado, mas sem enumeradores?

    • 1 respostas
  • Marko Smith

    Como faço para corrigir um erro MODULE_NOT_FOUND para um módulo que não importei manualmente?

    • 6 respostas
  • Marko Smith

    `(expression, lvalue) = rvalue` é uma atribuição válida em C ou C++? Por que alguns compiladores aceitam/rejeitam isso?

    • 3 respostas
  • Marko Smith

    Um programa vazio que não faz nada em C++ precisa de um heap de 204 KB, mas não em C

    • 1 respostas
  • Marko Smith

    PowerBI atualmente quebrado com BigQuery: problema de driver Simba com atualização do Windows

    • 2 respostas
  • Marko Smith

    AdMob: MobileAds.initialize() - "java.lang.Integer não pode ser convertido em java.lang.String" para alguns dispositivos

    • 1 respostas
  • Martin Hope
    Fantastic Mr Fox Somente o tipo copiável não é aceito na implementação std::vector do MSVC 2025-04-23 06:40:49 +0800 CST
  • Martin Hope
    Howard Hinnant Encontre o próximo dia da semana usando o cronógrafo 2025-04-21 08:30:25 +0800 CST
  • Martin Hope
    Fedor O inicializador de membro do construtor pode incluir a inicialização de outro membro? 2025-04-15 01:01:44 +0800 CST
  • Martin Hope
    Petr Filipský Por que os conceitos do C++20 causam erros de restrição cíclica, enquanto o SFINAE antigo não? 2025-03-23 21:39:40 +0800 CST
  • Martin Hope
    Catskul O C++20 mudou para permitir a conversão de `type(&)[N]` de matriz de limites conhecidos para `type(&)[]` de matriz de limites desconhecidos? 2025-03-04 06:57:53 +0800 CST
  • Martin Hope
    Stefan Pochmann Como/por que {2,3,10} e {x,3,10} com x=2 são ordenados de forma diferente? 2025-01-13 23:24:07 +0800 CST
  • Martin Hope
    Chad Feller O ponto e vírgula agora é opcional em condicionais bash com [[ .. ]] na versão 5.2? 2024-10-21 05:50:33 +0800 CST
  • Martin Hope
    Wrench Por que um traço duplo (--) faz com que esta cláusula MariaDB seja avaliada como verdadeira? 2024-05-05 13:37:20 +0800 CST
  • Martin Hope
    Waket Zheng Por que `dict(id=1, **{'id': 2})` às vezes gera `KeyError: 'id'` em vez de um TypeError? 2024-05-04 14:19:19 +0800 CST
  • Martin Hope
    user924 AdMob: MobileAds.initialize() - "java.lang.Integer não pode ser convertido em java.lang.String" para alguns dispositivos 2024-03-20 03:12:31 +0800 CST

Hot tag

python javascript c++ c# java typescript sql reactjs html

Explore

  • Início
  • Perguntas
    • Recentes
    • Highest score
  • tag
  • help

Footer

AskOverflow.Dev

About Us

  • About Us
  • Contact Us

Legal Stuff

  • Privacy Policy

Language

  • Pt
  • Server
  • Unix

© 2023 AskOverflow.DEV All Rights Reserve