Download ppt - Contributing To Rails By Plugin Gem

Contributing to Rails

with plugins or gems

Richard Huang

Ekohe

www.ekohe.comWeb Development & Graphic DesignChina Ruby on Rails Development - Rails Consulting - Rails Services - Merb - Offshore Web Development

AgendaTesting

Plugins

Gems

Contribute


Why use plugins or gemsComponent

Robust

Multiple choices


Why write a plugin or gemShare your ideas

DRY

Learn a lot

Make your code better


Plugin


Read the guides first

http://guides.rubyonrails.org/plugins.html

Read other people’s plugins

Just do it

Plugin structure


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

Plugin structure


Plugin logic codes

Textile README

require ‘bullet’

require ‘bulletware’reqire

‘bullet/association’……

Rspec to test plugins

Testing – the more, the better


Tests are documents

Tests make your code robust

Tests enable good communication between you and contributors

Autotest


autotest

autospec

Testing ActiveRecord


Use sqlite3 (memory)

Create and drop table each time

Silence your migration

Adding methods


class methods and instance methods

Changing method behavior


alias_method

Hack with different rails versions


Implementations are different in different rails versions

Configure your plugin


Enable or disable plugin

Lazy loading


autoload

Reuse logic


Similar to writing rails app

–Model

–Controller

–Helper

–Task

README


Let others know what you are doing

Rdoc, Textile or Markdown

An example is better

Gem


Easier to maintain

Easier to upgrade

Includes dependencies automatically

Can use without rails

Gem tool -- Jeweler


Defining your gem

Bumping gem version

Releasing gem

Adding gem rake


Rails does not load gem rake

Load it yourself

Adding executable to gem


Using optparse to get input

Defining executable in gemspec

Contribute


Write down your ideas

Share your codes (rubyforge, github, gemcutter, etc.)

Tell others what you do

Use it and improve it

Contribute


Don’t be afraid of reinventing the wheel

Don’t be afraid of ugly code

Don’t be afraid of bugs

To be a better contributor


Read other people’s plugins

http://github.com/flyerhzm/monitor

Q&A

Thank you

Website: http://www.huangzhimin.com

Github: http://github.com/flyerhzm
