Creating a gem basics in Ruby - Visual Walkthrough

Concept Flow - Creating a gem basics

Create gem folder structure

↓

Write gemspec file

↓

Write main Ruby code file

↓

Build gem package

↓

Install gem locally

↓

Use gem in Ruby projects

↓

Done

This flow shows the main steps to create a Ruby gem: set up files, write code, build, install, and use it.

Execution Sample

Ruby

mkdir my_gem
cd my_gem
# create my_gem.gemspec
# create lib/my_gem.rb
# build gem
# install gem

This example shows the basic commands and files to create and install a simple Ruby gem.

Execution Table

Step	Action	File/Folder Created	Result
1	Create gem folder	my_gem/	Folder created to hold gem files
2	Create gemspec file	my_gem.gemspec	Defines gem name, version, summary
3	Create main Ruby file	lib/my_gem.rb	Contains gem code (module/class)
4	Build gem package	my_gem-0.1.0.gem	Gem package file created
5	Install gem locally	Installed gem	Gem available for Ruby projects
6	Use gem in project	Require gem	Gem code can be used in Ruby scripts
7	Exit	-	Gem creation and installation complete

💡 All steps completed successfully, gem is ready to use

Variable Tracker

Variable/File	Start	After Step 2	After Step 3	After Step 4	After Step 5	Final
Folder 'my_gem'	Not exist	Exists	Exists	Exists	Exists	Exists
File 'my_gem.gemspec'	Not exist	Created	Created	Created	Created	Created
File 'lib/my_gem.rb'	Not exist	Not exist	Created	Created	Created	Created
Gem package file	Not exist	Not exist	Not exist	Created	Created	Created
Gem installed	No	No	No	No	Yes	Yes

Key Moments - 3 Insights

Why do we need a gemspec file?

The gemspec file (see step 2 in execution_table) tells RubyGems important info like the gem's name and version so it can build and install the gem properly.

What is the purpose of the lib/my_gem.rb file?

This file (step 3) contains the actual Ruby code for the gem. Without it, the gem would have no functionality.

Why do we build the gem before installing?

Building (step 4) packages all files into a .gem file. Installing uses this package to add the gem to your system.

Visual Quiz - 3 Questions

Look at the execution_table, at which step is the gem package file created?

A Step 2

B Step 3

C Step 4

D Step 5

💡 Hint

Check the 'File/Folder Created' column in execution_table row for step 4

According to variable_tracker, when does the 'lib/my_gem.rb' file get created?

A After Step 2

B After Step 3

C After Step 4

D After Step 5

💡 Hint

Look at the 'File lib/my_gem.rb' row and see when it changes from 'Not exist' to 'Created'

If you skip creating the gemspec file, what will most likely happen?

A Gem will fail to build or install

B Gem will build and install normally

C Gem will install but not work

D Gem will install but with warnings

💡 Hint

Refer to key_moments about the role of the gemspec file in building and installing

Concept Snapshot

Creating a Ruby gem:
1. Make a folder for your gem
2. Write a gemspec file with name, version, summary
3. Add your Ruby code in lib/ folder
4. Build the gem with 'gem build'
5. Install locally with 'gem install'
6. Use gem by requiring it in Ruby scripts

Full Transcript

To create a Ruby gem, first make a folder to hold your gem files. Then write a gemspec file that tells RubyGems the gem's name, version, and description. Next, add your Ruby code inside a file in the lib/ folder, usually named after your gem. After that, build the gem package using the gem build command, which creates a .gem file. Then install the gem locally with gem install. Finally, you can use your gem in Ruby projects by requiring it. Each step is important: the gemspec file is needed to build and install, the lib file contains your code, and building packages the gem for installation.

Practice

1. What is the main purpose of a Ruby gem?

easy

A. To compile Ruby code into machine language

B. To package and share reusable Ruby code

C. To create graphical user interfaces

D. To manage Ruby versions on your system

Solution

1. Step 1: Understand what a gem is

   A gem is a package that contains Ruby code that can be reused in different projects.

2. Step 2: Identify the main purpose

   The main purpose is to share and reuse code easily across Ruby projects.

3. Final Answer:

   To package and share reusable Ruby code -> Option B

4. Quick Check:

   Gem = reusable Ruby package [OK]

Hint: Gems are for sharing code, not compiling or GUIs [OK]

Common Mistakes:

• Thinking gems compile Ruby code
• Confusing gems with Ruby version managers
• Assuming gems create user interfaces

2. Which file is essential to define a Ruby gem's metadata and dependencies?

easy

A. README.md

B. Gemfile

C. Rakefile

D. gemspec

Solution

1. Step 1: Identify gem metadata file

   The gemspec file (.gemspec) defines the gem's name, version, authors, and dependencies.

2. Step 2: Differentiate from other files

   Gemfile manages project dependencies, Rakefile defines tasks, README.md is documentation.

3. Final Answer:

   gemspec -> Option D

4. Quick Check:

   Metadata and dependencies = gemspec [OK]

Hint: gemspec holds gem info; Gemfile is for app dependencies [OK]

Common Mistakes:

• Confusing Gemfile with gemspec
• Thinking README.md defines dependencies
• Assuming Rakefile holds gem metadata

3. Given this gemspec snippet, what is the gem's version?

Gem::Specification.new do |spec|
  spec.name        = "my_gem"
  spec.version     = "0.2.5"
  spec.summary     = "A sample gem"
end

medium

A. "0.2.5"

B. "2.5"

C. "0.2.0"

D. "1.0.0"

Solution

1. Step 1: Locate the version assignment

   The line spec.version = "0.2.5" sets the gem's version.

2. Step 2: Confirm the exact version string

   The version is exactly "0.2.5" as given in the code.

3. Final Answer:

   "0.2.5" -> Option A

4. Quick Check:

   Version in gemspec = "0.2.5" [OK]

Hint: Look for spec.version assignment in gemspec [OK]

Common Mistakes:

• Picking partial version like "0.2.0"
• Confusing version with gem name
• Assuming default version "1.0.0"

4. This gemspec file has an error. What is it?

Gem::Specification.new do |spec|
  spec.name = "example_gem"
  spec.version = 1.0.0
  spec.summary = "Example gem"
end

medium

A. Version should be a string, not a number

B. Missing spec.authors field

C. spec.name cannot have underscores

D. spec.summary must be longer than 20 characters

Solution

1. Step 1: Check version format

   The version is written as 1.0.0 without quotes, which Ruby treats as a numeric expression causing error.

2. Step 2: Correct version format

   Version must be a string like "1.0.0" with quotes to be valid.

3. Final Answer:

   Version should be a string, not a number -> Option A

4. Quick Check:

   Version must be string in gemspec [OK]

Hint: Always quote version strings in gemspec [OK]

Common Mistakes:

• Leaving version unquoted
• Thinking underscores are invalid in gem names
• Assuming summary length is strictly enforced

5. You want to create a gem that provides a method greet returning "Hello!". Which file structure and code snippet is correct? Options: A)

my_gem/
  lib/
    my_gem.rb
  my_gem.gemspec

# lib/my_gem.rb
module MyGem
  def self.greet
    "Hello!"
  end
end

B)

my_gem/
  src/
    greet.rb
  gemspec.rb

# src/greet.rb
class Greet
  def greet
    puts "Hello!"
  end
end

C)

my_gem/
  lib/
    greet.rb
  my_gem.gemspec

# lib/greet.rb
module Greet
  def greet
    "Hello!"
  end
end

D)

my_gem/
  lib/
    my_gem.rb
  my_gem.gemspec

# lib/my_gem.rb
def greet
  "Hello!"
end

hard

A. Wrong file name and missing self for method

B. Wrong folder and gemspec name; greet is instance method

C. Correct structure with module and class method greet

D. Method defined outside module, no namespacing

Solution

1. Step 1: Check folder and file structure

   Ruby gems use lib/ folder and a gemspec named after the gem. Correct structure with module and class method greet uses lib/my_gem.rb and my_gem.gemspec, which is correct.

2. Step 2: Verify code correctness

   Correct structure with module and class method greet defines a module MyGem with a class method self.greet returning "Hello!", which is the right way to provide a gem method.

3. Final Answer:

   Correct structure with module and class method greet -> Option C

4. Quick Check:

   lib folder + module + self method = correct gem code [OK]

Hint: Use lib folder and module with self.method for gem code [OK]

Common Mistakes:

• Using wrong folder names like src
• Defining instance instead of class methods
• Not namespacing methods inside a module