How I architected my big Rails app for success! (ConFoo 2014)

Slide 1

Slide 1 text

How I architected my big Rails app for success! Friday, February 28, 14

Slide 2

Slide 2 text

How I architected my big Rails app for success! Benjamin Smith Friday, February 28, 14

Slide 3

Slide 3 text

How I architected my big Rails app for success! Benjamin Smith Friday, February 28, 14

Slide 4

Slide 4 text

How I architected my big Rails app for success! Benjamin Smith Friday, February 28, 14

Slide 5

Slide 5 text

How I architected my big Rails app for success! Benjamin Smith @benjamin_smith Friday, February 28, 14

Slide 6

Slide 6 text

MVC @benjamin_smith Friday, February 28, 14

Slide 7

Slide 7 text

once upon a time @benjamin_smith Friday, February 28, 14

Slide 8

Slide 8 text

success Friday, February 28, 14

Slide 9

Slide 9 text

long project Friday, February 28, 14

Slide 10

Slide 10 text

big dev team Friday, February 28, 14

Slide 11

Slide 11 text

lots of codez Friday, February 28, 14

Slide 12

Slide 12 text

scalable Friday, February 28, 14

Slide 13

Slide 13 text

big bang release Friday, February 28, 14

Slide 14

Slide 14 text

success • long project • big dev team • lots of code • scalable • big 1st release @benjamin_smith Friday, February 28, 14

Slide 15

Slide 15 text

a grain of salt @benjamin_smith Friday, February 28, 14

Slide 16

Slide 16 text

success • long project • big dev team • lots of code • scalable • big 1st release @benjamin_smith Friday, February 28, 14

Slide 17

Slide 17 text

engines Friday, February 28, 14

Slide 18

Slide 18 text

engines-ish Friday, February 28, 14

Slide 19

Slide 19 text

Friday, February 28, 14

Slide 20

Slide 20 text

@benjamin_smith Friday, February 28, 14

Slide 21

Slide 21 text

@benjamin_smith Friday, February 28, 14

Slide 22

Slide 22 text

a little background @benjamin_smith Friday, February 28, 14

Slide 23

Slide 23 text

the product • Multimedia content publishing • A social network • iOS app for consumers (using JSON API) • CMS (web interface) for admins @benjamin_smith Friday, February 28, 14

Slide 24

Slide 24 text

started simple @benjamin_smith Friday, February 28, 14

Slide 25

Slide 25 text

Friday, February 28, 14

Slide 26

Slide 26 text

Friday, February 28, 14

Slide 27

Slide 27 text

Friday, February 28, 14

Slide 28

Slide 28 text

Friday, February 28, 14

Slide 29

Slide 29 text

Friday, February 28, 14

Slide 30

Slide 30 text

Friday, February 28, 14

Slide 31

Slide 31 text

Friday, February 28, 14

Slide 32

Slide 32 text

Friday, February 28, 14

Slide 33

Slide 33 text

Friday, February 28, 14

Slide 34

Slide 34 text

not too bad Friday, February 28, 14

Slide 35

Slide 35 text

Friday, February 28, 14

Slide 36

Slide 36 text

TRIED TO DO ^ Friday, February 28, 14

Slide 37

Slide 37 text

Friday, February 28, 14

Slide 38

Slide 38 text

Friday, February 28, 14

Slide 39

Slide 39 text

Friday, February 28, 14

Slide 40

Slide 40 text

Friday, February 28, 14

Slide 41

Slide 41 text

Friday, February 28, 14

Slide 42

Slide 42 text

Friday, February 28, 14

Slide 43

Slide 43 text

Friday, February 28, 14

Slide 44

Slide 44 text

Friday, February 28, 14

Slide 45

Slide 45 text

but why stop there? @benjamin_smith Friday, February 28, 14

Slide 46

Slide 46 text

Friday, February 28, 14

Slide 47

Slide 47 text

Friday, February 28, 14

Slide 48

Slide 48 text

Friday, February 28, 14

Slide 49

Slide 49 text

Friday, February 28, 14

Slide 50

Slide 50 text

Friday, February 28, 14

Slide 51

Slide 51 text

Friday, February 28, 14

Slide 52

Slide 52 text

Friday, February 28, 14

Slide 53

Slide 53 text

Friday, February 28, 14

Slide 54

Slide 54 text

Dependencies Friday, February 28, 14

Slide 55

Slide 55 text

Web Engines Dependencies Friday, February 28, 14

Slide 56

Slide 56 text

Web Engines Domain Engines Dependencies Friday, February 28, 14

Slide 57

Slide 57 text

Web Engines Domain Engines Dependencies Friday, February 28, 14

Slide 58

Slide 58 text

Dependencies Friday, February 28, 14

Slide 59

Slide 59 text

Friday, February 28, 14

Slide 60

Slide 60 text

@benjamin_smith Friday, February 28, 14

Slide 61

Slide 61 text

how to get started Friday, February 28, 14

Slide 62

Slide 62 text

rails plugin new engine_name --mountable @benjamin_smith Friday, February 28, 14

Slide 63

Slide 63 text

gem "engine_name", path: "path/to/engine_name" @benjamin_smith Friday, February 28, 14

Slide 64

Slide 64 text

mount EngineName::Engine => "/engine_name", :as => "engine_name" @benjamin_smith Friday, February 28, 14

Slide 65

Slide 65 text

bundle gem gem_name @benjamin_smith Friday, February 28, 14

Slide 66

Slide 66 text

gem "gem_name", path: "path/to/gem_name" @benjamin_smith Friday, February 28, 14

Slide 67

Slide 67 text

rails plugin new engine_name --mountable @benjamin_smith Friday, February 28, 14

Slide 68

Slide 68 text

rails plugin new engine_template --mountable @benjamin_smith Friday, February 28, 14

Slide 69

Slide 69 text

s/engine_template/new_engine_name/g s/EngineTemplate/NewEngineName/g for file in $(find . -name "*engine_template*") do mv $file ècho $file | sed s/engine_template/$1/` done @benjamin_smith Friday, February 28, 14

Slide 70

Slide 70 text

s/gem_template/new_gem_name/g s/GemTemplate/NewGemName/g for file in $(find . -name "*gem_template*") do mv $file ècho $file | sed s/gem_template/$1/` done @benjamin_smith Friday, February 28, 14

Slide 71

Slide 71 text

got it? got it? Friday, February 28, 14

Slide 72

Slide 72 text

engines the right way Friday, February 28, 14

Slide 73

Slide 73 text

self contained engines • all tables namespaced • migrations • tests @benjamin_smith Friday, February 28, 14

Slide 74

Slide 74 text

table namespacing @benjamin_smith Friday, February 28, 14

Slide 75

Slide 75 text

Friday, February 28, 14

Slide 76

Slide 76 text

Friday, February 28, 14

Slide 77

Slide 77 text

Friday, February 28, 14

Slide 78

Slide 78 text

Friday, February 28, 14

Slide 79

Slide 79 text

Friday, February 28, 14

Slide 80

Slide 80 text

migrations inside engines @benjamin_smith Friday, February 28, 14

Slide 81

Slide 81 text

rake your_engine_name:install:migrations @benjamin_smith Friday, February 28, 14

Slide 82

Slide 82 text

module EngineWithMigrations class Engine < ::Rails::Engine isolate_namespace EngineWithMigrations initializer :append_migrations do |app| unless app.root.to_s.match root.to_s app.conﬁg.paths["db/migrate"] += conﬁg.paths["db/migrate"].expanded end end end end http://pivotallabs.com/leave-your-migrations-in-your-rails- engines/ Friday, February 28, 14

Slide 83

Slide 83 text

one table per migration http://pivotallabs.com/moving-db-tables-between-rails- engines/ Friday, February 28, 14

Slide 84

Slide 84 text

testing the engines in isolation @benjamin_smith Friday, February 28, 14

Slide 85

Slide 85 text

Friday, February 28, 14

Slide 86

Slide 86 text

engines the right way Friday, February 28, 14

Slide 87

Slide 87 text

self contained engines • all tables namespaced • migrations • tests @benjamin_smith Friday, February 28, 14

Slide 88

Slide 88 text

no circular dependencies @benjamin_smith Friday, February 28, 14

Slide 89

Slide 89 text

Friday, February 28, 14

Slide 90

Slide 90 text

Friday, February 28, 14

Slide 91

Slide 91 text

Friday, February 28, 14

Slide 92

Slide 92 text

class User < ActiveRecord::Base has_many :posts end class Post < ActiveRecord::Base belongs_to :user end Friday, February 28, 14

Slide 93

Slide 93 text

Friday, February 28, 14

Slide 94

Slide 94 text

domain api Friday, February 28, 14

Slide 95

Slide 95 text

domain api • simple classes to wrap ActiveRecord calls • take as input: params or ids • output PORO @benjamin_smith Friday, February 28, 14

Slide 96

Slide 96 text

class UserManager def ﬁnd_by_id(id) User.new(UserRecord.ﬁnd(id)) end private class UserRecord < ActiveRecord::Base validates :email, presence: true end end Friday, February 28, 14

Slide 97

Slide 97 text

class UserManager def ﬁnd_by_id(id) User.new(UserRecord.ﬁnd(id)) end private class UserRecord < ActiveRecord::Base validates :email, presence: true end end Friday, February 28, 14

Slide 98

Slide 98 text

class UserManager def ﬁnd_by_id(id) User.new(UserRecord.ﬁnd(id)) end private class UserRecord < ActiveRecord::Base validates :email, presence: true end end Friday, February 28, 14

Slide 99

Slide 99 text

class UserManager def ﬁnd_by_id(id) User.new(UserRecord.ﬁnd(id)) end private class UserRecord < ActiveRecord::Base validates :email, presence: true end end class User def initialize(user_record) self.email = user_record.email end end Friday, February 28, 14

Slide 100

Slide 100 text

that’s a lie @benjamin_smith Friday, February 28, 14

Slide 101

Slide 101 text

it’s called the Data Mapper pattern @benjamin_smith Friday, February 28, 14

Slide 102

Slide 102 text

Friday, February 28, 14

Slide 103

Slide 103 text

@user.posts @post.user Friday, February 28, 14

Slide 104

Slide 104 text

class PostManager def ﬁnd_all_by_user_id(user_id) PostRecord.where(user_id: user_id) # ... convert to PORO ... end end Friday, February 28, 14

Slide 105

Slide 105 text

class PostManager def ﬁnd_all_by_user_id(user_id) PostRecord.where(user_id: user_id) # ... convert to PORO ... end end post_manager = PostManager.new @posts = post_manager.ﬁnd_all_by_user_id(@user.id) Friday, February 28, 14

Slide 106

Slide 106 text

Friday, February 28, 14

Slide 107

Slide 107 text

Friday, February 28, 14

Slide 108

Slide 108 text

class UserManager def ﬁnd_by_id(id) User.new(UserRecord.ﬁnd(id)) end end Friday, February 28, 14

Slide 109

Slide 109 text

class UserManager def find_by_id(id) User.new(UserRecord.find(id)) end end user_manager = UserManager.new author = user_manager.find_by_id(@post.user_id) Friday, February 28, 14

Slide 110

Slide 110 text

Friday, February 28, 14

Slide 111

Slide 111 text

Friday, February 28, 14

Slide 112

Slide 112 text

engines the right way Friday, February 28, 14

Slide 113

Slide 113 text

no circular dependencies @benjamin_smith Friday, February 28, 14

Slide 114

Slide 114 text

started simple Friday, February 28, 14

Slide 115

Slide 115 text

Friday, February 28, 14

Slide 116

Slide 116 text

Friday, February 28, 14

Slide 117

Slide 117 text

Friday, February 28, 14

Slide 118

Slide 118 text

Friday, February 28, 14

Slide 119

Slide 119 text

I live my life one green build at a time Friday, February 28, 14

Slide 120

Slide 120 text

Friday, February 28, 14

Slide 121

Slide 121 text

Friday, February 28, 14

Slide 122

Slide 122 text

Friday, February 28, 14

Slide 123

Slide 123 text

git whatchanged origin/master.. @benjamin_smith Friday, February 28, 14

Slide 124

Slide 124 text

Friday, February 28, 14

Slide 125

Slide 125 text

how did it work out? Friday, February 28, 14

Slide 126

Slide 126 text

Friday, February 28, 14

Slide 127

Slide 127 text

engines are a pain... • LOW velocity for ﬁrst 4-6 weeks • client worries • opposite of Rails • one pair to start is a MUST • some technical hurtles • must be diligent about refactoring • monkey patching Rails @benjamin_smith Friday, February 28, 14

Slide 128

Slide 128 text

Friday, February 28, 14

Slide 129

Slide 129 text

... but they get better • no slow down in development time • they age well • easier parallel development • potential for scaling • smart and fast build scripts @benjamin_smith Friday, February 28, 14

Slide 130

Slide 130 text

thumbs up @benjamin_smith Friday, February 28, 14

Slide 131

Slide 131 text

Friday, February 28, 14

Slide 132

Slide 132 text

class UserManager def ﬁnd_by_id(id) User.new(UserRecord.ﬁnd(id)) end private class UserRecord < ActiveRecord::Base validates :email, presence: true end end Friday, February 28, 14

Slide 133

Slide 133 text

thanks Friday, February 28, 14

Slide 134

Slide 134 text

more infoz: @benjamin_smith http://pivotallabs.com/tag/rails-application-suites/ https://speakerdeck.com/benjaminleesmith/ Friday, February 28, 14