Составитель
Декабрь 2007 г. [номер версии: V6.0-3]
Это руководство содержит краткий обзор процесса разработки приложений на Ruby и Ruby on Rails в среде IDE NetBeans. В нем представлены методы выполнения некоторых типичных этапов этого процесса при помощи функций поддержки Ruby, предусмотренных в среде IDE.
Руководство составлено таким образом, что соблюдать какой-либо определенный порядок при ознакомлении с ним не требуется. Можно просто пролистать все страницы, а затем вернуться к требуемому разделу для более подробного ознакомления. Последовательное описание процедуры разработки приведено в руководстве Создание блога Ruby за 10 минут.
*Rails 1.2.5 или Rails 1.2.6 требуется для двух разделов, в которых используется инфраструктура Rails. Следовать указаниям в этих разделах при работе с Rails 2.0 невозможно.
Проект является эквивалентом рабочей среды для приложения. Новый проект Ruby может быть создан как на основе существующих файлов, так и путем создания нового набора папок с шаблонами проекта.
Примечание: При открытии уже существующего проекта Ruby или JRuby, созданного вне среды IDE, единственное связанное с программным обеспечением изменение NetBeans, которое среда IDE вносит в проект, заключается в создании папки nbproject, содержащей метаданные NetBeans.
В среде IDE можно открыть сразу несколько проектов. При одновременном открытии нескольких проектов необходимо указать, какой проект является главным. Главный проект – это проект, исполняемый средой IDE при нажатии кнопки "Run Main Project". Для изменения главного проекта щелкните проект правой кнопкой мыши в окне "Project" и выберите "Set as Main Project".
При создании нового проекта Ruby автоматически создается файл, которому по умолчанию присваивается имя main.rb и который определяется средой как главный сценарий. При нажатии кнопки "Run Main Project" () среда IDE сохраняет все изменения в файле и выполняет главный сценарий. Для изменения главного сценария щелкните правой кнопкой узел проекта в окне "Projects" и выберите "Properties" в появившемся меню. Выберите категорию "Run" и введите имя файла в текстовом поле "Main Script".
Примечание: Для проектов Ruby создается файл main.rb. При создании проекта Ruby on Rails, как показано в разделе Создание проекта Ruby on Rails, файл main.rb не создается.
Упражнение
Для создания проекта Ruby выполните следующие действия.
Запустите среду IDE одним из следующих способов, если это не было выполнено ранее:
Windows, Solaris и Linux. Дважды щелкните значок "NetBeans" на рабочем столе.
Mac. Дважды щелкните значок "NetBeans" в папке установки.
Щелкните правой кнопкой мыши в пустой области в окне "Projects" и выберите "New Project" в появившемся меню.
В мастере создания проекта выберите "Ruby" в области "Categories", затем выберите "Ruby Application" в области "Projects" и нажмите кнопку "Next". Если ранее какие-либо проекты Ruby не открывались и не создавались, может появиться диалоговое окно, предлагающее выбрать интерпретатор Ruby. Выберите один из предложенных интерпретаторов и нажмите кнопку "OK".
Введите имя проекта, например simple_ruby_application, и нажмите кнопку "Finish".
В редакторе откроется файл main.rb. Обратите внимание на вызов puts в коде для отображения строки "Hello World".
В окне "Project" показан логический вид файлов проекта. Щелкните вкладку "Files" для просмотра физической структуры, затем вернитесь к окну "Projects". В проектах Ruby эти два представления очень похожи.
Нажмите кнопку "Run Main Project" () для запуска приложения.
Результаты отображаются в нижней части экрана IDE, как показано на рисунке ниже.
Работа с файлами Ruby
Работа с файлами проекта Ruby подобна работе в текстовом редакторе. Для открытия файла дважды щелкните узел файла в окне "Projects" или в окне "Files". Можно также нажать Alt-Shift-O (Ctrl-Shift-O на Mac) для перехода к файлам по имени.
В редакторе IDE предусмотрено множество функций, упрощающих работу разработчика. В этом разделе приведен обзор основных функций изменения. Полный список см. на вики-странице NetBeans Ruby Editing.
Упражнение
Для создания простого проекта Ruby, выводящего на экран список продуктов, выполните следующие действия. Сначала создайте класс для отдельного продукта. Затем создаете класс для списка объектов и файл данных, из которого будут браться данные о продукте. Наконец, измените файл main.rb для отображения этого списка. По мере составления кода также будут представлены некоторые функции внесения изменений в код.
Создание класса объектов
Создайте новый проект Ruby или используйте проект, который был создан в предыдущем разделе.
В окне "Projects" создайте класс файла. Для этого щелкните правой кнопкой мыши узел "Source Files" и выберите "New > Ruby Class" в появившемся меню. Введите Item в текстовом поле "Class" и нажмите кнопку "Finish".
Среда IDE создает файл с именем item.rb и открывает этот файл в редакторе.
Замените содержимое файла item.rb следующим не совсем корректным кодом. Этот код будет исправлен позднее.
class Item
def initialize(id, type, price)
end
def simple_method(id, type, price)
@id = id
@type = type
@price = price.to_f
end
def to_s
"Item #{@id} is a #{@type}: Price $#{@price}"
end
end
Щелкните правой кнопкой мыши в тексте кода и выберите "Format" в появившемся меню для его переформатирования.
Обратите внимание на серые волнистые линии под аргументами метода инициализации (см. рисунок ниже). Эти линии указывают на неиспользуемые переменные. Ошибка будет исправлена в ходе выполнения следующих двух этапов.
Установите курсор на @type в simple_method и нажмите комбинацию клавиш Alt-Shift-Period (Ctrl-Shift-Period на Mac) для выбора строки. Повторное нажатие этой комбинации клавиш приводит к выбору блока (см. рисунок ниже).
Щелкните правой кнопкой мыши в тексте кода и выберите "Cut" в появившемся меню.
Установите курсор в начало конструктора (метод initialize) и нажмите комбинацию клавиш Shift-Enter для вставки новой строки под текущей. Щелкните правой кнопкой мыши новую строку и выберите "Paste" в появившемся меню.
Метод simple_method был необходим для размещения кода, который требовался для выполнения предыдущих этапов. Теперь этот метод можно удалить. Сначала установите курсор на выражении end метода simple_method.
Обратите внимание на то, что среда IDE выделяет соответствующее определение def.
Нажмите комбинацию клавиш Alt-Shift-Period (Ctrl-Shift-Period на Mac) для выбора метода, затем нажмите клавишу Backspace для его удаления.
Установите курсор на пустой строке и нажмите комбинацию клавиш Ctrl-E (Cmd-E на Mac) для ее удаления.
На этом этапе, а также на двух следующих этапах, демонстрируется функция автозавершения кода. Вставьте строку в верхней части блока класса, установите на нее курсор, введите attr_a и нажмите комбинацию клавиш Ctrl-Space (если комбинация клавиш Ctrl-Space не работает, нажмите комбинацию клавиш Ctrl-\).
На экране появится список возможных подстановок для автозавершения введенного выражения (см. рисунок ниже).
Выберите вариант attr_accessor :attr_names rw и нажмите клавишу Enter.
Выбранный текст подставляется в код, а пользователю предлагается внести изменения в attr_names (см. рисунок ниже).
Введите id, :type, :price для завершения оператора и нажмите клавишу Enter.
Оператор должен выглядеть примерно так:
attr_accessor :id, :type, :price
Выберите каждый из аргументов метода attr_accessor и обратите внимание на то, как в среде IDE отмечается использование каждого атрибута.
Готовый сценарий должен выглядеть следующим образом:
class Item
attr_accessor :id, :type, :price
def initialize(id, type, price)
@id = id
@type = type
@price = price.to_f
end
def to_s
"Item #{@id} is a #{@type}: Price $#{@price}"
end
end
Создание класса ItemsList
В окне "Projects" создайте еще один класс файла. Для этого щелкните правой кнопкой мыши узел "Source Files" и выберите "New > Ruby Class" в появившемся меню. Введите "ItemsList" в текстовом поле "Class" и нажмите кнопку "Finish". Обратите внимание, что файлу автоматически присваивается имя items_list.rb.
Замените содержимое файла items_list.rb следующим кодом.
class ItemsList
DATA_FILE="data.txt"
attr_accessor :items
def initialize
@items = ItemsList.load_item_data
end
private
def self.load_item_data
items = []
File.open(DATA_FILE) do |data_file|
data_file.readlines.each do |line|
items << Item.new(*line.split("\s"))
end
end
items
end
end
Создайте строку над определением "Class" и введите require ' (с одинарной кавычкой).
Обратите внимание, как при этом автоматически добавляется закрывающая кавычка, а курсор помещается между ними (см. рисунок ниже). Среда IDE автоматически вставляет и удаляет парные символы, такие как кавычки, фигурные и квадратные скобки, а также операторы end для блоков кода.
Установите курсор внутри одинарных кавычек, введите it и нажмите комбинацию клавиш Ctrl-Space. Существует только один доступный параметр импорта, начинающийся с "it" – это "item", как показано на следующем рисунке. Нажмите клавишу Tab для подтверждения этого выбора.
Создание файла данных
В окне "Projects" щелкните правой кнопкой мыши узел "Source Files" и выберите "New > Other" в появившемся меню. Выберите "Other" в области "Categories" и выберите "Empty File" в области "File Types", затем нажмите кнопку "Next".
Введите data.txt в текстовое поле "File Name".
Проверьте, что в поле "Folder" выбрано значение lib, и нажмите кнопку "Finish".
Примечание: Текстовый файл помещается в папку lib, поскольку при запуске проекта из среды IDE папка lib является рабочим каталогом по умолчанию.
Вставьте следующий текст в файл data.txt.
BF15678 book 25.32
C29589 cd 18.95
F89028 beverage 2.00
BN98232 book 45.33
BF15890 book 15.98
Создание главного сценария и выполнение приложения
В окне "Projects" дважды щелкните main.rb для вывода этого файла в окне редактора. Замените содержимое следующими операторами, выводящими на экран список объектов:
require 'items_list'
items_list = ItemsList.new
items_list.items.each do |item|
line_item = item.to_s
line_item.gsub! (/book/, 'fiction \0') if item.id =~ /\AB[FN]/
line_item.gsub! (/fiction/, 'non-\0') if item.id =~ /\ABN/
puts line_item
end
puts "\n"
Скопированный код содержит два объекта Regexp: /\AB[FN]/ и /\ABN/. Установите курсор на одном из объектов Regexp, как показано ниже, и нажмите комбинацию клавиш Ctrl-Space. На экране появится список символов и символьных комбинаций для регулярных выражений. Проверьте данные, вставленные в data.txt, на предмет того, какие объекты соответствуют каждому из двух регулярных выражений.
Для выполнения проекта нажмите кнопку "Run Main Project" на основной панели инструментов.
Среда IDE сохраняет все изменения и запускает сценарий main.rb. В окне "Output" появляются результаты работы приложения (см. рисунок ниже).
Для применения полученных знаний на практике создайте новый проект Ruby. Настройте проект так, чтобы на экран выводились записи из списка задач.
Примечание: Настоящий раздел написан для Rails 1.2.5 и Rails 1.2.6.
Создание в IDE проекта Ruby on Rails очень похоже на использование команды rails в окне терминала. Фактически, при создании проекта среда IDE создает те же самые папки и файлы, которые создала бы команда rails.
Для создания проекта щелкните правой кнопкой мыши в окне "Projects" и выберите "New Project" в появившемся меню. Выберите "Ruby" в области "Categories" и затем выберите "Ruby on Rails Application" или "Ruby on Rails Application With Existing Sources" в области "Projects".
В среде IDE можно открыть сразу несколько проектов. Узел главного проекта (проекта, в отношении которого выполняются действия NetBeans), выделяется полужирным шрифтом. Для изменения главного проекта щелкните проект правой кнопкой мыши в окне "Project" и выберите "Set as Main Project".
Как видно на следующем рисунке, на второй странице мастера создания проекта можно дать проекту имя и указать его местоположение. Раскрывающийся список содержит названия нескольких поддерживаемых серверов базы данных. В среде IDE будет использоваться выбранный сервер БД, а также пункт "Access Database Using JDBC", определяющий способ записи данных для файла database.yml.
Упражнение
Для создания проекта Ruby on Rails выполните описанные ниже действия.
Щелкните правой кнопкой мыши в пустой области в окне "Projects" и выберите "New Project" в появившемся меню.
В мастере создания проекта выберите "Ruby" в области "Categories", затем выберите "Ruby on Rails Application" в области "Projects" и нажмите кнопку "Next". Если ранее какие-либо проекты Ruby не открывались и не создавались, может появиться диалоговое окно, предлагающее выбрать интерпретатор Ruby. Выберите один из предложенных интерпретаторов и нажмите кнопку "OK".
Присвойте проекту имя, например, simple_rails_application.
Затем выберите сервер базы данных, который будет использоваться с этим приложением. При использовании JRuby следует выбрать MySQL, PostgresSQL, Oracle, HSQLDB или Java DB (также известный как Derby).
На основе этой информации средой IDE составляется файл database.yml.
Примечание: Если данный проект предполагается использовать только для работы с руководством, без обращения к фактическим базам данным, можно оставить настройки БД по умолчанию.
При использовании JRuby и необходимости обращения к серверу базы данных, отличному от MySQL, следует установить флажок "Access Database Using JDBC". Если сервером базы данных является MySQL, выбирать JDBC не обязательно.
Если этот флажок установлен, среда IDE добавляет к файлу environment.rb операторы для использования библиотеки Gem ActiveRecord-JDBC.
Примечание: Для использования подключения JDBC следует получить драйвер клиента JDBC 3.0 для сервера базы данных и поместить копию драйвера JDBC в папку "JRuby/lib".
Нажмите кнопку "Finish".
Исследуйте логический вид структуры файла в окне "Projects".
Щелкните правой кнопкой мыши узел проекта (корневой узел для проекта) и обратите внимание на пункты меню.
Щелкните вкладку "Files" и сравните эту физическую структуру файла с логическим видом, представленным в окне "Projects".
Для упрощения сравнения двух видов на следующем рисунке показаны два окна рядом.
Щелкните правой кнопкой мыши узел проекта в окне "Files" и обратите внимание на те пункты меню, которые отличаются от пунктов в контекстном меню в окне "Projects". Например, контекстное меню узла проекта в окне "Projects" содержит действие "Generate", действие "Run Rake Task" и действие "Rails Console", в дополнение ко многим другим действиям, используемым только в Rails.
Работа с файлами Ruby on Rails
Примечание: Настоящий раздел написан для Rails 1.2.5 и Rails 1.2.6.
Поддержка Ruby в NetBeans позволяет работать не только с проектами Ruby, но и с проектами Ruby on Rails. Rails – платформа, позволяющая быстро создавать веб-приложения для работы с базами данных, основанные на шаблоне разделения модель-представление-контроллер (MVC).
Как и при работе с проектами Ruby, для открытия файла в редакторе дважды щелкните узел этого файла в окне "Projects" или в окне "Files", либо нажмите комбинацию клавиш Alt-Shift-O (Ctrl-Shift-O на Mac) для перехода к файлу по имени.
Контекстные меню для узлов в окне "Project" обеспечивают быстрый доступ к сценариям Rails и задачам Rake, например, сценарию generate для автоматического создания кода и задаче db:migrate для перехода на определенную версию таблиц базы данных.
Среда IDE распознает связи между типами файлов и упрощает переход к связанным файлам. Например, при изменении файла режима просмотра можно перейти к связанному файлу действия или тесту при помощи контекстного меню.
Как и во всех проектах NetBeans, для запуска приложения следует нажать кнопку "Run Main Project". Среда IDE сохраняет все изменения файла, при необходимости запускает веб-сервер, затем выводит на экран обозревателя страницу приветствия. Для открытия в обозревателе URL-адреса любого изменяемого контроллера, действия, графики или вспомогательного средства можно использовать действие меню "Run File".
Упражнение
Для создания версии Rails на основе демонстрационного проекта, представленного в разделе Работа с файлами Ruby, выполните следующие действия. В этом варианте конструктор принимает символ "решетка" вместо позиционных аргументов, данные поступают из файла YAML, а функциональность ItemsList перемещается в класс Item.
Примечание: Как правило, классы моделей в проекте Rails основаны на таблицах базы данных. Иными словами, приложение получает данные из файла YAML.
Создание класса модели
Создайте новый проект Ruby on Rails или используйте проект, который был создан в предыдущем разделе.
В окне "Projects" щелкните правой кнопкой мыши узел "Models" и выберите "Generate" в появившемся меню.
Откроется диалоговое окно "Rails Generator" с моделью, выбранной в раскрывающемся списке "Generate", как показано ниже.
Введите Item в текстовом поле "Arguments" и нажмите кнопку "OK".
Среда IDE создает файл с именем item.rb и открывает этот файл в редакторе. Узел этого файла появится под узлом "Models" в окне "Projects". Среда IDE также создает набор тестов в области "Unit Test", средство тестирования в "Test Fixtures" и запись переноса по пути "Migrations > migrate".
Замените содержимое файла item.rb следующим кодом.
# Takes:
# :id => unique item id
# :type => type of item
# :price => price of the item
class Item
DATA_FILE="data.yml"
attr_accessor :id, :type, :price
def initialize(attributes)
@id = attributes['id']
@type = attributes['type']
@price = attributes['price'].to_f
end
def to_s
"Item #{@id} is a #{@type}: Price $#{@price}"
end
def self.load_item_data
YAML.load_file(DATA_FILE).collect do |item_hash|
Item.new(item_hash)
end
end
end
Создание файла данных
Класс Item требует файла data.yml, из которого будут поступать данные. Для создания этого файла щелкните правой кнопкой мыши узел проекта в окне "Projects" и выберите "New > Other" в появившемся меню.
В диалоговом окне "New File" выберите "Ruby" в области "Categories", выберите файл YAML в области "File Types" и нажмите кнопку "Next".
Введите data в текстовом поле "File Name" и нажмите кнопку "Finish".
Среда IDE создает файл с именем data.yml в корневой папке проекта и открывает этот файл в редакторе. Поскольку файл находится в корневой папке, он не представлен в логическом виде проекта в окне "Project". Однако он отображается в окне "Files".
Замените содержимое файла data.yml следующим текстом.
-
id: BF15678
type: book
price: 25.32
-
id: C29589
type: cd
price: 18.95
-
id: F89028
type: beverage
price: 2.00
-
id: BN98232
type: book
price: 45.33
-
id: BF15890
type: book
price: 15.98
Создание контроллера и режима просмотра
Теперь модель готова, и к ней нужно добавить контроллер и режим просмотра. В окне "Projects" щелкните правой кнопкой мыши узел "Controllers" и выберите "Generate" в появившемся меню.
Откроется диалоговое окно "Rails Generator" с контроллером, выбранным в раскрывающемся списке "Generate", как показано ниже.
Введите Item в текстовом поле "Name", введите index в текстовом поле "Views" и нажмите кнопку "OK".
Среда IDE создает класс ItemController и режим просмотра index.rhtml, находящийся в узле "Views > item". Кроме того, создаются "Functional Tests > item_controller_test.rb" и "Helpers > item_helper.rb".
Замените содержимое файла item_controller.rb следующим кодом.
class ItemController < ApplicationController
def index
@items = Item.load_item_data
end
end
Действие index, которое вызывает контроллер перед вызовом режима просмотра индекса, заполняет глобальный массив @items списком объектов.
Для быстрого перехода к файлу index.rhtml щелкните правой кнопкой мыши определение индекса и выберите "Navigate > Go to Rails Action" или "View" в появившемся меню, как показано на следующем рисунке.
Замените содержимое index.rhtml следующим кодом.
<h1>List of Items</h1>
<table border="1">
<tr><th>Id</th><th>Type</th><th>Price</th></tr>
<% for item in @items %>
<tr>
<td><%= item.id %>
</td>
<td><%= item.type %></td>
<td class="align-right"><%= '%.02f' % item.price %></td>
</tr>
<% end %>
</table>
Вложенный в HTML код Ruby выполняет итерации в глобальном массиве @items, определенном посредством индексного действия в контроллере.
Выполнение приложения
Для сохранения всех изменений нажмите кнопку "Save All" на основной панели инструментов.
При этом звездочки (*) во вкладках файла, указывающие на измененные файлы, исчезают.
Щелкните правой кнопкой мыши в редакторе и выберите "Run File".
Среда IDE передает URL-адрес контроллера объектов и индексное действие серверу, который возвращает обозревателю следующую страницу.
Для выполнения всего приложения выберите "Run Main Project".
Обратите внимание на то, что появляется стандартная страница приветствия "Ruby on Rails". Это связано с тем, что маршрутизатор по умолчанию выводит на экран файл "Public > index.html". Для изменения маршрутизации выполните следующие действия.
Разверните узел "Public" в окне "Projects".
Щелкните правой кнопкой мыши узел "index.html" и выберите "Delete" в появившемся меню.
В окне "Projects" разверните узел "Configuration" и дважды щелкните routes.rb для его открытия в редакторе.
Перейдите к следующему комментарию.
# map.connect '', :controller => "welcome"
Замените комментарий следующим кодом, выделенным полужирным шрифтом.
# You can have the root of your site routed by hooking up ''
# -- just remember to delete public/index.html.
map.connect '', :controller => "item"
Для того чтобы изменения в маршрутизации вступили в силу, нажмите кнопку остановки сервера в нижнем правом углу IDE, как показано ниже.
Нажмите кнопку "Run Main Project" для запуска приложения в обозревателе.
Закрепление материала на практике
Теперь попробуйте создать проект с самого начала. Создайте проект Ruby on Rails, выводящий на экран записи из списка задач.
На веб-сайте Ruby on Rails можно ознакомиться с экранными демонстрациями, презентациями, руководствами и примерами.
Для загрузки и установки демонстрационного приложения Depot на Ruby можно воспользоваться средством Plugins (возможно, оно уже установлено в используемой версии IDE). После установки подключаемого модуля щелкните правой кнопкой мыши в окне "Projects" и выберите "New Project" в появившемся меню. Разверните узел "Samples" в области "Categories" и выберите "Ruby". Выберите "Depot" и нажмите кнопку "Next". Нажмите кнопку "Finish" и следуйте указаниям в файле README, который отображается в обозревателе.
Использование консоли JRuby Interactive Ruby (IRB)
Как можно догадаться по названию, JRuby Interactive Ruby (IRB) Console – это модуль, позволяющий вводить операторы Ruby в интерактивном режиме, как при работе с Ruby IRB. Кроме того, консоль JRuby Interactive Ruby (IRB) Console совместима с приложениями для платформы Java.
Для открытия консоли выберите в главном меню "Window > Other > Ruby Shell" (IRB). Консоль появится в нижней части IDE, как показано на следующем рисунке.
Консоль IRB запускается из папки установки NetBeans. Для переключения на другую папку введите следующую команду, заменив your-path путем к папке, содержащей файлы Ruby.
=> Dir.chdir("your-path")
Закрытие окна консоли не приводит к завершению сеанса IRB. История команд будет доступна и после повторного открытия окна. Для завершения сеанса введите в консоли quit или exit.
Упражнение
Для открытия консоли IRB выберите "Window > Other > Ruby Shell" (IRB) в главном меню.
Для ознакомления со средой введите некоторые константы Ruby, например, PLATFORM, VERSION, ENV_JAVA и ENV. Для просмотра всех констант верхнего уровня введите Object::constants.
Попробуйте выполнить некоторые операторы Ruby в среде IRB. Например, введите следующие операторы и проверьте полученные результаты:
Протестируйте любые другие операторы Ruby, например, для проверки возможных исключительных ситуаций.
Попробуйте воспользоваться функцией автозавершения кода. Введите первые несколько символов и нажмите клавишу Tab. Появится список возможных подстановок, показанный на следующем рисунке. Для уменьшения числа пунктов в списке можно ввести следующий символ выражения. Выберите требуемый вариант и нажмите клавишу Enter.
Для просмотра истории команд нажмите несколько раз клавишу со стрелкой вверх, а для перемещения вниз – клавишу со стрелкой вниз. Для повторного выполнения команды нажмите клавишу Return.
) среда IDE сохраняет все изменения в файле и выполняет главный сценарий. Для изменения главного сценария щелкните правой кнопкой узел проекта в окне "Projects" и выберите "Properties" в появившемся меню. Выберите категорию "Run" и введите имя файла в текстовом поле "Main Script".
