stack 0.0.5 → 0.0.6

data/README.markdown

@@ -0,0 +1,134 @@
+Stack
+=====
+
+Generates a static site from template files with YAML and Liquid. Stack supports template transformation through Markdown, Textile and Less CSS.
+
+Within template files, stack allows you to use bi-directional YAML variables and include files.
+
+Dependencies
+------------
+
+* [Liquid][] - Templating system 
+* [RedCloth][] - Textile transformation
+* [Maruku][] - Markdown transformation
+* [Less][] - CSS transformation
+
+Install
+-------
+
+Available through [Gemcutter][].
+
+	gem install stack
+
+Usage
+-----
+
+### Command Line
+
+
+	cd /path/to/my/site
+	stack [command] [options]
+	
+#### Commands
+
+	generate
+	
+Generate runs through the source and transforms the templates, if no source is specified the current directory will be used.
+	
+	server
+	
+Runs a web server serving the output of the transformed source, by default when running Stack in server mode your templates will be automatically transformed when changed (this can be disabled).
+	
+	watch
+	
+Watches a directory and re-builds whenever theres file changes.
+	
+#### Options
+
+	--source
+	
+	--target
+	
+##### Server Options
+	
+	--port
+	
+	--watches
+	
+
+### Ruby
+
+	require 'stack'
+
+	Stack::Generator.new("/path/to/source", "/path/to/target")
+
+Templates and YAML
+------------------
+
+Template files can contain YAML block's that are processed by Stack and can be used to define Liquid variables for use in your templates. A YAML block can be something like;
+
+	---
+	layout: application
+	title: Page Title
+	---
+	
+### Pre-defined variables
+
+	layout
+
+This specifies the layout file to use around the content, theres no need to specify the extension. The layout must be defined in a file inside a `_layout` folder that is within the current template scope, if you have templates defined in a sub-folder you can have a `_layout` folder that only templates in the sub-folder can access.
+
+	generator
+	
+This variable holds the current  hash used to transform the current template. You should not override this from the YAML block.
+
+	generator.time
+	
+The current Time from when the Stack processed and transformed the templates.
+
+	generator.processed_at
+	
+The current Time the `generator` processed the templates.
+
+	generator.transformed_at
+	
+The current Time the `generator` transformed the templates.
+
+### Liquid Templates
+
+Its out of the scope of this project's README file to describe how Liquid templating can be used, for more information see the [Liquid Wiki][].
+
+#### Filters
+	
+	{{ generator.time | date_to_xmlschema }} #=> 2009-10-31T21:16:06+00:00
+	
+Transforms a Time into a XML schema format string.
+
+	{{ generator.time | date_to_string }} #=> 31 Oct 2009
+	
+Transforms a Time into a formatted string.
+
+	{{ title | xml_escape }} #=>
+	
+Escapes the specified string for use in XML.
+
+Contribute
+----------
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+License
+-------
+
+Copyright (c) 2009 Adam Livesley (sixones). See LICENSE for details.
+
+[Liquid]: http://liquidmarkup.org/ "Liquid"
+[RedCloth]: http://redcloth.org/ "RedCloth"
+[Maruku]: http://maruku.rubyforge.org/ "Maruku"
+[Less]: http://lesscss.org/ "Less"
+[Gemcutter]: http://gemcutter.org/gems/stack "Gemcutter"
+[Liquid Wiki]: http://wiki.github.com/tobi/liquid/ "Liquid Wiki"

data/Rakefile

@@ -19,6 +19,7 @@ begin
     gem.add_dependency "RedCloth", ">= 4.2.1"
     gem.add_dependency "maruku", ">= 0.5.9"
     gem.add_dependency "less", ">= 1.0.0"
+    gem.add_dependency "directory_watcher", ">= 1.2.0"
 
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 0
-:patch: 5
+:patch: 6

data/lib/stack.rb

@@ -2,12 +2,13 @@
 require 'rubygems'
 
 require 'optparse'
-
+require 'directory_watcher'
 require 'liquid'
 require 'maruku'
 require 'mash'
 require 'RedCloth'
 require 'less'
+require 'webrick'
 
 require 'core_ext/hash'
 
@@ -17,10 +18,18 @@ require 'stack/runner'
 
 require 'stack/template'
 require 'stack/parsable'
+require 'stack/server'
+require 'stack/watcher'
 
 require 'stack/templates/page'
 require 'stack/templates/layout'
 
+require 'stack/filters/register'
+require 'stack/filters/standard'
+require 'stack/filters/convertors'
+require 'stack/filters/datetime'
+require 'stack/filters/string'
+
 module Stack
   # Default options used by stack, overridden from the command line or YML configration file.
   DEFAULTS = {
@@ -29,7 +38,7 @@ module Stack
   }.freeze
   
   # Array of valid commands stack can use
-  COMMANDS = %w(create generate server)
+  COMMANDS = %w(create generate server watch)
   
   # Array of transformable extensions (these extensions go through the liquid transformer)
   EXTENSIONS = %w(.html .markdown .mdown .mkdn .md .textile .js .css)

data/lib/stack/filters/convertors.rb

@@ -0,0 +1,19 @@
+module Stack
+  module Filters
+    module Convertors
+      include Stack::Filters::Register
+      
+      def from_markdown(content)
+        Maruku.new(content).to_html
+      end
+      
+      def from_textile(content)
+        RedCloth.new(content).to_html
+      end
+      
+      def from_less(content)
+        Less::Engine.new(content).to_css
+      end
+    end
+  end
+end

data/lib/stack/filters/datetime.rb

@@ -0,0 +1,15 @@
+module Stack
+  module Filters
+    module DateTime
+      include Stack::Filters::Register
+      
+      def date_to_string(date)
+        date.strftime("%d %b %Y")
+      end
+      
+      def date_to_xmlschema(date)
+        date.strftime("%Y-%m-%dT%H:%M:%S%Z")
+      end
+    end
+  end
+end

data/lib/stack/filters/register.rb

@@ -0,0 +1,17 @@
+module Stack
+  module Filters
+    module Register
+      def self.extensions; @@extensions; end
+
+      @@extensions = [ ]
+    
+      def self.included(base)
+        @@extensions << base
+      end
+      
+      def self.invoke_filter(name, params)
+        self.send(name, params)
+      end
+    end
+  end
+end

data/lib/stack/filters/standard.rb

@@ -0,0 +1,27 @@
+module Stack
+  module Filters
+    module Standard
+      include Stack::Filters::Register
+      
+      def hello_world(input)
+        "Hello World!"
+      end
+      
+      def length(input)
+        input.length
+      end
+      
+      def escape(input)
+        CGI::escape(input)
+      end
+      
+      def escape_html(input)
+        CGI::escapeHTML(input)
+      end
+      
+      def escape_xml(input)
+        CGI::escapeHTML(input)
+      end
+    end
+  end
+end

data/lib/stack/filters/string.rb

@@ -0,0 +1,11 @@
+module Stack
+  module Filters
+    module String
+      include Stack::Filters::Register
+      
+      def count_words(input)
+        input.split.length
+      end
+    end
+  end
+end

data/lib/stack/generator.rb

@@ -7,6 +7,8 @@ module Stack
     attr_accessor :layouts
     attr_accessor :pages
     
+    attr_accessor :processed_at, :transformed_at
+    
     def initialize(source, target, parent = nil)
       self.source = source
       self.target = target
@@ -24,6 +26,8 @@ module Stack
     end
     
     def process!
+      self.processed_at = Time.now
+      
       read_layouts
       read_pages
       
@@ -50,6 +54,8 @@ module Stack
     end
     
     def transform!
+      self.transformed_at = Time.now
+      
       self.pages.each do |name, page|
         page.write!
       end
@@ -74,7 +80,9 @@ module Stack
     
     def to_hash
       {
-        
+        :processed_at => self.processed_at,
+        :transformed_at => self.transformed_at,
+        :time => Time.now
       }
     end
     

data/lib/stack/runner.rb

@@ -38,7 +38,23 @@ module Stack
     # Runs the specified command 
     def run_command
       @generator = Stack::Generator.new(Stack::runner.configuration.source, Stack::runner.configuration.target)
-      @generator.transform!
+      
+      case self.command
+      when /(generate|gen)/
+        @generator.transform!
+      when /(server)/
+        # make a watcher
+        watcher = Stack::Watcher.new(@generator)
+        watcher.keep_alive = false
+        watcher.observe
+        # and a server
+        server = Stack::Server.new(@generator)
+        server.observe
+      when /(watch)/
+        # setup a watcher
+        watcher = Stack::Watcher.new(@generator)
+        watcher.observe
+      end
     end
   end
 end

data/lib/stack/server.rb

@@ -0,0 +1,27 @@
+module Stack
+  class Server
+    attr_accessor :source, :target
+    attr_accessor :generator
+    attr_accessor :http_server
+    attr_accessor :thread
+    
+    def initialize(generator)
+      self.generator = generator
+      self.source = self.generator.source
+      self.target = self.generator.target
+    end
+    
+    def observe
+      self.http_server = WEBrick::HTTPServer.new(
+        :Port => 4000,
+        :DocumentRoot => self.target
+      )
+      
+      self.thread = Thread.new {
+        self.http_server.start
+      }
+      
+      self.thread.join()
+    end
+  end
+end

data/lib/stack/template.rb

@@ -21,9 +21,6 @@ module Stack
         self.original_extension = ext[1, ext.length]
         self.extension = self.original_extension
         
-        puts self.original_extension
-        puts self.extension
-        
         read
       end
     end
@@ -40,22 +37,22 @@ module Stack
       layout_name = _payload[:layout]
       
       if (layout_name and do_layout)
-        puts "has layout! #{layout_name}"
-        
         # get layout 
         _tpl_payload = self.generator.layouts[layout_name].template_payload
         _tpl_payload.delete(:layout)
+        _tpl_payload.delete(:template)
+        _tpl_payload.delete(:generator)
         
-        puts _tpl_payload.inspect
-        puts "\n"
+        #puts _tpl_payload.inspect
+        #puts "\n"
         
         _payload = _payload.merge(_tpl_payload)
       end
       
-      puts _payload.inspect
-      puts "\n\n"
+      #puts _payload.inspect
+      #puts "\n\n"
       
-      content = Liquid::Template.parse(self.raw).render(Mash.new(_payload))
+      content = Liquid::Template.parse(self.raw).render(Mash.new(_payload), Stack::Filters::Register.extensions)
       content = self.transform(content)
       
       if (layout_name and do_layout)

data/lib/stack/watcher.rb

@@ -0,0 +1,45 @@
+module Stack
+  class Watcher
+    attr_accessor :source, :target
+    attr_accessor :generator
+    attr_accessor :directory_watcher
+    attr_accessor :keep_alive
+    
+    def initialize(generator)
+      self.generator = generator
+      self.source = self.generator.source
+      self.target = self.generator.target
+      
+      self.keep_alive = true
+    end
+    
+    def observe
+      dirs = ""
+      
+      Dir.chdir(self.source) do
+        dirs = Dir['*'].select { |x| File.directory?(x) }
+        dirs -= ['_stack']
+        dirs = dirs.map { |x| "#{x}/**/*" }
+        dirs += ['*']
+      end
+      
+      self.directory_watcher = DirectoryWatcher.new(self.source)
+      self.directory_watcher.interval = 1
+      self.directory_watcher.glob = dirs
+      
+      self.directory_watcher.add_observer do |*args|
+        self.generator.process!
+        self.generator.transform!
+        
+        time = Time.now.strftime("%Y-%m-%d %H:%M:%S")
+        puts "[#{time}] #{args.size} files changed and processed."
+      end
+      
+      self.directory_watcher.start
+      
+      if self.keep_alive
+        loop { sleep 1000 }
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: stack
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - sixones
@@ -62,6 +62,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.0.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: directory_watcher
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.0
+    version: 
 description: Generates a static site from template files with YAML and Liquid. Stack supports template transformation through Markdown, Textile and Less CSS.
 email: dev@sixones.com
 executables: 
@@ -70,22 +80,29 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION.yml
 - bin/stack
 - lib/core_ext/hash.rb
 - lib/stack.rb
 - lib/stack/configuration.rb
+- lib/stack/filters/convertors.rb
+- lib/stack/filters/datetime.rb
+- lib/stack/filters/register.rb
+- lib/stack/filters/standard.rb
+- lib/stack/filters/string.rb
 - lib/stack/generator.rb
 - lib/stack/parsable.rb
 - lib/stack/runner.rb
+- lib/stack/server.rb
 - lib/stack/template.rb
 - lib/stack/templates/layout.rb
 - lib/stack/templates/page.rb
+- lib/stack/watcher.rb
 - test/helper.rb
 - test/test_stack.rb
 has_rdoc: true

data/README.rdoc

@@ -1,20 +0,0 @@
-= stack
-
-Generates a static site from template files with YAML and Liquid. Stack supports template transformation through Markdown, Textile and Less CSS.
-
-Within template files, stack allows you to use bi-directional YAML variables and include files.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but
-   bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2009 Adam Livesley (sixones). See LICENSE for details.