Sollte man bei der Benennung eines Edelsteins mit mehr als einem Wort Bindestriche oder Unterstriche verwenden?

Question

Ich bin verwirrt darüber, was die Edelstein Namenskonvention ist, wenn der Edelstein Name mehr als ein Wort hat.

• Denken-Sphinx ist der Name des Edelsteins, aber die Basis * .rb-Datei für dieses Juwel ist lib/thinking_sphinx.rb (Unterstrichen)

• Akten-as-markierbare-on ist die Name des Edelsteins, und die Basisdatei * .rb heißt lib/acts-as-taggable-on.rb (Bindestriche)

• factory_girl verwendet einen Unterstrich sowohl im Namen des Edelsteins als auch im Namen der Basis * .rb-Datei

Spielt es eine Rolle, ob Unterstriche oder Bindestriche verwendet werden? Gibt es hier einen Konsens?

Answer 1

Eric Hodel hat einen Blog-Post auf diesem: A Project Naming Recommendation

Rails die Konvention von Mapping Camelcase Klassennamen unterstrichenen Dateinamen (Klasse IMAPProcesor in imap_processor.rb definiert ist) verfestigt. Mit unterstrichenen Gem Namen macht es einfach für Menschen zu herauszufinden, welche Datei zu erfordern (gleiche als Projektname) oder welche Klasse Name in Ri suchen.

Wenn ich ein Plugin Juwel oder eine Erweiterung habe, werde ich auf den Teilprojektnamen mit einem Bindestrich heften. Wenn ich einen neuen Handler für imap_to_rss für Chase Bank E-Mail hinzufügen möchte, würde der Edelstein imap_to_rss-chase heißen.

Answer 2

Folgen Sie dem Rat here, hier ist eine Tabelle, wie die Dinge zusammenbrechen würden.

|  Gem name  | Require statement   | Main class or module | 
|:--------------------|:-----------------------------|:----------------------| 
|fancy_require  |require 'fancy_require'  | FancyRequire   | 
|ruby_parser   |require 'ruby_parser'   | RubyParser   | 
|net-http-persistent |require 'net/http/persistent' | Net::HTTP::Persistent | 
|rdoc-data   |require 'rdoc/data'   | RDoc::Data   | 
|autotest-growl  |require 'autotest/growl'  | Autotest::Growl  | 
|net-http-digest_auth |require 'net/http/digest_auth'| Net::HTTP::DigestAuth |