devver-germinate 1.1.0 → 1.2.0

data/spec/germinate/text_hunk_spec.rb

@@ -3,6 +3,51 @@ require File.expand_path(
 
 module Germinate
   describe TextHunk do
+    before :each do
+      @it = TextHunk.new(["line 1", "line 2"])
+    end
+
+    it "should enable insertion expansion" do
+      @it.should be_expand_insertions
+    end
+
+    it "should enable line joining" do
+      @it.should be_join_lines
+    end
+
+    it "should enable blank stripping" do
+      @it.should be_strip_blanks
+    end
+
+    it "should disable comment erasure" do
+      @it.should_not be_erase_comments
+    end
+
+    it "should enable uncommenting" do
+      @it.should be_uncomment
+    end
+
+    it "should enable stripping right-side whitespace" do
+      @it.should be_rstrip_lines
+    end
+
+    it "should disable bracketing" do
+      @it.should_not be_bracket
+    end
+      
+    it "should enable pipeline processing" do
+      @it.should be_pipeline
+    end
+
+    it "should enable insertion resolution" do
+      @it.should be_expand_insertions
+    end
+
+    it "should enable flattening nested hunks" do
+      @it.should be_flatten_nested
+    end
+
+
     context "when visited by a formatter" do
       before :each do
         @comment_prefix = ">>"

data/spec/germinate/text_transforms_spec.rb

@@ -6,13 +6,35 @@ module Germinate
 
     Germinate::TextTransforms.methods(false).each do |transform|
       describe "'#{transform}'" do
+        before :each do
+          @transform = Germinate::TextTransforms.send(transform)
+        end
+
         it "should preserve hunk attributes from input to output" do
           @pipeline = lambda {|h| h}
           @input = Hunk.new([], :comment_prefix => "foo", :pipeline => @pipeline)
-          @transform = Germinate::TextTransforms.send(transform)
           @output = @transform.call(@input)
           @output.comment_prefix.should == @input.comment_prefix
         end
+
+        unless transform == "flatten_nested"
+          context "given a lumpy hunk" do
+            before :each do
+              @nested_hunk = Hunk.new(["line 3", "line 4"])
+              @lumpy = Hunk.new([
+                  "line 1",
+                  @nested_hunk,
+                  "line 2"
+                ],
+                :comment_prefix => "foo")
+              @output = @transform.call(@lumpy)
+            end
+            
+            it "should pass nested hunks through untouched" do
+              @output[1].should == @nested_hunk
+            end
+          end
+        end
       end
     end
 
@@ -49,7 +71,7 @@ module Germinate
         end
 
         it "should do nothing" do
-          @it.call(["# foo", " bar"]).should == ["# foo", " bar"]
+          @it.call(Hunk.new(["# foo", " bar"])).should == ["# foo", " bar"]
         end
       end
 
@@ -63,6 +85,17 @@ module Germinate
         end
       end
 
+      context "given no explicit prefix" do
+        before :each do
+          @hunk = Hunk.new([" # foo", " bar"], :comment_prefix => " # ")
+          @it = TextTransforms.uncomment
+        end
+
+        it "should fall back on hunk's comment prefix" do
+          @it.call(@hunk).should == ["foo", " bar"]
+        end
+      end
+
     end
 
     describe "strip_blanks" do
@@ -81,6 +114,23 @@ module Germinate
         end
       end
 
+      context "given a nested hunk at the end" do
+        before :each do
+          @hunk = Hunk.new(
+            [
+              "not blank", 
+              "the good stuff", 
+              Hunk.new(["line 1"])
+            ])
+          @it = TextTransforms.strip_blanks
+        end
+
+        it "should not strip the hunk" do
+          @it.call(@hunk).should == 
+            ["not blank", "the good stuff", Hunk.new(["line 1"])]
+        end
+      end
+
     end
 
     describe "rstrip_lines" do
@@ -150,5 +200,43 @@ module Germinate
         end
       end
     end
+
+    describe "expand_insertions" do
+      before :each do
+        @output   = stub("Output")
+        @hunk     = stub("Hunk")
+      end
+
+      context "called on a hunk" do
+        before :each do
+          @it = TextTransforms.expand_insertions
+        end
+
+        it "should invoke expand_insertions on the hunk" do
+          @hunk.should_receive(:resolve_insertions).and_return(@output)
+          @it.call(@hunk).should == @output
+        end
+      end
+    end
+
+    describe "flatten" do
+      context "given a lumpy hunk" do
+        before :each do
+          @nested_hunk = Hunk.new(["line 3", "line 4"])
+          @lumpy = Hunk.new([
+              "line 1",
+              @nested_hunk,
+              "line 2"
+            ],
+            :comment_prefix => "foo")
+          @output = TextTransforms.flatten_nested.call(@lumpy)
+        end
+        
+        it "should flatten the hunk into a single level" do
+          @output.should == ["line 1", "line 3", "line 4", "line 2"]
+        end
+      end
+
+    end
   end
 end

data/spec/germinate/transform_process_spec.rb

@@ -0,0 +1,50 @@
+require 'stringio'
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. .. lib germinate]))
+
+module Germinate
+  describe TransformProcess do
+    before :each do 
+      @hunk1  = stub("Hunk1").as_null_object
+      @it = TransformProcess.new
+    end
+
+    def output
+      @output.rewind
+      @output.string
+    end
+
+    TRANSFORMS = TextTransforms.singleton_methods
+    TRANSFORMS.each do |transform_name|
+      context "when only #{transform_name} is enabled" do
+        before :each do
+          @hunk          = stub("Hunk").as_null_object
+          @transformed   = stub("Transformed Hunk")
+          @transform     = stub("Transform", :call => @transformed)
+          TextTransforms.stub!(transform_name).and_return(@transform)
+
+          (TRANSFORMS - [transform_name]).each do |disabled_transform|
+            @hunk.stub!("#{disabled_transform}?").and_return(false)
+            TextTransforms.stub!(disabled_transform) do
+              fail "Transform #{disabled_transform} should not be enabled"
+            end
+          end
+          @hunk.stub!("#{transform_name}?").and_return(true)
+        end
+
+        it "should perform transform on input hunks" do
+          @transform.should_receive(:call).with(@hunk).and_return(@transformed)
+          @it.call(@hunk)
+        end
+
+        it "should return the result of the transform" do
+          @it.call(@hunk).should == @transformed
+        end
+
+      end
+    end
+    
+  end
+
+end

data/spec/germinate/variable_spec.rb

@@ -0,0 +1,14 @@
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. .. lib germinate]))
+
+module Germinate
+  describe Variable do
+    before :each do
+      @it = Variable.new("magic_word", "xyzzy", "LINE", "SOURCE_PATH", 123)
+    end
+
+    it "should stringify to its value" do
+      @it.to_s.should == "xyzzy"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: devver-germinate
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Avdi Grimm
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-13 00:00:00 -07:00
+date: 2009-07-21 00:00:00 -07:00
 default_executable: germ
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -103,13 +103,14 @@ files:
 - examples/basic.rb
 - examples/short.rb
 - features/author-formats-article.feature
-- features/author-lists-info.feature
+- features/author-lists-info.pending_feature
 - features/author-publishes-article-source.feature
 - features/author-publishes-article.feature
 - features/author-republishes-article.feature
 - features/author-selects-hunks.feature
+- features/author-sets-variables.feature
 - features/author-updates-article-source.feature
-- features/author-views-stuff.feature
+- features/author-views-stuff.pending_feature
 - features/bin/quoter
 - features/bin/sorter
 - features/example_articles/bracketing.rb
@@ -139,21 +140,27 @@ files:
 - 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/origin.rb
 - lib/germinate/pipeline.rb
-- lib/germinate/process.rb
+- lib/germinate/publisher.rb
 - lib/germinate/reader.rb
 - lib/germinate/selector.rb
 - lib/germinate/shared_style_attributes.rb
+- lib/germinate/shell_process.rb
+- lib/germinate/shell_publisher.rb
+- lib/germinate/simple_publisher.rb
+- lib/germinate/source_file.rb
 - lib/germinate/text_transforms.rb
+- lib/germinate/transform_process.rb
+- lib/germinate/variable.rb
+- sample.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
@@ -163,10 +170,15 @@ files:
 - spec/germinate/librarian_spec.rb
 - spec/germinate/pipeline_spec.rb
 - spec/germinate/process_spec.rb
+- spec/germinate/publisher_spec.rb
 - spec/germinate/reader_spec.rb
 - spec/germinate/selector_spec.rb
+- spec/germinate/shell_publisher_spec.rb
+- spec/germinate/source_file_spec.rb
 - spec/germinate/text_hunk_spec.rb
 - spec/germinate/text_transforms_spec.rb
+- spec/germinate/transform_process_spec.rb
+- spec/germinate/variable_spec.rb
 - spec/germinate_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb

data/lib/germinate/article_formatter.rb

@@ -1,75 +0,0 @@
-require 'ick'
-require 'fattr'
-require File.expand_path("shared_style_attributes", File.dirname(__FILE__))
-
-# A Formatter is responsible for taking content hunks received from an Editor
-# and formatting them for display or publishing.
-class Germinate::ArticleFormatter
-  Ick::Returning.belongs_to self
-  include Germinate::SharedStyleAttributes
-
-  fattr :join_lines             => true
-  fattr :strip_blanks           => true
-  fattr :rstrip_newlines        => true
-  fattr :uncomment              => true
-  fattr :rstrip_lines           => true
-
-  def initialize(output_stream=$stdout)
-    @output_stream  = output_stream
-    @first_output   = true
-  end
-
-  def start!
-  end
-
-  def finish!
-  end
-
-  def format!(hunk)
-    @output_stream.puts unless first_output?
-    hunk.format_with(self)
-    @first_output = false if first_output?
-  end
-
-  def format_text!(hunk, comment_prefix=nil)
-    text_transforms.inject(hunk) do |hunk, transform|
-      transform.call(hunk)
-    end.each do |line|
-      @output_stream.puts(line)
-    end
-  end
-
-  def format_code!(hunk, comment_prefix=nil)
-    code_transforms.inject(hunk) do |hunk, transform|
-      transform.call(hunk)
-    end.each do |line|
-      @output_stream.puts(line)
-    end
-  end
-
-  private
-
-  def first_output?
-    @first_output
-  end
-
-  def text_transforms
-    returning([]) do |transforms|
-      transforms << Germinate::TextTransforms.strip_blanks if strip_blanks?
-      if uncomment?
-        transforms << Germinate::TextTransforms.uncomment(comment_prefix) 
-      end
-      transforms << Germinate::TextTransforms.join_lines if join_lines?
-      transforms << Germinate::TextTransforms.rstrip_lines if rstrip_lines?
-    end
-  end
-
-  def code_transforms
-    returning([]) do |transforms|
-      transforms << Germinate::TextTransforms.strip_blanks if strip_blanks?
-      transforms << Germinate::TextTransforms.rstrip_lines if rstrip_lines?
-      transforms << 
-        Germinate::TextTransforms.bracket
-    end
-  end
-end

data/spec/germinate/article_formatter_spec.rb

@@ -1,153 +0,0 @@
-require 'stringio'
-
-require File.expand_path(
-    File.join(File.dirname(__FILE__), %w[.. .. lib germinate]))
-
-module Germinate
-  describe ArticleFormatter do
-    before :each do 
-      @output = StringIO.new
-      @hunk1  = stub("Hunk1")
-      @hunk2  = stub("Hunk2")
-      @it = ArticleFormatter.new(@output)
-    end
-
-    def output
-      @output.rewind
-      @output.string
-    end
-
-    context "given some hunks to format" do
-      before :each do
-        @hunks = [@hunk1, @hunk2]
-      end
-
-      it "should visit each hunk in turn" do
-        @hunk1.should_receive(:format_with).with(@it).ordered
-        @hunk2.should_receive(:format_with).with(@it).ordered
-        @hunks.each do |hunk|
-          @it.format!(hunk)
-        end
-      end
-    end
-
-    
-    context "given some text lines to format but no comment prefix" do
-      before :each do
-        @it.join_lines = false
-        @it.format_text!(Hunk.new([" # foo", "bar\n\n"]))
-      end
-
-      it "should just normalise newlines" do
-        output.should == " # foo\nbar\n"
-      end
-    end
-
-    context "given some text lines to format and a comment prefix" do
-      before :each do
-        @it.comment_prefix = "# "
-        @it.uncomment      = true
-        @it.join_lines     = false
-        @it.format_text!(Hunk.new(["#  foo", "bar\n\n"]), "# ")
-      end
-
-      it "should erase comments" do
-        output.should == " foo\nbar\n"
-      end
-    end
-
-    context "given leading and trailing blank lines around text" do
-      before :each do
-        @it.format_text!(Hunk.new(["", "foo", " \n "]), "#")
-      end
-
-      it "should erase comments" do
-        output.should == "foo\n"
-      end
-    end
-
-    context "given uncommenting is enabled and a comment prefix is set" do
-      it "should supply the comment prefix to the uncomment transform" do
-        @hunk          = stub("Hunk").as_null_object
-        @hunk.stub!(:strip).and_return(@hunk)
-        @prefix        = "//"
-        @transform     = stub("Transform", :call => @transformed)
-        TextTransforms.stub!(:uncomment).and_return(@transform)
-
-        TextTransforms.should_receive(:uncomment).with(@prefix).
-          and_return(lambda{|h| h})
-
-        @it.comment_prefix = @prefix
-        @it.uncomment      = true
-        @it.format_text!(@hunk)
-      end
-    end
-
-    CODE_TRANSFORMS = %w[rstrip_lines strip_blanks]
-    TEXT_TRANSFORMS  = %w[join_lines strip_blanks uncomment rstrip_lines]
-    TEXT_TRANSFORMS.each do |transform_name|
-      context "when only #{transform_name} is enabled" do
-        before :each do
-          (TEXT_TRANSFORMS - [transform_name]).each do |disabled_transform|
-            @it.send("#{disabled_transform}=", false)
-            TextTransforms.stub!(disabled_transform) do
-              fail "Transform #{disabled_transform} should not be enabled"
-            end
-          end
-          @it.send("#{transform_name}=", true)
-          
-          @transformed   = stub("Transformed Hunk").as_null_object
-          @hunk          = stub("Hunk").as_null_object
-          @hunk.stub!(:strip).and_return(@hunk)
-          @transform     = stub("Transform", :call => @transformed)
-          TextTransforms.stub!(transform_name).and_return(@transform)
-
-        end
-
-        it "should perform transform on text hunks" do
-          @transform.should_receive(:call).with(@hunk)
-          @it.format_text!(@hunk)
-        end
-
-        it "should return the result of the transform" do
-          @it.format_text!(@hunk).should == @transformed
-        end
-
-        unless CODE_TRANSFORMS.include?(transform_name)
-          it "should not perform transform on code hunks" do
-            @transform.should_not_receive(:call).with(@hunk)
-            @it.format_code!(@hunk)
-          end
-        end
-      end
-    end
-
-    context "given some code lines to format" do
-      before :each do
-        @it.format_code!(Hunk.new([" \n ", " # foo", "bar\n\n", ""]))
-      end
-
-      it "should normalise newlines and strip blanks" do
-        output.should == " # foo\nbar\n"
-      end
-    end
-
-    context "given a code hunk with brackets specified" do
-      before :each do
-        @hunk = Hunk.new(["line 1"], 
-          :code_open_bracket => "<<<",
-          :code_close_bracket => ">>>")
-      end
-
-      it "should wrap the code in brackets" do
-        @transform = stub("Bracketer")
-        TextTransforms.should_receive(:bracket).
-          with().and_return(@transform)
-        @transform.should_receive(:call).with(["line 1"]).and_return([])
-        @it.format_code!(@hunk)
-      end
-    end
-
-  end
-
-end