jgm-ecstatic 0.0.0

data/ChangeLog

@@ -0,0 +1,3 @@
+=== 0.1 / 2009-07-19
+
+* Initial release

data/README

@@ -0,0 +1,79 @@
+= ecstatic
+
+* http://github.com/jgm/ecstatic
+
+== DESCRIPTION:
+
+ecstatic helps you manage a static website.  Pages are generated
+from tenjin templates and YAML data files.
+
+== FEATURES:
+
+* Generates a static site, for high performance and security
+* Separation of data and presentation, as in a dynamic web framework,
+  but with data in text files rather than databases
+* Supports markdown
+* Supports output in HTML, plain text, and LaTeX
+
+== SYNOPSIS:
+
+First, generate a site skeleton:
+
+    ecstatic mysite
+
+See what has been done:
+
+    cd mysite
+    ls
+
+To build the site (in the <tt>site</tt> directory):
+
+    rake
+
+Try modifying the layout (<tt>standard.rbhtml</tt>),
+the data (<tt>events.yaml</tt>), or the template
+(<tt>events.rbhtml</tt>).  Recompile the site with rake.
+
+If you want to add new pages, just add templates and
+datafiles, and register the pages in <tt>siteindex.yaml</tt>.
+Put any static files in <tt>files</tt>; these will be copied
+verbatim into the site.
+
+If a page has no dynamic elements (other than the ones handled
+by the layout), you can use a markdown file instead of a
+template.  Just give it the extension <tt>.markdown</tt>
+
+== REQUIREMENTS:
+
+* rpeg-markdown
+* tenjin
+* activesupport
+
+== INSTALL:
+
+* sudo gem install ecstatic
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 John MacFarlane
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,26 @@
+# -*- ruby -*-
+
+require 'rubygems'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "ecstatic"
+    gemspec.summary = "Framework for maintaining a static website from templates and data in YAML files."
+    gemspec.email = "jgm@berkeley.edu"
+    gemspec.homepage = "http://github.com/jgm/cloudlib"
+    gemspec.description = "Ecstatic is a framework for maintaining a static website from templates and data in YAML files."
+    gemspec.authors = ["John MacFarlane"]
+    gemspec.has_rdoc = true
+    gemspec.authors  = ["John MacFarlane"]
+    gemspec.test_files = []
+    gemspec.add_dependency("activesupport", [">= 1.1"])
+    gemspec.add_dependency("rpeg-markdown", [">= 0.2"])
+    gemspec.add_dependency("tenjin", [">= 0.6.1"])
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+
+# vim: syntax=ruby

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/bin/ecstatic

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+
+if ARGV.length != 1
+  $stderr.puts "Usage: ecstatic PATH  - create skeleton site in PATH\n"
+  exit 1
+end
+
+target = ARGV[0]
+
+sampledir = File.join File.dirname(__FILE__), "../samplesite"
+FileUtils.cp_r("#{sampledir}/.", target)
+
+puts "Created skeleton in #{target}."
+puts "To make your site:"
+puts "    cd #{target}"
+puts "    rake"
+
+exit 0

data/ecstatic.gemspec

@@ -0,0 +1,62 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ecstatic}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John MacFarlane"]
+  s.date = %q{2009-07-20}
+  s.default_executable = %q{ecstatic}
+  s.description = %q{Ecstatic is a framework for maintaining a static website from templates and data in YAML files.}
+  s.email = %q{jgm@berkeley.edu}
+  s.executables = ["ecstatic"]
+  s.extra_rdoc_files = [
+    "ChangeLog",
+     "README"
+  ]
+  s.files = [
+    "ChangeLog",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "bin/ecstatic",
+     "ecstatic.gemspec",
+     "lib/ecstatic.rb",
+     "samplesite/README",
+     "samplesite/Rakefile",
+     "samplesite/events.rbhtml",
+     "samplesite/events.yaml",
+     "samplesite/files/Ukulele.jpg",
+     "samplesite/files/css/print.css",
+     "samplesite/files/css/screen.css",
+     "samplesite/models/models.rb",
+     "samplesite/siteindex.yaml",
+     "samplesite/standard.rbhtml"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/jgm/cloudlib}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Framework for maintaining a static website from templates and data in YAML files.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 1.1"])
+      s.add_runtime_dependency(%q<rpeg-markdown>, [">= 0.2"])
+      s.add_runtime_dependency(%q<tenjin>, [">= 0.6.1"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 1.1"])
+      s.add_dependency(%q<rpeg-markdown>, [">= 0.2"])
+      s.add_dependency(%q<tenjin>, [">= 0.6.1"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 1.1"])
+    s.add_dependency(%q<rpeg-markdown>, [">= 0.2"])
+    s.add_dependency(%q<tenjin>, [">= 0.6.1"])
+  end
+end

data/lib/ecstatic.rb

@@ -0,0 +1,109 @@
+require 'rubygems'
+require 'tenjin'
+require 'optparse'
+require 'yaml'
+require 'markdown'
+require 'activesupport'
+
+module Ecstatic
+  class Page
+    attr_accessor :contexthash, :layoutfile, :templatefile
+  
+    def initialize(templatefile = nil, datafiles = [], layoutfile = nil)
+      @templatefile = templatefile
+      @layoutfile = layoutfile
+      # get context from data files
+      @contexthash = {}
+      datafiles.each do |file|
+        yamltext = File.open(file).read
+        yaml = YAML::load(yamltext)
+        # if YAML is not a hash, make a hash with file's basename as key:
+        unless yaml.class == Hash
+          yaml = {File.basename(file, File.extname(file)) => yaml}
+        end
+        yaml.each_pair do |key,val|
+          model = key.singularize.capitalize
+          begin
+            @contexthash[key] = Object.const_get(model).from_array(val)
+          rescue
+            $stderr.puts("Unable to initialize " + key + " from model " + model)
+            @contexthash[key] = val
+          end
+        end
+      end
+    end
+  
+    def escapefun(format)
+      case
+      when format == :html
+        return 'Ecstatic.markdown_to_compact_html'
+      when format == :latex
+        return 'Ecstatic.markdown_to_latex'
+      else
+        return 'escape'
+      end
+     end
+  
+     def to_format(format)
+      engine = Tenjin::Engine.new(:cache => false, :escapefunc => escapefun(format))
+      
+      if File.extname(self.templatefile) == '.markdown'
+        contents = File.open(self.templatefile).read
+        output = case
+                 when format == :html
+                    markdown_to_compact_html(contents)
+                 when format == :latex
+                    markdown_to_latex(contents)
+                 else
+                    escape(contents)
+                 end
+      else
+        context = Tenjin::Context.new(self.contexthash)
+        output = engine.render(self.templatefile, context)
+      end
+     
+      if self.layoutfile
+        supercontext = Tenjin::Context.new({'_contents' => output})
+        superoutput = engine.render(self.layoutfile, {'_contents' => output})
+        return superoutput
+      else
+        return output
+      end
+    end
+  
+    def to_html
+      self.to_format(:html)
+    end
+  
+    def to_latex
+      self.to_format(:latex)
+    end
+  
+    def to_plain
+      self.to_format(:plain)
+    end
+  end
+  
+    # escape functions
+  
+    def markdown_to_html(str)
+      Markdown.new(str, :smart).to_html
+    end
+  
+    def markdown_to_compact_html(str)
+      res = markdown_to_html(str)
+      if (res =~ /<p>.*<p>/)
+        return res 
+      else  # only one paragraph
+        return res.gsub(/<\/?p>/,"")
+      end
+    end
+  
+    def markdown_to_latex(str)
+      Markdown.new(str, :smart).to_latex
+    end
+  
+    alias m markdown_to_html
+    module_function :markdown_to_html, :markdown_to_compact_html, :markdown_to_latex, :m
+end
+

data/samplesite/README

@@ -0,0 +1 @@
+To be completed.

data/samplesite/Rakefile

@@ -0,0 +1,66 @@
+require 'rake/clean'
+require 'ecstatic'
+require 'find'
+
+# load user-defined data models
+Find.find('models') do |f|
+  require f unless f == 'models'
+end
+
+SITEDIR = "site"
+CLEAN.include(SITEDIR)
+
+LAYOUT = "standard.rbhtml"
+
+siteindex = YAML::load File.read("siteindex.yaml")
+SITETITLE = siteindex['sitetitle']
+
+# construct list of pages
+PAGES = {}
+siteindex['pages'].each do |p|
+  dest = File.join SITEDIR, p['url']
+  PAGES[dest] = {
+    :title => p['title'],
+    :template => p['template'],
+    :data => if p['data'].class == Array
+                p['data']
+             elsif p['data'].class == String
+                [p['data']]
+             else
+                []
+             end }
+end
+
+# construct hash of files
+FILESDIR = "files"
+FILES = {}
+Find.find(FILESDIR) do |f|
+  if f != FILESDIR
+    base = f.gsub(/^[^\/]*\//,"")
+    FILES[File.join(SITEDIR, base)] = f
+  end
+end
+
+task :default => :all
+task :all => [SITEDIR] + PAGES.keys + FILES.keys
+
+directory SITEDIR
+
+FILES.each_pair do |dest,src|
+  file dest => src do
+    d = File.dirname dest
+    if ! File.exists? d
+      mkdir_p(File.dirname(dest))
+    end
+    cp src, dest
+  end
+end
+
+PAGES.each_pair do |dest,page|
+
+  file dest => ([page[:template], LAYOUT] + page[:data]) do
+    output = Ecstatic::Page.new(page[:template], page[:data], LAYOUT).to_html
+    File.open(dest, 'w').write(output)
+  end
+
+end

data/samplesite/events.rbhtml

@@ -0,0 +1,9 @@
+<h1>Events</h1>
+<img src="Ukulele.jpg"/>
+<ul>
+<?rb for event in @events.sort_by {|e| e.date}.reverse ?>
+  <li>
+    ${event.speaker}, ${event.title} (${event.date.to_s("%B %d, %Y")})
+  </li>
+<?rb end ?>
+</ul>

data/samplesite/events.yaml

@@ -0,0 +1,14 @@
+events:
+
+- title: Why Static Sites Are Best
+  speaker: Sam Spade
+  date:
+    start: 2009-04-08
+    end  : 2009-04-09
+
+- title: Ruby vs. Haskell
+  speaker:
+   - Sam Spade
+   - John Doe
+  date: 2009-05-09
+

data/samplesite/files/css/print.css

@@ -0,0 +1 @@
+/* CSS for printing here */

data/samplesite/files/css/screen.css

@@ -0,0 +1 @@
+/* CSS for screen display here */

data/samplesite/models/models.rb

@@ -0,0 +1,58 @@
+class Array
+  def to_s
+    self.to_sentence
+  end
+end
+
+class Model
+  def modelname
+    self.class.lowercase 
+  end
+  def self.from_array(ary)
+    return ary.map do |t|
+      self.new(t)
+    end
+  end
+end
+
+class Daterange < Model
+  attr_accessor :start, :end
+
+  def initialize(d)
+    if d.class == Hash
+      @start = d['start']
+      @end = d['end']
+    else
+      @start = d
+      @end = nil
+    end
+  end
+
+  def to_s(format="%F")
+    if self.end 
+      return(self.start.strftime(format) + " - " + self.end.strftime(format))
+    else
+      return self.start.strftime(format)
+    end
+  end
+
+  def <=>(b)
+    if self.end && b.end
+       [self.start, self.end] <=> [b.start, b.end]
+    else
+       self.start <=> b.start
+    end 
+  end
+
+end
+
+class Event < Model
+  attr_accessor :title, :date, :speaker
+
+  def initialize(e)
+    @title = e['title']
+    @date = Daterange.new(e['date'])
+    @speaker = e['speaker']
+  end
+end
+

data/samplesite/siteindex.yaml

@@ -0,0 +1,12 @@
+sitetitle: My ecstatic site
+
+pages:
+
+- url: events.html
+  title: Events
+  template: events.rbhtml
+  data: events.yaml
+
+menu:
+
+- events.html

data/samplesite/standard.rbhtml

@@ -0,0 +1,10 @@
+<html>
+<head>
+   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+   <link rel="stylesheet" type="text/css" href="css/screen.css" />
+   <link rel="stylesheet" type="text/css" media="print" href="css/print.css" />
+</head>
+<body>
+#{@_contents}
+</body>
+</html>

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: jgm-ecstatic
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- John MacFarlane
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-20 00:00:00 -07:00
+default_executable: ecstatic
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.1"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rpeg-markdown
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.2"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: tenjin
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.1
+    version: 
+description: Ecstatic is a framework for maintaining a static website from templates and data in YAML files.
+email: jgm@berkeley.edu
+executables: 
+- ecstatic
+extensions: []
+
+extra_rdoc_files: 
+- ChangeLog
+- README
+files: 
+- ChangeLog
+- README
+- Rakefile
+- VERSION
+- bin/ecstatic
+- ecstatic.gemspec
+- lib/ecstatic.rb
+- samplesite/README
+- samplesite/Rakefile
+- samplesite/events.rbhtml
+- samplesite/events.yaml
+- samplesite/files/Ukulele.jpg
+- samplesite/files/css/print.css
+- samplesite/files/css/screen.css
+- samplesite/models/models.rb
+- samplesite/siteindex.yaml
+- samplesite/standard.rbhtml
+has_rdoc: true
+homepage: http://github.com/jgm/cloudlib
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Framework for maintaining a static website from templates and data in YAML files.
+test_files: []
+