Fred Heath RedFred7

YARD CHEATSHEET http://yardoc.org

May 2020 - updated fork: https://gist.github.com/phansch/db18a595d2f5f1ef16646af72fe1fb0e

cribbed from http://pastebin.com/xgzeAmBn

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

Modules

Lambda: standard

# Creating a lambda
l = lambda { |name| "Hi #{name}!" }

# Executing the lambda
l.call("foo") # => Hi foo!

Dynamic Dispatch
Dynamic Method
Ghost Methods
Dynamic Proxies
Blank Slate
Kernel Method
Flattening the Scope (aka Nested Lexical Scopes)
Context Probe
Class Eval (not really a 'spell' more just a demonstration of its usage)
Class Macros

A Primer on Ruby Method Lookup

Method lookup is a simple affair in most languages without multiple inheritance. You start from the receiver and move up the ancestors chain until you locate the method. Because Ruby allows you to mix in modules and extend singleton classes at runtime, this is an entirely different affair.

I will not build contrived code to exemplify the more complicated aspects of Ruby method lookup, as this will only serve to confuse the matter.

When you pass a message to an object, here is how Ruby finds what method to call:

1. Look within singleton class

It's not immediately obvious how to pull down the code for a PR and test it locally. But it's pretty easy. (This assumes you have a remote for the main repo named upstream.)

Getting the PR code

Make note of the PR number. For example, Rod's latest is PR #37: Psiphon-Labs/psiphon-tunnel-core#37
Fetch the PR's pseudo-branch (or bookmark or rev pointer whatever the word is), and give it a local branch name. Here we'll name it pr37:

$ git fetch upstream pull/37/head:pr37

	Warden::Manager.serialize_into_session{\|user\| user.id }
	Warden::Manager.serialize_from_session{\|id\| User.get(id) }

	Warden::Manager.before_failure do \|env,opts\|
	# Sinatra is very sensitive to the request method
	# since authentication could fail on any type of method, we need
	# to set it for the failure app so it is routed to the correct block
	env['REQUEST_METHOD'] = "POST"
	end

	namespace :db do
	require 'sequel'
	namespace :migrate do
	Sequel.extension :migration

	task :connect do
	if ENV['DATABASE_URL']
	DB = Sequel.connect(ENV['DATABASE_URL'])
	else
	puts 'ABORTING: You must set the DATABASE_URL environment variable!'

	class Foo
	attr_reader :bar
	def initialize
	@bar = 123
	ObjectSpace.define_finalizer( self, self.class.finalize(bar) )
	end

	def self.finalize(bar)
	proc { puts "DESTROY OBJECT #{bar}" }
	end

	require 'sinatra'

	get '/long_process' do

	child_pid = Process.fork do
	# hard work is done here...
	sleep 10
	Process.exit
	end

	git branch -m old_branch new_branch # Rename branch locally
	git push origin :old_branch # Delete the old branch
	git push --set-upstream origin new_branch # Push the new branch, set local branch to track the new remote