Build Awesome Command-Line Applications in Ruby · Control Your Computer, Simplify Your Life by Copeland, David B. -- Read -- Imperial Library of Trantor

Index

Build Awesome Command-Line Applications in Ruby Table of Contents What Readers Are Saying About Build Awesome Command-Line Applications in Ruby Introduction

How This Book Is Organized Who This Book Is For What You’ll Need Conventions Used in the Book Online Resources Acknowledgments

Chapter 1: Have a Clear and Concise Purpose

1.1 Problem 1: Backing Up Data 1.2 Problem 2: Managing Tasks 1.3 What Makes an Awesome Command-Line App 1.4 Moving On

Chapter 2: Be Easy to Use

2.1 Understanding the Command Line: Options, Arguments, and Commands 2.2 Building an Easy-to-Use Command-Line Interface 2.3 Building an Easy-to-Use Command-Suite Interface 2.4 Moving On

Chapter 3: Be Helpful

3.1 Documenting a Command-Line Interface 3.2 Documenting a Command Suite 3.3 Including a Man Page 3.4 Writing Good Help Text and Documentation 3.5 Moving On

Chapter 4: Play Well with Others

4.1 Using Exit Codes to Report Success or Failure 4.2 Using the Standard Output and Error Streams Appropriately 4.3 Formatting Output for Use As Input to Another Program 4.4 Trapping Signals Sent from Other Apps 4.5 Moving On

Chapter 5: Delight Casual Users

5.1 Choosing Names for Options and Commands 5.2 Choosing Default Values for Flags and Arguments 5.3 Deciding Default Behavior 5.4 Moving On

Chapter 6: Make Configuration Easy

6.1 Why External Configuration? 6.2 Reading External Configuration from Files 6.3 Using Configuration Files with Command Suites 6.4 Design Considerations When Using Configuration 6.5 Moving On

Chapter 7: Distribute Painlessly

7.1 Distributing with RubyGems 7.2 Distributing Without RubyGems 7.3 Collaborating with Other Developers 7.4 Moving On

Chapter 8: Test, Test, Test

8.1 Testing User Behavior with Acceptance Tests 8.2 Testing in Isolation with Unit Tests 8.3 A Word About Test-Driven Development 8.4 Moving On

Chapter 9: Be Easy to Maintain

9.1 Dividing Code into Multiple Files 9.2 Designing Code for Maintainability 9.3 Moving On

Chapter 10: Add Color, Formatting, and Interactivity

10.1 Adding Color Using ANSI Escape Sequences 10.2 Formatting Output with Tables 10.3 Providing Interactive User Input with readline 10.4 Moving On

Appendix 1: Common Command-Line Gems and Libraries

A1.1 Alternatives for Simple Command-Line Apps A1.2 Alternatives for Command Suites A1.3 Other Relevant Libraries

Appendix 2: Bibliography