Beautiful Code in Rails 3 by Gregg Pollack Starting a new app New - - PowerPoint PPT Presentation

▶
beautiful code in rails 3
SMART_READER_LITE
LIVE PREVIEW

Beautiful Code in Rails 3 by Gregg Pollack Starting a new app New - - PowerPoint PPT Presentation

Mar 30, 2024 129 likes •599 views

Beautiful Code in Rails 3 by Gregg Pollack Starting a new app New Router API ActionController - respond_with ActionMailer Syntax ActiveRelation (arel) ERB Strings Escaped Unobtrusive Javascript Starting a New App $ rails Usage: rails

slide-1
SLIDE 1

Beautiful Code in Rails 3

Starting a new app New Router API ActionController - respond_with ActionMailer Syntax ActiveRelation (arel) ERB Strings Escaped Unobtrusive Javascript

Gregg Pollack

by

slide-2
SLIDE 2

$ rails

Starting a New App

Usage: rails APP_PATH [options] Options: ‐O, [‐‐skip‐activerecord] # Skip ActiveRecord files ‐r, [‐‐ruby=PATH] # Path to the Ruby binary of your choice # Default: /Users/greggpollack/.rvm/rubies/ruby‐1.8.7‐p248/bin/ruby ‐T, [‐‐skip‐testunit] # Skip TestUnit files ‐G, [‐‐skip‐git] # Skip Git ignores and keeps ‐m, [‐‐template=TEMPLATE] # Path to an application template ‐d, [‐‐database=DATABASE] # Preconfigure for selected database [‐‐edge] # Setup the application with Gemfile # pointing to Rails repository [‐‐dev] # Setup the application with Gemfile pointing to your rails checkout ‐J, [‐‐skip‐prototype] # Skip Prototype files

slide-3
SLIDE 3

$ rails test_app create create README create .gitignore ... $ rails Usage: rails COMMAND [ARGS] The most common rails commands are: generate Generate new code (short‐cut alias: "g") console Start the Rails console (short‐cut alias: "c") server Start the Rails server (short‐cut alias: "s") dbconsole Start a console for the database specified in config/database.yml (short‐cut alias: "db") In addition to those, there are: application Generate the Rails application code destroy Undo code generated with "generate" benchmarker See how fast a piece of code runs profiler Get profile information from a piece of code plugin Install a plugin runner Run a piece of code in the application environment All commands can be run with ‐h for more information.

$ ls script/ rails

$ cd test_app/

slide-4
SLIDE 4

script/generate script/console script/server

  • ld scripts

new hotness script/dbconsole rails g rails c rails s rails db

slide-5
SLIDE 5

script/generate script/console script/server

  • ld scripts

new hotness script/dbconsole

alias r='rails'

r g r c r s r db

slide-6
SLIDE 6

New Router API

slide-7
SLIDE 7

TestApp::Application.routes.draw do |map| end

config/routes.rb

resources :posts map.

New Routing API

slide-8
SLIDE 8

TestApp::Application.routes.draw do |map| end

config/routes.rb

resources :posts

New Routing API

slide-9
SLIDE 9

map.resources :posts do |post| post.resources :comments end resources :posts do resources :comments end

New Routing API

Rails 2 Rails 3

slide-10
SLIDE 10

map.resources :posts, :member => { :confirm => :post, :notify => :post } do |post| post.resources :comments, :member => { :preview => :post }, :collection => { :archived => :get } end

resources :posts do member do post :confirm get :notify end resources :comments do member do post :preview end collection do get :archived end end end resources :posts do member do post :confirm get :notify end resources :comments do post :preview, :on => :member get :archived, :on => :collection end end

Rails 2 Rails 3 Rails 3

New Routing API

slide-11
SLIDE 11

map.connect 'login', :controller => 'session', :action => 'new' match 'login' => 'session#new'

Rails 2 Rails 3

map.login 'login', :controller => 'session', :action => 'new' match 'login' => 'session#new', :as => :login

Rails 2 Rails 3

Named Route

login_path

slide-12
SLIDE 12

map.root :controller => "users"

Rails 2 Rails 3

root :to => "users#index" map.connect ':controller/:action/:id' map.connect ':controller/:action/:id.:format'

Rails 2 Rails 3

match ':controller(/:action(/:id(.:format)))'

Legacy Route

(commented out by default)

New Routing API

slide-13
SLIDE 13

http://guides.rails.info/routing.html

For more information

slide-14
SLIDE 14

Starting a new app New Router API ActionController - respond_with ActionMailer Syntax ActiveRelation (arel) ERB Strings Escaped Unobtrusive Javascript

#Rails3OMGPonies!

Beautiful Code in Rails 3

slide-15
SLIDE 15

class UsersController < ApplicationController

Regular Syntax

New ActionController Syntax

do |format| format.html # show.html.erb format.xml { render :xml => @user } end respond_to do |format| format.html format.xml { render :xml => @users.to_xml } end respond_to def index @users = User.all end ... end def show @user = User.find(params[:id])

slide-16
SLIDE 16

class UsersController < ApplicationController

New ActionController Syntax

respond_to respond_to def index @users = User.all end ... end :html, :xml, :json respond_with(@users) respond_with(@user) def show @user = User.find(params[:id])

Improved Syntax

slide-17
SLIDE 17

ActionMailer

M i k e l L i n d s a a r

slide-18
SLIDE 18

New ActionMailer Syntax

create app/models/user_mailer.rb

Rails 2 Rails 3

$script/generate mailer UserMailer welcome forgot_password create app/mailers/user_mailer.rb $r g mailer UserMailer welcome forgot_password

slide-19
SLIDE 19

New ActionMailer Syntax

Rails 2 Rails 3

def welcome(user, subdomain) subject 'Welcome to TestApp' recipients user.email from 'admin@testapp.com' body :user => user, :subdomain => subdomain end def welcome(user, subdomain) @user = user @subdomain = subdomain mail(:from => "admin@testapp.com", :to => user.email, :subject => "Welcome to TestApp") end

UserMailer.deliver_welcome(user, subdomain) UserMailer.welcome(user, subdomain).deliver

slide-20
SLIDE 20

New ActionMailer Syntax

Rails 3

class UserMailer < ActionMailer::Base def welcome(user, subdomain) @user = user @subdomain = subdomain mail(:to => @user.email, :subject => "Welcome to TestApp") end end attachments['test.pdf'] = File.read("#{Rails.root}/public/test.pdf") do |format| format.html { render 'other_html_welcome' } format.text { render 'other_text_welcome' } end default :from => "admin@testapp.com" welcome.text.erb welcome.html.erb

Defaults

slide-21
SLIDE 21

ActiveRelation

replaces the internal ad-hoc query generation with query generation based on relational algebra.

Nick Kallen

slide-22
SLIDE 22

@posts = Post.find(:all, :conditions => {:published => true})

@posts = Post.where(:published => true)

returns an ActiveRecord::Relation returns an Array of Posts immediately queries the db doesn’t query the db

Rails 2 Rails 3

ActiveRelation

slide-23
SLIDE 23

@posts = Post.where(:published => true) if params[:order] @posts = @posts.order(params[:order]) end @posts.each do |p| ... end

Query runs here ActiveRelation

Lazy Loading

slide-24
SLIDE 24

@posts = Post.where(:published => true) if params[:order] @posts = @posts.order(params[:order]) end @posts = Post.where(:published => true) @posts = @posts.order(params[:order]) @posts = Post.where(:published => true).order(params[:order])

We can refactor!

slide-25
SLIDE 25

@posts = Post.where(:published => true).order(params[:order]) posts = Post.order(params[:order]) @published = posts.where(:published => true) @unpublished = posts.where(:published => false)

This is obviously a bad example (should be using named routes)

@published = Post.published @unpublished = Post.unpublished

ActiveRelations can be Shared

slide-26
SLIDE 26

@published = Post.published @unpublished = Post.unpublished @published = Post.published @unpublished = Post.unpublished

class Post < ActiveRecord::Base default_scope :order => 'title' named_scope :published, :conditions => {:published => true} named_scope :unpublished, :conditions => {:published => false} end

class Post < ActiveRecord::Base default_scope order('title') scope :published, where(:published => true) scope :unpublished, where(:published => false) end

Rails 2 Rails 3

ActiveRelation

slide-27
SLIDE 27

where(:conditions) having(:conditions) select group

  • rder

limit

  • ffset

joins includes(:include) lock readonly from

New Finder Methods ActiveRelation

slide-28
SLIDE 28

Post.find(:all, :conditions => {:author => "Joe"}, :includes => :comments, :order => "title", :limit => 10) Post.where(:author => "Joe").include(:comments).order(:title).limit(10)

ActiveRelation

Rails 2 Rails 3 Remember, this version doesn’t do the query immediately

slide-29
SLIDE 29

Starting a new app New Router API ActionController - respond_with ActionMailer Syntax ActiveRelation (arel) ERB Strings Escaped Unobtrusive Javascript

#Rails3OMGPonies!

Beautiful Code in Rails 3

slide-30
SLIDE 30

ActiveRecord

Erubis is a fast, secure, and very extensible implementation of ERB

ActiveRelation ActionView Erubis

Use of external libraries

slide-31
SLIDE 31

Cross-Site Scripting (XSS)

<%= @post.body %>

Rails 2 Rails 3

<%= h @post.body %>

Rails 2

<%= raw @post.body %> <%= @post.body %>

Rails 3

(unsafe) (unsafe) (safe) (safe)

slide-32
SLIDE 32

data-method data-confirm data-remote

Adopting Unobtrusive Javascript

data-disable-with

HTML 5 custom data attributes

Custom data attributes are intended to store custom data private to the page or application, for which there are no more appropriate attributes or elements

data-*

slide-33
SLIDE 33

<%= link_to_remote 'Show', :url => post %> <%= link_to 'Show', post, :remote => true %>

<a href="#" onclick="new Ajax.Request('/posts/1', {asynchronous:true, evalScripts:true, parameters:'authenticity_token=' + encodeURIComponent('9sk..44d')}); return false;">Show</a>

<a href="/posts/1" data-remote="true">Show</a>

Adopting Unobtrusive Javascript

Rails 2 Rails 3

slide-34
SLIDE 34

<% remote_form_for(@post) do |f| %> <% form_for(@post, :remote => true) do |f| %>

<form action="/posts" class="new_post" id="new_post" method="post"

  • nsubmit="new Ajax.Request('/posts', {asynchronous:true,

evalScripts:true, parameters:Form.serialize(this)}); return false;"> <form action="/posts" class="new_post" data-remote="true" id="new_post" method="post">

Adopting Unobtrusive Javascript

Rails 2 Rails 3

slide-35
SLIDE 35

<%= link_to 'Destroy', post, :method => :delete %>

<a href="/posts/1" data-method="delete" rel="nofollow">Destroy</a>

<a href="/posts/1" onclick="var f = document.createElement('form'); f.style.display = 'none'; this.parentNode.appendChild(f); f.method = 'POST'; f.action = this.href;var m = document.createElement('input'); m.setAttribute('type', 'hidden'); m.setAttribute('name', '_method'); m.setAttribute('value', 'delete'); f.appendChild(m);var s = document.createElement('input'); s.setAttribute('type', 'hidden'); s.setAttribute('name', 'authenticity_token'); s.setAttribute('value', '9skdJ0k+l9/q3PWToz6MtfyiB2gcyhnKubeGV6WFL44='); f.appendChild(s);f.submit();return false;">Destroy</a>

Adopting Unobtrusive Javascript

Rails 2 Rails 3

slide-36
SLIDE 36

<%= link_to 'Destroy', post, :confirm => 'Are you sure?', :method => :delete %>

<a href="/posts/1" data-confirm="Are you sure?" data-method="delete" rel="nofollow">Destroy</a>

<a href="/posts/1" onclick="if (confirm('Are you sure?')) { var f = document.createElement('form'); f.style.display = 'none'; this.parentNode.appendChild(f); f.method = 'POST'; f.action = this.href;var m = document.createElement('input'); m.setAttribute('type', 'hidden'); m.setAttribute('name', '_method'); m.setAttribute('value', 'delete'); f.appendChild(m);var s = document.createElement('input'); s.setAttribute('type', 'hidden'); s.setAttribute('name', 'authenticity_token'); s.setAttribute('value', '9skdJ0k+l9/q3PWToz6MtfyiB2gcyhnKubeGV6WFL44='); f.appendChild(s);f.submit(); };return false;">Destroy</a>

Adopting Unobtrusive Javascript

Rails 2 Rails 3

slide-37
SLIDE 37

<%= f.submit 'Create Post', :disable_with => "Please wait..." %>

<input id="post_submit" name="commit" onclick="if (window.hiddenCommit) { window.hiddenCommit.setAttribute('value', this.value); }else { hiddenCommit = document.createElement('input');hiddenCommit.type = 'hidden';hiddenCommit.value = this.value;hiddenCommit.name = this.name;this.form.appendChild(hiddenCommit); }this.setAttribute('originalValue', this.value);this.disabled = true;this.value='Please wait...';result = (this.form.onsubmit ? (this.form.onsubmit() ? this.form.submit() : false) : this.form.submit());if (result == false) { this.value = this.getAttribute('originalValue');this.disabled = false; }return result;" type="submit" value="Create Post" />

Adopting Unobtrusive Javascript

<%= f.submit :disable_with => "Please wait..." %>

<input data-disable-with="Please wait..." id="post_submit" name="commit" type="submit" value="Create Post" />

Rails 2 Rails 3

Notice, the button label has an intellegent default

slide-38
SLIDE 38

data-method data-confirm data-remote

Adopting Unobtrusive Javascript

data-disable-with

HTML 5 custom data attributes

slide-39
SLIDE 39

/public/stylesheets/rails.js

var message = event.element().readAttribute('data-confirm'); if (message) { // ... Do a confirm box } var element = event.findElement("a[data-remote=true]"); if (element) { // ... Do the AJAX call } var element = event.findElement("a[data-method]"); if (element) { // ... Create a form } }); document.observe("dom:loaded", function() { $(document.body).observe("click", function(event) {

slide-40
SLIDE 40

http://github.com/rails/jquery-ujs

jQuery in Rails?

$('a[data-confirm],input[data-confirm]').live('click', function () { // ... Do a confirm box }); $('form[data-remote="true"]').live('submit', function (e) { // ... Do an AJAX call });

slide-41
SLIDE 41

Deprecated Methods

http://github.com/rails/prototype_legacy_helper

link_to_remote remote_form_for

  • bserve_field
  • bserve_form

form_remote_tag button_to_remote submit_to_remote link_to_function periodically_call_remote

prototype_legacy_helper

slide-42
SLIDE 42

Starting a new app New Router API ActionController - respond_with ActionMailer Syntax ActiveRelation (arel) ERB Strings Escaped Unobtrusive Javascript

#Rails3OMGPonies!

Beautiful Code in Rails 3

slide-43
SLIDE 43

Bundler

http://railscasts.com/episodes/201-bundler

Making Generators with Thor

http://bit.ly/rails3generators

(that I didn’t have time for)

Missing APIs

slide-44
SLIDE 44

name author URL rainbow of 80s toys merwing✿little dear

http://www.flickr.com/photos/merwing/2152164258/

Old Loc Merlijn Hoek

http://www.flickr.com/photos/merlijnhoek/1040997599/

Notting Hill Gate Eole

http://www.flickr.com/photos/eole/942309733/

Britomart Train Station EssjayNZ

http://www.flickr.com/photos/essjay/260511465/

Das Licht Small

http://www.flickr.com/photos/small/62713023/

Metro Genova

  • pti mystic

http://www.flickr.com/photos/miiilio/2503634282/

Immobility Dilemna gilderic

http://www.flickr.com/photos/gilderic/3528157964/

train station nolifebeforecoffee

http://www.flickr.com/photos/nolifebeforecoffee/1803584805/

Mystical station Jsome1

http://www.flickr.com/photos/jsome1/2226394415/

Railswaystation Pieter Musterd

http://www.flickr.com/photos/piet_musterd/2233025691/

The Handover MarkyBon

http://www.flickr.com/photos/markybon/152769885/

EN57 magro_kr

http://www.flickr.com/photos/iks_berto/1328682171/

Creative Commons

slide-45
SLIDE 45

Gregg Pollack

Gregg@EnvyLabs.com

http://envylabs.com

http://ruby5.envylabs.com

Ruby5 Podcast

If you need help with a Rails 3 project, feel free to give us a call

Come to our Rails 3 training at Railsconf 2010

http://bit.ly/rails3ropes

We’re also available to run Rails 3 Training at your company, email:

Gregg@EnvyLabs.com 407-754-5517

Presentation by: