stasis 0.1.0

data/.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+*.gem
+coverage
+docs
+dump.rdb
+pkg
+site/.sass-cache
+site/public
+spec/fixtures/project/public
+tmp

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2010
+
+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/README.md

@@ -0,0 +1,287 @@
+Stasis
+======
+
+Stasis is a dynamic framework for static sites.
+
+Install
+-------
+
+Install via RubyGems:
+
+<!-- language:console -->
+
+    $ gem install stasis
+
+Templates
+---------
+
+At its most essential, Stasis takes a directory tree with [supported template files](#supported_markup_languages) and renders them.
+
+Example directory structure:
+
+<!-- language:console -->
+
+    project/
+        index.html.haml
+        other.txt
+
+Run `stasis`:
+
+<!-- highlight:stasis language:console -->
+
+    $ cd project
+    $ stasis
+
+Stasis creates a `public` directory:
+
+<!-- highlight:public/ language:console -->
+
+    project/
+        index.html.haml
+        other.txt
+        public/
+            index.html
+            other.txt
+
+`index.html.haml` becomes `public/index.html`.
+
+`other.txt` is copied as-is because `.txt` is an unrecognized template extension.
+
+Controllers
+-----------
+
+Controllers contain Ruby code that is evaluated once before all templates render.
+
+Example directory structure:
+
+<!-- highlight:controller.rb language:console -->
+
+    project/
+        controller.rb
+        index.html.haml
+        subdirectory/
+            controller.rb
+            index.html.haml
+
+Before
+------
+
+Use `before` blocks within `controller.rb` to execute code before a template renders.
+
+`controller.rb`:
+
+    before 'index.html.haml' do
+      @something = true
+    end
+
+`@something` is now available to the `index.html.haml` template.
+
+The `before` method can take any number of paths and/or regular expressions:
+
+    before 'index.html.haml', /.*html.erb/ do
+      @something = true
+    end
+
+Layouts
+-------
+
+`layout.html.haml`:
+
+    %html
+      %body= yield
+
+In `controller.rb`, set the default layout:
+
+    layout 'layout.html.haml'
+
+Set the layout for a particular template:
+
+    layout 'index.html.haml' => 'layout.html.haml'
+
+Use a regular expression:
+
+    layout /.*html.haml/ => 'layout.html.haml'
+
+Set the layout from a `before` block:
+
+    before 'index.html.haml' do
+      layout 'layout.html.haml'
+    end
+
+Render
+------
+
+Within a template:
+
+    %html
+      %body= render '_partial.html.haml'
+
+Within a `before` block:
+
+    before 'index.html.haml' do
+      @partial = render '_partial.html.haml'
+    end
+
+Text:
+
+    render :text => 'Hello'
+
+Local variables:
+
+    render 'index.html.haml', :locals => { :x => true }
+
+Include a block for the template to `yield` to:
+
+    render 'index.html.haml' { 'Hello' }
+
+Instead
+-------
+
+The `instead` method changes the output of the template being rendered:
+
+    before 'index.html.haml' do
+      instead render('subdirectory/index.html.haml')
+    end
+
+Helpers
+-------
+
+`controller.rb`:
+
+    helpers do
+      def say_hello
+        'Hello'
+      end
+    end
+
+The `say_hello` method is now available to all `before` blocks and templates.
+
+Ignore
+------
+
+Use the `ignore` method in `controller.rb` to ignore certain paths.
+
+Ignore filenames with an underscore at the beginning:
+
+    ignore /\/_.*/
+
+Priority
+--------
+
+Use the `priority` method in `controller.rb` to change the file process order.
+
+Copy `.txt` files before rendering the `index.html.erb` template:
+
+    priority /.*txt/ => 2, 'index.html.erb' => 1
+
+The default priority is `0` for all files.
+
+Usage
+-----
+
+### Command Line
+
+Always execute the `stasis` command in the root directory of your project.
+
+Development mode (auto-regenerate on save):
+
+<!-- highlight:-d language:console -->
+
+    $ stasis -d
+
+Only render specific files or directories:
+
+<!-- highlight:-o language:console -->
+
+    $ stasis -o index.html.haml,subdirectory
+
+Change the public (destination) directory:
+
+<!-- highlight:-o language:console -->
+
+    $ stasis -p ../public
+   
+### Programmatic
+
+Instanciate a `Stasis` object:
+
+    stasis = Stasis.new('/path/to/project/root')
+
+Optionally specify a destination directory:
+
+    stasis = Stasis.new('/project', '/html')
+
+Render all templates:
+
+    stasis.render
+
+Render a specific template or directory:
+
+    stasis.render('index.html.haml', 'subdirectory')
+
+Define local variables for `before` callbacks, views, and `helpers`:
+
+    stasis.render(:locals => { :x => 'y' })
+
+More
+----
+
+### Supported Markup Languages
+
+Stasis uses [Tilt](https://github.com/rtomayko/tilt) to support the following template engines:
+
+<!-- language:console -->
+
+    ENGINE                     FILE EXTENSIONS
+    -------------------------- ----------------------
+    ERB                        .erb, .rhtml
+    Interpolated String        .str
+    Erubis                     .erb, .rhtml, .erubis
+    Haml                       .haml
+    Sass                       .sass
+    Scss                       .scss
+    Less CSS                   .less
+    Builder                    .builder
+    Liquid                     .liquid
+    RDiscount                  .markdown, .mkd, .md
+    Redcarpet                  .markdown, .mkd, .md
+    BlueCloth                  .markdown, .mkd, .md
+    Kramdown                   .markdown, .mkd, .md
+    Maruku                     .markdown, .mkd, .md
+    RedCloth                   .textile
+    RDoc                       .rdoc
+    Radius                     .radius
+    Markaby                    .mab
+    Nokogiri                   .nokogiri
+    CoffeeScript               .coffee
+    Creole (Wiki markup)       .creole
+    Yajl                       .yajl
+
+### Server Mode
+
+Stasis can run as a server that uses [redis](http://redis.io) to wait for render jobs.
+
+Stasis server that uses redis on port 6379:
+
+<!-- highlight:-s language:console -->
+
+    $ stasis -s localhost:6379/0
+
+Push to the server (in Ruby):
+
+    Stasis::Server.push(
+      # Paths to render
+      :paths => [ "index.html.haml", "subdirectory" ],
+
+      # Redis address
+      :redis => "localhost:6379/0",
+
+      # Return rendered templates (false by default)
+      :return => false,
+
+      # Block until templates generate (false by default)
+      :wait => false,
+
+      # Write to the filesystem (true by default)
+      :write => true
+    )

data/Rakefile

@@ -0,0 +1,109 @@
+require File.dirname(__FILE__) + '/lib/stasis/gems'
+
+Stasis::Gems.activate %w(rake rocco rspec)
+
+require 'rake'
+require 'rocco/tasks'
+require 'spec/rake/spectask'
+
+def gemspec
+  @gemspec ||= begin
+    file = File.expand_path('../stasis.gemspec', __FILE__)
+    eval(File.read(file), binding, file)
+  end
+end
+
+if defined?(Spec::Rake::SpecTask)
+  desc "Run specs"
+  Spec::Rake::SpecTask.new do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = %w(-fs --color)
+    t.warning = true
+  end
+  task :spec
+  task :default => :spec
+end
+
+desc "Build gem(s)"
+task :gem do
+  old_gemset = ENV['GEMSET']
+  root = File.expand_path('../', __FILE__)
+  pkg = "#{root}/pkg"
+  system "rm -Rf #{pkg}"
+  Stasis::Gems.gemset_names.each do |gemset|
+    ENV['GEMSET'] = gemset.to_s
+    system "cd #{root} && gem build stasis.gemspec"
+    system "mkdir -p #{pkg} && mv *.gem pkg"
+  end
+  ENV['GEMSET'] = old_gemset
+end
+
+namespace :gem do
+  desc "Install gem(s)"
+  task :install do
+    Rake::Task['gem'].invoke
+    Dir["#{File.dirname(__FILE__)}/pkg/*.gem"].each do |pkg|
+      system "gem install #{pkg} --no-ri --no-rdoc"
+    end
+  end
+  
+  desc "Push gem(s)"
+  task :push do
+    Rake::Task['gem'].invoke
+    Dir["#{File.dirname(__FILE__)}/pkg/*.gem"].each do |pkg|
+      system "gem push #{pkg}"
+    end
+  end
+end
+
+namespace :gems do
+  desc "Install gem dependencies (DEV=0 DOCS=0 GEMSPEC=default SUDO=0)"
+  task :install do
+    dev = ENV['DEV'] == '1'
+    docs = ENV['DOCS'] == '1' ? '' : '--no-ri --no-rdoc'
+    gemset = ENV['GEMSET']
+    sudo = ENV['SUDO'] == '1' ? 'sudo' : ''
+    
+    Stasis::Gems.gemset = gemset if gemset
+    
+    if dev
+      gems = Stasis::Gems.gemspec.development_dependencies
+    else
+      gems = Stasis::Gems.gemspec.dependencies
+    end
+    
+    gems.each do |name|
+      name = name.to_s
+      version = Stasis::Gems.versions[name]
+      if Gem.source_index.find_name(name, version).empty?
+        version = version ? "-v #{version}" : ''
+        system "#{sudo} gem install #{name} #{version} #{docs}"
+      else
+        puts "already installed: #{name} #{version}"
+      end
+    end
+  end
+end
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+desc "Build web site"
+task :site do
+  cmd = [
+    'cd site',
+    '../bin/stasis',
+    'rm -rf ../../public',
+    'mv public ../../',
+    'cd ../',
+    'git checkout gh-pages',
+    'rm -rf *.png *.html *.css *.js site',
+    'mv ../public/* .'
+  ].join '&&'
+  `#{cmd}`
+end
+
+desc "Build Rocco Docs"
+Rocco::make 'docs/'

data/bin/stasis

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/stasis")
+
+Stasis::Gems.activate %w(slop)
+require 'slop'
+
+slop = Slop.parse :help => true do
+  on :d, :development, "Development mode\t\t(auto-regenerate)"
+  on :o, :only, "Only generate specific files\t(comma-separated)", :optional => true, :as => Array
+  on :p, :public, "Public directory path", :optional => true
+  on :s, :server, "Server mode\t\t\t(default redis host: localhost:6379/0)", :optional => true, :default => "localhost:6379/0"
+end
+
+options = slop.to_hash
+options.delete(:server) unless slop.server?
+
+if slop.development?
+  Stasis::DevMode.new(Dir.pwd, options)
+elsif slop.only? && slop.public?
+  Stasis.new(Dir.pwd, slop[:public], options).render(*slop[:only])
+elsif slop.only?
+  Stasis.new(Dir.pwd, options).render(*slop[:only])
+elsif slop.server?
+  Stasis::Server.new(Dir.pwd, options)
+elsif slop.public?
+  Stasis.new(Dir.pwd, slop[:public], options).render(*slop[:only])
+else
+  Stasis.new(Dir.pwd, options).render
+end