specky/doc/specky.txt
author Mahlon E. Smith <mahlon@martini.nu>
Wed, 07 Jul 2010 16:47:28 -0700
branchvim-stuff
changeset 15 285603587539
parent 10 a8f9271a7cab
child 19 763cef799c74
permissions -rw-r--r--
Initial commit of the HGRev Vim plugin.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
     1
*specky.txt* Last change: $Id$
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
     2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
     3
                VIM REFERENCE MANUAL    by Mahlon E. Smith
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
     4
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
     5
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
     6
                                  specky!
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
     7
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
     8
A Plugin for testing Ruby code with RSpec -- and more                 *specky*
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
     9
==============================================================================
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    10
CONTENTS                                                      *SpeckyContents*
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    11
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    12
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    13
    1) Intro........................................|SpeckyIntro|
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    14
    2) Functionality................................|SpeckyFunctionality|
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    15
    3) Enabling Specky..............................|SpeckyVimrcExample|
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    16
    4) Configuration................................|SpeckyOptions|
3
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
    17
        4.1) Create text banners....................|g:speckyBannerKey|
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
    18
        4.2) Cycling quote styles...................|g:speckyQuoteSwitcherKey|
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
    19
        4.3) Display ruby documentation.............|g:speckyRunRdocKey|
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
    20
        4.4) Toggle editing between spec and code...|g:speckySpecSwitcherKey|
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
    21
        4.5) Run specs for the current buffer.......|g:speckyRunSpecKey|
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
    22
        4.6) Modify the default spec command........|g:speckyRunSpecCmd|
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
    23
        4.7) Modify the default rdoc command........|g:speckyRunRdocCmd|
6
31d00503e038 * Small documentation updates
mahlon
parents: 5
diff changeset
    24
        4.8) Alter new window behavior..............|g:speckyWindowType|
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    25
    5) Author.......................................|SpeckyAuthor|
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    26
    6) License......................................|SpeckyLicense|
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    27
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    28
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    29
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    30
==============================================================================
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    31
1. INTRO                                                         *SpeckyIntro*
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    32
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    33
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    34
Specky is primarily a small collection of functions to help make behavioral
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    35
testing streamlined and easy when working with ruby and rspec.
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    36
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    37
Specky secondarily includes a couple of conveniences to make your everyday
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    38
programming tasks smooooth and pleasurable.
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    39
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    40
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    41
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    42
==============================================================================
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    43
2. FUNCTIONALITY                                         *SpeckyFunctionality*
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    44
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    45
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    46
Okay then, what does it do?
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    47
5
3346aa8d5364 Add snippets and rspec syntax highlights.
mahlon
parents: 3
diff changeset
    48
By default?  Nothing but syntax highlighting unless you are comfortable using
3346aa8d5364 Add snippets and rspec syntax highlights.
mahlon
parents: 3
diff changeset
    49
the menus.  I decided the easiest way to cherry pick the functionality that
3346aa8d5364 Add snippets and rspec syntax highlights.
mahlon
parents: 3
diff changeset
    50
you'd like was to enable them via key bindings.  By doing this, Specky won't
3346aa8d5364 Add snippets and rspec syntax highlights.
mahlon
parents: 3
diff changeset
    51
make assumptions about your current environment, and won't stomp on anything
3346aa8d5364 Add snippets and rspec syntax highlights.
mahlon
parents: 3
diff changeset
    52
you don't want it to.
3
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
    53
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
    54
    Specky won't do -anything- with your environment until you enable ~
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
    55
    the key bindings!! ~
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    56
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    57
After you've configured your bindings, here are some of the things you can
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    58
now do with a single key stroke:
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    59
>
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    60
    - Switch back and forth from code to testing spec 
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    61
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    62
    - Run the spec, with results going to a new, syntax highlighted buffer 
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    63
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    64
    - Jump quickly to spec failures and failure detail 
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    65
        - 'e' and 'r' to move back and forth on each failed assertion, 
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    66
        - 'E' to jump details for it. 
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    67
        - '<C-e>' to "forget" the currently selected failed assertion
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    68
        - 'q' to close the spec output buffer. 
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    69
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    70
    - View rdoc of the word under the cursor
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    71
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    72
    - Dynamically switch string types for the word under the cursor
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    73
      (double quoted, quoted, symbol)
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    74
3
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
    75
    - Make lovely and quick comment banners for ruby code.
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    76
5
3346aa8d5364 Add snippets and rspec syntax highlights.
mahlon
parents: 3
diff changeset
    77
Specky also includes a "snippets" file that can be used with the Snipmate
3346aa8d5364 Add snippets and rspec syntax highlights.
mahlon
parents: 3
diff changeset
    78
plugin by Michael Sanders <msanders42+vim@gmail.com>. (Minimum version 0.74.)
3346aa8d5364 Add snippets and rspec syntax highlights.
mahlon
parents: 3
diff changeset
    79
3346aa8d5364 Add snippets and rspec syntax highlights.
mahlon
parents: 3
diff changeset
    80
	http://www.vim.org/scripts/script.php?script_id=2540
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    81
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    82
==============================================================================
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    83
3. ENABLING-SPECKY                                        *SpeckyVimrcExample*
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    84
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    85
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    86
Here's what my config looks like. >
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    87
3
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
    88
    let g:speckyBannerKey = "<C-S>b"
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    89
    let g:speckyQuoteSwitcherKey = "<C-S>'"
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    90
    let g:speckyRunRdocKey = "<C-S>r"
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    91
    let g:speckySpecSwitcherKey = "<C-S>x"
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    92
    let g:speckyRunSpecKey = "<C-S>s"
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    93
    let g:speckyRunSpecCmd = "spec -fs -r loadpath.rb"
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    94
    let g:speckyRunRdocCmd = "fri -L -f plain"
6
31d00503e038 * Small documentation updates
mahlon
parents: 5
diff changeset
    95
    let g:speckyWindowType = 2
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    96
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    97
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    98
With these bindings, all specky commands start with <ctrl-s> ("s" for
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
    99
specky!), followed by a mnemonic function to run:
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   100
3
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   101
    b ----> Banner creation ~
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   102
    ' ----> Quote cycling ~
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   103
    r ----> run Rdoc ~
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   104
    x ----> code and spec eXchange ~
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   105
    s ----> run Spec ~
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   106
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   107
Of course, <ctrl-s> is a "suspend" signal for most terminals, so these
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   108
bindings are meant for a |gui| environment, such as gvim.  Your mileage (and
3
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   109
tastes) will doubtlessly vary.  Do what you will.  I won't judge you.
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   110
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   111
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   112
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   113
==============================================================================
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   114
4. CONFIGURATION-OPTIONS                                       *SpeckyOptions*
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   115
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   116
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   117
Here are all of the available configuration options.
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   118
3
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   119
Please note that you must set binding variables:
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   120
3
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   121
    |g:speckyBannerKey|
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   122
    |g:speckyQuoteSwitcherKey|
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   123
    |g:speckyRunRdocKey|
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   124
    |g:speckySpecSwitcherKey|
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   125
    |g:speckyRunSpecKey|
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   126
3
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   127
...in order to enable the respective specky functionality.  See
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   128
|SpeckyVimrcExample| for details. Any other options are entirely optional.
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   129
Put these into your |vimrc|, or wherever else you enjoy storing this kind of
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   130
stuff.
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   131
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   132
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   133
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   134
------------------------------------------------------------------------------
3
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   135
4.1                                                        *g:speckyBannerKey*
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   136
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   137
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   138
Setting this binding enables comment banner creation.
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   139
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   140
This is purely a convenience routine, and a stylistic one at that.  I prefer
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   141
large advertising of what "area" of code you are in, along with other
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   142
miscellaneous labels for humans to read.  If this isn't how you roll, then by
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   143
all means, don't enable this binding!  :)
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   144
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   145
As an example -- you can just type:
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   146
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   147
	instance methods ~
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   148
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   149
Then hit the keystroke.  It will magically turn into: >
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   150
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   151
  ########################################################################
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   152
  ### I N S T A N C E   M E T H O D S
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   153
  ########################################################################
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   154
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   155
With all those saved extra keystrokes this might provide you per banner over
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   156
the years, your RSI-free hands will thank you.  And the total time savings!!
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   157
Oh man, what are you going to DO with all of that extra free time?
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   158
The possibilities are staggering.
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   159
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   160
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   161
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   162
------------------------------------------------------------------------------
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   163
4.2                                                 *g:speckyQuoteSwitcherKey*
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   164
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   165
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   166
Setting this binding enables quote "style switching".
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   167
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   168
If you aren't in ruby mode, this just changes the word under the cursor
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   169
back and forth from double quoting to single quoting.
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   170
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   171
    string -> "string" -> 'string' -> "string" ... ~
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   172
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   173
In ruby mode, symbols are also put into the rotation.
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   174
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   175
    "string" -> 'string' -> :string -> "string" ... ~
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   176
3
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   177
Note that quote cycling only works with a |word|.
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   178
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   179
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   180
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   181
------------------------------------------------------------------------------
3
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   182
4.3                                                       *g:speckyRunRdocKey*
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   183
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   184
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   185
Setting this enables the display of rdoc documentation for the current
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   186
word under the cursor.  For lookups with multiple matches, you can continue
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   187
using this binding to "drill down" to the desired documentation.
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   188
         
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   189
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   190
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   191
------------------------------------------------------------------------------
3
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   192
4.4                                                  *g:speckySpecSwitcherKey*
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   193
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   194
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   195
Setting this enables spec to code switching, and visa versa.
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   196
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   197
Switching uses path searching instead of reliance on directory structure in
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   198
your project.  The idea here is that you'd |:chdir| into your project
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   199
directory.  Spec files just need to end in '_spec.rb', which is a common
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   200
convention.
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   201
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   202
    aRubyClass.rb ---> aRubyClass_spec.rb~
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   203
 
6
31d00503e038 * Small documentation updates
mahlon
parents: 5
diff changeset
   204
Because it leaves respective buffers open, you can essentially think of this
31d00503e038 * Small documentation updates
mahlon
parents: 5
diff changeset
   205
as a quick toggle between code and tests.
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   206
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   207
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   208
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   209
------------------------------------------------------------------------------
3
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   210
4.5                                                       *g:speckyRunSpecKey*
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   211
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   212
6
31d00503e038 * Small documentation updates
mahlon
parents: 5
diff changeset
   213
Setting this variable runs "spec" on the current buffer.
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   214
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   215
All output is sent to a syntax highlighted scratch buffer. This new window is
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   216
re-used for each spec run.  You can quickly "jump" to assertion failures and
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   217
their associated details with the following keys:
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   218
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   219
        e and r ~
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   220
            Move forward and backward through the failed assertions.
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   221
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   222
        E~
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   223
            While on a failure line, jump to the details of the failure.
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   224
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   225
        <C-e> ~
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   226
            "Forget" the last found failed assertion, and start over at the
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   227
            beginning of the list. (ie, the next 'e' keystroke will select
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   228
            error #1.)
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   229
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   230
        q ~
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   231
            Closes the spec output buffer. 
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   232
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   233
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   234
Normally, you'd only want to perform this keystroke while in a spec file
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   235
buffer.  If specky thinks you are in code, rather than a buffer (as indicated
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   236
by the lack of a "_spec.rb" file naming convention) then it will attempt to
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   237
switch to the spec before running the command.
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   238
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   239
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   240
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   241
------------------------------------------------------------------------------
3
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   242
4.6                                                       *g:speckyRunSpecCmd*
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   243
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   244
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   245
This is the program, with flags, that the current file is sent to when
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   246
executing the |g:speckyRunSpecKey| keybinding.
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   247
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   248
A common addition is to include an "-r" flag for sucking in local libraries
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   249
necessary for testing your project.  The spec "plain" output format is
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   250
supported too, though less useful.
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   251
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   252
    Default: ~
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   253
        spec -fs
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   254
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   255
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   256
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   257
------------------------------------------------------------------------------
3
db3e3abfc647 * Add colorschemes directory.
mahlon
parents: 2
diff changeset
   258
4.7                                                       *g:speckyRunRdocCmd*
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   259
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   260
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   261
If you prefer an rdoc display program other than "ri", you can set it
6
31d00503e038 * Small documentation updates
mahlon
parents: 5
diff changeset
   262
with this variable.  "fri -L -f plain" is always a nice choice, for example.
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   263
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   264
    Default: ~
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   265
        ri
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   266
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   267
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   268
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   269
------------------------------------------------------------------------------
6
31d00503e038 * Small documentation updates
mahlon
parents: 5
diff changeset
   270
4.8                                                       *g:speckyWindowType*
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   271
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   272
6
31d00503e038 * Small documentation updates
mahlon
parents: 5
diff changeset
   273
For both spec and rdoc commands, this variable controls the behavior of the
31d00503e038 * Small documentation updates
mahlon
parents: 5
diff changeset
   274
newly generated window.
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   275
6
31d00503e038 * Small documentation updates
mahlon
parents: 5
diff changeset
   276
	Default: ~
31d00503e038 * Small documentation updates
mahlon
parents: 5
diff changeset
   277
		0
31d00503e038 * Small documentation updates
mahlon
parents: 5
diff changeset
   278
		
31d00503e038 * Small documentation updates
mahlon
parents: 5
diff changeset
   279
	0 ~
31d00503e038 * Small documentation updates
mahlon
parents: 5
diff changeset
   280
		Create a new tabbed window
31d00503e038 * Small documentation updates
mahlon
parents: 5
diff changeset
   281
	1 ~
31d00503e038 * Small documentation updates
mahlon
parents: 5
diff changeset
   282
		Split the current window horizontally
31d00503e038 * Small documentation updates
mahlon
parents: 5
diff changeset
   283
	2 ~
31d00503e038 * Small documentation updates
mahlon
parents: 5
diff changeset
   284
		Split the current window vertically
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   285
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   286
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   287
==============================================================================
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   288
5. AUTHOR                                                       *SpeckyAuthor*
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   289
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   290
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   291
Specky was written by Mahlon E. Smith.
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   292
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   293
    mahlon@martini.nu ~
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   294
    http://www.martini.nu/ 
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   295
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   296
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   297
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   298
==============================================================================
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   299
6. LICENSE                                                     *SpeckyLicense*
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   300
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   301
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   302
Specky is distributed under the BSD license.
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   303
    http://www.opensource.org/licenses/bsd-license.php
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   304
>
10
a8f9271a7cab * Remove committed keyword expansions.
Mahlon E. Smith <mahlon@martini.nu>
parents: 6
diff changeset
   305
    Copyright (c) 2008-2009, Mahlon E. Smith <mahlon@martini.nu>
2
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   306
    All rights reserved.
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   307
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   308
    Redistribution and use in source and binary forms, with or without
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   309
    modification, are permitted provided that the following conditions are
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   310
    met:
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   311
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   312
        * Redistributions of source code must retain the above copyright
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   313
          notice, this list of conditions and the following disclaimer.
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   314
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   315
        * Redistributions in binary form must reproduce the above copyright
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   316
          notice, this list of conditions and the following disclaimer in the
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   317
          documentation and/or other materials provided with the distribution.
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   318
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   319
    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   320
    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   321
    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   322
    A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   323
    OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   324
    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   325
    TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   326
    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   327
    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   328
    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   329
    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   330
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   331
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   332
6b33188f1694 Moving Specky into a Vim subfolder.
mahlon
parents:
diff changeset
   333
vim: set noet nosta sw=4 ts=4 ft=help :