Rubyのネームスペースに名前を付けるための好ましい方法（より良いスタイル）は何ですか？単数形か複数形か？

Question

はあなたのために使用しての長所と短所は何ですか：

FooLib::Plugins 
FooLib::Plugins::Bar 

対

FooLib::Plugin 
FooLib::Plugin::Bar 

命名規則？そして、あなたは何を使うのでしょうか、何を使っていますか？コミュニティでより一般的に使用されるものは何ですか？

Answer 1

私にとってFooLib::Pluginsはモジュールのように見え、さまざまなプラグインクラスが保持される名前空間として使用されます。FooLib::PluginはFooLibプラグインのスーパークラスのようです。

FooLib::Plugins::Barでは、Barはプラグインの名前のようです。 FooLib::Plugin::Barでは、によって使用されるヘルパークラス、またはプラグインの名前であるかどうかは疑いがあります。 Pluginを想定し

Answer 2

は、基本クラスである：

• class FooLib::Plugin::Bar < FooLib::Plugin

  これは私が使用してお勧めです。 BarはFooLibおよびでPluginであり、FooLib::Pluginを継承しています。また、自然に読み込む一般的なクラスの名前空間の下にネストFooLibライブラリが提供するプラグインを保持します：

  # Assign the Bar Plugin of the FooLib library to p. 
  p = FooLib::Plugin::Bar 
  

  私はあなたのライブラリーのためのサードパーティ製のプラグインを開発した場合、私は次のような構造を作成します。

  # Baz is a Plugin for the FooLib library provided by BarLib. 
  class BarLib::FooLib::Plugin::Baz < ::FooLib::Plugin 
  

  私はFooLib階層をミラーますが、BarLibさんの名前空間の下に。私はそれを直接拡張しません。

• class FooLib::Plugins::Bar < FooLib::Plugin

  私はこの1つをも使用している、と私はそれが最も理にかなっていると思います。 BarはFooLib::Pluginであり、FooLibによって提供されるPluginsの1つです。ただし、潜在的に不要なモジュールが作成されます。

  私はPluginsがPlugins.add、Plugins.allとPlugins.loadedのようなメソッドを実装し、中央のプラグインリポジトリだった場合、これは素晴らしい選択だと思います。

  余分なモジュールを正当化できる場合に使用してください。

• class FooLib::Plugins::Bar < FooLib::Plugins

  は私に多くの意味がありません。 BarはPluginsのうちの1つで、FooLibの部分は正常です。ただし、Pluginsから継承しています。それは複数のプラグインから継承されていますか？私には奇妙に聞こえる。クラス名は不可能な何かを示唆するべきではありません。

Answer 3

一般的に、私が取る傾向にあるアプローチがある：プラグイン用

module Foo 
    module Plugin 
    class Base; end 
    end 
end 

class Foo::Plugin::Bar < Foo::Plugin::Base; end 

Baseクラスが慣例では、すべてのRubyOnRailsでの場所で見つかったコードベースだけでなく、他の多くの。 （例えば等ActiveRecord::Base、ActionController::Base）

IはFoo::Pluginが両方の基本クラスとプラグインの名前空間として使用される@Matheusモレイラのアプローチに同意しません。

これが慣例としなければならない行うべきではありません理由だけで機能的な理由 - Rubyコミュニティ1のモジュールよりも名前空間とクラスのあまり多くのインスタンスがあります。私が本当に別のクラスの名前空間として使用されるクラスを実際に見るのは、そのクラスの目的が名前空間クラスに対してプライベートであり、外部では使用されないときだけです。

Answer 4

用途：

module FooLib end 
module FooLib::Plugins end 
class FooLib::Plugins::Plugin; end #the base for plugins 
class FooLib::Plugins::Bar < FooLib::Plugins::Plugin; end 
class FooLib::Plugins::Bar2 < FooLib::Plugins::Plugin; end 

または別の言葉で：

module FooLib 
    module Plugins 
    class Plugin; end #the base for plugins 
    class Bar < Plugin; end 
    class Bar2 < Plugin; end 
    end 
end 

また、このようなファイルを整理：

- foo_lib/ 
    - plugins/ 
    - plugin.rb 
    - bar.rb 
    - bar2.rb 

これはhow Rails does itある（ので、これはRailsの道であります）。私。アソシエーション名前空間（すなわちAssociations::SingularAssociation）を継承するクラスの、そこからすべての関連付け、名前空間とAssociations::Association class見形成します。

Answer 5

私は第二のアプローチは、@jtrimによって概説でしょう。 //api.rubyonrails：[RailsのAPI]（HTTPを見ることによって

module Foo 
    module Plugin 

    def self.included(base) 
     raise "cannot be included" 
    end 

    def self.extended(base) 
     raise "cannot extend" 
    end 

    def self.new(*args) 
     Base.new(*args) 
    end 

    class Base;end 
    end 
end 


base_plugin_obj = Foo::Plugin.new(...)