RubyのDSL（Domain Specific Language）で美しいコードを書く

作成日 2025.02.13
Ruby
ruby

DSL（Domain Specific Language）は特定の目的に特化した小さな言語で、Rubyではその簡潔さと柔軟性を活かして強力なDSLを構築できます。本記事では、RubyでDSLを作成し、美しいコードを実現する方法を学びます。

1. DSLとは何か
2. なぜRubyはDSLに向いているのか
3. シンプルなDSLの構築
4. メソッドチェーンによるDSLの作成
5. ブロックを利用した柔軟なDSL
6. スコープ制御の工夫
7. 外部DSLと内部DSL
8. モジュールでDSLを整理
9. DSLでリーダブルなコードを書く
10. DSLのテスト
11. 実用的なDSLの例
12. まとめ

DSLとは何か

DSLは特定のタスクやドメインに特化した言語です。Rubyでは、内部DSLを用いてライブラリやフレームワークの設計に活用されます。

# RailsのルーティングDSL例
Rails.application.routes.draw do
  get 'posts/:id', to: 'posts#show'
end

なぜRubyはDSLに向いているのか

Rubyの柔軟な文法やオープンクラス機能が、シンプルで読みやすいDSL構築を可能にしています。

シンプルなDSLの構築

クラスとinstance_evalを使ってDSLを構築します。

class Form
  def self.build(&block)
    form = new
    form.instance_eval(&block)
  end

  def field(name)
    puts "フィールド: #{name}"
  end
end

Form.build do
  field :username
  field :password
end

メソッドチェーンによるDSLの作成

メソッドチェーンを用いて直感的な記述を可能にします。

class Query
  def initialize
    @query = []
  end

  def select(*fields)
    @query << "SELECT #{fields.join(', ')}"
    self
  end

  def from(table)
    @query << "FROM #{table}"
    self
  end

  def where(condition)
    @query << "WHERE #{condition}"
    self
  end

  def build
    @query.join(' ')
  end
end

query = Query.new
             .select(:id, :name)
             .from(:users)
             .where("age > 30")
puts query.build

ブロックを利用した柔軟なDSL

ブロックを受け取り、柔軟な構文を提供します。

class Menu
  def self.build(&block)
    menu = new
    menu.instance_eval(&block)
  end

  def item(name, price)
    puts "#{name}: ¥#{price}"
  end
end

Menu.build do
  item "ラーメン", 800
  item "餃子", 400
end

スコープ制御の工夫

インスタンス変数を利用し、スコープを制御します。

class Config
  def initialize
    @settings = {}
  end

  def set(key, value)
    @settings[key] = value
  end

  def get(key)
    @settings[key]
  end
end

config = Config.new
config.set(:timeout, 30)
puts config.get(:timeout)

外部DSLと内部DSL

外部DSL（独自言語）と内部DSL（既存言語内の構文）の違いについて解説します。

# 外部DSL例: JSON
{
  "name": "example",
  "version": "1.0.0"
}

# 内部DSL例: Ruby
Gem::Specification.new do |s|
  s.name = "example"
  s.version = "1.0.0"
end

モジュールでDSLを整理

モジュールを使ってDSLの機能を整理します。

module DSL
  def define_method(name, &block)
    self.class.send(:define_method, name, &block)
  end
end

class MyDSL
  extend DSL

  define_method(:greet) { puts "Hello!" }
end

MyDSL.new.greet

DSLでリーダブルなコードを書く

リーダブルで直感的な記述を目指します。

class Recipe
  def self.build(&block)
    recipe = new
    recipe.instance_eval(&block)
  end

  def ingredient(name, quantity)
    puts "#{name}: #{quantity}"
  end
end

Recipe.build do
  ingredient "小麦粉", "200g"
  ingredient "卵", "2個"
end

DSLのテスト

DSLの動作を保証するためにテストを書きます。

require 'minitest/autorun'

class DSLTest < Minitest::Test
  def test_menu
    output = capture_io do
      Menu.build do
        item "寿司", 1000
      end
    end
    assert_match(/寿司: ¥1000/, output.first)
  end
end

実用的なDSLの例

Rubyの有名なライブラリで使用されているDSLの例を紹介します。

# RSpecのDSL例
RSpec.describe "Array" do
  it "has a size method" do
    expect([].size).to eq(0)
  end
end

まとめ

RubyのDSLはコードを簡潔かつリーダブルにする強力なツールです。簡単な設計から複雑なフレームワークまで、幅広く応用できます。