Нам нужны твои мозги

Хотите расти как разработчик и найти крутую работу? Не протирайте штаны — займитесь Open Source проектами. Так легче всего попасть в лучшие команды разработчиков и положить себе в резюме настоящий проект, вместо нелепых «примеров кода». Но найти подходящий проект для участия сложно. Начинаются лень и отговорки, а за ними — отсутствие профессионального роста, критики по-настоящему крутых программистов, уныние и застой.

На Cult of Martians мы собираем интересные задачи для современных веб-программистов. Можно выбрать подходящую по сложности, продолжительности и специализации. Задачи не выдуманы «из воздуха» — каждая решает насущную проблему, и решить ее можно через создание нового Open Source проекта или улучшение существующего. Решайте задачи, прокачивайтесь, присылайте решение на оценку. Лучших могут пригласить к себе на работу компании, программистам которых понравится ваше решение.

Бэк: GraphQL RuboCop: добавить коп для проверки использования :hash_key

Для новичков, задача на пару дней

rubocop-graphql — Ruby gem, проверяющий на соответствие стилю код, использующий DSL graphql-ruby.

Необходимо реализовать коп FieldHashKey, проверяющий, что при объявлении поля везде, где возможно, используется опция :hash_key.

Польза: научиться писать копы для rubocop, принести пользу Ruby–сообществу.

GraphQL–тип включает в себя список полей — название, тип, описание и аргументы, которые описываются с помощью метода #field:

class Types::UserType < Types::BaseObject
  field :phone, String, null: true
end

По умолчанию интерпретатор попытается вызвать метод с тем же названием (если работает с объектом) либо достать значение ключа с тем же названием (если работает с Hash). Кроме этого, в этом же классе можно объявить метод с тем же названием (такой метод называется resolver method), и тогда будет использоваться он.

Иногда при работе с Hash требуется использовать значение, соответствующее ключу, не совпадающему с названием поля:

class Types::UserType < Types::BaseObject
  field :phone, String, null: true

  def phone
    object[:home_phone]
  end
end

Вместо этого следует использовать встроенную опцию :hash_key:

class Types::UserType < Types::BaseObject
  field :phone, String, null: true, hash_key: :home_phone
end

Постановка задачи

Если внутри класса—типа объявлен resolver method, в котором нет ничего, кроме извлечения значения из хэша по ключу (object[:something]), то нужно предлагать использовать опцию :hash_key:

class Types::UserType < Types::BaseObject
  field :phone, String, null: true
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use hash_key: :home_phone

  def phone
    object[:home_phone]
  end
end

Кроме этого, для этого копа необходимо реализовать метод #autocorrect, который будет удалять ненужный метод и добавлять опцию hash_key к объявлению поля:

class Types::UserType < Types::BaseObject
  field :phone, String, null: true, hash_key: :home_phone
end

Советы по реализации

  1. Разобраться с node pattern — инструментом rubocop для работы с AST.
  2. Посмотреть, как реализован аналогичный коп FieldMethod (он проверяет, что внутри resolver method не происходит только вызов метода на объекте).
  3. Посмотреть, как реализован метод #autocorrect в FieldMethod.

Инструкции по выполнению

  1. Обсудить задачу, если есть вопросы.
  2. Форкнуть проект rubocop-graphql на GitHub.
  3. Реализовать необходимый функционал и покрыть его тестами.
  4. Сделать Pull Request.