Slide 1

Slide 1 text

Design Principles behind

Slide 2

Slide 2 text

I am José Valim @josevalim

Slide 3

Slide 3 text

I work at blog.plataformatec.co

Slide 4

Slide 4 text

Core Team Member

Slide 5

Slide 5 text

Rails 3

Slide 6

Slide 6 text

SOLID Design

Slide 7

Slide 7 text

No content

Slide 8

Slide 8 text

•Single Responsibility Principle •Open/closed Principle •Liskov Substitution

Slide 9

Slide 9 text

Single Responsibility Principle

Slide 10

Slide 10 text

“A class should have one, and only one, reason to change” - Uncle Bob

Slide 11

Slide 11 text

Example: Views Refactoring

Slide 12

Slide 12 text

0.x ActionView::Base tracking details finding templates compiling templates rendering templates rendering context Controller Render Contents

Slide 13

Slide 13 text

1.0 ActionView::Base tracking details finding templates rendering templates rendering context Controller Render Contents Template Template handler compiling templates

Slide 14

Slide 14 text

builder, rjs, haml...

Slide 15

Slide 15 text

2.2 ActionView::Base tracking details rendering templates rendering context Controller Render Contents Template Template handler compiling templates View paths hold filesystem paths finding templates

Slide 16

Slide 16 text

Rails Engines!

Slide 17

Slide 17 text

3.0 ActionView::Base tracking details rendering templates rendering context Controller Render Contents Template Template handler compiling templates View paths hold resolvers Resolvers finding templates

Slide 18

Slide 18 text

The resolver object no longer restricts templates to the filesystem

Slide 19

Slide 19 text

class BasicController < ActionController::Base self.view_paths = [ ActionView::FixtureResolver.new( "basic/hello_world.html.erb" => "Hello world!" ) ] def hello_world render :action => "hello_world" end end

Slide 20

Slide 20 text

You can create your own abstractions, allowing you to read templates from the database!

Slide 21

Slide 21 text

3.0 ActionView::Base tracking details rendering templates rendering context Controller Render Contents Template Template handler compiling templates View paths hold resolvers Resolvers finding templates

Slide 22

Slide 22 text

3.0 ActionView::Base rendering templates rendering context Controller Render Contents Template Template handler compiling templates View paths hold resolvers Resolvers finding templates Lookup context tracking details

Slide 23

Slide 23 text

3.1 Controller Template Template handler compiling templates View paths hold resolvers Resolvers finding templates Lookup context tracking details AV::Renderer rendering templates ActionView::Base rendering context

Slide 24

Slide 24 text

def lookup_context ActionView::LookupContext.new(self.class._view_paths) end def view_renderer ActionView::Renderer.new(lookup_context) end def _render_template(options) view_renderer.render(view_context, options) end

Slide 25

Slide 25 text

def view_context ActionView::Base.new(view_renderer, view_assigns, self) end

Slide 26

Slide 26 text

Maybe templates could be rendered in the controller context?

Slide 27

Slide 27 text

class BasicController < ActionController::Base include ActionView::Context # STEP 1 before_filter :_prepare_context # STEP 2 def hello_world @value = "Hello" end protected def view_context # STEP 3 self end def __controller_method__ "controller context!" end end

Slide 28

Slide 28 text

# app/views/basic/hello_world.html.erb <%= @value %> from <%= __controller_method__ %> # would return... Hello from controller context!

Slide 29

Slide 29 text

3.1 Controller Template Template handler compiling templates View paths hold resolvers Resolvers finding templates Lookup context tracking details AV::Renderer rendering templates ActionView::Base rendering context

Slide 30

Slide 30 text

Top-down comprehension Worse Maintainability Better Focused comprehension Much Better Extensibility POSSIBLE!

Slide 31

Slide 31 text

Open/closed Principle

Slide 32

Slide 32 text

“You should be able to extend a class behavior without modifying it” - Uncle Bob

Slide 33

Slide 33 text

Open for extension, closed for modification

Slide 34

Slide 34 text

class ApplicationController < ActionController::Base end

Slide 35

Slide 35 text

Easy to follow because Ruby classes are all open for extensions...

Slide 36

Slide 36 text

... but easy to violate because they are not closed for modification.

Slide 37

Slide 37 text

# In your initializer ... config.active_record.table_name_prefix = “foo” # Then ... ActiveRecord::Base.table_name_prefix #=> “foo”

Slide 38

Slide 38 text

class ApplicationModel < ActiveRecord::Base end

Slide 39

Slide 39 text

class MyApp::ApplicationModel < ActiveRecord::Base end

Slide 40

Slide 40 text

Dependency Inversion

Slide 41

Slide 41 text

“Depend on abstractions, not on concretions” - Uncle Bob

Slide 42

Slide 42 text

def initialize(app:

Slide 43

Slide 43 text

def initialize(app)

Slide 44

Slide 44 text

@rack_app.call

Slide 45

Slide 45 text

1) Define

Slide 46

Slide 46 text

match “/foo”, to:

Slide 47

Slide 47 text

match “/foo”, to: match “/foo”, to: PostsController.action

Slide 48

Slide 48 text

3.1 Controller Template Template handler compiling templates View paths hold resolvers Resolvers finding templates Lookup context tracking details AV::Renderer rendering templates ActionView::Base rendering context

Slide 49

Slide 49 text

@resolver.find_all( name, prefix, partial, details, key, locals

Slide 50

Slide 50 text

@haml_handler.call

Slide 51

Slide 51 text

2) Remove hardcoded dependencies

Slide 52

Slide 52 text

class PostsController < ApplicationController use ActiveRecord::IdentityMap::Middleware, :only => :index # ... end # And this builds the middleware stack ... PostsController.action(:index)

Slide 53

Slide 53 text

def self.action(name) middleware_stack.build(name.to_s) do |env| new.dispatch(name, ActionDispatch::Request.new(env)) end end

Slide 54

Slide 54 text

def self.action(name, klass = ActionDispatch::Request) middleware_stack.build(name.to_s) do |env| new.dispatch(name, klass.new(env)) end end

Slide 55

Slide 55 text

3) Define hooks

Slide 56

Slide 56 text

1) Load console on sandbox rails console --sandbox 2) Internally... require “rails/console/ sandbox”

Slide 57

Slide 57 text

ActiveRecord::Base.connection.increment_open_transactions ActiveRecord::Base.connection.begin_db_transaction at_exit do ActiveRecord::Base.connection.rollback_db_transaction ActiveRecord::Base.connection.decrement_open_transactions end

Slide 58

Slide 58 text

Instead provide a hook...

Slide 59

Slide 59 text

class ActiveRecord::Railtie < Rails::Railtie console do |sandbox| if sandbox require "active_record/railties/console_sandbox" end ActiveRecord::Base.logger = Logger.new(STDERR) end end

Slide 60

Slide 60 text

Liskov Substitution Principle

Slide 61

Slide 61 text

“Derived classes must be substitutable for their base classes” - Uncle Bob

Slide 62

Slide 62 text

“Derived classes must be substitutable for their base classes” - Uncle Bob

Slide 63

Slide 63 text

@rack_app.call •Receives a hash •Returns an array with status code, headers and an object that responds

Slide 64

Slide 64 text

Define substitutable but also don’t violate the principle

Slide 65

Slide 65 text

Datamapper x Active Record

Slide 66

Slide 66 text

Active Model User.model_name user.persisted? user.valid? user.errors user.to_key user.to_param

Slide 67

Slide 67 text

How do we ensure substitutability?

Slide 68

Slide 68 text

ActiveModel::Lint::Tests

Slide 69

Slide 69 text

class LintTest < ActiveSupport::TestCase include ActiveModel::Lint::Tests def setup @model = SomeDatamapperModel.new end end

Slide 70

Slide 70 text

Interface Segregation Principle

Slide 71

Slide 71 text

“Make fine grained interfaces that are client specific” - Uncle Bob

Slide 72

Slide 72 text

“Clients should depend on as narrow protocol as possible” - Jim Weirich

Slide 73

Slide 73 text

Active Model User.model_name user.persisted? user.valid? user.errors user.to_key user.to_param

Slide 74

Slide 74 text

How do we ensure a narrow protocol?

Slide 75

Slide 75 text

class MyPost < ActiveRecord::Base end my_post = MyPost.new assert_equal "my_posts/1", url_for(my_post)

Slide 76

Slide 76 text

my_post = Mock.new my_post.stubs(:model_name).returns("MyPost") my_post.stubs(:to_param).returns(2) assert_equal "my_posts/1", url_for(my_post)

Slide 77

Slide 77 text

Code to well- defined and narrow protocols

Slide 78

Slide 78 text

No content

Slide 79

Slide 79 text

No content

Slide 80

Slide 80 text

Questions? José Valim @josevalim blog.plataformatec.com

Slide 81

Slide 81 text

Questions? blog twitter ID José Valim @josevalim blog.plataformatec.com