germinate 1.2.0

data/features/author-updates-article-source.feature

@@ -0,0 +1,5 @@
+Feature: author updates article source
+
+  As an author
+  I want to push changes to article source code
+  So that other programmers will see the latest version

data/features/author-views-stuff.pending_feature

@@ -0,0 +1,52 @@
+Note: this is a debug feature and its not worth specifying until it gets a bit
+more stable.
+Feature: author views information
+
+  As an author
+  I want to view the components of my article
+  So that I can diagnose errors in output
+
+  Scenario: list stuff
+    Given an article with the contents:
+      """
+      # :TEXT:
+      # Anonymous section 1
+    
+      anonymous code 1
+      # :END:
+
+      anonymous code 2
+
+      # :TEXT: A
+      # Section A
+
+      # :SAMPLE: X
+      code sample X
+
+      # :PROCESS: frob, "aaa"
+      # :PROCESS: munge, "bbb"
+      """
+    When I run the command "germ show --section=SECTION1" on the article
+    Then the output should be as follows:
+      """
+      # Anonymous section 1
+      
+      Insertion[@SECTION1]
+      """
+    When I run the command "germ show --section=A" on the article
+    Then the output should be as follows:
+      """
+      # Section A
+
+      """
+    When I run the command "germ show --sample=X" on the article
+    Then the output should be as follows:
+      """
+      code sample X
+
+      """
+    When I run the command "germ show --process=munge" on the article
+    Then the output should be as follows:
+      """
+      bbb
+      """

data/features/bin/quoter

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+File.open(ARGV[0]) do |file|
+  file.each_line do |line|
+    puts "> #{line.chomp}"
+  end
+end

data/features/bin/sorter

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+$stdin.readlines.sort.each do |line|
+  puts line
+end

data/features/example_articles/bracketing.rb

@@ -0,0 +1,27 @@
+# :BRACKET_CODE: "[", "]"
+
+# :SAMPLE: main
+def main
+  hello
+end
+
+# :SAMPLE: hello, { brackets: [ "{", "}" ] }
+def hello
+  puts "hello"
+end
+
+# :TEXT:
+# Should have square brackets
+# :INSERT: @main
+
+# :TEXT:
+# Should have curly brackets
+# :INSERT: @hello
+
+# :TEXT:
+# Should have curly brackets
+# :INSERT: @hello:2
+
+# :TEXT:
+# Should have angle brackets
+# :INSERT: @hello:2, { brackets: [ "<", ">" ] }

data/features/example_articles/escaping.txt

@@ -0,0 +1,13 @@
+# What if you want to write about Germinate in Germinate?  Escaping is the key.
+
+# :TEXT:
+# Here are some Germinate directives
+# \:TEXT:
+# \:SAMPLE:
+# \:INSERT:
+# You get the idea.
+
+# It works in code too:
+
+# :SAMPLE:
+# \:PROCESS: foo, bar

data/features/example_articles/excerpt_output.rb

@@ -0,0 +1,16 @@
+# We can excerpt the output of a command instead of running the command on an
+# excerpt.
+# :PROCESS: ruby, "ruby %f"
+# :SAMPLE:
+
+puts "-" * 3
+puts "line 1"
+puts "-" * 5
+
+puts "=" * 3
+puts "line 2"
+puts "=" * 5
+
+# :TEXT:
+# :INSERT: $SOURCE|ruby:/===/../=====/
+# :INSERT: $SOURCE|ruby:/---/../-----/

data/features/example_articles/hello.rb

@@ -0,0 +1,9 @@
+# A hello, world demo for Germinate
+# This section should not appear in the output
+
+# :TEXT:
+# Hello, world!
+# :CUT:
+
+def ignore_me
+end

data/features/example_articles/pipelines.txt

@@ -0,0 +1,25 @@
+# A %f will be replaced with a path to a temporary file
+# :PROCESS: quote, "quoter %f"
+#
+# If there is no %f the content will be piped into the command on STDIN
+# :PROCESS: sort,  "sorter"
+
+# :SAMPLE: names
+joe
+sally
+aaron
+george
+zack
+susan
+# :TEXT:
+# Sorting the sample:
+# :INSERT: @names|sort
+#
+# Quoting the sample:
+# :INSERT: @names|quote
+#
+# We can combine pipelines with excerpting:
+# :INSERT: @names:2..4|quote
+#
+# And we can chain processes to form a true pipeline:
+# :INSERT: @names|sort|quote

data/features/example_articles/regexen.rb

@@ -0,0 +1,24 @@
+# :SAMPLE: A
+
+def foo
+  # ...
+end
+
+def bar
+  # ...
+end
+
+class Frob
+  # ...
+end
+
+# :TEXT:
+# We can select code by regexp
+# :INSERT: @A:/foo/../end/
+#
+# Or with a regex and a length
+# :INSERT: @A:/bar/,7
+#
+# Ending offset can be exclusive
+# :INSERT: @A:/foo/.../Frob/
+

data/features/example_articles/sample_offsets.rb

@@ -0,0 +1,18 @@
+# :SAMPLE: A
+a_line_1 = 1
+a_line_2 = 2
+a_line_3 = 3
+a_line_4 = 4
+
+# :TEXT:
+# We can specify a starting offset:
+# :INSERT: @A:2
+# 
+# And an ending offset
+# :INSERT: @A:2..3
+#
+# Ending offset can be exclusive
+# :INSERT: @A:1...3
+#
+# We can specify offset and count instead
+# :INSERT: @A:2,3

data/features/example_articles/specials.rb

@@ -0,0 +1,19 @@
+# :SAMPLE: A
+a_line_1 = 1
+a_line_2 = 2
+a_line_3 = 3
+a_line_4 = 4
+
+# :SAMPLE: B
+b_line_1 = 1
+b_line_2 = 2
+
+# :TEXT:
+# We can paste in all the code:
+# :INSERT: $CODE, { disable_transforms: true }
+# 
+# Or all the text:
+# :INSERT: $TEXT, { disable_transforms: true }
+#
+# Or the entire source file
+# :INSERT: $SOURCE, { disable_transforms: true }

data/features/example_articles/stderr.rb

@@ -0,0 +1,10 @@
+# We can capture both STDOUT and STDERR by using shell modifiers
+# :PROCESS: ruby, "ruby %f 2>&1"
+# :SAMPLE: output
+$stdout.sync = true
+$stdout.puts "Hello, STDOUT"
+$stderr.puts "Hello, STDERR"
+$stdout.puts "Hello again, STDOUT"
+
+# :TEXT:
+# :INSERT: $SOURCE|ruby

data/features/example_articles/wrapping.rb

@@ -0,0 +1,8 @@
+# An example of text-wrappeing
+#
+# :TEXT:
+# 'Twas brillig and the slithy toves
+# Did gyre and gimbal in the wabe
+#
+# All mimsy were the borogroves
+# And the momeraths outgrabe

data/features/example_output/bracketing.out

@@ -0,0 +1,23 @@
+Should have square brackets
+[
+def main
+  hello
+end
+]
+
+Should have curly brackets
+{
+def hello
+  puts "hello"
+end
+}
+
+Should have curly brackets
+{
+  puts "hello"
+}
+
+Should have angle brackets
+<
+  puts "hello"
+>

data/features/example_output/code_samples.txt

@@ -0,0 +1,186 @@
+Hi there!  Here's a Hello, World method:
+
+def hello
+  puts "Hello, World!"
+end
+
+The immediately following code sample can be implicitly referenced:
+
+def nameless
+  puts "I have no name"
+end
+
+Or explicitly referenced
+
+def foo
+  puts "foo"
+end
+
+Samples can be referenced by name
+
+def fred
+  # This comment is part of the sample
+  puts "Hello, my name is Fred"
+  puts "la la la"
+end
+
+Or by index:
+
+def boring
+  1 + 1
+end
+
+SOURCE is a special sample which contains this entire source file.
+
+    # This example demonstrates the use of code samples.
+
+    # :TEXT:
+    # Hi there!  Here's a Hello, World method:
+
+    def hello
+      puts "Hello, World!"
+    end
+
+    # :CUT:
+    # Here's some boring support code we don't want to show the world.
+
+    def boring
+      1 + 1
+    end
+
+    # Here are two a named samples:
+    # :SAMPLE: fred
+
+    def fred
+      # This comment is part of the sample
+      puts "Hello, my name is Fred"
+      puts "la la la"
+    end
+
+    # :SAMPLE: sally
+
+    def sally
+      puts "Hello, my name is Sally"
+    end
+
+    # :END:
+    # Sample "sally" ends above, and does not include the following.
+
+    def wizard
+      puts "Pay no attention to the man behind the curtain!"
+    end
+
+    # Samples can be inside comment blocks
+    # :SAMPLE: george
+    #    (defun george () (format "Hello from George"))
+    # :CUT:
+
+    # Samples can have comment markers stripped
+    # :SAMPLE: mary, { uncomment: true }
+    #    (defun mary () (format "Hello from Mary"))
+    # :CUT:
+
+    # :TEXT:
+    # The immediately following code sample can be implicitly referenced:
+    # :INSERT:
+    # :CUT:
+    def nameless
+      puts "I have no name"
+    end
+
+    # :TEXT:
+    # Or explicitly referenced
+    # :INSERT: FOLLOWING
+    # :CUT:
+    def foo
+      puts "foo"
+    end
+
+    # :TEXT:
+    # Samples can be referenced by name
+    # :INSERT: fred
+    # 
+    # Or by index:
+    # :INSERT: #2
+    #
+    # SOURCE is a special sample which contains this entire source file.
+    # :INSERT: SOURCE, { indent: 4 }
+    #
+    # CODE is a special sample which contains all the non-text portions of this
+    # file.
+    # :INSERT: CODE, { indent: " > " }
+    #
+    # We can select specific lines:
+    # :INSERT: sally:2
+    #
+    # Or ranges of lines:
+    # :INSERT: sally:2..3
+    # 
+    # Or lines matching a regex:
+    # :INSERT: sally:/def/
+    #
+    # Or ranges of regexen:
+    # :INSERT: fred:/puts/.../end/
+
+CODE is a special sample which contains all the non-text portions of this file.
+
+ > # This example demonstrates the use of code samples.
+ >
+ > def hello
+ >   puts "Hello, World!"
+ > end
+ >
+ > # Here's some boring support code we don't want to show the world.
+ >
+ > def boring
+ >   1 + 1
+ > end
+ >
+ > # Here are two a named samples:
+ >
+ > def fred
+ >   # This comment is part of the sample
+ >   puts "Hello, my name is Fred"
+ >   puts "la la la"
+ > end
+ >
+ > def sally
+ >   puts "Hello, my name is Sally"
+ > end
+ > 
+ > # Sample "sally" ends above, and does not include the following.
+ > 
+ > def wizard
+ >   puts "Pay no attention to the man behind the curtain!"
+ > end
+ >
+ > # Samples can be inside comment blocks
+ > 
+ > # Samples can have comment markers stripped
+ > 
+ > def nameless
+ >   puts "I have no name"
+ > end
+ >
+ > def foo
+ >   puts "foo"
+ > end
+
+We can select specific lines:
+
+  puts "Hello, my name is Sally"
+
+Or ranges of lines:
+
+  puts "Hello, my name is Sally"
+end
+
+Or lines matching a regex:
+
+  def sally
+
+# Or ranges of regexen:
+
+  puts "Hello, my name is Fred"
+  puts "la la la"
+