Speed-dating Your Rails Application

Presented at Nash.rb

Transcript

1. Speed-dating Your Rails Application Dana Jones @danabrit Software Developer Collective Idea collectiveidea.com
2. Who Am I? @danabrit @danabrit
4. • deadmanssnitch • harmony • hourglass • inchworm • Downside
5. 6 years 8 years
6. HatTip: thejohnsonletters.com
7. 1. New job
8. 1. New job 2. Change project at job
9. 1. New job 2. Change project at job 3. New client
10. 1. New job 2. Change project at job 3. New client 4. Review a gem for possible use
11. 1. New job 2. Change project at job 3. New client 4. Review a gem for possible use 5. Open source contributor
12. HatTip: huffpost.com
13. HatTip: myitalia.me
14. Goals
15. Goals Values
16. Goals Values Lifestyles
17. Goals Values Lifestyles Tastes
18. Goals Values Lifestyles Attraction Tastes
19. HatTip: phermalabs.com
20. HatTip: positiveproductive.com
21. Key Concepts
22. 1.Classes
23. 1.Classes 2.Documentation
24. 1.Classes 2.Documentation 3.Dependencies
25. 1.Classes 2.Documentation 3.Dependencies 4.Data Storage
26. Classes Getting to Know Your
27. Relationship Graphs help you visualize the relationships between the classes in your application.
28. Post Relationship Graph: 
 Simple Blog
29. Post Author 1 Relationship Graph: 
 Simple Blog
30. Post Author 1 ∞ Relationship Graph: 
 Simple Blog
31. Post Author Comment Tag 1 ∞ Relationship Graph: 
 Simple Blog
32. Post Author Comment Tag 1 ∞ ∞ ∞ Relationship Graph: 
 Simple Blog
33. Post Author Comment Tag 1 1 1 ∞ ∞ ∞ Relationship Graph: 
 Simple Blog
34. Lobsters - Link Aggregator
 github.com/jcs/lobsters
 May 2015
35. Redmine - CMS github.com/edavis10/redmine
 circa 2009
37. Computer-Generated Relationship Graphs github.com/voormedia/rails-erd gem "rails-erd" $ brew install graphviz $ bundle install $ bundle exec rake erd rails-erd github.com/preston/railroady gem "railroady" $ brew install graphviz $ bundle install $ bundle exec rake diagram:all railroady
38. $ bundle exec rake erd rails-erd: default github.com/fxn/rails-contributors contributors.rubyonrails.org
39. $ bundle exec rake erd attributes=false rails-erd: simple
40. $ bundle exec rake diagram:all railroady: complete
41. $ bundle exec rake diagram:all railroady: brief
42. Customizing Diagrams rails-erd railroady Diagram title Output file name/type Diagram orientation Show/hide inheritance Show/hide timestamp fields Include orphaned models Transitive associations Generate controller diagrams Include plugin/engine models Diagram info label Limit models by name (only/exclude)
43. Documentation Getting to Know Your
44. Documentation is the secret, underused weapon in the developer’s arsenal.
46. Sources of Documentation • README - general overview of the application, 
 install instructions, caveats, dependencies,
 historical data
47. Sources of Documentation • README - general overview of the application, 
 install instructions, caveats, dependencies,
 historical data
 • /doc - RubyDoc documentation (native to Rails),
 as well as anything that you or other gems may
 add to this dir (eg. railroady schemas, rdoc, yardoc)
48. Sources of Documentation • README - general overview of the application, 
 install instructions, caveats, dependencies,
 historical data
 • /doc - RubyDoc documentation (native to Rails),
 as well as anything that you or other gems may
 add to this dir (eg. railroady schemas, rdoc, yardoc)
 • Tests - especially feature tests. Well-named, well-
 structured tests are excellent documentation.
49. Dependencies Getting to Know Your
50. • Gemfile Dependencies
51. # By placing all of Spree's shared dependencies in this file and then loading # it for each component's Gemfile, we can be sure that we're only testing just # the one component of Spree. source 'https://rubygems.org' gem 'coffee-rails', '~> 4.0.0' gem 'sass-rails', '~> 5.0.0' gem 'sqlite3', platforms: [:ruby, :mingw, :mswin, :x64_mingw] gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw] platforms :jruby do gem 'jruby-openssl' gem 'activerecord-jdbcsqlite3-adapter' end platforms :ruby do gem 'mysql2' gem 'pg' end group :test do gem 'capybara', '~> 2.4' gem 'database_cleaner', '~> 1.3' gem 'email_spec' gem 'factory_girl_rails', '~> 4.5.0' gem 'launchy' gem 'rspec-activemodel-mocks' gem 'rspec-collection_matchers' gem 'rspec-its' gem 'rspec-rails', '~> 3.1.0' gem 'simplecov' gem 'webmock', '1.8.11' gem 'poltergeist', '1.6.0' gem 'timecop' gem 'with_model' end group :test, :development do gem 'rubocop', require: false gem 'pry-byebug' end
52. source 'https://rubygems.org' # Bundle edge Rails instead: gem 'rails', github: 'rails/rails' gem 'rails', '4.1.6' # Use sqlite3 as the database for Active Record gem 'sqlite3' # Use SCSS for stylesheets gem 'sass-rails', '~> 4.0.3' gem 'bootstrap-sass', '~> 3.3.1' gem 'autoprefixer-rails' # Use Uglifier as compressor for JavaScript assets gem 'uglifier', '>= 1.3.0' # Use CoffeeScript for .js.coffee assets and views gem 'coffee-rails', '~> 4.0.0' # See https://github.com/sstephenson/execjs#readme for more supported runtimes # gem 'therubyracer', platforms: :ruby # Use jquery as the JavaScript library gem 'jquery-rails' # Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks gem 'turbolinks' # Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder gem 'jbuilder', '~> 2.0' # bundle exec rake doc:rails generates the API under doc/api. gem 'sdoc', '~> 0.4.0', group: :doc # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring gem 'spring', group: :development # Use ActiveModel has_secure_password # gem 'bcrypt', '~> 3.1.7' # Use unicorn as the app server # gem 'unicorn' # Use Capistrano for deployment # gem 'capistrano-rails', group: :development # Use debugger # gem 'debugger', group: [:development, :test]
53. • Gemfile • /lib Dependencies
54. • Gemfile • /lib • /config Dependencies
55. • Gemfile • /lib • /config ๏ environments ๏ initializers ๏ routes Dependencies
56. Data Storage Getting to Know Your
57. HatTip: thedreamingwizard.com
58. 1. Number of tables Data Storage - Red Flags
59. 1. Number of tables 2. Redundancy Data Storage - Red Flags
60. 1. Number of tables 2. Redundancy 3. Unused tables Data Storage - Red Flags
61. 1. Number of tables 2. Redundancy 3. Unused tables 4. Missing indices Data Storage - Red Flags
62. 1. Number of tables 2. Redundancy 3. Unused tables 4. Missing indices 5. Cleverness smells Data Storage - Red Flags
63. 1. Number of tables 2. Redundancy 3. Unused tables 4. Missing indices 5. Cleverness smells 6. Meaningless attribute names Data Storage - Red Flags
64. 1. Number of tables 2. Redundancy 3. Unused tables 4. Missing indices 5. Cleverness smells 6. Meaningless attribute names • data • type • key, value • a, b, c • first_option, second_option Data Storage - Red Flags
65. Just Enough Getting to Know
66. HatTip: travelingtopher.com
67. Thank You! Dana Jones @danabrit
68. Bonus Slides
69. HatTip: essence.com
70. 1. Logic allocation Second Date
71. 1. Logic allocation 2. Code redundancy Second Date
72. 1. Logic allocation 2. Code redundancy 3. Simplicity Second Date
73. 1. Logic allocation 2. Code redundancy 3. Simplicity 4. Hackishness (count the TODOs) Second Date
74. 1. Logic allocation 2. Code redundancy 3. Simplicity 4. Hackishness (count the TODOs) 5. Javascript library usage Second Date
75. 1. Logic allocation 2. Code redundancy 3. Simplicity 4. Hackishness (count the TODOs) 5. Javascript library usage 6. Responsiveness (design) Second Date
76. 1. Logic allocation 2. Code redundancy 3. Simplicity 4. Hackishness (count the TODOs) 5. Javascript library usage 6. Responsiveness (design) 7. Responsiveness (speed) Second Date
77. 1. Logic allocation 2. Code redundancy 3. Simplicity 4. Hackishness (count the TODOs) 5. Javascript library usage 6. Responsiveness (design) 7. Responsiveness (speed) 8. Authentication/authorization Second Date
78. 1. Logic allocation 2. Code redundancy 3. Simplicity 4. Hackishness (count the TODOs) 5. Javascript library usage 6. Responsiveness (design) 7. Responsiveness (speed) 8. Authentication/authorization 9. Markup language/views Second Date
79. 1. Logic allocation 2. Code redundancy 3. Simplicity 4. Hackishness (count the TODOs) 5. Javascript library usage 6. Responsiveness (design) 7. Responsiveness (speed) 8. Authentication/authorization 9. Markup language/views 10.Feedback (metrics and human) Second Date
80. Ruby on Rails Speed-dating Checklist Do I know what each class represents? Do the tests pass? Do the associations between classes make sense? Am I familiar/comfortable with the testing stack? Are there redundant or unnecessary classes or tables? Are there signs of organization or disorganization? Do the classes’ attributes make sense? How much monkey-patching is evident? Is the same data being stored in multiple places, without cause? Are there obvious lapses in security? Are my primary and foreign keys sensical? Does it follow common Rails and Ruby conventions? Will the application be difficult to install or configure? Are the data types used sensical, performant, and efficient? What versions of Ruby and Rails does it rely on? Does indexing appear to be used sanely? Are there dependencies I have struggled with in the past? Am I familiar with the database this project uses? Are there gems I’ve never used or heard of before? Does the database used match the requirements of this project, and/or my use of it? Is the project in active development? What external APIs does this project depend on? Do I know how to contact the maintainer? Does this project offer a robust community for support and/or guidance? How thoroughly-tested is the project? Is this a project I am welcomed to contribute to? How much do I trust the tests? Is this a project I feel inclined to contribute to?