markdown_datafier 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc8799940b1cfb8cdb3c5cd3b86b21afe60737c8
-  data.tar.gz: 23a3ec116b0913d432afbb650779f9f3fe539cbe
+  metadata.gz: cde3f4e2699fa8a1e0bb15dd12d6012b1cc83891
+  data.tar.gz: 63a7eadf7972a49192beef734692711b03339081
 SHA512:
-  metadata.gz: e29a6e7391bcd2a5a092e06abbd74bdd9c7ea1fc37603f91d03f351987e18b2288e144a2e4ae30e6d0a3be1300cd743964881b6da3c66966d901b2fa87ac6942
-  data.tar.gz: c6ac3ad38dce7163a6abf2b687c6217fe6d8633f4d835ca9e787869422474c934a7f02998c706bcfd99ae41e0846ecad56839c6e480ede6d0f453d48af61a83b
+  metadata.gz: 686ef848dd143ba3a2311f4c069997164ac9d0dfc87641afdbc192a71cf34039da69d08b81212efb7e03887ec57695c8b8319f8d62ed9a569661a151f2ec7b2b
+  data.tar.gz: 3eafeab8de7ccce91f5de2537c0b1382ca29d6403150f8a961ce155bc43de4698b5b5f8a124c7e90edd696e3feb7f310e27e97fd756c87a1cd8107527fd1f617

data/README.md

@@ -4,7 +4,7 @@ MarkdownDatafier is a ruby gem which reads a structure of Markdown files, parses
 
 MarkdownDatafier was inspired by the NestaCMS framework. But instead of a self-contained CMS, I simply wanted to get data out of a Markdown file structure to be used however I like (direct into Mustache templates via server-side Sinarta or Rails; or via an API endpoint to a javascript framework, iOS/Android app, and so on).
 
-This is currently in an early alpha stage. Though it is likely to remain simple, there will undoubtedly be some feature additions and improvement to things like exception handling. This gem was developed using Ruby 2.0.0p247.
+This gem was developed and tested using Ruby 2.0.0p353.
 
 ## Installation
 
@@ -20,24 +20,32 @@ Or install it yourself as:
 
     $ gem install markdown_datafier
 
-## Usage
+## Setup
 
-Create an object for your server and include MarkdownDatafier:
+Create an object, include MarkdownDatafier and set the absolute path to your Markdown files to the @@content_path global variable:
 
     require 'markdown_datafier'
-    class MyServerObject
+    class MyDatafier
       include MarkdownDatafier
     end
 
-Then create an instance of the server using the full path to your config directory:
+## Usage
 
-    server = MyServerObject.new(config_directory: "/absolute/path/to/config/")
+I've attempting to design this module to be useful in a few different ways, depending on your needs. In each case, you create a server instance targeted at the content directory of your choosing. However, how you design your application to both represent your content in Markdown and what you do with the resulting structured data is up to you. For instance, you can set it up so that each page of a website is represented by the structure of your Markdown files and subdirectories (look in /spec/fixtures/server_content/ for an example of this). Or, you could alternatively use each Markdown file to represent persistence of object data (look in /spec/fixtures/instances/ for an example of this), which could then be used to create objects on another class. 
     
-Inside your configuration directory, configure your config.yml file like so:
+Set up an instance of your server, passing the relative path to your content directory as shown:
 
-    content_directory: '/absolute/path/to/content/directory/'
+    server = MyDatafier.new(content_path: "/path/to/content/directory")
     
-Files are accessed individually by their "shortname" (the file name path inside your content_directory minus the extension, OR the parent directory name)
+If you want an array of hashes representing each Markdown file in the immediate :content_path, do:
+
+    content = server.collect
+    
+If you want an array of hashes representing each Markdown file in a subdirectory of :content_path, do:
+
+    content = server.collect("some_sub_directory")
+    
+Files can also be accessed individually by their "shortname" (the file name path inside your content_directory minus the extension, OR the parent directory name)
 
     content = server.find_by_path(some-existing-file)
 
@@ -51,6 +59,8 @@ Or a splash page like so:
 
     content = server.splash_page
     
+Both the home_page and splash pages work by the naming convention on the root :content_path.
+    
 You can also grab a collection of indexes for the top level sections of your content 
     
     collection = server.indexes_for_sections
@@ -61,6 +71,10 @@ Or specify a sub level (for instance by using the "shortname" of previously retr
 
 Take a look at the file structure in spec/fixtures/content to see how the directory structure and meta data works.
 
+## Recommendation
+
+This will all work just dandy running as it is in ObjectSpace. However, the intention is that you would use Markdown files to manage your content and its structure, and either use Rake to generate actual HTML files or set up some sort of caching system (clearing and rewriting your cache when content is changed). There's no need to be doing all this parsing overhead with each request to your application.
+
 ## Contributing
 
 1. Fork it

data/lib/markdown_datafier.rb

@@ -3,13 +3,28 @@ require "time"
 require "redcarpet"
 
 module MarkdownDatafier
-  attr_accessor :content_directory
   class MetadataParseError < RuntimeError; end
   
+  attr_accessor :content_path
+  
   def self.root
     File.expand_path '../..', __FILE__
   end
   
+  def initialize(attributes)
+    @content_path = attributes[:content_path]
+  end
+  
+  def collect(directory=nil)
+    directory = directory.nil? ? @content_path : "#{@content_path}#{directory}"
+    collection = []
+    Dir.foreach(directory) do |f|
+      next if f == '.' || f == '..' || File.extname(f) != ".mdown"
+      collection << find_by_path(File.basename(f, ".mdown"))
+    end
+    collection
+  end
+  
   def home_page
     find_by_path("index")
   end
@@ -21,10 +36,10 @@ module MarkdownDatafier
   def indexes_for_sections(directory=nil)
     sections = []
     if directory.nil?
-      Dir.chdir(content_directory)
+      Dir.chdir(@content_path)
       currrent_dir_name = ""
     else
-      Dir.chdir(content_directory + directory)
+      Dir.chdir(@content_path + directory)
       currrent_dir_name = File.basename(Dir.pwd)
     end
     sub_directories.each do |section|
@@ -39,7 +54,7 @@ module MarkdownDatafier
   
   def find_by_path(shortname)
     begin
-      path = determine_file_path(content_directory + strip_leading_slashes(shortname))
+      path = determine_file_path(@content_path + strip_leading_slashes(shortname))
       content = "Shortname: #{shortname}\nCreate Datetime: #{File.ctime(path)}\n" + File.open(path).read
       parse_file_content(content)
     rescue

data/lib/markdown_datafier/version.rb

@@ -1,3 +1,3 @@
 module MarkdownDatafier
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/spec/fixtures/instances/bob.mdown

@@ -0,0 +1,12 @@
+Last Name: Bob
+First Name: Franks
+Phone: 555-213-1212
+Favorite Food: Pickles
+Birthdate Date: 23 July 1970
+Summary: Bob is a really good guy who does nice things.
+
+# This guy is great
+
+Americano acerbic turkish so ristretto single origin wings. Kopi-luwak body id coffee sugar saucer café au lait id aroma. Galão, americano sit milk cup extra, arabica crema cup java con panna. Cultivar black redeye to go pumpkin spice so aromatic turkish cultivar fair trade.
+
+Plunger pot, blue mountain ut decaffeinated coffee irish viennese. Black, coffee caffeine cortado froth kopi-luwak, cream iced cup aromatic acerbic. Cup, ristretto, cappuccino seasonal as variety, in chicory a body variety. Black caramelization, galão, viennese grounds sit froth lungo.

data/spec/fixtures/instances/doug.mdown

@@ -0,0 +1,13 @@
+Last Name: Doug
+First Name: Simsom
+Phone: 555-987-4534
+Favorite Food: Pizza
+Birthdate Date: 3 October 1969
+Summary: Doug is kind of invisible. In fact, who is he?
+Nav Name: Invisible Doug
+
+# This guy exists, I think
+
+A, bar americano est, galão sugar sit half and half frappuccino. Saucer, plunger pot, est frappuccino filter chicory robusta cultivar. Pumpkin spice, eu flavour pumpkin spice and café au lait, saucer dark french press filter that chicory. Skinny medium wings, steamed percolator dark cinnamon body half and half.
+
+Dark fair trade siphon bar robusta that blue mountain a carajillo. Wings iced, aged dark est qui froth, skinny id lungo spoon turkish. Cup saucer java cortado frappuccino kopi-luwak aromatic. White, strong doppio, cup carajillo crema redeye seasonal and that.

data/spec/fixtures/instances/instance-sub-dir/article-one.mdown

@@ -0,0 +1,15 @@
+Title Tag: Article One | My Website
+Description: This is a description meta for article one.
+Keywords: rspec, testing, markdown
+Publish Date: 23 July 2010 00:00 EST
+Summary: This is a summary text for article one.
+
+# 10 Amazing Things This Dog Did Which Will Blow Your Heart Valves
+
+Redeye french press carajillo, to go roast caramelization galão whipped in rich acerbic in spoon. Milk froth caramelization carajillo cappuccino redeye cinnamon, brewed breve, viennese, plunger pot spoon, cream, as, caramelization body decaffeinated mug spoon. Siphon redeye plunger pot, half and half acerbic robusta redeye espresso, skinny, dripper single origin foam, cinnamon espresso single origin americano sweet americano carajillo. Americano cream, black carajillo beans viennese aged, et cultivar crema, redeye organic, viennese french press iced, dark, affogato acerbic carajillo cup extra. In sugar dripper, seasonal extra aftertaste rich roast white, decaffeinated white, latte single shot coffee affogato macchiato aroma aromatic skinny coffee ut siphon breve. Siphon, and caramelization whipped aftertaste white sweet mocha, mazagran java breve to go, carajillo breve, macchiato, robusta blue mountain aroma mug arabica irish turkish. Coffee white aroma, grounds decaffeinated mazagran, chicory kopi-luwak acerbic affogato, to go cinnamon trifecta cultivar filter. Organic wings americano eu plunger pot saucer, chicory, roast iced affogato half and half milk whipped affogato half and half extra aftertaste, sit dripper froth siphon cup sugar acerbic. Caffeine, beans steamed caramelization blue mountain arabica, cup, froth blue mountain body, doppio coffee cappuccino turkish to go. Body grounds cappuccino, mazagran robusta, strong black fair trade, frappuccino lungo robusta sugar affogato. Aroma mug redeye spoon, irish cinnamon, caramelization, breve cappuccino crema, ut, dark barista crema robusta body affogato white grinder extraction.
+
+Seasonal white in, caffeine skinny to go, id, eu kopi-luwak pumpkin spice that trifecta pumpkin spice viennese caramelization breve. Aged strong, cream, sweet decaffeinated, barista mocha skinny java white redeye steamed, and breve cortado cup cappuccino lungo caffeine milk strong dark arabica milk. Irish, cinnamon aromatic espresso brewed, crema, acerbic, chicory redeye, aroma affogato crema latte sweet extraction siphon robusta caramelization cappuccino at saucer barista. A frappuccino cup, espresso café au lait blue mountain wings rich iced seasonal plunger pot pumpkin spice whipped affogato, organic filter, qui et iced siphon white. Percolator, arabica whipped ut mocha dripper mocha, white whipped, frappuccino extra seasonal lungo medium saucer in, barista half and half irish as cinnamon doppio barista. White grounds decaffeinated variety extra, decaffeinated french press wings white, plunger pot, iced bar whipped dark, sweet, iced at cortado robust percolator. Viennese single origin cinnamon body, id blue mountain acerbic, at mug bar, chicory java caramelization, cup iced carajillo cinnamon crema. Cup lungo, a froth that to go steamed, viennese, robusta fair trade, milk, caffeine, filter skinny cappuccino irish caramelization extraction brewed flavour espresso. Extraction steamed wings, barista filter acerbic robust shop arabica decaffeinated percolator froth half and half saucer. Seasonal rich carajillo mocha half and half organic affogato saucer seasonal affogato cinnamon saucer skinny foam galão. Decaffeinated as mug, coffee cultivar café au lait turkish rich sugar extraction est saucer sweet galão white filter at aromatic aged eu sit saucer.
+
+Dripper aroma con panna affogato, ristretto, plunger pot aromatic siphon, acerbic, frappuccino est turkish milk crema. To go iced, percolator americano milk acerbic plunger pot, macchiato, frappuccino cinnamon ristretto acerbic viennese coffee cappuccino americano. Espresso redeye, siphon spoon, bar mocha, french press seasonal grinder affogato milk, cup café au lait percolator et instant medium french press. Wings, con panna cortado spoon, robust decaffeinated java coffee, caramelization roast dripper, single shot so qui french press coffee iced viennese sit roast barista. Coffee et in, siphon, cinnamon, breve strong cultivar to go, coffee whipped organic id dark. Ristretto, aged filter rich extraction shop froth sweet french press, aroma cream java barista milk rich crema. Blue mountain qui, as, organic cappuccino rich lungo chicory beans ristretto, blue mountain spoon percolator acerbic froth cream that. Qui fair trade con panna aroma est carajillo con panna cup mug dark grinder aromatic coffee in body et seasonal rich milk crema acerbic half and half single origin carajillo. Percolator, carajillo beans cup, ut flavour irish sweet mocha, body steamed, lungo mazagran sweet cappuccino decaffeinated cup whipped. Sweet pumpkin spice filter bar roast fair trade seasonal french press in decaffeinated medium, java, beans steamed, chicory frappuccino extra roast plunger pot variety blue mountain. Qui id est cinnamon seasonal milk whipped americano, aftertaste, dripper brewed seasonal aromatic, whipped fair trade cream breve iced ristretto white.
+
+Decaffeinated flavour, ut aroma, frappuccino, mazagran pumpkin spice to go acerbic, extraction decaffeinated, carajillo cinnamon americano wings french press at chicory cortado. Mazagran, est cultivar, breve, blue mountain café au lait, cup, latte, blue mountain crema blue mountain and, mocha, cup, variety wings qui et body. Breve id macchiato grounds, variety eu, crema brewed flavour to go robust est cappuccino. Galão, irish decaffeinated, blue mountain seasonal, body fair trade, kopi-luwak percolator mazagran at cinnamon, acerbic saucer coffee as, so frappuccino instant ristretto wings. Turkish macchiato java qui carajillo rich chicory robust java, id redeye foam café au lait froth. Cultivar, est, variety skinny iced white plunger pot, single origin doppio, cup, strong in a crema sugar instant. Coffee ristretto beans con panna cup, coffee strong plunger pot saucer strong ristretto latte at coffee roast. Et cultivar grinder kopi-luwak siphon, id sugar medium shop organic aftertaste half and half caramelization, acerbic filter mocha instant froth shop. Qui cinnamon, cultivar organic flavour, plunger pot milk extraction shop instant half and half, id body, americano caffeine breve cream and mazagran. Spoon wings, carajillo dripper, beans lungo, bar and, so to go aftertaste, medium chicory robusta instant black. Aftertaste iced qui extraction, galão, decaffeinated cultivar, mug, et mazagran americano crema beans crema, single origin robust aromatic medium seasonal.

data/spec/fixtures/instances/instance-sub-dir/article-two.mdown

@@ -0,0 +1,15 @@
+Title Tag: Article Two | My Website
+Description: This is a description meta for article two.
+Keywords: rspec, testing, markdown
+Publish Date: 23 July 2010 00:00 EST
+Summary: This is a summary text for article two.
+
+# You Won't Believe The Touching Things The Woman Did For A Freakin' Bee
+
+Flavour extra espresso plunger pot skinny instant and, pumpkin spice, cream ut cup, ut cultivar single origin siphon variety, medium spoon that roast breve cappuccino. Cinnamon con panna sweet cultivar so, caramelization froth and, aroma extraction half and half shop strong, ut wings a french press beans plunger pot. Aged, that galão as extra dripper plunger pot white as saucer crema qui lungo. A half and half crema, siphon, crema variety that mazagran, to go extraction espresso grinder coffee, acerbic java espresso decaffeinated whipped. Instant, sugar, beans, chicory organic, cortado organic robust, cultivar, brewed trifecta ristretto a et so chicory decaffeinated variety. Whipped dark ristretto seasonal caffeine plunger pot chicory irish coffee single origin and galão that. Froth at robust filter viennese sweet cup ut aged arabica, as est con panna, iced, latte cream aromatic cream aromatic so coffee. Cinnamon, single shot, galão variety, frappuccino so, ristretto wings aftertaste robusta whipped mocha, id aftertaste filter brewed aftertaste. Aromatic organic cream con panna, acerbic, cultivar, and ristretto id acerbic as pumpkin spice americano. French press coffee body ut and, spoon in, as black, crema aroma, saucer extra affogato, french press aromatic variety medium extraction shop a turkish. A robusta affogato instant id, steamed est, percolator foam spoon aftertaste americano spoon macchiato organic.
+
+Grinder aromatic steamed variety and brewed arabica, ut dark in, trifecta, medium viennese beans café au lait variety shop blue mountain spoon. Arabica trifecta, wings, chicory to go decaffeinated as organic pumpkin spice and, kopi-luwak whipped chicory, mocha sugar at lungo aftertaste. Java, lungo filter siphon macchiato dripper, rich as body id aroma, half and half, variety café au lait roast rich instant. Single origin cultivar, grinder arabica, coffee caramelization whipped caramelization variety sweet rich, arabica, cream plunger pot caramelization steamed coffee. As cappuccino qui steamed single origin cappuccino, to go, ut, americano ristretto americano, half and half turkish espresso single origin café au lait, wings, beans robust chicory galão saucer aroma. Aromatic half and half, blue mountain cup, breve dripper single shot id crema americano carajillo, decaffeinated white redeye, black, a, blue mountain dripper ristretto aftertaste black. Extraction caramelization strong, foam, turkish, froth to go redeye, foam cup black breve sweet. Dark medium doppio strong grinder est pumpkin spice, aroma steamed sugar carajillo, eu, sugar caramelization that sugar, blue mountain variety, dripper flavour americano aromatic froth doppio. Sit milk, plunger pot flavour con panna, saucer affogato, foam, brewed half and half mazagran as seasonal single shot arabica, trifecta, french press arabica white mug mazagran variety cortado pumpkin spice. Milk robust and, steamed viennese cup in café au lait flavour iced ut affogato irish mocha chicory rich. Sit, beans pumpkin spice, macchiato grinder cortado viennese roast bar mug americano brewed, rich cup extraction whipped, a, ristretto black, pumpkin spice rich ristretto so sweet.
+
+Siphon flavour crema, foam in strong qui lungo froth that caffeine cultivar affogato lungo percolator arabica. Turkish, spoon decaffeinated, acerbic single origin, cortado qui, coffee, and decaffeinated skinny doppio con panna chicory. Turkish aroma sugar whipped ristretto aroma coffee carajillo, con panna macchiato, ristretto lungo café au lait viennese cup robusta percolator black coffee seasonal siphon. Mazagran roast spoon strong macchiato ut instant milk viennese ut, brewed foam cream instant turkish extra white macchiato foam cinnamon. Aromatic cinnamon id, irish seasonal galão carajillo latte, white foam brewed sweet caramelization. Cup, foam grinder, half and half turkish, eu strong pumpkin spice macchiato sugar froth, and qui trifecta single shot instant wings. Cortado saucer, aromatic sugar, crema viennese plunger pot kopi-luwak, cream black galão skinny id acerbic. Steamed ristretto whipped black, id, grounds organic black java, cultivar arabica coffee brewed decaffeinated single shot. Mazagran extraction crema, cup sit organic, steamed, frappuccino percolator, brewed arabica chicory, to go chicory, bar con panna chicory turkish grounds frappuccino seasonal rich aromatic galão. Roast, java, and con panna cream, galão in caramelization java caramelization cream steamed, robusta macchiato espresso, white shop redeye cortado body. Medium, and wings ut extraction viennese coffee blue mountain at crema acerbic shop affogato instant turkish.
+
+Seasonal to go foam eu so extra doppio milk, decaffeinated grounds breve medium plunger pot white brewed, trifecta bar extra café au lait redeye aftertaste percolator aroma. Filter brewed, robusta froth filter, americano, mocha so acerbic, cream skinny acerbic pumpkin spice trifecta caffeine. Cappuccino mazagran sit turkish barista robust, grinder, est fair trade froth, kopi-luwak pumpkin spice est espresso single origin steamed instant in cream single shot. Carajillo, redeye rich coffee grounds, to go half and half ristretto turkish trifecta, aroma doppio cappuccino turkish, cinnamon cappuccino carajillo coffee irish. Caramelization robusta so flavour spoon, foam, con panna, beans, lungo rich, filter, espresso skinny et single shot mug mocha aged sugar con panna. Trifecta ristretto flavour, irish aromatic aftertaste roast java grounds café au lait brewed latte shop extraction sweet. Con panna bar, robust froth, turkish at flavour single origin filter caramelization lungo fair trade rich blue mountain. Doppio single origin cultivar crema, dripper, aftertaste con panna medium single origin coffee java eu cinnamon rich. Doppio decaffeinated organic sit, viennese et organic, macchiato, dripper roast decaffeinated, single origin ristretto half and half single origin frappuccino. Qui viennese medium, barista americano, steamed french press chicory, a, single origin viennese brewed, at qui cream black mocha sit cream. Barista siphon, dark body, trifecta, cappuccino saucer trifecta arabica organic, white macchiato irish, that aged, aroma ut cinnamon strong java whipped.

data/spec/fixtures/instances/satan.mdown

@@ -0,0 +1,13 @@
+Last Name: Satan
+First Name: Smith
+Phone: 555-666-7732
+Favorite Food: Nutella
+Birthdate Date: 6 December 1966
+Summary: Satan is kind of a manipulative jerk.
+Nav Name: Jerky Satan
+
+# What a jerk
+
+Cinnamon, robust a crema, foam grounds lungo caffeine beans coffee variety saucer. Decaffeinated cortado acerbic, macchiato, turkish that viennese cinnamon aftertaste. Skinny, a sweet strong café au lait turkish froth rich percolator affogato rich.
+
+French press, et, extra and, instant, in extra con panna mazagran siphon. Flavour roast pumpkin spice whipped coffee robusta flavour sugar a cinnamon. Chicory iced, filter, java, skinny cultivar macchiato mocha lungo mocha black cortado.

data/spec/markdown_datafier_spec.rb

@@ -1,251 +1,253 @@
 require_relative 'spec_helper'
 
 describe MarkdownDatafier do
-  
-  let(:server) { TestServer.new }
-  
-  describe "initialization" do
-    
-    before(:each) do
-      server.content_directory = MarkdownDatafier.root + "/spec/fixtures/content/"
-    end
-  
-    it "should set the content_directory" do
-      expect(server.content_directory).to eq MarkdownDatafier.root + "/spec/fixtures/content/"
-    end
-  end
+  context "used as a server" do
+    let(:server) { TestServer.new(content_path: MarkdownDatafier.root + "/spec/fixtures/server_content/") }
 
-  describe "file parsing" do
-    let(:contents) { File.open(server.content_directory + "test-one.mdown").read }
+    describe "when file parsing" do
+      let(:contents) { File.open(MarkdownDatafier.root + "/spec/fixtures/server_content/" + "test-one.mdown").read }
     
-    before(:each) do
-      server.content_directory = MarkdownDatafier.root + "/spec/fixtures/content/"
-    end
-    
-    it "should strip leading slashes from shortname" do
-      shortname = "/test-one"
-      expect(server.strip_leading_slashes(shortname)).to eq "test-one"
-    end
+      it "should strip leading slashes from shortname" do
+        shortname = "/test-one"
+        expect(server.strip_leading_slashes(shortname)).to eq "test-one"
+      end
     
-    it "should change underscores to dashes" do
-      shortname = "test_one_two_three"
-      expect(server.underscores_to_dashes(shortname)).to eq "test-one-two-three"
-    end
+      it "should change underscores to dashes" do
+        shortname = "test_one_two_three"
+        expect(server.underscores_to_dashes(shortname)).to eq "test-one-two-three"
+      end
     
-    it "should check if requested path is a directory" do
-      path = MarkdownDatafier.root + "/spec/fixtures/content/section-two/child-section-one"
-      expect(server.is_directory?(path)).to eq true
-    end
+      it "should check if requested path is a directory" do
+        path = MarkdownDatafier.root + "/spec/fixtures/server_content/section-two/child-section-one"
+        expect(server.is_directory?(path)).to eq true
+      end
     
-    it "should split the meta and body" do
-      expect(server.split_meta_and_body(contents)).to include(:meta, :body)
-    end
+      it "should split the meta and body" do
+        expect(server.split_meta_and_body(contents)).to include(:meta, :body)
+      end
     
-    it "should set publish_datetime when it is provided" do
-      provided_content = {:meta=>
-                        {:create_datetime=>"2013-10-21 23:12:06 -0400",
-                         :publish_datetime=>"23 July 2010 00:00 EST"}}
-      result = server.determine_publish_datetime(provided_content)         
-      expect(result[:meta][:publish_datetime]).to eq "2010-07-23T05:00:00Z"
-    end
+      it "should set publish_datetime when it is provided" do
+        provided_content = {:meta=>
+                          {:create_datetime=>"2013-10-21 23:12:06 -0400",
+                           :publish_datetime=>"23 July 2010 00:00 EST"}}
+        result = server.determine_publish_datetime(provided_content)         
+        expect(result[:meta][:publish_datetime]).to eq "2010-07-23T05:00:00Z"
+      end
     
-    it "should set publish_datetime from provided publish date" do
-      provided_content = {:meta=>
-                        {:create_datetime=>"2013-10-21 23:12:06 -0400",
-                         :publish_date=>"23 July 2010"}}
-      result = server.determine_publish_datetime(provided_content)         
-      expect(result[:meta][:publish_datetime]).to eq "2010-07-23T04:00:00Z"
-    end
+      it "should set publish_datetime from provided publish date" do
+        provided_content = {:meta=>
+                          {:create_datetime=>"2013-10-21 23:12:06 -0400",
+                           :publish_date=>"23 July 2010"}}
+        result = server.determine_publish_datetime(provided_content)         
+        expect(result[:meta][:publish_datetime]).to eq "2010-07-23T04:00:00Z"
+      end
     
-    it "should set publish_datetime from provided date" do
-      provided_content = {:meta=>
-                        {:create_datetime=>"2013-10-21 23:12:06 -0400",
-                         :date=>"23 July 2010 00:00 EST"}}
-      result = server.determine_publish_datetime(provided_content)         
-      expect(result[:meta][:publish_datetime]).to eq "2010-07-23T05:00:00Z"
-    end
+      it "should set publish_datetime from provided date" do
+        provided_content = {:meta=>
+                          {:create_datetime=>"2013-10-21 23:12:06 -0400",
+                           :date=>"23 July 2010 00:00 EST"}}
+        result = server.determine_publish_datetime(provided_content)         
+        expect(result[:meta][:publish_datetime]).to eq "2010-07-23T05:00:00Z"
+      end
     
-    it "should set publish_datetime from create datetime when no date meta is provided" do
-      provided_content = {:meta=>
-                        {:create_datetime=>"2013-10-21 23:12:06 -0400"}}
-      result = server.determine_publish_datetime(provided_content)         
-      expect(result[:meta][:publish_datetime]).to eq "2013-10-22T03:12:06Z"
-    end
+      it "should set publish_datetime from create datetime when no date meta is provided" do
+        provided_content = {:meta=>
+                          {:create_datetime=>"2013-10-21 23:12:06 -0400"}}
+        result = server.determine_publish_datetime(provided_content)         
+        expect(result[:meta][:publish_datetime]).to eq "2013-10-22T03:12:06Z"
+      end
     
-    describe "resolve shortname to absolute path" do
+      describe "resolve shortname to absolute path" do
       
-      it "with leading slash directory index request" do
-        expect(server.find_by_path("/section-two")[:meta][:title_tag]).to eq "Subsection 2 Index | My Website"
-      end
+        it "with leading slash directory index request" do
+          expect(server.find_by_path("/section-two")[:meta][:title_tag]).to eq "Subsection 2 Index | My Website"
+        end
       
-      it "with trailing slash directory index request" do
-        expect(server.find_by_path("section-two/")[:meta][:title_tag]).to eq "Subsection 2 Index | My Website"
-      end
+        it "with trailing slash directory index request" do
+          expect(server.find_by_path("section-two/")[:meta][:title_tag]).to eq "Subsection 2 Index | My Website"
+        end
       
-      it "with leading and trailing slash directory index request" do
-        expect(server.find_by_path("/section-two/")[:meta][:title_tag]).to eq "Subsection 2 Index | My Website"
-      end
+        it "with leading and trailing slash directory index request" do
+          expect(server.find_by_path("/section-two/")[:meta][:title_tag]).to eq "Subsection 2 Index | My Website"
+        end
       
-      it "with middle only slash on a non-index subdirectory file" do
-        expect(server.find_by_path("section-one/sub-one-test-one")[:meta][:title_tag]).to eq "My Subsection 1 Test Page 1 | My Website"
-      end
+        it "with middle only slash on a non-index subdirectory file" do
+          expect(server.find_by_path("section-one/sub-one-test-one")[:meta][:title_tag]).to eq "My Subsection 1 Test Page 1 | My Website"
+        end
       
-      it "with middle only slash on a child subdirectory request" do
-        expect(server.find_by_path("section-two/child-section-one")[:meta][:title_tag]).to eq "Subsection Child 1 Index | My Website"
-      end
+        it "with middle only slash on a child subdirectory request" do
+          expect(server.find_by_path("section-two/child-section-one")[:meta][:title_tag]).to eq "Subsection Child 1 Index | My Website"
+        end
       
-    end
-  end
-  
-  describe "with existing content" do
-
-    before(:each) do
-      server.content_directory = MarkdownDatafier.root + "/spec/fixtures/content/"
-    end
-
-    it "should return the home page content" do
-      expect(server.home_page[:meta][:title_tag]).to eq "My Homepage | My Website"
-    end
-    
-    it "should hide indexes as root directories" do
-      expect(server.home_page[:meta][:title_tag]).to eq "My Homepage | My Website"
+      end
     end
   
-    it "should return the splash page" do
-      expect(server.splash_page[:meta][:title_tag]).to eq "My Home Splash | My Website"
-    end
+    describe "with existing content" do
 
-    it "should return a populated array of indexes for top level sections" do
-      expect(server.indexes_for_sections()).to have(2).items
-    end
-    
-    it "should return a populated array of indexes for the specified section's child directories" do
-      expect(server.indexes_for_sections("/section-two")).to have(1).items
-    end
-    
-    it "should return an empty array for section with no child directories" do
-      expect(server.indexes_for_sections("section-one/")).to be_empty
-    end
-    
-    it "should return the appropriate first index for sections in the array" do
-      expect(server.indexes_for_sections.first[:meta][:title_tag]).to eq "Subsection 1 Index | My Website"
-    end
-    
-    it "should deliver index file for a root directory request" do
-      expect(server.find_by_path("/")[:meta][:shortname]).to eq "/"
-    end
-    
-    it "should return a file from a section directory" do
-      expect(server.find_by_path("section-one/sub-one-test-one")[:meta][:nav_name]).to eq "One Deep"
-    end
-    
-    it "should return a file from a child of section directory" do
-      expect(server.find_by_path("section-two/child-section-one/child-one-test-one")[:meta][:nav_name]).to eq "Two Deep"
-    end
-    
-    describe "should deliver an index file from a subdirectory directory request" do
-      it "with no trailing slash" do
-        expect(server.find_by_path("/section-two")[:meta][:nav_name]).to eq "Subsection 2 Index"
-      end
-      
-      it "with trailing slash" do
-        expect(server.find_by_path("/section-two/")[:meta][:nav_name]).to eq "Subsection 2 Index"
+      it "should return the home page content" do
+        expect(server.home_page[:meta][:title_tag]).to eq "My Homepage | My Website"
       end
-    end
     
-    describe "should deliver an index file from a child directory directory request" do
-      it "with no trailing slash" do
-        expect(server.find_by_path("/section-two/child-section-one")[:meta][:nav_name]).to eq "Subsection Child 1 Index"
-      end
-      
-      it "with trailing slash" do
-        expect(server.find_by_path("/section-two/child-section-one/")[:meta][:nav_name]).to eq "Subsection Child 1 Index"
+      it "should hide indexes as root directories" do
+        expect(server.home_page[:meta][:title_tag]).to eq "My Homepage | My Website"
       end
-    end
   
-    describe "should return the correct" do
-      it "shortname" do
-        expect(server.find_by_path("test-one")[:meta][:shortname]).to eq "test-one"
+      it "should return the splash page" do
+        expect(server.splash_page[:meta][:title_tag]).to eq "My Home Splash | My Website"
       end
-      
-      it "title_tag" do
-        expect(server.find_by_path("test-one")[:meta][:title_tag]).to eq "My Test Page 1 | My Website"
+
+      it "should return a populated array of indexes for top level sections" do
+        expect(server.indexes_for_sections()).to have(2).items
       end
-      
-      it "description" do
-        expect(server.find_by_path("test-one")[:meta][:description]).to eq "This is a description meta for test page 1."
+    
+      it "should return a populated array of indexes for the specified section's child directories" do
+        expect(server.indexes_for_sections("/section-two")).to have(1).items
       end
-      
-      it "keywords" do
-        expect(server.find_by_path("test-one")[:meta][:keywords]).to eq "rspec, testing, markdown"
+    
+      it "should return an empty array for section with no child directories" do
+        expect(server.indexes_for_sections("section-one/")).to be_empty
       end
-      
-      it "publish_date in UTC ISO 8601 format" do
-        expect(server.find_by_path("test-one")[:meta][:publish_datetime]).to eq "2010-07-23T05:00:00Z"
+    
+      it "should return the appropriate first index for sections in the array" do
+        expect(server.indexes_for_sections.first[:meta][:title_tag]).to eq "Subsection 1 Index | My Website"
       end
-      
-      it "nav_name when supplied" do
-        expect(server.find_by_path("/")[:meta][:nav_name]).to eq "Home"
+    
+      it "should deliver index file for a root directory request" do
+        expect(server.find_by_path("/")[:meta][:shortname]).to eq "/"
       end
-      
-      it "nav_name when not supplied" do
-        expect(server.find_by_path("test-one")[:meta][:nav_name]).to eq "Test Page 1"
+    
+      it "should return a file from a section directory" do
+        expect(server.find_by_path("section-one/sub-one-test-one")[:meta][:nav_name]).to eq "One Deep"
       end
-      
-      it "summary" do
-        expect(server.find_by_path("test-one")[:meta][:summary]).to eq "This is a summary text for test page 1."
+    
+      it "should return a file from a child of section directory" do
+        expect(server.find_by_path("section-two/child-section-one/child-one-test-one")[:meta][:nav_name]).to eq "Two Deep"
       end
+    
+      describe "should deliver an index file from a subdirectory directory request" do
+        
+        it "with no trailing slash" do
+          expect(server.find_by_path("/section-two")[:meta][:nav_name]).to eq "Subsection 2 Index"
+        end
       
-      it "large_image" do
-        expect(server.find_by_path("test-one")[:meta][:large_image]).to eq "http://mysite.com/images/test-one-500x500.png"
+        it "with trailing slash" do
+          expect(server.find_by_path("/section-two/")[:meta][:nav_name]).to eq "Subsection 2 Index"
+        end
+        
       end
+    
+      describe "should deliver an index file from a child directory directory request" do
+        
+        it "with no trailing slash" do
+          expect(server.find_by_path("/section-two/child-section-one")[:meta][:nav_name]).to eq "Subsection Child 1 Index"
+        end
       
-      it "medium_image" do
-        expect(server.find_by_path("test-one")[:meta][:medium_image]).to eq "http://mysite.com/images/test-one-200x200.png"
+        it "with trailing slash" do
+          expect(server.find_by_path("/section-two/child-section-one/")[:meta][:nav_name]).to eq "Subsection Child 1 Index"
+        end
+        
       end
-      
-      it "small_image" do
-        expect(server.find_by_path("test-one")[:meta][:small_image]).to eq "http://mysite.com/images/test-one-75x75.png"
+  
+      describe "should return the correct" do
+        
+        it "shortname" do
+          expect(server.find_by_path("test-one")[:meta][:shortname]).to eq "test-one"
+        end
+      
+        it "title_tag" do
+          expect(server.find_by_path("test-one")[:meta][:title_tag]).to eq "My Test Page 1 | My Website"
+        end
+      
+        it "description" do
+          expect(server.find_by_path("test-one")[:meta][:description]).to eq "This is a description meta for test page 1."
+        end
+      
+        it "keywords" do
+          expect(server.find_by_path("test-one")[:meta][:keywords]).to eq "rspec, testing, markdown"
+        end
+      
+        it "publish_date in UTC ISO 8601 format" do
+          expect(server.find_by_path("test-one")[:meta][:publish_datetime]).to eq "2010-07-23T05:00:00Z"
+        end
+      
+        it "nav_name when supplied" do
+          expect(server.find_by_path("/")[:meta][:nav_name]).to eq "Home"
+        end
+      
+        it "nav_name when not supplied" do
+          expect(server.find_by_path("test-one")[:meta][:nav_name]).to eq "Test Page 1"
+        end
+      
+        it "summary" do
+          expect(server.find_by_path("test-one")[:meta][:summary]).to eq "This is a summary text for test page 1."
+        end
+      
+        it "large_image" do
+          expect(server.find_by_path("test-one")[:meta][:large_image]).to eq "http://mysite.com/images/test-one-500x500.png"
+        end
+      
+        it "medium_image" do
+          expect(server.find_by_path("test-one")[:meta][:medium_image]).to eq "http://mysite.com/images/test-one-200x200.png"
+        end
+      
+        it "small_image" do
+          expect(server.find_by_path("test-one")[:meta][:small_image]).to eq "http://mysite.com/images/test-one-75x75.png"
+        end
+      
+        it "position of nil" do
+          expect(server.find_by_path("test-one")[:meta][:position]).to be_nil
+        end
+      
+        it "position of 2" do
+          expect(server.find_by_path("test-two")[:meta][:position]).to eq "2"
+        end
+      
+        it "body in html format" do
+          expect(server.find_by_path("test-one")[:body]).to include("<h1>Test Page 1</h1>")
+        end
+
       end
-      
-      it "position of nil" do
-        expect(server.find_by_path("test-one")[:meta][:position]).to be_nil
+    end
+    
+    describe "with no matching content" do
+      let(:empty_server) { TestEmptyServer.new(content_path: MarkdownDatafier.root + "/spec/fixtures/empty/") }
+    
+      it "should return nil for find_by_path" do
+        expect(empty_server.find_by_path("ragamuffin")).to be_nil
       end
-      
-      it "position of 2" do
-        expect(server.find_by_path("test-two")[:meta][:position]).to eq "2"
+    
+      it "should return nil for home page" do
+        expect(empty_server.home_page).to be_nil
       end
-      
-      it "body in html format" do
-        expect(server.find_by_path("test-one")[:body]).to include("<h1>Test Page 1</h1>")
+    
+      it "should return nil for splash page" do
+        expect(empty_server.splash_page).to be_nil
       end
-
-    end
-  end
-  describe "with no matching content" do
     
-    before(:each) do
-      server.content_directory = MarkdownDatafier.root + "/spec/fixtures/empty/"
     end
+  
+  end
+  
+  describe "when collecting content instances for the default content path" do
     
-    it "should return nil for find_by_path" do
-      expect(server.find_by_path("ragamuffin")).to be_nil
-    end
+    let(:instance_server) { TestInstanceServer.new(content_path: MarkdownDatafier.root + "/spec/fixtures/instances/") }
     
-    it "should return nil for home page" do
-      expect(server.home_page).to be_nil
+    it "should collect 3 instances of people" do
+      expect(instance_server.collect).to have(3).items
     end
     
-    it "should return nil for splash page" do
-      expect(server.splash_page).to be_nil
+    it "should collect 2 instances of articles when supplied a sub directory path under the :content_path" do
+      expect(instance_server.collect("instance-sub-dir")).to have(2).items
     end
     
   end
-
   
   describe ".root" do
+    
     it "should return the gem's root directory" do
       expect(File.basename(MarkdownDatafier.root)).to eq "markdown_datafier"
     end
+    
   end
+  
 end

data/spec/spec_helper.rb

@@ -4,6 +4,14 @@ class TestServer
   include MarkdownDatafier
 end
 
+class TestEmptyServer
+  include MarkdownDatafier
+end
+
+class TestInstanceServer
+  include MarkdownDatafier
+end
+
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_datafier
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - J. Ryan Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-29 00:00:00.000000000 Z
+date: 2014-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -82,16 +82,21 @@ files:
 - lib/markdown_datafier.rb
 - lib/markdown_datafier/version.rb
 - markdown_datafier.gemspec
-- spec/fixtures/content/index.mdown
-- spec/fixtures/content/section-one/index.mdown
-- spec/fixtures/content/section-one/sub-one-test-one.mdown
-- spec/fixtures/content/section-two/child-section-one/child-one-test-one.mdown
-- spec/fixtures/content/section-two/child-section-one/index.mdown
-- spec/fixtures/content/section-two/index.mdown
-- spec/fixtures/content/section-two/sub-two-test-one.mdown
-- spec/fixtures/content/splash.mdown
-- spec/fixtures/content/test-one.mdown
-- spec/fixtures/content/test-two.mdown
+- spec/fixtures/instances/bob.mdown
+- spec/fixtures/instances/doug.mdown
+- spec/fixtures/instances/instance-sub-dir/article-one.mdown
+- spec/fixtures/instances/instance-sub-dir/article-two.mdown
+- spec/fixtures/instances/satan.mdown
+- spec/fixtures/server_content/index.mdown
+- spec/fixtures/server_content/section-one/index.mdown
+- spec/fixtures/server_content/section-one/sub-one-test-one.mdown
+- spec/fixtures/server_content/section-two/child-section-one/child-one-test-one.mdown
+- spec/fixtures/server_content/section-two/child-section-one/index.mdown
+- spec/fixtures/server_content/section-two/index.mdown
+- spec/fixtures/server_content/section-two/sub-two-test-one.mdown
+- spec/fixtures/server_content/splash.mdown
+- spec/fixtures/server_content/test-one.mdown
+- spec/fixtures/server_content/test-two.mdown
 - spec/markdown_datafier_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/etherdev/markdown_datafier
@@ -120,15 +125,20 @@ specification_version: 4
 summary: Reads a structure of Markdown files parses their metadata and outputs to
   a ruby hash or array of hashes. Easy to plug into your own API endpoints.
 test_files:
-- spec/fixtures/content/index.mdown
-- spec/fixtures/content/section-one/index.mdown
-- spec/fixtures/content/section-one/sub-one-test-one.mdown
-- spec/fixtures/content/section-two/child-section-one/child-one-test-one.mdown
-- spec/fixtures/content/section-two/child-section-one/index.mdown
-- spec/fixtures/content/section-two/index.mdown
-- spec/fixtures/content/section-two/sub-two-test-one.mdown
-- spec/fixtures/content/splash.mdown
-- spec/fixtures/content/test-one.mdown
-- spec/fixtures/content/test-two.mdown
+- spec/fixtures/instances/bob.mdown
+- spec/fixtures/instances/doug.mdown
+- spec/fixtures/instances/instance-sub-dir/article-one.mdown
+- spec/fixtures/instances/instance-sub-dir/article-two.mdown
+- spec/fixtures/instances/satan.mdown
+- spec/fixtures/server_content/index.mdown
+- spec/fixtures/server_content/section-one/index.mdown
+- spec/fixtures/server_content/section-one/sub-one-test-one.mdown
+- spec/fixtures/server_content/section-two/child-section-one/child-one-test-one.mdown
+- spec/fixtures/server_content/section-two/child-section-one/index.mdown
+- spec/fixtures/server_content/section-two/index.mdown
+- spec/fixtures/server_content/section-two/sub-two-test-one.mdown
+- spec/fixtures/server_content/splash.mdown
+- spec/fixtures/server_content/test-one.mdown
+- spec/fixtures/server_content/test-two.mdown
 - spec/markdown_datafier_spec.rb
 - spec/spec_helper.rb