fnando-glue 0.0.2 → 0.0.3

data/README.markdown

@@ -26,7 +26,9 @@ Just run `glue /some/path` to generate your site skeleton.
 TODO
 ----
 
-Write tests
+* Write documentation
+* Automatically generate sitemap
+* Generate feed
 
 MAINTAINER
 ----------

data/Rakefile

@@ -19,6 +19,7 @@ spec = Gem::Specification.new do |s|
   s.add_dependency "RedCloth"
   s.add_dependency "rdiscount"
   s.add_dependency "haml"
+  s.add_dependency "builder"
 end
 
 namespace :gem do
@@ -72,4 +73,4 @@ namespace :gem do
     system "sudo gem install #{spec.instance_variable_get('@name')}"
     system "rm *.gem"
   end
-end
+end

data/glue.gemspec

@@ -14,14 +14,14 @@ Gem::Specification.new do |s|
   s.add_dependency "RedCloth", ">= 0"
   s.add_dependency "rdiscount", ">= 0"
   s.add_dependency "haml", ">= 0"
-  s.version = "0.0.2"
+  s.add_dependency "builder", ">= 0"
+  s.version = "0.0.3"
   s.require_paths = ["lib"]
   s.files = ["Rakefile",
  "glue.gemspec",
  "README.markdown",
  "bin/glue",
  "lib/glue",
- "lib/glue/capistrano.rb",
  "lib/glue/generator.rb",
  "lib/glue/helper.rb",
  "lib/glue/rake.rb",
@@ -29,16 +29,21 @@ Gem::Specification.new do |s|
  "lib/glue/template/helper.rb",
  "lib/glue/template/meta.rb",
  "lib/glue/template/parser.rb",
+ "lib/glue/template/sitemap.rb",
  "lib/glue/template.rb",
  "lib/glue.rb",
  "lib/vendor",
  "lib/vendor/colorize-0.0.1",
  "lib/vendor/colorize-0.0.1/colorize.rb",
+ "templates/404.haml",
  "templates/_footer.haml",
+ "templates/glue.yml",
  "templates/helper.rb",
+ "templates/htaccess",
  "templates/index.haml",
  "templates/main.haml",
  "templates/Rakefile",
+ "templates/robots.txt",
  "templates/style.sass"]
   s.authors = ["Nando Vieira"]
 end

data/lib/glue/generator.rb

@@ -12,9 +12,9 @@ module Glue
         FileUtils.mkdir_p(output)
       end
       
-      # create views directory
-      run %(creating #{Colorize.yellow("views/layouts")} directory) do
-        FileUtils.mkdir_p File.join(output, "views/layouts")
+      # create public directory
+      run %(creating #{Colorize.yellow("public")} directory) do
+        # FileUtils.mkdir_p File.join(output, "public")
       end
       
       # create javascripts directory
@@ -22,22 +22,32 @@ module Glue
         FileUtils.mkdir_p File.join(output, "public/javascripts")
       end
       
+      # create images directory
+      run %(creating #{Colorize.yellow("public/images")} directory) do
+        FileUtils.mkdir_p File.join(output, "public/images")
+      end
+      
+      # create views directory
+      run %(creating #{Colorize.yellow("views/layouts")} directory) do
+        FileUtils.mkdir_p File.join(output, "views/layouts")
+      end
+      
       # create config directory
       run %(creating #{Colorize.yellow("config")} directory) do
         FileUtils.mkdir_p File.join(output, "config")
       end
       
+      # copy rake file
+      run %( copying #{Colorize.yellow("config/glue.yml")}) do
+        FileUtils.cp File.join(templates, "glue.yml"), File.join(output, "config/glue.yml")
+      end
+      
       # copy stylesheet file
       run %( copying #{Colorize.yellow("views/stylesheets/style.sass")}) do
         FileUtils.mkdir_p File.join(output, "views/stylesheets")
         FileUtils.cp File.join(templates, "style.sass"), File.join(output, "views/stylesheets/style.sass")
       end
       
-      # create images directory
-      run %(creating #{Colorize.yellow("public/images")} directory) do
-        FileUtils.mkdir_p File.join(output, "public/images")
-      end
-      
       # copy rake file
       run %( copying #{Colorize.yellow("Rakefile")}) do
         FileUtils.cp File.join(templates, "Rakefile"), File.join(output, "Rakefile")
@@ -58,10 +68,25 @@ module Glue
         FileUtils.cp File.join(templates, "index.haml"), File.join(output, "views/index.haml")
       end
       
+      # copy 404.haml
+      run %( copying #{Colorize.yellow("views/404.haml")}) do
+        FileUtils.cp File.join(templates, "404.haml"), File.join(output, "views/404.haml")
+      end
+      
       # copy _footer.haml
       run %( copying #{Colorize.yellow("views/_footer.haml")}) do
         FileUtils.cp File.join(templates, "_footer.haml"), File.join(output, "views/_footer.haml")
       end
+      
+      # copy .htaccess
+      run %( copying #{Colorize.yellow("public/.htaccess")}) do
+        FileUtils.cp File.join(templates, "htaccess"), File.join(output, "public/.htaccess")
+      end
+      
+      # copy robots.txt
+      run %( copying #{Colorize.yellow("public/robots.txt")}) do
+        FileUtils.cp File.join(templates, "robots.txt"), File.join(output, "public/robots.txt")
+      end
     end
   end
 end

data/lib/glue/rake.rb

@@ -1,5 +1,7 @@
 require File.dirname(__FILE__) + "/../glue"
 
+task :default => "glue:auto"
+
 namespace :glue do
   task :default => :generate
   
@@ -7,4 +9,43 @@ namespace :glue do
   task :generate do
     Glue::Template.generate!
   end
+  
+  desc "Auto-generate pages"
+  task :auto do
+    thread = Thread.new do
+      latest_mtime = 0
+
+      trap 'INT' do
+        puts
+        thread.exit
+      end
+
+      loop do
+        files = Dir["views/**/*.*"] + Dir["config/**/*.*"]
+        changes = []
+        
+        mtime = files.collect do |file| 
+          mt = File.mtime(file).to_i
+          changes << file if latest_mtime > 0 && mt > latest_mtime
+          mt
+        end.max
+
+        if latest_mtime < mtime
+          if changes.size > 0
+            puts Colorize.yellow("\n\n#{changes.size} file(s) changed") + " - #{Time.now.strftime('%Y-%m-%d %H:%M:%S')}"
+            changes.each do |file| 
+              puts "  - #{Colorize.blue(file, :options => :highlight)}"
+            end unless latest_mtime == 0
+          end
+          latest_mtime = mtime
+          Glue::Template.generate!
+          puts
+        end
+
+        sleep ENV["WAIT"] || 2
+      end
+    end
+
+    thread.join
+  end
 end

data/lib/glue/template/helper.rb

@@ -10,7 +10,7 @@ module Glue
       end
       
       def haml(text)
-        Haml::Engine.new(text).to_html(self)
+        Haml::Engine.new(text).to_html(self, $meta.data)
       end
       
       def render(path)

data/lib/glue/template/meta.rb

@@ -1,19 +1,19 @@
 module Glue
   module Template
     class Meta
-      attr_accessor :metadata
+      attr_accessor :data
       attr_accessor :body
       attr_accessor :content
     
       def initialize(path)
-        self.metadata = {}
+        self.data = {}
         self.body = File.read(path)
         process!
       end
     
       def process!
         self.content = body.gsub /^\/ *(.*?): *(.*?) *$/sm do |m|
-          metadata[$1] = $2
+          data[$1.to_sym] = $2
           ""
         end
       end

data/lib/glue/template/parser.rb

@@ -2,17 +2,23 @@ module Glue
   module Template
     class Parser
       attr_accessor :root
+      attr_accessor :sitemap
+      attr_accessor :config
       
       include Glue::Helper
       
       def initialize(root)
         @root = root
+        @config = YAML.load_file("#{root}/config/glue.yml")
+        
+        @sitemap = Glue::Template::Sitemap.new
+        @sitemap.base_url = config["base_url"]
       end
       
       def run!
         # load user helper file if exist
-        if File.exists?("#{root}/helper.rb")
-          require "#{root}/helper.rb"
+        if File.exists?("#{root}/config/helper.rb")
+          require "#{root}/config/helper.rb"
           Glue::Template::Helper.__send__ :include, ::Helper
         end
         
@@ -29,36 +35,65 @@ module Glue
           next if path =~ /#{Regexp.escape("#{root}/views/layouts/")}/
           
           # partial files should be skipped
-          next if path =~ /_.*?\.haml$/
+          next if File.basename(path) =~ /_.*?\.haml$/
           
           run "processing #{Colorize.yellow(path)}" do
             render_haml(path)
           end
         end
+        
+        # save sitemap
+        run "generating #{Colorize.yellow("public/sitemap.xml")}..." do
+          sitemap.save File.join(root, "public", "sitemap.xml")
+        end
       end
       
       def render_haml(path)
         # extract metadata from file
-        meta = Glue::Template::Meta.new(path)
+        $meta = Glue::Template::Meta.new(path)
         
         # instantiate template helper
         helper = Glue::Template::Helper.new
         
         # instantiate and process haml for page
-        haml = Haml::Engine.new(meta.content)
-        content_for_layout = haml.to_html(helper)
+        haml = Haml::Engine.new($meta.content)
+        content_for_layout = haml.to_html(helper, $meta.data)
         
         # instantiate haml for layout
-        layout = File.read("#{root}/views/layouts/#{meta.metadata["layout"]}.haml")
+        layout = File.read("#{root}/views/layouts/#{$meta.data[:layout]}.haml")
         haml = Haml::Engine.new(layout)
-        vars = meta.metadata.merge({
+        
+        # set haml variables
+        vars = {}
+        vars.merge!($meta.data)
+        vars.merge!({
           :content_for_layout => content_for_layout,
-          :glue_version => Glue::VERSION
+          :generator => Glue::VERSION,
+          :last_update => File.mtime(path).xmlschema
         })
         
         # retrieve relative file path and set target
-        relative_path = path.sub("#{root}/views/", "").gsub(/\.haml$/, ".html")
-        target = File.join(root, "public", relative_path)
+        relative_path = path.sub("#{root}/views/", "").gsub(/\.haml$/, "")
+        target = File.join(root, "public", relative_path + ".html")
+        
+        # sitemap data
+        if config["use_extension"]
+          path_for_sitemap = relative_path + ".html"
+        else
+          path_for_sitemap = relative_path.gsub(/\/?index$/, "")
+        end
+        
+        mapping = {
+          :path => path_for_sitemap,
+          :changed_at => File.mtime(path),
+          :priority => $meta.data[:priority] || "0.5",
+          :frequency => $meta.data[:frequency] || "daily"
+        }
+        
+        unless $meta.data[:sitemap] == "no"
+          self.sitemap << mapping
+          self.sitemap << mapping.merge(:path => "/") if $meta.data[:index] == "yes"
+        end
         
         # create directories if necessary
         FileUtils.mkdir_p File.dirname(target)
@@ -72,7 +107,7 @@ module Glue
         end
         
         # save as index page
-        if meta.metadata["index"] == "true"
+        if $meta.data[:index] == "yes"
           index_path = File.join(root, "public", "index.html")
         
           File.open(index_path, "w+") do |f|

data/lib/glue/template/sitemap.rb

@@ -0,0 +1,36 @@
+module Glue
+  module Template
+    class Sitemap
+      attr_accessor :urls
+      attr_accessor :base_url
+      
+      def initialize
+        self.urls = []
+      end
+      
+      def <<(options)
+        self.urls << options
+      end
+      
+      def save(path)
+        file = File.open(path, "w+")
+        xml = Builder::XmlMarkup.new(:target => file, :indent => 2)
+        xml.instruct! :xml, :version => "1.1", :encoding => "UTF-8"
+        xml.comment! "Generated at #{Time.now.inspect}"
+        
+        xml.urlset :xmlns => "http://www.sitemaps.org/schemas/sitemap/0.9" do
+          urls.each do |options|
+            xml.url do
+              xml.loc         File.join(base_url, options[:path])
+              xml.lastmod     options[:changed_at].xmlschema if options[:changed_at]
+              xml.changefreq  options[:frequency] if options[:frequency]
+              xml.priority    options[:priority] if options[:priority]
+            end
+          end
+        end
+        
+        file.close
+      end
+    end
+  end
+end

data/lib/glue.rb

@@ -1,22 +1,25 @@
 module Glue
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end
 
 # add glue lib to load path
 $LOAD_PATH.unshift File.dirname(__FILE__)
 
 require "FileUtils" unless defined?(FileUtils)
-require "ostruct"
 require "open-uri"
 require "RedCloth"
 require "rdiscount"
 require "haml"
 require "sass"
 require "vendor/colorize-0.0.1/colorize"
+require "builder"
+require "uri"
+require "yaml"
 
 require "glue/helper"
 require "glue/generator"
 require "glue/template"
 require "glue/template/parser"
 require "glue/template/meta"
-require "glue/template/helper"
+require "glue/template/helper"
+require "glue/template/sitemap"

data/templates/404.haml

@@ -0,0 +1,16 @@
+/ title: Page not found
+/ description: The page you're looking for could not be found
+/ keywords: 
+/ layout: main
+/ id: not-found
+/ sitemap: no
+
+%h2 Page not found
+
+%p
+  %strong Sorry!
+  The page you're looking for could not be found.
+
+%p
+  Go back to the 
+  %a{"href" => "/"} home page

data/templates/glue.yml

@@ -0,0 +1,10 @@
+# Set your base url.
+# Include domain and path (if needed).
+# Domain is required for sitemap generation.
+base_url: http://example.com/some/path
+
+# Use extension when generating sitemap.
+# If you're using Apache you can enable `MultiViews`
+# and access your URL like http://example.com/about
+# instead of http://example.com/about.html
+use_extension: false

data/templates/htaccess

@@ -0,0 +1,20 @@
+# DEFLATE compresses files
+<IfModule mod_deflate.c>
+	<FilesMatch "\.(js|css)$">
+		SetOutputFilter DEFLATE
+	</FilesMatch>
+</IfModule>
+
+# Multiviews allows to access URLs like http://example.com/some/page.html
+# without the extension; so http://example.com/some/page will be valid as
+# well.
+Options +MultiViews
+
+# Set 404 page
+ErrorDocument 404 /404.html
+
+# Force PDF/ZIP download
+<FilesMatch "\.(?i:pdf|zip)$">
+  ForceType application/octet-stream
+  Header set Content-Disposition attachment
+</FilesMatch>

data/templates/main.haml

@@ -5,8 +5,9 @@
     %title= title
     %meta{"name" => "description", "content" => description}
     %meta{"name" => "keywords", "content" => keywords}
-    %meta{"name" => "generator", "content" => "Glue #{glue_version}"}
+    %meta{"name" => "generator", "content" => "Glue #{generator}"}
     %meta{"http-equiv" => "content-type", "content" => "text/html; charset=UTF-8"}
+    %meta{"http-equiv" => "last-update", "content" => last_update}
     %link{"rel" => "shortcut icon", "href" => "/favicon.ico", "type" => "image/x-icon"}
     %link{"rel" => "stylesheet", "href" => "/stylesheets/style.css", "type" => "text/css"}
     

data/templates/robots.txt

@@ -0,0 +1,4 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+# User-agent: *
+
+SITEMAP: /sitemap.xml

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fnando-glue
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Nando Vieira
@@ -52,6 +52,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: 
 email: 
 - fnando.vieira@gmail.com
@@ -67,7 +77,6 @@ files:
 - README.markdown
 - bin/glue
 - lib/glue
-- lib/glue/capistrano.rb
 - lib/glue/generator.rb
 - lib/glue/helper.rb
 - lib/glue/rake.rb
@@ -75,16 +84,21 @@ files:
 - lib/glue/template/helper.rb
 - lib/glue/template/meta.rb
 - lib/glue/template/parser.rb
+- lib/glue/template/sitemap.rb
 - lib/glue/template.rb
 - lib/glue.rb
 - lib/vendor
 - lib/vendor/colorize-0.0.1
 - lib/vendor/colorize-0.0.1/colorize.rb
+- templates/404.haml
 - templates/_footer.haml
+- templates/glue.yml
 - templates/helper.rb
+- templates/htaccess
 - templates/index.haml
 - templates/main.haml
 - templates/Rakefile
+- templates/robots.txt
 - templates/style.sass
 has_rdoc: true
 homepage: http://github.com/fnando/glue

data/lib/glue/capistrano.rb

@@ -1,5 +0,0 @@
-module Glue
-  module Capistrano
-    
-  end
-end