Cutting your own RubyGems

Nick Quaranto
@qrush [email protected]
R B Y
cutting your own RubyGems
Wednesday, May 25, 2011

View Slide

P S A
first, a

View Slide

Where have all of
the manuals gone?

View Slide

http://history.nasa.gov/diagrams/gemini.html

View Slide

http://archive.computerhistory.org/resources/text/Apple/Apple.AppleI.1976.102646518.pdf

View Slide

http://ed-thelen.org/comp-hist/CRAY-1-HardRefMan/CRAY-1-HRM.html

View Slide

http://guides.rubyonrails.org

View Slide

http://progit.org

View Slide

http://guides.sproutcore.org

View Slide

We need
MORE
manuals!

View Slide

MAKE
MANUALS

View Slide

http://guides.rubygems.org

View Slide

G E M
what is a gem?

View Slide

Gems contain a
packaged Ruby
application or library.

View Slide

RubyGems helps you
download, install, and
manipulate gems.

View Slide

rubygems.org
rubygems client

View Slide

rubygems.org
rubygems client
gems

View Slide

rubygems.org
rubygems client
gems,
gemspecs,
indexes
from S3
gems

View Slide

.gem

View Slide

Code Gemspec
Docs

View Slide

.gem Rails
???

View Slide

Ruby looks on your
$LOAD_PATH when
you call Kernel#require

View Slide

RubyGems manages
your $LOAD_PATH

View Slide

% irb -rpp
>> pp $LOAD_PATH
[".../lib/ruby/site_ruby/1.8",
".../lib/ruby/site_ruby",
".../lib/ruby/vendor_ruby/1.8",
".../lib/ruby/vendor_ruby",
".../lib/ruby/1.8",
"."]

View Slide

% irb -rpp
>> require 'rake'
LoadError: no such file to load --
rake
from (irb):2:in `require'
from (irb):2

View Slide

>> require 'rubygems'
=> true
>> require 'rake'
=> true
>> pp $LOAD_PATH[0..1]
[".../gems/rake-0.8.7/bin",
".../gems/rake-0.8.7/lib"]

View Slide

RubyGems overrides
Kernel#require
RubyGems puts bin/ and
lib/ on your $LOAD_PATH

View Slide

Gemspec holds
metadata & info
about the gem

View Slide

% cat freewill.gemspec
Gem::Specification.new do |s|
s.name = 'freewill'
s.version = '1.0.0'
s.date = '2010-04-27'
s.summary = "Freewill!"
s.description = "I will choose Freewill!"
s.authors = ["Nick Quaranto"]
s.email = '[email protected]'
s.homepage = 'http://example.com'
s.files = ["lib/freewill.rb"]
end

View Slide

A gem is just
a tarball of
tarballs

View Slide

% gem fetch rake
Downloaded rake-0.8.7
% tar zxvf rake-0.8.7.gem
x data.tar.gz
x metadata.gz

View Slide

A GEM IS A TARBALL
WITHIN A TARBALL

View Slide

WHY CAN’T I USE
MY LINUX PACKAGE
MANAGER THEN

View Slide


View Slide

LOL, WHAT’S A TARBALL

View Slide

D Y I
make your own gem

View Slide

share/modularize code
automate your process
releasing a gem is easy!

View Slide

first gem

View Slide

Your gem
needs a name

View Slide

DO NOT CALL IT:
[rR].*
rials
cheezburger
kitty
dicks

View Slide

no capitals, please
use underscores for spaces
use dashes for extensions

View Slide

% tree
.
├── hola.gemspec
└── lib
└── hola.rb

View Slide

% cat lib/hola.rb
class Hola
def self.hi(msg = "world")
puts "Hello #{msg}!"
end
end

View Slide

require ‘hola’
% tree
.
├── hola.gemspec
└── lib
└── hola.rb

View Slide

% cat hola.gemspec
s.name = 'hola'
s.version = '0.0.0'
s.date = '2010-04-28'
s.summary = "Hola!"
s.description = "A simple hello world gem"
s.authors = ["Nick Quaranto"]
s.email = '[email protected]'
s.files = ["lib/hola.rb"]
s.homepage =
'http://rubygems.org/gems/hola'
end

View Slide

push
install
build

View Slide

push
install
build
LOCAL

View Slide

push
install
build
LOCAL
REMOTE

View Slide

% gem build hola.gemspec
Successfully built RubyGem
Name: hola
Version: 0.0.0
File: hola-0.0.0.gem
% gem install ./hola-0.0.0.gem
Successfully installed hola-0.0.0
1 gem installed

View Slide


View Slide

try your gem out
before pushing!

View Slide

% irb -rubygems
>> require 'hola'
=> true
>> Hola.hi
Hello world!

View Slide

% irb -rubygems
>> require 'hola'
=> true
>> Hola.hi
Hello world!
require 'ubygems.rb'

View Slide


View Slide

% gem push hola-0.0.0.gem
Enter your RubyGems.org credentials.
Don't have an account yet?
Create one at http://rubygems.org/sign_up
Email: [email protected]
Password:
Signed in.
Pushing gem to RubyGems.org...
Successfully registered gem: hola (0.0.0)

View Slide

push
install
build
LOCAL
REMOTE
install list -r

View Slide

% gem list -r hola
*** REMOTE GEMS ***
hola (0.0.0)
% gem install hola
Successfully installed hola-0.0.0
1 gem installed

View Slide

executable
first gem

View Slide

gems are like
awesome shell aliases

View Slide

% curl -s http://jsonip.com/ | \
prettify_json.rb
{
"ip": "24.60.248.134"
}

View Slide

% mkdir bin
% touch bin/hola
% chmod a+x bin/hola

View Slide

% cat bin/hola
#!/usr/bin/env ruby
require 'hola'
puts Hola.hi(ARGV[0])

View Slide

% cat bin/hola
#!/usr/bin/env ruby
require 'hola'
(shə-băng')

View Slide

% cat bin/hola
#!/usr/bin/env ruby
require 'hola'
“Probably derived from “shell bang” under the influence of
American slang “the whole shebang” (everything, the works)”
http://www.retrologic.com/jargon/S/shebang.html
(shə-băng')

View Slide

% cat bin/hola
#!/usr/bin/env ruby
require 'hola'
(shə-băng')
“Probably derived from “shell bang” under the influence of
American slang “the whole shebang” (everything, the works)”
http://www.retrologic.com/jargon/S/shebang.html

View Slide

% ruby -Ilib ./bin/hola
Hello world!
% ruby -Ilib ./bin/hola Baltimore
Hello Baltimore!

View Slide

% ruby -Ilib ./bin/hola
Hello world!
% ruby -Ilib ./bin/hola Baltimore
Hello Baltimore!
$LOAD_PATH.unshift(“lib”)

View Slide

% hola
Hello world!
% hola Baltimore
Hello Baltimore!

View Slide

% head -4 hola.gemspec
s.name = 'hola'
s.version = '0.0.1'
s.executables << 'hola'

View Slide

tests
executable
first gem

View Slide

framework
automation

View Slide

framework
automation
rake
thor

View Slide

framework
automation
rake
thor
Test::Unit rspec
bacon context
matchy shoulda
riot testy shindo
zebra lemon dfect
cucumber steak

View Slide

Test your gem.
Use whatever.
Please test it.

View Slide

http://test.rubygems.org

View Slide


View Slide

% cat Rakefile
require 'rake/testtask'
Rake::TestTask.new do |t|
t.libs << 'test'
end
desc "Run tests"
task :default => :test

View Slide

% cat test/test_hola.rb
require 'test/unit'
require 'hola'
class HolaTest < Test::Unit::TestCase
def test_default_hello
assert_equal "Hello world!",
Hola.hi
end
def test_custom_hello
assert_equal "Hello Boston!",
Hola.hi("Boston")
end
end

View Slide

% rake test
(in /Users/qrush/Dev/ruby/hola)
Loaded suite
Started
..
Finished in 0.000736 seconds.
2 tests, 2 assertions, 0 failures,
0 errors, 0 skips
Test run options: --seed 15331

View Slide

tests
executable
first gem
docs

View Slide

Others will use your gem.
Write about it.

View Slide

At least have a README!

View Slide

http://twitter.com/rubygems

View Slide

inline
guides

View Slide

inline
guides
nokogiri
yard

View Slide

inline
guides
nokogiri
yard
rails
datamapper

View Slide

# The main Hola driver
class Hola
# Say hi to the world!
#
# Example:
# >> Hola.hi("Buffalo")
# => Hello Buffalo!
#
# Arguments:
# message: (String)
def self.hi(message = "world")
puts "Hello #{message}!"
end
end

View Slide

http://yardoc.org

View Slide

P T N
patterns

View Slide

Cutting your own RubyGems

Cutting your own RubyGems

Nick Quaranto

More Decks by Nick Quaranto

Other Decks in Programming

Featured

Transcript