Everand Logo

Welcome to Everand!

  • Discover millions of ebooks, audiobooks, and so much more with a free trial

    Only $11.99/month after trial. Cancel anytime.

    Clean Ruby: A Guide to Crafting Better Code for Rubyists
    Clean Ruby: A Guide to Crafting Better Code for Rubyists
    Clean Ruby: A Guide to Crafting Better Code for Rubyists
    Ebook135 pages1 hour

    Clean Ruby: A Guide to Crafting Better Code for Rubyists

    By Carleton DiLeo

    ()

    Read preview

    About this ebook

    Learn how to make better decisions and write cleaner Ruby code. This book shows you how to avoid messy code that is hard to test and which cripples productivity. Author Carleton DiLeo shares hard-learned lessons gained from years of experience across numerous codebases both large and small. Each chapter covers the topics you need to know to make better decisions and optimize your productivity. Many books will tell you how to do something; this book will tell you why you should do it. Start writing code you love. 

    What You Will Learn

    • Build better classes to help promote code reuse
    • Improve your decision making and make better, smarter choices
    • Identify bad code and fixed it
    • Create quality names for all of your variables, classes, and modules
    • Write better, concise classes
    • Improve the quality of your methods
    • Properly use modules
    • Clarify your Boolean logic
    • See when and how you refactor
    • Improve your understanding of TDD and write better tests
    Who This Book Is For
    This book is written for Ruby developers. There is no need to learn a new language or translate concepts to Ruby.
    LanguageEnglish
    PublisherApress
    Release dateNov 29, 2019
    ISBN9781484255469
    Clean Ruby: A Guide to Crafting Better Code for Rubyists

    Related to Clean Ruby

    Related ebooks

    Programming For You

    View More
    View More

    Related podcast episodes

    Related articles

    • Article

      Get Into Coding!

      Aug 23, 2022

      Get Into Coding!
      1 min read

    • Article

      Rise Of The Robots

      Jan 12, 2021

      Rise Of The Robots
      7 min read

    • Article

      Set Up Your First Database

      Aug 25, 2020

      Set Up Your First Database
      1 min read

    • Article

      Mailserver

      Oct 19, 2021

      Mailserver
      3 min read

    • Article

      Linux From Scratch

      Feb 8, 2022

      Linux From Scratch
      8 min read

    • Article

      Security Cams

      Aug 7, 2020

      Security Cams
      2 min read

    • Article

      Workflow

      Nov 17, 2020

      Workflow
      3 min read

    • Article

      Common Errors

      Aug 27, 2019

      If you receive a ‘Script not found’ error, this probably means that you don’t have the mod scripts installed in your Minecraft directory. Check that you’ve replaced .minecraft with the one from McPiFoMo; this should include mcpipy, which will be full

      1 min read

    • Article

      How To Use Mojolicious For Web Scraping

      Mar 8, 2022

      Part One Don’t miss next issue! Subscribe on page 16 Mark Gardner is a software developer and blogger with over 25 years of IT experience. You can reach him at www.phoenixtrap.com and @markjgardner. The map function is designed to transform a list or

      5 min read

    • Article

      Rokoko Studio 2.0

      Feb 23, 2021

      Rokoko Studio 2.0
      1 min read

    • Article

      Improve Your Typing

      Dec 13, 2022

      GNU T YPIST Credit: www.gnu.org/software/gtypist OUR EXPERT Shashank Sharma is a trial lawyer in New Delhi and an avid Arch user. He’s quite happy with his typing speed, errors and all. Touch-typing is the ability to type without looking at the keybo

      5 min read

    • Article

      Linux From Scratch

      Mar 8, 2022

      Linux From Scratch
      9 min read

    • Article

      Plugins For Nnn

      Aug 10, 2020

      Nnn is tiny but highly extensible. There are several plugins available in the Git repo (check out the list at https://github.com/jarun/nnn/tree/ master/plugins, which also shows their dependencies), and even a script to install them easily. You can r

      1 min read

    • Article

      Build A Mac Server

      Sep 19, 2023

      Build A Mac Server
      10 min read

    • Article

      The State Of Linux Security

      Apr 7, 2020

      The State Of Linux Security
      1 min read

    • Article

      Newsdesk

      May 30, 2023

      Newsdesk
      2 min read

    • Article

      Orchestral Manoeuvres In The Docker

      Feb 9, 2021

      Jonni’s been arguing with me this issue – he thinks Linux Format readers don’t need virtual machine orchestration. Of course, as always, he’s right, but I’ve never let being wrong stop me before… Just because you don’t actually “need” something doesn

      1 min read

    • Article

      From Child Hacker To Bug Hunter

      Mar 19, 2020

      Why did you become a black hat hacker? At school I would finish my work in ten minutes and spend the rest of the lesson playing on the computer. I was 10 or 11 when I stumbled across a chatroom whose members taught me how to hack – I was just a bore

      1 min read

    • Article

      Orchestrating with Xen

      Feb 9, 2021

      The distinction between Type 1 hypervisors (being minimal OSes designed only to host VMs) and those of Type 2 (which run VMs inside a regular operating system) can get a little muddy. KVM, which userspace programs like VirtualBox and QEMU can use, mi

      2 min read

    • Article

      Client-free Remote Desktop Access For All

      Sep 24, 2019

      Guacamole is a open-source software project consisting of a client and server component that work together to enable remote connectivity to server environments from a web browser. In fact, this open-source project goes back as far as 2010, having spe

      9 min read

    • Article

      Meet The Team

      Oct 19, 2021

      Meet The Team
      1 min read

    Related categories

    Reviews for Clean Ruby

    0 ratings

    0 ratings0 reviews

    What did you think?

    Tap to rate

    Review must be at least 10 words

      Book preview

      Clean Ruby - Carleton DiLeo

      © Carleton DiLeo 2019

      C. DiLeoClean Rubyhttps://doi.org/10.1007/978-1-4842-5546-9_1

      1. The Qualities of Clean Code

      Carleton DiLeo¹ 

      (1)

      Boulder, CO, USA

      So what is clean code? If you ask three different developers, you will get three different answers. It’s a hard concept to define. You know clean code when you see it, as if written by a programming wizard from a distant land. We all want to write good code that others admire. Sometimes we don’t know where to start. How do we take our messy, unorganized code and turn it into something beautiful?

      Many factors determine clean code, but we will focus on these:

      Readable

      Easy to change

      Straightforward

      Examine code you’ve written. How many of those questions can you answer yes? It’s unlikely you said yes to all of them. It’s more realistic you said no to at least one or more. Even the most experienced developers have a hard time achieving this, so don’t worry. The skills required to create clean code take time and patience to learn. As you learn new techniques, try them in your code and pick the ones that work for you. There is trial and error involved, but this book will be your guide along the way.

      Readability

      Code readability describes the effort required to understand what a piece of code does. Readable code should be like a well-written book; it doesn’t expect you to dig into the details to discover its purpose. It should be easy to understand a variable’s meaning, or what a method will do when [^^Invoked]. With unreadable code, you must read multiple times before you get the meaning. After reading unreadable code, you have many questions. You will spend more time understanding it than changing it.

      Let’s start with a simple code example of code that is not readable:

      1   def method1(t, b)

      2    c = t + b

      3    return c

      4   end

      Examine the code and ask yourself the following questions:

      Is the code easy to understand?

      What does this code do?

      Several design decisions have made this small method hard to read. The method name is ambiguous, and the variable names are vague. These issues prevent us from understanding what the code is trying to do. This example may be extreme, but finding unreadable code like this in the wild is possible. It’s OK because with a little effort, this code will be so much better.

      Before we continue, let’s talk about variables. They are the storage containers of our application, which allow us to keep bits of information in memory for computation. A single application can have thousands of variables, but none should be superfluous. The earlier example has an extra variable, c, which is both nondescript and unnecessary; it decreases the readability of the method because it adds bloat. Code bloat is bad because a developer has to read more code than necessary.

      This is how we could rewrite the earlier example:

      1   def sum(a, b)

      2    a + b

      3   end

      This example is much easier to read. It does the same thing, but it has a better method name and better variable names that give clues on the code’s intent. The name sum tells the reader it will calculate the sum of its parameters, a and b. The method arguments, a and b, are short, but descriptive enough in this context. We removed the c variable and instead returned the result of our operation to the calling code. Ruby returns the last expression of a method, which means storing the result of a + b in a separate variable is redundant and unnecessary.

      What did we accomplish with this refactor? The new method is easy to read and comprehend with little effort. As a result, you spend less energy trying to understand the code and more effort adding new functionality. Next time you are programming, make sure you take the time to proofread what you wrote. Does the code need much effort to understand? Do variable names describe the data they represent and method names inform the reader of their intent? Make sure you don’t leave any room for doubt.

      Extensibility

      Code can change for various reasons: new product requirements, gems need upgrading to fix bugs, and old code gets refactored. As developers, we must adapt because code we are writing now will change. It’s important to prepare. The steps we take to make our code extensible will pay dividends later.

      During my career, I’ve used shortcuts to save time. I’ve convinced myself there wasn’t enough time to do it the right way. I often regretted my decision later. Taking more time to design an extensible solution, I would have produced code that was not so fragile and hard to change. Don’t make the same mistakes I’ve made. Think how your code might change and plan for

      Enjoying the preview?
      Page 1 of 1