breakdown 0.0.2 → 0.1.0

data/README.md

@@ -18,6 +18,11 @@ Or install it yourself as:
 
 ## Usage
 
+    require 'breakdown'
+    Breakdown::process input_filename, output_dir
+    
+E.g. Breakdown::process _my_huge_markdown_file.md_, _contents_    
+
 Breakdown extends the function of markdown section breaks, providing simple controls for splitting large files.
 
 Any valid markdown horizontal section may be used. The following are all valid breakdown commands:
@@ -51,6 +56,22 @@ Any page section starting with the `:discard` directive will be skipped during t
     This page will created
     *** :discard
     This page will not  
+    
+### Using blocks
+
+Passing a block to the `Breakdown::process` method allows an opportunity to modify the title and text of each
+section prior to writing out to a file.    
+
+    Breakdown::process input_filename, output_dir do |section|
+      section[:title] = section[:title].upcase
+      section[:text] = convert_to_swedish_chef(section[:text])
+      section
+    end
+
+Each `section` is hash containing values for `:title` and `:text` keys. It's important to pass the modified section
+back (as the last statement in the block) so it can be accessed by the rest of the `process` method.
+
+Typical uses for the block method is to add metadata to the head of a section's text, for example when using Breakdown to generate content for *nanoc* or *Jekyll*.
 
 ## Contributing
 

data/lib/breakdown.rb

@@ -53,10 +53,14 @@ module Breakdown
 
           command_match = title.match(/[:](?<command>.[a-z]*)(\s(?<params>.*)|$)/)
           if command_match
-            self.send(command_match[:command], command_match[:params], text, options)
+            section = self.send(command_match[:command], command_match[:params], text, options)
           else
-            write_section(title, text, options)
-          end   
+            section = {:title => title, :text => text}
+          end 
+          
+          section = yield section if block_given?
+          
+          write_section(section, options) unless section.nil?  
         end  
       #rescue  
        f.close # SMELL silent fail
@@ -79,7 +83,8 @@ module Breakdown
       @autonum_sections[title] = @autonum_sections[title] ? @autonum_sections[title] += 1 : 1
     
       title = "#{title}-#{@autonum_sections[title]}"
-      write_section(title, text, options)
+      
+      {:title => title, :text => text}
     end  
     
     def discard(*args)
@@ -89,9 +94,11 @@ module Breakdown
     # Utility methods
     
     def each_section(file)   
-      title = 'index'
+      title = 'index' # Default to 'index' if no title given
       text = ''
 
+      # TODO This could be more efficient by applying regular expressions to the whole file, finding
+      # breakpoints and processing them independently. The naive approach will do for now
       while line = file.gets do
         marker = line.match(/((^([*]{3}\s)|^([*]\s){3})|^([*]{5}\s)|^([-]\s){3}|^([-]{39}))(?<title>.*)/)
 
@@ -104,17 +111,17 @@ module Breakdown
           text += line
         end    
       end
-      yield title, text if !text.empty?   
+      yield title, text if !text.empty? # Process any remaining text as a single section  
     end
     
-    def write_section(title, text, options)
-      output_filename = File.join(options[:output_dir], "/#{title}.#{options[:extension]}")
-      File.open(output_filename, 'w') { |file| file.write text }    
+    def write_section(section, options)
+      output_filename = File.join(options[:output_dir], "/#{section[:title]}.#{options[:extension]}")
+      File.open(output_filename, 'w') { |file| file.write section[:text] }    
     end  
   end
 
-  def self.process(filename, output_dir, options={})  
+  def self.process(filename, output_dir, options={}, &block)  
     processor = Processor.new
-    processor.process(filename, output_dir, options)  
+    processor.process(filename, output_dir, options, &block)  
   end   
 end  

data/lib/breakdown/version.rb

@@ -1,3 +1,3 @@
 module Breakdown
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/tachypomp_spec.rb

@@ -21,6 +21,33 @@ describe Breakdown do
       Breakdown::process './spec/examples/the-tachypomp-and-other-stories.md', @output_dir
       filecount(@output_dir).should equal(9)
     end
+    
+    it "should modify title and text when processed using a block" do
+      
+      filecount(@output_dir).should equal(0)
+      Breakdown::process './spec/examples/the-tachypomp-and-other-stories.md', @output_dir do |section|
+        section[:title] = section[:title] + '-modified'
+        section[:text]= '!!modified!!' + section[:text] 
+        section
+      end 
+       
+      %w(
+        index-modified.md
+        section-1-modified.md
+        section-2-modified.md
+        section-3-modified.md
+        section-4-modified.md
+        section-5-modified.md
+        section-6-modified.md
+        section-7-modified.md
+        table-of-contents-modified.md
+      ).each do |filename|      
+        file_path = File.join @output_dir, filename
+        File.exist?(file_path).should be_true
+        text = File.read(file_path)
+        text.should include('!!modified!!')
+      end  
+    end
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: breakdown
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-06 00:00:00.000000000 Z
+date: 2013-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -130,3 +130,4 @@ test_files:
 - spec/examples/three_stars_and_a_space.md
 - spec/spec_helper.rb
 - spec/tachypomp_spec.rb
+has_rdoc: