Fat Models Aren't Enough - RailsConf

Fat Models Arent Enough
Jeff Casimir / @j3
learn by doing
Tuesday, May 17, 2011
Best Practices
Refactoring by Hamlet DArcy

Don't touch anything that doesn't have [good test] coverage. Otherwise, you're not refactoring; you're just changing shit.
3
Refactoring by Hamlet DArcy

Question, Object, & Suggest

Skinny Controllers, Fat Models

Jamis Buck, October 2006
When rst getting started with Rails, it is tempting to shove lots of logic in the view.
A better way is to move as much of the logic as possible into the controller.
If we push that code into the model, we... slim down the controller document the operation by naming the method
The Rails Stack
The Rails Stack

Request Response
Router
View
Controller
Model
Database
10
Beautiful Views are HTML

11
Beautiful Actions are 8 simple lines

12
Beautiful Models are Organized

13
Fat Models Arent Enough

Why Bother?
14
15
Ideas for discussion

Presenter Pattern Better Rails through Better Ruby

15
Ideas for discussion

The Presenter Pattern
17
Presenter Pattern, Formally

Adaptation of the Decorator Pattern Wrapper that adds non-mutator methods

17
Presenter Pattern, Formally

18
Presenter Pattern, As I See It

Object-based shepherd of presentation Understands the mixing of one or more objects
18
Presenter Pattern, As I See It

In Need of a Presenter
/app/controllers/reports_controller.rb
def show @student = Student.find params[:student_id] @term = Term.find params[:term_id] @report_type = ReportType.find params[:report_type_id] end
19
/app/views/reports/show.html.haml
%h1= "#{@student.last_name}, #{@student.first_name}" %h2= "#{@report_type.report_title} for #{@term.start_date} to #{@term.end_date}" - @student.courses.each do |course| - course_report = @student.report_data_for_course(course) = render :partial => "course_report", :locals => {:course_report => course_report}
1a. Build Presenter

/app/presenters/student_report.rb
20
1a. Build Presenter

class StudentReport attr_reader :student, :term, :report_type
20
1a. Build Presenter

class StudentReport attr_reader :student, :term, :report_type delegate :start_date, :end_date, :to => :term delegate :first_name, :last_name, :courses, :report_data_for_course, :to => :student delegate :report_title, :to => :report_type
20
1a. Build Presenter

class StudentReport attr_reader :student, :term, :report_type delegate :start_date, :end_date, :to => :term delegate :first_name, :last_name, :courses, :report_data_for_course, :to => :student delegate :report_title, :to => :report_type def initialize(params) @student = Student.find params[:student_id] @term = Term.find params[:term_id] @report_type = ReportType.find params[:report_type_id] end end
20
1a. Build Presenter

class StudentReport attr_reader :student, :term, :report_type delegate :start_date, :end_date, :to => :term delegate :first_name, :last_name, :courses, :report_data_for_course, :to => :student delegate :report_title, :to => :report_type def initialize(params) @student = Student.find params[:student_id] @term = Term.find params[:term_id] @report_type = ReportType.find params[:report_type_id] end end
20
1a. Build Presenter

class StudentReport delegate :start_date, :end_date, :to => :term delegate :first_name, :last_name, :courses, :report_data_for_course, :to => :student delegate :report_title, :to => :report_type def initialize(params) @student = Student.find params[:student_id] @term = Term.find params[:term_id] @report_type = ReportType.find params[:report_type_id] end end
20
1b. Use the Presenter

def show @student = Student.find params[:student_id] @term = Term.find params[:term_id] @report_type = ReportType.find params[:report_type_id] end
21

def show @report = StudentReport.new(params) end
21

21
%h1= "#{@report.last_name}, #{@report.first_name}" %h2= "#{@report.report_title} for #{@report.start_date} to # {@report.end_date}" - @report.courses.each do |course| - course_report = @report.report_data_for_course(course) = render :partial => "course_report", :locals => {:course_report => course_report}
2b. Presenter as Engine

22

22
class StudentReport # ...initialize and term/course delegators delegate :first_name, :last_name, :courses, :to => :student

22
class StudentReport # ...initialize and term/course delegators delegate :first_name, :last_name, :courses, :to => :student def course_reports courses.collect do |c| @student.report_data_for_course(c) end end end
2b. Defer to Engine

23
%h1= "#{@report.last_name}, #{@report.first_name}" %h2= "#{@report.report_title} for #{@report.start_date} to # {@report.end_date}" - @report.courses.each do |course| - course_report = @report.report_data_for_course(course) = render :partial => "course_report", :locals => {:course_report => course_report}
2b. Defer to Engine

23
%h1= "#{@report.last_name}, #{@report.first_name}" %h2= "#{@report.report_title} for #{@report.start_date} to # {@report.end_date}" - @report.courses.each do |course| - course_report = @report.report_data_for_course(course) = render :partial => "course_report", :locals => {:course_report => course_report} = render :partial => 'course_report', :collection => @report.course_reports
2b. Defer to Engine

23
%h1= "#{@report.last_name}, #{@report.first_name}" %h2= "#{@report.report_title} for #{@report.start_date} to # {@report.end_date}" = render :partial => 'course_report', :collection => @report.course_reports
2b. Defer to Engine

23
%h1= "#{@report.last_name}, #{@report.first_name}" %h2= "#{@report.report_title} for #{@report.start_date} to # {@report.end_date}" = render @report.course_reports
Asks each element for its ClassName Renders the partial with that name and sets the local variable
3a. Compute in Engine

24

24
class StudentReport # ...initialize and term/course delegators delegate :first_name, :last_name, :courses, :to => :student def course_reports courses.collect do |c| @student.report_data_for_course(c) end end
end

24
class StudentReport # ...initialize and term/course delegators delegate :first_name, :last_name, :courses, :to => :student def course_reports courses.collect do |c| @student.report_data_for_course(c) end end
end

24
class StudentReport # ...initialize and term/course delegators delegate :first_name, :last_name, :courses, :to => :student def course_reports courses.collect do |c| @student.report_data_for_course(c) end end def report_data_for_course(course) # Compute the report data end end

24
class StudentReport # ...initialize and term/course delegators delegate :first_name, :last_name, :courses, :to => :student def course_reports courses.collect do |c| report_data_for_course(c) end end def report_data_for_course(course) # Compute the report data end end
4. Canonical Data
%h1= "#{@report.last_name}, #{@report.first_name}" %h2= "#{@report.report_title} for #{@report.start_date} to #{@report.end_date}" = render @report.course_reports
25
class StudentReport # ...initialize, delegates, data calculators
@report.name
end
4. Canonical Data
%h1= "#{@report.last_name}, #{@report.first_name}" %h2= "#{@report.report_title} for #{@report.start_date} to #{@report.end_date}" = render @report.course_reports
25
class StudentReport # ...initialize, delegates, data calculators def student_name [last_name, first_name].join(", ") end @report.name
end
4. Canonical Data
%h1= @report.student_name %h2= "#{@report.report_title} for #{@report.start_date} to #{@report.end_date}" = render @report.course_reports
25
class StudentReport # ...initialize, delegates, data calculators def student_name [last_name, first_name].join(", ") end @report.name
end
4. Canonical Data
%h1= @report.student_name %h2= "#{@report.report_title} for #{@report.start_date} to #{@report.end_date}" = render @report.course_reports
25
class StudentReport # ...initialize, delegates, data calculators def student_name [last_name, first_name].join(", ") end @report.name def title "#{report_title} for #{start_date} to #{end_date}" end end
4. Canonical Data
%h1= @report.student_name %h2= @report.title = render @report.course_reports
25
class StudentReport # ...initialize, delegates, data calculators Or maybe a decorator? def student_name [last_name, first_name].join(", ") end @report.name def title "#{report_title} for #{start_date} to #{end_date}" end end
5. End State Review
26
5. End State Review

26
5. End State Review

26
5. End State
27
5. End State
/app/presenters/student_report.rb ( rst half)
27
class StudentReport delegate :start_date, :end_date, :to => :term delegate :first_name, :last_name, :courses, :to => :student delegate :report_title, :to => :report_type def initialize(params) @student = Student.find params[:student_id] @term = Term.find params[:term_id] @report_type = ReportType.find params[:report_type_id] end def student_name [last_name, first_name].join(", ") end #...continued
5. End State
/app/presenters/student_report.rb (second half)
28
5. End State
/app/presenters/student_report.rb (second half)
#...continued def title "#{report_title} for #{start_date} to #{end_date}" end def course_reports courses.collect do |c| report_data_for_course(c) end end private def report_data_for_course(course) # Compute the report data end end
28
Afterthoughts
29
Afterthoughts
Did you just obliterate MVC?
29
Afterthoughts
Did you just obliterate MVC? Why not just use helpers?
29
Afterthoughts
Did you just obliterate MVC? Why not just use helpers? They suck
29
Afterthoughts
Did you just obliterate MVC? Why not just use helpers? They suck Objects are not scary
29
Afterthoughts
Did you just obliterate MVC? Why not just use helpers? They suck Objects are not scary Using Rails helpers is ok!
29
Better Rails through Better Ruby
31
A signicant percentage of Rails programmers are not Ruby programmers.

(my theory)
31
Dont Repeat Yourself (DRY)

Dont copy and paste code. Dave Thomas & Andy Hunt

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system. Dave Thomas & Andy Hunt
Real-World DRY: Sort
33

class StudentsController < ApplicationController def index case params[:sort_by] when "last_name" then @students = Student.all.order(:last_name) when "first_name" then @students = Student.all.order(:first_name) else @students = Student.all end end end
33
Typical Param-Handling Action


class StudentsController < ApplicationController def index case params[:sort_by] when "last_name" then @students = Student.all.order(:last_name) when "first_name" then @students = Student.all.order(:first_name) else @students = Student.all end end end
33
Typical Param-Handling Action

34

class StudentsController < ApplicationController def index @students = case params[:sort_by] when "last_name" then Student.all.order(:last_name) when "first_name" then Student.all.order(:first_name) else Student.all end end end
34
Simple DRY Improvement

35

class StudentsController < ApplicationController def index @students = Student.all_by(params[:sort_by]) end end
35

class StudentsController < ApplicationController def index @students = Student.all_by(params[:sort_by]) end end
35
class Student < ActiveRecord::Base def self.all_by(param) case param when "last_name" then order(:last_name) when "first_name" then order(:first_name) else order(:id) end end Thinking about scope? end
Real DRY Progress

Give me a minute.
Real-World DRY: Setters
36

class StudentsController < ApplicationController def create @student = Student.new(params[:student]) @student.created_by = current_user @student.lunch_id = LunchTracker.new @student.lunch_balance = 0 # redirects, etc end end
36
Action Setting Attributes

37

class StudentsController < ApplicationController def create @student = Student.new(params, current_user) # redirects, etc end end
37

class StudentsController < ApplicationController def create @student = Student.new(params, current_user) # redirects, etc end end class Student < ActiveRecord::Base def initialize(params, creator) self.created_by = creator self.lunch_id = LunchTracker.new self.lunch_balance = LunchTracker::STARTING_BALANCE super end end
37
Trying to Encapsulate Creation

38

class StudentsController < ApplicationController def create @student = current_user.students.new(params) # redirects, etc end end
38
Build Through the Relationship


class StudentsController < ApplicationController def create @student = current_user.students.new(params) # redirects, etc end end class Student < ActiveRecord::Base def initialize(params = nil) self.lunch_id = LunchTracker.new self.lunch_balance = LunchTracker::STARTING_BALANCE super end end
38
Build Through the Relationship

39
Single Responsibility Principle

Every object should have a single responsibility, and that responsibility should be entirely encapsulated by the class.
39
Single Responsibility Principle

40

class Student < ActiveRecord::Base def initialize(params = nil) self.lunch_id = LunchTracker.new self.lunch_balance = LunchTracker::STARTING_BALANCE super end end
40
SRP Cleanup

class Student < ActiveRecord::Base def initialize(params = nil) self.lunch_id = LunchTracker.new self.lunch_balance = LunchTracker::STARTING_BALANCE super end end
40
SRP Cleanup

class Student < ActiveRecord::Base def initialize(params = nil) self.lunch_id = LunchTracker.new super end end
40
self.lunch_balance = LunchTracker::STARTING_BALANCE
SRP Cleanup

class Student < ActiveRecord::Base def initialize(params = nil) self.lunch_id = LunchTracker.new super end end
40
SRP Cleanup
41

class Student < ActiveRecord::Base def initialize(params=nil) self.lunch_id = LunchTracker.new super end end
41
More Repetition

class Student < ActiveRecord::Base has_one :lunch, :class_name => 'LunchTracker' def initialize(params=nil) self.lunch_id = LunchTracker.new super end end
41
More Repetition

class Student < ActiveRecord::Base has_one :lunch, :class_name => 'LunchTracker' def initialize(params=nil) self.lunch_id = LunchTracker.new super end end
41
More Repetition

class Student < ActiveRecord::Base has_one :lunch, :class_name => 'LunchTracker' def initialize(params=nil) self.build_lunch super end end
41
More Repetition
42

class StudentsController < ApplicationController def create @student = Student.new(params[:student]) @student.created_by = current_user @student.lunch_id = LunchTracker.new @student.lunch_balance = 0 # redirects, etc end end
42
Start / End Review


class StudentsController < ApplicationController def create @student = current_user.students.new(params) # redirects, etc end end class Student < ActiveRecord::Base has_one :lunch, :class_name => 'LunchTracker' def initialize(params = nil) self.build_lunch super end end
42
Start / End Review

Signs of SRP Violations
43
Methods that do too much Symptom: Your method is longer than 8 lines Solution: refactor with extract method
43
43
Methods located in the wrong object Symptom: reaching too deeply into child objects / Law of Demeter Solution: refactor with move method
43
Methods located in the wrong object Symptom: reaching too deeply into child objects / Law of Demeter Solution: refactor with move method Magic Numbers, copy text, and conguration data Solution: introduce constants or a cong object
Scopes are Dead
Why We Loved Scopes
45
Simple Scope in Rails 3
46
Simple Scope in Rails 3

class Student < ActiveRecord::Base scope :active, where(:inactive => false) end
46
Quick and Easy

A Gotcha Scenario
47
A Gotcha Scenario

Frank creates a migration adding the inactive eld to Student Frank writes a scope like this:
scope :active, where(:inactive => false)
47
Frank checks in his code, woohoo! Lucy checks out Franks code Lucy runs rake db:migrate
A Gotcha Scenario

Frank creates a migration adding the inactive eld to Student Frank writes a scope like this:
scope :active, where(:inactive => false)
47
Frank checks in his code, woohoo! Lucy checks out Franks code Lucy runs rake db:migrate
d in xe
!!! sh ra
2 3.0.
Scope with Parameters
48
Scope with Parameters

class Student < ActiveRecord::Base scope :starts_with, lambda { |fragment| where("last_name LIKE ?%", fragment) } end
48
Lambda ZOMG!
AREL and Lazy Evaluation
49
Scopes & Lambdas
50
Scopes & Lambdas
50
Scopes & Lambdas
50
We dont need scopes, just write good Ruby.
51
We dont need scopes, just write good Ruby.

class Student < ActiveRecord::Base def self.starts_with(fragment) where("last_name LIKE ?%", fragment) end end
51
Class Methods > Scopes

Wrap Up
52
Wrap Up

Use presenters as an abstraction layer between views and models DRY isnt about copy & paste, its about knowledge Forget scopes, you dont need them! Embrace Ruby
52
learn by doing
Jeff Casimir @j3
53
54
Writing Better Instructions

Every instruction added is technical debt accumulated.
54
Writing Better Instructions

Less code is less debt
55
self is rarely necessary
55

self is rarely necessary return is rarely necessary
55

self is rarely necessary return is rarely necessary Master collection operations including: each, collect/map, select, detect, merge
55

self is rarely necessary return is rarely necessary Master collection operations including: each, collect/map, select, detect, merge Take advantage of return values from all statements, even if, case, while
55
Method Naming
56
Method Naming
56
Names matter Express meaning, imply the return type and quantity
Method Naming

56
Names matter Express meaning, imply the return type and quantity Follow Ruby naming conventions Solutions: if it changes the data, end in ! if it returns a boolean, end in ?
Method Naming

56
Names matter Express meaning, imply the return type and quantity Follow Ruby naming conventions Solutions: if it changes the data, end in ! if it returns a boolean, end in ? Physically organize methods within a model...
Collecting Class Methods

class Student class << self def search(params) # Class Method 1 end def random # Class Method 2 end end def to_s # Instance Method 1 end def <=>(other) # Instance Method 2 end end
57
Collecting Class Methods

class Student class << self def search(params) # Class Method 1 end def random # Class Method 2 end end
57
def to_s # Instance Method 1 end def <=>(other) # Instance Method 2 end end
Dene class methods within a single subclass

Fat Models Aren&#39;t Enough - RailsConf

Diunggah oleh

Informasi Dokumen

Deskripsi Asli:

Hak Cipta

Format Tersedia

Bagikan dokumen Ini

Bagikan atau Tanam Dokumen

Opsi Berbagi

Apakah menurut Anda dokumen ini bermanfaat?

Apakah konten ini tidak pantas?

Hak Cipta:

Format Tersedia

Fat Models Aren&#39;t Enough - RailsConf

Diunggah oleh

Hak Cipta:

Format Tersedia

Fat Models Arent Enough

Jeff Casimir / @j3

Tuesday, May 17, 2011

Refactoring by Hamlet DArcy

Refactoring by Hamlet DArcy

Question, Object, & Suggest

Tuesday, May 17, 2011

Skinny Controllers, Fat Models

Tuesday, May 17, 2011

Tuesday, May 17, 2011

Tuesday, May 17, 2011

Tuesday, May 17, 2011

Tuesday, May 17, 2011

Tuesday, May 17, 2011

Tuesday, May 17, 2011

The Rails Stack

Tuesday, May 17, 2011

The Rails Stack

Tuesday, May 17, 2011

Beautiful Views are HTML

Beautiful Actions are 8 simple lines

Beautiful Models are Organized