SpreeConf 2012: Spree's Hidden Gems

A random collection of all things Spree Commerce related.

Transcript

2. Brian Quinn Co-founder & CTO of Spree Commerce, Inc. @briandq bdq
3. Spree’s Hidden Gems
4. We’re going to cover
5. We’re going to cover • Core Features
6. We’re going to cover • Core Features • Official Extensions
7. We’re going to cover • Core Features • Official Extensions • Community Extensions
8. We’re going to cover • Core Features • Official Extensions • Community Extensions • Extension Points
9. We’re going to cover • Core Features • Official Extensions • Community Extensions • Extension Points • Spree Performance
10. We’re going to cover • Core Features • Official Extensions • Community Extensions • Extension Points • Spree Performance • Deployment Options
11. We’re going to cover • Core Features • Official Extensions • Community Extensions • Extension Points • Spree Performance • Deployment Options • More theming
12. Core Features
13. Product Properties
21. spree_sunspot_search https://github.com/jbrien/spree_sunspot_search spree_solr_search https://github.com/romul/spree_solor_search
22. # Product Properties for use with Faceting # gets turned to #{value}_property for the facet unless defined?(PRODUCT_PROPERTY_FACETS) PRODUCT_PROPERTY_FACETS = [:brand, :shirt_fit, :gender] end Facetted Search
25. Product Groups
34. http://yourstore.com/pg/spreeconf
37. Adding a scope module Spree class Product < ActiveRecord::Base def self.in_permalink(words) like_any([:permalink], prepare_words(words)) end end end
38. Extensions
39. Official Extensions
40. spree_store_credits
48. spree_affiliate
49. spree_gift_cards
50. spree_related_products
59. spree_page_cache
60. Community Extensions
61. Community Extensions Spree’s Rogues Gallery
64. spree_static_content
65. tomash
66. globalize_spree
67. dancinglightning
68. spree-pos
69. spree_simple_reports
70. jsqu99
71. spree_flexi_variants
73. spree_essentials
74. spree_essential_cms
75. spree_essential_blog
76. and more! • spree_essential_press • spree_essential_news • spree_redirect • spree_variant_options • spree_drop_shipping • spree_retailers • spree_wholesale
79. Extension Points
80. Spree::Admin::ResourceController
81. Action Callbacks Spree::Admin::ProductsController.class_eval do update.before :fix_something private def fix_something @product.name ||= 'Fallback name' end end
82. Action Callbacks Spree::Admin::ProductsController.class_eval do update.before :fix_something private def fix_something @product.name ||= 'Fallback name' end end
83. Action Callbacks Spree::Admin::ProductsController.class_eval do update.before :fix_something private def fix_something @product.name ||= 'Fallback name' end end
84. Action Callbacks Spree::Admin::ProductsController.class_eval do update.after :fix_something private def fix_something @product.variants.clear end end
85. Action Callbacks Spree::Admin::ProductsController.class_eval do update.fails :fix_something private def fix_something Panic.start_now! end end
86. core/app/controllers/.../resource_controller.rb require 'spree/core/action_callbacks' class Spree::Admin::ResourceController < Spree::Admin::BaseController ... def create invoke_callbacks(:create, :before) if @object.save invoke_callbacks(:create, :after) flash.notice = flash_message_for(@object, :successfully_created) respond_with(@object) do |format| format.html { redirect_to location_after_save } format.js { render :layout => false } end else invoke_callbacks(:create, :fails) respond_with(@object) end end
87. core/app/controllers/.../resource_controller.rb require 'spree/core/action_callbacks' class Spree::Admin::ResourceController < Spree::Admin::BaseController ... def create invoke_callbacks(:create, :before) if @object.save invoke_callbacks(:create, :after) flash.notice = flash_message_for(@object, :successfully_created) respond_with(@object) do |format| format.html { redirect_to location_after_save } format.js { render :layout => false } end else invoke_callbacks(:create, :fails) respond_with(@object) end end
88. core/app/controllers/.../resource_controller.rb require 'spree/core/action_callbacks' class Spree::Admin::ResourceController < Spree::Admin::BaseController ... def create invoke_callbacks(:create, :before) if @object.save invoke_callbacks(:create, :after) flash.notice = flash_message_for(@object, :successfully_created) respond_with(@object) do |format| format.html { redirect_to location_after_save } format.js { render :layout => false } end else invoke_callbacks(:create, :fails) respond_with(@object) end end
89. core/app/controllers/.../resource_controller.rb require 'spree/core/action_callbacks' class Spree::Admin::ResourceController < Spree::Admin::BaseController ... def create invoke_callbacks(:create, :before) if @object.save invoke_callbacks(:create, :after) flash.notice = flash_message_for(@object, :successfully_created) respond_with(@object) do |format| format.html { redirect_to location_after_save } format.js { render :layout => false } end else invoke_callbacks(:create, :fails) respond_with(@object) end end
90. Spree::Responder
91. Spree::HomeController.class_eval do respond_override :index => { :html => { :success => lambda { render :partial => "shared/some_file" } } } end Respond Override
92. Spree::HomeController.class_eval do respond_override :index => { :html => { :success => lambda { render :partial => "shared/some_file" } } } end Respond Override
93. Spree::HomeController.class_eval do respond_override :index => { :html => { :success => lambda { render :partial => "shared/some_file" } } } end Respond Override
94. Spree::HomeController.class_eval do respond_override :index => { :html => { :success => lambda { render :partial => "shared/some_file" } } } end Respond Override
95. Spree::HomeController.class_eval do respond_override :index => { :html => { :success => lambda { render :partial => "shared/some_file" } } } end Respond Override
96. Respond Override Spree::HomeController.class_eval do def index @searcher = Spree::Config.searcher_class.new(params) @products = @searcher.retrieve_products respond_with(@products) do |format| format.html { render :partial => "shared/some_file" } end end end
97. Respond Override Spree::HomeController.class_eval do def index @searcher = Spree::Config.searcher_class.new(params) @products = @searcher.retrieve_products respond_with(@products) do |format| format.html { render :partial => "shared/some_file" } end end end
98. Abilities & Roles
99. CanCan
100. CanCan
101. def initialize(user) user ||= Spree::User.new if user.has_role? 'admin' can :manage, :all else can :read, User do |resource| resource == user end can :update, User do |resource| resource == user end can :create, User can :read, Order do |order, token| order.user == user || order.token && token == order.token end ... auth/app/models/spree/ability.rb
102. def initialize(user) user ||= Spree::User.new if user.has_role? 'admin' can :manage, :all else can :read, User do |resource| resource == user end can :update, User do |resource| resource == user end can :create, User can :read, Order do |order, token| order.user == user || order.token && token == order.token end ... auth/app/models/spree/ability.rb
103. def initialize(user) user ||= Spree::User.new if user.has_role? 'admin' can :manage, :all else can :read, User do |resource| resource == user end can :update, User do |resource| resource == user end can :create, User can :read, Order do |order, token| order.user == user || order.token && token == order.token end ... auth/app/models/spree/ability.rb
104. def initialize(user) user ||= Spree::User.new if user.has_role? 'admin' can :manage, :all else can :read, User do |resource| resource == user end can :update, User do |resource| resource == user end can :create, User can :read, Order do |order, token| order.user == user || order.token && token == order.token end ... auth/app/models/spree/ability.rb
105. def initialize(user) user ||= Spree::User.new if user.has_role? 'admin' can :manage, :all else can :read, User do |resource| resource == user end can :update, User do |resource| resource == user end can :create, User can :read, Order do |order, token| order.user == user || order.token && token == order.token end ... auth/app/models/spree/ability.rb
106. def check_authorization session[:access_token] ||= params[:token] order = current_order || Spree::Order.find_by_number(params[:id]) if order authorize! :edit, order, session[:access_token] else authorize! :create, Spree::Order end end auth/.../orders_controller_decorator.rb
107. def check_authorization session[:access_token] ||= params[:token] order = current_order || Spree::Order.find_by_number(params[:id]) if order authorize! :edit, order, session[:access_token] else authorize! :create, Spree::Order end end auth/.../orders_controller_decorator.rb
108. def check_authorization session[:access_token] ||= params[:token] order = current_order || Spree::Order.find_by_number(params[:id]) if order authorize! :edit, order, session[:access_token] else authorize! :create, Spree::Order end end auth/.../orders_controller_decorator.rb
109. Adding Roles > packer = Spree::Role.create :name => 'packer' => #<Spree::Role id: 930089100, name: "packer"> > Spree::User.last.has_role? 'packer' => false > Spree::User.last.roles << packer > Spree::User.last.has_role? 'packer' => true
110. Adding Roles > packer = Spree::Role.create :name => 'packer' => #<Spree::Role id: 930089100, name: "packer"> > Spree::User.last.has_role? 'packer' => false > Spree::User.last.roles << packer > Spree::User.last.has_role? 'packer' => true
111. Adding Roles > packer = Spree::Role.create :name => 'packer' => #<Spree::Role id: 930089100, name: "packer"> > Spree::User.last.has_role? 'packer' => false > Spree::User.last.roles << packer > Spree::User.last.has_role? 'packer' => true
112. Adding Roles > packer = Spree::Role.create :name => 'packer' => #<Spree::Role id: 930089100, name: "packer"> > Spree::User.last.has_role? 'packer' => false > Spree::User.last.roles << packer > Spree::User.last.has_role? 'packer' => true
113. Adding abilities module Spree class PackerAbility include CanCan::Ability def initialize(user) if user.has_role? 'packer' can [:read, :update], Shipment end end end end Ability.register_ability(Spree:::PackerAbility)
114. Adding abilities module Spree class PackerAbility include CanCan::Ability def initialize(user) if user.has_role? 'packer' can [:read, :update], Shipment end end end end Ability.register_ability(Spree:::PackerAbility)
115. Adding abilities module Spree class PackerAbility include CanCan::Ability def initialize(user) if user.has_role? 'packer' can [:read, :update], Shipment end end end end Ability.register_ability(Spree:::PackerAbility)
116. Adding abilities module Spree class PackerAbility include CanCan::Ability def initialize(user) if user.has_role? 'packer' can [:read, :update], Shipment end end end end Ability.register_ability(Spree:::PackerAbility)
117. Adding abilities module Spree class PackerAbility include CanCan::Ability def initialize(user) if user.has_role? 'packer' can [:read, :update], Shipment end end end end Ability.register_ability(Spree:::PackerAbility)
118. Versionfile
119. Versionfile "1.0.x" => { :branch => 'master' } "0.70.x" => { :tag => "v1.2", :version => "1.2" } "0.60.x" => { :ref => "5172de86dd46905e6d60", :version => "1.1" } "0.50.x" => { :ref => "5172de86dd46905e6d60", :version => "1.1" } "0.30.x" => { :version => "1.0" }
120. Versionfile "1.0.x" => { :branch => 'master' } "0.70.x" => { :tag => "v1.2", :version => "1.2" } "0.60.x" => { :ref => "5172de86dd46905e6d60", :version => "1.1" } "0.50.x" => { :ref => "5172de86dd46905e6d60", :version => "1.1" } "0.30.x" => { :version => "1.0" }
121. Versionfile "1.0.x" => { :branch => 'master' } "0.70.x" => { :tag => "v1.2", :version => "1.2" } "0.60.x" => { :ref => "5172de86dd46905e6d60", :version => "1.1" } "0.50.x" => { :ref => "5172de86dd46905e6d60", :version => "1.1" } "0.30.x" => { :version => "1.0" }
122. Versionfile "1.0.x" => { :branch => 'master' } "0.70.x" => { :tag => "v1.2", :version => "1.2" } "0.60.x" => { :ref => "5172de86dd46905e6d60", :version => "1.1" } "0.50.x" => { :ref => "5172de86dd46905e6d60", :version => "1.1" } "0.30.x" => { :version => "1.0" }
123. Versionfile "1.0.x" => { :branch => 'master' } "0.70.x" => { :tag => "v1.2", :version => "1.2" } "0.60.x" => { :ref => "5172de86dd46905e6d60", :version => "1.1" } "0.50.x" => { :ref => "5172de86dd46905e6d60", :version => "1.1" } "0.30.x" => { :version => "1.0" }
124. Versionfile
125. Performance
126. Performance Tools & Testing
127. Siege brew install siege
128. siege -r 10 -c 10 http://yoursite.com
129. siege -t 30M -c 10 http://yoursite.com
130. siege -t 30M -c 10 -b http://yoursite.com
131. siege -t 30M -c 10 -d 15 http://yoursite.com
132. siege -t 30M -c 10 -f /path/to/urls.txt http://yoursite.com http://yoursite.com/products http://yoursite.com/p/something http://yoursite.com/login POST username=admin&password=123
133. siege -t 30M -c 10 -i -f /path/to/urls.txt
134. Sproxy brew install sproxy
135. sproxy -p 9090 -f /path/to/urls.txt
136. BrowerMob.com LoadImpact.com
138. Performance Tips
139. (if you’re using MySQL) Use mysql2
140. mysql BEFORE
141. mysql BEFORE
142. mysql BEFORE ZOMG!
143. mysql mysql2 BEFORE AFTER ZOMG!
144. Ruby GC Tuning
145. 100 concurrent users, 10 reqs each
146. Transactions: Availability: Elapsed time: Data transferred: Response time: Transaction rate: Throughput: Concurrency: Successful transactions: Failed transactions: Longest transaction: Shortest transaction: 1000 hits 100.00 % 189.45 secs 3.89 MB 17.98 secs 5.28 trans/sec 0.02 MB/sec 94.90 1000 0 21.85 1.08
147. Slowest Request
150. Change Ruby from MRI 1.8.7-p352 to REE 1.8.7-2011.03 Step 1
151. Tweak Unicorn’s Configuration Step 2
152. preload_app true GC.respond_to?(:copy_on_write_friendly=) and GC.copy_on_write_friendly = true before_fork do |server, worker| defined?(ActiveRecord::Base) and ActiveRecord::Base.connection.disconnect! end after_fork do |server, worker| defined?(ActiveRecord::Base) and ActiveRecord::Base.establish_connection end config/unicorn.rb
153. preload_app true GC.respond_to?(:copy_on_write_friendly=) and GC.copy_on_write_friendly = true before_fork do |server, worker| defined?(ActiveRecord::Base) and ActiveRecord::Base.connection.disconnect! end after_fork do |server, worker| defined?(ActiveRecord::Base) and ActiveRecord::Base.establish_connection end config/unicorn.rb
154. Get Garbage Collection times reporting to New Relic Step 3
155. if GC.respond_to?(:enable_stats) GC.enable_stats end config/initializer/enable_gc_stats.rb
156. 100 concurrent users, 10 reqs each BEFORE
157. 100 concurrent users, 10 reqs each BEFORE AFTER
158. RUBY_HEAP_MIN_SLOTS= 400000 RUBY_HEAP_SLOTS_INCREMENT= 10000 RUBY_HEAP_SLOTS_GROWTH_FACTOR= 1 RUBY_GC_MALLOC_LIMIT= 55000000 RUBY_HEAP_FREE_MIN= 80000
159. BEFORE
160. BEFORE AFTER
161. Transactions: Availability: Elapsed time: Data transferred: Response time: Transaction rate: Throughput: Concurrency: Successful transactions: Failed transactions: Longest transaction: Shortest transaction: 1000 hits 100.00 % 39.94 secs 3.72 MB 3.29 secs 25.04 trans/sec 0.08 MB/sec 82.35 1000 0 7.67 0.48 1000 hits 100.00 % 189.45 secs 3.89 MB 17.98 secs 5.28 trans/sec 0.02 MB/sec 94.90 1000 0 21.85 1.08 Before After
162. GC Tuning can go wrong!
163. Deployment
164. Deployment Scenarios
165. MYSQL RUBY App & DB RAILS UNICORN NGINX Single App + DB
166. Application Database 1 App + 1 DB
167. Application Database Load Balancer Application 1 x LB, 2 x App, 1 x DB
168. Database Application + Load Balancer Application 2 x App, 1 x DB
169. Database Application + Load Balancer Stand By 1 x App, 1 x StdBy, 1 x DB
170. Database Application + Load Balancer Application 2 x App, 1 x DB
171. Database Application + Load Balancer Application Application
172. Application Database Load Balancer Application Application Application
173. Database Application + Load Balancer Stand By 1 x Application 1 x Database 1 x Stand By App
174. Deployment Service
175. Deployment Service
194. In case you missed it
195. In case you missed it • A blank Ubuntu 10.04 LTS Cloud Server
196. In case you missed it • A blank Ubuntu 10.04 LTS Cloud Server • Installed Puppet
197. In case you missed it • A blank Ubuntu 10.04 LTS Cloud Server • Installed Puppet • Compiled Ruby 1.9.3 from source
198. In case you missed it • A blank Ubuntu 10.04 LTS Cloud Server • Installed Puppet • Compiled Ruby 1.9.3 from source • Installed Rubg Gems, Git, Nginx, MySQL, Imagick, Bundler, Foreman, etc
199. In case you missed it • A blank Ubuntu 10.04 LTS Cloud Server • Installed Puppet • Compiled Ruby 1.9.3 from source • Installed Rubg Gems, Git, Nginx, MySQL, Imagick, Bundler, Foreman, etc • Cloned Spree 1.0.0.rc demo app
200. In case you missed it • A blank Ubuntu 10.04 LTS Cloud Server • Installed Puppet • Compiled Ruby 1.9.3 from source • Installed Rubg Gems, Git, Nginx, MySQL, Imagick, Bundler, Foreman, etc • Cloned Spree 1.0.0.rc demo app • Ran bundle install
201. In case you missed it • A blank Ubuntu 10.04 LTS Cloud Server • Installed Puppet • Compiled Ruby 1.9.3 from source • Installed Rubg Gems, Git, Nginx, MySQL, Imagick, Bundler, Foreman, etc • Cloned Spree 1.0.0.rc demo app • Ran bundle install • Bootstrapped sample db & compiled assets
202. In case you missed it • A blank Ubuntu 10.04 LTS Cloud Server • Installed Puppet • Compiled Ruby 1.9.3 from source • Installed Rubg Gems, Git, Nginx, MySQL, Imagick, Bundler, Foreman, etc • Cloned Spree 1.0.0.rc demo app • Ran bundle install • Bootstrapped sample db & compiled assets • All with one command!
203. Open Sourcing (soon)
204. Theme Editors
205. Deface Editor
206. Deface Editor Store Editor
207. Deface Editor Store Editor ==
238. Thank You
240. Questions?
241. SpreeConf Whisky