Ev Dolzhenko dolzenko

Improved YARD CHEATSHEET http://yardoc.org

forked from https://gist.github.com/chetan/1827484 which is from early 2012 and contains outdated information.

Templates to remind you of the options and formatting for the different types of objects you might want to document using YARD.

What I Wish I'd Known About Equity Before Joining A Unicorn

Disclaimer: This piece is written anonymously. The names of a few particular companies are mentioned, but as common examples only.

This is a short write-up on things that I wish I'd known and considered before joining a private company (aka startup, aka unicorn in some cases). I'm not trying to make the case that you should never join a private company, but the power imbalance between founder and employee is extreme, and that potential candidates would

Debugging in JRuby

Step-by-step debugging and stack navigation for JRuby code.

Problem: the common tools byebug and pry-byebug are MRI-only.

Prerequisites

Force JRuby to run in fully interpreted mode:
(otherwise next would behave like step)

Smart Caps Lock: Remap to Control AND Escape (Linux, Mac, Windows)

把 Caps Lock 變成智慧的 Control 以及 Escape ：

單獨輕按一下就是 Escape 。
若按下時同時按著其他鍵，就會是 Control 。

這應該是 Vim 和 Emacs 的最佳解了！(Emacs? Bash 的快捷鍵就是 Emacs 系列的)

Send Escape if you tap Caps Lock alone.

The standard names for indexes in PostgreSQL are:

{tablename}_{columnname(s)}_{suffix}

where the suffix is one of the following:

pkey for a Primary Key constraint;

key for a Unique constraint;

excl for an Exclusion constraint;

idx for any other kind of index;

There are three easy to make mistakes in go. I present them here in the way they are often found in the wild, not in the way that is easiest to understand.

All three of these mistakes have been made in Kubernetes code, getting past code review at least once each that I know of.

Loop variables are scoped outside the loop.

What do these lines do? Make predictions and then scroll down.

func print(pi *int) { fmt.Println(*pi) }

	# Download this to your Rails app directory and run with:
	# bin/rails runner upgrade_encrypted_secrets.rb

	# Everything below here is private API and not something your app should use.
	Rails::Secrets.singleton_class.prepend Module.new {
	def decrypt(data)
	cipher = OpenSSL::Cipher.new("aes-256-cbc").decrypt
	cipher.key = key
	cipher.update(data) << cipher.final
	end

	############################################################################
	# #
	# ------- Useful Docker Aliases -------- #
	# #
	# # Installation : #
	# copy/paste these lines into your .bashrc or .zshrc file or just #
	# type the following in your current shell to try it out: #
	# wget -O - https://gist.githubusercontent.com/jgrodziski/9ed4a17709baad10dbcd4530b60dfcbb/raw/d84ef1741c59e7ab07fb055a70df1830584c6c18/docker-aliases.sh \| bash
	# #
	# # Usage: #

	require 'json'
	require 'set'

	myself = `go list`.strip

	deps = Set.new
	`go list ./...`.each_line do \|dep\|
	pdeps = JSON.parse(`mgmt go list -json #{dep}`)
	deps += pdeps['Deps']
	deps += pdeps['TestImports'] if pdeps['TestImports']

	# read more at https://terrty.net/2014/ssl-tls-in-nginx/
	# latest version on https://gist.github.com/paskal/628882bee1948ef126dd/126e4d1daeb5244aacbbd847c5247c2e293f6adf
	# security test score: https://www.ssllabs.com/ssltest/analyze.html?d=terrty.net
	# your nginx version might not have all directives included, test this configuration before using in production against your nginx:
	# $ nginx -c /etc/nginx/nginx.conf -t

	server {
	# public key, contains your public key and class 1 certificate, to create:
	# (example for startssl)
	# $ (cat example.com.pem & wget -O - https://www.startssl.com/certs/class1/sha2/pem/sub.class1.server.sha2.ca.pem) \| tee -a /etc/nginx/ssl/domain.pem > /dev/null