От CodeIgniter к Ruby on Rails: преобразование

Сегодня мы создадим простой чат с использованием PHP-фреймворка CodeIgniter. Затем мы будем портировать это точное приложение по частям на Ruby on Rails!

В этом руководстве мы создадим простое приложение shoutbox в CodeIgniter, а затем перенесем его на Ruby on Rails. Мы будем сравнивать код между двумя приложениями, чтобы увидеть, где они похожи и где они различаются. Изучать Rails намного проще, если вы уже знакомы со структурой инфраструктуры MVC (Model, View, Controller).

Нужен ли мне предыдущий опыт CodeIgniter?

Да, или опыт работы с PHP и другими MVC-фреймворками (CakePHP, Zend и т. Д.). Ознакомьтесь с некоторыми другими учебными пособиями по CI здесь, на Nettuts , включая серию видео с нуля !

Нужен ли мне предыдущий опыт работы с Ruby / Rails?

Хотя это поможет, нет. Я приложил все усилия, чтобы сделать прямые сравнения между Ruby и PHP, а также между Rails и CodeIgniter, поэтому, применяя имеющиеся у вас знания, это не будет слишком сложным.

Здравствуйте, CodeIgniter

Начните с загрузки платформы CodeIgniter на локальный / веб-сервер и настройте базу данных (я назвал ее ci_shoutbox ) с помощью следующих команд SQL:

Как обычно в CodeIgniter, введите свои данные в /system/application/config/database.php :

Затем config.php :

И autoload.php :

Наконец, установите контроллер по умолчанию внутри routes.php :

Контроллер и модель

Поскольку это такое простое приложение, нам нужен только один контроллер и одна модель. Inside /controllers/ create shouts.php :

И модель как /models/shout.php :

Получение Криков

Наша главная страница, индекс, выводит 10 последних криков из базы данных. Начните с добавления следующего в контроллер Shouts:

В строке 2 мы вызываем all_shouts() из модели Shout.
После этого мы загружаем соответствующий файл представления и передаем в него переменную $data (CodeIgniter автоматически разберет массив $data , чтобы мы могли получить доступ к крикам просто как $shouts вместо $data['shouts'] ).

Вызов базы данных

Давайте теперь создадим all_shouts() в нашей модели:

Это относительно просто. Мы извлекаем 10 самых последних записей из таблицы «крики» и выводим их в порядке убывания. Это создаст следующую команду SQL за кулисами:

Если какие-либо записи были найдены, они добавляются в массив $data и возвращаются в контроллер.

Вид

Внутри каталога /views/ создайте следующие файлы и папки:

• footer.php
• header.php
• /shouts/
  • index.php

Добавьте следующее в /shouts/index.php :

В строке 2 мы включаем header.php .
Если какие-либо крики были возвращены из базы данных, мы перебираем их с помощью foreach и создаем базовый список с Gravatar автора, его именем и сообщением. Если крики не были найдены, мы показываем сообщение об ошибке.
Наконец, мы включаем footer.php .

Обратите внимание, что в строке 7 мы создаем URL Gravatar . URL содержит хеш MD5 адреса электронной почты пользователя. Мы используем strtolower() PHP strtolower() чтобы гарантировать, что все письма будут в нижнем регистре, если служба Gravatar чувствительна к регистру.

Продолжая, нам нужна форма внизу страницы, чтобы добавить новый крик. Прежде чем включить файл представления нижнего колонтитула, добавьте следующее:

В строке 1 мы используем form_open() из помощника form_open() по форме. Это создает открывающий тег <form> с соответствующими параметрами и будет указывать на shouts / create (функция Create внутри контроллера Shouts).
Остальное — обычная HTML-форма, за исключением того, что мы повторяем set_value() для каждого «значения». В ближайшее время мы добавим проверку в форму, и это гарантирует, что в случае каких-либо ошибок представленные данные автоматически повторно вводятся в форму.

Наконец, нам нужно создать верхний и нижний колонтитулы. Добавьте следующее в /views/header.php :

Смотрите в строке 8, что при включении таблицы стилей мы используем base_url() из помощника URL CodeIgniter для генерации URL-адреса для корня сайта — это поместит таблицу стилей по адресу http://example.com/css/style. css .

Добавьте следующее в /views/footer.php :

Представление и проверка

Поскольку форма указывает на функцию Create в контроллере Shouts, давайте создадим это сейчас:

В строке 2 мы извлекаем крики (как мы делали с функцией index), так как они все еще должны быть показаны.
Строки 4-6 — наши правила проверки. Сначала мы проверяем вводимое имя из отправленной формы, а затем — читаемую человеком версию. Третий параметр содержит разделенный по конвейеру (‘|’) список правил проверки.

Например, мы устанавливаем все поля как обязательные, а также пропускаем их через htmlspecialchars перед отправкой. «Имя» и «Электронная почта» имеют максимальную длину, а поле отправленной электронной почты должно напоминать адрес электронной почты.

Если проверка не пройдена, представление индекса загружается снова; в противном случае мы запускаем функцию create() из модели Shout. В строке 13 мы устанавливаем сообщение об успехе во флэш-данные, которые будут отображаться на следующей выполненной странице.

Прежде чем продолжить, мы должны отобразить сообщения об ошибках и успехах (см. Изображения выше) в нашем представлении. Добавьте следующее непосредственно после того, как мы /views/shouts/index.php заголовок в /views/shouts/index.php :

Вставить в базу данных

Внутри модели Shout введите следующее:

Очень просто, мы компилируем массив, содержащий отправленные данные, и вставляем его в таблицу `криков`.

стайлинг

В самом корневом каталоге вашего приложения — в той же папке, что и папка /system/ CodeIgniter, создайте две новые папки: /css/ и /images/ .
В папке CSS добавьте следующее в файл с именем style.css :

И сохраните следующие изображения в папку /images/ : (при сохранении изображения будут иметь правильный размер!)

Для подтверждения, ваша структура каталогов должна выглядеть как на картинке ниже:

И … готово! Если вы думаете, что мы написали очень мало фактического внутреннего кода в CI, подождите, пока мы не доберемся до Rails, где все взаимодействие с базами данных автоматизировано!

Привет, Rails

В этом руководстве я предполагаю, что в вашей системе правильно установлены Ruby, Rails и MySQL (или предпочитаемый вами механизм базы данных). Если нет, см. Руководство по установке Rails и страницу загрузки MySQL . Если вы используете Mac OSX Leopard, Ruby и Rails предустановлены.

Также полезно знать, как перемещаться в вашей операционной системе с помощью командной строки. Например, чтобы изменить каталог, используйте cd foldername или cd C:\Users\Dan и т. Д.

Rails предоставляет ряд инструментов командной строки для ускорения разработки вашего приложения. Внутри терминала (или командной строки в Windows) перейдите в папку, в которой вы хотите хранить свои проекты Rails. Лично я храню их в каталоге /rails/ в моей пользовательской области.

Настройка

Запустите следующую команду, чтобы создать копию Rails для вашего приложения:

Здесь Rails установится в /shoutbox/ . Поскольку MySQL — мой предпочтительный движок базы данных, я указываю -d mysql . Если вы предпочитаете использовать MySQLlite (по умолчанию в Rails), вы просто запустите rails shoutbox .
Перейдите в каталог shoutbox:

Теперь мы сгенерируем контроллер и модель:

Rails теперь сгенерировал наш контроллер ‘Shouts’ и модель ‘Shout’. Важно знать, что Rails поддерживает строгий стиль именования.
Ваш контроллер должен быть назван во множественном числе того, с чем он будет иметь дело (например, Крики, Пользователи, Списки). Контроллер обычно работает только с одной моделью, которая названа в единственном числе (например, Shout, User, Listing). Следование этому стандарту гарантирует, что Rails сможет использовать все свои функции.

Внутри вашего каталога shoutbox откройте файл /config/database.yml, в котором будут /config/database.yml данные нашей базы данных. Введите свои данные в разделе «Разработка»:

Вы можете видеть, что Rails автоматически установил файл конфигурации для использования адаптера MySQL. Скорее всего, вам нужно только изменить имя пользователя и пароль.
Не волнуйтесь, вам еще не следовало создавать shoutbox_development данных shoutbox_development . Мы создадим это дальше.

Затем откройте файл /db/migrate/***_create_shouts.rb (в большинстве версий Rails к /db/migrate/***_create_shouts.rb файла /db/migrate/***_create_shouts.rb дата и время):

Это файл миграции базы данных. Rails использует их, чтобы помочь разработчикам правильно структурировать свои базы данных, поскольку они могут стать грязными, когда несколько разработчиков изменяют таблицы базы данных одновременно.
Вы также сможете откатить вашу базу данных до предыдущей версии, если вам нужно.

Здесь мы добавим поля нашей базы данных:

Это может выглядеть страшно, но это очень просто! t.string :name создает поле «имя» в базе данных, которое будет храниться в виде строки (т. е. «varchar»). То же самое касается поля «электронная почта».
Поле ‘message’ добавляется и сохраняется как текст (как в SQL).

Вы заметите, что Rails автоматически включает t.timestamps . Это включает в себя поля create_at и updated_at, которые Rails будет автоматически заполнять при создании или обновлении поля.
Кроме того, Rails автоматически создаст поле id, поэтому нам не нужно это определять самим.

Это эквивалентно следующей команде SQL:

Хотя для создания этих миграций может понадобиться немного привыкнуть, их гораздо проще набирать, чем SQL!

Наконец, выполните следующие две команды в Терминале, чтобы создать и настроить базу данных:

Первая команда создает базу данных с именем ‘shoutbox_development’. Второй запускает любые внешние миграции баз данных (в данном случае наш файл ***_create_shouts.rb ).

Запустите сервер, а затем перейдите по адресу http: // localhost: 3000 (или любой другой порт, на котором сервер говорит, что он работает — в большинстве случаев это 3000):

Чтобы удалить страницу приветствия по умолчанию, сначала удалите файл в /public/index.html , затем в /config/routes.rb вставьте следующее где-нибудь между первой и последней строками:

Вам нужно будет перезапустить сервер всякий раз, когда вы вносите изменения в контроллер или в маршруты — нажмите Ctrl + C, затем повторно запустите ruby script/server .

На этом завершается процесс настройки Rails. Хотя весь этот процесс может показаться сложным прямо сейчас, вы можете сделать это всего за несколько минут, и как только вы к нему привыкнете, это гораздо быстрее, чем настройка проекта CodeIgniter.

Фиктивные данные

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

Из папки вашего приложения в Терминале запустите ruby script/console . Это интерактивный интерпретатор Ruby, который также подключен к нашему приложению Rails, поэтому мы можем взаимодействовать с ним!

В отношении Rails следует помнить одну очень важную вещь: ваша модель автоматически связывается с соответствующей таблицей базы данных . Например, ваша модель «Кричать» связана с таблицей «крики» в вашей базе данных — это основная причина, по которой следование соглашениям по именованию Rails может быть очень полезным!

Запустите следующий код ruby ​​внутри интерактивной консоли:

Здесь мы вызываем new метод Rails для модели «Кричать» — это создаст новую запись в таблице базы данных криков. Мы также передаем хеш, содержащий данные, которые мы хотим ввести.
Это хранится в переменной «кричать».

Примечание. Хеш — это то, что PHP называет ассоциированным массивом — массивом, в котором вы также можете установить свой собственный ключ.
Примерный PHP-эквивалент этого кода:

Наконец, сохраните это в базу данных с помощью:

Если вы ввели код правильно, ruby ​​должен вернуть ‘true’.
Теперь вы можете получить это из базы данных с помощью:

Первая команда найдет самую последнюю строку в таблице «крики» и сохранит ее в переменной «крик». Мы можем найти конкретный элемент с shout.name который должен возвращать все, что вы ввели в качестве «имени» для записи.

Повторите Shout.new и Shout.save еще несколько раз, чтобы добавить больше записей в базу данных.

Отображение криков

Внутри файла /app/controllers/shouts_controller.rb введите следующее между существующим оператором класса:

Мы вызываем метод all_shouts из модели ‘Shout’ и сохраняем результат в переменной экземпляра shouts (как видно из @ ).

В CodeIgniter эквивалентный код был:

Некоторые заметные различия:

1. Rails использует символ «<» вместо «extends» при создании класса;
2. Для создания функции / метода мы используем def вместо function ;
3. Rails не требует метода конструктора;
4. Rails автоматически загружает файл представления для текущего метода. В этом случае файл представления находится по адресу /app/views/shouts/index.html.erb ;
5. Уже заметно, что код в Rails намного чище. Вам не нужны скобки (скобки) при определении функции / метода, если он не содержит никаких параметров, нам не нужно добавлять точку с запятой в конце каждого оператора, и в поле зрения нет фигурных скобок!

Модель

Внутри /app/models/shout.rb введите следующее внутри класса, чтобы определить функцию all_shouts :

Здесь мы запускаем Rails ‘ find для модели Shout (т. Е. Таблицы криков). Мы передаем хеш, сообщающий методу ограничить количество результатов до 10 в порядке убывания.
Это эквивалентный код CodeIgniter:

Да … намного проще!
Также обратите внимание, что в Ruby, если вы специально не return что-либо, автоматически возвращается последний оператор. Например, мы могли бы использовать следующее вместо этого (хотя это не имело бы никакого значения):

Вид

В CodeIgniter нам приходилось вручную включать файлы верхнего и нижнего колонтитула в каждом представлении. Rails использует немного другой подход. Внутри /views/layouts/ создайте файл с именем application.html.erb со следующим внутри:

Это преимущественно обычный HTML-макет, сочетающий в себе как верхний, так и нижний колонтитулы. В строке 7 мы включаем ссылку на таблицу стилей. Rails предоставляет папку /public/ в которую вы включаете изображения, таблицу стилей, файлы javascript и любые статические файлы HTML. В этом случае код выведет ссылку на таблицу стилей по адресу /public/stylesheets/style.css .

Далее в строке 21 находится <%= yield %> . Это вставит файл основного вида для конкретной страницы в этом месте.

Почему .html.erb? Все файлы представлений в Rails сначала имеют расширение для определенного формата, который вы хотите выводить, а затем .erb, чтобы сервер интерпретировал код Ruby внутри него.
Это означает, что у вас также может быть файл .xml.erb, если вы хотите экспортировать в XML для определенных страниц и т. Д.

<%= %> Ruby использует <% и %> чтобы обернуть любой код Ruby для интерпретации, так же как PHP использует <?php и ?> .
На страницах HTML мы используем <%= ... %> (обратите внимание на равно), чтобы «напечатать» код. В PHP мы используем <?php echo ... ?> Или <?= ... ?> Для ‘echo’ кода.

Внутри /public/stylesheets/ создайте файл с именем style.css содержащий тот же CSS, который мы использовали в разделе CodeIgniter.
Также вставьте изображения из раздела CodeIgniter в /public/images/ .

Если вы перезагрузите сервер сейчас и перезагрузите браузер, вы должны увидеть страницу ошибки «Шаблон отсутствует». Это потому, что мы еще не создали фактическое представление для текущей страницы.

Страница ошибки «Шаблон отсутствует» сообщает нам, какой файл он ожидал:
«Отсутствует шаблон shouts/index.html.erb в пути просмотра app/views «
Итак, давайте создадим этот файл сейчас и введем следующее, чтобы проверить его:

Перезагрузите страницу, и вы должны увидеть следующее (если нет, проверьте, что у вас есть таблица стилей и изображения в правильных местах):

перекручивание

Вы помните, что в CodeIgniter мы использовали приведенный ниже код для циклического просмотра и отображения каждого полученного крика:

Эквивалент в Ruby следующий (замените сообщение «Hello, World!» Этим):

В строке 2 находится обычный цикл ‘foreach’ в Ruby. Вместо foreach ($shouts as $shout) в PHP мы используем for shout in @shouts в Ruby.

Цикл замыкается в end строки 16.

В строке 4 мы создаем URL Gravatar почти так же, как в PHP, с некоторыми исключениями:

1. В PHP мы используем символ точки (.) Для объединения операторов, Ruby использует символ плюс (+), как в JavaScript;
2. Рубиновая версия PHP-функции md5() — Digest::MD5.hexdigest() ;
3. Функция h() в Ruby эквивалентна PHP htmlspecialchars() ;
4. PHP использует -> для доступа к объекту (например, $shout->email ). Ruby использует точку (например, shout.email );
5. Чтобы адрес электронной почты был в нижнем регистре, мы используем strtolower($shout->email) в PHP. В Ruby все является объектом, поэтому мы просто добавляем .downcase к концу строки или переменной — shout.email.downcase . Вы также можете .upcase , .reverse и т. Д.

Обновите страницу в вашем браузере, и теперь вы должны увидеть сообщения!

Форма представления

Продолжая, мы должны включить форму внизу страницы для отправки новых криков. Сначала взгляните на следующую строку:

Это блок из помощника форм Rails для простого создания форм. form_for :shout связывает форму напрямую с моделью Shout.

:url = { :action = 'create ' } — это хэш, детализирующий, куда форма будет направлена ​​при отправке. В этом случае форма перейдет в / shouts / create / (Контроллер криков, метод Create). Мы могли бы набрать:: :url = { :controller = 'shouts', :action = 'create } , однако отсутствие ключа’ controller ‘в хэше указывает Rails использовать текущий контроллер.

Наконец, do |f| сохраняет все ранее в переменной f . Например, мы могли бы создать текстовое поле, связанное с этим, используя f.text_field

Теперь мы объяснили, что введите полный код формы внизу файла представления индекса:

И сравните это с версией CodeIgniter PHP:

Мы больше используем помощник по формам Rails при создании полей ввода, текстовой области и кнопки отправки. С помощью f.text_field :name, :size = 20 мы создаем текстовое поле с именем ‘name’ (соответствующее столбцу в нашей базе данных, в который он должен быть вставлен). Это вывело бы в HTML как:

В версии приложения CodeIgniter мы установили для каждого поля ввода значение « <?= set_value('email') ?> Поэтому CodeIgniter автоматически заполнит поля, если они не пройдут проверочные тесты.
В Rails это обрабатывается автоматически, так как мы используем помощник по формам Rails для создания входных данных.

Обновите страницу в вашем браузере, и вы должны увидеть форму внизу:

Представление и проверка

Следующим шагом является вставка любых отправленных данных в базу данных. Форма направлена ​​на shouts / create, поэтому давайте сейчас создадим действие create (внутри контроллера):

В строке 2 мы извлекаем все наши текущие крики из базы данных, так как они все еще должны отображаться.

В строке 4 мы загружаем new функцию Rails для нашей модели Shout. Вы помните, что мы использовали Shout.new при вставке фиктивных данных в базу данных через интерактивную консоль.
Мы передаем new представленные данные с помощью params[] — так Rails обращается к данным POST.
Это загружается в переменную экземпляра @shout .

Когда мы использовали интерактивную консоль, мы использовали shout.save для сохранения данных. Если он был успешным, он возвращает «true», в противном случае возвращается «false». Таким образом, в строке 5 мы проверяем, можно ли сохранить крик в базе данных, если это так, мы загружаем уведомление об успешном завершении в «флэш-данные» сеанса и перенаправляем обратно в индекс.
В противном случае мы загружаем файл представления индекса через функцию render .

Проверка

Вы можете задаться вопросом, где обрабатывается наша проверка, так как мы сделали это в контроллере в CodeIgniter. В Rails мы размещаем правила внутри Модели.
Когда Rails пытается вставить данные в базу данных (например, с помощью @shout.save ), Модель автоматически проверит данные на соответствие нашим правилам, прежде чем пытаться их сохранить. Таким образом, если проверка не @shout.save , то @shout.save вернет значение «false», представление будет перезагружено и отобразятся сообщения об ошибках.

Внутри модели Shout вставьте следующее, прежде чем мы определим self.all_shouts :

В истинном стиле Ruby правила проверки читаются почти как естественный английский. В строке 1 мы гарантируем, что «сообщение» существует.

Далее мы проверяем длину поля ‘name’ — оно должно быть от 1 до 255 символов. 1..255 определяет диапазон. Например, мы можем определить диапазон от 10 до 15 с 10..15 .

Наконец, мы проверяем отправленное письмо в формате адреса электронной почты с использованием регулярного выражения. По сути, отправленное письмо должно состоять из пяти частей:

1. Строка, содержащая комбинацию букв, цифр, подчеркивания, полной точки или дефиса;
2. Символ;
3. Строка, содержащая комбинацию букв, цифр или дефиса;
4. Точка;
5. Строка, содержащая комбинацию букв или дефис.

И наконец…

Теперь нам просто нужно отобразить сообщения об ошибках / успехе в представлении (см. Выше). Добавьте следующее в верхней части файла представления индекса:

В первой строке мы отображаем любые сообщения об ошибках для формы. Мы устанавливаем :header_message и :message в nil (Ruby использует ‘nil’, PHP использует ‘null’), чтобы остановить функцию, отображающую нормальные сообщения, которые она отображает (нам просто нужны сообщения об ошибках).

Вторая строка отображает наше успешное сообщение. Обратите внимание на if flash[:notice] note if flash[:notice] в конце строки. Это гарантирует все, прежде чем он попытается отобразить, если существует уведомление вспышки.
Очевидно, мы могли бы также сделать следующее; однако это имело бы тот же эффект:

Это оно!

Попробуйте, он должен функционировать точно так же, как версия CodeIgniter, но с гораздо меньшим количеством кода (который также намного легче читать!)

CodeIgniter:
Контроллер: 31 линия
Модель: 33 линии
Вид: 69 строк
Всего: 133 строки

Рубин на рельсах:
Контроллер: 19 линий
Модель: 11 линий
Просмотр: 64 строки
Всего: 94 строки

Хотя это руководство, возможно, сделало процесс разработки приложения на Rails слишком сложным, оглянуться назад на свой код и посмотреть, насколько все просто!

Если это руководство вызвало у вас интерес к Ruby и Ruby on Rails, я настоятельно рекомендую приобрести копию Rails для разработчиков PHP , гибкую веб-разработку с использованием Rails и / или программирование Ruby от программистов Pragmatic.

Теперь иди! Отправляйся исследовать мир Rails!