modified .pull command to include entire file if @tag is omitted

Author: gyepisam

Diff for: README.md

@@ -9,25 +9,26 @@ Welcome To Gitdown
 
 Gitdown is a simple tool for writing documentation hosted on a github repository.  It uses [ditaa][] to convert ascii diagrams into images, and produces [markdown][] documents that can be uploaded to your repository along with code.  I made Gitdown so that we could write technical white papers and user guides as plain text (including diagrams) and publish them with a single "git push" command.  Gitdown is a simpler version of the tool we use to maintain the [ØMQ][zeromq] [Guide][zguide].
 
-Gitdown is written and maintained by Pieter Hintjens.  Please use the issue [tracker][] for all comments and errata.  This document was published on Thursday March, 2011 at 22:41:04, and generated by the magic of Gitdown from README.txt.
+Gitdown is written and maintained by Pieter Hintjens.  Please use the issue [tracker][] for all comments and errata.  This document was published on Tuesday February, 2013 at 16:43:34, and generated by the magic of Gitdown from README.txt.
 
 This is version 2011.03.24 of Gitdown. Changelog:
 
+* 2013.02.05: Gyepi Sam changed pull command to make chunk specification optional.
 * 2010.03.24: added .pull command to include chunks from other files.
 * 2010.10.11: don't do symbol substitution in code blocks.
 * 2010.10.09: added .toc token to generate table of contents.
 
-<A name="toc2-31" title="Contents" />
+<A name="toc2-32" title="Contents" />
 Contents
 --------
 
-&emsp;<a href="#toc2-37">License</a>
-&emsp;<a href="#toc2-46">Installation and Use</a>
-&emsp;<a href="#toc2-71">How it Works</a>
-&emsp;<a href="#toc2-126">Gitdown Syntax Summary</a>
-&emsp;<a href="#toc2-186">Markdown Syntax Summary</a>
+&emsp;<a href="#toc2-38">License</a>
+&emsp;<a href="#toc2-47">Installation and Use</a>
+&emsp;<a href="#toc2-72">How it Works</a>
+&emsp;<a href="#toc2-127">Gitdown Syntax Summary</a>
+&emsp;<a href="#toc2-193">Markdown Syntax Summary</a>
 
-<A name="toc2-37" title="License" />
+<A name="toc2-38" title="License" />
 License
 -------
 
@@ -36,7 +37,7 @@ Copyright (c) 1996-2011 iMatix Corporation
 
 This is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
 
-<A name="toc2-46" title="Installation and Use" />
+<A name="toc2-47" title="Installation and Use" />
 Installation and Use
 --------------------
 
@@ -61,7 +62,7 @@ To use Gitdown, edit a text document much like this README.txt.  Then:
 
 The images directory holds images for all documents in the current directory.  You can write documents anywhere on the git tree but if they are not at the root you must tell Gitdown how to create a full image path by setting the SUBDIR symbol (see below).
 
-<A name="toc2-71" title="How it Works" />
+<A name="toc2-72" title="How it Works" />
 How it Works
 ------------
 
@@ -80,7 +81,7 @@ The Gitdown workflow is:
 
 This README acts as an example.
 
-<A name="toc2-126" title="Gitdown Syntax Summary" />
+<A name="toc2-127" title="Gitdown Syntax Summary" />
 Gitdown Syntax Summary
 ---------------------
 
@@ -93,7 +94,7 @@ Gitdown is a pre-processor that adds these syntax elements on top of Markdown:
     .set name=value             Sets Gitdown symbol
     .sub oldval=newval          Replaces oldval by newval in every line
     .toc [top]                  Insert table of contents
-    .pull srcfile@tag[,opts]    Pull a chunk of text from sourcefile
+    .pull srcfile[@tag][,opts]  Pull a chunk of text, or the whole file, from srcfile
     .end                        Everything past this is ignored
 
     $\(xxx)                     Value of variable, anywhere in text
@@ -126,7 +127,13 @@ Gitdown is a pre-processor that adds these syntax elements on top of Markdown:
 
 The top argument for .toc tells it the top header level in the text. Lower levels are shown horizontally.  E.g. this file has level 2 headers in the text and uses `.toc 1` to get these laid-out on a single row.
 
-The opts argument for .pull can be: 'code' to indicate the results should be indented 4 spaces. An opts of 'left' removes any left margin. A chunk of text is identified by '@tag' anywhere in the line before the chunk, and any other tag signalling the end. '@end' can be used to close any chunk. Tag names must be alphanumeric.
+If the .pull command includes an optional @tag, the named chunk of text is pulled from the source file.
+A chunk of text is identified by '@tag' anywhere in the line before the chunk, and any other tag signalling the end. '@end' can be used to close any chunk. Tag names must be alphanumeric.
+If @tag is omitted, the entire file is included.
+
+The opts argument for .pull can be: 'code' to indicate the results should be indented 4 spaces.
+An opts of 'left' removes any left margin.
+
 
 These symbols have special meaning:
 
@@ -140,7 +147,7 @@ These symbols are predefined by gitdown for you:
 * SELF specifies the input file name without extension.
 * OUTPUT specifies the current output file name,
 
-<A name="toc2-186" title="Markdown Syntax Summary" />
+<A name="toc2-193" title="Markdown Syntax Summary" />
 Markdown Syntax Summary
 -----------------------
 

Diff for: README.txt

@@ -23,6 +23,7 @@ Gitdown is written and maintained by Pieter Hintjens.  Please use the issue [tra
 
 This is version 2011.03.24 of Gitdown. Changelog:
 
+* 2013.02.05: Gyepi Sam changed pull command to make chunk specification optional.
 * 2010.03.24: added .pull command to include chunks from other files.
 * 2010.10.11: don't do symbol substitution in code blocks.
 * 2010.10.09: added .toc token to generate table of contents.
@@ -130,7 +131,7 @@ Gitdown is a pre-processor that adds these syntax elements on top of Markdown:
     .set name=value             Sets Gitdown symbol
     .sub oldval=newval          Replaces oldval by newval in every line
     .toc [top]                  Insert table of contents
-    .pull srcfile@tag[,opts]    Pull a chunk of text from sourcefile
+    .pull srcfile[@tag][,opts]  Pull a chunk of text, or the whole file, from srcfile
     .end                        Everything past this is ignored
 
     $\(xxx)                     Value of variable, anywhere in text
@@ -163,7 +164,13 @@ Gitdown is a pre-processor that adds these syntax elements on top of Markdown:
 
 The top argument for .toc tells it the top header level in the text. Lower levels are shown horizontally.  E.g. this file has level 2 headers in the text and uses `.toc 1` to get these laid-out on a single row.
 
-The opts argument for .pull can be: 'code' to indicate the results should be indented 4 spaces. An opts of 'left' removes any left margin. A chunk of text is identified by '@tag' anywhere in the line before the chunk, and any other tag signalling the end. '@end' can be used to close any chunk. Tag names must be alphanumeric.
+If the .pull command includes an optional @tag, the named chunk of text is pulled from the source file.
+A chunk of text is identified by '@tag' anywhere in the line before the chunk, and any other tag signalling the end. '@end' can be used to close any chunk. Tag names must be alphanumeric.
+If @tag is omitted, the entire file is included.
+
+The opts argument for .pull can be: 'code' to indicate the results should be indented 4 spaces.
+An opts of 'left' removes any left margin.
+
 
 These symbols have special meaning:
 

Diff for: bin/gitdown

@@ -121,22 +121,42 @@ while ($line < @input) {
         elsif (/^\.\-/) {
             #   Comment, ignore
         }
-        elsif (/^\.pull (.*)(@[a-zA-Z0-9]+)(,(.*)\s*)?/) {
-            $source = $1;
-            $tag = $2;
-            $opts = $4;
+        elsif (/^\.pull\s+(.*?)([@,].+)?\s*$/) {
+            my ($source, $rest) = ($1, $2);
+            my ($tag, $opts); #tags and opts are both optional
+
+            if ($rest =~ /^(@[a-zA-Z0-9]+)(,.+)?/) {
+                $tag = $1;
+                $rest = $2;
+            }
+
+            if ($rest =~ /,(.*)/) {
+                $opts = $1;
+            }
+
             die "Can't read $source: $!"
-                unless open (SOURCE, $source);
+            unless open (SOURCE, $source);
+
+            my $apply_opts = sub {
+                chomp;
+                $_ = "    $_" if ($opts eq "code");
+                s/^ {4}// if ($opts eq "left");
+
+            };
             while (<SOURCE>) {
-                if (/$tag/) {
-                    while (<SOURCE>) {
-                        last if /@[a-zA-Z0-9]+/;
-                        chop;
-                        $_ = "    $_" if ($opts eq "code");
-                        s/^    // if ($opts eq "left");
-                        writeln ($_);
+                if ($tag) {
+                    if (/$tag/) {
+                        while (<SOURCE>) {
+                            last if /@[a-zA-Z0-9]+/;
+                            $apply_opts->();
+                            writeln ($_);
+                        }
                     }
                 }
+                else {
+                    $apply_opts->();
+                    writeln ($_);
+                }
             }
             close (SOURCE);
         }

Diff for: images/README_1.png

@@ -0,0 +1,22 @@
+@ch1
+
+The reward for work well done is the opportunity to do more.
+
+@end
+
+@ch2
+
+for(int i = 0; i < argc ; i++) {
+    printf("%s\n", argv[i]);
+}
+
+@end
+
+@ch3
+
+    <files>
+     <name="/etc/passwd" perm="0600" />
+     <name="/etc/quotd" />
+    </files>
+
+@end

Diff for: images/README_2.png

@@ -0,0 +1,3 @@
+There is wisdom in turning as often as possible from the familiar to the
+unfamiliar: it keeps the mind nimble, it kills prejudice, and it fosters
+humor.

Diff for: test/chunks

@@ -0,0 +1,29 @@
+This file should pull three chunks from a file named chunks
+
+This is chunk 1, which is plain text 
+
+The reward for work well done is the opportunity to do more.
+
+
+This is chunk 2, which is code
+
+    
+    for(int i = 0; i < argc ; i++) {
+        printf("%s\n", argv[i]);
+    }
+    
+
+This is chunk 3, which is left aligned
+
+
+<files>
+ <name="/etc/passwd" perm="0600" />
+ <name="/etc/quotd" />
+</files>
+
+
+This is file2, no chunk, plain text
+
+There is wisdom in turning as often as possible from the familiar to the
+unfamiliar: it keeps the mind nimble, it kills prejudice, and it fosters
+humor.

Diff for: test/file2

@@ -0,0 +1,16 @@
+This file should pull three chunks from a file named chunks
+
+This is chunk 1, which is plain text 
+.pull chunks@ch1
+
+This is chunk 2, which is code
+
+.pull chunks@ch2,code
+
+This is chunk 3, which is left aligned
+
+.pull chunks@ch3,left
+
+This is file2, no chunk, plain text
+
+.pull file2