serious 0.2.0 → 0.2.1

data/README.rdoc

@@ -2,7 +2,7 @@
 
 Serious is a blog engine inspired by other filesystem-based engines like jekyll (http://jekyllrb.com/) 
 and toto (http://cloudhead.io/toto) and is based upon Sinatra and rack, thus can be hosted
-very easily (and for free) on heroku (http://heroku.com).
+very easily (and for free) on heroku (http://heroku.com). 
 
 The articles are stored in plain text files with an opinionated naming scheme which is used for
 getting the date and permalink of your article: <code>articles/2010-02-14-will-you-be-my-valentine.txt</code>
@@ -39,10 +39,20 @@ Install the gem:
   
   sudo gem install serious
 
-Since a basic template and css are provided inside the gem, all you've got to do is set up a directory
-for your new blog, create an articles folder, a config.ru and (for heroku), a .gems file.
+You can use the supplied generator using the <code>serious</code> executable provided with the gem.
+Type <code>serious</code> in your shell to see the available options.
 
-The directory structure would be something like:
+By default the generator will create the app with gem-based public and views directories and initialize
+a git repository. To host your app on heroku instantly, supply the --heroku option, which will use
+the heroku gem to create your app and push it to heroku via git. Type:
+
+  serious my-fancy-blog --heroku
+  
+And you can go to http://my-fancy-blog.heroku.com to see your new blog!
+
+== The setup
+
+The directory basic directory structure of your Serious site would be something like this:
 
   serious_blog/
   - articles
@@ -60,21 +70,26 @@ The config.ru is pretty straight-forward if you want to stick to the defaults:
   
 The .gems file if you want to host on heroku:
 
-  stupid_formatter --version '>= 0.2.0'
-  serious --version '>= 0.1.3'
+  stupid_formatter
+  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.
 
+== 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
-<code>git init</code>, you can now do:
+<code>git init</code> or sticked with the generator, which created your git repo, you can now do:
   
   heroku create mysweetlittleblog
   git push heroku master
   
 Point your browser to the url, and bang, you're ready!
 
-You might also want to test your blog locally. Use thin (<code>sudo gem install thin</code>) with:
+== Running with thin
+
+You might also want to test your blog locally or host it with thin. 
+Use thin (<code>sudo gem install thin</code>) with:
 
   thin -R config.ru start
   
@@ -86,7 +101,24 @@ 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).
 
-== Configuration
+== Comments with disqus
+
+You can activate comments for articles very easily with disqus (http://disqus.com) by setting
+the <code>disqus</code> property to your disqus-id (e.g. 'myfancysite'). Disqus developer mode will
+be automatically activated for requests served by http://localhost so you can preview your settings
+and layout properly.
+
+  Serious.set :disqus, 'yourid'
+  
+== Google Analytics
+
+You can activate Google Analytics by setting the <code>google_analytics</code> property to your 
+tracker id (something like 'UA-123123-5'). The required code will then be included to your site.
+For requests served from http://localhost, the inclusion is skipped.
+
+  Serious.set :google_analytics, 'UA-123123-5'
+
+== Configuration options
 
 Inside your config.ru, you can customize the settings for your Serious site.
 
@@ -153,6 +185,37 @@ Well, your site has to know where it lives to provide proper links in your atom
 with the url setting, which defaults to 'http://localhost:3000'
   
   Serious.set :url, 'http://localhost:3000'
+
+=== The date format
+
+There is a helper in the Date class for formatting dates according to the configuration specified
+in Serious.date_format and which is used in the frontend. It defaults to "%B %o %Y", which expands
+to (i.e.) 'December 24th, 2009'. Notice that %o is a custom flag that is not built-in in the default
+strftime method of Date. It returns the ordinal name of the day. Customize with:
+
+  Serious.set :date_format, "%Y-%m-%d"
+  
+=== Disqus comments
+
+To enable disqus comments, specify your disqus id with the disqus property. Disqus is disabled 
+by default. See section above for more information on disqus and comments.
+
+  Serious.set :disqus, 'yourdisqusid'
+  
+=== Google Analytics
+
+To enable google analytics, specify your tracker id at the property <code>google_analytics</code>.
+See section above for more information on Google Analytics.
+
+  Serious.set :google_analytics, 'UA-123123-5'
+  
+=== Custom feed url in layout
+
+If you want to specify a different feed url for the head link tag, for example to point your readers
+to Feedburner, you can do so by specifiyng the <code>feed_url</code> option and setting up your
+feed to be burned by feedburner based upon <code>http://yoururl.com/atom.xml</code>.
+
+  Serious.set :feed_url, 'http://feeds.feedburner.com/myfeedurl'  
   
 === Displayed items
 
@@ -201,14 +264,10 @@ to learn how to add your own formatters or erb helpers.
 
 * static pages
 * make summary delim configurable
-* beautifuller date formatting in frontend
 * make caching better
 * make it possible to host in subdirectories
 * valid xhtml in demo setup
-* generator for basic app?
 * rake tasks for generating new posts and validating existing
-* disqus (optional)
-* google analytics (optional)
 * allow for choice between erb/haml templates
 
 == Note on Patches/Pull Requests

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/ruby_ext.rb

@@ -0,0 +1,29 @@
+# A couple of Ruby extensions
+
+class Date
+  # Returns the date formatted with the format defined in Serious.date_format
+  # and extended with the %o flag for ordinal day names.
+  def formatted
+    strftime(Serious.date_format.gsub("%o", day.ordinal))
+  end
+end
+
+class Fixnum
+  # Taken from toto
+  def ordinal
+    # 1 => 1st
+    # 2 => 2nd
+    # 3 => 3rd
+    # ...
+    case self % 100
+      when 11..13; "#{self}th"
+    else
+      case self % 10
+        when 1; "#{self}st"
+        when 2; "#{self}nd"
+        when 3; "#{self}rd"
+        else "#{self}th"
+      end
+    end
+  end
+end

data/lib/serious.rb

@@ -4,6 +4,8 @@ require 'sinatra/base'
 require 'stupid_formatter'
 require 'yaml'
 require 'builder'
+$:.unshift File.dirname(__FILE__)
+require 'ruby_ext'
 
 class Serious < Sinatra::Base
   
@@ -27,6 +29,10 @@ class Serious < Sinatra::Base
     def render_article(article, summary_only=false)
       render :erb, :'_article', :locals => { :article => article, :summary_only => summary_only }, :layout => !summary_only
     end
+    
+    def render_partial(name)
+      render :erb, :"_#{name}", :layout => false
+    end
   end
 
   # Index page
@@ -60,7 +66,6 @@ class Serious < Sinatra::Base
   end
 end
 
-$:.unshift File.dirname(__FILE__)
 require 'serious/article'
 # Set up default stupid_formatter chain
 StupidFormatter.chain = [StupidFormatter::Erb, StupidFormatter::RDiscount]
@@ -76,4 +81,8 @@ Serious.set :archived_on_index, 10 # Number of items to display small (title onl
 Serious.set :cache_timeout, 300
 Serious.set :run, false
 Serious.set :environment, :production
+Serious.set :date_format, "%B %o %Y"
+Serious.set :disqus, false
+Serious.set :google_analytics, false
+Serious.set :feed_url, '/atom.xml'
 

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

@@ -27,14 +27,23 @@ h1, h2, h3, h4 {
 
 .author {
   color: #666;
+  font-size: 14px;
 }
 
 #header {
-  margin: 25px 0px 50px 0px;
+  margin: 0px 0px 25px 0px;
+  padding: 25px;
+  text-align: center;
+  border-bottom: 3px solid #BE2805;
+}
+
+#header h1 {
+  font-family: 'Baskerville', Georgia, Times, serif;
+  font-size: 28px;
 }
 
 #header a {
-  color: black;
+  color: #666;
   text-decoration: none;
 }
 
@@ -64,7 +73,25 @@ h1, h2, h3, h4 {
 }
 
 #container .article {
-  margin-bottom: 50px;
+  margin-bottom: 80px;
+}
+
+#container .body a {
+  color: #BE2805;
+}
+
+#container .body a:hover {
+  color: black;
+}
+
+#container blockquote {
+  background-color: #fafafa;
+  margin: 0 0 25px 0;
+  padding: 25px;
+}
+
+#disqus_thread {
+  padding-top: 25px;
 }
 
 

data/lib/site/views/_archives.erb

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

data/lib/site/views/_article.erb

@@ -1,12 +1,15 @@
 <div class="article">
-  <span class="date right"><%= article.date %></span>
+  <span class="date right"><%= article.date.formatted %></span>
   <h2><a href="<%= article.url %>"><%= article.title %></a></h2>
   <div class="body">
     <% if summary_only %>
       <%= article.summary.formatted %>
+      <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>    
+      <span class="author right">Written by <%= article.author %></span>   
+      
+      <%= render_partial :disqus if Serious.disqus %> 
     <% end %>
   </div>
 

data/lib/site/views/_disqus.erb

@@ -0,0 +1,9 @@
+<% if request.url =~ %r{http://localhost} %>
+<script type="text/javascript">  var disqus_developer = true; </script> 
+<% end %>
+<div id="disqus_thread" style="clear:both;"></div>
+<script type="text/javascript" src="http://disqus.com/forums/<%= Serious.disqus %>/embed.js"></script>
+<noscript>
+  <a href="http://disqus.com/forums/<%= Serious.disqus %>/?url=ref">View the discussion thread.</a>
+</noscript>
+<a href="http://disqus.com" class="dsq-brlink">blog comments powered by <span class="logo-disqus">Disqus</span></a>

data/lib/site/views/_google_analytics.erb

@@ -0,0 +1,11 @@
+<% unless request.url =~ %r{http://localhost} %>
+  <script type="text/javascript">
+  var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+  document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+  </script>
+  <script type="text/javascript">
+  try {
+  var pageTracker = _gat._getTracker("<%= Serious.google_analytics %>");
+  pageTracker._trackPageview();
+  } catch(err) {}</script>
+<% end %>

data/lib/site/views/layout.erb

@@ -2,7 +2,7 @@
   <head>
   <link rel="stylesheet" type="text/css" href="/css/serious.css">
   <link rel="stylesheet" type="text/css" href="/css/coderay.css">
-  <link rel="alternate" type="application/atom+xml" title="Serious Test Layout" href="/atom.xml" />
+  <link rel="alternate" type="application/atom+xml" title="<%= Serious.title %>" href="<%= Serious.feed_url %>" />
   <title><%= @article ? @article.title + " - " : "" %><%= Serious.title %></title>
   </head>
   
@@ -17,6 +17,8 @@
     <div id="footer">
       This blog is <a href="http://github.com/colszowka/serious">serious</a>
     </div>
+    
+    <%= render_partial :google_analytics if Serious.google_analytics %> 
   </body>
 </html>
 

data/serious.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{serious}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Christoph Olszowka"]
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
      "Rakefile",
      "VERSION",
      "bin/serious",
+     "lib/ruby_ext.rb",
      "lib/serious.rb",
      "lib/serious/article.rb",
      "lib/site/public/css/coderay.css",
@@ -33,6 +34,8 @@ Gem::Specification.new do |s|
      "lib/site/views/404.erb",
      "lib/site/views/_archives.erb",
      "lib/site/views/_article.erb",
+     "lib/site/views/_disqus.erb",
+     "lib/site/views/_google_analytics.erb",
      "lib/site/views/archives.erb",
      "lib/site/views/atom.builder",
      "lib/site/views/index.erb",
@@ -44,6 +47,7 @@ Gem::Specification.new do |s|
      "test/articles/2009-12-24-merry-christmas.txt",
      "test/helper.rb",
      "test/test_article.rb",
+     "test/test_ruby_ext.rb",
      "test/test_serious.rb"
   ]
   s.homepage = %q{http://github.com/colszowka/serious}
@@ -54,6 +58,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/test_serious.rb",
      "test/helper.rb",
+     "test/test_ruby_ext.rb",
      "test/test_article.rb"
   ]
 

data/test/helper.rb

@@ -47,6 +47,13 @@ class Test::Unit::TestCase
     end
   end
   
+  def self.should_contain_attribute(attribute, text, selector)
+    should "contain '#{text}' in '#{selector}' #{attribute}" do
+      doc = Hpricot.parse(last_response.body)
+      assert_equal text, (doc/selector).first[attribute]
+    end
+  end
+  
   def self.should_set_cache_control_to(seconds)
     should "set Cache-Control header with timeout of #{seconds} seconds" do
       assert_equal "public, max-age=#{Serious.cache_timeout}", last_response.headers['Cache-Control']

data/test/test_ruby_ext.rb

@@ -0,0 +1,69 @@
+require 'helper'
+
+#
+# Tests for the Ruby Extensions
+# 
+class TestRubyExt < Test::Unit::TestCase
+  # ========================================================================
+  # Tests for formatted date 
+  # ========================================================================
+  context "With Serious.date_format set to '%Y-%m-%d'" do
+    setup do
+      @original_format = Serious.date_format
+      Serious.set :date_format, "%Y-%m-%d"
+    end
+    
+    should "return '2009-12-13' for Date.new(2009, 12, 13).formatted" do 
+      assert_equal '2009-12-13', Date.new(2009, 12, 13).formatted
+    end
+    
+    should "return '2010-01-09' for Date.new(2010, 1, 9).formatted" do 
+      assert_equal '2010-01-09', Date.new(2010, 1, 9).formatted
+    end
+    
+    teardown do
+      Serious.set :date_format, @original_format
+    end
+  end
+  
+  context "With Serious.date_format set to '%a, %B %d, %Y'" do
+    setup do
+      @original_format = Serious.date_format
+      Serious.set :date_format, "%a, %B %d, %Y"
+    end
+    
+    should "return 'Sat, February 13 2010' for Date.new(2010, 2, 13).formatted" do 
+      assert_equal 'Sat, February 13, 2010', Date.new(2010, 2, 13).formatted
+    end
+    
+    teardown do
+      Serious.set :date_format, @original_format
+    end    
+  end
+  
+  context 'With Serious.date_format set to "%B %o %Y"' do
+    setup do
+      @original_format = Serious.date_format
+      Serious.set :date_format, "%B %o %Y"
+    end
+    
+    should "return 'February 12th 2010' for Date.new(2010, 2, 12).formatted" do 
+      assert_equal 'February 12th 2010', Date.new(2010, 2, 12).formatted
+    end
+    
+    teardown do
+      Serious.set :date_format, @original_format
+    end
+  end
+  
+  # ========================================================================
+  # Tests for ordinal
+  # ========================================================================
+  
+  should("return '1st' for 1.ordinal") { assert_equal '1st', 1.ordinal}
+  should("return '2nd' for 2.ordinal") { assert_equal '2nd', 2.ordinal}
+  should("return '3rd' for 3.ordinal") { assert_equal '3rd', 3.ordinal}
+  should("return '4th' for 4.ordinal") { assert_equal '4th', 4.ordinal}
+  should("return '31st' for 31.ordinal") { assert_equal '31st', 31.ordinal}
+  
+end

data/test/test_serious.rb

@@ -16,6 +16,8 @@ class TestSerious < Test::Unit::TestCase
     should_contain_elements 3, "ul#articles li"
     should_contain_text "Merry Christmas!", "ul#articles li:first"
     should_contain_text "Merry christmas, dear reader!", "ul#articles li:first"
+    should_contain_text "December 24th 2009", "ul#articles li:first .date"
+    
     should_not_contain_text "Lorem ipsum dolor...", "ul#articles li:first"
     
     should_contain_text "Ruby is the shit!", "ul#articles"
@@ -50,6 +52,7 @@ class TestSerious < Test::Unit::TestCase
     should_respond_with 200
     should_set_cache_control_to 300
     should_contain_text "Archives for 2009-12", "#container h2:first"
+    should_contain_text 'December 24th 2009', "ul.archives li"
     should_contain_elements 2, "ul.archives li"
     should_contain_text "Merry Christmas!", "ul.archives li:first"
     should_contain_text "Ruby is the shit!", "ul.archives"
@@ -187,4 +190,79 @@ class TestSerious < Test::Unit::TestCase
     should_contain_text "Merry Christmas!", "feed entry:first title"
     should_contain_text "Christoph Olszowka", "feed entry:first author name:first"
   end
+  
+  # ===================================================================
+  # Tests for disqus integration
+  # ===================================================================
+  context "With disqus id set" do
+    setup { Serious.set :disqus, 'foobar' }
+    teardown { Serious.set :disqus, false}
+    
+    context "GET /2009/12/24/merry-christmas" do
+      setup { get '/2009/12/24/merry-christmas' }
+      
+      should_contain_text "View the discussion thread.", "#container .article noscript"
+      should_contain_elements 1, "#container #disqus_thread"
+    end
+  end
+  
+  context "With disqus inactive" do
+    setup { Serious.set :disqus, false }
+    
+    context "GET /2009/12/24/merry-christmas" do
+      setup { get '/2009/12/24/merry-christmas' }
+      
+      should_not_contain_text "View the discussion thread.", "#container .article noscript"
+      should_contain_elements 0, "#container #disqus_thread"
+    end
+  end
+  
+  # ===================================================================
+  # Tests for google analytics integration
+  # ===================================================================
+  context "With google analytics active" do
+    setup { Serious.set :google_analytics, 'analyticsid' }
+    
+    context "GET /" do
+      setup { get '/' }
+      
+      should_contain_elements 2, "body script"
+    end
+  end
+  
+  context "With google analytics inactive" do
+    setup { Serious.set :google_analytics, false }
+    
+    context "GET /" do
+      setup { get '/' }
+      
+      should_contain_elements 0, "body script"
+    end
+  end
+  
+  # ===================================================================
+  # Tests for feed url setting
+  # ===================================================================
+  context "With default feed url" do
+    context "GET /" do
+      setup { get '/' }
+      
+      should_contain_attribute "href", "/atom.xml", "head link:last"
+    end
+  end
+  
+  context "With custom feed url" do
+    setup do
+      @original_feed_url = Serious.feed_url
+      Serious.set :feed_url, 'http://feeds.feedburner.com/myfeedurl'
+    end
+    teardown { Serious.set :feed_url, @original_feed_url }
+    
+    context "GET /" do
+      setup { get '/' }
+      
+      should_contain_attribute "href", "http://feeds.feedburner.com/myfeedurl", "head link:last"
+    end
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: serious
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Christoph Olszowka
@@ -89,6 +89,7 @@ files:
 - Rakefile
 - VERSION
 - bin/serious
+- lib/ruby_ext.rb
 - lib/serious.rb
 - lib/serious/article.rb
 - lib/site/public/css/coderay.css
@@ -96,6 +97,8 @@ files:
 - lib/site/views/404.erb
 - lib/site/views/_archives.erb
 - lib/site/views/_article.erb
+- lib/site/views/_disqus.erb
+- lib/site/views/_google_analytics.erb
 - lib/site/views/archives.erb
 - lib/site/views/atom.builder
 - lib/site/views/index.erb
@@ -107,6 +110,7 @@ files:
 - test/articles/2009-12-24-merry-christmas.txt
 - test/helper.rb
 - test/test_article.rb
+- test/test_ruby_ext.rb
 - test/test_serious.rb
 has_rdoc: true
 homepage: http://github.com/colszowka/serious
@@ -139,4 +143,5 @@ summary: Serious is a simple, file-driven blog engine inspired by toto and drive
 test_files: 
 - test/test_serious.rb
 - test/helper.rb
+- test/test_ruby_ext.rb
 - test/test_article.rb