Contributing To Rails By Plugin Gem
Download as PPT, PDF2 likes900 views
The document discusses how to contribute to the Ruby on Rails framework through plugins and gems. It covers topics like plugin and gem structure, testing plugins, adding methods and changing method behavior, configuring plugins, writing documentation (README), releasing gems, and contributing code to open source projects. The goal is to teach developers how to properly write plugins and gems and make contributions to improve Rails and share their work with others.
Contributing To Rails By Plugin Gem
- 1. Contributing to Rails with plugins or gems Richard Huang E kohe www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development
- 2. Agenda Testing Plugins Gems Contribute www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development
- 3. Why use plugins or gems Component Robust Multiple choices www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development
- 4. Why write a plugin or gem Share your ideas DRY Learn a lot Make your code better www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development
- 5. Plugin www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development Read the guides first http://guides.rubyonrails.org/plugins.html Read other people’s plugins Just do it
- 6. Plugin structure www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development Executed when plugin loaded Executed when plugin installed Executed when plugin destroyed Rake task added to rails rake load path Logic codes of your plugin Test codes of your plugin Define plugin rake tasks
- 7. Plugin structure www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development Plugin logic codes Textile README require ‘bullet’ require ‘bulletware’ reqire ‘bullet/association’ …… Rspec to test plugins
- 8. Testing – the more, the better www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development Tests are documents Tests make your code robust Test s e nable good communication between you and contributors
- 9. Autotest www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development autotest a utospec
- 10. Testing ActiveRecord www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development Use sqlite3 (memory) Create and drop table each time Silence your migration
- 11. Adding methods www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development class methods and instance methods
- 12. Changing method behavior www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development alias_method
- 13. Hack with different rails versions www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development Implementations are different in different rails versions
- 14. Configure your plugin www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development Enable or disable plugin
- 15. Lazy loading www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development autoload
- 16. Reuse logic www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development Similar to writing rails app Model Controller Helper Task
- 17. README www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development Let others know what you are doing Rdoc, Textile or Markdown An example is better
- 18. Gem www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development Easier to maintain Easier to upgrade Includes dependencies automatically Can use without rails
- 19. Gem tool -- Jeweler www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development Defining your gem Bumping gem version Releasing gem
- 20. Adding gem rake www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development Rails does not load gem rake Load it yourself
- 21. Adding executable to gem www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development Using optparse to get input Defining executable in gemspec
- 22. Contribute www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development Write down your ideas Share your codes (rubyforge, github, gemcutter, etc.) Tell others what you do Use it and improve it
- 23. Contribute www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development Don’t be afraid of reinventing the wheel Don’t be afraid of ugly code Don’t be afraid of bugs
- 24. To be a better contributor www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development Read other people’s plugins http://github.com/flyerhzm/monitor
- 25. Q&A Thank you Website: http://www.huangzhimin.com Github: http://github.com/flyerhzm www.ekohe.com Web Development & Graphic Design China Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development