Principles of Package Design

Retired

This book is no longer available for sale.

Principles of Package Design

Preparing your code for reuse
  • 723

    Readers

  • 268

    Pages

  • English

  • PDF

  • EPUB

  • MOBI

  • WEB

About the Book

In Principles of Package Design Matthias Noback tells you everything about designing software components, also known as packages. In the first part you'll revisit the SOLID principles of class design. They will help you prepare your classes for use in packages. The second part covers the important, yet lesser known package design principles. When you've finished this book, you'll be ready to design packages that have high cohesion, low coupling and are at the same time user- and maintainer-friendly.

This book has been revised and then republished by Apress. From now on you can order it from them: https://www.apress.com/us/book/9781484241189

About the Author

Matthias Noback
Matthias Noback

Matthias Noback has been building web applications since 2003. He is the author of Principles of Package Design and Object Design Style Guide and Advanced Web Application Architecture. He is a regular blogger, public speaker and trainer.

Table of Contents

  • Introduction
    • The situation
    • Overview of the contents
    • Notes about the code samples
    • Thank you
  • Class design
    • Introduction
      • SOLID principles
      • Why follow the principles?
      • Prepare for change
    • The Single responsibility principle
      • A class with too many responsibilities
      • Responsibilities are reasons to change
      • Refactoring: using collaborator classes
      • Advantages of having a single responsibility
      • A small peek ahead: common closure
    • The Open/closed principle
      • A class that is closed for extension
      • Refactoring: abstract factory
      • Refactoring: making the abstract factory open for extension
      • Refactoring: polymorphism
      • Conclusion
        • Packages need classes that are open for extension
    • The Liskov substitution principle
      • Violation: a derived class does not have an implementation for all methods
      • Violation: different substitutes return things of different types
      • Violation: a derived class is less permissive with regard to method arguments
      • Violation: secretly programming a more specific type
      • Conclusion
    • The Interface segregation principle
      • Violation: leaky abstractions
        • Refactoring: create separate interfaces and use multiple inheritance
          • What did we do?
      • Violation: multiple use cases
        • Refactoring: separate interfaces and multiple inheritance
      • Violation: no interface, just a class
        • Implicit changes in the implicit interface
        • Refactoring: add header and role interfaces
    • The Dependency inversion principle
      • Example of dependency inversion: the FizzBuzz generator
        • Making the FizzBuzz class open for extension
        • Removing the specificness from the FizzBuzz class
      • Violation: a high-level class depends upon a low-level class
        • Refactoring: abstractions and concretions both depend on abstractions
      • Violation: a class depends upon a class from another package
        • Solution: add an abstraction and remove the dependency using composition
      • Conclusion
        • Peeking ahead: abstract dependencies
  • Package design
    • Principles of cohesion
        • Becoming a programmer
        • The hardest part
      • Cohesion
        • Class design principles benefit cohesion
        • Package design principles, part I: Cohesion
    • The Release/reuse equivalence principle
      • Keep your package under version control
      • Add a package definition file
      • Use semantic versioning
        • Design for backward compatibility
          • Rules of thumb
            • Don’t throw anything away
            • When you rename something, add a proxy
            • Only add parameters at the end and with a default value
            • Methods should not have side effects
            • Dependency versions should be permissive
            • Use objects instead of primitive values
            • Use private object properties and methods for information hiding
            • Use object factories
            • And so on
      • Add meta files
        • README and documentation
          • Installation and configuration
          • Usage
          • Extension points
          • Limitations (optional)
        • License
        • Change log
      • Quality control
        • Quality from the user’s point of view
        • What the package maintainer needs to do
          • Add tests
      • Conclusion
    • The Common reuse principle
      • Signs that the principle is being violated
        • Feature strata
          • Obvious stratification
          • Obfuscated stratification
        • Classes that can only be used when … is installed
          • Suggested refactoring
          • A package should be “linkable”
          • Cleaner releases
        • Bonus features
          • Suggested refactoring
          • Sub-packages
      • Conclusion
        • Guiding questions
        • When to apply the principle
        • When to violate the principle
        • Why not to violate the principle
    • The Common closure principle
      • A change in one of the dependencies
        • Assetic
      • A change in an application layer
        • FOSUserBundle
      • A change in the business
        • Sylius
      • The tension triangle of cohesion principles
    • Principles of coupling
      • Coupling
    • The Acyclic dependencies principle
      • Coupling: discovering dependencies
        • Different ways of package coupling
          • Composition
          • Inheritance
          • Implementation
          • Usage
          • Creation
          • Functions
          • Not to be considered: global state
        • Visualizing dependencies
      • The Acyclic dependencies principle
        • Nasty cycles
        • Cycles in a package dependency graph
          • Dependency resolution
          • Release management
          • Is it all that bad?
      • Solutions for breaking the cycles
        • Some pseudo-cycles and their dissolution
        • Some real cycles and their dissolution
          • Dependency inversion
          • Inversion of control
            • Mediator
            • Chain of responsibility
            • Mediator and chain of responsibility combined: an event system
      • Conclusion
    • The Stable dependencies principle
      • Stability
      • Not every package can be highly stable
      • Unstable packages should only depend on more stable packages
      • Measuring stability
      • Decreasing instability, increasing stability
      • Violation: your stable package depends on a third-party unstable package
        • Solution: use dependency inversion
      • A package can be both responsible and irresponsible
      • Conclusion
    • The Stable abstractions principle
      • Stability and abstractness
      • How to determine if a package is abstract
        • The A metric
      • Abstract things belong in stable packages
      • Abstractness increases with stability
      • The main sequence
      • Types of packages
        • Concrete, instable packages
        • Abstract, stable packages
        • Strange packages
      • Conclusion
    • Conclusion
      • Creating packages is hard
        • Reuse-in-the-small
        • Reuse-in-the-large
        • Embracing software diversity
        • Component reuse is possible, but requires more work
      • Creating packages is doable
        • Reducing the impact of the first rule of three
        • Reducing the impact of the second rule of three
      • Creating packages is easy?
  • Appendices
    • Appendix I: The full Page class

Other books by this author

A Year With Symfony
Matthias Noback
Un Año Con Symfony
Luis Cordova and Matthias Noback
Один год с Symfony
Matthias Noback and Dmitry Bykadorov
Microservices for everyone
Matthias Noback
Style Guide for Object Design
Matthias Noback
Advanced Web Application Architecture
Matthias Noback
PHP for the Web
Matthias Noback
PHP для веба
Matthias Noback and Alexey Pyltsyn

Authors have earned$10,052,337writing, publishing and selling on Leanpub, earning 80% royalties while saving up to 25 million pounds of CO2 and up to 46,000 trees.

Learn more about writing on Leanpub

The Leanpub 45-day 100% Happiness Guarantee

Within 45 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.

See full terms

Free Updates. DRM Free.

If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).

Most Leanpub books are available in PDF (for computers), EPUB (for phones and tablets) and MOBI (for Kindle). The formats that a book includes are shown at the top right corner of this page.

Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.

Learn more about Leanpub's ebook formats and where to read them

Write and Publish on Leanpub

You can use Leanpub to easily write, publish and sell in-progress and completed ebooks and online courses! Leanpub is a powerful platform for serious authors, combining a simple, elegant writing and publishing workflow with a store focused on selling in-progress ebooks. Leanpub is a magical typewriter for authors: just write in plain text, and to publish your ebook, just click a button. It really is that easy.

Learn more about writing on Leanpub

Top Books

  1. #1

    C++ Best Practices

    Jason Turner

    Level up your C++, get the tools working for you, eliminate common problems, and move on to more exciting things!

  2. #2

    Digital-First Events

    Joep Piscaer and Jana Boruta

    The only resource you will ever need to launch your digital events program.

  3. #3

    Algebra-Driven Design

    Sandy Maguire

    A how-to field guide on building leak-free abstractions and algebraically designing real-world applications.

  4. #4

    Ansible for DevOps

    Jeff Geerling

    Ansible is a simple, but powerful, server and configuration management tool. Learn to use Ansible effectively, whether you manage one server—or thousands.

  5. #5
  6. #6

    Continuous Delivery Pipelines

    Dave Farley

    This practical handbook provides a step-by-step guide for you to get the best continuous delivery pipeline for your software.

  7. #7

    Cloud Strategy

    Gregor Hohpe

    “Strategy is the difference between making a wish and making it come true.” A successful migration to the cloud can transform your organization, but it shouldn’t be driven by wishes. This book tells you how to develop a sound strategy guided by frameworks and decision models without being overly abstract nor getting lost in product details.

  8. #8

    node-opcua by example

    Etienne Rossignon

    Get the best out of node-opcua through a set of documented examples by the author himself that will allow you to create stunning OPCUA Servers or Clients.

  9. #9

    Technical leadership and the balance with agility

    Simon Brown

    A developer-friendly, practical and pragmatic guide to lightweight software architecture, technical leadership and the balance with agility.

  10. #10

    Everyday Rails - RSpecによるRailsテスト入門

    Junichi Ito (伊藤淳一), AKIMOTO Toshiharu, 魚振江, and Aaron Sumner

    RSpecを使ってRailsアプリケーションに信頼性の高いテストを書く実践的なアドバイスを提供します。詳細で丁寧な説明は本書のオリジナルコンテンツです。また、説明には実際に動かせるサンプルアプリケーションも使用します。本書は2017年版にアップデートされ、RSpec 3.6やRails 5.1といった新しい環境に対応しています！さあ、自信をもってテストできるようになりましょう！

Top Bundles

  1. #1

    Software Architecture for Developers: Volumes 1 & 2 - Technical leadership and communication

    2 Books

    "Software Architecture for Developers" is a practical and pragmatic guide to modern, lightweight software architecture, specifically aimed at developers. You'll learn:The essence of software architecture.Why the software architecture role should include coding, coaching and collaboration.The things that you really need to think about before...
  2. #2

    CCIE Service Provider Ultimate Study Bundle

    2 Books

    Piotr Jablonski, Lukasz Bromirski, and Nick Russo have joined forces to deliver the only CCIE Service Provider training resource you'll ever need. This bundle contains a detailed and challenging collection of workbook labs, plus an extensively detailed technical reference guide. All of us have earned the CCIE Service Provider certification...
  3. #3

    Modern C++ by Nicolai Josuttis

    2 Books

  4. #4

    Django for Beginners/APIs/Professionals

    3 Books

  5. #5

    Modern Management Made Easy

    3 Books

    Read all three Modern Management Made Easy books. Learn to manage yourself, lead and serve others, and lead the organization.
  6. #6

    Cisco CCNA 200-301 Complet

    4 Books

    Ce lot comprend les quatre volumes du guide préparation à l'examen de certification Cisco CCNA 200-301.
  7. #7

    Mastering Containers

    2 Books

    Docker and Kubernetes are taking the world by storm! These books will get you up-to-speed fast! Docker Deep Dive is over 400 pages long, and covers all objectives on the Docker Certified Associate exam.The Kubernetes Book includes everything you need to get up and running with Kubernetes!
  8. #8

    The Python Craftsman

    3 Books

    The Python Craftsman series comprises The Python Apprentice, The Python Journeyman, and The Python Master. The first book is primarily suitable for for programmers with some experience of programming in another language. If you don't have any experience with programming this book may be a bit daunting. You'll be learning not just a programming...
  9. #9

    CCDE Practical Studies (All labs)

    3 Books

    CCDE lab
  10. #10

    Linux Administration Complet

    4 Books

    Ce lot comprend les quatre volumes du Guide Linux Administration :Linux Administration, Volume 1, Administration fondamentale : Guide pratique de préparation aux examens de certification LPIC 1, Linux Essentials, RHCSA et LFCS. Administration fondamentale. Introduction à Linux. Le Shell. Traitement du texte. Arborescence de fichiers. Sécurité...

Publish Early, Publish Often

  • Path
  • There are many paths, but the one you're on right now on Leanpub is:
  • › Principles-of-package-design

Leanpub is copyright © 2010-2021 Ruboss Technology Corp. All rights reserved.