Skip to content
This repository
Browse code

started documentation in the README

  • Loading branch information...
commit d851d8839cbd0793250b22fdf53e7e673a423d32 1 parent 2afeda2
Micah Martin authored November 23, 2010
231  .idea/workspace.xml
@@ -2,12 +2,11 @@
2 2
 <project version="4">
3 3
   <component name="ChangeListManager">
4 4
     <list default="true" readonly="true" id="92049f6f-a13c-41db-a1c6-8945dfe47517" name="Default" comment="">
5  
-      <change type="DELETED" beforePath="$PROJECT_DIR$/m2/mmargs/mmargs/1.2.0/mmargs-1.2.0.jar" afterPath="" />
6  
-      <change type="NEW" beforePath="" afterPath="$PROJECT_DIR$/src/mmargs/Arguments.java" />
7  
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/.gitignore" afterPath="$PROJECT_DIR$/.gitignore" />
8  
-      <change type="DELETED" beforePath="$PROJECT_DIR$/src/speclj/SpecFailure.class" afterPath="" />
9 5
       <change type="MODIFICATION" beforePath="$PROJECT_DIR$/project.clj" afterPath="$PROJECT_DIR$/project.clj" />
10  
-      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/src/speclj/version.clj" afterPath="$PROJECT_DIR$/src/speclj/version.clj" />
  6
+      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/src/speclj/core.clj" afterPath="$PROJECT_DIR$/src/speclj/core.clj" />
  7
+      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/spec/speclj/should_spec.clj" afterPath="$PROJECT_DIR$/spec/speclj/should_spec.clj" />
  8
+      <change type="NEW" beforePath="" afterPath="$PROJECT_DIR$/examples/basics/basic_spec.clj" />
  9
+      <change type="MODIFICATION" beforePath="$PROJECT_DIR$/README.md" afterPath="$PROJECT_DIR$/README.md" />
11 10
       <change type="MODIFICATION" beforePath="$PROJECT_DIR$/.idea/workspace.xml" afterPath="$PROJECT_DIR$/.idea/workspace.xml" />
12 11
     </list>
13 12
     <ignored path="$USER_HOME_GRAILS$/" />
@@ -68,28 +67,28 @@
68 67
   <component name="FileColors" enabled="true" enabledForTabs="true" />
69 68
   <component name="FileEditorManager">
70 69
     <leaf>
71  
-      <file leaf-file-name="main.clj" pinned="false" current="false" current-in-tab="false">
72  
-        <entry file="file://$PROJECT_DIR$/src/speclj/main.clj">
  70
+      <file leaf-file-name="README.md" pinned="false" current="false" current-in-tab="false">
  71
+        <entry file="file://$PROJECT_DIR$/README.md">
73 72
           <provider selected="true" editor-type-id="text-editor">
74  
-            <state line="52" column="117" selection-start="1819" selection-end="1819" vertical-scroll-proportion="0.0">
  73
+            <state line="56" column="38" selection-start="1285" selection-end="1285" vertical-scroll-proportion="0.0">
75 74
               <folding />
76 75
             </state>
77 76
           </provider>
78 77
         </entry>
79 78
       </file>
80  
-      <file leaf-file-name="README.md" pinned="false" current="false" current-in-tab="false">
81  
-        <entry file="file://$PROJECT_DIR$/README.md">
  79
+      <file leaf-file-name="project.clj" pinned="false" current="false" current-in-tab="false">
  80
+        <entry file="file://$PROJECT_DIR$/project.clj">
82 81
           <provider selected="true" editor-type-id="text-editor">
83  
-            <state line="0" column="0" selection-start="0" selection-end="0" vertical-scroll-proportion="0.0">
  82
+            <state line="4" column="34" selection-start="205" selection-end="205" vertical-scroll-proportion="0.0">
84 83
               <folding />
85 84
             </state>
86 85
           </provider>
87 86
         </entry>
88 87
       </file>
89  
-      <file leaf-file-name="project.clj" pinned="false" current="false" current-in-tab="false">
90  
-        <entry file="file://$PROJECT_DIR$/project.clj">
  88
+      <file leaf-file-name="LICENSE" pinned="false" current="false" current-in-tab="false">
  89
+        <entry file="file://$PROJECT_DIR$/LICENSE">
91 90
           <provider selected="true" editor-type-id="text-editor">
92  
-            <state line="14" column="0" selection-start="499" selection-end="499" vertical-scroll-proportion="0.0">
  91
+            <state line="0" column="0" selection-start="0" selection-end="0" vertical-scroll-proportion="0.0">
93 92
               <folding />
94 93
             </state>
95 94
           </provider>
@@ -113,46 +112,46 @@
113 112
           </provider>
114 113
         </entry>
115 114
       </file>
116  
-      <file leaf-file-name="Arguments.java" pinned="false" current="false" current-in-tab="false">
117  
-        <entry file="file://$PROJECT_DIR$/src/mmargs/Arguments.java">
  115
+      <file leaf-file-name="core.clj" pinned="false" current="false" current-in-tab="false">
  116
+        <entry file="file://$PROJECT_DIR$/src/speclj/core.clj">
118 117
           <provider selected="true" editor-type-id="text-editor">
119  
-            <state line="11" column="13" selection-start="297" selection-end="297" vertical-scroll-proportion="0.0">
  118
+            <state line="51" column="48" selection-start="1448" selection-end="1448" vertical-scroll-proportion="0.0">
120 119
               <folding />
121 120
             </state>
122 121
           </provider>
123 122
         </entry>
124 123
       </file>
125  
-      <file leaf-file-name="vigilant.clj" pinned="false" current="false" current-in-tab="false">
126  
-        <entry file="file://$PROJECT_DIR$/src/speclj/run/vigilant.clj">
  124
+      <file leaf-file-name="core_spec.clj" pinned="false" current="false" current-in-tab="false">
  125
+        <entry file="file://$PROJECT_DIR$/spec/speclj/core_spec.clj">
127 126
           <provider selected="true" editor-type-id="text-editor">
128  
-            <state line="168" column="184" selection-start="7033" selection-end="7033" vertical-scroll-proportion="0.0">
  127
+            <state line="78" column="26" selection-start="2405" selection-end="2432" vertical-scroll-proportion="0.0">
129 128
               <folding />
130 129
             </state>
131 130
           </provider>
132 131
         </entry>
133 132
       </file>
134  
-      <file leaf-file-name="util.clj" pinned="false" current="false" current-in-tab="false">
135  
-        <entry file="file://$PROJECT_DIR$/src/speclj/util.clj">
  133
+      <file leaf-file-name="should_spec.clj" pinned="false" current="false" current-in-tab="false">
  134
+        <entry file="file://$PROJECT_DIR$/spec/speclj/should_spec.clj">
136 135
           <provider selected="true" editor-type-id="text-editor">
137  
-            <state line="3" column="0" selection-start="67" selection-end="67" vertical-scroll-proportion="0.0">
  136
+            <state line="28" column="19" selection-start="934" selection-end="934" vertical-scroll-proportion="0.0">
138 137
               <folding />
139 138
             </state>
140 139
           </provider>
141 140
         </entry>
142 141
       </file>
143  
-      <file leaf-file-name="core.clj" pinned="false" current="false" current-in-tab="false">
144  
-        <entry file="file://$PROJECT_DIR$/src/speclj/core.clj">
  142
+      <file leaf-file-name="basic_spec.clj" pinned="false" current="true" current-in-tab="true">
  143
+        <entry file="file://$PROJECT_DIR$/examples/basics/basic_spec.clj">
145 144
           <provider selected="true" editor-type-id="text-editor">
146  
-            <state line="93" column="48" selection-start="3293" selection-end="3293" vertical-scroll-proportion="0.0">
  145
+            <state line="0" column="0" selection-start="0" selection-end="169" vertical-scroll-proportion="0.0">
147 146
               <folding />
148 147
             </state>
149 148
           </provider>
150 149
         </entry>
151 150
       </file>
152  
-      <file leaf-file-name=".gitignore" pinned="false" current="true" current-in-tab="true">
  151
+      <file leaf-file-name=".gitignore" pinned="false" current="false" current-in-tab="false">
153 152
         <entry file="file://$PROJECT_DIR$/.gitignore">
154 153
           <provider selected="true" editor-type-id="text-editor">
155  
-            <state line="4" column="5" selection-start="29" selection-end="29" vertical-scroll-proportion="0.10212766">
  154
+            <state line="4" column="5" selection-start="29" selection-end="29" vertical-scroll-proportion="0.0">
156 155
               <folding />
157 156
             </state>
158 157
           </provider>
@@ -168,22 +167,22 @@
168 167
   <component name="IdeDocumentHistory">
169 168
     <option name="changedFiles">
170 169
       <list>
171  
-        <option value="$PROJECT_DIR$/src/speclj/report/verbose.clj" />
172  
-        <option value="$PROJECT_DIR$/spec/speclj/report/specdoc_spec.clj" />
173  
-        <option value="$PROJECT_DIR$/src/leiningen/spec.clj" />
174  
-        <option value="$PROJECT_DIR$/spec/speclj/main_spec.clj" />
175 170
         <option value="$PROJECT_DIR$/src/speclj/reporting.clj" />
176 171
         <option value="$PROJECT_DIR$/src/speclj/report/progress.clj" />
177 172
         <option value="$PROJECT_DIR$/src/speclj/report/silent.clj" />
178 173
         <option value="$PROJECT_DIR$/src/speclj/report/specdoc.clj" />
179 174
         <option value="$PROJECT_DIR$/src/speclj/util.clj" />
180 175
         <option value="$PROJECT_DIR$/src/speclj/run/vigilant.clj" />
181  
-        <option value="$PROJECT_DIR$/src/speclj/core.clj" />
182 176
         <option value="$PROJECT_DIR$/src/speclj/main.clj" />
183 177
         <option value="$PROJECT_DIR$/src/mmargs/Arguments.java" />
184 178
         <option value="$PROJECT_DIR$/src/speclj/version.clj" />
185  
-        <option value="$PROJECT_DIR$/project.clj" />
186 179
         <option value="$PROJECT_DIR$/.gitignore" />
  180
+        <option value="$PROJECT_DIR$/examples/basics/basics.clj" />
  181
+        <option value="$PROJECT_DIR$/spec/speclj/should_spec.clj" />
  182
+        <option value="$PROJECT_DIR$/src/speclj/core.clj" />
  183
+        <option value="$PROJECT_DIR$/project.clj" />
  184
+        <option value="$PROJECT_DIR$/README.md" />
  185
+        <option value="$PROJECT_DIR$/examples/basics/basic_spec.clj" />
187 186
       </list>
188 187
     </option>
189 188
   </component>
@@ -276,6 +275,56 @@
276 275
               <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" />
277 276
             </PATH_ELEMENT>
278 277
           </PATH>
  278
+          <PATH>
  279
+            <PATH_ELEMENT>
  280
+              <option name="myItemId" value="speclj" />
  281
+              <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.ProjectViewProjectNode" />
  282
+            </PATH_ELEMENT>
  283
+            <PATH_ELEMENT>
  284
+              <option name="myItemId" value="speclj" />
  285
+              <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" />
  286
+            </PATH_ELEMENT>
  287
+            <PATH_ELEMENT>
  288
+              <option name="myItemId" value="spec" />
  289
+              <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" />
  290
+            </PATH_ELEMENT>
  291
+            <PATH_ELEMENT>
  292
+              <option name="myItemId" value="speclj" />
  293
+              <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" />
  294
+            </PATH_ELEMENT>
  295
+          </PATH>
  296
+          <PATH>
  297
+            <PATH_ELEMENT>
  298
+              <option name="myItemId" value="speclj" />
  299
+              <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.ProjectViewProjectNode" />
  300
+            </PATH_ELEMENT>
  301
+            <PATH_ELEMENT>
  302
+              <option name="myItemId" value="speclj" />
  303
+              <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" />
  304
+            </PATH_ELEMENT>
  305
+            <PATH_ELEMENT>
  306
+              <option name="myItemId" value="examples" />
  307
+              <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" />
  308
+            </PATH_ELEMENT>
  309
+          </PATH>
  310
+          <PATH>
  311
+            <PATH_ELEMENT>
  312
+              <option name="myItemId" value="speclj" />
  313
+              <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.ProjectViewProjectNode" />
  314
+            </PATH_ELEMENT>
  315
+            <PATH_ELEMENT>
  316
+              <option name="myItemId" value="speclj" />
  317
+              <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" />
  318
+            </PATH_ELEMENT>
  319
+            <PATH_ELEMENT>
  320
+              <option name="myItemId" value="examples" />
  321
+              <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" />
  322
+            </PATH_ELEMENT>
  323
+            <PATH_ELEMENT>
  324
+              <option name="myItemId" value="basics" />
  325
+              <option name="myItemType" value="com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode" />
  326
+            </PATH_ELEMENT>
  327
+          </PATH>
279 328
         </subPane>
280 329
       </pane>
281 330
       <pane id="Favorites" />
@@ -307,57 +356,57 @@
307 356
       <recent name="$PROJECT_DIR$/examples/prime_factors" />
308 357
     </key>
309 358
   </component>
310  
-  <component name="RunManager" selected="Clojure Script.main_spec">
311  
-    <configuration default="false" name="storm" type="ClojureScriptRunConfiguration" factoryName="Clojure Script" temporary="true">
  359
+  <component name="RunManager" selected="Clojure Script.basic_spec">
  360
+    <configuration default="false" name="verbose" type="ClojureScriptRunConfiguration" factoryName="Clojure Script" temporary="true">
312 361
       <module name="speclj" />
313  
-      <setting name="path" value="$PROJECT_DIR$/examples/failures/storm.clj" />
  362
+      <setting name="path" value="$PROJECT_DIR$/src/speclj/report/verbose.clj" />
314 363
       <setting name="vmparams" value="" />
315 364
       <setting name="params" value="" />
316  
-      <setting name="workDir" value="$PROJECT_DIR$/examples/failures" />
  365
+      <setting name="workDir" value="$PROJECT_DIR$/src/speclj/report" />
317 366
       <setting name="repl" value="false" />
318 367
       <RunnerSettings RunnerId="Run" />
319 368
       <ConfigurationWrapper RunnerId="Run" />
320 369
       <method />
321 370
     </configuration>
322  
-    <configuration default="false" name="console_spec" type="ClojureScriptRunConfiguration" factoryName="Clojure Script" temporary="true">
  371
+    <configuration default="false" name="main_spec" type="ClojureScriptRunConfiguration" factoryName="Clojure Script" temporary="true">
323 372
       <module name="speclj" />
324  
-      <setting name="path" value="$PROJECT_DIR$/spec/speclj/report/console_spec.clj" />
  373
+      <setting name="path" value="$PROJECT_DIR$/spec/speclj/main_spec.clj" />
325 374
       <setting name="vmparams" value="" />
326 375
       <setting name="params" value="" />
327  
-      <setting name="workDir" value="$PROJECT_DIR$/spec/speclj/report" />
  376
+      <setting name="workDir" value="$PROJECT_DIR$/spec/speclj" />
328 377
       <setting name="repl" value="false" />
329 378
       <RunnerSettings RunnerId="Run" />
330 379
       <ConfigurationWrapper RunnerId="Run" />
331 380
       <method />
332 381
     </configuration>
333  
-    <configuration default="false" name="verbose_spec" type="ClojureScriptRunConfiguration" factoryName="Clojure Script" temporary="true">
  382
+    <configuration default="false" name="basics" type="ClojureScriptRunConfiguration" factoryName="Clojure Script" temporary="true">
334 383
       <module name="speclj" />
335  
-      <setting name="path" value="$PROJECT_DIR$/spec/speclj/report/verbose_spec.clj" />
  384
+      <setting name="path" value="$PROJECT_DIR$/examples/basics/basics.clj" />
336 385
       <setting name="vmparams" value="" />
337 386
       <setting name="params" value="" />
338  
-      <setting name="workDir" value="$PROJECT_DIR$/spec/speclj/report" />
  387
+      <setting name="workDir" value="$PROJECT_DIR$/examples/basics" />
339 388
       <setting name="repl" value="false" />
340 389
       <RunnerSettings RunnerId="Run" />
341 390
       <ConfigurationWrapper RunnerId="Run" />
342 391
       <method />
343 392
     </configuration>
344  
-    <configuration default="false" name="verbose" type="ClojureScriptRunConfiguration" factoryName="Clojure Script" temporary="true">
  393
+    <configuration default="false" name="should_spec" type="ClojureScriptRunConfiguration" factoryName="Clojure Script" temporary="true">
345 394
       <module name="speclj" />
346  
-      <setting name="path" value="$PROJECT_DIR$/src/speclj/report/verbose.clj" />
  395
+      <setting name="path" value="$PROJECT_DIR$/spec/speclj/should_spec.clj" />
347 396
       <setting name="vmparams" value="" />
348 397
       <setting name="params" value="" />
349  
-      <setting name="workDir" value="$PROJECT_DIR$/src/speclj/report" />
  398
+      <setting name="workDir" value="$PROJECT_DIR$/spec/speclj" />
350 399
       <setting name="repl" value="false" />
351 400
       <RunnerSettings RunnerId="Run" />
352 401
       <ConfigurationWrapper RunnerId="Run" />
353 402
       <method />
354 403
     </configuration>
355  
-    <configuration default="false" name="main_spec" type="ClojureScriptRunConfiguration" factoryName="Clojure Script" temporary="true">
  404
+    <configuration default="false" name="basic_spec" type="ClojureScriptRunConfiguration" factoryName="Clojure Script" temporary="true">
356 405
       <module name="speclj" />
357  
-      <setting name="path" value="$PROJECT_DIR$/spec/speclj/main_spec.clj" />
  406
+      <setting name="path" value="$PROJECT_DIR$/examples/basics/basic_spec.clj" />
358 407
       <setting name="vmparams" value="" />
359 408
       <setting name="params" value="" />
360  
-      <setting name="workDir" value="$PROJECT_DIR$/spec/speclj" />
  409
+      <setting name="workDir" value="$PROJECT_DIR$/examples/basics" />
361 410
       <setting name="repl" value="false" />
362 411
       <RunnerSettings RunnerId="Run" />
363 412
       <ConfigurationWrapper RunnerId="Run" />
@@ -538,11 +587,11 @@
538 587
       </method>
539 588
     </configuration>
540 589
     <list size="5">
541  
-      <item index="0" class="java.lang.String" itemvalue="Clojure Script.storm" />
542  
-      <item index="1" class="java.lang.String" itemvalue="Clojure Script.console_spec" />
543  
-      <item index="2" class="java.lang.String" itemvalue="Clojure Script.verbose_spec" />
544  
-      <item index="3" class="java.lang.String" itemvalue="Clojure Script.verbose" />
545  
-      <item index="4" class="java.lang.String" itemvalue="Clojure Script.main_spec" />
  590
+      <item index="0" class="java.lang.String" itemvalue="Clojure Script.verbose" />
  591
+      <item index="1" class="java.lang.String" itemvalue="Clojure Script.main_spec" />
  592
+      <item index="2" class="java.lang.String" itemvalue="Clojure Script.basics" />
  593
+      <item index="3" class="java.lang.String" itemvalue="Clojure Script.should_spec" />
  594
+      <item index="4" class="java.lang.String" itemvalue="Clojure Script.basic_spec" />
546 595
     </list>
547 596
     <configuration name="&lt;template&gt;" type="WebApp" default="true" selected="false">
548 597
       <Host>localhost</Host>
@@ -575,7 +624,7 @@
575 624
     <servers />
576 625
   </component>
577 626
   <component name="ToolWindowManager">
578  
-    <frame x="0" y="22" width="1440" height="874" extended-state="6" />
  627
+    <frame x="0" y="22" width="1920" height="1174" extended-state="6" />
579 628
     <editor active="true" />
580 629
     <layout>
581 630
       <window_info id="Changes" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="5" side_tool="false" content_ui="tabs" />
@@ -586,14 +635,14 @@
586 635
       <window_info id="IDEtalk Messages" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="1" side_tool="false" content_ui="tabs" />
587 636
       <window_info id="IDEtalk" active="false" anchor="right" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="0" side_tool="false" content_ui="tabs" />
588 637
       <window_info id="Version Control" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="2" side_tool="false" content_ui="tabs" />
589  
-      <window_info id="Messages" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="true" weight="0.32891247" sideWeight="0.5" order="3" side_tool="false" content_ui="tabs" />
  638
+      <window_info id="Messages" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.32891247" sideWeight="0.5" order="3" side_tool="false" content_ui="tabs" />
590 639
       <window_info id="TODO" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="13" side_tool="false" content_ui="tabs" />
591 640
       <window_info id="Structure" active="false" anchor="left" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.25" sideWeight="0.5" order="1" side_tool="true" content_ui="tabs" />
592 641
       <window_info id="Maven Projects" active="false" anchor="right" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="1" side_tool="false" content_ui="tabs" />
593 642
       <window_info id="Commander" active="false" anchor="right" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.4" sideWeight="0.5" order="3" side_tool="false" content_ui="tabs" />
594  
-      <window_info id="Project" active="false" anchor="left" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="true" weight="0.18247126" sideWeight="0.6618037" order="0" side_tool="false" content_ui="tabs" />
  643
+      <window_info id="Project" active="false" anchor="left" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="true" weight="0.13568376" sideWeight="0.7685009" order="0" side_tool="false" content_ui="tabs" />
595 644
       <window_info id="Dependency Viewer" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="4" side_tool="false" content_ui="tabs" />
596  
-      <window_info id="Run" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.3143236" sideWeight="0.5" order="8" side_tool="false" content_ui="tabs" />
  645
+      <window_info id="Run" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="true" weight="0.22485769" sideWeight="0.5" order="8" side_tool="false" content_ui="tabs" />
597 646
       <window_info id="Cvs" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.25" sideWeight="0.5" order="11" side_tool="false" content_ui="tabs" />
598 647
       <window_info id="Message" active="false" anchor="bottom" auto_hide="false" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.33" sideWeight="0.5" order="6" side_tool="false" content_ui="tabs" />
599 648
       <window_info id="IntelliJad Console" active="false" anchor="bottom" auto_hide="true" internal_type="DOCKED" type="DOCKED" visible="false" weight="0.32732448" sideWeight="0.5" order="0" side_tool="false" content_ui="tabs" />
@@ -638,114 +687,114 @@
638 687
     <option name="FILTER_TARGETS" value="false" />
639 688
   </component>
640 689
   <component name="editorHistoryManager">
641  
-    <entry file="file://$PROJECT_DIR$/spec/speclj/report/progress_spec.clj">
  690
+    <entry file="file://$PROJECT_DIR$/src/speclj/report/specdoc.clj">
642 691
       <provider selected="true" editor-type-id="text-editor">
643  
-        <state line="46" column="186" selection-start="1464" selection-end="1464" vertical-scroll-proportion="0.0">
  692
+        <state line="25" column="195" selection-start="799" selection-end="799" vertical-scroll-proportion="0.0">
644 693
           <folding />
645 694
         </state>
646 695
       </provider>
647 696
     </entry>
648  
-    <entry file="file://$PROJECT_DIR$/src/speclj/run/standard.clj">
  697
+    <entry file="file://$PROJECT_DIR$/src/speclj/reporting.clj">
649 698
       <provider selected="true" editor-type-id="text-editor">
650  
-        <state line="0" column="0" selection-start="0" selection-end="0" vertical-scroll-proportion="0.0">
  699
+        <state line="26" column="33" selection-start="805" selection-end="805" vertical-scroll-proportion="0.0">
651 700
           <folding />
652 701
         </state>
653 702
       </provider>
654 703
     </entry>
655  
-    <entry file="file://$PROJECT_DIR$/src/speclj/report/progress.clj">
  704
+    <entry file="file://$PROJECT_DIR$/src/speclj/util.clj">
656 705
       <provider selected="true" editor-type-id="text-editor">
657  
-        <state line="44" column="17" selection-start="1368" selection-end="1368" vertical-scroll-proportion="0.0">
  706
+        <state line="3" column="0" selection-start="67" selection-end="67" vertical-scroll-proportion="0.0">
658 707
           <folding />
659 708
         </state>
660 709
       </provider>
661 710
     </entry>
662  
-    <entry file="file://$PROJECT_DIR$/src/speclj/report/silent.clj">
  711
+    <entry file="file://$PROJECT_DIR$/src/speclj/run/vigilant.clj">
663 712
       <provider selected="true" editor-type-id="text-editor">
664  
-        <state line="8" column="17" selection-start="187" selection-end="187" vertical-scroll-proportion="0.0">
  713
+        <state line="168" column="184" selection-start="7033" selection-end="7033" vertical-scroll-proportion="0.0">
665 714
           <folding />
666 715
         </state>
667 716
       </provider>
668 717
     </entry>
669  
-    <entry file="file://$PROJECT_DIR$/src/speclj/report/specdoc.clj">
  718
+    <entry file="file://$PROJECT_DIR$/src/speclj/main.clj">
670 719
       <provider selected="true" editor-type-id="text-editor">
671  
-        <state line="25" column="195" selection-start="799" selection-end="799" vertical-scroll-proportion="0.0">
  720
+        <state line="52" column="117" selection-start="1819" selection-end="1819" vertical-scroll-proportion="0.0">
672 721
           <folding />
673 722
         </state>
674 723
       </provider>
675 724
     </entry>
676  
-    <entry file="file://$PROJECT_DIR$/src/speclj/reporting.clj">
  725
+    <entry file="file://$PROJECT_DIR$/src/mmargs/Arguments.java">
677 726
       <provider selected="true" editor-type-id="text-editor">
678  
-        <state line="26" column="33" selection-start="805" selection-end="805" vertical-scroll-proportion="0.0">
  727
+        <state line="11" column="13" selection-start="297" selection-end="297" vertical-scroll-proportion="0.0">
679 728
           <folding />
680 729
         </state>
681 730
       </provider>
682 731
     </entry>
683  
-    <entry file="file://$PROJECT_DIR$/src/speclj/util.clj">
  732
+    <entry file="file://$PROJECT_DIR$/src/speclj/version.clj">
684 733
       <provider selected="true" editor-type-id="text-editor">
685  
-        <state line="3" column="0" selection-start="67" selection-end="67" vertical-scroll-proportion="0.0">
  734
+        <state line="9" column="67" selection-start="222" selection-end="222" vertical-scroll-proportion="0.0">
686 735
           <folding />
687 736
         </state>
688 737
       </provider>
689 738
     </entry>
690  
-    <entry file="file://$PROJECT_DIR$/src/speclj/run/vigilant.clj">
  739
+    <entry file="file://$PROJECT_DIR$/src/speclj/running.clj">
691 740
       <provider selected="true" editor-type-id="text-editor">
692  
-        <state line="168" column="184" selection-start="7033" selection-end="7033" vertical-scroll-proportion="0.0">
  741
+        <state line="0" column="0" selection-start="0" selection-end="0" vertical-scroll-proportion="0.0">
693 742
           <folding />
694 743
         </state>
695 744
       </provider>
696 745
     </entry>
697  
-    <entry file="file://$PROJECT_DIR$/src/speclj/core.clj">
  746
+    <entry file="file://$PROJECT_DIR$/.gitignore">
698 747
       <provider selected="true" editor-type-id="text-editor">
699  
-        <state line="93" column="48" selection-start="3293" selection-end="3293" vertical-scroll-proportion="0.0">
  748
+        <state line="4" column="5" selection-start="29" selection-end="29" vertical-scroll-proportion="0.0">
700 749
           <folding />
701 750
         </state>
702 751
       </provider>
703 752
     </entry>
704  
-    <entry file="file://$PROJECT_DIR$/src/speclj/main.clj">
  753
+    <entry file="file://$PROJECT_DIR$/spec/speclj/core_spec.clj">
705 754
       <provider selected="true" editor-type-id="text-editor">
706  
-        <state line="52" column="117" selection-start="1819" selection-end="1819" vertical-scroll-proportion="0.0">
  755
+        <state line="78" column="26" selection-start="2405" selection-end="2432" vertical-scroll-proportion="0.0">
707 756
           <folding />
708 757
         </state>
709 758
       </provider>
710 759
     </entry>
711  
-    <entry file="file://$PROJECT_DIR$/src/mmargs/Arguments.java">
  760
+    <entry file="file://$PROJECT_DIR$/spec/speclj/should_spec.clj">
712 761
       <provider selected="true" editor-type-id="text-editor">
713  
-        <state line="11" column="13" selection-start="297" selection-end="297" vertical-scroll-proportion="0.0">
  762
+        <state line="28" column="19" selection-start="934" selection-end="934" vertical-scroll-proportion="0.0">
714 763
           <folding />
715 764
         </state>
716 765
       </provider>
717 766
     </entry>
718  
-    <entry file="file://$PROJECT_DIR$/README.md">
  767
+    <entry file="file://$PROJECT_DIR$/src/speclj/core.clj">
719 768
       <provider selected="true" editor-type-id="text-editor">
720  
-        <state line="0" column="0" selection-start="0" selection-end="0" vertical-scroll-proportion="0.0">
  769
+        <state line="51" column="48" selection-start="1448" selection-end="1448" vertical-scroll-proportion="0.0">
721 770
           <folding />
722 771
         </state>
723 772
       </provider>
724 773
     </entry>
725  
-    <entry file="file://$PROJECT_DIR$/src/speclj/version.clj">
  774
+    <entry file="file://$PROJECT_DIR$/LICENSE">
726 775
       <provider selected="true" editor-type-id="text-editor">
727  
-        <state line="9" column="67" selection-start="222" selection-end="222" vertical-scroll-proportion="0.0">
  776
+        <state line="0" column="0" selection-start="0" selection-end="0" vertical-scroll-proportion="0.0">
728 777
           <folding />
729 778
         </state>
730 779
       </provider>
731 780
     </entry>
732  
-    <entry file="file://$PROJECT_DIR$/src/speclj/running.clj">
  781
+    <entry file="file://$PROJECT_DIR$/project.clj">
733 782
       <provider selected="true" editor-type-id="text-editor">
734  
-        <state line="0" column="0" selection-start="0" selection-end="0" vertical-scroll-proportion="0.0">
  783
+        <state line="4" column="34" selection-start="205" selection-end="205" vertical-scroll-proportion="0.0">
735 784
           <folding />
736 785
         </state>
737 786
       </provider>
738 787
     </entry>
739  
-    <entry file="file://$PROJECT_DIR$/project.clj">
  788
+    <entry file="file://$PROJECT_DIR$/README.md">
740 789
       <provider selected="true" editor-type-id="text-editor">
741  
-        <state line="14" column="0" selection-start="499" selection-end="499" vertical-scroll-proportion="0.0">
  790
+        <state line="56" column="38" selection-start="1285" selection-end="1285" vertical-scroll-proportion="0.0">
742 791
           <folding />
743 792
         </state>
744 793
       </provider>
745 794
     </entry>
746  
-    <entry file="file://$PROJECT_DIR$/.gitignore">
  795
+    <entry file="file://$PROJECT_DIR$/examples/basics/basic_spec.clj">
747 796
       <provider selected="true" editor-type-id="text-editor">
748  
-        <state line="4" column="5" selection-start="29" selection-end="29" vertical-scroll-proportion="0.10212766">
  797
+        <state line="0" column="0" selection-start="0" selection-end="169" vertical-scroll-proportion="0.0">
749 798
           <folding />
750 799
         </state>
751 800
       </provider>
66  README.md
Source Rendered
... ...
@@ -1,17 +1,65 @@
1  
-# mmspec
  1
+# speclj #
  2
+### (pronounced "speckle" [spek-uhl]) ###
  3
+It's a TDD/BDD framework for [Clojure](http://clojure.org/).  Based quite loyally on [RSpec](http://rspec.info/).
2 4
 
3  
-FIXME: write description
  5
+# Installation
4 6
 
5  
-## Usage
  7
+TODO
6 8
 
7  
-FIXME: write
  9
+# Usage
8 10
 
9  
-## Installation
  11
+## Speclj 101
  12
+Checkout this example.  Below we'll look at it piece by piece.
10 13
 
11  
-FIXME: write
  14
+	(ns basics-spec
  15
+	  (:use [speclj.core]))
12 16
 
13  
-## License
  17
+	(describe "Truth"
14 18
 
15  
-Copyright (C) 2010 FIXME
  19
+	  (it "is true"
  20
+	    (should true))
16 21
 
17  
-Distributed under the Eclipse Public License, the same as Clojure.
  22
+	  (it "is not false"
  23
+	    (should-not false)))
  24
+
  25
+	(conclude-single-file-run)
  26
+
  27
+### `speclj.core` namespace
  28
+Your spec files should `:use` the `speclj.core` in it's entirety.  It's a clean namespace and you're likely going to use all the definitions within it.
  29
+
  30
+	(:use [speclj.core])
  31
+
  32
+### `#describe`
  33
+`describe` is the outer most container for specs.  It takes a `String` name and any number of _spec components_.
  34
+
  35
+	(describe "Truth" ...)
  36
+
  37
+### `it`
  38
+`it` specifies a _characteristic_ of the subject.  This is where assertions go.  Be sure to provide good names as the first parameter of `it` calls.
  39
+
  40
+	(it "is true" ...)
  41
+	
  42
+### `should` and `should-not`
  43
+Assertions.  All assertions begin with `should`.  `should` and `should-not` are just two of the many matchers available.  They both take expressions that they will check for truthy-ness and falsy-ness respectively.
  44
+
  45
+	(should ...)
  46
+	(should-not ...)
  47
+
  48
+# Contributing
  49
+Clone the master branch, build, and run all the tests: 
  50
+
  51
+	git clone https://github.com/slagyr/speclj.git
  52
+	cd speclj
  53
+	lein javac
  54
+	lein spec
  55
+
  56
+Make patches and submit them along with an issue (see below).
  57
+
  58
+## Issues
  59
+Post issues on the speclj github project:
  60
+
  61
+* [https://github.com/slagyr/speclj/issues](https://github.com/slagyr/speclj/issues)
  62
+
  63
+# License 
  64
+Copyright (C) 2010 Micah Martin All Rights Reserved.
  65
+Distributed under the The MIT License.
12  examples/basics/basic_spec.clj
... ...
@@ -0,0 +1,12 @@
  1
+(ns basics-spec
  2
+  (:use [speclj.core]))
  3
+
  4
+(describe "Truth"
  5
+
  6
+  (it "is true"
  7
+    (should true))
  8
+
  9
+  (it "is not false"
  10
+    (should-not false)))
  11
+
  12
+(conclude-single-file-run)
2  project.clj
@@ -2,7 +2,7 @@
2 2
 
3 3
 (defproject speclj speclj.version/string
4 4
   :description "speclj: Pronounced 'speckle', is a Behavior Driven Development framework for Clojure."
5  
-  :license {:name "MIT"
  5
+  :license {:name "The MIT License"
6 6
             :url "file://LICENSE"
7 7
             :distribution :repo
8 8
             :comments "Copyright © 2010 Micah Martin All Rights Reserved."}
8  spec/speclj/should_spec.clj
@@ -9,6 +9,10 @@
9 9
     (should-pass! (should true))
10 10
     (should-fail! (should false)))
11 11
 
  12
+  (it "should-not tests falsy"
  13
+    (should-fail! (should-not true))
  14
+    (should-pass! (should-not false)))
  15
+
12 16
   (it "should= tests equality"
13 17
     (should-pass! (should= 1 1))
14 18
     (should-pass! (should= "hello" "hello"))
@@ -19,6 +23,10 @@
19 23
     (should= "Expected truthy but was: <false>" (failure-message (should false)))
20 24
     (should= "Expected truthy but was: <>" (failure-message (should nil))))
21 25
 
  26
+  (it "should failure message is nice"
  27
+    (should= "Expected falsy but was: <true>" (failure-message (should-not true)))
  28
+    (should= "Expected falsy but was: <1>" (failure-message (should-not 1))))
  29
+
22 30
   (it "should= failure message is nice"
23 31
     (should=
24 32
       (str "Expected: <1>" endl "     got: <2> (using =)")
6  src/speclj/core.clj
@@ -45,6 +45,12 @@
45 45
     (if-not value#
46 46
       (throw (SpecFailure. (str "Expected truthy but was: <" value# ">"))))))
47 47
 
  48
+
  49
+(defmacro should-not [expr]
  50
+  `(let [value# ~expr]
  51
+    (if value#
  52
+      (throw (SpecFailure. (str "Expected falsy but was: <" value# ">"))))))
  53
+
48 54
 (defmacro should= [expr1 expr2]
49 55
   `(let [expected# ~expr1 actual# ~expr2]
50 56
     (if (not (= expected# actual#))

0 notes on commit d851d88

Please sign in to comment.
Something went wrong with that request. Please try again.