who-needs-wp 0.3.0 → 0.4.0

data/README.md

@@ -0,0 +1,119 @@
+# who-needs-wp
+_Who needs Wordpress?_
+ 
+The majority of web sites are consumed. Visitors will stumble upon the site, read a few pages (if you're lucky) and then disappear. Normally for every visitor to the site each webpage is generated dynamically. Each visitor has their own version of the web page for that particular moment of time. Is this really necessary? How often does the content on the web site you are visiting change?
+
+Take blogs for example. I have a blog written using the excellent Wordpress software. I'm able to write posts within Wordpress and see them appear on the web site without leaving my web browser. My posts are held in a database, when a user requests to view my blog multiple requests are made to the database to build a dynamic page on which contents rarely changes. I create a new blog post every 3 weeks, it seems a bit unnecessary to generate a web page when the content hasn't changed.
+
+There is another option. Instead of generating the web site dynamically when the page is requested I can generate the web page whenever the content changes. So whenever I create a new post - I regenerate the site. 
+
+This has the advantage of serving web pages faster; I use less hosting space; and I cut any unnecessary features which Wordpress provides.
+
+The main disadvantage is that user's aren't able to comment on my posts - but this don't matter too much - nobody ever did! ;-)
+
+## Getting Started
+
+`who-needs-wp` is a small Ruby program which helps generate static web sites. To start using `who-needs-wp` you need to install Ruby. On Ubuntu enter the following into a command prompt:
+
+    sudo apt-get install ruby ruby-dev rubygems
+    
+You then need to install `who-needs-wp` by running the following:
+
+    sudo gem install who-needs-wp
+    
+Ensure that Ruby gems is in your `PATH` variable by opening `~/.bashrc` and entering:
+
+    export PATH=/var/lib/gems/1.8/bin:$PATH
+
+You'll need to re-load the `.bashrc` file by using the following command:
+
+    . ~/.bashrc
+    
+Now create a folder which will host your web site
+
+    mkdir /var/www/website/
+    
+`who-needs-wp` stores posts in the `posts/` folder followed by a folder representing the date of the post. i.e. `posts/year/month/day`.
+
+Create an example post by creating a folder and creating a Markdown file.
+
+    mkdir /var/www/website/posts/2010/03/15/ --parents
+    gedit /var/www/website/posts/2010/03/15/An_example_post.markdown
+    
+The filename will be used as the title for the page - all the underscores will be replaced with spaces.
+
+Along with [Markdown Syntax][MarkdownSyntax] you can also specify the author of the blog post within the file:
+
+    Author: Your Name
+
+Before it can generate the site `who-needs-wp` needs to be configured. Copy the following into `/var/www/website/.who-needs-wp.yaml`
+
+    --- 
+    :url: /website/test
+    :title: An example blog
+    :author: Your Name
+
+These are the properties which are used to generate the website:
+
+* `url` - The base URL of the website
+* `title` - A title for the index of your site
+* `author` - When a author is not specified within the post this author is displayed
+
+Now you can generate your site:
+
+    who-needs-wp .
+    
+And view the blog at the following URL:
+
+    http://localhost/website/
+
+## Overriding Templates
+
+You will probably find that the templates used by `who-needs-wp` don't quite match your requirements. You can override any of the templates by creating a `templates` folder. You can copy the existing templates from the gem as a starting point. The templates are stored within the `/var/lib/gems/1.8/gems/who-needs-wp-0.1.0/lib/who-needs-wp/templates/`. 
+
+## Applying alternative styles
+
+You can specify an additional stylesheet by using the `-s` or `--stylesheet` option to the `who-needs-wp` command.
+
+## Twitter
+
+`who-needs-wp` can place a [Twitter][Twitter] stream in the side bar. This can either be a search or an individual user's feed.
+
+Modifying `.who-needs-wp.yaml` and add:
+
+    :twitter:
+      :user: <your twitter user>
+      :search: <your twitter search>
+      
+## Delicious
+
+`who-needs-wp` can also display a list of bookmarks from [Delicious][Delicious]. Modify `.who-needs-wp.yaml` and add:
+
+    :delicious:
+      :user: <your delicious username>
+
+## Google Analytics
+
+To enable Google Analytics you need to specify your web property ID in `.who-needs-wp.yaml`. For example:
+
+    :google_analytics: UA-XXXXXXXX
+
+
+## Syntax Highlighting
+
+`who-needs-wp` will syntax highlight your code snippets using [Makers-Mark][MakersMark] and [Pygments][Pygments]
+
+## Migration from Wordpress
+
+A simple script is in development which will convert a MySQL database to seperate Markdown pages.
+
+### Copyright
+
+Copyright (c) 2010 Owen Griffin. See LICENSE for details.
+
+[Markdown]: http://daringfireball.net/projects/markdown/
+[MarkdownSyntax]: http://daringfireball.net/projects/markdown/syntax
+[Delicious]: http://del.icio.us/
+[Twitter]: http://twitter.com/
+[MakersMark]: http://github.com/nakajima/makers-mark
+[Pygments]: http://pygments.org/

data/lib/who-needs-wp.rb

@@ -25,6 +25,7 @@ module WhoNeedsWP
   # Logger
   @logger = Logger.new(STDOUT)
 
+  # Generate the site with the specified options
   def self.generate(options)
     @options = options
     self.load_templates
@@ -37,20 +38,24 @@ module WhoNeedsWP
     self.generate_posts
     self.generate_pages
     self.index
+    self.all_posts
     self.css
   end
+
+  # Generate the index page for the blog
   def self.index
-    File.open("index.html", "w") do |file|
-      contents = ""
-      @POSTS[0..3].each do |post|
-        contents << post[:html]
-      end
-      file.puts @template['layout'].render(Object.new, {
-                                            :content => contents, 
-                                            :options => @options, 
-                                            :sidebar => @sidebar.join,
-                                             :layout_name => "index"
-                                          })
+    contents = ""
+    @POSTS[0..3].each do |post|
+      contents << post[:html]
     end
+    self.render_html("index.html", "index", contents)
+  end
+
+  # Generate a page containing a list of all posts
+  def self.all_posts
+    self.render_html("posts/all.html", "post_index", @template['all_posts'].render(Object.new, { 
+                                                                              :posts => @POSTS, 
+                                                                              :options => @options
+                                                                            }), "All Posts")
   end
 end

data/lib/who-needs-wp/pages.rb

@@ -25,30 +25,27 @@ module WhoNeedsWP
 
   def self.generate_pages
     @pages.each do |page|
-      File.open(page[:filename][:generated], "w") do |file|
-        markdown = File.read(page[:filename][:original])
-        page[:author] = @options[:author]
-        match = markdown.match(/^[aA]uthor: (.*)$/o)
-        if match
-          page[:author] = match[1]
-          # Remove the author from the post text
-          markdown.gsub! /^[aA]uthor: .*$/, ''
-        end
-#        post[:markdown] = RDiscount.new(markdown, :smart, :generate_toc).to_html
-        page[:markdown] = MakersMark.generate(markdown)
-        page[:html] = @template['page'].render(Object.new, {
-                                                :page => page, 
-                                                :title => page[:title],
-                                                :options => @options
-                                              })
-        file.puts @template['layout'].render(Object.new, {
-                                              :content => page[:html], 
-                                              :options => @options, 
-                                              :title => page[:title], 
-                                              :sidebar => @sidebar.join,
-                                               :layout_name => "page"
-                                            })
+
+      markdown = File.read(page[:filename][:original])
+
+      page[:author] = @options[:author]
+
+      match = markdown.match(/^[aA]uthor: (.*)$/o)
+      if match
+        page[:author] = match[1]
+        # Remove the author from the post text
+        markdown.gsub! /^[aA]uthor: .*$/, ''
       end
+
+      # post[:markdown] = RDiscount.new(markdown, :smart, :generate_toc).to_html
+      page[:markdown] = MakersMark.generate(markdown)
+      page[:html] = @template['page'].render(Object.new, {
+                                               :page => page, 
+                                               :title => page[:title],
+                                               :options => @options
+                                             })
+      # Render the page as HTML
+      self.render_html(page[:filename][:generated], "page", page[:html], page[:title])
     end
   end
 end

data/lib/who-needs-wp/posts.rb

@@ -29,35 +29,36 @@ module WhoNeedsWP
 
   def self.generate_posts
     @POSTS.each_index do |index|
+      # Calculate the previous and next posts
       post = @POSTS[index]
       previous_post = @POSTS[index + 1] if index + 1 < @POSTS.length
       next_post = @POSTS[index - 1] if index > 1
-      File.open(post[:filename][:generated], "w") do |file|
-        markdown = File.read(post[:filename][:original])
-        post[:author] = @options[:author]
-        match = markdown.match(/^[aA]uthor: (.*)$/o)
-        if match
-          post[:author] = match[1]
-          # Remove the author from the post text
-          markdown.gsub! /^[aA]uthor: .*$/, ''
-        end
-#        post[:markdown] = RDiscount.new(markdown, :smart, :generate_toc).to_html
-        post[:markdown] = MakersMark.generate(markdown)
-        post[:html] = @template['post'].render(Object.new, {
-                                                :post => post, 
-                                                :title => post[:title],
-                                                :options => @options,
-                                                 :next_post => next_post,
-                                                 :previous_post => previous_post
-                                              })
-        file.puts @template['layout'].render(Object.new, {
-                                              :content => post[:html], 
-                                              :options => @options, 
-                                              :title => post[:title], 
-                                              :sidebar => @sidebar.join,
-                                               :layout_name => "post"
-                                            })
+
+      # Read the contents of the file
+      markdown = File.read(post[:filename][:original])
+      
+      # Specify the default author
+      post[:author] = @options[:author]
+
+      # Check to see if the author of the document is specified with "Author:"
+      match = markdown.match(/^[aA]uthor: (.*)$/o)
+      if match
+        post[:author] = match[1]
+        # Remove the author from the post text
+        markdown.gsub! /^[aA]uthor: .*$/, ''
       end
+
+      # post[:markdown] = RDiscount.new(markdown, :smart, :generate_toc).to_html
+      post[:markdown] = MakersMark.generate(markdown)
+      post[:html] = @template['post'].render(Object.new, {
+                                               :post => post, 
+                                               :title => post[:title],
+                                               :options => @options,
+                                               :next_post => next_post,
+                                               :previous_post => previous_post
+                                             })
+      # Render the post as HTML
+      self.render_html(post[:filename][:generated], "post", post[:html], post[:title])
     end
   end
 end

data/lib/who-needs-wp/templates.rb

@@ -1,6 +1,24 @@
 
 
 module WhoNeedsWP
+
+  # Render the specified HTML contents within the layout template
+  def self.render_html(filename, type, contents, title = "")
+    File.open(filename, "w") do |file|
+      body = @template['body'].render(Object.new, {
+                                              :content => contents, 
+                                              :options => @options, 
+                                              :sidebar => @sidebar.join,
+                                               :layout_name => type
+                                            })
+      file.puts @template['layout'].render(Object.new, {
+                                             :content => body,
+                                             :options => @options,
+                                             :title => title 
+                                           })
+    end
+  end
+
   def self.load_templates
     template_folder = File.expand_path(File.join(File.dirname(__FILE__), "templates"))
     @template = Hash.new

data/lib/who-needs-wp/templates/all_posts.haml

@@ -0,0 +1,6 @@
+%h1 All Posts
+%ul
+  - posts.each do |post|
+    %li
+      %span.date= post[:created_at].strftime('%Y-%m-%d')
+      %a.title{:href => "#{options[:url]}/#{post[:filename][:generated]}", :title => post[:title]}= post[:title]

data/lib/who-needs-wp/templates/body.haml

@@ -0,0 +1,17 @@
+#doc4.yui-t2
+  #hd
+    %h1
+      %a{:href => "#{options[:url]}/index.html"}= options[:title]
+  #bd
+    #yui-main
+      .yui-b
+        .yui-gc
+          .yui-u.first
+            #content{:class => "#{layout_name}"}= content
+          .yui-u
+            =sidebar
+    .yui-b
+
+  #ft
+    Generated using who-needs-wp
+

data/lib/who-needs-wp/templates/layout.haml

@@ -4,28 +4,22 @@
     %link{:rel => "stylesheet", :type => "text/css", :href => "#{options[:url]}/style.css"}/
     %title
       = options[:title]
-      - if defined? title
+      - if defined? title and title != nil and not title.empty?
         \-
         = title
     - if defined? options[:stylesheet]
       %link{:rel => "stylesheet", :type => "text/css", :href => "#{options[:url]}/#{options[:stylesheet]}"}/
     %meta{:"http-equiv" => "Content-Type", :content => "text/html; charset=utf-8"}/
   %body
-    #doc4.yui-t2
-      #hd
-        %h1
-          %a{:href => "#{options[:url]}/index.html"}= options[:title]
-      #bd
-        #yui-main
-          .yui-b
-            .yui-gc
-              .yui-u.first
-                #content{:class => "#{layout_name}"}= content
-              .yui-u
-                =sidebar
-        .yui-b
-          
-      #ft
-        Generated using who-needs-wp
-          
-          
+    = content
+
+  - if options[:google_analytics] != nil and not options[:google_analytics].empty?
+    %script{:src => 'http://www.google-analytics.com/ga.js', :type => 'text/javascript'}/
+    :javascript
+      try {
+      var pageTracker = _gat._getTracker("#{options[:google_analytics]}_");
+      pageTracker._trackPageview();
+      } catch(err) {}
+
+
+

data/lib/who-needs-wp/templates/recentposts.haml

@@ -4,3 +4,5 @@
     %li
       %span.date= post[:created_at].strftime('%Y-%m-%d')
       %a.title{:href => "#{options[:url]}/#{post[:filename][:generated]}", :title => post[:title]}= post[:title]
+  %li
+    %a{:href => "#{options[:url]}/posts/all.html", :title => "All posts"} more

data/lib/who-needs-wp/templates/twitter.haml

@@ -7,4 +7,4 @@
     - tweets.each do |tweet|
       %li
         %span.date= Date.parse(tweet[:created_at]).strftime('%Y-%m-%d')
-        %span= tweet[:text]
+        %span= WhoNeedsWP::parse_tweet tweet[:text]

data/lib/who-needs-wp/twitter.rb

@@ -1,16 +1,23 @@
 
 module WhoNeedsWP
+  
+  def self.parse_tweet(text)
+    text = text.gsub(/(http:\/\/[^ ]+)/, '<a href="\1">\1</a>')
+    text = text.gsub(/(@([^ :]+))/, '<a href="http://twitter.com/\2">\1</a>')
+    return text.gsub(/(#([^ :]+))/, '<a href="http://twitter.com/#search?q=%23\2">\1</a>')
+  end
+  
   def self.twitter
-    @logger.debug @options[:twitter]
-    if @options[:twitter][:user]
+    if @options[:twitter][:user] != nil and not @options[:twitter][:user].empty?
       @logger.debug "Reading Tweets for user #{@options[:twitter][:user]}"
+      tweets = Twitter::Search.new.from(@options[:twitter][:user]).per_page(5).fetch().results
       @sidebar << @template['twitter'].render(Object.new, { 
-                                                :tweets => Twitter::Search.new.from(@options[:twitter][:user]).per_page(5).fetch().results, 
+                                                :tweets => tweets,  
                                                 :feed_title => "@#{@options[:twitter][:user]}",
                                                 :options => @options
                                               })
     end
-    if @options[:twitter][:search]
+    if @options[:twitter][:search] != nil and not @options[:twitter][:search].empty?
       @logger.debug "Searching Twitter for #{@options[:twitter][:search]}"
       @sidebar << @template['twitter'].render(Object.new, { 
                                                 :tweets => Twitter::Search.new(@options[:twitter][:search]).per_page(5).fetch().results, 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Owen Griffin
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-17 00:00:00 +00:00
+date: 2010-03-19 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -110,7 +110,7 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - lib/who-needs-wp.rb
 - lib/who-needs-wp/css.rb
@@ -122,6 +122,8 @@ files:
 - lib/who-needs-wp/stylesheets/reset-fonts-grids.sass
 - lib/who-needs-wp/stylesheets/style.sass
 - lib/who-needs-wp/templates.rb
+- lib/who-needs-wp/templates/all_posts.haml
+- lib/who-needs-wp/templates/body.haml
 - lib/who-needs-wp/templates/delicious.haml
 - lib/who-needs-wp/templates/layout.haml
 - lib/who-needs-wp/templates/page.haml
@@ -131,7 +133,7 @@ files:
 - lib/who-needs-wp/templates/twitter.haml
 - lib/who-needs-wp/twitter.rb
 - LICENSE
-- README.rdoc
+- README.md
 has_rdoc: true
 homepage: http://github.com/owengriffin/who-needs-wp
 licenses: []

data/README.rdoc

@@ -1,17 +0,0 @@
-= who-needs-wp
-
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Owen Griffin. See LICENSE for details.