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.
In researching topics for RailsCasts I often read code in Rails and other gems. This is a great exercise to do. Not only will you pick up some coding tips, but it can help you better understand what makes code readable.
A common practice to organize code in gems is to divide it into modules. When this is done extensively I find it becomes very difficult to read. Before I explain further, a quick detour on instance_eval.
You can find instance_eval used in many DSLs: from routes to state machines. Here's an example from Thinking Sphinx.
class Article < ActiveRecord::Base
| [ | |
| { "keys": ["f12"], "command": "htmlprettify"}, | |
| { "keys": ["f1"], "command": "fold" }, | |
| { "keys": ["f2"], "command": "unfold" }, | |
| { "keys": ["ctrl+l"], "command": "show_overlay", "args": {"overlay": "goto", "text": "@"} }, | |
| { "keys": ["ctrl+space"], "command": "auto_complete" }, | |
| { "keys": ["ctrl+space"], "command": "replace_completion_with_auto_complete", "context": | |
| [ | |
| { "key": "last_command", "operator": "equal", "operand": "insert_best_completion" }, |
| # check if job exists | |
| curl -XGET 'http://jenkins/checkJobName?value=yourJobFolderName' --user user.name:YourAPIToken | |
| # with folder plugin | |
| curl -s -XPOST 'http://jenkins/job/FolderName/createItem?name=yourJobName' --data-binary @config.xml -H "Content-Type:text/xml" --user user.name:YourAPIToken | |
| # without folder plugin | |
| curl -s -XPOST 'http://jenkins/createItem?name=yourJobName' --data-binary @config.xml -H "Content-Type:text/xml" --user user.name:YourAPIToken | |
| # create folder |
| import groovy.json.JsonSlurper | |
| import org.springframework.test.web.servlet.MockMvc | |
| import static org.springframework.test.web.servlet.setup.MockMvcBuilders.* | |
| import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*; | |
| import static org.springframework.http.HttpStatus.* | |
| import spock.lang.Specification | |
| /** | |
| * A Spock Spring MVC Rest unit test that doesn't require a full spring context | |
| */ |
This list is based on aliases_spec.rb.
You can see also Module: RSpec::Matchers API.
| matcher | aliased to | description |
|---|---|---|
| a_truthy_value | be_truthy | a truthy value |
| a_falsey_value | be_falsey | a falsey value |
| be_falsy | be_falsey | be falsy |
| a_falsy_value | be_falsey | a falsy value |
| Below are the Big O performance of common functions of different Java Collections. | |
| List | Add | Remove | Get | Contains | Next | Data Structure | |
| ---------------------|------|--------|------|----------|------|--------------- | |
| ArrayList | O(1) | O(n) | O(1) | O(n) | O(1) | Array | |
| LinkedList | O(1) | O(1) | O(n) | O(n) | O(1) | Linked List | |
| CopyOnWriteArrayList | O(n) | O(n) | O(1) | O(n) | O(1) | Array |
| # file: config/initialize/httparty.rb | |
| require 'httparty' | |
| module HTTParty | |
| class Request | |
| alias_method :_original_perform, :perform | |
| def perform(&block) | |
| payload = { | |
| method: http_method.const_get(:METHOD), | |
| url: uri |
Download this gist, and then run:
chmod 755 open_files_limit_mac.sh
./open_files_limit_mac.sh
Restart the system, and then run: