germinate 1.2.0

data/cucumber.yml

@@ -0,0 +1,2 @@
+autotest: --no-color --format pretty
+autotest-all: --no-color --format pretty

data/examples/basic.rb

@@ -0,0 +1,123 @@
+# :PUBLISHER: source, gist
+# A basic example of a Germinate article.
+#
+# This text is "front matter" and will not be included in the final article.
+# The article doesn't begin until the first text directive.
+#
+# Let's set up code bracketing so that code excerpts will be surrounded by HTML
+# <pre>...</pre> tags.
+#
+# :BRACKET_CODE: <pre>, </pre>
+#
+# :TEXT:
+# This is the first line of the article text.  For the formatted article,
+# Germinate will remove the comment prefixes ("# ") and join paragraphs into
+# single lines.
+#
+# We're coming up on our first code section.  If some code immediately follows a
+# text section it will automatically be inserted into the formatted article
+# text.
+def my_func
+  # ...
+end
+# :END:
+# 
+# The END directive above ends that particular code sample.  This text will not
+# be included in the final article.
+#
+# We don't want to have to write our source code in the order it appears in
+# the article.  Let's define a named code sample.
+#
+# :SAMPLE: hello
+def hello
+  puts "Hello, #{ARGV[0]}"
+end
+hello
+
+# :TEXT:
+# We're back in the article text now.  Let's insert our named sample now.
+# :INSERT: @hello
+#
+# Now lets define some processes and experiment with running the sample through
+# them.
+#
+# :PROCESS: fred, "ruby %f Fred"
+# :PROCESS: jane, "ruby %f Jane"
+# :PROCESS: quote, "ruby -n -e 'puts \"> #{$_}\"'"
+#
+# Note that the "quote" process has no %f placeholder for the filename.
+# If it doesn't find a %f, Germinate will pipe the source sample into the
+# command on its STDIN.
+#
+# Here's the result of :INSERT: @hello|fred
+# :INSERT: @hello|fred
+#
+# Here's the result of :INSERT: @hello|jane
+# :INSERT: @hello|jane
+#
+# We can even chain processes together. Here's the result of 
+# :INSERT: @hello|jane|quote
+# :INSERT: @hello|jane|quote
+#
+# It's not necessary to quote whole code samples.  We can select specific lines
+# to excerpt using more advanced selectors.
+#
+# Select a single line
+# :INSERT: @foo:2
+# :INSERT: @foo:2
+#
+# Select an inclusive range
+# :INSERT: @foo:2..4
+# :INSERT: @foo:2..4
+#
+# Select an exclusive range
+# :INSERT: @foo:1...3
+# :INSERT: @foo:1...3
+#
+# Select by starting line and length
+# :INSERT: @foo:4,4
+# :INSERT: @foo:4,4
+#
+# Select by starting and ending regular expressions
+# :INSERT: @foo:/do_stuff/../end/
+# :INSERT: @foo:/do_stuff/../end/
+#
+# Select by regex and length
+# :INSERT: @foo:/attr_reader/,3
+# :INSERT: @foo:/attr_reader/,3
+#
+# :SAMPLE: foo
+class Foo
+  attr_reader :bar
+  attr_reader :baz
+  attr_reader :buz
+
+  def do_stuff
+    # ...
+  end
+end
+# :END:
+
+# :TEXT:
+# Finally, we can include all of the code samples in a single chunk with
+# :INSERT: $CODE
+# :INSERT: $CODE
+#
+# There are some other special section names, such as $SOURCE and $TEXT.  See
+# the Germinate documentation for more.
+#
+# :CUT:
+#
+# You can format this article for publishing by running:
+#
+#   germ format <filename>
+#
+# If you want to experiment with the selector syntax, try:
+#
+#   germ select -s <selector>
+#
+# Enjoy!
+#
+# 1 2 3 5 6 7 8
+
+# :SET: 'GIST_ID', '150391'

data/examples/short.rb

@@ -0,0 +1,19 @@
+# #!/usr/bin/env ruby
+# :PUBLISHER: source, gist
+# :BRACKET_CODE: <pre>, </pre>
+# :PROCESS: ruby, "ruby %f"
+
+# :SAMPLE: hello
+def hello(who)
+  puts "Hello, #{who}"
+end
+
+hello("World")
+
+# :TEXT:
+# Check out my amazing program!  Here's the hello method:
+# :INSERT: @hello:/def/../end/
+
+# And here's the output:
+# :INSERT: @hello|ruby
+# :SET: 'GIST_ID', '150868'

data/features/author-formats-article.feature

@@ -0,0 +1,111 @@
+Feature: author formats article
+
+  As an author
+  I want to format my articles
+  So that they can be published
+
+  Scenario: format text followed by code
+    Given an article with the contents:
+      """
+      # :TEXT:
+      # This is my article
+    
+      this is my code
+      """
+    When I run the format command on the article
+    Then the output should be as follows:
+      """
+      This is my article
+  
+      this is my code
+      """
+
+  Scenario: format code with bracketing
+    Given an article with the contents:
+      """
+      # :BRACKET_CODE: "<pre>", "</pre>"
+      # :TEXT:
+      # This is my article
+    
+      this is my code
+      """
+    When I run the format command on the article
+    Then the output should be as follows:
+      """
+      This is my article
+  
+      <pre>
+      this is my code
+      </pre>
+      """
+
+  Scenario: override default bracketing
+    Given an article with the contents:
+      """
+      # :BRACKET_CODE: "<pre>", "</pre>"
+      # :TEXT: SECTION1
+      # This is my article
+    
+      # :SAMPLE: SECTION1, { brackets: [ '[code]', '[/code]' ] }
+      this is my code
+      """
+    When I run the format command on the article
+    Then the output should be as follows:
+      """
+      This is my article
+  
+      [code]
+      this is my code
+      [/code]
+      """
+
+  Scenario: insert a named section
+    Given an article with the contents:
+      """
+      # :BRACKET_CODE: "<pre>", "</pre>"
+    
+      # :SAMPLE: sample1
+      code sample 1
+
+      # :SAMPLE: sample2
+      code sample 2
+
+      # :TEXT:
+      # Here is example 2:
+      # :INSERT: @sample2
+      #
+      # And here is example 1:
+      # :INSERT: @sample1
+      """
+    When I run the format command on the article
+    Then the output should be as follows:
+      """
+      Here is example 2:
+      <pre>
+      code sample 2
+      </pre>
+
+      And here is example 1:
+      <pre>
+      code sample 1
+      </pre>
+      """
+
+  Scenario Outline: more formatting examples
+    Given the article "<input_file>"
+    When I run the format command on the article
+    Then the output should look like "<output_file>"
+
+  Scenarios:
+    | input_file        | output_file        |
+    | hello.rb          | hello.txt          |
+    | wrapping.rb       | wrapping.txt       |
+    | sample_offsets.rb | sample_offsets.txt |
+    | specials.rb       | specials.txt       |
+    | regexen.rb        | regexen.txt        |
+    | pipelines.txt     | pipelines.out      |
+    | escaping.txt      | escaping.out       |
+    | bracketing.rb     | bracketing.out     |
+    | stderr.rb         | stderr.out         |
+    | excerpt_output.rb | excerpt_output.out |
+

data/features/author-lists-info.pending_feature

@@ -0,0 +1,48 @@
+Note: this is a debug feature and its not worth specifying until it gets a bit
+more stable.
+Feature: author lists information
+
+  As an author
+  I want to list the various 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 list --sections" on the article
+    Then the output should be as follows:
+      """
+      SECTION1
+      A
+      """
+    When I run the command "germ list --samples" on the article
+    Then the output should be as follows:
+      """
+      SECTION1
+      SECTION2
+      X
+      """
+    When I run the command "germ list --processes" on the article
+    Then the output should be as follows:
+      """
+      frob
+      _transform
+      munge
+      """

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

@@ -0,0 +1,5 @@
+Feature: author publishes article source
+
+  As an author
+  I want to publish my article source code to Gist
+  So that I can share it with other programmers

data/features/author-publishes-article.feature

@@ -0,0 +1,57 @@
+Feature: author publishes article
+
+  As an author
+  I want to publish my article as a blog post
+  So that the world can see it
+
+  Scenario: using a shell publisher
+    Given an article with the contents:
+    """
+    # :PUBLISHER: source, shell, { command: "quoter %f", select: '$SOURCE' }
+    # :BRACKET_CODE: "<pre>", "</pre>"
+    # :TEXT:
+    # This is the text
+    # :SAMPLE:
+    def hello
+      # ...
+    end
+    """
+    When I run the command "germ publish source --debug " on the article
+    Then the output should be as follows:
+    """
+    > # :PUBLISHER: source, shell, { command: "quoter %f", select: '$SOURCE' }
+    > # :BRACKET_CODE: "<pre>", "</pre>"
+    > # :TEXT:
+    > # This is the text
+    > # :SAMPLE:
+    > def hello
+    >   # ...
+    > end
+    """
+
+  Scenario: using a shell publisher with a pipeline
+    Given an article with the contents:
+    """
+    # :PROCESS: quote, "quoter %f"
+    # :PUBLISHER: source, shell, { command: "quoter %f", pipeline: quote, select: '$SOURCE' }
+    # :BRACKET_CODE: "<pre>", "</pre>"
+    # :TEXT:
+    # This is the text
+    # :SAMPLE:
+    def hello
+      # ...
+    end
+    """
+    When I run the command "germ publish source --debug " on the article
+    Then the output should be as follows:
+    """
+    > > # :PROCESS: quote, "quoter %f"
+    > > # :PUBLISHER: source, shell, { command: "quoter %f", pipeline: quote, select: '$SOURCE' }
+    > > # :BRACKET_CODE: "<pre>", "</pre>"
+    > > # :TEXT:
+    > > # This is the text
+    > > # :SAMPLE:
+    > > def hello
+    > >   # ...
+    > > end
+    """

data/features/author-republishes-article.feature

@@ -0,0 +1,5 @@
+Feature: author re-publishes article
+
+  As an author
+  I want to re-publish my article after updating it
+  So that the world can see the latest version

data/features/author-selects-hunks.feature

@@ -0,0 +1,26 @@
+Feature: author experiments with selectors
+
+  As an author
+  I want to test the behavior of various selectors
+  So that I know what to use in my article
+
+  Scenario: list stuff
+    Given an article with the contents:
+      """
+      # :TEXT: A
+      # Section A
+
+      # :SAMPLE: X
+      X 1
+      X 2
+      X 3
+      X 4
+
+      # :PROCESS: quote, "quoter %f"
+      """
+    When I run the command "germ select '@X:2..3|quote'" on the article
+    Then the output should be as follows:
+      """
+      > X 2
+      > X 3
+      """

data/features/author-sets-variables.feature

@@ -0,0 +1,88 @@
+Feature: author sets variables
+
+  As an author
+  I want to set named values in my article
+  So that I can re-use them in processes, etc.
+
+  Scenario: setting a new variable
+    Given an article with the contents:
+    """
+    # :TEXT:
+    # This is some text
+    # :SET: FOO, 123
+    """
+    When I run the command "germ list variables --debug" on the article
+    Then the output should be as follows:
+    """
+    FOO                  123
+    """
+    When I run the command "germ set MAGIC_WORD xyzzy --debug" on the article
+    Then the article contents should be:
+    """
+    # :TEXT:
+    # This is some text
+    # :SET: FOO, 123
+    # :SET: 'MAGIC_WORD', 'xyzzy'
+
+    """
+    And the article backup contents should be:
+    """
+    # :TEXT:
+    # This is some text
+    # :SET: FOO, 123
+    """
+    When I run the command "germ list variables --debug" on the article
+    Then the output should be as follows:
+    """
+    FOO                  123
+    MAGIC_WORD           xyzzy
+    """
+
+  Scenario: changing an existing variable
+    Given an article with the contents:
+    """
+    # :PUBLISHER: env, shell, { command: 'echo %f > /dev/null; echo $FOO' }
+    # :TEXT:
+    # This is some text
+    # :SET: FOO, 123
+    # This is more text
+    """
+    When I run the command "germ list variables --debug" on the article
+    Then the output should be as follows:
+    """
+    FOO                  123
+    """
+    When I run the command "germ publish env --debug" on the article
+    Then the output should be as follows:
+    """
+    123
+    """
+    When I run the command "germ set FOO 456 --debug" on the article
+    Then the article contents should be:
+    """
+    # :PUBLISHER: env, shell, { command: 'echo %f > /dev/null; echo $FOO' }
+    # :TEXT:
+    # This is some text
+    # :SET: 'FOO', '456'
+    # This is more text
+
+    """
+    And the article backup contents should be:
+    """
+    # :PUBLISHER: env, shell, { command: 'echo %f > /dev/null; echo $FOO' }
+    # :TEXT:
+    # This is some text
+    # :SET: FOO, 123
+    # This is more text
+
+    """
+    When I run the command "germ list variables --debug" on the article
+    Then the output should be as follows:
+    """
+    FOO                  456
+    """
+    When I run the command "germ publish env --debug" on the article
+    Then the output should be as follows:
+    """
+    456
+    """