Обзор онлайн-справочников для Ruby On Rails

    Мало найдеться программистов (особенно начинающих), способных держать в голове названия всех нужных методов а так-же количество, порядок и назначение передаваемых им параметров. Для этого существуют справочники по API.

    В этом посте я хотел бы собрать вместе несколько полезных, посвященных Ruby on Rails, справочных ресурсов (в том числе и по API), которые всегда удобно держать под рукой, в соседней вкладке браузера.

    Речь пойдет о:

    api.rubyonrails.org — официальная документация




    Это, скорее всего, первый онлайн-справочник по Ruby On Rails API, который бросится в глаза начинающему RoR-программисту. Пользователь здесь не найдет ничего особенного — это официальная документация, поэтому она выглядит как pure_rdoc_generated-веб-сайт, основанный на фреймах. Навигация на троечку — выполнять поиск приходится со «словарем в руках», т.к. встроенный поиск отсутствует.

    Реккомендуется привыкшим к http://www.ruby-doc.org, официальной документации для Ruby :-)

    wiki.rubyonrails.org




    Ресурс другой специфики, нежели официальная документация по API. Здесь представлены, в первую очередь, различного рода статьи, гайды и F.A.Q. по настройке, а так-же собраны различные списки (сообщества, хостинги и т.д.) и приведены вводные описания работы с тем или иным модулем снабженные краткими примерами кода.

    В целом ресурс вызывает весьма противоречивые чувства — с одной стороны он расположен на официальным поддомене, с другой — на поверку оказываеться, что там очень мало статей, многие из которых находяться в состоянии stub, в то время как другие уже давно потеряли актуальность. В первую очередь представляет собой интерес, как сборник инструкций по настройке и развертыванию приложения, настройке связи с БД и установке плагинов.

    guides.rubyonrails.org




    Данный ресурс представляет собой сборник статей. Является более близким к программированию нежели wiki.rubyonrails.org. Здесь в деталях и с примерами представлены большие статьи, охватывающие все аспекты использования фреймворка: маршрутизация (routing), рендеринг; всесторонне расмотрена работа с моделями и контроллерами. Каждая статья обильно снабжена прозрачными примерами. Среди мейнтейнеров проекта присутствует Pratik Naik, входящий в состав Rails Core Team.

    Будучи завсегдатаем на stackoverflow.com меня, на первых порах, неоднократно отправляли почитать статью по интересующей меня теме именно сюда.

    railsapi.com




    Персональный фаворит. На сайте присутствует сверхудобная навигация с поиском и приятным интерфесом. Реализован на базе фреймов с небольшим применением JavaScript'a. Сам справочник, похоже, генерируется на основе официальной документации прямо из исходников RoR. И хотя он, по идее, являеться лишь декорированой копией официальной версии, надпись на главной (Last modified: 2009-12-29 20:23:32 +0000) всё-же заставляет задуматься о предпочтении именно этого справочника официальному (см. первый скриншот).

    Поиск по методам выполняется не только полнотекстовый (поисковик не поленится поискать в т.ч. и где-то посреди названия), но т.н. smart-поиск: например по запросу round, помимо прочего будет найден метод proxy_found (что, конечно хорошо, но не понятно когда такое может понадобиться).

    Приятный, аскетичный дизайн не отвлекает от поиска и чтения информации. Скорость работы так-же радует — задержка загрузки новой страницы практически незаметна (на канале 512 Кбит).

    На просторах интернета присутствует и младший брат railsapi.comrailsbrain.com. В данный обзор он не попал виду того, что кроме ajax-обертки (на самом деле лишь поиска) над офф. документацией, он более ничем не примечателен.

    apidock.com/rails




    Сгенерирован на основе официальной документации. К каждой отдельной статье в справочнике можно написать заметку (чем, собственно, и занимаются зарегестрированые там пользователи). В заметках обычно содержатся различные недокументирование приемы использования описаных в статье методов. Так-же, каждой статье присваивается специальный символ, по которому определяется документированность рассматриваемого класса или модуля. Помимо этого на каждой статье присутствует таймлайн версий Rails, по которому можно определить как менялась статья от версии к версии.

    Использовать справочник в каждодневном режиме представляется весьма сомнительным ввиду неудобной навигации (похоже, в этом плане railsapi.com пока вне конкуренции.). Единственное что, возможно, представляет здесь интерес — пользовательские заметки, которые, в трудную минуту, могуть быстро дать ответ на возникший вопрос (хотя здесь, наверное, предпочтительнее будет использовать старый добрый stackoverflow.com).

    Вывод


    В качестве основного подручного средства лучше всего использовать http://railsapi.com. В качестве быстрого сборника рецептов, и онлайн-пособия для основательного понимания тех или иных вещей — http://guides.rubyonrails.org. Для инструкций по настройке/установке — http://wiki.rubyonrails.org.

    В остальном — дело вкуса. Кто знает, возможно одним понравится аскетичный дизайн официальной документации, в то время как другим — кричащие оттенки красного нa apidock.

    Топик навеян постом об онлайн-справочнике по jQuery.
    Поделиться публикацией
    AdBlock похитил этот баннер, но баннеры не зубы — отрастут

    Подробнее
    Реклама

    Комментарии 12

      +1
      Я сейчас постоянно пользуюсь apidock, а railsapi раньше пользовался, да вот забыл как он называется и долго не посещал. спасибо за напоминание, теперь и на нем буду сидеть)

      кстати, у apidock очень удобно, что рядом есть описание метода, комментарии и исходник. комментарии уж больно там полезные
        +1
        У apidock плюс справка по Ruby
        0
        Я раньше пользовался api.rubyontrails.org, сейчас предпочитаю локальный RDoc в закладках, благо он генерируется автоматически при установке гемов.
          0
          Мне нравится читать документацию по гемам с помощью Bdoc и Hanna. Bdoc строит навигацию по гемам, а в шаблоне Hanna есть поиск по названиям методов.
            0
            Хмм, действительно неплохие плагины. Спасибо, буду иметь в виду
            0
            Я совсем не знаю Ruby. Какая книга считается лучшей по RoR на русском? (книгу по Ruby не хочу, т.к. нвдеюсь на наличие необходимого минимума в книге по RoR)
            0
            RailsBrain примечателен наличием прямых ссылок (пример).
            В railsapi.com этого, увы, нет.
            В процессе написания комента был найден rubybrain.com.
              0
              Спасибо за rubybrain.com!
              0
              railsapi позволяет скачать всю документацию в .zip и браузить локально, за что его и люблю.
                0
                Жаль, нет на русском хорошего материала. А подборочку в избранное!
                  0
                  gotapi.com тоже весьма хорош. Очень давно пользуюсь. Из достоинств: кроме api для RoR, есть ruby, python, javascript и много других…

                  Только полноправные пользователи могут оставлять комментарии. Войдите, пожалуйста.

                  Самое читаемое