ace 0.1 → 0.3

data/CHANGELOG

@@ -1,3 +1,13 @@
-= Version 0.0.1
+= Version 0.3
+  * Added LazyRendering mixin.
+  * Added SassFilter.
+  * Added PygmentsFilter for syntax highlighting.
+  * Added Static class for copying static files.
+
+= Version 0.2
+  * Filters inheritance.
+  * Item#permalink and Item#server_path.
+
+= Version 0.1
   * Items
   * Generators

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Jakub Šťastný aka Botanicus
+Copyright (c) 2010 – 2011 Jakub Šťastný aka Botanicus
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.textile

@@ -1,3 +1,13 @@
+h1. About
+
+Ace is a static page generator like "Nanoc":http://nanoc.stoneship.org, "Jekyll":https://github.com/mojombo/jekyll or "Webby":http://webby.rubyforge.org/tutorial. How is it different? Well, it's better :) ! I really like Nanoc and I used it for quite a while, but it's not flexible enough. If you need to generate a lot of pages on the fly, it's a hassle. It provides helpers, but helpers are – let's face it – programming style we used to use years back when we yet believed that PHP is actually a really nice language.
+
+Ace chose an OOP approach
+
+Another common proble of these generators is, that they are way too opinionated. Thanks Webby, but I don't give a damn about your Sitemap, thank you very much!
+
+Also, last but not least, Ace has a real template inheritance. Layouts are for kids, real men use template inheritance! What's the advantage? It's incredibly flexible. You can have
+
 h1. Why you should be interested in ace?
 
 In Ace, every page is an instance
@@ -7,11 +17,11 @@ There are also *generators* available for easier generating items on the fly.
 
 Ace has *template inheritance*. I love template inheritance, it's more flexible pattern than layouts.
 
-Tasks for deployment included.
+Tasks for deployment are included.
 
 h1. The boot process
 
-# load @boot.rb@ where the
+# Load @boot.rb@ where the
 # load the rules (controllers / globs mapping)
 # load & instantiate the items: only the renderables (concrete post)
 # run the filters, layoutin' ... actually this can be defined in the controller

data/bin/ace

@@ -2,7 +2,7 @@
 # encoding: utf-8
 
 if RUBY_VERSION < "1.9.1"
-  abort "Ace requires Ruby 1.9."
+  abort "Ace requires Ruby 1.9"
 end
 
 base   = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
@@ -40,7 +40,7 @@ end
 rules.rules.each do |klass, files|
   puts "#{klass} #{files.inspect}"
   files.each do |file|
-    if File.binread(file).match(/^-{3,5}\s*$/)
+    if File.binread(file).match(/^-{3,5}\s*$/) # TODO: this should be a filter or lazy-loaded
       raw_item = Ace::RawItem.new(file).tap(&:parse)
       item = klass.create(raw_item.metadata, raw_item.content)
     else
@@ -52,14 +52,14 @@ end
 
 puts
 
-rules.generators.each do |generator_klass|
-  puts "~ Running #{generator_klass}"
-  generator = generator_klass.new
+# Generator is anything what provides #generate method.
+rules.generators.each do |generator|
+  puts "~ Running generator #{generator}"
   begin
-    if generator.respond_to?(:run)
-      generator.run
+    if generator.respond_to?(:generate)
+      generator.generate
     else
-      abort "Generator #{generator.inspect} doesn't respond to the #run method!"
+      abort "Generator #{generator.inspect} doesn't respond to the #generate method!"
     end
   rescue Exception => exception
     puts "Error in generator #{generator.inspect}: #{exception.message}"
@@ -71,6 +71,5 @@ end
 puts
 
 Ace::Item.all_instances.each do |item|
-  puts "~ Generating #{item.output_path}"
   item.save!
 end

data/lib/ace.rb

@@ -9,8 +9,13 @@
 
 require "yaml"
 require "fileutils"
+require "ace/filters/sass"
 
 module Ace
+  module Helpers
+    # include your helpers here
+  end
+
   class RawItem
     attr_accessor :path, :metadata, :content
     def initialize(path)
@@ -19,11 +24,11 @@ module Ace
 
     def parse
       pieces = @data.split(/^-{3,5}\s*$/)
-      if pieces.size < 3
-        raise RuntimeError.new(
-          "The file '#{content_filename}' appears to start with a metadata section (three or five dashes at the top) but it does not seem to be in the correct format."
-        )
-      end
+      # if pieces.size < 3
+      #   raise RuntimeError.new(
+      #     "The file '#{path}' appears to start with a metadata section (three or five dashes at the top) but it does not seem to be in the correct format."
+      #   )
+      # end
 
       # Parse
       self.metadata = YAML.load(pieces[1]).inject(Hash.new) { |metadata, pair| metadata.merge(pair[0].to_sym => pair[1]) } || Hash.new
@@ -36,10 +41,12 @@ module Ace
   class Item
     def self.inherited(subclass)
       self.subclasses << subclass
+      subclass.before_filters.push(*self.before_filters)
+      subclass.after_filters.push(*self.after_filters)
     end
 
     def self.subclasses
-      @subclasses ||= Array.new
+      @subclasses ||= [self]
     end
 
     def self.instances
@@ -111,6 +118,23 @@ module Ace
       end
     end
 
+    def server_path
+      absolute = self.output_path.sub(/^output\//, "")
+      "/#{absolute}"
+    end
+
+    def base_url
+      self.config[:base_url]
+    end
+
+    def permalink
+      if self.config[:base_url].nil?
+        raise "You have to add :base_url into config.yml or redefine #base_url method!"
+      end
+
+      "#{self.base_url}#{self.server_path}"
+    end
+
     attr_writer :output_path
     def output_path
       @output_path ||= begin
@@ -122,6 +146,7 @@ module Ace
 
     def save!
       content = self.render # so filters can influence output_path
+      puts "~ [RENDER] #{self.output_path}"
 
       FileUtils.mkdir_p File.dirname(self.output_path)
       File.open(self.output_path, "w") do |file|
@@ -131,10 +156,6 @@ module Ace
   end
 
   class Asset < Item
-  end
-
-  module Helpers
-    def link_to(anchor, path_or_item, options = nil)
-    end
+    before Ace::SassFilter
   end
 end

data/lib/ace/filters/layout.rb

@@ -10,12 +10,16 @@ end
 
 module Ace
   class LayoutFilter < Filter
+    class Scope
+      include Ace::Helpers
+    end
+
     def initialize(options)
       @path = options[:layout]
     end
 
     def call(item, content)
-      template = TemplateInheritance::Template.new(@path)
+      template = TemplateInheritance::Template.new(@path, Scope.new)
       return template.render(item: item)
     end
   end

data/lib/ace/filters/pygments.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require "ace/filters"
+require "nokogiri"
+require "albino"
+
+module Ace
+  class PygmentsFilter < Filter
+    def call(item, content)
+      doc = Nokogiri::HTML(content)
+      doc.css("pre[lang]").each do |pre|
+        unless pre['lang'].nil? || pre['lang'].empty?
+          # Set $VERBOSE to nil if you don't want to see this message.
+          warn "~ Syntax highlight in '#{item.original_path}' using '#{pre['lang']}' lexer."
+          pre.replace Albino.colorize(pre.content, pre['lang'])
+        end
+      end
+      doc.to_s
+    end
+  end
+end

data/lib/ace/filters/sass.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+require "sass"
+require "ace/filters"
+
+module Ace
+  class SassFilter < Filter
+    def call(item, content)
+      if item.output_path && item.output_path.end_with?(".scss")
+        item.output_path.sub!(/scss$/, "css")
+        begin
+          engine = Sass::Engine.new(content, {:syntax => :scss})
+          output = engine.render
+        rescue Exception => e
+          warn "~~ SassFilter exception: #{e}"
+          abort
+        end
+        return output
+      else
+        return content
+      end
+    end
+  end
+end

data/lib/ace/filters/template.rb

@@ -12,8 +12,10 @@ TemplateInheritance::Template.paths << File.join(Dir.pwd, "content")
 
 module Ace
   class TemplateFilter < Filter
+    TEMPLATE_EXTS_PATTERN = /\.(haml|erb|erubis)$/i
+
     def call(item, content)
-      if item.output_path
+      if item.output_path.match(TEMPLATE_EXTS_PATTERN)
         item.output_path = item.output_path.split(".")[0..-2].join(".")
       end
 

data/lib/ace/mixins/lazy.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+# Sometimes rendering is taking too long, so you want to skip
+# it in case that nothing changed in the files which influence
+# the output. For example syntax highlighting via Pygments takes
+# a while, so it's better to include this mixin and redefine
+# #source_files to include every file which influence the output.
+module Ace
+  module LazyRendering
+    def compare_mtime(one, others)
+      File.exist?(one) && File.mtime(one) > others.map { |post| File.mtime(post) }.max
+    end
+
+    # @api public
+    def source_files
+      [self.original_path]
+    end
+
+    def fresh?
+      @fresh ||= compare_mtime(self.output_path, self.source_files)
+    end
+
+    def save!
+      if self.fresh?
+        puts "~ [IGNORE] #{self.output_path}"
+      else
+        super
+      end
+    end
+  end
+end

data/lib/ace/static.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require "ace/filters/template"
+
+# rule Ace::Static, "about.html.haml"
+# rule Ace::Static("output/index.html"), "index.html.haml"
+module Ace
+  def self.Static(output_path)
+    Class.new(Static) do
+      define_method(:output_path) do
+        output_path
+      end
+    end
+  end
+
+  class Static < Item
+    before Ace::TemplateFilter
+  end
+end

data/lib/ace/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Ace
-  VERSION = "0.1"
+  VERSION = "0.3"
 end

metadata

@@ -1,18 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: ace
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  version: "0.1"
+  prerelease: 
+  version: "0.3"
 platform: ruby
 authors: 
 - "Jakub \xC5\xA0\xC5\xA5astn\xC3\xBD aka Botanicus"
 autorequire: 
 bindir: bin
 cert_chain: 
-date: 2011-02-17 00:00:00 +00:00
+date: 2011-03-17 00:00:00 +00:00
 default_executable: ace
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -23,8 +20,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -36,11 +31,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 0
-        - 1
-        - 2
         version: 0.0.1.2
   type: :development
   version_requirements: *id002
@@ -93,7 +83,11 @@ files:
 - lib/ace/filters.rb
 - lib/ace/filters/haml.rb
 - lib/ace/filters/layout.rb
+- lib/ace/filters/pygments.rb
+- lib/ace/filters/sass.rb
 - lib/ace/filters/template.rb
+- lib/ace/mixins/lazy.rb
+- lib/ace/static.rb
 - lib/ace/version.rb
 - project_generator/metadata.yml
 - project_generator/postprocess.rb
@@ -103,8 +97,7 @@ has_rdoc: true
 homepage: http://github.com/botanicus/ace
 licenses: []
 
-post_install_message: "[\e[32mVersion 0.0.1\e[0m] Items\n\
-  [\e[32mVersion 0.0.1\e[0m] Generators\n"
+post_install_message: 
 rdoc_options: []
 
 require_paths: 
@@ -114,22 +107,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ~>
     - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 9
       version: "1.9"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: ace
-rubygems_version: 1.3.7
+rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
 summary: Ace is highly flexible static pages generator with template inheritance.