在 Ruby 中命名命名空间的首选方式（更好的风格）是什么？单数还是复数？

Question

有何优缺点

FooLib::Plugins
FooLib::Plugins::Bar

对您而言，使用:与

FooLib::Plugin
FooLib::Plugin::Bar

命名约定 ？你会使用什么或者你正在使用什么？社会上比较常用的是什么？

Answer 1

使用：

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

这是 Rails 是如何做到的 （所以这是铁路方式）。即查看 Associations 命名空间和 Associations::Association 类 构成 Associations 命名空间的所有类均从中继承（即关联::SingularAssociation）。

Answer 2

对我来说，FooLib::Plugins 看起来像一个模块，用作保存各种插件类的命名空间。FooLib::Plugin 看起来像 FooLib 插件的超类。

在 FooLib::Plugins::Bar 中，Bar 看起来绝对像是插件的名称。对于 FooLib::Plugin::Bar，我会怀疑 Bar 是否是 Foo::Plugin 使用的辅助类，或者名称一个插件的。

Answer 3

假设 Plugin 是基类：

• class FooLib::Plugin::Bar

  class FooLib::Plugin::Bar

  class FooLib::Plugin::Bar

  class FooLib::Plugin::Bar

  FooLib::插件

  这是我使用和推荐的。 Bar 是 FooLib 中的一个 Plugin 并且它继承自 FooLib::Plugin。它还将 FooLib 库提供的插件嵌套在通用类的命名空间下，读起来很自然：

  # 将 FooLib 库的 Bar Plugin 分配给 p.
  p = FooLib::Plugin::Bar
  

  如果我要为您的库开发第三方插件，我将创建以下结构：

  # Baz 是 BarLib 提供的 FooLib 库的插件。
  类 BarLib::FooLib::Plugin::Baz < ::FooLib::插件
  

  请注意，我镜像了 FooLib 层次结构，但位于 BarLib 的命名空间下。我不会直接扩展它。

• 类 FooLib::Plugins::Bar < FooLib::插件

  我也用过这个，我觉得这个最有意义。 Bar 扩展了 FooLib::Plugin，并且是 FooLib 提供的 Plugins 之一。然而，它创建了一个可能不需要的模块。

  如果 Plugins 是一个实现 Plugins.add、Plugins.all 等方法的中央插件存储库，我认为这将是一个不错的选择和Plugins.loaded。

  如果您可以证明额外的模块是合理的，请使用它。

• 类 FooLib::Plugins::Bar < FooLib::插件

  对我来说没有多大意义。 Bar 是 FooLib 中的 Plugins 之一，该部分看起来不错。但是，它继承自 Plugins。它是否继承自多个插件？这对我来说听起来很奇怪；类名不应该暗示不可能的事情。

Answer 4

我赞同@jtrim 概述的方法。

鉴于模块（即插件）仅用于命名空间，我通常会覆盖模块中的新方法：

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(...)

Answer 5

一般来说，我倾向于采用的方法是：

module Foo
  module Plugin
    class Base; end
  end
end

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

插件的 Base 类是一种约定，在 RubyOnRails 代码库以及许多其他代码库中随处可见。 （例如ActiveRecord::Base、ActionController::Base等）

我不同意@Matheus Moreira使用Foo::Plugin的方法既作为插件的基类又作为命名空间。

不应该这样做的唯一功能性原因与约定有关 - 在 Ruby 社区中，人们会发现作为命名空间的类实例比模块要少得多。我真正看到类用作另一个类的命名空间的唯一一次是当该类的用途对于命名空间类来说是私有的并且不在外部使用时。