fngtps-weblog 0.5.0

data/TODO

@@ -0,0 +1,5 @@
+NOTES
+
+  git config --add user.name 'Manfred Stienstra'
+  git config --add user.email 'manfred@fngtps.com'
+  gem install rdiscount erubis git json

data/bin/weblog

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+if $0 == __FILE__
+  require 'rubygems'
+  $:.unshift(File.expand_path('../../lib', __FILE__))
+end
+
+require 'weblog'
+require 'option_parser'
+
+def usage
+  puts "Usage: #{File.basename($0)} <command>"
+  puts ""
+  puts "Commands:"
+  puts "  init:     Initialize a directory for use with the weblog tool"
+  puts "  generate: Convert all Markdown source to an HTML file"
+  puts "  publish:  Move a draft directory into the public directory"
+  puts "  info:     Print information about the current working directory"
+  puts "Options:"
+  puts "  -v, --verbose: Print informative messages"
+end
+
+options     = {}
+flags, args = OptionParser.parse(ARGV)
+
+flags.each do |key, value|
+  case key
+  when 'h', 'help'
+    usage
+    exit 0
+  when 'v', 'verbose'
+    options[:verbose] = true
+  end
+end
+
+case args[0]
+when 'init'
+  Weblog.init(options)
+when 'publish'
+  Weblog.publish(options, *args[1..-1])
+when 'info'
+  Weblog.print_info(options)
+when 'help'
+  usage
+else
+  Weblog.generate(options)
+end

data/lib/option_parser.rb

@@ -0,0 +1,28 @@
+class OptionParser
+  def self.parse(argv)
+    return [{},[]] if argv.empty?
+    
+    options  = {}
+    rest     = []
+    switch   = nil
+    
+    for value in argv
+      # values is a switch
+      if value[0] == 45
+        switch = value.slice((value[1] == 45 ? 2 : 1)..-1)
+        options[switch] = nil
+      else
+        if switch
+          # we encountered a switch so this
+          # value belongs  to  that  switch
+          options[switch] = value
+          switch = nil
+        else
+          rest << value
+        end
+      end
+    end
+    
+    [options, rest]
+  end
+end

data/lib/weblog.rb

@@ -0,0 +1,155 @@
+require 'set'
+require 'time'
+require 'fileutils'
+
+require 'rdiscount'
+require 'erubis'
+require 'json'
+require 'git'
+
+class Weblog
+  autoload :Helpers, "weblog/helpers"
+  autoload :Index,   "weblog/index"
+  autoload :Month,   "weblog/month"
+  autoload :Snippet, "weblog/snippet"
+  autoload :Post,    "weblog/post"
+  
+  DIRECTORIES = %w(
+    public/javascripts
+    public/stylesheets
+    draft
+  )
+  
+  # --- Utilities
+  
+  def self.source_root
+    File.expand_path('../../', __FILE__)
+  end
+  
+  def self.template_path
+    File.join(source_root, 'templates')
+  end
+  
+  def self.find_working_directory(cwd)
+    candidate = cwd
+    while(candidate)
+      directory = File.join(candidate, 'public')
+      if File.exist?(directory)
+        return candidate
+      else
+        parts = candidate.split('/')
+        candidate = parts.empty? ? false : parts[0..-2].join('/')
+      end
+    end; nil
+  end
+  
+  def initialize(cwd, options={})
+    @options = options
+    unless @path = self.class.find_working_directory(cwd)
+      puts "[!] Please use this tool from somewhere within the working directory"
+    end
+  end
+  
+  def git
+    @git ||= Git.open(@path)
+  end
+  
+  def verbose?
+    @options[:verbose]
+  end
+  
+  # --- Attributes
+  
+  attr_accessor :path
+  
+  def title
+    @path.split('/').last.gsub(/[_-]/, ' ').capitalize
+  end
+  
+  def months
+    Month.all(self)
+  end
+  
+  def posts
+    if @posts.nil?
+      paths       = Set.new
+      base_path   = File.join(@path, 'public')
+      path_length = base_path.split('/').length
+      Dir.glob(File.join(base_path, '**/post.*')).each do |file|
+        paths << file.split('/')[path_length..-2].join('/')
+      end
+      @posts = paths.map do |path|
+        Weblog::Post.new(self, path)
+      end
+    end; @posts
+  end
+  
+  def size
+    posts.size
+  end
+  
+  def author
+    git.config('user.name')
+  end
+  
+  # --- Commands
+  
+  def index
+    Weblog::Index.new(self)
+  end
+  
+  def generate
+    posts.each { |post| post.generate }
+    months.each { |month| month.generate }
+    index.generate
+  end
+  
+  def publish(*directories)
+    year  = Time.now.year.to_s
+    month = "%02d" % Time.now.month
+    directories.each do |directory|
+      name        = directory.split('/').last
+      destination = File.join(@path, 'public', year, month, name)
+      FileUtils.mkdir_p(File.dirname(destination))
+      FileUtils.mv(directory, destination)
+    end
+  end
+  
+  def print_info
+    months.each do |month|
+      puts "#{month.path}: #{month.size} #{month.size == 1 ? 'post' : 'posts'}"
+    end
+    puts [
+      "Directory:   #{@path}",
+      "Title:       #{title}",
+      "Author:      #{author}",
+      "Total posts: #{size} #{size == 1 ? 'post' : 'posts'}"
+    ].join("\n")
+  end
+  
+  def self.init(options)
+    DIRECTORIES.each { |path| FileUtils.mkdir_p(path) }
+    unless File.exist?('templates')
+      FileUtils.cp_r(template_path, 'templates')
+      FileUtils.rm_rf('templates/.svn')
+    end
+  end
+  
+  def self.generate(options)
+    weblog = new(Dir.pwd, options)
+    weblog.generate
+    weblog
+  end
+  
+  def self.publish(options, *directories)
+    weblog = new(Dir.pwd, options)
+    weblog.publish(*directories)
+    weblog
+  end
+  
+  def self.print_info(options)
+    weblog = new(Dir.pwd, options)
+    weblog.print_info
+    weblog
+  end
+end

data/lib/weblog/helpers.rb

@@ -0,0 +1,13 @@
+class Weblog
+  module Helpers
+    def format_date(date)
+      return '' if date.nil?
+      date.strftime("%d-%m-%Y")
+    end
+    
+    def format_date_and_time(time)
+      return '' if time.nil?
+      time.strftime("#{format_date(time)}, %H:%M")
+    end
+  end
+end

data/lib/weblog/index.rb

@@ -0,0 +1,56 @@
+class Weblog
+  class Index
+    SIZE = 5
+    
+    def initialize(weblog)
+      @weblog = weblog
+    end
+    
+    def posts
+      if @posts.nil?
+        @posts = []
+        @weblog.months.reverse.each do |month|
+          month.posts.each do |post|
+            @posts << post
+            return @posts if @posts.length >= SIZE
+          end
+        end
+      end; @posts
+    end
+    
+    # --- Rendering system
+    
+    include Weblog::Helpers
+    
+    def html_template_filename
+      File.join(@weblog.path, "templates/index.html.erb")
+    end
+    
+    def feed_template_filename
+      File.join(@weblog.path, "templates/index.rss.erb")
+    end
+    
+    def render(template_filename)
+      Erubis::EscapedEruby.new(
+        File.read(template_filename)
+      ).result(binding)
+    end
+    
+    def html_filename
+      File.join(@weblog.path, 'public', 'weblog.html')
+    end
+    
+    def feed_filename
+      File.join(@weblog.path, 'public', 'weblog.rss')
+    end
+    
+    def generate
+      FileUtils.mkdir_p(File.dirname(html_filename))
+      File.open(html_filename, 'w') { |file| file.write(render(html_template_filename)) }
+      puts "Generated weblog index" if @weblog.verbose?
+      FileUtils.mkdir_p(File.dirname(feed_filename))
+      File.open(feed_filename, 'w') { |file| file.write(render(feed_template_filename)) }
+      puts "Generated weblog feed" if @weblog.verbose?
+    end
+  end
+end

data/lib/weblog/month.rb

@@ -0,0 +1,67 @@
+class Weblog
+  class Month
+    attr_accessor :year, :month
+    
+    def initialize(weblog, year, month)
+      @weblog = weblog
+      @year   = year.to_i
+      @month  = month.to_i
+      @path   = File.join(@year.to_s, ("%02d" % @month))
+    end
+    
+    attr_reader :path
+    
+    # Returns a list of posts for this month in reverse chronological order
+    def posts
+      @weblog.posts.select do |post|
+        post.path.start_with?(@path)
+      end.sort_by { |post| -post.published_at.to_i }
+    end
+    
+    def size
+      posts.size
+    end
+    
+    def self.all(weblog)
+      months = []
+      Dir.entries(File.join(weblog.path, 'public')).each do |year|
+        if year =~ /^\d{4}$/
+          Dir.entries(File.join(weblog.path, 'public', year)).each do |month|
+            if month =~ /^\d{2}$/
+              months << new(weblog, year, month)
+            end
+          end
+        end
+      end
+      months.sort_by do |month|
+        [month.year, month.month]
+      end
+    end
+    
+    # --- Rendering system
+    
+    include Weblog::Helpers
+    
+    def template_filename
+      File.join(@weblog.path, "templates/month.html.erb")
+    end
+    
+    def render
+      Erubis::EscapedEruby.new(
+        File.read(template_filename)
+      ).result(binding)
+    end
+    
+    def index_filename
+      File.join(@weblog.path, 'public', @path, 'index.html')
+    end
+    
+    def generate
+      FileUtils.mkdir_p(File.dirname(index_filename))
+      File.open(index_filename, 'w') do |file|
+        file.write(render)
+      end
+      puts "Generated #{@year}/#{"%02d" % @month}" if @weblog.verbose?
+    end
+  end
+end

data/lib/weblog/post.rb

@@ -0,0 +1,154 @@
+class Weblog
+  class Post
+    attr_accessor :path
+    
+    def initialize(weblog, path)
+      @weblog = weblog
+      @path   = path
+      @post   = self
+      _load_metadata
+    end
+    
+    # --- Metadata
+    
+    def metadata_filename
+      File.join(@weblog.path, 'public', @path, 'post.json')
+    end
+    
+    attr_writer :author
+    
+    def published_at=(published_at)
+      @published_at = Time.parse(published_at)
+    end
+    
+    def updated_at=(updated_at)
+      @updated_at = Time.parse(updated_at)
+    end
+    
+    def _load_metadata
+      JSON.parse(File.read(metadata_filename)).each do |key, value|
+        self.send("#{key}=", value)
+      end if File.exist?(metadata_filename)
+    end
+    
+    # --- Attributes
+    
+    def blob
+      if File.exist?(index_filename)
+        @blob ||= @weblog.git.gblob(index_filename)
+      end
+    end
+    
+    def last_commit
+      @last_commit ||= blob.log(1).first if blob
+    end
+    
+    def first_commit
+      @first_commit ||= blob.log(10_000).map{|l|l}.last if blob
+    end
+    
+    def modified?
+      @modified ||= @weblog.git.status.changed.any? do |filename, status|
+        snippet.filename.end_with?(filename)
+      end
+    end
+    
+    # * Author:
+    #   - When it's in the git repository: first commit author
+    #   - Otherwise: configured author
+    def _author
+      if commit = first_commit
+        first_commit.author.name
+      else
+        @weblog.author
+      end
+    end
+    
+    def author
+      @author ||= _author
+    end
+    
+    # * The created date:
+    #   - When it's not in the git repository: current date and time
+    #   - When it's in the git repository: first commit date
+    def _published_at
+      if commit = first_commit
+        commit.date
+      else
+        Time.now
+      end
+    end
+    
+    def published_at
+      @published_at ||= _published_at
+    end
+    
+    # * The updated date:
+    #   - When it's not in the git repository: nil
+    #   - When it has modifications: current date and time
+    #   - When it has no modifications: last commit date
+    def _updated_at
+      if modified?
+        Time.now
+      elsif commit = last_commit
+        commit.date
+      else
+        nil
+      end
+    end
+    
+    def updated_at
+      @updated_at ||= _updated_at
+    end
+    
+    def stylesheets
+      Dir.glob(File.join(@weblog.path, 'public', path, '*.css')).map do |path|
+        File.basename(path)
+      end
+    end
+    
+    def javascripts
+      Dir.glob(File.join(@weblog.path, 'public', path, '*.js')).map do |path|
+        File.basename(path)
+      end
+    end
+    
+    def snippet
+      @snippet ||= Snippet.new(@weblog, self, File.join('public', path))
+    end
+    
+    def title
+      snippet.title.strip
+    end
+    
+    def content
+      snippet.content
+    end
+    
+    # --- Rendering system
+    
+    include Weblog::Helpers
+    
+    def template_filename
+      File.join(@weblog.path, "templates/post.html.erb")
+    end
+    
+    def render
+      Erubis::EscapedEruby.new(
+        File.read(template_filename)
+      ).result(binding)
+    end
+    
+    def index_filename
+      File.join(@weblog.path, 'public', @path, 'index.html')
+    end
+    
+    def generate
+      FileUtils.mkdir_p(File.dirname(index_filename))
+      File.open(index_filename, 'w') do |file|
+        file.write(render)
+      end
+      puts "Generated #{path}" if @weblog.verbose?
+    end
+  end
+end

data/lib/weblog/snippet.rb

@@ -0,0 +1,51 @@
+class Weblog
+  class Snippet
+    attr_accessor :path, :filename
+    
+    def initialize(weblog, object, path)
+      @weblog = weblog
+      @path   = path
+      find_snippet_file
+    end
+    
+    def candidates
+      %w(post.md post.html).map do |name|
+        File.join(@weblog.path, @path, name)
+      end
+    end
+    
+    def find_snippet_file
+      @filename = candidates.detect do |filename|
+        File.exist?(filename)
+      end
+    end
+    
+    def source_type
+      @filename.end_with?('.md') ? :markdown : :html
+    end
+    
+    def read
+      @read ||= File.read(filename).split("\n")
+    end
+    
+    def title
+      return '' if read.empty?
+      case source_type
+      when :markdown
+        /^#(.*)$/.match(read[0])[1]
+      when :html
+        /<h1>(.*)<\/h1>/.match(read[0])[1]
+      end
+    end
+    
+    def content
+      return '' if read.empty?
+      case source_type
+      when :markdown
+        RDiscount.new(read[1..-1].join("\n")).to_html
+      when :html
+        read[1..-1].join("\n")
+      end
+    end
+  end
+end

data/templates/index.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title><%= @weblog.title %></title>
+<meta charset="utf-8" />
+</head>
+<body>
+<% posts.each do |post| %>
+  <h1><a href="<%= post.path %>"><%= post.title %></a></h1>
+  <%== post.content %>
+<% end %>
+</body>
+</html>

data/templates/index.rss.erb

@@ -0,0 +1,23 @@
+<?xml version="1.0"?>
+<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
+  <channel>
+    <title><%= @weblog.title %></title>
+    <atom:id>http://www.fngtps.com/index.rss</atom:id>
+    <atom:link rel="self" type="application/rss+xml" href="http://www.fngtps.com/index.rss"/>
+    <link>http://www.fngtps.com/index.rss</link>
+    <description>Recent posts on ‘Fingertips’</description>
+    <% unless posts.empty? %>
+    <lastBuildDate><%= (posts.first.updated_at || posts.first.published_at).rfc822 %></lastBuildDate>
+    <% end %>
+    <% posts.each do |post| %><% if post.published_at %>
+      <item>
+        <title><%= post.title %></title>
+        <link>http://www.fngtps.com/<%= post.path %></link>
+        <description><%= post.content %></description>
+        <pubDate><%= post.published_at.rfc822 %></pubDate>
+        <atom:updated><%= (post.updated_at || post.published_at).rfc822 %></atom:updated>
+        <guid>http://www.fngtps.com/<%= post.path %></guid>
+      </item>
+    <% end %><% end %>
+  </channel>
+</rss>

data/templates/month.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title><%= @weblog.title %></title>
+<meta charset="utf-8" />
+</head>
+<body>
+<% posts.each do |post| %>
+  <h1><a href="<%= post.path.split('/').last %>"><%= post.title %></a></h1>
+  <%== post.content %>
+<% end %>
+</body>
+</html>

data/templates/post.html.erb

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title><%= @weblog.title %></title>
+<meta charset="utf-8" />
+<% @post.stylesheets.each do |path| %>
+<link rel="stylesheet" href="<%= path %>" />
+<% end %>
+</head>
+<body>
+<h1><%= @post.title %></h1>
+<%== @post.content %>
+<p><%= @post.author %>, <%= format_date(@post.published_at) %><% if @post.updated_at %>, updated at <%= format_date_and_time(@post.updated_at) %><% end %></p>
+<% @post.javascripts.each do |path| %>
+<script src="<%= path %>" type="text/javascript"></script>
+<% end %>
+</body>
+</html>

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification 
+name: fngtps-weblog
+version: !ruby/object:Gem::Version 
+  hash: 11
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
+platform: ruby
+authors: 
+- Manfred Stienstra
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-18 00:00:00 +01:00
+default_executable: weblog
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: erubis
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: git
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: test-spec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: Weblog tools.
+email: manfred@fngtps.com
+executables: 
+- weblog
+extensions: []
+
+extra_rdoc_files: 
+- TODO
+files: 
+- bin/weblog
+- lib/option_parser.rb
+- lib/weblog.rb
+- lib/weblog/helpers.rb
+- lib/weblog/index.rb
+- lib/weblog/month.rb
+- lib/weblog/post.rb
+- lib/weblog/snippet.rb
+- templates/index.html.erb
+- templates/index.rss.erb
+- templates/month.html.erb
+- templates/post.html.erb
+- TODO
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Weblog tools.
+test_files: []
+