Observers

Designing and Maintaining Software (DAMS)
 Louis Rose

Delivery people need to know when pizzas are ready class Pizza def initialize(delivery_person) @delivery_person = delivery_person end def bake cook # blocking call @delivery_person.deliver(self) end end

As does the web app.
 As does… class Pizza def initialize(delivery_person, website) @delivery_person = delivery_person @website = website end def bake cook # blocking call @delivery_person.deliver(self) @website.update_status(self, :baked) end end

How do we avoid this coupling?

Switch to a polling model? class Pizza def initialize @baked = false end def bake cook # blocking call @baked = true end def baked? @baked end end

class DeliveryPerson def wait_for_delivery(pizza) sleep(1) until pizza.baked? deliver(pizza) end def deliver(pizza) puts "Delivering #{pizza}" end end

DeliveryPerson is an observer class Pizza def observers @observers ||= [] end def add_observer(object, message=:update) observers << [object, message] end def bake cook # blocking call notify_observers(self) end def notify_observers(*args) observers.each do |object, message| object.send(message, *args) end end end

class DeliveryPerson def wait_for_delivery(pizza) pizza.add_observer(self, :deliver) end def deliver(pizza) puts "Delivering #{pizza}" end end

Ruby has an observer library require "observer" class Pizza include Observable def bake cook # blocking call changed notify_observers(self) end end

class DeliveryPerson def wait_for_delivery(pizza) pizza.add_observer(self, :deliver) end def deliver(pizza) puts "Delivering #{pizza}" end end

Don’t forget to call changed when using Observable!

A potential downside require "observer" class Pizza include Observable def bake cook # blocking call changed notify_observers(self) end end

class DeliveryPerson def wait_for_delivery(pizza) pizza.add_observer(self, :deliver) end def deliver(pizza) puts "Delivering #{pizza}" address = pizza.customer.address deadline = pizza.order.deadline collect(pizza.id) navigate_to(address, by: deadline) end end

A potential downside require "observer" class Pizza include Observable def bake cook # blocking call changed notify_observers(self) end end

class DeliveryPerson def wait_for_delivery(pizza) pizza.add_observer(self, :deliver) end def deliver(pizza) puts "Delivering #{pizza}" address = pizza.customer.address deadline = pizza.order.deadline collect(pizza.id) navigate_to(address, by: deadline) end end

Use a push model to avoid coupling the observer to the observable’s API

Pull model require "observer" class Pizza include Observable def bake cook # blocking call changed notify_observers(self) end end

class DeliveryPerson def wait_for_delivery(pizza) pizza.add_observer(self, :deliver) end def deliver(pizza) puts "Delivering #{pizza}" address = pizza.customer.address deadline = pizza.order.deadline collect(pizza.id) navigate_to(address, by: deadline) end end

Push model require "observer" class Pizza include Observable def bake cook # blocking call changed address = customer.address deadline = order.deadline notify_observers(id, address, deadline) end end

class DeliveryPerson def wait_for_delivery(pizza) pizza.add_observer(self, :deliver) end def deliver(id, address, deadline) puts "Delivering #{pizza}" collect(id) navigate_to(address, by: deadline) end end

Pull vs Push Pull

Push

notify_observers(self)

notify_observers(data, more_data, …)

Observable is not coupled to the data needed by the observers

Observers are not coupled to the observable’s API

Prefer when: observers require
 different sets of data

Prefer when: all observers require same data and observers can be reused

Callback style
 (Lightweight, multimodal observers)

class Pizza def observers @observers ||= Hash.new { |h,k| h[k] = [] } end def before_baking(&callback) observers[:before_baking] << callback end def after_baking(&callback) observers[:after_baking] << callback end def bake notify_observers(:before_baking, self) cook # blocking call notify_observers(:after_baking, self) end def notify_observers(event, *args) observers[event].each do |o| o.call(args) end end end

class Website def track(pizza) pizza.before_baking do |pizza| update_status_page(pizza, "in the oven") end pizza.after_baking do |pizza| update_status_page(pizza, "on its way") end end end

Summary Use observers to avoid coupling an object to
 other objects that care about its state Push observers avoid coupling the observers to the observable’s API. Pull observers facilitate lots of different types of observer. Callbacks are lightweight and multimodal
 observers that are fairly popular in Ruby code

Designing and Maintaining Software (DAMS) - GitHub

Observers. Designing and Maintaining Software (DAMS). Louis Rose. Page 2. Page 3. Delivery people need to know when pizzas are ready class Pizza def initialize(delivery_person). @delivery_person = delivery_person end def bake cook # blocking call. @delivery_person.deliver(self) end end. Page 4. class Pizza.

2MB Sizes 0 Downloads 266 Views

Recommend Documents

Designing and Maintaining Software (DAMS) - GitHub
ASTs are tree data structures that can be analysed for meaning (following JLJ in SYAC 2014/15) ... More Cohesive. Avoids Duplication. Clearer. More Extensible.

Designing and Maintaining Software (DAMS) - GitHub
Open-source. Influenced by Perl, Smalltalk, Eiffel, Ada and Lisp. Dynamic. Purely object-oriented. Some elements of functional programming. Duck-typed class Numeric def plus(x) self.+(x) end end y = 5.plus(6) https://www.ruby-lang.org/en/about · http

Designing and Maintaining Software (DAMS) - GitHub
Page 1. Getting Lean. Designing and Maintaining Software (DAMS). Louis Rose. Page 2. Lean software… Has no extra parts. Solves the problem at hand and no more. Is often easier to change (i.e., is more habitable). Page 3. The Advice I Want to Give.

Designing and Maintaining Software (DAMS) - GitHub
Why not duplicate? Designing and Maintaining Software (DAMS). Louis Rose. Page 2. Habitable Software. Leaner. Less Complex. Loosely Coupled. More Cohesive. Avoids Duplication. Clearer. More Extensible ??? Page 3. Bad Practice. Page 4. Don't Repeat Yo

Designing and Maintaining Software (DAMS) - GitHub
“We have tried to demonstrate that it is almost always incorrect to begin the decomposition of a system into modules on the basis of a flowchart. We propose instead that one begins with a list of difficult design decisions or design decisions which

Designing and Maintaining Software (DAMS) - GitHub
Tools: Vagrant. Designing and Maintaining Software (DAMS). Louis Rose. Page 2. Bugs that appear in production and that can't be reproduced by a developer on their machine are really hard to fix. Problem: “It works on my machine”. Page 3. Why does

Designing and Maintaining Software (DAMS) - GitHub
Clear Documentation. Designing and Maintaining Software (DAMS). Louis Rose. Page 2. Bad documentation. Misleading or contradictory find_customer(id). CustomerGateway. Used to look up a customer by their customer number. Page 3. Bad documentation. Red

Designing and Maintaining Software (DAMS) - GitHub
%w.rack tilt date INT TERM..map{|l|trap(l){$r.stop}rescue require l};. $u=Date;$z=($u.new.year + 145).abs;puts "== Almost Sinatra/No Version has taken the stage on #$z for development with backup from Webrick". $n=Module.new{extend. Rack;a,D,S,q=Rack

Designing and Maintaining Software (DAMS) - GitHub
R&D: sketch habitable solutions on paper, using UML. 4. Evaluate solutions and implement the best, using TDD. Probably start again at 3. 5. Give to the product owner to validate. Probably start again at 1. 6. Put into production for customers to eval

Designing and Maintaining Software (DAMS) - GitHub
Habitable Software. Leaner. Less Complex. Loosely Coupled. More Cohesive. Avoids Duplication. Clearer. More Extensible ??? Page 3. Lean. “Perfection is finally achieved not when there is no longer anything to add, but when there is no longer anythi

Designing and Maintaining Software (DAMS) - GitHub
Fixes issue #42. Users were being redirected to the home page after login, which is less useful than redirecting to the page they had originally requested before being redirected to the login form. * Store requested path in a session variable. * Redi

Designing and Maintaining Software (DAMS) - GitHub
Designing and Maintaining Software (DAMS). Louis Rose ... Loosely coupled software is… Flexible: the ... http://www.objectmentor.com/resources/articles/dip.pdf ... Monthly. Sales. Reporting. Sales. Data. Provider. MySQL. Database. Access ...

Designing and Maintaining Software (DAMS) - GitHub
What is it? Several pieces of data are often used together. Why is it problematic? Behaviour that operates on the clump has no home. (and consequently is often duplicated). When does it arise? High cohesion of the clump has not been detected. D

Designing and Maintaining Software (DAMS) - GitHub
“We want the reading of code to be easy, even it makes the writing harder. (Of course, there's no way to write code without also reading it, so…)” - Bob Martin. Clean Code. Prentice Hall, 2009. Page 5. Page 6. User Experience. “A person of av

Designing and Maintaining Software (DAMS) - GitHub
Getting loose coupling. Designing and Maintaining Software (DAMS). Louis Rose ... should not depend on low-level modules. Both should depend on abstractions.” “Abstractions should not depend on details. Details should depend on abstractions.” -

Designing and Maintaining Software (DAMS) - GitHub
Automatically detect similar fragments of code. class StuffedCrust def title. "Stuffed Crust " +. @toppings.title +. " Pizza" end def cost. @toppings.cost + 6 end end class DeepPan def title. "Deep Pan " +. @ingredients.title +. " Pizza" end def cost

Designing and Maintaining Software (DAMS) - GitHub
Ruby Testing Frameworks. 3 popular options are: RSpec, Minitest and Test::Unit. We'll use RSpec, as it has the most comprehensive docs. Introductory videos are at: http://rspec.info ...

Designing and Maintaining Software (DAMS) - GitHub
Clear Names. Designing and Maintaining Software (DAMS). Louis Rose. Page 2. Naming is hard. “There are only two hard things in Computer. Science: cache invalidation and naming things.” - Phil Karlton http://martinfowler.com/bliki/TwoHardThings.ht

Designing and Maintaining Software (DAMS) - GitHub
Coupling Between Objects. Counts the number of other classes to which a class is coupled (other than via inheritance). CBO(c) = |d ∈ C - (1cl U Ancestors(C))| uses(c, d) V uses(d, c). - Chidamber and Kemerer. A metrics suite for object-oriented des

Designing and Maintaining Software (DAMS) - GitHub
Reducing duplication. Designing and Maintaining Software (DAMS). Louis Rose. Page 2. Tactics. Accentuate similarities to find differences. Favour composition over inheritance. Know when to reach for advanced tools. (metaprogramming, code generation).

Designing and Maintaining Software (DAMS) - GitHub
Plug-ins. Designing and Maintaining Software (DAMS). Louis Rose. Page 2. Problem. Page 3. Current Architecture. Shareable. Likeable. Food. Pizza. Liking and sharing foods are primary business concerns, so shouldn't be implemented as delegators. Page

Designing and Maintaining Software (DAMS) - GitHub
When we are testing the way that a unit behaves when a condition is met, use a stub to setup the condition. Solution: use stubs for queries class Subscription ... def bill(amount) unless payments.exists(subscription_id: id) payments.charge(subscripti

Designing and Maintaining Software (DAMS) - GitHub
Getting Cohesion. Designing and Maintaining Software (DAMS). Louis Rose. Page 2. Single Responsibility. Principle. A class should have only one reason to change. - Martin and Martin. Chapter 8, Agile Principles, Patterns and Practices in C#, Prentice

Designing and Maintaining Software (DAMS) - GitHub
Size != Complexity. “Imagine a small (50 line) program comprising. 25 consecutive "IF THEN" constructs. Such a program could have as many as 33.5 million distinct control paths.” - Thomas J. McCabe. IEEE Transactions on Software Engineering, 2:4,