spandex 0.0.5 → 0.0.6

data/lib/spandex/finder.rb

@@ -17,7 +17,9 @@ module Spandex
 
     def get(path)
       path = Page.pathify path
-      load(Page.file_from_path(path, @base_dir), path)
+      paths = Pathname.glob(File.join(@base_dir, "#{path}.*"))
+      file = paths.select{|path| Page.registered?(path)}.first
+      load(file, path)
     end
 
     def get_by_filename(filename)
@@ -34,18 +36,36 @@ module Spandex
       @pages.values
     end
 
-    def all_articles
-      all_pages
-        .select{|page| page.date}
-        .sort {|x, y| y.date <=> x.date }
+    def all_articles(include_drafts = false)
+      find_articles(:include_drafts => include_drafts)
     end
 
-    def find_pages(conditions)
-      find_inside(all_pages, conditions)
+    def find_articles(conditions)
+      #require dates - definition of articles
+      real_conds = {:has_date => true}
+      
+      #by default, don't include drafts
+      real_conds[:draft] = false unless conditions[:include_drafts]
+      real_conds.merge!(conditions.reject{|k| k == :include_drafts})
+
+      #articles should be sorted by date descending
+      find_pages(real_conds).sort {|x, y| y.date <=> x.date }
     end
 
-    def find_articles(conditions)
-      find_inside(all_articles, conditions)
+    def find_pages(conditions)
+      output = all_pages
+      conditions.each do |k, v|
+        next if v.nil?
+        cond = case k
+               when :has_date then lambda {|p| p.date}
+               when :draft then lambda {|p| p.draft? == v}
+               when :tag then lambda {|p| p.tags.include?(v) }
+               when :title then lambda {|p| p.title.match(v)}
+               else lambda{|p| true}
+               end
+        output = output.select(&cond)
+      end
+      output
     end
 
     def tags
@@ -81,20 +101,5 @@ module Spandex
         page
       end
     end
-
-    def find_inside(xs, conditions = {}) 
-      output = xs
-      conditions.each do |k, v|
-        next unless v
-        cond = case k
-               when :tag then lambda {|p| p.tags.include?(v) }
-               when :title then lambda {|p| p.title.match(v)}
-               else lambda{|p| true}
-               end
-        output = output.select(&cond)
-      end
-      output
-    end
-    
   end
 end

data/lib/spandex/page.rb

@@ -1,4 +1,5 @@
 require 'time'
+require 'date'
 require 'pathname'
 require 'tilt'
 require 'atom'
@@ -17,12 +18,6 @@ module Spandex
       Page.new(path, content, pathname.extname, metadata, render_options)
     end
 
-    def self.file_from_path(path, base_path)
-      path = fix_path path
-      paths = Pathname.glob(File.join(base_path, "#{path}.*"))
-      pathname = paths.select{|path| registered?(path)}.first
-    end
-
     def self.path_from_file(pathname, base_path)
       pathname = pathify pathname
       pathify pathname.relative_path_from(pathify(base_path)).sub_ext('')
@@ -33,13 +28,20 @@ module Spandex
       Tilt.registered?(pathname.extname.sub(/^./, ''))
     end
 
+    def metadata(*keys)
+      keys.each do |key|
+        key = key.to_s
+        return @metadata[key] if @metadata.has_key? key
+      end
+      nil
+    end
     
     def title
-      metadata("title") || "(Unknown Title)"
+      metadata(:title) || "(Unknown Title)"
     end
     
     def date
-      @date ||= metadata("date") ? DateTime.parse(metadata("date")) : nil
+      @date ||= metadata(:date) ? DateTime.parse(metadata(:date)) : nil
     end
     
     def body
@@ -47,7 +49,11 @@ module Spandex
     end
     
     def tags
-      @tags ||= metadata("tags", "categories") ? metadata("tags", "categories").split(",").map{|tag| tag.strip} : []
+      @tags ||= metadata(:tags, :categories) ? metadata(:tags, :categories).split(",").map{|tag| tag.strip} : []
+    end
+
+    def draft?
+      metadata(:draft) ? true : false
     end
     
     def to_atom_entry(root)
@@ -74,13 +80,6 @@ module Spandex
       @mtime = Time.now
       @render_options = render_options
     end
-  
-    def metadata(*keys)
-      keys.each do |key|
-        return @metadata[key] if @metadata.has_key? key
-      end
-      nil
-    end
 
     def self.pathify(path_or_string)
       fix_path path_or_string.is_a?(String) ? Pathname.new(path_or_string) : path_or_string

data/lib/spandex/version.rb

@@ -1,3 +1,3 @@
 module Spandex
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/finder_spec.rb

@@ -27,7 +27,16 @@ describe Spandex::Finder do
 
       make_finder.all_pages.map{|p| p.title}.should =~ ["The", "Sounds"]
     end
-  
+
+    it "includes drafts" do
+      create_file("stuff.md", :draft => "true")
+      make_finder.all_pages.size.should == 1
+    end
+
+    it "ignores stray files" do
+      create_file("stuff.md~", :date => "1986/5/25")
+      make_finder.all_articles.should be_empty
+    end
   end
 
   context "when getting all articles" do
@@ -45,6 +54,17 @@ describe Spandex::Finder do
       results[0].date.should == Date.civil(2011, 5, 25)
     end
 
+    it "excludes drafts by default" do
+      create_file("stuff.md", :date => "2011/5/25", :draft => "true")
+      make_finder.all_articles.size.should == 0
+    end
+
+    it "can include drafts" do
+      create_file("stuff.md", :date => "2011/5/25", :draft => "true")
+      create_file("more_stuff.md", :date => "2011/5/25", :draft => "false")
+      make_finder.all_articles(true).size.should == 2
+    end
+
     it "sorts by date descending" do
       create_file("stuff.md", :date => "1986/5/25")
       create_file("more_stuff.md", :date => "1982/5/25") 
@@ -56,13 +76,7 @@ describe Spandex::Finder do
       [Date.civil(2011,5,25), Date.civil(1986,5,25), Date.civil(1982,5,25)].each_with_index do |date, i|
         results[i].date.should == date
       end
-    end
-
-    it "ignores stray files" do
-      create_file("stuff.md~", :date => "1986/5/25")
-      make_finder.all_articles.should be_empty
-    end
-    
+    end    
   end
 
   context "when generating an atom feed" do
@@ -154,16 +168,6 @@ describe Spandex::Finder do
       page.should be_nil
     end
 
-    it "caches individual files" do
-      finder = make_finder
-
-      create_file("stuff.md", :tags => "yeah")
-      finder.get("stuff").tags.should == ["yeah"]
-
-      create_file("stuff.md", :tags => "nah")
-      finder.get("stuff").tags.should == ["yeah"]
-    end
-
     it "doesn't muck up the cache" do
       create_file("stuff.md")
       finder = make_finder
@@ -192,8 +196,6 @@ describe Spandex::Finder do
       finder.get("/stuff")
       finder.all_pages.size.should == 1
     end
-    
-
   end
 
   context "when loading by filename" do
@@ -210,7 +212,7 @@ describe Spandex::Finder do
 
   end
 
-  context "when find pages" do
+  context "when finding pages" do
     it "can find them by tag" do
       create_file("no.md", :tags => "nono")
       create_file("yeah.md", :tags => "yeahyeah")
@@ -224,6 +226,18 @@ describe Spandex::Finder do
     it "can find them by titles" do
       create_file("no.md", :title => "This has the wrong title")
       create_file("yeah.md", :title => "This has the correct title")
+
+      results = make_finder.find_pages :title => "correct"
+      results.size.should == 1
+      results.first.title.should == "This has the correct title"
+    end
+
+    it "can find them by draft status" do
+      create_file "no.md"
+      create_file "yeah.md", :draft => "true"
+      results = make_finder.find_pages :draft => true
+      results.size.should == 1
+      results.first.draft?.should == true
     end
 
     it "can find them by multiple metrics" do
@@ -237,14 +251,28 @@ describe Spandex::Finder do
 
   context "when finding articles" do
     it "only finds articles" do
-      create_file("no.md", :tags => "yeahyeah")
-      create_file("yeah.md", :tags => "yeahyeah", :date => "2011/5/26", :title => "Yeah Yeah Yeah")      
+      create_file "no.md", :tags => "yeahyeah"
+      create_file "yeah.md", :tags => "yeahyeah", :date => "2011/5/26", :title => "Yeah Yeah Yeah"
       
-      results = make_finder.find_articles(:tag => "yeahyeah")
+      results = make_finder.find_articles :tag => "yeahyeah"
       results.size.should == 1
       results.first.title == "Yeah Yeah Yeah"
     end
 
+    it "excludes drafts by default" do
+      create_file "no.md", :tags => "yeahyeah", :date => "2010/5/25", :draft => "true"
+      create_file "yeah.md", :tags => "yeahyeah", :date => "2011/5/26", :title => "Yeah Yeah Yeah"
+      results = make_finder.find_articles :tag => "yeahyeah"
+      results.size.should == 1
+    end
+
+    it "can include drats" do
+      create_file "no.md", :tags => "yeahyeah", :date => "2010/5/25", :draft => "true"
+      create_file "yeah.md", :tags => "yeahyeah", :date => "2011/5/26", :title => "Yeah Yeah Yeah"
+      results = make_finder.find_articles :include_drafts => true, :tag => "yeahyeah"
+      results.size.should == 2
+    end
+
   end
 
   before(:each) do

data/spec/page_spec.rb

@@ -39,6 +39,16 @@ describe Spandex::Page do
       page.tags.should have(2).tags
     end
 
+    it "can be in draft mode" do
+      page = create_page("test.md", :draft => true)
+      page.draft?.should == true
+    end
+
+    it "isn't in draft mode by default" do
+      page = create_page("test.md")
+      page.draft?.should == false
+    end
+
     it "can parse the body" do
       page = create_page("test.md", :content => "But it's not that easy")
       page.body.should == Redcarpet::Markdown.new(Redcarpet::Render::HTML).render("But it's not that easy")
@@ -58,11 +68,21 @@ describe Spandex::Page do
       page.date.should == Date.civil(2011, 5, 25)
     end
 
-    it "can omit the date" do
+    it "can ommit the date" do
       page = create_page("test.md")
       page.date.should be_nil
     end
 
+    it "exposes metadata directly" do
+      page = create_page("test.md", :somethin => "yo")
+      page.metadata("somethin").should == "yo"
+    end
+
+    it "allows you to use symbols in getting metadata" do
+      page = create_page("test.md", :somethin => "yo")
+      page.metadata(:somethin).should == "yo"
+    end
+
     it "produces good atom output" do
       page = create_page("test.md", :title => "hello!", :date => "2011/5/25")
       entry = page.to_atom_entry("http://test.org")

metadata

@@ -1,71 +1,68 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: spandex
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.6
   prerelease: 
-  version: 0.0.5
 platform: ruby
-authors: 
+authors:
 - Isaac Cambron
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-09-30 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-11-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: tilt
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &11869220 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: ratom
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *11869220
+- !ruby/object:Gem::Dependency
+  name: ratom
+  requirement: &11868700 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *11868700
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &11868240 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: redcarpet
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *11868240
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &11867620 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
         version: 2.0.0b5
   type: :development
-  version_requirements: *id004
-description: Spandex manages a store of markup files and their metadata, useful in building blogs or blog engines
-email: 
+  prerelease: false
+  version_requirements: *11867620
+description: Spandex manages a store of markup files and their metadata, useful in
+  building blogs or blog engines
+email:
 - icambron@alum.mit.edu
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - README.md
@@ -81,30 +78,26 @@ files:
 - spec/wrapper_spec.rb
 homepage: https://github.com/icambron/spandex
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A simple content engine
 test_files: []
-