zenweb 2.18.1 → 3.0.0.b1

data/lib/zenweb/plugins/disqus.rb

@@ -0,0 +1,18 @@
+class Zenweb::Page
+
+  ##
+  # Returns a javascript blob to add a disqus comments block to the page.
+
+  def disqus shortname
+    '<div id="disqus_thread"></div>' +
+      run_js_script("http://#{shortname}.disqus.com/embed.js")
+  end
+
+  ##
+  # Returns a javascript blob to convert properly formatted links to
+  # disqus comment counts.
+
+  def disqus_counts shortname
+    run_js_script "http://#{shortname}.disqus.com/count.js"
+  end
+end

data/lib/zenweb/plugins/erb.rb

@@ -0,0 +1,43 @@
+class Zenweb::Page
+  ##
+  # Render a page's erb and return the result
+
+  def render_erb page, content
+    erb body, self, binding
+  end
+
+  ##
+  # Render erb in +content+ for +source+ with +binding.
+  #
+  # Personally, I find erb's delimiters a bit annoying, so for now,
+  # I've added additional gsub's to the content to make it a bit more
+  # palatable.
+  #
+  #     {{ ... }} becomes <%= ... %>
+  #     {% ... %} becomes <%  ... %>
+  #
+  # Unfortunately, those are the delimiters from liquid, so if someone
+  # goes and makes a liquid plugin it could clash. But why you'd have
+  # liquid and erb on the same file is beyond me... so it prolly won't
+  # become a legitimate issue.
+
+  def erb content, source, binding = TOPLEVEL_BINDING
+    require 'erb'
+    extend ERB::Util
+
+    unless defined? @erb then
+      content = content.
+        gsub(/\{\{/, "<%=").
+        gsub(/\}\}/, "%>").
+        gsub(/\{%/,  "<%").
+        gsub(/%\}/,  "%>").
+        gsub(/\\([{}%])/, '\1')
+
+      @erb = ERB.new(content, nil, "-")
+    end
+
+    @erb.filename = source.inspect
+    @erb.result binding
+  end
+end # erb
+

data/lib/zenweb/plugins/google.rb

@@ -0,0 +1,20 @@
+class Zenweb::Page
+  ##
+  # Returns a javascript blob to add a google ad to the page. You need
+  # to provide the configuration param "google_ad_client" to your site
+  # config for this to work.
+
+  def google_ad slot, width = 468, height = 60
+    <<-"EOM".gsub(/^ {6}/, '')
+      <script><!--
+      google_ad_client = "#{self["google_ad_client"]}";
+      google_ad_slot   = "#{slot}";
+      google_ad_width  = #{width};
+      google_ad_height = #{height};
+      //-->
+      </script>
+      <script src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
+      </script>
+    EOM
+  end
+end # google

data/lib/zenweb/plugins/less.rb

@@ -0,0 +1,10 @@
+class Zenweb::Page
+  ##
+  # Render less source to css.
+
+  def render_less page, content
+    require "less"
+
+    Less::Engine.new(content || body).to_css
+  end
+end

data/lib/zenweb/plugins/markdown.rb

@@ -0,0 +1,121 @@
+class Zenweb::Page
+  KRAMDOWN_CONFIG = { # :nodoc:
+    :toc_levels    => '2..4',
+
+    :coderay_wrap               => :div,
+    :coderay_line_numbers       => :table,
+    :coderay_tab_width          => 4,
+    :coderay_css                => :class,
+    # TODO: turn off smart quotes
+  }
+
+  ##
+  # Render markdown page content using kramdown.
+
+  def render_md page, content
+    markdown(content || self.body) # HACK
+  end
+
+  ##
+  # Render markdown content.
+  #
+  # I cheated and added some additional gsubs. I prefer "``` lang" so
+  # that works now.
+
+  def markdown content
+    require "kramdown"
+
+    content = content.
+      gsub(/^``` *(\w+)/) { "{:lang=\"#$1\"}\n~~~" }.
+      gsub(/^```/, '~~~')
+
+    Kramdown::Document.new(content, KRAMDOWN_CONFIG).to_html
+  end
+
+  ############################################################
+  # Helper Methods:
+
+  ##
+  # Returns a markdown formatted sitemap for the given pages or the
+  # current page's subpages. This intelligently composes a sitemap
+  # whether the pages are ordered (dated) or not or a combination of
+  # the two.
+
+  def sitemap pages = nil, indent = 0
+    pages ||= self.subpages
+    dated, regular = pages.partition(&:dated?)
+
+    bonus   = 0
+    prev    = nil
+    regular = regular
+    subpages =
+      regular.sort_by { |p| p.url } +
+      dated.sort_by   { |p| [-p.date.to_i, p.url] }
+
+    subpages.map { |page|
+      x = []
+
+      if page.dated? then
+        bonus = 1
+        fmt ||= page.config["date_fmt"] || "%Y-%m" # REFACTOR: yuck
+        curr = page.date.strftime fmt
+        if prev != curr then
+          x << "#{"  " * (indent)}* #{curr}:"
+          prev = curr
+        end
+      end
+
+      x << "#{"  " * (indent+bonus)}* [#{page.title}](#{page.clean_url})"
+      x += [page.sitemap(nil, indent+bonus+1)] unless page.subpages.empty?
+      x
+    }.flatten.join "\n"
+  end
+
+  ##
+  # Convenience function to return a markdown TOC.
+
+  def toc
+    "* \n{:toc}\n"
+  end
+
+  ##
+  # Return a kramdown block-tag to add attributes to the following (or
+  # preceding... kramdown is a bit crazy) block. Attributes can either
+  # be a simple name or a hash of key/value pairs.
+
+  def attr h_or_name
+    h_or_name = h_or_name.map { |k,v| "#{k}=\"#{v}\"" }.join " " if
+      Hash === h_or_name
+
+    "{:#{h_or_name}}"
+  end
+
+  ##
+  # Return a kramdown block-tag for a CSS class.
+
+  def css_class name
+    attr ".#{name}"
+  end
+
+  ##
+  # Return a kramdown block-tag for a CSS ID.
+
+  def css_id name
+    attr "##{name}"
+  end
+
+  ##
+  # Return a markdown-formatted link for a given url and title.
+
+  def link(url, title) # :nodoc:
+    "[#{title}](#{url})"
+  end
+
+  ##
+  # Return a markdown-formatted image for a given url and an optional alt.
+
+  def image url, alt=url
+    "![#{alt}](#{url})"
+  end
+end # markdown
+

data/lib/zenweb/site.rb

@@ -0,0 +1,237 @@
+require "rubygems"
+gem "rake"
+require "rake"
+require "make/rake/work/well"
+
+require "zenweb/page"
+require "zenweb/config"
+require "zenweb/extensions"
+
+module Zenweb
+
+  ##
+  # Holder for the entire website. Everything gets driven from here.
+  #
+  # TODO: describe expected filesystem layout and dependency mgmt.
+
+  class Site
+    include Rake::DSL
+
+    ##
+    # Returns all pages found via #scan
+
+    attr_reader :pages
+
+    ##
+    # Returns all configs found via #scan
+
+    attr_reader :configs
+
+    ##
+    # Returns all known layouts found via #scan
+
+    attr_reader :layouts
+
+    ##
+    # Loads all files matching "zenweb/plugins/*.rb".
+
+    def self.load_plugins
+      Gem.find_files("zenweb/plugins/*.rb").each do |path|
+        require path
+      end
+    end
+
+    self.load_plugins
+
+    def initialize # :nodoc:
+      @layouts = {}
+      @pages = {}
+      @configs = Hash.new { |h,k| h[k] = Config.new self, k }
+    end
+
+    ##
+    # Returns a magic hash that groups up all the pages by category
+    # (directory). The hash has extra accessor methods on it to make
+    # grabbing what you want a bit cleaner. eg:
+    #
+    #    site.categories.blog # => [Page[blog/...], ...]
+
+    def categories
+      @categories ||=
+        begin
+          h = Hash.new { |h2,k| h2[k] = [] }
+
+          def h.method_missing msg, *args
+            if self.has_key? msg.to_s then
+              self[msg.to_s]
+            else
+              super
+            end
+          end
+
+          pages.each do |url, page|
+            dir = url.split(/\//).first
+            next unless File.directory? dir and dir !~ /^_/
+            next if url =~ /index.html/ or url !~ /html/
+            h[dir] << page
+          end
+
+          h.keys.each do |dir|
+            h[dir] = h[dir].sort_by { |p| [-p.date.to_i, p.title ] }
+          end
+
+          h
+        end
+    end
+
+    ##
+    # Return the top level config.
+
+    def config
+      configs["_config.yml"]
+    end
+
+    ##
+    # Generates the website by invoking the 'site' task.
+
+    def generate
+      task(:site).invoke
+    end
+
+    ##
+    # Returns a list of all known html pages.
+
+    def html_pages
+      self.pages.values.select { |p| p.url_path =~ /\.html/ }
+    end
+
+    def inspect # :nodoc:
+      "Site[#{pages.size} pages, #{configs.size} configs]"
+    end
+
+    ##
+    # Returns a layout named +name+.
+
+    def layout name
+      @layouts[name]
+    end
+
+    ##
+    # Proxy object for the config. Returns a config item at +msg+.
+
+    def method_missing msg, *args
+      config[msg.to_s] || warn("#{self.inspect} does not define #{msg}")
+    end
+
+    ##
+    # Returns all pages (with titles) sorted by date.
+
+    def pages_by_date
+      # page.config["title"] avoids the warning
+      html_pages.select {|page| page.config["title"] }.
+        sort_by { |page| [-page.date.to_i, page.title] }
+    end
+
+    ##
+    # Returns a hash mapping page url to page.
+
+    def pages_by_url
+      unless defined? @pages_by_url then
+        h = {}
+        pages.each do |_,p|
+          h[p.url] = p
+        end
+        @pages_by_url = h
+      end
+      @pages_by_url
+    end
+
+    ##
+    # Scans the directory tree and finds all relevant pages, configs,
+    # layouts, etc.
+    #
+    # TODO: talk about expected directory structure and extra
+    # naming enhancements.
+
+    def scan
+      excludes = %w[~ Rakefile] + Array(config["exclude"])
+
+      top = Dir["*"] - excludes
+      files = top.select { |path| File.file? path }
+      files += Dir["{#{top.join(",")}}/**/*"].reject { |f| not File.file? f }
+
+      renderers_re = Page.renderers_re
+
+      files.each do |path|
+        case path
+        when /(?:#{excludes.join '|'})$/
+          # ignore
+        when /^_layout/ then
+          name = File.basename(path).sub(/\..+$/, '')
+          @layouts[name] = Page.new self, path
+        when /^_/ then
+          next
+        when /\.yml$/ then
+          @configs[path] = Config.new self, path
+        when /\.(?:png|jpg|gif|eot|svg|ttf|woff|ico|pdf|m4a|t?gz)$/ then # HACK
+          @pages[path] = Page.new self, path, self.config
+        when /\.(?:txt|html|css|js)$/, renderers_re then # HACK
+          @pages[path] = Page.new self, path
+        else
+          warn "unknown file type: #{path}" if Rake.application.options.trace
+        end
+      end
+
+      t = Time.now
+      @pages.reject! { |path, page| page.date && page.date > t } unless
+        ENV["ALL"]
+
+      fix_subpages
+    end
+
+    def fix_subpages # :nodoc:
+      parents = {}
+      @pages.values.select(&:index?).each do |p|
+        parents[File.dirname p.path] = p
+      end
+
+      @pages.values.each do |p|
+        path = File.dirname p.path
+        path = File.dirname path if p.index?
+
+        parent = parents[path]
+        next unless parent and parent != p and p.url =~ /html$/
+        p.parent = parent
+        parent.subpages << p
+      end
+
+      @pages.values.each do |p|
+        unless p.subpages.empty? then
+          sorted = p.subpages.sort_by(&:clean_url)
+          sorted = sorted.reverse if p.subpages.first.dated_path?
+          p.subpages.replace sorted
+        end
+      end
+    end
+
+    ##
+    # Wire up all the configs and pages. Invokes :extra_wirings to
+    # allow you to add extra manual dependencies.
+
+    def wire
+      directory ".site"
+      task :site => ".site"
+
+      configs.each do |path, config|
+        config.wire
+      end
+
+      pages.each do |path, page|
+        page.wire
+      end
+
+      $website = self # HACK
+      task(:extra_wirings).invoke
+    end
+  end # class Site
+end