gidget 0.2.1 → 0.3.0

data/README.rdoc

@@ -7,29 +7,17 @@ Gidget is a minimalist blog engine designed to run on Heroku with a Git-based wo
 == Basic Structure
 
 * Sinatra based server
-* A singleton array containing post information (the body of a post is lazily-loaded)
+* A File Mapper to help map requests to pages, posts, and tags
+* A class to handle page information
 * A class to handle post information
 
-== Routing
+== Templates
 
-* / - an index template with access to the full array of posts
-* /2010/11/19 - an archive template with access to all posts from the specified year/month/day as well as what year, month, and day it is for (month and day are optional)
-* /2010/11/19/first-post - a post template with access to the full array of posts and the current post index
-* /page/1 - a paging template with access to posts for the specified day as well as the current page number and total number of pages
-* /some-special-page - a custom template with access to the full array of posts
+<This section is being rewritten>
 
-== Post Creation
+== Page/Post Creation
 
-Posts are simply .txt files located under a folder named posts located off the root of the web app.  Text files contain two sections of data.  The first is metadata including at least a title and date as such:
-
-  title: My great post title
-  date: 2010-11-19
-  
-  _Hello World!_  This is my first blog post!
-
-The second section is the body of the post and uses markdown as it's markup language.  The two sections should be separated by an empty line.
-
-File name and structure (other than the .txt extension) don't matter.  Gidget will determine request paths based on the date and title metadata and sort them accordingly.
+<This section is being rewritten>
 
 == Settings
 
@@ -38,7 +26,6 @@ Gidget uses Sinatra's built-in setting support.  Settings can be set in your con
   gidget = Gidget::Server.new do
     set :title, "My Awesome Blog"
     set :author, "Your Name Goes Here"
-    set :summary_size, 100
     set :page_size, 10
   end
 
@@ -79,10 +66,11 @@ In order to deploy an app to Heroku you must have an account with them.  Once yo
   git push heroku master
   heroku open
 
-Congrats!  You now have your own blog running on the internets!
+Congrats!  You now have your own blog running on the world wide web!
 
 == TO BE DONE
 
+* Cleanup stub contents
 * Come up with a decent base theme
 
 == Contributing to gidget

data/_stub_/pages/about.txt

@@ -0,0 +1,3 @@
+title: About
+
+This is an about page with whatever information you want to be here.

data/_stub_/views/index.haml

@@ -7,4 +7,5 @@
       %h1 My Blog
     %article
       %h1= posts[0].title
-      = posts[0].body
+      = posts[0].body
+      = DateTime.now.to_s

data/_stub_/views/page.haml

@@ -6,4 +6,5 @@
     %header
       %h1 My Blog
     %article
-      %h1= "I found #{posts.size} posts!"
+      %h1= page.title
+      = page.body

data/_stub_/views/post_paging.haml

@@ -0,0 +1,9 @@
+!!! 5
+%html
+  %head
+    %title= settings.title
+  %body
+    %header
+      %h1 My Blog
+    %article
+      %h1= "I found #{posts.size} posts!"

data/bin/gidget

@@ -24,6 +24,7 @@ class App
 
     print  "  Copying stub ... "
     FileUtils.cp_r(source + "/.", destination)
+    FileUtils.remove_file(File.join(destination, "config.dev.ru"))
     puts "done."
     
     puts "Done."

data/lib/gidget/ext.rb

@@ -4,11 +4,6 @@ class String
   end
 
 
-  def humanize
-    self.capitalize.gsub(/[-_]+/, ' ')
-  end
-
-
   def starts_with?(prefix)
     prefix = prefix.to_s
     self[0, prefix.length] == prefix

data/lib/gidget/file_mapper.rb

@@ -0,0 +1,68 @@
+require 'singleton'
+require 'gidget/page'
+require 'gidget/post'
+
+
+module Gidget
+  class FileMapper
+    include Singleton
+    
+    attr_reader :pages
+    attr_reader :posts
+    attr_reader :tags
+  
+  
+    def initialize
+      @pages = Hash.new
+      @posts = Array.new
+      @tags = Hash.new
+    end
+    
+    
+    def load
+      page_paths = Dir.glob("pages/**/*.txt")
+
+      # load the page index
+      page_paths.each { |file_path|
+        page = Page.new(file_path)
+        @pages[page.request_path] = page
+      }
+      
+      puts "Page Index created, size = " + @pages.keys.size.to_s
+      
+      
+      post_paths = Dir.glob("posts/**/*.txt")
+
+      # load the post index
+      post_paths.each { |file_path|
+        post = Post.new(file_path)
+        @posts << post
+      }
+      
+      # sort the post index by date descending (newest will be first)
+      @posts.replace @posts.sort_by { |p| Time.parse(p.date.to_s).to_i }.reverse!
+      
+      puts "Post Index created, size = " + @posts.size.to_s
+      
+      
+      # load the tag index
+      @posts.each { |post|
+        if (post.meta_data.has_key? :tags)
+          tags = post.meta_data[:tags].split(',')
+          
+          tags.each { |tag|
+            tag.strip!
+            
+            if (!@tags.has_key? tag)
+              @tags[tag] = []
+            end
+            
+            @tags[tag] << post
+          }
+        end
+      }
+      
+      puts "Tag Index created, size = " + @tags.keys.size.to_s
+    end
+  end
+end

data/lib/gidget/page.rb

@@ -0,0 +1,55 @@
+require 'rdiscount'
+require 'yaml'
+require 'gidget/ext'
+
+
+module Gidget
+  class Page
+    attr_reader :file_path
+    attr_reader :meta_data
+    
+    
+    def initialize(file_path)
+      @file_path = file_path
+      
+      begin
+        file = File.open(@file_path, "r")
+
+        # read the first paragraph and load it into a Hash with symbols as keys
+        @meta_data = YAML.load(file.gets("")).inject({}) { |h, (k,v)| h.merge(k.to_sym => v) }
+      ensure
+        file.close()
+      end
+    end
+
+
+    def request_path
+      @meta_data[:permalink] || "/" + self.title.slugize
+    end
+
+
+    def title
+      @meta_data[:title]
+    end
+
+
+    def body
+      begin
+        file = File.open(@file_path, "r")
+
+        # ignore the first paragraph
+        file.gets("")
+
+        # read the rest of the file and process it's markdown
+        RDiscount.new(file.gets(nil)).to_html
+      ensure
+        file.close()
+      end
+    end
+
+
+    def method_missing(m, *args, &block)
+      @meta_data[m] || super
+    end
+  end
+end

data/lib/gidget/post.rb

@@ -1,52 +1,20 @@
-require 'yaml'
-require 'rdiscount'
-require 'gidget/ext'
+require 'gidget/page'
 
 
 module Gidget
-  class Post
-    attr_reader :file_path
-    attr_reader :request_path
-    attr_reader :meta_data
-    
-    
-    def initialize(file_path)
-      @file_path = file_path
-      
-      begin 
-        file = File.open(@file_path, "r")
-    
-        # read the first paragraph and load it into a Hash with symbols as keys
-        @meta_data = YAML.load(file.gets("")).inject({}) { |h, (k,v)| h.merge(k.to_sym => v) }
-      ensure
-        file.close()
-      end
-      
-      @request_path = @meta_data[:date].strftime("/%Y/%m/%d/") + @meta_data[:title].slugize
+  class Post < Page
+    def request_path
+      @meta_data[:permalink] || self.date.strftime("/%Y/%m/") + self.title.slugize
     end
     
     
-    def body
-      begin
-        file = File.open(@file_path, "r")
-    
-        # ignore the first paragraph
-        file.gets("")
-    
-        # read the rest of the file and process it's markdown
-        RDiscount.new(file.gets(nil)).to_html
-      ensure
-        file.close()
-      end
+    def date
+      @meta_data[:date]
     end
     
     
-    def method_missing(m, *args, &block)  
-      if (@meta_data.has_key?(m))
-        return @meta_data[m]
-      else
-        super
-      end
+    def tags
+      @meta_data[:tags] || ""
     end
   end
 end

data/lib/gidget/server.rb

@@ -1,6 +1,7 @@
 require 'sinatra/base'
+require 'benchmark'
 require 'haml'
-require 'gidget/post_index'
+require 'gidget/file_mapper'
 
 
 module Gidget
@@ -14,82 +15,97 @@ module Gidget
       super(app, &b=nil)
       Server.class_exec(&block) if block_given?
       
-      PostIndex.instance.load
+      # load the file mapper
+      puts Benchmark.measure { FileMapper.instance.load }
     end
 
 
+    # route for root
     get '/' do
-      render_view(:index, { :posts => PostIndex.instance })
+      haml :index, :locals => { :posts => FileMapper.instance.posts }
     end
 
 
-    get %r{^\/\d{4}\/\d{2}\/\d{2}\/[\w,-]+$} do
+    # route for a specific page
+    get %r{^\/[\w,\-,\/]+$} do
+      page = FileMapper.instance.pages[request.path]
+
+      if (page != nil)
+        haml :page, :locals => { :page => page }
+      else
+        pass
+      end
+    end
+
+
+    # route for a specific post
+    get %r{^\/[\w,\-,\/]+$} do
       index = nil
-  
-      PostIndex.instance.each_with_index { |p, i|
+
+      FileMapper.instance.posts.each_with_index { |p, i|
         if (p.request_path == request.path)
           index = i
           break
         end
       }
-  
+
       if (index != nil)
-        render_view(:post, { :posts => PostIndex.instance, :index => index })
+        haml :post, :locals => { :posts => FileMapper.instance.posts, :index => index }
+      else
+        pass
       end
     end
-
-
-    get %r{^\/(\d{4})(\/(\d{2})(\/(\d{2}))?)?$} do
-      year = params[:captures][0]
-      month = params[:captures][2]
-      day = params[:captures][4]
-      
-      posts = PostIndex.instance.select { |p|
-        p.request_path.starts_with? request.path
-      }
-  
-      render_view(:archive, { :posts => posts, :year => year, :month => month, :day => day })
-    end
     
     
-    get %r{^\/page\/(\d+$)} do
+    # route for an archive listing in the format /archive/yyyy/mm (year and month are optional)
+    get %r{^\/archive(\/(\d{4})(\/(\d{2}))?)?$} do
+      if (params[:captures] == nil)
+        posts = FileMapper.instance.posts
+      else
+        year = params[:captures][1]
+        month = params[:captures][3]
+        
+        prefix = "#{year}#{month}"
+        
+        posts = FileMapper.instance.posts.select { |p|
+          p.date.strftime("%Y%m").starts_with? prefix
+        }
+      end
+  
+      haml :archive, :locals => { :posts => posts, :year => year, :month => month }
+    end
+
+
+    # route for post paging
+    get %r{^\/page\/(\d+)$} do
       current_page = params[:captures][0].to_i
-      total_pages = (PostIndex.instance.size + settings.page_size - 1) / settings.page_size
-      
+      total_pages = (FileMapper.instance.posts.size + settings.page_size - 1) / settings.page_size
+
       if (current_page <= total_pages)
-        posts = PostIndex.instance[(current_page - 1) * settings.page_size, settings.page_size]
-      
-        render_view(:page, { :posts => posts, :current_page => current_page, :total_pages => total_pages })
+        posts = FileMapper.instance.posts[(current_page - 1) * settings.page_size, settings.page_size]
+
+        haml :post_paging, :locals => { :posts => posts, :current_page => current_page, :total_pages => total_pages }
       else
         pass
       end
     end
-    
-    
-    get %r{^\/tag\/([\w,-]+$)} do
-      posts = TagIndex.instance[params[:captures][0]]
-      
+
+
+    # route for list of posts tagged with a particular tag
+    get %r{^\/tag\/([\w,\-]+)$} do
+      posts = FileMapper.instance.tags[params[:captures][0]]
+
       if (posts != nil)
-        render_view(:tag, { :posts => posts })
+        haml :tag, :locals => { :posts => posts }
       else
         pass
       end
     end
     
     
-    get %r{^\/[\w,-]+$} do
-      begin
-        render_view(request.path.to_sym, { :posts => PostIndex.instance })
-      rescue 
-        pass
-      end
-    end
-    
-    
-    def render_view(view, locals)
+    # make all requests cached for a day
+    after do
       expires(86400, :public)
-      
-      haml view, :locals => locals
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gidget
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Forrest Robertson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-09 00:00:00 -07:00
+date: 2011-02-08 00:00:00 -07:00
 default_executable: gidget
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -139,19 +139,21 @@ files:
 - _stub_/Gemfile
 - _stub_/config.dev.ru
 - _stub_/config.ru
+- _stub_/pages/about.txt
 - _stub_/posts/first-post.txt
 - _stub_/views/about.haml
 - _stub_/views/archive.haml
 - _stub_/views/index.haml
 - _stub_/views/page.haml
 - _stub_/views/post.haml
+- _stub_/views/post_paging.haml
 - _stub_/views/tag.haml
 - lib/gidget.rb
 - lib/gidget/ext.rb
+- lib/gidget/file_mapper.rb
+- lib/gidget/page.rb
 - lib/gidget/post.rb
-- lib/gidget/post_index.rb
 - lib/gidget/server.rb
-- lib/gidget/tag_index.rb
 - LICENSE.txt
 - README.rdoc
 - bin/gidget

data/lib/gidget/post_index.rb

@@ -1,28 +0,0 @@
-require 'singleton'
-require 'gidget/post'
-require 'gidget/tag_index'
-
-
-module Gidget
-  class PostIndex < Array
-    include Singleton
-
-
-    def load
-      paths = Dir.glob("posts/**/*.txt")
-
-      # add all the posts to the array
-      paths.each { |file_path|
-        self << Post.new(file_path)
-      }
-    
-      # sort the array by the request path, descending (newest by date will be first)
-      self.replace self.sort_by { |p| p.request_path }.reverse!
-
-      puts "Post Index created, size = " + self.size.to_s
-      
-      # load the tag index
-      TagIndex.instance.load self
-    end
-  end
-end

data/lib/gidget/tag_index.rb

@@ -1,30 +0,0 @@
-require 'singleton'
-require 'gidget/post'
-
-
-module Gidget
-  class TagIndex < Hash
-    include Singleton
-
-    
-    def load posts
-      posts.each { |post|
-        tags = nil
-        
-        if (post.meta_data.has_key? :tags)
-          tags = post.meta_data[:tags].split(',')
-          
-          tags.each { |tag|
-            tag.strip!
-            
-            if (!self.has_key? tag)
-              self[tag] = []
-            end
-            
-            self[tag] << post
-          }
-        end
-      }
-    end
-  end
-end