devver-germinate 1.0.0 → 1.0.1

data/features/author-formats-article.feature

@@ -105,4 +105,5 @@ Feature: author formats article
     | regexen.rb        | regexen.txt        |
     | pipelines.txt     | pipelines.out      |
     | escaping.txt      | escaping.out       |
+    | bracketing.rb     | bracketing.out     |
 

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_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/germinate.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{germinate}
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Avdi Grimm"]
@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   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/code_samples.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/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", "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.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.0'
+  VERSION = '1.0.1'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:

data/lib/germinate/hunk.rb

@@ -11,13 +11,7 @@ class Germinate::Hunk < ::Array
 
   def initialize(contents=[], template = {})
     super(contents)
-    if Germinate::SharedStyleAttributes === template
-      copy_shared_style_attrubutes_from(template)
-    else
-      template.each_pair do |key, value|
-        send(key, value)
-      end
-    end
+    copy_shared_style_attrubutes_from(template)
   end
 
   # return a copy with leading and trailing whitespace lines removed

data/lib/germinate/insertion.rb

@@ -1,15 +1,21 @@
 require 'fattr'
+require File.expand_path("shared_style_attributes", File.dirname(__FILE__))
 
 class Germinate::Insertion
+  include Germinate::SharedStyleAttributes
+
   attr_reader :library
   attr_reader :selector
 
-  def initialize(selector, library)
+  def initialize(selector, library, template={})
+    copy_shared_style_attrubutes_from(template)
     @selector = selector
     @library  = library
   end
 
   def resolve
-    library[selector]
+    returning(library[selector]) do |hunk|
+      hunk.copy_shared_style_attrubutes_from(self, false)
+    end
   end
 end

data/lib/germinate/librarian.rb

@@ -50,8 +50,8 @@ class Germinate::Librarian
     @samples[sample] << line
   end
 
-  def add_insertion!(section, selector)
-    insertion = Germinate::Insertion.new(selector, self)
+  def add_insertion!(section, selector, attributes)
+    insertion = Germinate::Insertion.new(selector, self, attributes)
     @sections[section] << insertion
   end
 

data/lib/germinate/reader.rb

@@ -153,8 +153,7 @@ class Germinate::Reader
     self.sample_name = sample_name || automatic_section_name
     librarian.set_code_attributes!(
       sample_name,
-      :code_open_bracket  => options.fetch("brackets", []).first,
-      :code_close_bracket => options.fetch("brackets", []).last)
+      options_to_style_attributes(options))
     code!
   end
 
@@ -163,10 +162,11 @@ class Germinate::Reader
     librarian.code_close_bracket = close_bracket
   end
 
-  def insert_control_line!(selector=nil)
+  def insert_control_line!(selector=nil, options={})
     librarian.add_insertion!(
       current_section, 
-      Germinate::Selector.new(selector, current_section))
+      Germinate::Selector.new(selector, current_section),
+      options_to_style_attributes(options))
   end
 
   def process_control_line!(process_name, command)
@@ -209,4 +209,13 @@ class Germinate::Reader
   def unescape(line)
     line.sub(/\\(:[A-Z0-9_]+:)/, '\1') 
   end
+
+  def options_to_style_attributes(options)
+    returning({}) do |attributes|
+      if options.key?("brackets")
+        attributes[:code_open_bracket] = options.fetch("brackets").first
+        attributes[:code_close_bracket] = options.fetch("brackets").last
+      end
+    end
+  end
 end

data/lib/germinate/shared_style_attributes.rb

@@ -15,9 +15,22 @@ module Germinate::SharedStyleAttributes
     }
   end
 
-  def copy_shared_style_attrubutes_from(other)
-    other.shared_style_attributes.each_pair do |key, value|
-      self.send(key, value) unless other.send(key).nil?
+  def copy_shared_style_attrubutes_from(other, override=true)
+    case other
+    when Germinate::SharedStyleAttributes
+      copy_attributes!(other.shared_style_attributes)
+    when Hash
+      copy_attributes!(other, override)
+    else
+      raise "Don't know how to copy attributes from #{other.inspect}"
+    end
+  end
+
+  def copy_attributes!(attributes, override=true)
+    attributes.each_pair do |key, value|
+      if !value.nil? && (override || !send(key))
+        self.send(key, value)
+      end
     end
   end
 end

data/spec/germinate/implicit_insertion_spec.rb

@@ -4,7 +4,7 @@ require File.expand_path(
 module Germinate
   describe ImplicitInsertion do
     before :each do
-      @hunk     = stub("Hunk")
+      @hunk     = stub("Hunk").as_null_object
       @library  = stub("Library")
       @selector = stub("Selector")
       @it = Germinate::ImplicitInsertion.new(@selector, @library)

data/spec/germinate/insertion_spec.rb

@@ -4,10 +4,10 @@ require File.expand_path(
 module Germinate
   describe Insertion, "given a library and a selector" do
     before :each do
-      @hunk     = stub("Hunk")
+      @hunk     = stub("Hunk").as_null_object
       @library  = stub("Library", :[] => @hunk)
       @selector = stub("Selector")
-      @it = Germinate::Insertion.new(@selector, @library)
+      @it = Germinate::Insertion.new(@selector, @library, {})
     end
 
     it "should use the library to resolve itself" do

data/spec/germinate/librarian_spec.rb

@@ -83,7 +83,7 @@ module Germinate
 
     context "given an insertion in my_section with selector @my_selector" do
       before :each do
-        @it.add_insertion!("my_section", "@my_selector")
+        @it.add_insertion!("my_section", "@my_selector", { :comment_prefix => "@" })
       end
 
       it "should add an Insertion to the named section" do
@@ -97,6 +97,10 @@ module Germinate
       it "should give the insertion a reference to the library" do
         @it.section("my_section").last.library.should == @it
       end
+
+      it "should apply any passed attributes to the insertion" do
+        @it.section("my_section").last.comment_prefix.should == "@"
+      end
     end
 
     context "given a process to file" do 

data/spec/germinate/reader_spec.rb

@@ -277,12 +277,13 @@ module Germinate
       end
       
       it "should add an insertion to the current section" do
-        @librarian.should_receive(:add_insertion!).with("mysection", anything)
+        @librarian.should_receive(:add_insertion!).
+          with("mysection", anything, anything)
         @it << @line
       end
 
       it "should pass a selector object to the librarian" do
-        @librarian.should_receive(:add_insertion!) do |section, selector|
+        @librarian.should_receive(:add_insertion!) do |section, selector, options|
           selector.should be_a_kind_of(Selector)
           selector.string.should == "foo"
           selector.default_key.should == "mysection"
@@ -291,6 +292,23 @@ module Germinate
       end
     end
 
+    context "given an insertion with custom attributes" do
+      before :each do
+        @it << ":TEXT: mysection"
+        @line = ":INSERT: foo, { brackets: ['<<', '>>'] } "
+      end
+      
+      it "should pass the attributes on to the library" do
+        @librarian.should_receive(:add_insertion!).
+          with(anything, anything, {
+            :code_open_bracket => "<<", 
+            :code_close_bracket => ">>" 
+          })
+        @it << @line
+      end
+
+    end
+
     context "given a process directive" do
       before :each do
         @line = ' # :PROCESS: sortail, "sort | tail"'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: devver-germinate
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Avdi Grimm
@@ -111,7 +111,7 @@ files:
 - features/author-views-stuff.feature
 - features/bin/quoter
 - features/bin/sorter
-- features/example_articles/code_samples.rb
+- features/example_articles/bracketing.rb
 - features/example_articles/escaping.txt
 - features/example_articles/hello.rb
 - features/example_articles/pipelines.txt
@@ -119,6 +119,7 @@ files:
 - 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

data/features/example_articles/code_samples.rb

@@ -1,89 +0,0 @@
-# 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 the 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/