who-needs-wp 0.5.1 → 0.5.2

data/README.html

@@ -0,0 +1,132 @@
+<h1>who-needs-wp</h1>
+
+<p><em>Who needs Wordpress?</em></p>
+
+<p>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?</p>
+
+<p>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.</p>
+
+<p>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. </p>
+
+<p>This has the advantage of serving web pages faster; I use less hosting space; and I cut any unnecessary features which Wordpress provides.</p>
+
+<p>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! ;-)</p>
+
+<h2>Getting Started</h2>
+
+<p>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:</p>
+
+<pre><code>sudo apt-get install ruby ruby-dev rubygems
+</code></pre>
+
+<p>You then need to install who-needs-wp by running the following:</p>
+
+<pre><code>sudo gem install who-needs-wp
+</code></pre>
+
+<p>Ensure that Ruby gems is in your <code>PATH</code> variable by opening <code>~/.bashrc</code> and entering:</p>
+
+<pre><code>export PATH=/var/lib/gems/1.8/bin:$PATH
+</code></pre>
+
+<p>You'll need to re-load the <code>.bashrc</code> file by using the following command:</p>
+
+<pre><code>. ~/.bashrc
+</code></pre>
+
+<p>Now create a folder which will host your web site</p>
+
+<pre><code>mkdir /var/www/website/
+</code></pre>
+
+<p>who-needs-wp stores posts in the <code>posts/</code> folder followed by a folder representing the date of the post. i.e. <code>posts/year/month/day</code>.</p>
+
+<p>Create an example post by creating a folder and creating a Markdown file.</p>
+
+<pre><code>mkdir /var/www/website/posts/2010/03/15/ --parents
+gedit /var/www/website/posts/2010/03/15/An_example_post.markdown
+</code></pre>
+
+<p>The filename will be used as the title for the page - all the underscores will be replaced with spaces.</p>
+
+<p>Along with <a href="http://daringfireball.net/projects/markdown/syntax">Markdown Syntax</a> you can also specify the author of the blog post within the file:</p>
+
+<pre><code>Author: Your Name
+</code></pre>
+
+<p>Before it can generate the site who-needs-wp needs to be configured. Copy the following into <code>/var/www/website/.who-needs-wp.yaml</code></p>
+
+<pre><code>--- 
+:url: /website/test
+:title: An example blog
+:author: Your Name
+</code></pre>
+
+<p>These are the properties which are used to generate the website:</p>
+
+<ul>
+<li><code>url</code> - The base URL of the website</li>
+<li><code>title</code> - A title for the index of your site</li>
+<li><code>author</code> - When a author is not specified within the post this author is displayed</li>
+</ul>
+
+<p>Now you can generate your site:</p>
+
+<pre><code>who-needs-wp .
+</code></pre>
+
+<p>And view the blog at the following URL:</p>
+
+<pre><code>http://localhost/website/
+</code></pre>
+
+<h2>Overriding Templates</h2>
+
+<p>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 <code>templates</code> folder. You can copy the existing templates from the gem as a starting point. The templates are stored within the <code>/var/lib/gems/1.8/gems/who-needs-wp-0.1.0/lib/who-needs-wp/templates/</code>. </p>
+
+<h2>Applying alternative styles</h2>
+
+<p>You can specify an additional stylesheet by using the <code>-s</code> or <code>--stylesheet</code> option to the who-needs-wp command.</p>
+
+<h2>Twitter</h2>
+
+<p>who-needs-wp can place a <a href="http://twitter.com/">Twitter</a> stream in the side bar. This can either be a search or an individual user's feed.</p>
+
+<p>Modifying <code>.who-needs-wp.yaml</code> and add:</p>
+
+<pre><code>:twitter:
+  :user: &lt;your twitter user&gt;
+  :search: &lt;your twitter search&gt;
+</code></pre>
+
+<h2>Delicious</h2>
+
+<p>who-needs-wp can also display a list of bookmarks from <a href="http://del.icio.us/">Delicious</a>. Modify <code>.who-needs-wp.yaml</code> and add:</p>
+
+<pre><code>:delicious:
+  :user: &lt;your delicious username&gt;
+</code></pre>
+
+<h2>Google Analytics</h2>
+
+<p>To enable Google Analytics you need to specify your web property ID in <code>.who-needs-wp.yaml</code>. For example:</p>
+
+<pre><code>:google_analytics: UA-XXXXXXXX
+</code></pre>
+
+<h2>Syntax Highlighting</h2>
+
+<p>who-needs-wp will syntax highlight your code snippets using <a href="http://github.com/nakajima/makers-mark">Makers-Mark</a> and <a href="http://pygments.org/">Pygments</a></p>
+
+<h2>Migration from Wordpress</h2>
+
+<p>Packaged with who-needs-wp is a simple script called wordpress2wnwp which aids migrating from Wordpress. wordpress2wnwp exports posts from a MySQL database and outputs them in the who-needs-wp filing structure. It also generates Apache2 <code>RewriteRule</code>s which rewrite any Wordpress URLs to who-needs-wp.</p>
+
+<p>To find more information on wordpress2wnwp enter the following command:</p>
+
+<pre><code>wordpress2wnwp -h
+</code></pre>
+
+<h3>Copyright</h3>
+
+<p>Copyright (c) 2010 Owen Griffin. See LICENSE for details.</p>

data/README.md

@@ -101,7 +101,10 @@ To enable Google Analytics you need to specify your web property ID in `.who-nee
 
 ## Syntax Highlighting
 
-who-needs-wp will syntax highlight your code snippets using [Makers-Mark][MakersMark] and [Pygments][Pygments]
+who-needs-wp will syntax highlight your code snippets using [Makers-Mark][MakersMark] and [Pygments][Pygments]. You will need to ensure that Pygments is installed.
+
+    sudo apt-get install python-setuptools
+    sudo easy_install pygments
 
 ## Migration from Wordpress
 

data/bin/who-needs-wp

@@ -47,6 +47,17 @@ Choice.options do
     default options[:author]
   end
 
+  option :upload do
+    short '-u'
+    long '--upload'
+    desc 'Upload the output to an FTP address.'
+  end
+
+  option :remote_addr do
+    long '--remote-addr=username'
+    desc "Location to upload the output. To enable specify the --upload option. (Default: \"#{options[:ftp]}\")"
+  end
+
   option :help do
     long '--help'
     desc 'Show this message'

data/bin/wordpress2wnwp

@@ -98,7 +98,7 @@ class Wordpress2WNWP
 
   # Returns a list of parent post identifiers
   def self.parent_posts
-    results = @database.query("SELECT DISTINCT post_parent FROM #{@table_name}")
+    results = @database.query("SELECT id FROM #{@table_name} WHERE post_type ='post'")
     posts = []
     while row = results.fetch_row do
       posts << row[0]
@@ -110,14 +110,14 @@ class Wordpress2WNWP
   def self.latest_posts(parents)
     posts = []
     parents.each do |post_id|
-      results = @database.query("SELECT post_title, post_date, post_content FROM #{@table_name} WHERE post_parent = '#{post_id}' ORDER BY ID DESC LIMIT 1")
+      results = @database.query("SELECT post_title, post_date, post_content FROM #{@table_name} WHERE post_parent = '#{post_id}' AND post_type='revision' ORDER BY ID DESC LIMIT 1")
       row = results.fetch_row
       posts << {
         :id => post_id,
         :title => row[0],
         :date => Date.parse(row[1]),
         :content => row[2]
-      }
+      } if row != nil
     end
     return posts
   end
@@ -137,16 +137,31 @@ class Wordpress2WNWP
 
   # Generate a list of Apache2 rewrite rules
   def self.generate_rewrites(posts)
-    puts "Re-write rules for Apache2:"
-    posts.each do |post|
-      results = @database.query("SELECT guid FROM #{@table_name} WHERE post_parent='#{post[:id]}'")
-      while row = results.fetch_row do
-        if row[0] =~ /p=([0-9]+)/
-          guid = $1
-          puts "RewriteCond %{QUERY_STRING} p=#{guid}"
-          puts "RewriteRule ^#{@options[:url]}$ #{@options[:url]}posts/#{post[:filename]} [L]"
+    File.open('.htaccess', 'w') do |file|
+      # Set up redirects
+      file.puts "RewriteEngine On"
+      base = @options[:url]
+      base = '/' if base.empty?
+      file.puts "RewriteBase #{base}"
+
+      # Re-write for RSS 2.0 feed
+      file.puts "RewriteCond %{QUERY_STRING} ^feed=rss2$"
+      file.puts "RewriteRule ^.*$ #{@options[:url]}/posts.rss?feed= [L]"
+      # Rewrites for all posts
+      posts.each do |post|
+        file.puts "RewriteCond %{QUERY_STRING} ^p=#{post[:id]}$"
+        file.puts "RewriteRule ^.*$ #{@options[:url]}/posts/#{post[:filename]}?p= [L]"
+        results = @database.query("SELECT guid FROM #{@table_name} WHERE post_parent='#{post[:id]}'")
+        while row = results.fetch_row do
+          if row[0] =~ /p=([0-9]+)/
+            guid = $1
+            file.puts "RewriteCond %{QUERY_STRING} ^p=#{guid}$"
+            file.puts "RewriteRule ^.*$ #{@options[:url]}/posts/#{post[:filename]}?p= [R,L]"
+          end
         end
+
       end
+
     end
   end
 end

data/bin/wordpress2wnwp~

@@ -0,0 +1,6 @@
+#!/bin/ruby
+
+prefix = ARGV[3]
+DB = Sequel.connect('postgres://localhost/#{ARGV[0]}?user=#{ARGV[1]}&password=#{ARGV[2]}')
+
+dataset = DB.from('wp_#{prefix}_posts')

data/lib/who-needs-wp.rb

@@ -1,3 +1,4 @@
+# -*- coding: undecided -*-
 require 'rubygems'
 require 'rdiscount'
 require 'haml'
@@ -8,6 +9,8 @@ require 'sass'
 require 'makers-mark'
 require 'logger'
 require 'rss/maker'
+require 'net/ssh'
+require 'net/sftp'
 require 'who-needs-wp/css.rb'
 require 'who-needs-wp/twitter.rb'
 require 'who-needs-wp/delicious.rb'
@@ -28,13 +31,16 @@ module WhoNeedsWP
   # Generate the site with the specified options
   def self.generate(options)
     @options = options
+    if @options[:url] == '/'
+      @options[:url] = ''
+    end
     self.load_templates
     self.load_posts
     self.load_pages
     self.recentposts
     self.page_index
- #   self.twitter
- #   self.delicious
+    self.twitter
+    self.delicious
     self.generate_posts
     self.generate_pages
     self.index
@@ -42,6 +48,9 @@ module WhoNeedsWP
     self.css
     self.rss("posts.rss")
     self.atom("posts.atom")
+    if @options[:upload] 
+      self.upload
+    end
   end
 
   # Generate the index page for the blog
@@ -64,4 +73,66 @@ module WhoNeedsWP
                                                                               :options => @options
                                                                             }), "All Posts")
   end
+
+  def self.upload
+    match = @options[:remote_addr].match(/(.*)@(.*):(.*)/)
+    username = match[1]
+    host = match[2]
+    remote_path = match[3]
+    # Replace the tilda with the full path for home
+    remote_path = "/home/#{username}/" + remote_path[1..remote_path.length] if remote_path =~ /^~.*$/
+    local_path = Dir.pwd
+    permissions = {
+      :directory => 0755,
+      :file => 0644
+    }
+    Net::SFTP.start(host, username) do |sftp|
+      Dir.glob("**/*") do |filename|
+        basename = File.basename(filename)
+        if basename =~ /^\..*$/ or 
+            basename =~ /.*\.markdown$/ or 
+            basename =~ /^.*~$/ or 
+            basename =~ /^\#.*\#$/
+          @logger.debug "Skipping #{filename}"
+        else
+          remote_filename = remote_path + filename.sub(local_path, '')
+          @logger.debug "Remote filename = #{remote_filename}"
+          
+          # If the directory does not exist then create it
+          begin
+            if File.directory? filename
+              remote_directory = remote_filename
+            else
+              remote_directory = File.dirname(remote_filename)
+            end
+            sftp.stat!(remote_directory)
+          rescue Net::SFTP::StatusException
+            @logger.debug "#{remote_directory} does not exist"
+            sftp.mkdir!(remote_directory, :permissions => permissions[:directory])
+          end
+
+          if not File.directory? filename
+          # If the file does not exist then create it
+          begin
+            status = sftp.stat!(remote_filename)
+          rescue Net::SFTP::StatusException
+            @logger.debug "#{remote_filename} does not exist"
+            sftp.upload!(filename, remote_filename)
+            sftp.setstat(remote_filename, :permissions => permissions[:file])
+            next
+          end
+
+          # If the local file has changed then upload it
+          if File.stat(filename).mtime > Time.at(status.mtime)
+            @logger.debug "Copying #{filename} to #{remote_filename}"
+            sftp.upload!(filename, remote_filename)
+          else
+            @logger.debug "Skipping #{filename}"
+          end
+          end
+        end
+      end
+      @logger.debug "Disconnecting from remote server"
+    end
+  end
 end

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

@@ -3,7 +3,7 @@
   %h2.title
     %a{:href => "#{options[:url]}/#{post[:filename][:generated]}"}= post[:title]
   .date
-    = post[:created_at].strftime('%Y-%m-%d')
+    = post[:created_at].strftime("%B %d, %Y") 
   .author
     by
     = post[:author]

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 5
-  - 1
-  version: 0.5.1
+  - 2
+  version: 0.5.2
 platform: ruby
 authors: 
 - Owen Griffin
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-26 00:00:00 +00:00
+date: 2010-03-27 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -118,12 +118,14 @@ dependencies:
 description: A static web site generator.
 email: owen.griffin@gmail.com
 executables: 
+- wordpress2wnwp~
 - wordpress2wnwp
 - who-needs-wp
 extensions: []
 
 extra_rdoc_files: 
 - LICENSE
+- README.html
 - README.md
 files: 
 - lib/who-needs-wp.rb
@@ -149,6 +151,7 @@ files:
 - lib/who-needs-wp/templates/twitter.haml
 - lib/who-needs-wp/twitter.rb
 - LICENSE
+- README.html
 - README.md
 has_rdoc: true
 homepage: http://github.com/owengriffin/who-needs-wp