serious 0.2.2 → 0.2.3

data/README.rdoc

@@ -56,7 +56,9 @@ The directory basic directory structure of your Serious site would be something
 
   serious_blog/
   - articles
-    - articles/2010-02-14-will-you-be-my-valentine.txt
+    - 2010-02-14-will-you-be-my-valentine.txt
+  - pages
+    - about.txt
   - config.ru
   - .gems
   - Rakefile
@@ -73,14 +75,11 @@ The .gems file if you want to host on heroku:
 
   serious
   
-Note that sinatra is not included in the gemfile since heroku has it installed by default, but serious
-will install it as a gem dependency on other systems as well.
-
-The Rakefile, which is obviously totally optional but highly recommended.
+The Rakefile, which is obviously totally optional but highly recommended looks like this:
 
   require 'serious'
   require 'serious/tasks'
-
+  
 == Creating heroku app manually
 
 Assuming you've got the heroku gem installed and set up and you've set up git for your blog with
@@ -108,6 +107,14 @@ The whole archives can be accessed at <code>/archives</code>. Archives by year,
 are available at <code>/2009</code> (all of 2009), <code>/2009/05</code> (May 2009), 
 <code>/2009/05/15</code> (May 15th 2009).
 
+== Static pages
+
+Static pages are quite similar to blog articles, in that their formatting and processing is the same.
+They have a yaml front matter, content that gets piped through the StupidFormatter and so on.
+The filename sans the extension serves as the permalink, pages can be reached via 
+<code>/pages/PERMALINK</code>, so the content in pages/about.txt will be served at 
+<code>/pages/about</code>
+
 == Rake tasks
 
 If you've set up the Rakefile in your site's main directory like mentioned above (this happens 

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.2.3

data/bin/serious

@@ -33,6 +33,7 @@ require 'fileutils'
 puts "Creating directory #{DIRNAME}"
 ORIGINAL_DIR = Dir.getwd
 FileUtils.mkdir_p(File.join(DIRNAME, 'articles'))
+FileUtils.mkdir_p(File.join(DIRNAME, 'pages'))
 Dir.chdir(DIRNAME)
 
 GEM_ROOT = File.join(File.dirname(__FILE__), '..')
@@ -66,6 +67,14 @@ end
 copy_views if views?
 copy_public if public?
 
+puts "Writing about page"
+
+File.open('pages/about.txt', "w+") do |about|
+  about.puts "title: About"
+  about.puts
+  about.puts "Something about you"
+end
+
 puts "Writing config.ru"
 File.open('config.ru', 'w+') do |config|
   config.puts "require 'serious'"

data/lib/serious/page.rb

@@ -0,0 +1,32 @@
+class Serious::Page < Serious::Article
+  class << self
+    #
+    # Returns all pages
+    #
+    def all
+      @pages ||= page_paths.map { |path| new(path) }
+    end
+    
+    def find(permalink)
+      all.find_all {|page| page.permalink == permalink }.first
+    end
+    
+    private
+    
+      # Returns all page files in pages path
+      def page_paths
+        @pages_paths ||= Dir[File.join(Serious.pages, '*')].sort
+      end
+  end
+  
+  def url
+    "/pages/#{permalink}"
+  end
+  
+  private
+  
+    # Will extract the permalink from the filename.
+    def extract_date_and_permalink!
+      @permalink = File.basename(path).split('.')[0...-1].join("")
+    end
+end

data/lib/serious.rb

@@ -10,6 +10,7 @@ require 'ruby_ext'
 class Serious < Sinatra::Base
   
   set :articles, Proc.new { File.join(Dir.getwd, 'articles') }
+  set :pages, Proc.new { File.join(Dir.getwd, 'pages') }
   set :static, true # Required to serve static files, see http://www.sinatrarb.com/configuration.html
   
   not_found do
@@ -55,18 +56,32 @@ class Serious < Sinatra::Base
   
   # Archives route
   get %r{^/(\d{4})[/]{0,1}(\d{0,2})[/]{0,1}(\d{0,2})[/]{0,1}$} do
-    @selection = params[:captures].reject {|s| s.strip.length == 0 }.map {|n| n.length == 1 ? "%02d" % n : n}
-    @articles = Article.find(*@selection)
+    selection = params[:captures].reject {|s| s.strip.length == 0 }.map {|n| n.length == 1 ? "%02d" % n : n}
+    @articles = Article.find(*selection)
+    @title = "Archives for #{selection.join("-")}"
     erb :archives
   end
   
   get "/archives" do
     @articles = Article.all
+    @title = "Archives"
     erb :archives
   end
+  
+  get "/pages" do
+    @articles = Page.all
+    @title = "Pages"
+    erb :archives
+  end
+  
+  get "/pages/:page" do
+    halt 404 unless @article = Page.find(params[:page])
+    render_article @article
+  end
 end
 
 require 'serious/article'
+require 'serious/page'
 # Set up default stupid_formatter chain
 StupidFormatter.chain = [StupidFormatter::Erb, StupidFormatter::RDiscount]
 

data/lib/site/public/css/serious.css

@@ -42,7 +42,8 @@ h1, h2, h3, h4 {
 }
 
 #header {
-  margin: 0px 0px 60px 0px;
+  margin: 0;
+  margin-bottom: 30px;
   padding: 30px;
   text-align: center;
   border-bottom: 2px solid #BE2805;

data/lib/site/views/_archives.erb

@@ -2,7 +2,9 @@
   <% articles.each do |article| %>
     <li>
       <a href="<%= article.url %>"><%= article.title %></a>
-      <span class="date"><%= article.date.formatted %></span>
+      <% if article.date %>
+        <span class="date"><%= article.date.formatted %></span>
+      <% end %>
     </li>
   <% end %>
 </ul>

data/lib/site/views/_article.erb

@@ -1,5 +1,7 @@
 <div class="article">
-  <span class="date right"><%= article.date.formatted %></span>
+  <% if article.date %>
+    <span class="date right"><%= article.date.formatted %></span>
+  <% end %>
   <h2><a href="<%= article.url %>"><%= article.title %></a></h2>
   <div class="body">
     <% if summary_only %>
@@ -7,9 +9,11 @@
       <span class="right date"><a href="<%= article.url %>">read on...</a></span>
     <% else %>
       <%= article.body.formatted %>
-      <span class="author right">Written by <%= article.author %></span>   
       
-      <%= render_partial :disqus if Serious.disqus %> 
+      <% if article.instance_of?(Serious::Article) %>
+        <span class="author right">Written by <%= article.author %></span>   
+        <%= render_partial :disqus if Serious.disqus %> 
+      <% end %>
     <% end %>
   </div>
 

data/lib/site/views/archives.erb

@@ -1,2 +1,2 @@
-<h2>Archives<%= @selection ? " for " + @selection.join("-") : "" %></h2>
+<h2><%= @title %></h2>
 <%= render_archived @articles %>

data/lib/site/views/index.erb

@@ -7,3 +7,8 @@
 </ul>
 <h3><a href="/archives">Older posts</a></h3>
 <%= render_archived @archived %>
+
+<% if Serious::Page.all.count > 0 %>
+  <h3><a href="/pages">Pages</a></h3>
+  <%= render_archived Serious::Page.all %>
+<% end %>

data/lib/site/views/layout.erb

@@ -10,6 +10,7 @@
     <div id="header">
       <h1><a href="/"><%= Serious.title %></a></h1>
     </div>
+    
     <div id="container">
       <%= yield %>
     </div>

data/serious.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{serious}
-  s.version = "0.2.2"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Christoph Olszowka"]
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
      "lib/ruby_ext.rb",
      "lib/serious.rb",
      "lib/serious/article.rb",
+     "lib/serious/page.rb",
      "lib/serious/tasks.rb",
      "lib/site/public/css/coderay.css",
      "lib/site/public/css/serious.css",
@@ -49,8 +50,11 @@ Gem::Specification.new do |s|
      "test/articles/2009-12-11-ruby-is-the-shit.txt",
      "test/articles/2009-12-24-merry-christmas.txt",
      "test/helper.rb",
+     "test/pages/about.txt",
+     "test/pages/foo-bar.txt",
      "test/test_article.rb",
      "test/test_bin.rb",
+     "test/test_page.rb",
      "test/test_ruby_ext.rb",
      "test/test_serious.rb"
   ]
@@ -60,7 +64,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Serious is a simple, file-driven blog engine inspired by toto and driven by sinatra}
   s.test_files = [
-    "test/test_bin.rb",
+    "test/test_page.rb",
+     "test/test_bin.rb",
      "test/test_serious.rb",
      "test/helper.rb",
      "test/test_ruby_ext.rb",

data/test/helper.rb

@@ -12,6 +12,7 @@ class Test::Unit::TestCase
   include Rack::Test::Methods
   Serious.set :title, "Serious Test Blog"
   Serious.set :articles, File.join(File.dirname(__FILE__), 'articles')
+  Serious.set :pages, File.join(File.dirname(__FILE__), 'pages')
   Serious.set :author, "TheDeadSerious"
   Serious.set :url, 'http://example.com'
   StupidFormatter.chain = [StupidFormatter::Erb, StupidFormatter::RDiscount]

data/test/pages/about.txt

@@ -0,0 +1,5 @@
+title: About me
+
+Some text about me
+~
+And some more content with <%= 'erb' %>

data/test/pages/foo-bar.txt

@@ -0,0 +1,3 @@
+title: Foo Bar
+
+Baz!

data/test/test_bin.rb

@@ -37,6 +37,7 @@ class TestBin < Test::Unit::TestCase
     
     when_running_serious_with 'foo' do
       should_have_dir 'foo/articles'
+      should_have_dir 'foo/pages'
       should_have_dir 'foo/.git'
       should_have_file 'foo/.gems', 'serious --version'
       should_not_have_path 'foo/public'
@@ -48,6 +49,11 @@ class TestBin < Test::Unit::TestCase
         Dir.chdir('..')
       end
       
+      should_have_file 'foo/pages/about.txt' do |file| 
+        should_contain "title: About", file
+        should_contain "Something about you", file
+      end
+      
       should_have_file 'foo/config.ru' do |file| 
         should_contain "require 'serious'", file
         should_contain "Serious.set :title, 'foo'", file

data/test/test_page.rb

@@ -0,0 +1,101 @@
+require 'helper'
+
+class TestPage < Test::Unit::TestCase
+  # ========================================================================
+  # Tests for all pages
+  # ========================================================================
+  context "Serious::Page.all" do
+    setup do
+      @pages = Serious::Page.all
+    end
+    
+    should("return 2 pages") { assert_equal 2, @pages.length }
+    should "have only instances of Serious::Page in the collection" do
+      assert @pages.all? {|a| a.instance_of?(Serious::Page) }
+    end
+    
+    should "return an existing path for all pages" do
+      assert @pages.all? {|p| File.exist? p.path }
+    end
+    
+    should "not have instance variable @yaml set on any page" do
+      @pages.each do |page|
+        assert_nil page.instance_variable_get(:@yaml)
+      end
+    end
+    
+    should "not have instance variable @content set on any page" do
+      @pages.each do |page|
+        assert_nil page.instance_variable_get(:@content)
+      end
+    end
+  end
+  
+  # ========================================================================
+  # Tests for initializer and extracting permalink from path
+  # ========================================================================
+  context "Serious::Page.new('foo-bar.txt')" do
+    setup do
+      @page = Serious::Page.new('foo-bar.txt')
+    end
+    
+    should "return permalink 'foo-bar'" do
+      assert_equal 'foo-bar', @page.permalink
+    end
+    
+    should "return '/pages/foo-bar' as url" do
+      assert_equal '/pages/foo-bar', @page.url
+    end
+    
+    should "return 'http://example.com/pages/foo-bar' as full_url" do
+      assert_equal 'http://example.com/pages/foo-bar', @page.full_url
+    end
+  end
+  
+  # ========================================================================
+  # Tests for dynamic loading and processing of title, summary and body
+  # ========================================================================
+  context "The page 'about'" do
+    setup do
+      @page = Serious::Page.find('about')
+    end
+    
+    context "after getting the page's title" do
+      setup { @title = @page.title }
+      
+      should "have returned 'About me'" do
+        assert_equal 'About me', @title
+      end
+      
+      should "have initialized the @yaml instance variable to a hash" do
+        assert @page.instance_variable_get(:@yaml).kind_of?(Hash)
+      end
+      
+      should "have initialized the @content instance variable to a string" do
+        assert @page.instance_variable_get(:@content).kind_of?(String)
+      end
+      
+      should "have summary set to 'Some text about me'" do
+        assert_equal 'Some text about me', @page.summary
+      end
+      
+      should 'have formatted body set to "<p>Some text about me</p>\n\n<p>And some more content with erb</p>\n"' do
+        assert_equal "<p>Some text about me</p>\n\n<p>And some more content with erb</p>\n", @page.body.formatted
+      end
+    end
+  end
+  
+  context "The page 'foo-bar'" do
+    setup do
+      @page = Serious::Page.find('foo-bar')
+    end
+    
+    should "be valid" do
+      assert @page.valid?
+    end
+    should("have title 'Foo Bar'") { assert_equal 'Foo Bar', @page.title }
+    should('have summary "Baz!"')  { assert_equal "Baz!", @page.summary }
+    should('have body "Baz!"')     { assert_equal "Baz!", @page.body }
+    should('have summary equal to body') { assert_equal @page.summary, @page.body}
+  end
+end

data/test/test_serious.rb

@@ -27,8 +27,12 @@ class TestSerious < Test::Unit::TestCase
     should_contain_text "Foo Bar", "ul#articles"
     should_contain_text "Serious Test Blog", "head title"
     
-    should_contain_elements 1, "ul.archives li"
+    should_contain_elements 1, "ul.archives:first li"
     should_contain_text "Disco 2000", "ul.archives li:first"
+    
+    should_contain_text "Pages", "h3"
+    should_contain_elements 2, "ul.archives:last li"
+    should_contain_text "About me", "ul.archives:last li:first"
   end
   
   # ===================================================================
@@ -133,6 +137,7 @@ class TestSerious < Test::Unit::TestCase
     should_contain_text "Merry Christmas! - Serious Test Blog", "head title"
     should_contain_text "Merry christmas, dear reader!", ".article .body"
     should_contain_text "Lorem ipsum dolor...", ".article .body"
+    should_contain_elements 1, ".article span.author"
   end
   
   context "GET /2009/12/11/ruby-is-the-shit" do
@@ -204,6 +209,14 @@ class TestSerious < Test::Unit::TestCase
       should_contain_text "View the discussion thread.", "#container .article noscript"
       should_contain_elements 1, "#container #disqus_thread"
     end
+    
+    context "GET /pages/about" do
+      setup { get '/pages/about' }
+    
+      should_respond_with 200
+      should_set_cache_control_to 300
+      should_contain_elements 0, "#container #disqus_thread"
+    end
   end
   
   context "With disqus inactive" do
@@ -265,4 +278,39 @@ class TestSerious < Test::Unit::TestCase
     end
   end
   
+  
+  
+  # ===================================================================
+  # Tests for pages
+  # ===================================================================
+  context "GET /pages" do
+    setup { get '/pages' }  
+    should_respond_with 200
+    should_set_cache_control_to 300
+    
+    should_contain_elements 2, "ul.archives li"
+    should_contain_text "About me", "ul.archives li:first"
+  end
+  
+  context "GET /pages/" do
+    setup { get '/pages/' }  
+    should_respond_with 200
+  end if 1 == 2
+  
+  context "GET /pages/about" do
+    setup { get '/pages/about' }
+  
+    should_respond_with 200
+    should_set_cache_control_to 300
+    
+    should_contain_text "About me", "#container .article h2" 
+    should_contain_text "Some text about me", "#container .article .body" 
+    should_contain_elements 0, ".article span.author"
+    should_contain_text "And some more content with erb", "#container .article .body" 
+  end
+  
+  context "GET /pages/about/" do
+    setup { get '/pages/about/' }  
+    should_respond_with 200
+  end if 1 == 2 # TODO: FIXME
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: serious
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Christoph Olszowka
@@ -92,6 +92,7 @@ files:
 - lib/ruby_ext.rb
 - lib/serious.rb
 - lib/serious/article.rb
+- lib/serious/page.rb
 - lib/serious/tasks.rb
 - lib/site/public/css/coderay.css
 - lib/site/public/css/serious.css
@@ -112,8 +113,11 @@ files:
 - test/articles/2009-12-11-ruby-is-the-shit.txt
 - test/articles/2009-12-24-merry-christmas.txt
 - test/helper.rb
+- test/pages/about.txt
+- test/pages/foo-bar.txt
 - test/test_article.rb
 - test/test_bin.rb
+- test/test_page.rb
 - test/test_ruby_ext.rb
 - test/test_serious.rb
 has_rdoc: true
@@ -145,6 +149,7 @@ signing_key:
 specification_version: 3
 summary: Serious is a simple, file-driven blog engine inspired by toto and driven by sinatra
 test_files: 
+- test/test_page.rb
 - test/test_bin.rb
 - test/test_serious.rb
 - test/helper.rb