breakdown 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,6 @@
 # Breakdown
 
-TODO: Write a gem description
+Breaks large markdown text files into many smaller ones, based on markdown compatible markup commands.
 
 ## Installation
 
@@ -18,7 +18,39 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+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:
+
+    * * * home
+    *** page-1 
+    ***** page-2
+    - - - about
+    --------------------------------------- my_very_long_page_name
+
+Breakdown will create a new markdown file for each valid horizontal rule it finds. The new file will contain all the text between the horizontal rule and the next rule it finds (or the end of the file). Each file is named using the supplied title, with .md appended to the title. A page called 'home' will be created as 'home.md'.
+
+Any text at the start of a file that doesn't have a named section will be placed in a file 'index.md'.
+
+### Page numbering 
+   
+Pages in a sequence can be automatically numbered using the `:autonum` directive, e.g.
+
+    *** :autonum section
+    My first section
+    *** :autonum section
+    My second section
+  
+A markdown file like this will be broken into two smaller files, one called section-1.md and the other section-2.md
+
+### Discarding pages
+
+Any page section starting with the `:discard` directive will be skipped during the breakdown process, e.g.
+
+    *** first_page   
+    This page will created
+    *** :discard
+    This page will not  
 
 ## Contributing
 

data/lib/breakdown.rb

@@ -11,33 +11,90 @@ module Breakdown
   # ***** section :count # There will be a number of 'section' pages, with an id of 'section-1', 'section-2', etc
   # - - - # All horizontal rules can be used, per http://daringfireball.net/projects/markdown/syntax#hr 
   # --------------------------------------- # And '#' '//' comments are comments
+
+  # NOTE One idea would be to 'preprocess' the file using grep, e.g.
+  # Kernal::system %{grep -n '^(^\* \* \*|\*\*\*)' filename} do |ok, res|
+  #   if ! ok
+  #     puts "pattern not found (status = #{res.exitstatus})"
+  #   else
+  #     # Do some preprocessing here... split, build up strategy, etc
+  #   end
+  # end
+
+  # NOTE Naive first cut
+
+  # Valid markers:
+  #  * * *
+  #  ***  
+  #  *****
+  #  - - -
+  #  ---------------------------------------
   
-  def self.process(filename, output_dir, options={})  
-  
-    # NOTE One idea would be to 'preprocess' the file using grep, e.g.
-    # Kernal::system %{grep -n '^(^\* \* \*|\*\*\*)' filename} do |ok, res|
-    #   if ! ok
-    #     puts "pattern not found (status = #{res.exitstatus})"
-    #   else
-    #     # Do some preprocessing here... split, build up strategy, etc
-    #   end
-    # end
-     
-    # NOTE Naive first cut
+  class Processor
+    
+    def initialize
+      @autonum_count = {}  
+    end
+    
+    def process(filename, output_dir, options={})  
+
+      # Preconditions
+      raise "No such file: #{filename}" unless File.exist?(filename)     
+      raise "Can't read file: #{filename}" unless File.readable?(filename)
+
+      # SMELL output_dir is used in two different variables
+      options = {:extension => 'md', :output_dir => output_dir}.merge(options)
+
+      FileUtils.mkdir_p output_dir # Ensure we have somewhere to put our files
+
+      f = File.open(filename)
+      begin
+        each_section(f) do |title, text|
+
+          command_match = title.match(/[:](?<command>.[a-z]*)(\s(?<params>.*)|$)/)
+          if command_match
+            self.send(command_match[:command], command_match[:params], text, options)
+          else
+            write_section(title, text, options)
+          end   
+        end  
+      #rescue  
+       f.close # SMELL silent fail
+      end 
+    end
+       
+    private
+    
+    # DSL methods
+    
+    def autonum(*args)
+      title = args[0]
+      text = args[1]
+      
+      options = args[2]
+      
+      output_dir = options[:output_dir]
+      
+      @autonum_sections = @autonum_sections || {}
+      @autonum_sections[title] = @autonum_sections[title] ? @autonum_sections[title] += 1 : 1
+    
+      title = "#{title}-#{@autonum_sections[title]}"
+      write_section(title, text, options)
+    end  
     
-    # Valid markers:
-    #  * * *
-    #  ***  
-    #  *****
-    #  - - -
-    #  ---------------------------------------
-    def self.each_section(file)   
+    def discard(*args)
+      # Do nothing
+    end  
+      
+    # Utility methods
+    
+    def each_section(file)   
       title = 'index'
       text = ''
-      
+
       while line = file.gets do
         marker = line.match(/((^([*]{3}\s)|^([*]\s){3})|^([*]{5}\s)|^([-]\s){3}|^([-]{39}))(?<title>.*)/)
-        #marker = line.match(/^\*\*\* (?<title>.*)/)
+
         if marker
           yield title, text if !text.empty? 
           # start next section
@@ -48,28 +105,16 @@ module Breakdown
         end    
       end
       yield title, text if !text.empty?   
-      
-    end  
-     
-    raise "No such file: #{filename}" unless File.exist?(filename)     
-    raise "Can't read file: #{filename}" unless File.readable?(filename)
-    
-    options = {:extension => 'md'}.merge(options)
-    
-    FileUtils.mkdir_p output_dir # Ensure we have somewhere to put our files
-    
-    f = File.open(filename)
-    begin
-      
-      each_section(f) do |title, text|
-        
-      output_filename = File.join(output_dir, "/#{title}.#{options[:extension]}")
-      File.open(output_filename, 'w') { |file| file.write text }
-      end   
-        
- #   rescue  
-      f.close # SMELL silent fail
     end
     
-  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 }    
+    end  
+  end
+
+  def self.process(filename, output_dir, options={})  
+    processor = Processor.new
+    processor.process(filename, output_dir, options)  
+  end   
 end  

data/lib/breakdown/version.rb

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

data/spec/autonum_spec.rb

@@ -0,0 +1,12 @@
+require './spec/spec_helper'
+require './lib/breakdown'
+
+describe Breakdown do
+  
+  it "should create numbered sections" do
+    filecount(@output_dir).should eq(0)
+    Breakdown::process './spec/examples/auto_section.md', @output_dir
+    filecount(@output_dir).should eq(3)  
+  end    
+  
+end  

data/spec/breakdown_spec.rb

@@ -2,20 +2,9 @@ require './spec/spec_helper'
 require './lib/breakdown'
 
 describe Breakdown do
+  
   describe "should break down text file" do
     
-    def filecount(dir)
-      Dir[File.join(dir, '/**/*')].count { |file| File.file?(file) }  
-    end
-    
-    before(:all) do
-      @output_dir = "./spec/tmp/output/."   
-    end  
-      
-    before(:each) do
-       FileUtils.rm_rf(@output_dir, secure: true) # Clean out the output dir
-     end
-     
     it "on any ***" do
       filecount(@output_dir).should equal(0)
       Breakdown::process './spec/examples/star_star_star.md', @output_dir
@@ -46,4 +35,10 @@ describe Breakdown do
       filecount(@output_dir).should equal(2)
     end
   end
+  
+  it "should not break on *** and a space" do
+    filecount(@output_dir).should equal(0)
+    Breakdown::process './spec/examples/three_stars_and_a_space.md', @output_dir
+    filecount(@output_dir).should equal(1)
+  end
 end

data/spec/discard_spec.rb

@@ -0,0 +1,12 @@
+require './spec/spec_helper'
+require './lib/breakdown'
+
+describe Breakdown do
+  
+  it "should not create discarded sections" do
+    filecount(@output_dir).should eq(0)
+    Breakdown::process './spec/examples/discard_section.md', @output_dir
+    filecount(@output_dir).should eq(2)  
+  end    
+  
+end

data/spec/examples/auto_section.md

@@ -0,0 +1,6 @@
+*** :autonum section
+Foo
+*** :autonum section
+Bar
+*** :autonum section
+Bah

data/spec/examples/discard_section.md

@@ -0,0 +1,6 @@
+*** :autonum section
+Foo
+*** :discard
+Bar
+*** :autonum section
+Bah

data/spec/examples/three_stars_and_a_space.md

@@ -0,0 +1,3 @@
+Foo
+*** 
+Bar

data/spec/spec_helper.rb

@@ -7,4 +7,12 @@ RSpec.configure do |config|
 
   # Use the specified formatter
   config.formatter = :documentation # :progress, :html, :textmate
+  
+  # Global before each/all blocks
+  config.before(:all) { @output_dir = "./spec/tmp/output/." }
+  config.before(:each) { FileUtils.rm_rf(@output_dir, secure: true) } # Clean out the output dir 
+end
+
+def filecount(dir)
+  Dir[File.join(dir, '/**/*')].count { |file| File.file?(file) }  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: breakdown
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-22 00:00:00.000000000 Z
+date: 2013-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,7 +74,11 @@ files:
 - breakdown.gemspec
 - lib/breakdown.rb
 - lib/breakdown/version.rb
+- spec/autonum_spec.rb
 - spec/breakdown_spec.rb
+- spec/discard_spec.rb
+- spec/examples/auto_section.md
+- spec/examples/discard_section.md
 - spec/examples/example.md
 - spec/examples/five_stars.md
 - spec/examples/star_space_star_space_star_space.md
@@ -82,6 +86,7 @@ files:
 - spec/examples/the-tachypomp-and-other-stories.md
 - spec/examples/thirty_nine_dashes.md
 - spec/examples/three_dashes.md
+- spec/examples/three_stars_and_a_space.md
 - spec/spec_helper.rb
 - spec/tachypomp_spec.rb
 homepage: ''
@@ -110,7 +115,11 @@ signing_key:
 specification_version: 3
 summary: Preprocessor for large text files
 test_files:
+- spec/autonum_spec.rb
 - spec/breakdown_spec.rb
+- spec/discard_spec.rb
+- spec/examples/auto_section.md
+- spec/examples/discard_section.md
 - spec/examples/example.md
 - spec/examples/five_stars.md
 - spec/examples/star_space_star_space_star_space.md
@@ -118,5 +127,6 @@ test_files:
 - spec/examples/the-tachypomp-and-other-stories.md
 - spec/examples/thirty_nine_dashes.md
 - spec/examples/three_dashes.md
+- spec/examples/three_stars_and_a_space.md
 - spec/spec_helper.rb
 - spec/tachypomp_spec.rb