devver-germinate 1.0.1 → 1.1.0

data/History.txt

@@ -1,3 +1,13 @@
+== 1.1.0 / 2009-07-12
+
+* 1 major enhancement
+  * Added post-pipeline excerpting, e.g. $SOURCE|ruby:/def foo/../end/
+    Post-pipeline excerpting executes the process against the entire sample and 
+    then excerpts the output.
+* 1 minor enhancement
+  * Processes applied to $SOURCE will be given the actual source path instead of
+    a temp file
+
 == 1.0.0 / 2009-07-06
 
 * 1 major enhancement

data/TODO

@@ -0,0 +1,71 @@
+# -*- mode: org -*-
+#+SEQ_TODO:  TODO | DONE INVALID
+
+* INVALID Fix bug in `germ select`                          :bug:
+  CLOSED: [2009-07-12 Sun 18:25]
+:   germ select -s "$SOURCE|ruby" ruby_subprocesses_part_2.rb 
+:   F, [2009-07-12T17:41:17.331337 #19506] FATAL -- : No code sample named 'SECTION0'.  Known samples: helpers, SECTION3, open_with_pipe, open_with_pipe_dash, popen, popen_with_dash, SECTION8 (IndexError)
+
+<2009-07-12 Sun> My mistake... the shell was interpreting the $SOURCE directive.
+    
+* DONE Make $SOURCE use the actual source file path in processes
+  CLOSED: [2009-07-12 Sun 19:46]
+
+* TODO Improve error message for non-matching regexen in selectors :usability:
+
+* TODO Output line numbers for Reader errors                :usability:
+
+* TODO Gist uploads                                         :feature:
+
+* TODO Publishing to WordPress blogs (Atompub)              :feature:
+
+* TODO Alternate directive syntax                           :usability:
+  one that doesn't conflict with RDoc
+
+* TODO Anonymous processes                                  :feature:
+  A process that doesn't match a predefined process name should be interpreted
+  as a shell command.
+
+* TODO Code indent                                          :feature:
+  Define an indent (either N spaces or a string) to be applied to code sections.
+
+  Should first de-indent code.
+
+* TODO Shorthand for matching whitespace in selectors       :feature:
+  e.g. "@mysample:/def foo/..._"
+
+* TODO Format Pipelines                                     :feature:
+  Define a pipeline to be run on the entire article after formatting
+
+* TODO ERB Substitution                                     :feature:
+  Should be run on TEXT sections.
+
+* TODO Line# Helper                                         :feature:
+  A helper for ERB subtitution which inserts the line# of a given selector.
+
+* TODO Plugin API                                           :feature:
+  Should use gems to discover plugins.
+
+* TODO User-global preference file                          :feature:
+
+* TODO Multiple file support                                :feature:
+
+* TODO Output line numbers for errors at any point          :usability:
+  This will require giving Hunks the knowledge of their source offset.
+  
+* TODO Nested samples                                       :feature:
+  Might want to wait this on the implementation of nested states in AlterEgo.
+
+* TODO Optionally capture STDERR from processes             :feature:
+
+  Workaround: Authors can just include 2>&1 in their process definitions.
+
+* DONE Syntax for post-process excerpting
+  CLOSED: [2009-07-12 Sun 20:50]
+  E.g. "$SOURCE|ruby:/---/../---/"
+
+  This would cause the process to be run on $SOURCE and then a subset of the
+  output to be excerpted.
+
+* TODO Named Styles
+  A way to group together a bunch of style attributes in a reusable way.

data/bin/germ

@@ -44,9 +44,9 @@ Main do
     source_argument
     def run
       Germinate.logger = self
-      with_source_file do |source|
+      with_source_file do |source, path|
         application = Germinate::Application.new
-        application.format(source, $stdout, $stderr)
+        application.format(source, path, $stdout, $stderr)
       end
     end
   end
@@ -67,9 +67,9 @@ Main do
       COLLECTIONS.each do |collection|
         things_to_list << collection if params[collection].value
       end
-      with_source_file do |source|
+      with_source_file do |source, path|
         application = Germinate::Application.new
-        application.list(source, things_to_list, $stdout)
+        application.list(source, path, things_to_list, $stdout)
       end
     end
   end
@@ -90,9 +90,9 @@ Main do
         sel[type] = params[type].values
         sel
       }
-      with_source_file do |source|
+      with_source_file do |source, path|
         application = Germinate::Application.new
-        application.show(source, selection, $stdout)
+        application.show(source, path, selection, $stdout)
       end
     end
   end
@@ -108,9 +108,9 @@ Main do
     end
 
     def run
-      with_source_file do |source|
+      with_source_file do |source, path|
         application = Germinate::Application.new
-        application.select(source, params[:selector].value, $stdout)
+        application.select(source, path, params[:selector].value, $stdout)
       end
     end
   end
@@ -125,8 +125,11 @@ Main do
     end
   end
 
-  def with_source_file(&block)
-    File.open(params['source'].value, &block)
+  def with_source_file
+    path = params['source'].value
+    File.open(path) do |file|
+      yield file, path
+    end
   end
 end
 

data/features/author-formats-article.feature

@@ -106,4 +106,6 @@ Feature: author formats article
     | pipelines.txt     | pipelines.out      |
     | escaping.txt      | escaping.out       |
     | bracketing.rb     | bracketing.out     |
+    | stderr.rb         | stderr.out         |
+    | excerpt_output.rb | excerpt_output.out |
 

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/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_output/excerpt_output.out

@@ -0,0 +1,6 @@
+===
+line 2
+=====
+---
+line 1
+-----

data/features/example_output/stderr.out

@@ -0,0 +1,3 @@
+Hello, STDOUT
+Hello, STDERR
+Hello again, STDOUT

data/features/step_definitions/germinate.rb

@@ -19,10 +19,13 @@ Then /^the output should look like "([^\"]*)"$/ do |output_file|
 end
 
 Given /^an article with the contents:$/ do |contents|
-  Tempfile.open("germinate_example_article") do |file|
-    file.write(contents)
-    @filename = Pathname(file.path)
+  file = Tempfile.open("germinate_example_article")
+  file.write(contents)
+  file.close
+  at_exit do
+    file.delete
   end
+  @filename   = Pathname(file.path)
 end
 
 Then /^the output should be as follows:$/ do |example_output|

data/features/support/env.rb

@@ -16,3 +16,5 @@ def run_germinate(arguments, permit_failure=false)
   @result   = $CHILD_STATUS
   raise "Command `#{command}` failed" unless @result.success? or permit_failure
 end
+
+

data/germinate.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{germinate}
-  s.version = "1.0.1"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Avdi Grimm"]
-  s.date = %q{2009-07-10}
+  s.date = %q{2009-07-13}
   s.default_executable = %q{germ}
   s.description = %q{Germinate is a tool for writing about code.  With Germinate, the source code IS the article.  For example, given the following source code:  # #!/usr/bin/env ruby # :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  When we run the <tt>germ format</tt> command the following output is generated:  Check out my amazing program!  Here's the hello method: <pre> def hello(who) puts "Hello, #{who}" end </pre> And here's the output: <pre> Hello, World </pre>  To get a better idea of how this works, please take a look at link:examples/basic.rb, or run:  germ generate > basic.rb  To generate an example article to play with.  Germinate is particularly useful for writing articles, such as blog posts, which contain code excerpts.  Instead of forcing you to keep a source code file and an article document in sync throughout the editing process, the Germinate motto is "The source code IS the article".  Specially marked comment sections in your code file become the article text.  Wherever you need to reference the source code in the article, use insertion directives to tell Germinate what parts of the code to excerpt.  An advanced selector syntax enables you to be very specific about which lines of code you want to insert.  If you also want to show the output of your code, Germinate has you covered. Special "process" directives enable you to define arbitrary commands which can be run on your code.  The output of the command then becomes the excerpt text. You can define an arbitrary number of processes and have different excerpts showing the same code as processed by different commands.  You can even string processes together into pipelines.  Development of Germinate is graciously sponsored by Devver, purveyor of fine cloud-based services to busy Ruby developers.  If you like this tool please check them out at http://devver.net.}
   s.email = %q{avdi@avdi.org}
   s.executables = ["germ"]
   s.extra_rdoc_files = ["History.txt", "README.rdoc", "bin/germ"]
-  s.files = [".gitignore", "History.txt", "README.rdoc", "Rakefile", "bin/germ", "cucumber.yml", "examples/basic.rb", "examples/short.rb", "features/author-formats-article.feature", "features/author-lists-info.feature", "features/author-publishes-article-source.feature", "features/author-publishes-article.feature", "features/author-republishes-article.feature", "features/author-selects-hunks.feature", "features/author-updates-article-source.feature", "features/author-views-stuff.feature", "features/bin/quoter", "features/bin/sorter", "features/example_articles/bracketing.rb", "features/example_articles/escaping.txt", "features/example_articles/hello.rb", "features/example_articles/pipelines.txt", "features/example_articles/regexen.rb", "features/example_articles/sample_offsets.rb", "features/example_articles/specials.rb", "features/example_articles/wrapping.rb", "features/example_output/bracketing.out", "features/example_output/code_samples.txt", "features/example_output/escaping.out", "features/example_output/hello.txt", "features/example_output/pipelines.out", "features/example_output/regexen.txt", "features/example_output/sample_offsets.txt", "features/example_output/specials.txt", "features/example_output/wrapping.txt", "features/step_definitions/germinate.rb", "features/support/env.rb", "germinate.gemspec", "lib/germinate.rb", "lib/germinate/application.rb", "lib/germinate/article_editor.rb", "lib/germinate/article_formatter.rb", "lib/germinate/formatter.rb", "lib/germinate/hunk.rb", "lib/germinate/implicit_insertion.rb", "lib/germinate/insertion.rb", "lib/germinate/librarian.rb", "lib/germinate/pipeline.rb", "lib/germinate/process.rb", "lib/germinate/reader.rb", "lib/germinate/selector.rb", "lib/germinate/shared_style_attributes.rb", "lib/germinate/text_transforms.rb", "spec/germinate/application_spec.rb", "spec/germinate/article_editor_spec.rb", "spec/germinate/article_formatter_spec.rb", "spec/germinate/code_hunk_spec.rb", "spec/germinate/formatter_spec.rb", "spec/germinate/hunk_spec.rb", "spec/germinate/implicit_insertion_spec.rb", "spec/germinate/insertion_spec.rb", "spec/germinate/librarian_spec.rb", "spec/germinate/pipeline_spec.rb", "spec/germinate/process_spec.rb", "spec/germinate/reader_spec.rb", "spec/germinate/selector_spec.rb", "spec/germinate/text_hunk_spec.rb", "spec/germinate/text_transforms_spec.rb", "spec/germinate_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/ann.rake", "tasks/bones.rake", "tasks/cucumber.rake", "tasks/gem.rake", "tasks/git.rake", "tasks/notes.rake", "tasks/post_load.rake", "tasks/rdoc.rake", "tasks/rubyforge.rake", "tasks/setup.rb", "tasks/spec.rake", "tasks/svn.rake", "tasks/test.rake", "tasks/zentest.rake", "test/test_germinate.rb"]
+  s.files = [".gitignore", "History.txt", "README.rdoc", "Rakefile", "TODO", "bin/germ", "cucumber.yml", "examples/basic.rb", "examples/short.rb", "features/author-formats-article.feature", "features/author-lists-info.feature", "features/author-publishes-article-source.feature", "features/author-publishes-article.feature", "features/author-republishes-article.feature", "features/author-selects-hunks.feature", "features/author-updates-article-source.feature", "features/author-views-stuff.feature", "features/bin/quoter", "features/bin/sorter", "features/example_articles/bracketing.rb", "features/example_articles/escaping.txt", "features/example_articles/excerpt_output.rb", "features/example_articles/hello.rb", "features/example_articles/pipelines.txt", "features/example_articles/regexen.rb", "features/example_articles/sample_offsets.rb", "features/example_articles/specials.rb", "features/example_articles/stderr.rb", "features/example_articles/wrapping.rb", "features/example_output/bracketing.out", "features/example_output/code_samples.txt", "features/example_output/escaping.out", "features/example_output/excerpt_output.out", "features/example_output/hello.txt", "features/example_output/pipelines.out", "features/example_output/regexen.txt", "features/example_output/sample_offsets.txt", "features/example_output/specials.txt", "features/example_output/stderr.out", "features/example_output/wrapping.txt", "features/step_definitions/germinate.rb", "features/support/env.rb", "germinate.gemspec", "lib/germinate.rb", "lib/germinate/application.rb", "lib/germinate/article_editor.rb", "lib/germinate/article_formatter.rb", "lib/germinate/formatter.rb", "lib/germinate/hunk.rb", "lib/germinate/implicit_insertion.rb", "lib/germinate/insertion.rb", "lib/germinate/librarian.rb", "lib/germinate/pipeline.rb", "lib/germinate/process.rb", "lib/germinate/reader.rb", "lib/germinate/selector.rb", "lib/germinate/shared_style_attributes.rb", "lib/germinate/text_transforms.rb", "spec/germinate/application_spec.rb", "spec/germinate/article_editor_spec.rb", "spec/germinate/article_formatter_spec.rb", "spec/germinate/code_hunk_spec.rb", "spec/germinate/file_hunk_spec.rb", "spec/germinate/formatter_spec.rb", "spec/germinate/hunk_spec.rb", "spec/germinate/implicit_insertion_spec.rb", "spec/germinate/insertion_spec.rb", "spec/germinate/librarian_spec.rb", "spec/germinate/pipeline_spec.rb", "spec/germinate/process_spec.rb", "spec/germinate/reader_spec.rb", "spec/germinate/selector_spec.rb", "spec/germinate/text_hunk_spec.rb", "spec/germinate/text_transforms_spec.rb", "spec/germinate_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/ann.rake", "tasks/bones.rake", "tasks/cucumber.rake", "tasks/gem.rake", "tasks/git.rake", "tasks/notes.rake", "tasks/post_load.rake", "tasks/rdoc.rake", "tasks/rubyforge.rake", "tasks/setup.rb", "tasks/spec.rake", "tasks/svn.rake", "tasks/test.rake", "tasks/zentest.rake", "test/test_germinate.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/devver/germinate/}
   s.rdoc_options = ["--main", "README.rdoc"]

data/lib/germinate.rb

@@ -5,7 +5,7 @@ require 'logger'
 module Germinate
 
   # :stopdoc:
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:

data/lib/germinate/application.rb

@@ -3,8 +3,8 @@
 class Germinate::Application
   attr_writer :formatter
 
-  def format(source, output=$stdout, errors=$stderr)
-    librarian = load_librarian(source)
+  def format(source, path, output=$stdout, errors=$stderr)
+    librarian = load_librarian(source, path)
     editor    = Germinate::ArticleEditor.new(librarian)
     formatter = Germinate::ArticleFormatter.new(output)
 
@@ -19,8 +19,8 @@ class Germinate::Application
     formatter.finish!
   end
 
-  def list(source, things_to_list, output=$stdout)
-    librarian = load_librarian(source)
+  def list(source, path, things_to_list, output=$stdout)
+    librarian = load_librarian(source, path)
     if things_to_list.include?(:sections)
       output.puts(librarian.section_names.join("\n"))
     end
@@ -32,8 +32,8 @@ class Germinate::Application
     end
   end
 
-  def show(source, selection, output=$stdout)
-    librarian = load_librarian(source)
+  def show(source, path, selection, output=$stdout)
+    librarian = load_librarian(source, path)
     selection.fetch(:section, []).each do |section|
       output.puts(*librarian.section(section))
     end
@@ -45,15 +45,15 @@ class Germinate::Application
     end
   end
 
-  def select(source, selector, output=$stdout)
-    librarian = load_librarian(source)
+  def select(source, path, selector, output=$stdout)
+    librarian = load_librarian(source, path)
     output.puts(*librarian[selector])
   end
   private
 
-  def load_librarian(source)
+  def load_librarian(source, path)
     librarian = Germinate::Librarian.new
-    reader    = Germinate::Reader.new(librarian)
+    reader    = Germinate::Reader.new(librarian, path)
     source.each_line do |line|
       reader << line
     end

data/lib/germinate/hunk.rb

@@ -1,4 +1,6 @@
+require 'pathname'
 require 'ick'
+require 'fattr'
 require File.expand_path("shared_style_attributes", File.dirname(__FILE__))
 
 # A Hunk represents a chunk of content.  There are different types of Hunk, like
@@ -11,7 +13,7 @@ class Germinate::Hunk < ::Array
 
   def initialize(contents=[], template = {})
     super(contents)
-    copy_shared_style_attrubutes_from(template)
+    copy_shared_style_attributes_from(template)
   end
 
   # return a copy with leading and trailing whitespace lines removed
@@ -51,7 +53,7 @@ class Germinate::Hunk < ::Array
   def [](*args)
     returning(super) do |slice|
       if slice.kind_of?(Germinate::Hunk)
-        slice.copy_shared_style_attrubutes_from(self)
+        slice.copy_shared_style_attributes_from(self)
       end
     end
   end
@@ -59,7 +61,7 @@ class Germinate::Hunk < ::Array
   def slice(*args)
     returning(super) do |slice|
       if slice.kind_of?(Germinate::Hunk)
-        slice.copy_shared_style_attrubutes_from(self)
+        slice.copy_shared_style_attributes_from(self)
       end
     end
   end
@@ -71,6 +73,10 @@ class Germinate::Hunk < ::Array
     nil
   end
 
+  def whole_file?
+    false
+  end
+
   private
 
   def resolved?
@@ -113,6 +119,7 @@ class Germinate::Hunk < ::Array
 
 end
 
+# Represents a hunk of article text
 class Germinate::TextHunk < Germinate::Hunk
   def format_with(formatter)
     super(formatter) do |formatter|
@@ -121,6 +128,7 @@ class Germinate::TextHunk < Germinate::Hunk
   end
 end
 
+# Represents a hunk of source code
 class Germinate::CodeHunk < Germinate::Hunk
   def code_open_bracket=(new_value)
     super
@@ -141,3 +149,15 @@ end
 class Germinate::NullHunk < Germinate::Hunk
 end
 
+# Represents a the entire text of a file on disk
+class Germinate::FileHunk < Germinate::CodeHunk
+  def initialize(lines, template)
+    super(lines, template)
+    raise ArgumentError, "Path required" if source_path.nil?
+  end
+
+  def whole_file?
+    true
+  end
+end
+

data/lib/germinate/insertion.rb

@@ -8,14 +8,14 @@ class Germinate::Insertion
   attr_reader :selector
 
   def initialize(selector, library, template={})
-    copy_shared_style_attrubutes_from(template)
+    copy_shared_style_attributes_from(template)
     @selector = selector
     @library  = library
   end
 
   def resolve
     returning(library[selector]) do |hunk|
-      hunk.copy_shared_style_attrubutes_from(self, false)
+      hunk.copy_shared_style_attributes_from(self, false)
     end
   end
 end

data/lib/germinate/librarian.rb

@@ -13,6 +13,8 @@ class Germinate::Librarian
   attr_reader   :code_lines
   attr_reader   :front_matter_lines
 
+  fattr         :source_path => nil
+
   fattr(:log) { Germinate.logger }
 
   def initialize
@@ -114,7 +116,12 @@ class Germinate::Librarian
       when :code then sample(selector.key)
       when :special then 
         case selector.key
-        when "SOURCE" then Germinate::CodeHunk.new(lines, self)
+        when "SOURCE" 
+          if selector.whole?
+            Germinate::FileHunk.new(lines, self)
+          else
+            Germinate::CodeHunk.new(lines, self)
+          end
         when "CODE"   then Germinate::CodeHunk.new(code_lines, self)
         when "TEXT"   then Germinate::CodeHunk.new(text_lines, self)
         else raise "Unknown special section '$#{selector.key}'"
@@ -155,7 +162,12 @@ class Germinate::Librarian
     offset = selector.start_offset_for_slice
     case offset
     when Integer then offset
-    when Regexp  then hunk.index_matching(offset)
+    when Regexp  then 
+      returning(hunk.index_matching(offset)) do |offset|
+        if offset.nil?
+          raise "Cannot find line matching #{offset.inspect}"
+        end
+      end
     else 
       raise "Don't know how to use #{offset.inspect} as an offset"
     end
@@ -166,7 +178,11 @@ class Germinate::Librarian
     case offset
     when Integer, nil then offset
     when Regexp then 
-      hunk.index_matching(offset, start_offset)
+      returning(hunk.index_matching(offset, start_offset)) do |offset|
+        if offset.nil?
+          raise "Cannot find line matching #{offset.inspect}"
+        end
+      end
     else
       raise "Don't know how to use #{offset.inspect} as an offset"
     end

data/lib/germinate/process.rb

@@ -19,6 +19,8 @@ class Germinate::Process
   def call(input)
     if pipe?
       call_command_in_pipe(input)
+    elsif input.whole_file?
+      call_command_on_source_file(input)
     else
       call_command_on_temp_file(input)
     end
@@ -48,6 +50,12 @@ class Germinate::Process
     end
   end
 
+  def call_command_on_source_file(input)
+    log_popen(substitute_filename(command, input.source_path), 'r') do |process|
+      return Germinate::CodeHunk.new(process.readlines, input)
+    end
+  end
+
   def pipe?
     !command.include?("%f")
   end

data/lib/germinate/reader.rb

@@ -57,11 +57,13 @@ class Germinate::Reader
 
   end
 
-  def initialize(librarian)
+  def initialize(librarian, source_path=nil)
     @librarian       = librarian
     @section_count   = 0
     @current_section = "SECTION0"
     @line_number     = 1
+    @source_path     = source_path ? Pathname(source_path) : nil
+    librarian.source_path = @source_path
   end
 
   # Read a line

data/lib/germinate/selector.rb

@@ -9,7 +9,8 @@ class Germinate::Selector
   attr_reader :pipeline
   attr_reader :default_key
 
-  PATTERN = /([@$])?(\w+)?(:([^\s\|]+))?(\|([\w|]+))?/
+  PATTERN = /^([@$])?(\w+)?(:([^\s\|]+))?(\|([\w|]+))?$/
+  EXCERPT_OUTPUT_PATTERN = /^([@$])?(\w+)?(\|([\w|]+))?(:([^\s\|]+))?$/
   EXCERPT_PATTERN = %r{((-?\d+)|(/[^/]*/))(((\.\.\.?)|(,))((-?\d+)|(/[^/]*/)))?}
 
   def initialize(string, default_key)
@@ -17,9 +18,20 @@ class Germinate::Selector
     @default_key = default_key
     match_data = case string
                  when "", nil then {}
-                 else PATTERN.match(string)
+                 else 
+                   if data = PATTERN.match(string) 
+                     @excerpt_output = false
+                   elsif data = EXCERPT_OUTPUT_PATTERN.match(string)
+                     @excerpt_output = true
+                   else
+                     raise "Could not parse selector '#{string}'"
+                   end
+                   data
                  end
 
+    subscript_index = @excerpt_output ? 6 : 3
+    pipeline_index  = @excerpt_output ? 4 : 6
+
     @selector_type = 
       case match_data[1]
       when "$" then :special
@@ -27,15 +39,17 @@ class Germinate::Selector
       else raise "Unknown selector type '#{match_data[1]}'"
       end
     @key = match_data[2] || default_key
-    if match_data[3]
-      parse_excerpt(match_data[3])
+    if match_data[subscript_index]
+      @slice = true
+      parse_excerpt(match_data[subscript_index])
     else
+      @slice        = false
       @delimiter    = '..'
       @start_offset = 1
       @end_offset   = -1
       @length       = nil
     end
-    @pipeline = String(match_data[6]).split("|")
+    @pipeline = String(match_data[pipeline_index]).split("|")
   end
 
   def start_offset_for_slice
@@ -46,6 +60,21 @@ class Germinate::Selector
     offset_for_slice(end_offset)
   end
 
+  # Should excerpting be done on the output of the process?
+  def excerpt_output?
+    @excerpt_output
+  end
+
+  # Is it just a subset of the source hunk? (opposite of @whole?)
+  def slice?
+    @slice && !@excerpt_output
+  end
+
+  # Is it the entire hunk? (opposite of #slice?)
+  def whole?
+    !slice?
+  end
+
   private
 
   def parse_excerpt(excerpt)

data/lib/germinate/shared_style_attributes.rb

@@ -5,6 +5,7 @@ module Germinate::SharedStyleAttributes
   fattr :code_open_bracket  => nil
   fattr :code_close_bracket => nil
   fattr :pipeline           => []
+  fattr :source_path        => nil
 
   def shared_style_attributes
     Germinate::SharedStyleAttributes.fattrs.inject({}) { 
@@ -15,7 +16,7 @@ module Germinate::SharedStyleAttributes
     }
   end
 
-  def copy_shared_style_attrubutes_from(other, override=true)
+  def copy_shared_style_attributes_from(other, override=true)
     case other
     when Germinate::SharedStyleAttributes
       copy_attributes!(other.shared_style_attributes)

data/spec/germinate/file_hunk_spec.rb

@@ -0,0 +1,27 @@
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. .. lib germinate]))
+
+module Germinate
+  describe FileHunk do
+    before :each do
+      @it = FileHunk.new(["foo", "bar"], {:source_path => "SOURCE_PATH"})
+    end
+
+    it "should know its source path" do 
+      @it.source_path.to_s.should == "SOURCE_PATH"
+    end
+
+    specify { @it.should be_whole_file }
+
+    context "when visited by a formatter" do
+      before :each do
+        @formatter = stub("Formatter")
+      end
+
+      it "should call #formate_code! for self" do
+        @formatter.should_receive(:format_code!).with(@it, anything)
+        @it.format_with(@formatter)
+      end
+    end
+  end
+end

data/spec/germinate/hunk_spec.rb

@@ -40,6 +40,12 @@ module Germinate
       @it = Hunk.new
     end
 
+    it "should not have a source path" do
+      @it.source_path.should be_nil
+    end
+
+    specify { @it.should_not be_whole_file }
+
     context "with an insertion" do
       before :each do
         @nested_hunk = stub("Nested Hunk")

data/spec/germinate/librarian_spec.rb

@@ -9,6 +9,11 @@ module Germinate
   describe Librarian do
     before :each do
       @it = Librarian.new
+      @it.source_path = "SOURCE_PATH"
+    end
+
+    it "should know its source path if given" do
+      @it.source_path.should == "SOURCE_PATH"
     end
 
     context "by default" do
@@ -275,6 +280,21 @@ module Germinate
         @it["@SECTION1"].should == ["CODE 1"]
       end
 
+      context "given the $SOURCE selector with no subscripts" do
+        before :each do
+          @hunk = @it["$SOURCE"]
+        end
+
+        it "should return a FileHunk" do
+          @hunk.should be_a_kind_of(FileHunk)
+        end
+
+        it "should return a FileHunk with the source file path set" do
+          @hunk.source_path.should == "SOURCE_PATH"
+        end
+
+      end
+
       SELECTOR_EXAMPLES = [
         # Selector                  Expected Excerpt                   Expected Type
         [ "@SECTION1",              ["CODE 1"],                        CodeHunk ],
@@ -313,7 +333,7 @@ module Germinate
             "CODE 2l2",
             "CODE 2l3",
             "CODE 2l4",
-          ],                                                    CodeHunk
+          ],                                                    FileHunk
         ],
         [ "$TEXT",               [          
             "TEXT 1",

data/spec/germinate/process_spec.rb

@@ -60,5 +60,21 @@ module Germinate
       end
 
     end
+
+    context "given a command 'mycommand %f' and called on a file hunk" do
+      before :each do
+        @input = Germinate::FileHunk.new(
+          ["line 1\n", "line 2\n"],
+          {:source_path => "SOURCE_PATH"})
+        @it = Germinate::Process.new("myproc", "mycommand %f")
+      end
+
+      it "should pass the source file path to the command" do
+        @path = stub("Source File Path")
+        IO.should_receive(:popen).with("mycommand 'SOURCE_PATH'", "r").
+          and_yield(@command)
+        @it.call(@input).should == @output
+      end
+    end
   end
 end

data/spec/germinate/reader_spec.rb

@@ -6,7 +6,7 @@ module Germinate
     before :each do
       @librarian = stub("Librarian", :comment_prefix_known? => false).
         as_null_object
-      @it        = Reader.new(@librarian)
+      @it        = Reader.new(@librarian, "SOURCE_PATH")
     end
 
     it "should start in the :initial state" do
@@ -21,6 +21,11 @@ module Germinate
       @it.current_section.should == "SECTION0"
     end
 
+    it "should set the librarian's source path" do
+      @librarian.should_receive(:source_path=).with(Pathname("SOURCE_PATH"))
+      @it = Reader.new(@librarian, "SOURCE_PATH")
+    end
+
     context "when section count is incremented" do
 
       before :each do

data/spec/germinate/selector_spec.rb

@@ -3,20 +3,49 @@ require File.expand_path(
 
 module Germinate
   describe Selector do
+
+    context "given a subscript" do
+      before :each do
+        @it = Germinate::Selector.new("@A:1", "DEFAULT")
+      end
+
+      specify { @it.should be_slice }
+      specify { @it.should_not be_whole }
+    end
+
+    context "given no subscript" do
+      before :each do
+        @it = Germinate::Selector.new("@A", "DEFAULT")
+      end
+
+      specify { @it.should_not be_slice }
+      specify { @it.should be_whole }
+    end
+
+    context "given a post-pipeline subscript" do
+      before :each do
+        @it = Germinate::Selector.new("@A|foo:1", "DEFAULT")
+      end
+
+      specify { @it.should_not be_slice }
+      specify { @it.should be_whole }
+    end
+
     EXAMPLE_SELECTORS = [
-      # selector       type      key        delim  start end length pipeline
-      [ "@A",          :code,    "A",       '..',  1,    -1, nil,   []     ],
-      [ "@A:1",        :code,    "A",       nil,   1,    1,  nil,   []     ],
-      [ "",            :code,    "DEFAULT", '..',  1,    -1, nil,   []     ],
-      [ nil,           :code,    "DEFAULT", '..',  1,    -1, nil,   []     ],
-      [ ":2..4",       :code,    "DEFAULT", '..',  2,    4,  nil,   []     ],
-      [ ":2...4",      :code,    "DEFAULT", '...', 2,    4,  nil,   []     ],
-      [ "@B:2,5",      :code,    "B",       ',',   2,    nil,5,     []     ],
-      [ "@B:/z/,6",    :code,    "B",       ',',   /z/,  nil,6,     []     ],
-      [ "@_:/z/../x/", :code,    "_",       '..',  /z/,  /x/,nil,   []     ],
-      [ "@B:2,4|fnord",:code,    "B",       ',',   2,    nil,4,     ["fnord"]],
-      [ "$FOO",        :special, "FOO",     '..',  1,    -1, nil,   []     ],
-      [ "@A|foo|bar",  :code,    "A",       '..',  1,    -1, nil,   ["foo", "bar"]],
+      # selector       type      key        delim  start end length pipeline excerpt_output?
+      [ "@A",          :code,    "A",       '..',  1,    -1, nil,   []       ,false],
+      [ "@A:1",        :code,    "A",       nil,   1,    1,  nil,   []       ,false],
+      [ "",            :code,    "DEFAULT", '..',  1,    -1, nil,   []       ,false],
+      [ nil,           :code,    "DEFAULT", '..',  1,    -1, nil,   []       ,false],
+      [ ":2..4",       :code,    "DEFAULT", '..',  2,    4,  nil,   []       ,false],
+      [ ":2...4",      :code,    "DEFAULT", '...', 2,    4,  nil,   []       ,false],
+      [ "@B:2,5",      :code,    "B",       ',',   2,    nil,5,     []       ,false],
+      [ "@B:/z/,6",    :code,    "B",       ',',   /z/,  nil,6,     []       ,false],
+      [ "@_:/z/../x/", :code,    "_",       '..',  /z/,  /x/,nil,   []       ,false],
+      [ "@B:2,4|fnord",:code,    "B",       ',',   2,    nil,4,     ["fnord"],false],
+      [ "$FOO",        :special, "FOO",     '..',  1,    -1, nil,   []       ,false],
+      [ "@A|foo|bar",  :code,    "A",       '..',  1,    -1, nil,   ["foo", "bar"],false],
+      [ "@B|fnord:2,4",:code,    "B",       ',',   2,    nil,4,     ["fnord"],true],
     ]
 
     EXAMPLE_SELECTORS.each do |selector_attributes| 
@@ -28,6 +57,7 @@ module Germinate
       end_offset      = selector_attributes[5]
       length          = selector_attributes[6]
       pipeline        = selector_attributes[7]
+      excerpt_output  = selector_attributes[8]
 
       context "given selector '#{selector_attributes[0]}'" do
         before :each do
@@ -59,6 +89,12 @@ module Germinate
         it "should have delimiter #{delimiter.inspect}" do
           @it.delimiter.should == delimiter
         end
+        
+        if excerpt_output
+          specify { @it.should be_excerpt_output }
+        else
+          specify { @it.should_not be_excerpt_output }
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: devver-germinate
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors: 
 - Avdi Grimm
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-10 00:00:00 -07:00
+date: 2009-07-13 00:00:00 -07:00
 default_executable: germ
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -97,6 +97,7 @@ files:
 - History.txt
 - README.rdoc
 - Rakefile
+- TODO
 - bin/germ
 - cucumber.yml
 - examples/basic.rb
@@ -113,20 +114,24 @@ files:
 - features/bin/sorter
 - features/example_articles/bracketing.rb
 - features/example_articles/escaping.txt
+- features/example_articles/excerpt_output.rb
 - features/example_articles/hello.rb
 - features/example_articles/pipelines.txt
 - features/example_articles/regexen.rb
 - features/example_articles/sample_offsets.rb
 - features/example_articles/specials.rb
+- features/example_articles/stderr.rb
 - features/example_articles/wrapping.rb
 - features/example_output/bracketing.out
 - features/example_output/code_samples.txt
 - features/example_output/escaping.out
+- features/example_output/excerpt_output.out
 - features/example_output/hello.txt
 - features/example_output/pipelines.out
 - features/example_output/regexen.txt
 - features/example_output/sample_offsets.txt
 - features/example_output/specials.txt
+- features/example_output/stderr.out
 - features/example_output/wrapping.txt
 - features/step_definitions/germinate.rb
 - features/support/env.rb
@@ -150,6 +155,7 @@ files:
 - spec/germinate/article_editor_spec.rb
 - spec/germinate/article_formatter_spec.rb
 - spec/germinate/code_hunk_spec.rb
+- spec/germinate/file_hunk_spec.rb
 - spec/germinate/formatter_spec.rb
 - spec/germinate/hunk_spec.rb
 - spec/germinate/implicit_insertion_spec.rb