who-needs-wp 0.4.0 → 0.5.0

data/README.md

@@ -13,11 +13,11 @@ The main disadvantage is that user's aren't able to comment on my posts - but th
 
 ## 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:
+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:
+You then need to install who-needs-wp by running the following:
 
     sudo gem install who-needs-wp
     
@@ -33,7 +33,7 @@ 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`.
+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.
 
@@ -46,7 +46,7 @@ Along with [Markdown Syntax][MarkdownSyntax] you can also specify the author of
 
     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`
+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
@@ -69,15 +69,15 @@ And view the blog at the following URL:
 
 ## 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/`. 
+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.
+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.
+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:
 
@@ -87,7 +87,7 @@ Modifying `.who-needs-wp.yaml` and add:
       
 ## Delicious
 
-`who-needs-wp` can also display a list of bookmarks from [Delicious][Delicious]. Modify `.who-needs-wp.yaml` and add:
+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>
@@ -101,11 +101,15 @@ 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]
 
 ## Migration from Wordpress
 
-A simple script is in development which will convert a MySQL database to seperate Markdown pages.
+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 `RewriteRule`s which rewrite any Wordpress URLs to who-needs-wp.
+
+To find more information on wordpress2wnwp enter the following command:
+
+    wordpress2wnwp -h
 
 ### Copyright
 

data/bin/who-needs-wp

@@ -2,24 +2,69 @@
 $: << File.expand_path(File.dirname(__FILE__) + "/../lib")
 
 require 'rubygems'
+require 'choice'
 require 'who-needs-wp.rb'
-require 'optparse'
-
-options = {}
-OptionParser.new do |opts|
-  opts.banner = "Usage: who-needs-wp [options]"
-  
-  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
-    options[:verbose] = v
+
+PROGRAM_VERSION = "0.5.0"
+
+if File.exists? ".who-needs-wp.yaml"
+  options = YAML.load_file('.who-needs-wp.yaml') 
+else
+  options = {}
+end
+
+Choice.options do
+  header 'A static web site generator. Generates a blog based on Markdown-formatted documents.'
+  header ''
+  header 'Options are initially read from .who-needs-wp.yaml and over-written by any of the following.'
+  header ''
+
+  option :stylesheet do
+    short '-s'
+    long '--stylesheet=STYLESHEET'
+    desc "A CSS file which will be included in every page generated. (Default: \"#{options[:stylesheet]}\")"
+    default options[:stylesheet]
+  end
+
+  option :url do
+    short '-u'
+    long '--url-prefix=URL'
+    desc "Prefix any generated link with the specified URL. (Default: \"#{options[:url]}\")"
+    default options[:url]
   end
 
-  opts.on('-s', '--stylesheet STYLESHEET', 'Include STYLESHEET in the output') do |stylesheet|
-    options[:stylesheet] = stylesheet
+  option :title do
+    short '-t'
+    long '--title=TITLE'
+    desc "Title of the blog (Default: \"#{options[:title]}\")"
+    default options[:title]
   end
 
-  opts.on('-p', '--url-prefix PATH', 'Prefix all urls with PATH') do |url|
-    options[:url] = url
+  option :author do
+    short '-a'
+    long '--author=AUTHOR'
+    desc "Author of the blog (Default: \"#{options[:author]}\")"
+    default options[:author]
   end
-end.parse!
 
-WhoNeedsWP::generate(YAML.load_file('.who-needs-wp.yaml').merge(options))
+  option :help do
+    long '--help'
+    desc 'Show this message'
+  end
+
+  option :version do
+    short '-v'
+    long '--version'
+    desc 'Show version'
+    action do
+      puts "v#{PROGRAM_VERSION}"
+      exit
+    end
+  end
+
+end
+
+Choice.choices.each do |key, value|
+  options[key.to_sym] = value
+end
+WhoNeedsWP::generate(options)

data/bin/wordpress2wnwp

@@ -3,38 +3,152 @@
 require 'rubygems'
 require 'sequel'
 require 'logger'
-
 require 'mysql'
 require 'ftools'
+require 'choice'
 
+PROGRAM_VERSION=0.1
 
-database = ARGV[0]
-user = ARGV[1]
-password = ARGV[2]
-prefix = ARGV[3]
+Choice.options do
+  header 'Converts a MySQL Wordpress database to a blog in who-needs-wp format.'
+  header ''
+  header 'Database options:'
+  
+  option :host do
+    short '-h'
+    long '--host=HOST'
+    desc 'Hostname or IP of the MySQL server to connect to (default 127.0.0.1)'
+    default '127.0.0.1'
+  end
+  
+  option :database do
+    short '-d'
+    long '--database=DATABASE'
+    desc 'Name of the database to use (default wordpress)'
+    default 'wordpress'
+  end
 
-dbh = Mysql.real_connect("localhost", user, password, database)
-res = dbh.query("SELECT DISTINCT post_parent FROM wp_#{prefix}_posts")
-posts = []
-while row = res.fetch_row do
-  posts << row[0]
-end
-puts posts.inspect
-posts0 = []
-posts.each do |post_id|
-  res = dbh.query("SELECT post_title, post_date, post_content FROM wp_#{prefix}_posts WHERE post_parent ='#{post_id}' ORDER BY ID DESC LIMIT 1")
-  row = res.fetch_row
-  posts0 << {
-    :id => post_id,
-    :title => row[0],
-    :date => Date.parse(row[1]),
-    :content => row[2]
-  }
+  option :username do
+    short '-u'
+    long '--username=USER'
+    desc 'Name of the MySQL user to use (default wordpress)'
+    default 'wordpress'
+  end
+
+  option :password do
+    short '-p'
+    long '--password=PASSWORD'
+    desc 'Password for the MySQL user'
+  end
+
+  option :prefix do
+    long '--prefix=PREFIX'
+    desc 'Prefix for all Wordpress table names'
+    default ''
+  end
+
+  separator ''
+  separator 'Blog options: '
+
+  option :url do
+    long '--url=URL'
+    desc 'URL for new who-needs-wp blog (used for redirects)'
+    default '/'
+  end
+
+  separator ''
+  separator 'Common options: '
+  
+  option :help do
+    long '--help'
+    desc 'Show this message'
+  end
+
+  option :version do
+    short '-v'
+    long '--version'
+    desc 'Show version'
+    action do
+      puts "wordpress2wnwp Wordpress MySQL database converter v#{PROGRAM_VERSION}"
+      exit
+    end
+  end
 end
-posts0.each do |post|
-  dir = "#{post[:date].strftime('%Y')}/#{post[:date].strftime('%m')}/#{post[:date].strftime('%d')}"
-  File.makedirs dir
-  File.open(dir + "/" + post[:title].gsub(/ /, '_') + ".markdown", "w") do |file|
-    file.puts post[:content]
+
+class Wordpress2WNWP
+  # Convert a database given the options provided
+  def self.convert(options)
+    @options = options
+    if @options[:prefix].empty?
+      @table_name = "wp_posts"
+    else
+      @table_name = "wp_#{@options[:prefix]}_posts"
+    end    
+    self.connect
+    parents = self.parent_posts
+    posts = self.latest_posts(parents)
+    self.generate_posts(posts)
+    self.generate_rewrites(posts)
+  end
+  
+  # Connect to a MySQL database
+  def self.connect
+    @database = Mysql.real_connect(@options[:host], @options[:username], @options[:password], @options[:database])
+  end
+
+  # Returns a list of parent post identifiers
+  def self.parent_posts
+    results = @database.query("SELECT DISTINCT post_parent FROM #{@table_name}")
+    posts = []
+    while row = results.fetch_row do
+      posts << row[0]
+    end
+    return posts
+  end
+
+  # Returns the latest post from a given list of parent post identifiers
+  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")
+      row = results.fetch_row
+      posts << {
+        :id => post_id,
+        :title => row[0],
+        :date => Date.parse(row[1]),
+        :content => row[2]
+      }
+    end
+    return posts
+  end
+
+  # Given a list of posts generate the required Markdown files
+  def self.generate_posts(posts)
+    posts.each do |post|
+      directory = "#{post[:date].strftime('%Y')}/#{post[:date].strftime('%m')}/#{post[:date].strftime('%d')}"
+      File.makedirs directory
+      filename = directory + "/" + post[:title].gsub(/ /, '_')
+      post[:filename] = filename + ".html"
+      File.open(filename + ".markdown", "w") do |file|
+        file.puts post[:content]
+      end
+    end
+  end
+
+  # 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]"
+        end
+      end
+    end
   end
 end
+
+Wordpress2WNWP::convert(Choice.choices)

data/lib/who-needs-wp.rb

@@ -7,7 +7,7 @@ require 'open-uri'
 require 'sass'
 require 'makers-mark'
 require 'logger'
-
+require 'rss/maker'
 require 'who-needs-wp/css.rb'
 require 'who-needs-wp/twitter.rb'
 require 'who-needs-wp/delicious.rb'
@@ -33,13 +33,15 @@ module WhoNeedsWP
     self.load_pages
     self.recentposts
     self.page_index
-    self.twitter
-    self.delicious
+ #   self.twitter
+ #   self.delicious
     self.generate_posts
     self.generate_pages
     self.index
     self.all_posts
     self.css
+    self.rss("posts.rss")
+    self.atom("posts.atom")
   end
 
   # Generate the index page for the blog

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

@@ -6,15 +6,23 @@ module WhoNeedsWP
       @logger.debug "Loading post #{filename}"
       match = filename.match(/([0-9]{4})\/([0-9]{2})\/([0-9]{2})\/([^\.]*)/)
       date = DateTime.new(match[1].to_i, match[2].to_i, match[3].to_i)
-      @POSTS << {
+      generated_filename = File.dirname(filename) + "/" + File.basename(filename, ".markdown") + ".html" 
+      post = {
         :filename => { 
           :original => filename,
-          :generated => File.dirname(filename) + "/" + File.basename(filename, ".markdown") + ".html"
+          :generated => generated_filename,
         },
         :title => match[4].gsub(/_/, ' '),
         :created_at => date
       }
+      # Generate a unique post ID to be used in the Atom feed
+      post[:id] = "#{options[:url]}#{generated_filename}".gsub!(/http:\/\//, 'tag:')
+      match = post[:id].match(/([^\/]*)\/(.*)/)
+      post[:id] = "#{match[1]},#{date.strftime('%Y-%m-%d')}:#{match[2]}" if match
+      # Append the post to the global list of posts
+      @POSTS << post
     end
+    # Sort the posts, newest first
     @POSTS.sort! { |a, b| a[:created_at] <=> b[:created_at] }
     @POSTS.reverse!
   end
@@ -27,6 +35,32 @@ module WhoNeedsWP
                                                })
   end
 
+  def self.options
+    return @options
+  end
+
+  def self.POSTS
+    return @POSTS
+  end
+
+  def self.rss(filename, limit=10)
+    file = File.open(filename, "w")
+    file.write @template['rss'].render(Object.new, { 
+                                                 :posts => @POSTS[0..limit], 
+                                                 :options => @options
+                                               })
+    file.close
+  end
+
+  def self.atom(filename, limit=10)
+    file = File.open(filename, "w")
+    file.write @template['atom'].render(Object.new, { 
+                                                 :posts => @POSTS[0..limit], 
+                                                 :options => @options
+                                               })
+    file.close
+  end
+
   def self.generate_posts
     @POSTS.each_index do |index|
       # Calculate the previous and next posts
@@ -57,6 +91,9 @@ module WhoNeedsWP
                                                :next_post => next_post,
                                                :previous_post => previous_post
                                              })
+      # Set the summary of the post to be the first paragraph
+      post[:summary] = $1 if post[:html] =~ (/(?:<p>)(.*?)(?:<\/p>)/)
+      
       # Render the post as HTML
       self.render_html(post[:filename][:generated], "post", post[:html], post[:title])
     end

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

@@ -0,0 +1,19 @@
+!!! XML utf-8
+%feed{:xmlns => "http://www.w3.org/2005/Atom"}
+  %title= options[:title]
+  %id= "#{options[:url]}posts.atom"
+  %updated= "#{Time.now.xmlschema}"
+  %author
+    %name= options[:author]
+  %link{:href => "#{options[:url]}"}/
+  - posts.each do |post|
+    %entry
+      %title= post[:title]
+      %id= post[:id]
+      %updated= Time.parse(post[:created_at].to_s).xmlschema
+      %link{:href => "#{options[:url]}/#{post[:filename][:generated]}"}/
+      %content{:type => "text/html", :src => "#{options[:url]}/#{post[:filename][:generated]}"}/
+      %summary{:type => "html"}
+        :cdata
+          #{post[:summary]}
+        

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

@@ -2,6 +2,8 @@
 %html
   %head
     %link{:rel => "stylesheet", :type => "text/css", :href => "#{options[:url]}/style.css"}/
+    %link{:rel => "alternate", :type => "application/atom+xml", :href => "#{options[:url]}/posts.atom", :title => "#{options[:title]} - Atom"}/
+    %link{:rel => "alternate", :type => "application/rss+xml", :href => "#{options[:url]}/posts.rss", :title => "#{options[:title]} - RSS"}/
     %title
       = options[:title]
       - if defined? title and title != nil and not title.empty?

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

@@ -0,0 +1,15 @@
+!!! XML iso-8859-1
+%rss{:version => "2.0"}
+  %channel
+    %title= options[:title]
+    %description= options[:description]
+    %link= options[:url]
+    - posts.each do |post|
+      %item
+        %title= post[:title]
+        %link= "#{options[:url]}/#{post[:filename][:generated]}"
+        %guid= "#{options[:url]}/#{post[:filename][:generated]}"
+        %pubDate= Time.parse(post[:created_at].to_s).rfc822
+        %description
+          :cdata
+            #{post[:summary]}

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Owen Griffin
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-19 00:00:00 +00:00
+date: 2010-03-24 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -101,6 +101,20 @@ dependencies:
         version: 0.1.1
   type: :runtime
   version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: choice
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 4
+        version: 0.1.4
+  type: :runtime
+  version_requirements: *id007
 description: A static web site generator.
 email: owen.griffin@gmail.com
 executables: 
@@ -123,6 +137,7 @@ files:
 - 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/atom.haml
 - lib/who-needs-wp/templates/body.haml
 - lib/who-needs-wp/templates/delicious.haml
 - lib/who-needs-wp/templates/layout.haml
@@ -130,6 +145,7 @@ files:
 - lib/who-needs-wp/templates/pageindex.haml
 - lib/who-needs-wp/templates/post.haml
 - lib/who-needs-wp/templates/recentposts.haml
+- lib/who-needs-wp/templates/rss.haml
 - lib/who-needs-wp/templates/twitter.haml
 - lib/who-needs-wp/twitter.rb
 - LICENSE