Оvercommit - convenient Git hook manager

Voldemar Duletskiy, Ruby developer, Evrone, Moscow Ruby Meet-up 6 report
01 August 2017   4023
Ruby

Dynamic, open source programming language with a focus on simplicity and productivity, it has an elegant syntax that is natural to read and easy to write.

Hello Ruby fans! Today we will talk about Overcommit - the convenient management of git-hooks.

Imagine that you have a small project with a micro-team of three or four people, including the manager. Deadline is near, but you cannot lower the quality of the code. You don't wanna use CI and there are no extra money for it.

What is hooks and where are they located?

It is the scripts that are executed at certain event. You can view all existing hooks by running the following command:

ls -la .git/hooks

You will see this listing:

-rwxr-xr-x   1 voldemar  staff  3755 28 Jun 16:39 commit-msg
-rwxr-xr-x   1 voldemar  staff  3755 28 июн 16:39 overcommit-hook
-rwxr-xr-x   1 voldemar  staff  3755 28 Jun 16:39 post-checkout
-rwxr-xr-x   1 voldemar  staff  3755 28 Jun 16:39 post-commit
-rwxr-xr-x   1 voldemar  staff  3755 28 Jun 16:39 post-merge
-rwxr-xr-x   1 voldemar  staff  3755 28 Jun 16:39 post-rewrite
-rwxr-xr-x   1 voldemar  staff  3755 28 Jun 16:39 pre-commit
-rwxr-xr-x   1 voldemar  staff   673  2 Jun 14:37 pre-commit.sh
-rwxr-xr-x   1 voldemar  staff  3755 28 Jun 16:39 pre-push
-rwxr-xr-x   1 voldemar  staff  3755 28 Jun 16:39 pre-rebase

Hook is an executable file, which can content anything, including the Ruby code.

Why it is cool?

  • You can put linters like rubocop to the pre-commit hooks. It will not allow you to commit substandard code
  • You can hang up rspec to the pre-push hooks, and if the tests are dropped - cancel code sending
  • If you are already actively using hooks - you don't need to drag them from one repository to another, they all lie in .ovecommit.yml in a convenient format
RuboCop

Ruby static code analyzer, based on the community Ruby style guide

If you suffer from dispersion and you are sick of messages from your CI that tests have dropped again, or the ruby-cop found a million syntactic violations (or your colleagues in the code-review process). If you are an experienced developer, a good set of hooks seriously discourages young developers and reduces your code-review time. 

Intallation

Gemfile:

gem 'overcommit'

Execude from the consol:

bundle exec overcommit --install

 Now let's edit .overcommit.yml file

PreCommit:
  RuboCop:
    enabled: true
    command: ['bin/bundle', 'exec', 'rubocop', '-R']
    on_warn: fail
  HamlLint:
    enabled: true
    command: ['bin/bundle', 'exec', 'haml-lint', 'app/views/']
    on_warn: fail
  ScssLint:
    enabled: true
    command: ['bin/bundle', 'exec', 'scss-lint']
    include: 'app/assets/**/*.scss'
    on_warn: fail

PrePush:
  RSpec:
    enabled: true

We can see here that the launch of the rubocop scripts is describled in nice forman. haml-linter, sccs-linter and tests runs just before the commit.

In order to enforce hook running this should be executed:

bundle exec overcommit -R

Now, with every attempt to commit something, checks will be performed firstly.

 

Underwater rocks

If there are a lot of tests or they are dropping randomly - if you already have a habit to brew coffee while test runs, it's better to chop the hook responsible for running the tests. If they fall randomly - fix the tests at last, damn it.

Integration with Rubymine - I have serious problems with the integration of Overcommit and Rubymine

Continuous Integration

The practice of merging all developer working copies to a shared mainline several times a day

Overcommit and CI integration - if you still decide to connect CI, then most likely it already provides validation for the code. Often, their rules don't match and you have to adjust the settings, for example Rubocop under CI, or vice versa.

You can skip hooks by running git commit --no-verify

Conclusion

Overcommit is an excellent utility for maintaining a project in good shape for small teams. It will allow you not to grab your head every time after creating a pool of the requester with exclamations "Damn, I forgot to use rubocop again!" or "Damn, all the tests fell!".

Ruby/RoR News Digest 11 - 17.01

A migration path to Bundler 2+, the updated Ruby bibliography, testing signed and encrypted cookies in rails and more
17 January 2020   122

Greetings! I hope your week went great! Here's new Ruby news digest.

Learn the 3 ways webpack surprises coders, about the the pros and cons of using structure.sql in your Rails app, developers feedback on contributing to Ruby MRI and many other interesting things.

Articles

  • A Migration Path to Bundler 2+

The migration path the Bundler team could use for moving to Bundler 2+

  • 3 ways Webpack surprises web developers

Check what skilled learned helping with Webpack questions on StackOverflow for a month and why it may be really surprising even for the experienced programmer

  • The Ruby Bibliography

Great and recently updated list of must-read Ruby books

  • The Pros and Cons of Using structure.sql in Your Rails App 

Learn about the great differences and benefits of using structure.sql against the default schema.rb schema formats in your RoR apps

  • Contributing to Ruby MRI

Developer's feedback on contributing to the big Ruby "thing"

Guides

  • Effectively Using Materialized Views in Ruby on Rails

Learn what gives the materialized views in Postgres and how to use them in Rails

  • Testing Signed and Encrypted Cookies in Rails

Somethings, even such tasks come across the devs, so it's time to learn how to do that by checking author's experience

Updates

  • Rufo

An opinionated ruby formatter, intended to be used via the command line as a text-editor plugin

  • Solidus

Free and open-sourced ecommerce platform, built on the Rails

Podcast

  • 165: Rubyfmt with Penelope Phippen

The talk of 4 hosts (Coraline Ada Ehmke (speaker, writer, teacher, open source advocate and technologist with 20 years of experience), Jamey Hampton (an artist who turned into a programmer), Rein Henrichs(software developer) and Mandy Moore (show manager and producer of Greater Than Code)) with a Ruby developer and director of Ruby Central, ex-maintainer of RSpec about the popular code formating tool