Грабли 101

Эта статья объясняет основы Грабли. Это супер популярный инструмент для сборки, написанный на Ruby. Он предлагает большую гибкость и используется для управления всеми видами задач. Если вы используете Rails, я рекомендую заглянуть изнутри, чтобы узнать, какие задачи в вашем распоряжении и как написать свои.

темы

• Что такое грабли?
• Список заданий
• Начиная
• Пространства имен
• Предпосылки
• Передача аргументов
• Задачи интереса

Что такое грабли?

Благодаря Rails, Rake стал стандартом де-факто как инструмент сборки Ruby. Он очень популярен в сообществе Ruby. Очень рано команда разработчиков Rails решила использовать Rake в качестве сборщика для самого Rails, что означало, что в прошлом, когда вы загружали Rails, вам также требовалась копия Rake. Таким образом это выставило Рэйка большому количеству людей. Чуть позже он был включен в сам Ruby (1.9).

Rake де-факто заменил Unix-утилиту Make как инструмент для сборки на земле Ruby. Инструмент для сборки, такой как Rake, удобен для автоматизации задач различного типа — в основном, для управления задачами. Он часто используется для задач администрирования в Rails — где вы, скорее всего, уже сталкивались с этим — но вариантов его использования достаточно. Некоторые люди пишут свои книги в Markdown и настраивают задачи Rake, которые преобразуют соответствующие файлы в промежуточные HTML-файлы, которые затем, в свою очередь, преобразуются, например, в форматы электронных книг. Сохраняет много проблем, чтобы использовать Rake для этого.

Что делает Rake действительно мощным, так это то, что эти задачи могут быть связаны друг с другом и могут быть построены друг на друге. Кроме того, поскольку он написан на Ruby, вы можете написать любой код Ruby для ваших задач. Хотите использовать библиотеки Ruby в задачах Rake? Нет проблем! Забавный факт: это самый загружаемый RubyGem , более 100 миллионов загрузок. Так что определенно что-то в вашем поясе инструментов, на что вы должны уделить немного больше внимания.

Он был задуман покойным Джимом Вейрихом , известным и любимым разработчиком, докладчиком и участником экосистемы Ruby. Это действительно красивый инструмент — спасибо, Джим! ПОКОЙСЯ С МИРОМ!

Список заданий

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

Выход:

Вывод в приложении Rails на удивление обильный, не так ли? Вы можете найти намного больше удобных задач, чем обычные rake db:migrate или rake routes которые мы так хорошо знаем и выполняем несколько раз ежедневно.

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

Ракушка:

Выход:

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

Начиная

Rakefile может иметь одно из следующих пяти появлений:

• rakefile.rb
• rakefile
• Rakefile
• Rakefile.rb
• файлы .rake

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

Таможенная организация Rakefile

Rails делает это невероятно легко. В корне вашего приложения есть Rakefile. Он содержит следующее:

Rakefile

Когда у вас есть много пользовательских задач, имеет смысл разделить их на отдельные файлы .rake и поместить их в lib/tasks . Приведенный выше Rakefile просто загружает их, но каталог lib является лучшим логическим домом для задач. Существует даже генератор Rails для автоматизации части процесса. Если вы введете:

Ракушка

Вы получите Rakefile, автоматически помещенный в правильный каталог. Даже задача уже создана для вас. Ницца! В других проектах, не использующих Rails, вам просто нужно создать каталог rakelib и поместить туда свои файлы Rakefile — предпочтительно с .rake файлов .rake . Затем создайте файл с именем Rakefile и все эти файлы уже в вашем распоряжении.

Rake Task Anatomy

Lib / задачи / some_task.rake

Для полных новичков Ruby среди вас, и для людей, пришедших с языков с скобками, вот как это будет выглядеть в скобках.

Кстати, выглядит очень странно. Просто лишние скобки — никто не пишет задачи таким образом.

Мы предоставили именованное задание :about с описанием, которое не только напоминает нам в будущем о том, чего мы хотели достичь с помощью конкретных задач, но также отображается при запуске rake -T . Не ленитесь на этой части; это, вероятно, не стоит того.

Справа внизу находится ключевое слово task, которое определяет новую задачу с именем about . Это может быть вызвано в командной строке через rake about которые делают свою магию тогда. rake :about с другой стороны, вызовет прерывание Rake, не зная, «как построить задачу: about».

Через блок do end у нас есть lambda , и его тело определяет, что делает задача. Это базовая настройка, которая потребуется для выполнения задачи. Конечно, он предлагает гораздо больше возможностей, но общая структура остается неизменной.

требовать / импортировать

Некоторые рейкфайлы

Если вам нужно включить другие файлы Ruby или Rakefiles, это легко сделать с помощью стандартного оператора require .

Некоторые рейкфайлы

Сам Rake предоставляет нам другой способ сделать это — метод import . Это можно использовать в любой строке Rakefile. Этот поможет, если вы столкнетесь с проблемами, потому что требуемый файл был загружен до того, как Rakefile закончил загрузку и поэтому взорвался. Импортированный файл, с другой стороны, всегда будет загружаться после Rakefile.

вызвать и выполнить

Иногда вам может понадобиться выполнить определенную задачу из вашего класса Task вручную. Для этого у вас есть два метода класса Rake::Task : execute и invoke .

С помощью кода Rake::Task['some_task'] мы получили some_task Rake some_task для выполнения. Он возвращает экземпляр класса Rake::Task а затем запускает любой доступный метод.

Пространства имен

Очень интересная функция — это возможность именования ваших задач. Вы, наверное, уже использовали это десятки раз. Когда вы запускаете rake db:migrate , вы, например, используете пространство имен db . Вы вызываете задачу, отделяя ее двоеточием : из пространства имен. Пространства имен — это удобный способ организации ваших задач в виде файла rake — он сохраняет их логически разделенными. Несколько пространств имен, таких как rake time:zones:all в порядке, кстати.

Другие примеры включают в себя:

Некоторые рейкфайлы

Это базовая настройка. На самом деле все гораздо сложнее и может быть вложено несколько раз. Быстро взгляните на кодовую базу Rails и убедитесь сами, как реализован rake db:migrate . Не расстраивайся, если это над твоей головой. Просто оглянись вокруг, попробуй разобраться в том, как это устроено, и продолжай пока.

Предпосылки

Другой стратегией для организации ваших задач и их сохранения СУХОЙ является использование предпосылок для выполнения задачи. Это как зависимость, которая должна запускаться в первую очередь, прежде чем фактическая задача начинает свою работу. Таким образом, вы можете создавать более сложные задачи — настолько сложные, насколько вам нужно. Но я бы порекомендовал не становиться слишком умным и сделать его как можно более простым — и как можно более простым для понимания.

Некоторые рейкфайлы

Если вы хотите полагаться на несколько задач, вы просто помещаете их в массив. Конечно, порядок, в котором вы их размещаете, имеет значение.

Если вы запустите задачу rake, которая зависит от другой, мы получим следующий вывод:

Ракушка

Порядок, в котором вы определяете свои грабли, не влияет на вывод — только порядок, в котором вы помещаете в массив обязательные задачи для зависимостей задач. Также, пожалуйста, используйте для этого синтаксис hashrocket => .

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

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

Некоторые рейкфайлы

Важно отметить, однако: если вам нужно упомянуть пространство имен, вы должны передать обязательное условие в виде строки => 'marsellus_wallace:call_winston_wolf' .

Конечно, приведенные выше примеры являются глупыми, а не реальными примерами, но цель состояла в том, чтобы показать вам, как работают предпосылки и как вы их соедините, в то время как они зависят друг от друга.

Передача аргументов

У вас есть два варианта передачи аргументов в задачи Rake: либо используя переменные Bash, либо используя сам синтаксис Rake.

Переменная ENV

Если вы раньше не играли с Bash — или Bash звучит для вас как бред, — давайте возьмем пять и начнем с самого начала. Bash в вашей оболочке предлагает два вида переменных: глобальные (иначе среды) и локальные. Оба написаны в верхнем регистре. Переменные среды являются глобальными, что означает, что они доступны во всех оболочках и не исчезают при закрытии одной из них — в отличие от локальных переменных Bash, которые доступны только в текущей оболочке.

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

FYI

Немного в стороне, если вы env или ENV в своей оболочке, вы получите доступ к целому ряду переменных среды. Я отредактировал список, но для лучшего понимания, что такое переменные среды и что они включают, я призываю вас запустить его для себя.

Ракушка

Выход

Если вы хотите увидеть список локальных переменных Bash, вы можете запустить set .

Ракушка

Команда set дает вам намного больше выходных данных, но вышеприведенный момент показывает вам соответствующие биты.

Метод ENV класса Руби

Ruby предлагает способ использования окружения и локальных переменных Bash через хеш-подобный метод доступа. Для наших нужд, когда мы передадим переменную в задачу Rake, это будет локальная переменная Bash, которую вы можете найти в списке переменных, в которых запущен set или его разновидности. Ruby может прочитать его, используя ENV['VARIABLE'] .

Ракушка

Однако я хочу пояснить, что эта переменная не будет добавлена ​​в список ENV, который использует ваша система, — то, что вы видели при вызове env из оболочки. Чтобы добавить его в этот список, вам нужно будет его export . Это другая история , но я подумал, что должен это прояснить.

Некоторые рейкфайлы

В этом определении задачи вы можете увидеть, как мы подготовились принять или включить переменную, переданную в вызов задачи. ENV[BASHVARIABLE] Руби ENV[BASHVARIABLE] делает всю тяжелую работу. Если бы BOOKTITLE был глобальной переменной среды, мы могли бы получить к ней доступ и в этом определении задачи с помощью этого синтаксиса.

Синтаксис параметров Rake

Второй подход — использование чистого синтаксиса Rake. Вы просто передаете переменные в квадратные скобки. Такой подход лучше, и вы можете держать вещи более изолированными. Зачем привлекать Bash, если Rake вполне способен справиться с этим? Кроме того, у вас нет переменных Bash, плавающих таким образом. Если вы хотите передать несколько аргументов в задачу, это также намного элегантнее.

Ракушка

Некоторые рейкфайлы

Когда вы передаете больше аргументов, чем вы определили в своей задаче, вы можете просто получить к ним доступ через args . args.extras отображает массив всех дополнительно переданных параметров. args.to_a показывает вам все параметры — конечно же, в массиве.

Задачи интереса

Ниже приведен краткий список задач Rake, которые поставляются с Rails:

• децибел
• доктор
• TMP
• статистика
• Примечания
• около
• секрет
• активы
• маршруты

децибел

Ниже приведены несколько полезных задач в пространстве имен db для запуска миграций Active Record:

rake db:version печатает текущую версию схемы. Вывод выглядит примерно так:

rake db:migrate выполняет последнюю миграцию (и) — те, которые еще не выполнялись. Вы также можете передать конкретную миграцию для запуска.

Ракушка

rake db:create создает вашу базу данных. Если по умолчанию используется разработка и тестирование баз данных.

rake db:test:prepare гарантирует, что миграции, уже запущенные в вашей базе данных разработки, также будут выполнены для вашей тестовой базы данных. Если бы схема тестовой базы данных была не синхронизирована с вашей базой данных разработки, это, конечно, было бы не очень полезно.

rake db:drop:all удаляет как тестовые, так и разработанные базы данных по умолчанию.

rake db:migrate:up , rake db:migrate:down запускает методы up и down для рассматриваемой миграции.

rake db:redo гарантирует, что после запуска миграции миграция будет обратимой. Сначала запускается rake db:down а затем rake db:up .

rake db:rollback отменяет последнюю миграцию.

rake db:drop по умолчанию отбрасывает базы данных разработки и тестирования.

rake db:reset сначала удаляет базы данных и устанавливает их снова, загружая схему и заполняя базу данных.

доктор

rake doc:app генерирует документацию в doc/app . Он создает HTML-страницы о вашем исходном коде для удобного просмотра. Довольно круто!

Скриншот

rake doc:rails генерирует документацию API под doc/api также как HTML-страницы. Наверное, удобно, если вы не в сети.

TMP

Каталог tmp в корневом каталоге вашего Rails-приложения — это место для временных файлов, особенно файлов для сеансов и кеша. rake tmp:create вам все необходимое для работы с временными файлами. rake tmp:cache:clear очищает каталог tmp/cache rake tmp:sessions:clear очищает каталог tmp/sessions .

статистика

rake stats дает хороший обзор вашего приложения.

Примечания

Вы можете оставить заметки в своем коде. Вы можете добавить их в свои комментарии к TODO , FIXME , OPTIMIZE .

Какой-то Ruby-файл

Когда вы запускаете rake notes , Rake анализирует эти префиксы и получает список всех этих заметок из вашего кода.

Ракушка

Вы даже получите подробный список, где вы их найдете — каталог, имя файла, номер строки [Line Number] , все включено. Круто, верно?

около

rake about дает вам обзор номеров версий для:

• Рельсы
• Рубин
• RubyGems
• Адаптер базы данных
• Версия схемы
• Промежуточное
• Корень приложения

и много другой полезной информации.

секрет

Если вы не уверены в своем ключе сеанса и хотите заменить его, rake secret сгенерирует для вас новый псевдослучайный ключ. Это не заменит ключ для вас, хотя. Вывод в оболочке выглядит следующим образом:

активы

rake assets:precompile позволяет вам предварительно скомпилировать ваши активы в public/assets . Если вы хотите избавиться от старых активов, просто запустите rake assets:clean . Наконец, запуск rake assets:clobber удаляет весь каталог public/assets .

маршруты

rake routes могут быть наиболее важными. Он показывает вам все маршруты в вашем приложении.

Последние мысли

Написание Rake-заданий, не зная, что происходит под капотом, довольно быстро становится скучным. Эта статья была небольшой разминкой и введением для людей, которые впервые захотели заглянуть в Rake.

Я надеюсь, что он охватил все основы, не будучи слишком сухим — в конце концов, Rake — супер допинг и все такое, но в то же время, возможно, это не самая сексуальная игрушка. Эти базовые знания о Rake, тем не менее, должны дать вам все, что вам нужно, чтобы стать опасными, и расширить ваши знания о задачах Rake, которые находятся в вашем распоряжении.