Creating a Gem

Transcript

1. Creating Your First Gem
2. What?
3. Does One Thing Well
4. Why?
5. Programming is hard.
6. Programming well is really hard.
7. The Problem
8. Naming
9. The First Rule
10. Name It Something Clever
11. The Second Rule
12. Don’t Take One Of My Names
14. 615.555.1234
16. The Third Rule
17. Don’t Be Inappropriate
18. Don't name it something sexual.
19. Don't name it something misogynistic
20. Don't name it after crude words for your anatomy
21. F&%#
23. Why Listen To Me?
24. rspectacular null_and_void bangers_and_hash envision dolla_dolla_bill stipend use_the_forcible referehencible molten_core dynamo johnny_five i_am_valid oscillator chronological greenwich get_together enwrap pinpoint chicken_soup apple_cart ruby-progressbar
25. Our Example
27. “Translating pig latin is fun”.to_pig_latin # => “anslating-tray ig-pay atin-lay is-ay un-fay”
29. Creating Your Gem
30. Jewler
31. Hoe
32. Bundler
33. </disclaimer>
34. gem install bundler bundle gem pope_francis
35. create pope_francis/Gemfile create pope_francis/Rakefile create pope_francis/LICENSE.txt create pope_francis/README.md create pope_francis/.gitignore create pope_francis/pope_francis.gemspec create pope_francis/lib/pope_francis.rb create pope_francis/lib/pope_francis/version.rb
36. create pope_francis/Gemfile create pope_francis/Rakefile create pope_francis/LICENSE.txt create pope_francis/README.md create pope_francis/.gitignore create pope_francis/pope_francis.gemspec create pope_francis/lib/pope_francis.rb create pope_francis/lib/pope_francis/version.rb
37. Gem::Specification.new do |gem| gem.name = "pope_francis" gem.version = PopeFrancis::VERSION gem.authors = ["Jeff Felchner"] gem.email = ["accounts+git@thekompanee.com"] gem.description = %q{TODO: Write a gem description} gem.summary = %q{TODO: Write a gem summary} gem.homepage = "" end
38. Gem::Specification.new do |gem| gem.name = "pope_francis" gem.version = PopeFrancis::VERSION gem.authors = ["Jeff Felchner"] gem.email = ["accounts+git@thekompanee.com"] gem.description = %q{ig-pay atin-lay anslator-tray} gem.summary = %q{The one-stop shop for your Pig Latin needs} gem.homepage = "http://github.com/jfelchner/pope_francis" end
39. Releasing Your Gem
40. Sign Up on rubygems.org
42. Add Your Gem to Github (optional)
44. rake release
45. pope_francis 0.0.1 built to pkg/ pope_francis-0.0.1.gem Tagged v0.0.1 Pushed git commits and tags Pushed pope_francis 0.0.1 to rubygems.org
47. Versioning
48. Use Semantic Versioning (http://semver.org)
49. x.y.z Major . Minor . Patch (eg 1.8.4)
50. Your Gem’s Version
51. pope_francis/lib/pope_francis/version.rb
52. module PopeFrancis VERSION = "0.0.1" end
53. arning-way! Pushing The Same Version Twice Will Fail
54. > gem push pkg/pope_francis-0.0.1.gem Pushing gem to https://rubygems.org... Repushing of gem versions is not allowed. Please use `gem yank` to remove bad gem releases.
55. Yanking Releases
56. > gem install gemcutter > gem yank pope_francis -v 0.0.1 Yanking gem from RubyGems.org... Pushing gem to https://rubygems.org... Successfully yanked gem: pope_francis (0.0.1)
58. > gem install pope_francis ERROR: Could not find a valid gem 'pope_francis' (>= 0) in any repository ERROR: Possible alternatives: francis, tolerances
59. README Driven Development
60. Waaaaaaiiiiiiiiiiiiitttttttttt a second.....
61. Your Public API = Your Version
62. Your Public API is the most important thing when developing a gem.
64. Write the Code
65. Fast Forward
66. pope_francis/lib/pope_francis.rb
67. require ‘pope_francis’
68. require ‘pope_francis’ while english_phrase = gets do puts english_phrase.to_pig_latin end
69. Hacking On It
70. Fork the Gem
71. https://github.com/jfelchner/pope_francis
72. Rename the Gem in Your Fork
73. pope_francis-nash-rails
74. pope_francis-nash-rails-jfelchner
75. Using It In Another Project
76. gem install pope_francis-nash-rails-jfelchner
77. require ‘pope_francis’
78. require ‘pope_francis-nash-rails-jfelchner’
79. Exercises
80. Additional Options
81. “Translating pig latin is fun” .to_pig_latin(:hyphenate => false) # => “anslatingtray igpay atinlay isway unfay”
82. Preserve Capitalization
83. “Translating Pig Latin is fun”.to_pig_latin # => “Anslating-tray Ig-pay Atin-lay is-way un-fay”
84. Rails App
86. Thanks! Jeff Felchner @jfelchner