Clean Functions and Methods in Ruby

Welcome to your next step in mastering Clean Code! 🚀 Previously, we emphasized the significance of naming conventions in clean coding. Now, we delve into the realm of functions and methods, which serve as the backbone of application logic and are crucial for code organization and execution. Structuring these functions effectively is vital for enhancing the clarity and maintainability of a codebase. In this lesson, we'll explore best practices and techniques to ensure our code remains clean, efficient, and readable.

Let's outline the key principles for writing clean functions:

• Keep functions small. Small functions are easier to read, comprehend, and maintain.
• Focus on a single task. A function dedicated to one task is more reliable and simpler to debug.
• Limit arguments to three or fewer. Excessive arguments complicate the function signature and make it difficult to understand and use.
• Avoid boolean flags. Boolean flags can obscure the code's purpose; consider separate methods for different behaviors.
• Eliminate side effects. Functions should avoid altering external state or depending on external changes to ensure predictability.
• Implement the DRY principle. Employ helper functions to reuse code, minimizing redundancy and enhancing maintainability.

Now, let's take a closer look at each of these rules.

Functions should remain small, and if they become too large, consider splitting them into multiple, focused functions. While there's no fixed rule on what counts as large, a common guideline is around 15 to 25 lines of code, often defined by team conventions.

Below, you can see the process_order method, which is manageable but has the potential to become unwieldy over time:

def process_order(order, inventory, logger)
  # Step 1: Validate the order
  unless order.valid?
    logger.log('Invalid Order')
    return
  end

  # Step 2: Process payment
  unless order.process_payment
    logger.log('Payment failed')
    return
  end

  # Step 3: Update inventory
  inventory.update(order.items)

  # Step 4: Notify customer
  order.notify_customer

  # Step 5: Log order processing
  logger.log('Order processed successfully')
end

Given that this process involves multiple steps, it can be improved by extracting each step into a dedicated private method, as shown below:

def process_order(order, inventory, logger)
  return unless validate_order(order, logger)
  return unless process_payment(order, logger)

  update_inventory(order, inventory)
  notify_customer(order)
  log_order_processing(logger)
end

private

def validate_order(order, logger)
  if order.valid?
    true
  else
    logger.log('Invalid Order')
    false
  end
end

def process_payment(order, logger)
  if order.process_payment
    true
  else
    logger.log('Payment failed')
    false
  end
end

def update_inventory(order, inventory)
  inventory.update(order.items)
end

def notify_customer(order)
  order.notify_customer
end

def log_order_processing(logger)
  logger.log('Order processed successfully')
end

A function should embody the principle of doing one thing only. If a function handles multiple responsibilities, it may include several logical sections. Below you can see the save_and_notify_user method, which is both too lengthy and does multiple different things at once:

def save_and_notify_user(user, data_source, web_client)
  # Save user to the database
  sql = "INSERT INTO users (name, email) VALUES (?, ?)"

  data_source.get_connection do |connection|
    statement = connection.prepare(sql)
    statement.execute(user.name, user.email)
  end

  # Send a welcome email to the user
  response = web_client.post('/sendWelcomeEmail', user)
  raise 'Failed to send email' unless response.successful?
end

To enhance this code, you can create two dedicated methods for saving the user and sending the welcome email, resulting in dedicated responsibilities for each method and clearer code coordination:

def save_and_notify_user(user, data_source, web_client)
  save_user(user, data_source)
  notify_user(user, web_client)
end

private

def save_user(user, data_source)
  sql = "INSERT INTO users (name, email) VALUES (?, ?)"

  data_source.get_connection do |connection|
    statement = connection.prepare(sql)
    statement.execute(user.name, user.email)
  end
end

def notify_user(user, web_client)
  response = web_client.post('/sendWelcomeEmail', user)
  raise 'Failed to send email' unless response.successful?
end

Try to keep the number of function arguments to a maximum of three, as having too many can make functions less understandable and harder to use effectively. 🤔

Consider the save_address method below with five arguments, which makes the function less clean:

def save_address(street, city, state, zip_code, country)
  # Logic to save address
end

A cleaner version encapsulates the details into a hash, reducing the number of arguments and making the method signature clearer:

def save_address(address)
  # Logic to save address using address hash
end

Boolean flags in functions can create confusion, as they often suggest multiple pathways or behaviors within a single function. Instead, use separate methods for distinct behaviors. 🚫

The set_flag method below uses a boolean flag to indicate user status, leading to potential complexity:

def set_flag(user, is_admin)
  # Logic based on flag
end

A cleaner approach is to have distinct methods representing different behaviors:

def grant_admin_privileges(user)
  # Logic for admin rights
end

def revoke_admin_privileges(user)
  # Logic to remove admin rights
end

A side effect occurs when a function modifies some state outside its scope or relies on something external. This can lead to unpredictable behavior and reduce code reliability.

Below, the add_to_total method demonstrates a side effect by modifying an external state:

# Not Clean - Side Effect
def add_to_total(value)
  @total += value # modifies external state
  @total
end

A cleaner version, calculate_total, performs the operation without altering any external state:

# Clean - No Side Effect 🌟
def calculate_total(initial, value)
  initial + value
end

Avoid code repetition by introducing helper methods to reduce redundancy and improve maintainability.

The print_user_info and print_manager_info methods below repeat similar logic, violating the DRY principle. Here, user and manager are instances of classes with the attributes name and email:

def print_user_info(user)
  puts "Name: #{user.name}"
  puts "Email: #{user.email}"
end

def print_manager_info(manager)
  puts "Name: #{manager.name}"
  puts "Email: #{manager.email}"
end

To adhere to the DRY principles, use a generalized print_info method that operates on a parent Person type. Here, user, manager, and person are instances of classes that share common attributes name and email, allowing them to be used interchangeably in this context:

def print_info(person)
  puts "Name: #{person.name}"
  puts "Email: #{person.email}"
end

In this lesson, we learned that clean functions are key to maintaining readable and maintainable code. By keeping functions small, adhering to the Single Responsibility Principle, limiting arguments, avoiding side effects, and embracing the DRY principle, you set a strong foundation for clean coding. Next, we'll practice these principles to further sharpen your coding skills! 🎓