DevSimple

Эпизод #5 - Overcommit

2019-05-11T19:24:00+05:00

Overcommit - инструмент для удобного управления хуками гита, рассмотрим его как инструмент для самоконтроля по написанию чистого кода. Overcommit будет полезен как фронтендерам, так и бекендерам за счет того, что имеет большую базу предустановленных хуков. В данной статье будет рассмотрена настройка проверки кода утилитами RuboCop и Fasterer при каждой попытке сделать коммит.

Установка

Overcommit устанавливается как gem, командой:

gem install overcommit

Теперь можно устанановить хуки в репозиторий.

Важно: установка производится в корневом каталоге проекта, где инициализирован Git репозиторий. Если репозиторий не инициализирован, то запустите команду git init.

overcommit --install

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

overcommit --uninstall

Конфигурация

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

Предположим, что мы хотим настроть хуки, которые будут срабатывать каждый раз, когда мы создаем новый коммит (PreCommit). Хуки должны проверить код на соответствие так называемым style-guide и убедиться, что при написании кода мы использовали самые оптимальные методы. В этом нам помогут уже знакомые по предыдущим эпизодам инструменты Rubocop и Fasterer. Все возможные PreCommit-хуки можно найти тут.

Начнем с подключения Rubocop.

.overcommit.yml

Precommit:
  RuboCop:
    enabled: true

Указываем момент срабатывания хука - PreCommit.
Прописываем название самого хука - Rubocop.
Активируем его enabled: true

Далее нужно определиться с поведением хука для строк, которые не были модифицированны. Ранее мы определились, что мы хотим, чтобы хук анализировал только тот код, который был изменен. Поэтому нужно добавить опцию problem_on_unmodified_line с флагом ignore. А также определить поведение, когда будут найдены несоответствия. Настроим так, чтобы коммит нельзя было создать, пока не будут исправлены все несоответствия. В этой задаче нам поможет флаг on_warn с флагом fail.

Precommit:
  RuboCop:
    enabled: true
    on_warn: fail
    problem_on_unmodified_line: ignore

Часто требуется исключить некоторые файлы из проекта. Допустим, мы работаем над Rails проектом и хотим исключить из хука Rubocop все файлы, которые лежат в директории **/db/. Тогда наш конфигурационный файл примет следующий вид:

Precommit:
  RuboCop:
    enabled: true
    on_warn: fail
    problem_on_unmodified_line: ignore
    exclude:
      - '**/db/'

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

Precommit:
  RuboCop:
    enabled: true
    on_warn: fail
    problem_on_unmodified_line: ignore
    exclude:
      - '**/db/'

  Fasterer:
    enabled: true
    on_warn: fail
    problem_on_unmodified_line: ignore

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

gem install fasterer rubocop

После того как конфигурационный файл подготовлен необходимо прописать новые хуки в настройки вашего репозитория:

overcommit --sign

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

Использование

После того как Overcommit настроен и хуки прописаны в вашем репозитории, при попытке сделать коммит, будет производиться анализ измененного кода. Если будут найдены какие-либо несоответствия прописанным правилам, созадние коммита будет прервано и указаны инструкции для испавления ошибок.

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

class User
  attr_reader :first_name, :last_name, :email, :admin?

  def self.first_admin
    all.select { |user| user.admin? }.first
  end

  def role_name
    if admin?
      "Администратор"
    else
      "Пользователь"
    end
  end
end

Добавим новый код репозиторий:

git add user.rb
git commit

Добавленный код был проанализирован, коммит отменен и мы видим допущенные ошибки.

Внесем изменения согласно данному отчету:

class User
  attr_reader :first_name, :last_name, :email, :admin?

  def self.first_admin
    all.detect(:admin?)
  end

  def role_name
    if admin?
      'Администратор'
    else
      'Пользователь'
    end
  end
end

Повторим создание коммита:

git add user.rb
git commit

Теперь код валиден и мы можем завершить создание коммита

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

SKIP=RuboCop git commit # пропустить хук RuboCop
ONLY=RuboCop git commit # запустить только RuboCop
OVERCOMMIT_DISABLE=1 git commit # отключить все хуки

Для удобства можно создать алиасы для часто используемых команд.

Обязательно загляните в оф. репозиторий и изучите все возможности Overcommit.

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

BAT - улучшенный CAT с подсветкой синтаксиса

2019-01-26T10:24:00+05:00

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

Установка

Ubuntu

Скачайте последнюю версию .deb пакета отсюда и выполните команду:

# замените имя пакета, на скаченный вами
sudo dpkg -i bat_0.9.0_amd64.deb

MacOS

Установите bat с помощью пакетного менеджера Homebrew:

brew install bat

Arch Linux

Установите пакет bat из официального репозитория:

pacman -S bat

Другие системы

Если в списке выше вы не нашли своей операционной системы, то загляните в репозитрий.

Использование

Чтобы посмотреть содержимое файла, нужно выполнить команду:

bat file01.md

Вы также можете посмотреть содержимое сразу нескольких файлов:

bat file01.md file02.md

Или соединить несколько файлов в один:

bat file01.md file02.md > multifile.md

Перейдем к основным преимуществам bat.

Интеграция с Git

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

Подсветка синтаксиса

bat поддерживает подсветку синтаксиса для большого кол-ва языков разметки и программирования.

bat posts_controller.rb

С полным списком можно познакомиться, написав команду:

bat --list-languages

Конфигурация

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

bat --list-themes

Для использования темы, для примера возьмем Monokai Extended Origin, запустите:

bat --theme="Monokai Extended Origin" posts_controller.rb

Для того, чтобы изменить тему по умолчанию, можно присвоить переменной окружения BAT_THEME понравившуюся тему:

export BAT_THEME="TwoDark"

Добавление новой темы

Первое, что нужно сделать, это создать папку, где мы будем хранить новые темы:

mkdir -p "$(bat --config-dir)/themes"
cd "$(bat --config-dir)/themes"

Теперь ищем тему с расширением *.tmTheme, например по этой ссылке, скачиваем, копируем в только что созданную папку и обновляем кэш:

# Перемещаем скачанную тему Railscasts.tmTheme
mv ~/Downloads/Railscasts.tmTheme .

# Обновляем кэш
bat cache --build

После этого новая тему будет доступна для выбора.

Файл конфигурации

Есть еще один вариант изменения настроек по умолчанию, использовать файл настроек. Для этого нужно создать файл bat.conf и через переменную окружения BAT_CONFIG_PATH указать путь к этому файлу:

export BAT_CONFIG_PATH="/path/to/bat.conf"

Пример такого файла:

# Установить тему по умолчанию "TwoDark"
--theme="TwoDark"

# Показать номера строк, изменения Git и отобразить имя файла
--style="numbers,changes,header"

На этом все. Надеюсь, что этот пост был вам полезен.

Эпизод #4 - Chartkick

2018-08-30T03:17:00+05:00

В этом эпизоде рассмотрим возможности визуализации данных с помощью библиотеки Chartkick.

Ссылки:

Faker: https://github.com/stympy/faker
Chartkick: https://github.com/ankane/chartkick
Оф. документация Chartkick: https://www.chartjs.org/docs/latest/
Groupdate: https://github.com/ankane/groupdate
Highcharts: https://www.highcharts.com/demo
Код: https://github.com/dev-simple/charts

Эпизод #3 - Hound

2017-12-12T23:54:00+05:00

В этом эпизоде рассмотрим HoundCI, инструмент для автоматического анализа кода в Pull Request’ах, который работает в связке с GitHub. Hound может проанализировать несколько типов кода. Для каждого типа он использует свою технологию:

Ruby - Rubocop
CoffeeScript - CoffeeLint
JavaScript - JSHint
SCSS - SCSS-Lint
SASS - SASS-Lint
Haml - Haml-Lint
Go - Golint
Swift - SwiftLint
ESLint - ESLint
Python - Flake8
TypeScript - TSLint
Elixir - Credo

Подробнее можно посмотреть в оф.документации

Как это работает

Вы пишите код
Делает Pull Request
Hound проверяет ваш код и комментирует все проблемные места от имени пользователя houndci
Вы исправляете замечания
Делаете merge с master

Подключаем Hound к проекту

Первое, что необходимо сделать, это выполнить Вход используя свой GitHub аккаунт. После этого вы увидите список всех Ваших репозиториев. Для того, чтобы активировать Hound, нужно в строке с нужным репозиторием нажать на кнопку Activate.

После этого Hound будет делать Code Review для каждого Pull Request’а в вашем проекте.

Конфигурация

Мы можем подключить или отключить любой из линтеров. Разместите в корне Вашего проекта файл .hound.yml и, к примеру мы хотим отключить SCSS, напишем следующее:

scss:
  enabled: false

Это строка отключит слежку за файлами *.scss.

Мы также можем подключить свой файл конфигурации для каждого линтера. Для Ruby это может выглядеть так:

ruby:
  config_file: .rubocop.yml

Также можно исключить некоторые файлы из проверки:

scss:
  exclude:
    - "app/assets/stylesheets/plugins/**"

Hound очень удобен и прост в использовании. Он поможет Вам сохранить массу времени для поддержания чистого кода.

Ссылки

Hound: https://houndci.com/
Оф. документация: https://houndci.com/configuration
Проект, используемый в видео: https://github.com/dev-simple/create_blog_on_rails

Эпизод #2 - Rubocop

2017-12-04T01:33:00+05:00

В этом эпизоде поговорим о стиле программирования. Если вы работаете в команде, коммитите в Open Source проекты или просто хотите чтобы ваш код был чище и читабельнее, то этот урок будет для вас полезен.

Ruby очень гибкий язык, который дает нам возможность писать идентичный по функциональности код разными способами. Вы наверняка хоть раз задумывались о том, где делать отступы, использовать для блока конструкцию do … end или же использовать { ... }, использовать def с круглыми скобками, если у метода есть переменные или нет…

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

Например в Ruby-style-guide вы можете увидеть, что необходимо использовать 2 пробела в качестве уровня отступа и не использовать табуляцию.

Для более удобного восприятия больших чисел необходимо использовать нижнее подчеркивание _

# плохо (Сколько тут нолей?)
num = 1000000

# хорошо (число воспринимается гораздо легче)
num = 1_000_000

Для того, чтобы придерживаться этому своду правил существует статический анализатор кода Rubocop.

Rubocop

Для того, чтобы проанализировать ваш код, Rubocop использует так называемые cop'ы. Существует несколько категорий cop'ов:

Style - анализирует стиль кода (форматирование)
- Style/TrailingWhitespace - не использовать пробел в конце строки
- Style/UnlessElse - не использовать Unlses вместе с Else, т.к. Это затрудняет чтение вашего кода
- Style/StringLiterals - использование двойной или одинарных кавычек
Layout - анализирует использование отступов, выравнивание
- ayout/AlignArray - выравние элементов в массиве, который имеет Болле одной строки
- ayout/AlignHash - выравние элементов в хэше, который имеет Болле одной строки
Lint - анализирует синтаксис и плохие практики
- Lint/AssignmentInCondition - присвоение значения переменной в условии
- Lint/DuplicateMethods - проверяет наличие повторяющихся методов
Metrics - различные метрики кода
- Metrics/LineLength - следит за длиной строки
- Metrics/MethodLength - следит за числом строк в методе
Naming - следит за ошибками в наименовании, таких как наименование метода, констант и т.д.
- Naming/AccessorMethodName - следит за тем, чтобы вы не использовали в наименовании методов get и set префиксы
- Naming/AsciiIdentifiers - следит за тем, чтобы в наименовании не использовались non-ascii символы
Performance - следит за тем, чтобы использовались более быстрые семантически эквивалентные методы.
- Performance/Detect - использовать detect вместо констуркции select.first
- Performance/FlatMap - использовать flat_map вместо конструкции map.flatten
Security - следит за потенциально не безопасными методами и конструкциями
Rails - специфичный для Ruby on Rails проектов
- Rails/ApplicationRecord - следит за тем, чтобы модель наслаивалась от ApplicationRecord вместо ActiveRecord::Base
- Rails/DynamicFindBy - следит за динамическими методами find_by_*, рекомендуя использовать find_by
Bundler - следит за стилями и хорошими практиками в Gemfile
- Bundler/DuplicatedGem - следит за дупликатами в Gemfile
- Bundler/OrderedGems - следит за тем, чтобы gem'ы объявлялись в отсортированном порядке
Gemspec - следит за стилями и хорошими практиками в gemspec файлах

Подробнее можно почитать в официальной документации.

Практика

Установим rubocop console gem install rubocop

Для примера используем код из курса «Создание блога Rails». Перейдем в папку проекта и запустим rubocop c флагом -D для отображения cop'а, который вызвал нарушение

cd blog
rubocop -D
…
db/migrate/20170212144127_devise_create_users.rb:33:1: C: Layout/EmptyLines: Extra blank line detected.

75 files inspected, 236 offenses detected

Мы видим, что rubocop проанализировал проект и нашел 236 нарушений в 75 файлах. Так же в каждой строке можно увидеть какой именно cop обнаружил нарушение. В нашем примере последнее нарушение найдено cop'ом Layout/EmptyLines. Он говорит нам, что в 33 строке одной из миграций есть пустая строка. Можно вывести все нарушения связанные с этим cop'ом

rubocop -D --only Layout/EmptyLines

Inspecting 75 files
..C.......................................................................C

Offenses:

Gemfile:3:1: C: Layout/EmptyLines: Extra blank line detected.
db/migrate/20170212144127_devise_create_users.rb:33:1: C: Layout/EmptyLines: Extra blank line detected.

75 files inspected, 2 offenses detected

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

Для удобства Rubocop поддерживает режим автокоррекции. Для этого достаточно запустить rubocop c флагом -a. Если скомбинировать с флагом --only и указать конкретный cop, то будут исправлены только присущие данному cop'у нарушения.

rubocop -D -a --only Layout/EmptyLines

Inspecting 75 files
..C.......................................................................C

Offenses:

Gemfile:3:1: C: [Corrected] Layout/EmptyLines: Extra blank line detected.
db/migrate/20170212144127_devise_create_users.rb:33:1: C: [Corrected] Layout/EmptyLines: Extra blank line detected.

75 files inspected, 2 offenses detected, 2 offenses corrected

Мы видим, что нарушения были исправлены. При повторном запуске rubocop, данных нарушений уже не будет

rubocop -D --only Layout/EmptyLines

Inspecting 75 files
...........................................................................

75 files inspected, no offenses detected

Автокоррекция надежный помощник, но бывают случаи когда не возможно автоматически скорректировать ваш код. Ярким примером может послужить cop Metrics/LineLength, который следит за длинной строки.

rubocop -D -a --only Metrics/LineLength

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

Конфигурация Rubocop

По умолчанию Rubocop следит за всеми нарушениями, но вы можете изменить его поведение, добавив правила в файл .rubocop.yml.

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

В этом файле можно отключить любой cop или исключить отслеживаемые файлы. К примеру мы хотим исключить файл config/initializers/devise.rb, все файлы в папке db и увеличить длину строки до 120 символов. Для этого в файле .rubocop.yml напишем следующее

AllCops:
  Exclude:
    - 'config/initializers/devise.rb'
    - 'db/**/*'
Metrics/LineLength:
  Max: 120

Приведу другой пример. Теперь мы хотим отключить cop который отвечает за документацию класса Style/Documentation. Для этого в нашем конфиг-файле добавим следующую строку:

Style/Documentation:
  Enabled: false

При запуске команды rubocop -D мы больше не увидим нарушений этого типа. Но если ввести команду rubocop -D --only Style/Documentation, то нарушения снова отобразятся.

Чтобы каждый раз не вводить флаг -D для отображение имени cop'a нам может пригодится настройка DisplayCopNames: true в секции AllCops

AllCops:
  DisplayCopNames: true
  Exclude:
    - 'config/initializers/devise.rb'
    - 'db/**/*'

Metrics/LineLength:
  Max: 120

Style/Documentation:
  Enabled: false

Git Хук

Велика вероятность того, что вы можете забыть проверить ваш код перед коммитом в репозиторий. Чтобы исключить вероятность человеческого фактора воспользуемся pre-commit хуком для git.

В каждом проекте, в котором был инициализирован git репозиторий есть папка .git/hooks. Создайте файл pre-commit и скопируйте в него содержимое из файла по ссылке https://gist.github.com/artanikin/95ab0189d42d05da92f74fdee6d38abf

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

chmod +x .git/hooks/pre-commit

Данный хук отслеживает все измененные в коммите файлы и «натравливает» на них rubocop. Если были найдены какие-либо нарушения, то rubocop предложит вам их исправить перед коммитом.

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

Для примера внесем изменения в файл app/controllers/admin/posts_controller.rb, сохраним его и сделаем коммит.

git add app/controllers/admin/posts_controller.rb
git commit -m ‘Test commit’
Inspecting 1 file
C

Offenses:

app/controllers/admin/posts_controller.rb:1:1: C: Style/FrozenStringLiteralComment: Missing magic comment # frozen_string_literal: true.
class Admin::PostsController < Admin::AdminController
^
app/controllers/admin/posts_controller.rb:1:7: C: Style/ClassAndModuleChildren: Use nested module/class definitions instead of compact style.
class Admin::PostsController < Admin::AdminController
      ^^^^^^^^^^^^^^^^^^^^^^
app/controllers/admin/posts_controller.rb:2:34: C: Style/SymbolArray: Use %i or %I for an array of symbols.
  before_action :set_post, only: [:edit, :update, :destroy]
                                 ^^^^^^^^^^^^^^^^^^^^^^^^^^
app/controllers/admin/posts_controller.rb:18:3: C: Style/EmptyMethod: Put empty method definitions on a single line.
  def edit ...
  ^^^^^^^^

1 file inspected, 4 offenses detected
Would you like to continue press 'any key' or 'n/N' to halt?

Мы видим все нарушения, который нашел rubocop. Если мы хотим их исправить, то просто вводим n и нажимаем Enter.

Ссылки:

Ruby Style Guide: https://github.com/arbox/ruby-style-guide/blob/master/README-ruRU.md
Rails Style Guide: https://github.com/arbox/rails-style-guide/blob/master/README-ruRU.md#activerecord
Rubocop: https://github.com/bbatsov/rubocop
Rubocop оф. документация: http://rubocop.readthedocs.io/en/latest/
Git Hook: https://gist.github.com/artanikin/95ab0189d42d05da92f74fdee6d38abf

Эпизод #1 - Fast Ruby & Fasterer

2017-11-28T05:00:00+05:00

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

Ссылки:

fast-ruby: https://github.com/JuanitoFatas/fast-ruby
fasterer: https://github.com/DamirSvrtan/fasterer
Код из видео: https://github.com/dev-simple/lessons_code/tree/master/fast_ruby