md_splitter 0.0.7 → 0.0.8

data/.gitignore

@@ -2,4 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
-samples/*
+fixtures/**/*

data/bin/md_splitter

@@ -34,7 +34,7 @@ command :split do |c|
 			:dry_run     => options.dry_run.nil? ? false : true, 
 			:output_path => options.output_path,
 			:split_on    => options.split_on,
-			:manifest    => options.manifest.nil? ? false : true
+			:manifest    => options.manifest.nil? ? false : make_manifest_builder
 		}  
 		
 		puts opts
@@ -52,4 +52,8 @@ command :split do |c|
   end
 end
 
-default_command :split
+default_command :split 
+
+def make_manifest_builder
+	MdSplitter::ElfManifestBuilder.new	
+end

data/lib/md_splitter/elf_manifest_builder.rb

@@ -14,10 +14,22 @@ module MdSplitter
     # * *Raises* :
     #   - ++ ->
     #
-    def initialize items
-      @items = build_manifest_object items
-      
-    end
+    def initialize
+      @raw_object = {}    
+    end  
+    
+    #
+    #
+    # * *Args*    :
+    #   - ++ ->
+    # * *Returns* :
+    #   -
+    # * *Raises* :
+    #   - ++ ->
+    #
+    def build raw_obj, requested_id
+      @raw_object = build_manifest_object raw_obj, requested_id
+    end     
     
     # Accepts an ennumerable object and returns a json manifest
     #
@@ -29,23 +41,25 @@ module MdSplitter
     #   - ++ ->
     #
     def raw 
-      @items
+      @raw_object
     end 
     
-    def json
-      JSON.pretty_generate raw
+    def json 
+      puts "Generating json string from #{@raw_object}"
+      JSON.pretty_generate @raw_object
     end
        
     
     private
     
-    def build_manifest_object items
+    def build_manifest_object items, id = nil
       pages = Array.new
+      id ||= UUIDTools::UUID.random_create.to_s 
       items.each do |item|
         pages << get_page_object(item)
       end             
-      {
-        :id => UUIDTools::UUID.random_create.to_s,
+      obj = {
+        :id => id,
         :pages => pages
       }      
     end                                         

data/lib/md_splitter/splitter.rb

@@ -82,8 +82,11 @@ module MdSplitter
     private 
     
     def save_manifest pages, directory
-      say "Writing manifest"
-      manifest = MdSplitter::ElfManifestBuilder.new pages
+      say "Writing manifest"     
+      # build the manifest id from the source file's path
+      manifest_id = "#{directory}_pages"
+      manifest = @options[:manifest]
+      manifest.build(pages,manifest_id)
       save_file File.join(directory, "manifest.json"), manifest.json      
     end  
     

data/lib/md_splitter/version.rb

@@ -1,3 +1,3 @@
 module MdSplitter
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/spec/fixtures/sample/manifest.json

@@ -0,0 +1,25 @@
+{
+  "id": "spec/fixtures/sample_pages",
+  "pages": [
+    {
+      "id": "sample_1",
+      "title": "Sample 1",
+      "url": "sample_1.html"
+    },
+    {
+      "id": "sample_2",
+      "title": "Sample 2",
+      "url": "sample_2.html"
+    },
+    {
+      "id": "sample_3",
+      "title": "Sample 3",
+      "url": "sample_3.html"
+    },
+    {
+      "id": "sample_4",
+      "title": "Sample 4",
+      "url": "sample_4.html"
+    }
+  ]
+}

data/spec/fixtures/sample/sample_1.html

@@ -0,0 +1,3 @@
+<h1 id="header-1">Header 1</h1>
+
+<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>

data/spec/fixtures/sample/sample_2.html

@@ -0,0 +1,5 @@
+<ul>
+  <li>Hello</li>
+  <li>this</li>
+  <li>is</li>
+</ul>

data/spec/fixtures/sample/sample_3.html

@@ -0,0 +1,4 @@
+<ul>
+  <li>a</li>
+  <li>list</li>
+</ul>

data/spec/fixtures/sample/sample_4.html

@@ -0,0 +1,3 @@
+<h2 id="header-2">Header 2</h2>
+
+<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p>

data/spec/fixtures/split_me.md

@@ -0,0 +1,19 @@
+# Header 1 #
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+    
+---
+
+*	Hello
+*	this
+*	is
+*	a
+*	list
+
+***
+
+## Header 2 ##
+
+---
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

data/spec/ilb/md_splitter/manifest_builder_spec.rb

@@ -1,16 +1,23 @@
 require 'md_splitter/elf_manifest_builder'
 
-describe "Build an ELF manifest." do    
-	before(:each) do
-	  @subject = MdSplitter::ElfManifestBuilder.new get_test_object
-	end                                                    
+describe "ELF manifest builder." do    
+	before(:each) do                                        
+		@manifest_id = 'this/is/a/path'
+		@page_list = get_test_page_list
+	  @subject = MdSplitter::ElfManifestBuilder.new # @page_list, @manifest_id
+	end                                                                             
+	
+	it "should respond to a build method" do
+		@subject.should respond_to(:build).with(2).arguments # args are manifest object and id	  
+	end
 	
 	it "should respond to a raw method" do
 	  @subject.should respond_to(:raw)
 	end 
 	
 	describe "Return manifest object." do 
-		before(:each) do
+		before(:each) do 
+			@subject.build @page_list, @manifest_id
 		  @result = @subject.raw
 		end               
 		
@@ -18,8 +25,8 @@ describe "Build an ELF manifest." do
 			@result.should be_a(Hash)
 		end 
 		
-		it "should have an id property" do
-		  @result[:id].should be_a String
+		it "should return the id property provided at creation" do
+		  @result[:id].should eq @manifest_id
 		end                              
 		
 		it "should have a pages array" do
@@ -51,8 +58,8 @@ describe "Build an ELF manifest." do
 				end 
 				
 				it "ids should match source item ids" do
-					get_test_object.each_index do |i|
-						@result[:pages][i][:id].should eq get_test_object_titles[i]
+					get_test_page_list.each_index do |i|
+						@result[:pages][i][:id].should eq get_test_page_list_titles[i]
 					end
 				end	
 				
@@ -63,8 +70,8 @@ describe "Build an ELF manifest." do
 				end			
 				
 				it "url should match the source item" do
-					get_test_object.each_index do |i|
-						@result[:pages][i][:url].should eq get_test_object[i]
+					get_test_page_list.each_index do |i|
+						@result[:pages][i][:url].should eq get_test_page_list[i]
 					end
 				end                                    
 			end
@@ -89,15 +96,15 @@ private
 
 
 # Builds test object from which to test manifest
-def get_test_object                               
+def get_test_page_list                               
 	test_obj = ["page_number_1.html", "page_number_2.html", "page_number_3.html"]
 end       
 
-def get_test_object_titles
+def get_test_page_list_titles
 	return ['page_number_1', 'page_number_2', 'page_number_3']
 end     
 
-def get_test_object_ids
+def get_test_page_list_ids
 	return ['page_number_1', 'page_number_2', 'page_number_3']
 end
 

data/spec/ilb/md_splitter/splitter_spec.rb

@@ -1,5 +1,4 @@
 require 'md_splitter/splitter' 
-require 'md_splitter/elf_manifest_builder'
 require 'fileutils'	 
 
 describe "Splitter" do
@@ -28,11 +27,11 @@ describe "Splitter" do
 			end 
 	
 			it "should deal with folder hierarchies" do
-				mock_input_file_read "spec/fake/path/sample.md"							
+				mock_input_file_read test_input_path							
 				# expect call to Kramdown
 				mock_kramdown(sample_markdown.strip).should_receive(:to_html).and_return(simple_html)
 				mock_output_file_write "spec/fake/path/sample.html"
-				@subject.split "spec/fake/path/sample.md"
+				@subject.split test_input_path
 			end
 		end		
 		                
@@ -43,35 +42,35 @@ describe "Splitter" do
 			end 
 			it "should use the split_on option to split the src into multiple files" do
 				mock_doc_split
-				@subject.split "spec/fake/path/sample.md", :split_on => "---\n"								
+				@subject.split test_input_path, :split_on => "---\n"								
 			end
 			
 			it "should create the folder structure when necessary" do		
 				mock_doc_split
 				# when splitting a file, should create the target path if necessary
 				FileUtils.should_receive(:mkpath).with('spec/fake/path/sample')
-				@subject.split "spec/fake/path/sample.md", :split_on => "---\n" 
+				@subject.split test_input_path, :split_on => "---\n" 
 			end
 			
 			# it "should 'say' what we're doing" do
 			# 	mock_doc_split 
 			# 	STDOUT.should_receive(:puts).with(/Splitting sample.md/).once
-			# 	@subject.split "spec/fake/path/sample.md", :split_on => "---\n"
+			# 	@subject.split test_input_path, :split_on => "---\n"
 			# end  
 		end
 		
 		describe "support a custom output path" do 
 			it "for single files" do
-				mock_input_file_read "spec/fake/path/sample.md"                    
+				mock_input_file_read test_input_path                    
 				mock_output_file_write "spec/fake/path/exports/sample.html"
-				@subject.split "spec/fake/path/sample.md", :output_path => "exports"			  
+				@subject.split test_input_path, :output_path => "exports"			  
 			end   
 			
 			it "should use the custom path for split files" do
-			  mock_input_file_read "spec/fake/path/sample.md"
+			  mock_input_file_read test_input_path
 				mock_output_file_write "spec/fake/path/exports/sample.html", 3
 				FileUtils.should_receive(:mkpath).with('spec/fake/path/exports')
-				@subject.split "spec/fake/path/sample.md", :output_path => "exports", :split_on => "---"
+				@subject.split test_input_path, :output_path => "exports", :split_on => "---"
 			end
 		end
 		
@@ -82,45 +81,45 @@ describe "Splitter" do
 			it "should not perform any file actions" do 
 				make_safe_file_stubs 
 				File.should_not_receive(:open)
-				@subject.split	"spec/fake/path/sample.md", :split_on => "---\n", :dry_run => true
+				@subject.split	test_input_path, :split_on => "---\n", :dry_run => true
 			end 
 			it "should say when we're in dry_run mode" do
 				make_safe_file_stubs																												 
 				STDOUT.should_receive(:puts).with(/^Dry Run/i).at_least(:once)
-				@subject.split	"spec/fake/path/sample.md", :split_on => "---\n", :dry_run => true				
+				@subject.split	test_input_path, :split_on => "---\n", :dry_run => true				
 			end
 		end
 		
 		describe "create a manifest if requested" do
 			before(:each) do 
-				mock_input_file_read "spec/fake/path/sample.md"
+				mock_input_file_read test_input_path
 				mock_output_file_write "spec/fake/path/sample/sample.html", 3 
 				mock_output_file_write "spec/fake/path/sample/manifest.json" 
 				@duff_builder = double()
 				@duff_builder.stub(:json) 												
+				@duff_builder.stub(:build) 												
 				@subject = MdSplitter::Splitter.new				
 			end
 			
-		  it "should create a manifest builder" do
-				MdSplitter::ElfManifestBuilder.should_receive(:new).and_return(@duff_builder)
-				@subject.split	"spec/fake/path/sample.md", :split_on => "---", :manifest => true
+		  it "should accept a manifest builder as a parameter" do
+				# MdSplitter::ElfManifestBuilder.should_receive(:new).and_return(@duff_builder)
+				@duff_builder.should_receive(:json).and_return(target_elf_manifest)
+				@subject.split	test_input_path, :split_on => "---", :manifest => @duff_builder
 		  end 
 		                                                      
-			it "should pass a list of pages to the manifest builder" do
-			  MdSplitter::ElfManifestBuilder.should_receive(:new).with(["sample_1.html", "sample_2.html", "sample_3.html"]).and_return(@duff_builder)
-				@subject.split	"spec/fake/path/sample.md", :split_on => "---", :manifest => true
+			it "should pass a list of pages and an id to the :build command" do
+			  # MdSplitter::ElfManifestBuilder.should_receive(:new).with(["sample_1.html", "sample_2.html", "sample_3.html"], "spec/fake/path/sample").and_return(@duff_builder)
+				@duff_builder.should_receive(:build).with(expected_split_pages, "spec/fake/path/sample_pages")
+				@subject.split	test_input_path, :split_on => "---", :manifest => @duff_builder
 			end
 			
 			describe "saving the manifest" do
-				before(:each) do
-				  MdSplitter::ElfManifestBuilder.should_receive(:new).and_return(@duff_builder)
-				end
 				it "should request the json manifest and save it to the target directory" do                                       
-					@duff_builder.should_receive(:json).and_return(sample_elf_manifest)	
+					@duff_builder.should_receive(:json).and_return(target_elf_manifest)	
 					STDOUT.should_receive(:puts).with(/Splitting/i).at_least(:once)				
 					STDOUT.should_receive(:puts).with(/Writing spec\/fake\/path/i).at_least(:once)				
 					STDOUT.should_receive(:puts).with(/Writing manifest/i).at_least(:once)				
-					@subject.split	"spec/fake/path/sample.md", :split_on => "---", :manifest => true
+					@subject.split	test_input_path, :split_on => "---", :manifest => @duff_builder
 				end
 			end
 		 
@@ -136,7 +135,7 @@ def make_safe_file_stubs
 end
 
 def mock_doc_split
-	mock_input_file_read "spec/fake/path/sample.md"
+	mock_input_file_read test_input_path
 	FileUtils.stub(:mkpath)
 	mock_output_file_write "spec/fake/path/sample/sample.html", 3									
 	# mock_output_file_write "spec/fake/path/sample/sample_2.html"									
@@ -188,28 +187,36 @@ def sample_markdown
 	---
 	### Heading 3
 	eos
-end         
+end  
+
+def test_input_path
+	"spec/fake/path/sample.md"
+end   
+
+def expected_split_pages
+	["sample_1.html", "sample_2.html", "sample_3.html"]
+end
 
-def sample_elf_manifest
+def target_elf_manifest
 	<<-eos
 	{   
-		"id":"859d7b55-61fa-42fd-8b34-ae0f9c664bd71",
+		"id":"spec/fake/path/sample_pages",
 		"pages": 
 	    [
 	        {
-				"id":"page1",
-				"title":"Page 1",
-				"url":"page1.html"
+				"id":"sample_1",
+				"title":"Sample 1",
+				"url":"sample_1.html"
 	        },
 			{
-				"id":"page2",
-				"title":"Page 2",
-				"url":"page2.html"
+				"id":"sample_2",
+				"title":"Sample 2",
+				"url":"sample_2.html"
 	        },
 			{
-				"id":"page3",
-				"title":"Page 3",
-				"url":"page3.html"
+				"id":"sample_3",
+				"title":"Sample 3",
+				"url":"sample_3.html"
 	        }
 	    ]
 	}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: md_splitter
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-02 00:00:00.000000000Z
+date: 2011-11-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70125038532020 !ruby/object:Gem::Requirement
+  requirement: &70254001603000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70125038532020
+  version_requirements: *70254001603000
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70125038530500 !ruby/object:Gem::Requirement
+  requirement: &70254001600840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.21
   type: :development
   prerelease: false
-  version_requirements: *70125038530500
+  version_requirements: *70254001600840
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70125038529220 !ruby/object:Gem::Requirement
+  requirement: &70254001600100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *70125038529220
+  version_requirements: *70254001600100
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70125038528100 !ruby/object:Gem::Requirement
+  requirement: &70254001599380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70125038528100
+  version_requirements: *70254001599380
 - !ruby/object:Gem::Dependency
   name: growl
-  requirement: &70125038526420 !ruby/object:Gem::Requirement
+  requirement: &70254001598720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70125038526420
+  version_requirements: *70254001598720
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70125038523000 !ruby/object:Gem::Requirement
+  requirement: &70254001598080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70125038523000
+  version_requirements: *70254001598080
 - !ruby/object:Gem::Dependency
   name: kramdown
-  requirement: &70125038521720 !ruby/object:Gem::Requirement
+  requirement: &70254001596980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 0.13.3
   type: :runtime
   prerelease: false
-  version_requirements: *70125038521720
+  version_requirements: *70254001596980
 - !ruby/object:Gem::Dependency
   name: commander
-  requirement: &70125038519700 !ruby/object:Gem::Requirement
+  requirement: &70254001595760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 4.0.6
   type: :runtime
   prerelease: false
-  version_requirements: *70125038519700
+  version_requirements: *70254001595760
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70125038517480 !ruby/object:Gem::Requirement
+  requirement: &70254001595000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *70125038517480
+  version_requirements: *70254001595000
 - !ruby/object:Gem::Dependency
   name: uuidtools
-  requirement: &70125038514480 !ruby/object:Gem::Requirement
+  requirement: &70254001593980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,10 @@ dependencies:
         version: 2.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *70125038514480
+  version_requirements: *70254001593980
 - !ruby/object:Gem::Dependency
   name: active_support
-  requirement: &70125038513180 !ruby/object:Gem::Requirement
+  requirement: &70254001592300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,7 +131,7 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70125038513180
+  version_requirements: *70254001592300
 description: Parses md docs for split markers and produces multiple html files and
   a json manifest
 email:
@@ -141,6 +141,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- .DS_Store
 - .gitignore
 - .rvmrc
 - Gemfile
@@ -155,8 +156,15 @@ files:
 - lib/md_splitter/splitter.rb
 - lib/md_splitter/version.rb
 - md_splitter.gemspec
-- samples/sample.md
 - spec/bin/md_splitter_spec.rb
+- spec/fixtures/.DS_Store
+- spec/fixtures/sample.md
+- spec/fixtures/sample/manifest.json
+- spec/fixtures/sample/sample_1.html
+- spec/fixtures/sample/sample_2.html
+- spec/fixtures/sample/sample_3.html
+- spec/fixtures/sample/sample_4.html
+- spec/fixtures/split_me.md
 - spec/ilb/md_splitter/manifest_builder_spec.rb
 - spec/ilb/md_splitter/splitter_spec.rb
 homepage: ''
@@ -173,7 +181,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 864076252232225175
+      hash: -314162196657490798
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -182,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 864076252232225175
+      hash: -314162196657490798
 requirements: []
 rubyforge_project: md_splitter
 rubygems_version: 1.8.10
@@ -191,5 +199,13 @@ specification_version: 3
 summary: Prepares Markdown docs for web delivery
 test_files:
 - spec/bin/md_splitter_spec.rb
+- spec/fixtures/.DS_Store
+- spec/fixtures/sample.md
+- spec/fixtures/sample/manifest.json
+- spec/fixtures/sample/sample_1.html
+- spec/fixtures/sample/sample_2.html
+- spec/fixtures/sample/sample_3.html
+- spec/fixtures/sample/sample_4.html
+- spec/fixtures/split_me.md
 - spec/ilb/md_splitter/manifest_builder_spec.rb
 - spec/ilb/md_splitter/splitter_spec.rb