Макет каталога для чистого проекта Ruby

Question

Я начинаю изучать рубин. Я также изо дня в день разработчик C ++. Для проектов C ++ я обычно использую следующую структуру dir

/
 -/bin <- built binaries
 -/build <- build time temporary object (eg. .obj, cmake intermediates)
 -/doc <- manuals and/or Doxygen docs
 -/src
 --/module-1
 --/module-2
 -- non module specific sources, like main.cpp
 - IDE project files (.sln), etc.

Какую схему каталогов для Ruby (не Rails, не Merb) вы бы порекомендовали сохранить в чистоте, простоте и удобстве обслуживания?

Answer 1

Начиная с 2011 года, обычно используется ювелир вместо newgem, так как от последнего фактически отказались.

Answer 2

Основная структура стандартного проекта Ruby в основном:

  lib/
    foo.rb
    foo/
  share/
    foo/
  test/
    helper.rb
    test_foo.rb
  HISTORY.md (or CHANGELOG.md)
  LICENSE.txt
  README.md
  foo.gemspec

share/ встречается редко и иногда называется data/. Это не-ruby файлы общего назначения. Большинству проектов это не нужно, но даже когда они много раз, все просто хранится в lib/, хотя это, вероятно, не лучшая практика.

Каталог test/ может называться spec/, если вместо TDD используется BDD, хотя вы также можете увидеть features/, если используется огурец, или demo/, если используется QED.

В наши дни foo.gemspec может быть просто .gemspec - особенно если он не поддерживается вручную.

Если в вашем проекте есть исполняемые файлы командной строки, добавьте:

  bin/
    foo
  man/
    foo.1
    foo.1.md or foo.1.ronn

Кроме того, большинство проектов Ruby имеют:

  Gemfile
  Rakefile

Gemfile - для использования Bundler, а Rakefile - для инструмента сборки Rake. Но есть и другие варианты, если вы хотите использовать другие инструменты.

Несколько других необычных файлов:

  VERSION
  MANIFEST

Файл VERSION содержит только номер текущей версии. И MANIFEST (или Manifest.txt) содержит список файлов, которые будут включены в файл (ы) пакета проекта (например, пакет gem).

Что еще вы можете увидеть, но использование носит спорадический характер:

  config/
  doc/ (or docs/)
  script/
  log/
  pkg/
  task/ (or tasks/)
  vendor/
  web/ (or site/)

Где config/ содержит различные файлы конфигурации; doc/ содержит сгенерированную документацию, например, RDoc или иногда документация, поддерживаемая вручную; script/ содержит сценарии оболочки для использования проектом; log/ содержит сгенерированные журналы проекта, например, отчеты о тестировании покрытия; pkg/ содержит сгенерированные файлы пакетов, например, foo-1.0.0.gem; task/ может содержать различные файлы задач, такие как foo.rake или foo.watchr; vendor/ содержит копии других проектов, например, подмодули git; и наконец web/ содержит файлы сайта проекта.

Затем некоторые специфичные для инструмента файлы, которые также относительно распространены:

  .document
  .gitignore
  .yardopts
  .travis.yml

Они довольно очевидны.

Наконец, я добавлю, что я лично добавляю файл .index и каталог var/ для создания этого файла (подробнее об этом поищите в "Rubyworks Indexer") и часто имею каталог work, что-то вроде :

  work/
    NOTES.md
    consider/
    reference/
    sandbox/

Просто как свалка для целей разработки.

Answer 3

Bundler включает в себя необходимую инфраструктуру для создания драгоценного камня:

$ bundle gem --coc --mit --test=minitest --exe spider
Creating gem 'spider'...
MIT License enabled in config
Code of conduct enabled in config
      create  spider/Gemfile
      create  spider/lib/spider.rb
      create  spider/lib/spider/version.rb
      create  spider/spider.gemspec
      create  spider/Rakefile
      create  spider/README.md
      create  spider/bin/console
      create  spider/bin/setup
      create  spider/.gitignore
      create  spider/.travis.yml
      create  spider/test/test_helper.rb
      create  spider/test/spider_test.rb
      create  spider/LICENSE.txt
      create  spider/CODE_OF_CONDUCT.md
      create  spider/exe/spider
Initializing git repo in /Users/francois/Projects/spider
Gem 'spider' was successfully created. For more information on making a RubyGem visit https://bundler.io/guides/creating_gem.html

Затем в lib / вы создаете модули по мере необходимости:

lib/
  spider/
    base.rb
  crawler/
    base.rb
  spider.rb
    require "spider/base"
    require "crawler/base"

Прочтите страницу руководства для bundle gem , чтобы узнать подробнее о параметрах --coc, --exe и --mit.

Answer 4

@ Dentharg : ваш "включить один, чтобы включить все подчасти" является общим шаблоном. Как и у всего, у него есть свои преимущества (легко получить то, что вы хотите) и свои недостатки (многие из них могут загрязнять пространства имен, и вы не можете их контролировать). Ваш шаблон выглядит так:

- src/
    some_ruby_file.rb:
      require 'spider'
      Spider.do_something

+ doc/

- lib/
  - spider/
      spider.rb:
        $: << File.expand_path(File.dirname(__FILE__))
        module Spider
          # anything that needs to be done before including submodules
        end

        require 'spider/some_helper'
        require 'spider/some/other_helper'
        ...

Я мог бы рекомендовать это, чтобы позволить немного больше контроля:

- src/
    some_ruby_file.rb:
      require 'spider'
      Spider.include_all
      Spider.do_something

+ doc/

- lib
  - spider/
      spider.rb:
        $: << File.expand_path(File.dirname(__FILE__))
        module Spider
          def self.include_all
            require 'spider/some_helper'
            require 'spider/some/other_helper'
            ...
          end
        end

Answer 5

Почему бы не использовать точно такой же макет? Обычно вам не требуется сборка, потому что нет этапа компиляции, но остальное мне кажется нормальным.

Я не уверен, что вы подразумеваете под модулем, но если это всего лишь один класс, отдельная папка не понадобится, и, если имеется более одного файла, вы обычно пишете файл module-1.rb (по имени уровень как папка module-1), которая ничего не делает, кроме как требует все в module-1 /.

О, и я бы предложил использовать Rake для задач управления (вместо make).

Answer 6

Итак, я пошел с newgem. Я удалил все ненужные вещи из RubyForge / gem (мотыга, настройки и т. Д.), Создал git repo, импортировал проект в NetBeans. Все заняло 20 минут и все на зеленом. Это даже дало мне базовое задание по рейку для файлов спецификаций.

Спасибо всем.

Answer 7

Я бы придерживался чего-то похожего на то, с чем вы знакомы: нет смысла быть незнакомцем в вашем собственном каталоге проектов. : -)

Типичные вещи, которые у меня всегда есть: lib | src, bin, test.

(мне не нравятся эти генераторы монстров: первое, что я хочу сделать с новым проектом - это написать код, а не писать README, документы и т. Д.!)