Creating a Gem - Speaker Deck

Slide 1

Slide 1 text

Creating Your First Gem

Slide 2

Slide 2 text

What?

Slide 3

Slide 3 text

Does One Thing Well

Slide 4

Slide 4 text

Why?

Slide 5

Slide 5 text

Programming is hard.

Slide 6

Slide 6 text

Programming well is really hard.

Slide 7

Slide 7 text

The Problem

Slide 8

Slide 8 text

Naming

Slide 9

Slide 9 text

The First Rule

Slide 10

Slide 10 text

Name It Something Clever

Slide 11

Slide 11 text

The Second Rule

Slide 12

Slide 12 text

Don’t Take One Of My Names

Slide 13

Slide 13 text

No content

Slide 14

Slide 14 text

615.555.1234

Slide 15

Slide 15 text

No content

Slide 16

Slide 16 text

The Third Rule

Slide 17

Slide 17 text

Don’t Be Inappropriate

Slide 18

Slide 18 text

Don't name it something sexual.

Slide 19

Slide 19 text

Don't name it something misogynistic

Slide 20

Slide 20 text

Don't name it after crude words for your anatomy

Slide 21

Slide 21 text

F&%#

Slide 22

Slide 22 text

No content

Slide 23

Slide 23 text

Why Listen To Me?

Slide 24

Slide 24 text

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

Slide 25

Slide 25 text

Our Example

Slide 26

Slide 26 text

No content

Slide 27

Slide 27 text

“Translating pig latin is fun”.to_pig_latin # => “anslating-tray ig-pay atin-lay is-ay un-fay”

Slide 28

Slide 28 text

No content

Slide 29

Slide 29 text

Creating Your Gem

Slide 30

Slide 30 text

Jewler

Slide 31

Slide 31 text

Hoe

Slide 32

Slide 32 text

Bundler

Slide 33

Slide 33 text

Slide 34

Slide 34 text

gem install bundler bundle gem pope_francis

Slide 35

Slide 35 text

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

Slide 36

Slide 36 text

Slide 37

Slide 37 text

Gem::Specification.new do |gem| gem.name = "pope_francis" gem.version = PopeFrancis::VERSION gem.authors = ["Jeff Felchner"] gem.email = ["[email protected]"] gem.description = %q{TODO: Write a gem description} gem.summary = %q{TODO: Write a gem summary} gem.homepage = "" end

Slide 38

Slide 38 text

Gem::Specification.new do |gem| gem.name = "pope_francis" gem.version = PopeFrancis::VERSION gem.authors = ["Jeff Felchner"] gem.email = ["[email protected]"] 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

Slide 39

Slide 39 text

Releasing Your Gem

Slide 40

Slide 40 text

Slide 41

Slide 41 text

No content

Slide 42

Slide 42 text

Add Your Gem to Github (optional)

Slide 43

Slide 43 text

No content

Slide 44

Slide 44 text

rake release

Slide 45

Slide 45 text

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

Slide 46

Slide 46 text

No content

Slide 47

Slide 47 text

Versioning

Slide 48

Slide 48 text

Use Semantic Versioning (http://semver.org)

Slide 49

Slide 49 text

x.y.z Major . Minor . Patch (eg 1.8.4)

Slide 50

Slide 50 text

Your Gem’s Version

Slide 51

Slide 51 text

pope_francis/lib/pope_francis/version.rb

Slide 52

Slide 52 text

module PopeFrancis VERSION = "0.0.1" end

Slide 53

Slide 53 text

arning-way! Pushing The Same Version Twice Will Fail

Slide 54

Slide 54 text

> 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.

Slide 55

Slide 55 text

Yanking Releases

Slide 56

Slide 56 text

> 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)

Slide 57

Slide 57 text

No content

Slide 58

Slide 58 text

> gem install pope_francis ERROR: Could not find a valid gem 'pope_francis' (>= 0) in any repository ERROR: Possible alternatives: francis, tolerances

Slide 59

Slide 59 text

README Driven Development

Slide 60

Slide 60 text

Waaaaaaiiiiiiiiiiiiitttttttttt a second.....

Slide 61

Slide 61 text

Your Public API = Your Version

Slide 62

Slide 62 text

Your Public API is the most important thing when developing a gem.

Slide 63

Slide 63 text

No content

Slide 64

Slide 64 text

Write the Code

Slide 65

Slide 65 text

Fast Forward

Slide 66

Slide 66 text

pope_francis/lib/pope_francis.rb

Slide 67

Slide 67 text

require ‘pope_francis’

Slide 68

Slide 68 text

require ‘pope_francis’ while english_phrase = gets do puts english_phrase.to_pig_latin end

Slide 69

Slide 69 text

Hacking On It

Slide 70

Slide 70 text

Fork the Gem

Slide 71

Slide 71 text

https://github.com/jfelchner/pope_francis

Slide 72

Slide 72 text

Rename the Gem in Your Fork

Slide 73

Slide 73 text

pope_francis-nash-rails

Slide 74

Slide 74 text

pope_francis-nash-rails-jfelchner

Slide 75

Slide 75 text

Using It In Another Project

Slide 76

Slide 76 text

gem install pope_francis-nash-rails-jfelchner

Slide 77

Slide 77 text

require ‘pope_francis’

Slide 78

Slide 78 text

require ‘pope_francis-nash-rails-jfelchner’

Slide 79

Slide 79 text

Exercises

Slide 80

Slide 80 text

Additional Options

Slide 81

Slide 81 text

“Translating pig latin is fun” .to_pig_latin(:hyphenate => false) # => “anslatingtray igpay atinlay isway unfay”

Slide 82

Slide 82 text

Preserve Capitalization

Slide 83

Slide 83 text

“Translating Pig Latin is fun”.to_pig_latin # => “Anslating-tray Ig-pay Atin-lay is-way un-fay”