fnando-glue 0.0.3 → 0.0.4

data/README.markdown

@@ -27,8 +27,6 @@ TODO
 ----
 
 * Write documentation
-* Automatically generate sitemap
-* Generate feed
 
 MAINTAINER
 ----------

data/glue.gemspec

@@ -2,12 +2,9 @@
 # RUN : 'rake gem:update_gemspec'
 
 Gem::Specification.new do |s|
-  s.required_rubygems_version = ">= 0"
-  s.has_rdoc = true
-  s.email = ["fnando.vieira@gmail.com"]
-  s.name = "glue"
   s.homepage = "http://github.com/fnando/glue"
   s.bindir = "bin"
+  s.name = "glue"
   s.executables = ["glue"]
   s.summary = "Glue is a simple and dumb static site generator."
   s.add_dependency "main", ">= 0"
@@ -15,17 +12,20 @@ Gem::Specification.new do |s|
   s.add_dependency "rdiscount", ">= 0"
   s.add_dependency "haml", ">= 0"
   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/config.rb",
+ "lib/glue/core_ext.rb",
  "lib/glue/generator.rb",
  "lib/glue/helper.rb",
  "lib/glue/rake.rb",
  "lib/glue/template",
+ "lib/glue/template/base.rb",
+ "lib/glue/template/feed.rb",
  "lib/glue/template/helper.rb",
  "lib/glue/template/meta.rb",
  "lib/glue/template/parser.rb",
@@ -46,4 +46,8 @@ Gem::Specification.new do |s|
  "templates/robots.txt",
  "templates/style.sass"]
   s.authors = ["Nando Vieira"]
+  s.required_rubygems_version = ">= 0"
+  s.version = "0.0.4"
+  s.has_rdoc = true
+  s.email = ["fnando.vieira@gmail.com"]
 end

data/lib/glue.rb

@@ -1,5 +1,5 @@
 module Glue
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end
 
 # add glue lib to load path
@@ -16,10 +16,14 @@ require "builder"
 require "uri"
 require "yaml"
 
+require "glue/core_ext"
+require "glue/config"
 require "glue/helper"
 require "glue/generator"
 require "glue/template"
-require "glue/template/parser"
-require "glue/template/meta"
+require "glue/template/base"
 require "glue/template/helper"
+require "glue/template/meta"
+require "glue/template/parser"
+require "glue/template/feed"
 require "glue/template/sitemap"

data/lib/glue/config.rb

@@ -0,0 +1,8 @@
+module Glue
+  class Config < Hash
+    def initialize
+      path = File.join(GLUE_ROOT, "config", "glue.yml")
+      self.replace YAML.load_file(path).symbolize_keys
+    end
+  end
+end

data/lib/glue/core_ext.rb

@@ -0,0 +1,13 @@
+class Hash
+  def symbolize_keys
+    inject({}) do |options, (key, value)|
+      value = value.symbolize_keys if value.respond_to?(:symbolize_keys)
+      options[(key.to_sym rescue key) || key] = value
+      options
+    end
+  end
+  
+  def symbolize_keys!
+    self.replace(self.symbolize_keys)
+  end
+end

data/lib/glue/template/base.rb

@@ -0,0 +1,36 @@
+module Glue
+  module Template
+    class Base
+      attr_accessor :items
+      attr_accessor :config
+      attr_accessor :filters
+      
+      def initialize(config)
+        self.config = config
+        self.items = []
+        self.filters = []
+      end
+      
+      def <<(options)
+        self.items << options
+      end
+      
+      def apply_filters
+        filtered_items = []
+        
+        items.each do |options|
+          filters.collect do |f|
+            r = Regexp.new(f, Regexp::MULTILINE|Regexp::EXTENDED|Regexp::IGNORECASE)
+            filtered_items << options and break if options[:path] =~ r
+          end
+        end
+
+        filtered_items
+      end
+      
+      def save(path)
+        raise "This is an abstract method; override it!"
+      end
+    end
+  end
+end

data/lib/glue/template/feed.rb

@@ -0,0 +1,71 @@
+module Glue
+  module Template
+    class Feed < Base
+      RSS_TIME_FORMAT = "%a, %d %b %Y %H:%M:%S %z"
+      
+      def save(path)
+        # create a file handler
+        file = File.open(path, "w+")
+        
+        # sort and keep latest 10 items
+        self.filters = config[:feed][:filters]
+        
+        filtered_items = apply_filters
+        filtered_items = filtered_items.sort_by {|options| options[:updated_at].to_i }
+        filtered_items.reverse!
+        filtered_items = filtered_items[0,10]
+        
+        # instantiate builder
+        xml = Builder::XmlMarkup.new(:target => file, :indent => 2)
+        xml.instruct! :xml, :version => "1.1", :encoding => "UTF-8"
+        
+        feed_opts = {
+          "xmlns" => "http://www.w3.org/2005/Atom",
+          "xml:lang" => config[:site][:language],
+          "xml:base" => "http://www.example.org"
+        }
+        
+        xml.feed(feed_opts) do
+          # set feed id to url
+          xml.id config[:site][:base_url]
+          
+          # set title
+          xml.title config[:site][:title]
+          
+          # set description
+          xml.subtitle config[:site][:description]
+          
+          # set link to site
+          xml.link(:href => config[:site][:base_url])
+          
+          # set link to feed
+          xml.link(:href => File.join(config[:site][:base_url], "feed.xml"), :rel => "self")
+          
+          # add update date as the saving time 
+          xml.updated Time.now.xmlschema
+          
+          # add generator info
+          xml.generator("Glue", :uri => "http://github.com/fnando/glue", :version => Glue::VERSION)
+          
+          # set language
+          xml.language config[:site][:language]
+          
+          filtered_items.each do |options|
+            url = File.join(config[:site][:base_url], options[:path])
+            
+            xml.entry do
+              xml.title options[:title]
+              xml.summary options[:description]
+              xml.updated options[:updated_at].xmlschema
+              xml.link :rel => "alternate", :type => "text/html", :href => url
+              xml.id url
+            end
+          end
+        end
+        
+        # close handler
+        file.close
+      end
+    end
+  end
+end

data/lib/glue/template/helper.rb

@@ -1,6 +1,19 @@
 module Glue
   module Template
     class Helper
+      def config
+        @config ||= YAML.load_file(GLUE_ROOT + "/config/glue.yml")
+      end
+      
+      def url_for(path)
+        uri = URI.parse(config["base_url"])
+        base_path = uri.path.chomp("/")
+        
+        path = File.join(base_path, path)
+        path << ".html" if config["use_extension"] && base_path !~ /\.html$/
+        path
+      end
+      
       def markdown(text)
         RDiscount.new(text).to_html
       end

data/lib/glue/template/meta.rb

@@ -13,10 +13,12 @@ module Glue
     
       def process!
         self.content = body.gsub /^\/ *(.*?): *(.*?) *$/sm do |m|
-          data[$1.to_sym] = $2
+          data[$1] = $2
           ""
         end
+        
+        self.data.symbolize_keys!
       end
     end
   end
-end
+end

data/lib/glue/template/parser.rb

@@ -3,16 +3,16 @@ module Glue
     class Parser
       attr_accessor :root
       attr_accessor :sitemap
+      attr_accessor :feed
       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"]
+        @config = Glue::Config.new        
+        @sitemap = Glue::Template::Sitemap.new(@config)
+        @feed = Glue::Template::Feed.new(@config)
       end
       
       def run!
@@ -43,8 +43,17 @@ module Glue
         end
         
         # save sitemap
-        run "generating #{Colorize.yellow("public/sitemap.xml")}..." do
-          sitemap.save File.join(root, "public", "sitemap.xml")
+        if config[:sitemap][:enabled]
+          run "generating #{Colorize.yellow("public/sitemap.xml")}..." do
+            sitemap.save File.join(root, "public", "sitemap.xml")
+          end
+        end
+        
+        # save feed
+        if config[:feed][:enabled]
+          run "generating #{Colorize.yellow("public/feed.xml")}..." do
+            feed.save File.join(root, "public", "feed.xml")
+          end
         end
       end
       
@@ -77,24 +86,27 @@ module Glue
         target = File.join(root, "public", relative_path + ".html")
         
         # sitemap data
-        if config["use_extension"]
-          path_for_sitemap = relative_path + ".html"
-        else
+        if config[:site][:friendly_url]
           path_for_sitemap = relative_path.gsub(/\/?index$/, "")
+        else
+          path_for_sitemap = relative_path + ".html"
         end
         
-        mapping = {
+        # merge meta data with some template info
+        mapping = $meta.data.merge({
           :path => path_for_sitemap,
-          :changed_at => File.mtime(path),
-          :priority => $meta.data[:priority] || "0.5",
-          :frequency => $meta.data[:frequency] || "daily"
-        }
+          :updated_at => File.mtime(path)
+        })
         
         unless $meta.data[:sitemap] == "no"
           self.sitemap << mapping
           self.sitemap << mapping.merge(:path => "/") if $meta.data[:index] == "yes"
         end
         
+        unless $meta.data[:feed] == "no"
+          self.feed << mapping
+        end
+        
         # create directories if necessary
         FileUtils.mkdir_p File.dirname(target)
         

data/lib/glue/template/sitemap.rb

@@ -1,28 +1,20 @@
 module Glue
   module Template
-    class Sitemap
-      attr_accessor :urls
-      attr_accessor :base_url
-      
-      def initialize
-        self.urls = []
-      end
-      
-      def <<(options)
-        self.urls << options
-      end
-      
+    class Sitemap < Base
       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}"
         
+        self.filters = config[:sitemap][:filters]
+        filtered_items = apply_filters
+        
         xml.urlset :xmlns => "http://www.sitemaps.org/schemas/sitemap/0.9" do
-          urls.each do |options|
+          filtered_items.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.loc         File.join(config[:site][:base_url], options[:path])
+              xml.lastmod     options[:updated_at].xmlschema if options[:updated_at]
               xml.changefreq  options[:frequency] if options[:frequency]
               xml.priority    options[:priority] if options[:priority]
             end

data/templates/404.haml

@@ -4,6 +4,7 @@
 / layout: main
 / id: not-found
 / sitemap: no
+/ feed: no
 
 %h2 Page not found
 

data/templates/glue.yml

@@ -1,10 +1,40 @@
-# Set your base url.
-# Include domain and path (if needed).
-# Domain is required for sitemap generation.
-base_url: http://example.com/some/path
+site:
+  # Set default page title.
+  title: "Glue is awesome!"
+  
+  # Set default page description
+  description: "This awesome page has been generated using Glue <http://github.com/fnando/glue>!"
+  
+  # Set default keywords
+  keywords: "glue, ruby, haml, sass"
+  
+  # Set your base url.
+  # Include domain and path (if needed).
+  # Domain is required for sitemap generation.
+  base_url: http://example.com/some/path
+  
+  # If you're using Apache you can enable `MultiViews`
+  # or mod_rewrite and access your URL like 
+  # http://example.com/about instead of http://example.com/about.html
+  friendly_url: true
+  
+  # Set your language for feeds and meta tags
+  language: en-us
 
-# 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
+sitemap:
+  # Do generate sitemap
+  enabled: true
+  
+  # Filters will be applied against full filename.
+  # Use .*? to match all. Use regular expressions.
+  filters:
+    - .*?
+  
+feed:
+  # Do generate feed
+  enabled: true
+  
+  # Filters will be applied against full filename.
+  # Use .*? to match all. Use regular expressions.
+  filters:
+    - .*?

data/templates/htaccess

@@ -5,11 +5,6 @@
 	</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
 
@@ -18,3 +13,17 @@ ErrorDocument 404 /404.html
   ForceType application/octet-stream
   Header set Content-Disposition attachment
 </FilesMatch>
+
+# Enable Multiviews by default. Use mod rewrite
+# rules if you prefer.
+Options +MultiViews
+
+<IfModule mod_rewrite.c>
+	RewriteEngine Off
+
+	# handle existing file /some/path.html as /some/path
+	RewriteCond %{REQUEST_FILENAME} !-f
+	RewriteCond %{REQUEST_URI} !-d
+	RewriteCond %{REQUEST_FILENAME}.html -f
+	RewriteRule (.*) /$1.html
+</IfModule>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fnando-glue
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Nando Vieira
@@ -77,10 +77,14 @@ files:
 - README.markdown
 - bin/glue
 - lib/glue
+- lib/glue/config.rb
+- lib/glue/core_ext.rb
 - lib/glue/generator.rb
 - lib/glue/helper.rb
 - lib/glue/rake.rb
 - lib/glue/template
+- lib/glue/template/base.rb
+- lib/glue/template/feed.rb
 - lib/glue/template/helper.rb
 - lib/glue/template/meta.rb
 - lib/glue/template/parser.rb