プラグインの命名規則

プラグインのモジュール名、ファイル名についての規則です。

Active Support の String#camelize や String#underscore で相互変換を行っているため、適合していないと動作しません。

例

まずモジュール名とファイル名の例を示します。

プラグインの構成部分の例

# /lib/rgrb/plugin/some_plugin/generator.rb

module RGRB
  module Plugin
    module SomePlugin
      class Generator
        # ジェネレータの内容
      end
    end
  end
end

プラグインのテストケースの例

# /spec/rgrb/plugin/some_plugin/generator_spec.rb

require_relative '../../../spec_helper'
require 'rgrb/plugin/some_plugin/generator'

describe RGRB::Plugin::SomePlugin::Generator
  let(:generator) { described_class.new }

  # テストケースを書く
end

モジュール名

「SomePlugin」のようなアッパーキャメルケースの名前のモジュールとします。これを RGRB::Plugin モジュール内に作ります。このモジュールの中にプラグインの構成部分を作っていきます。

ファイル名

「some_plugin」のようなスネークケースとします。

まずディレクトリ /lib/rgrb/plugin/some_plugin/ を作ります。この中にプラグインの構成部分のファイルを入れていきます。例えば、上述のジェネレータのファイルのパスは /lib/rgrb/plugin/some_plugin/generator.rb とします。

テストケースを作る場合、まずディレクトリ /spec/rgrb/plugin/some_plugin/ を作ります。ここに RSpec 用のファイルを入れていきます。RSpec 用のファイルの名前は some_class_spec.rb とします。例えば、上述のジェネレータのテストケースのファイルのパスは /spec/rgrb/plugin/some_plugin/generator_spec.rb とします。