nanoc 2.1.1 → 2.1.2

data/ChangeLog

@@ -1,6 +1,13 @@
 nanoc Release Notes
 ===================
 
+2.1.2
+-----
+
+* Autocompiler now compiles assets as well
+* Sass filter now takes options (just like the Haml filter)
+* Haml/Sass options are now taken from the page *rep* instead of the page
+
 2.1.1
 -----
 

data/lib/nanoc/base/asset_rep.rb.orig

@@ -0,0 +1,280 @@
+module Nanoc
+
+  # A Nanoc::AssetRep is a single representation (rep) of an asset
+  # (Nanoc::Asset). An asset can have multiple representations. A
+  # representation has its own attributes and its own output file. A single
+  # asset can therefore have multiple output files, each run through a
+  # different set of filters with a different layout.
+  #
+  # An asset representation is observable. The following events will be
+  # notified:
+  #
+  # * :compilation_started
+  # * :compilation_ended
+  # * :filtering_started
+  # * :filtering_ended
+  #
+  # The compilation-related events have one parameters (the page
+  # representation); the filtering-related events have two (the page
+  # representation, and a symbol containing the filter class name).
+  class AssetRep
+
+    # The asset (Nanoc::Asset) to which this representation belongs.
+    attr_reader   :asset
+
+    # A hash containing this asset representation's attributes.
+    attr_accessor :attributes
+
+    # This asset representation's unique name.
+    attr_reader   :name
+
+    # Creates a new asset representation for the given asset and with the
+    # given attributes.
+    #
+    # +asset+:: The asset (Nanoc::Asset) to which the new representation will
+    #           belong.
+    #
+    # +attributes+:: A hash containing the new asset representation's
+    #                attributes. This hash must have been run through
+    #                Hash#clean before using it here.
+    #
+    # +name+:: The unique name for the new asset representation.
+    def initialize(asset, attributes, name)
+      # Set primary attributes
+      @asset      = asset
+      @attributes = attributes
+      @name       = name
+
+      # Reset flags
+      @compiled   = false
+      @modified   = false
+      @created    = false
+
+      # Reset stages
+      @filtered   = false
+    end
+
+    # Returns a proxy (Nanoc::AssetRepProxy) for this asset representation.
+    def to_proxy
+      @proxy ||= AssetRepProxy.new(self)
+    end
+
+    # Returns true if this asset rep's output file was created during the last
+    # compilation session, or false if the output file did already exist.
+    def created?
+      @created
+    end
+
+    # Returns true if this asset rep's output file was modified during the
+    # last compilation session, or false if the output file wasn't changed.
+    def modified?
+      @modified
+    end
+
+    # Returns true if this page rep has been compiled, false otherwise.
+    def compiled?
+      @compiled
+    end
+
+    # Returns the path to the output file, including the path to the output
+    # directory specified in the site configuration, and including the
+    # filename and extension.
+    def disk_path
+      @disk_path ||= @asset.site.router.disk_path_for(self)
+    end
+
+    # Returns the path to the output file as it would be used in a web
+    # browser: starting with a slash (representing the web root), and only
+    # including the filename and extension if they cannot be ignored (i.e.
+    # they are not in the site configuration's list of index files).
+    def web_path
+      compile(false, false)
+
+      @web_path ||= @asset.site.router.web_path_for(self)
+    end
+
+    # Returns true if this asset rep's output file is outdated and must be
+    # regenerated, false otherwise.
+    def outdated?
+      # Outdated if we don't know
+      return true if @asset.mtime.nil?
+
+      # Outdated if compiled file doesn't exist
+      return true if !File.file?(disk_path)
+
+      # Get compiled mtime
+      compiled_mtime = File.stat(disk_path).mtime
+
+      # Outdated if file too old
+      return true if @asset.mtime > compiled_mtime
+
+      # Outdated if asset defaults outdated
+      return true if @asset.site.asset_defaults.mtime.nil?
+      return true if @asset.site.asset_defaults.mtime > compiled_mtime
+
+      # Outdated if code outdated
+      return true if @asset.site.code.mtime.nil?
+      return true if @asset.site.code.mtime > compiled_mtime
+
+      return false
+    end
+
+    # Returns the attribute with the given name. This method will look in
+    # several places for the requested attribute:
+    #
+    # 1. This asset representation's attributes;
+    # 2. The attributes of this asset representation's asset;
+    # 3. The asset defaults' representation corresponding to this asset
+    #    representation;
+    # 4. The asset defaults in general;
+    # 5. The hardcoded asset defaults, if everything else fails.
+    def attribute_named(name)
+      # Check in here
+      return @attributes[name] if @attributes.has_key?(name)
+
+      # Check in asset
+      return @asset.attributes[name] if @asset.attributes.has_key?(name)
+
+      # Check in asset defaults' asset rep
+      asset_default_reps = @asset.site.asset_defaults.attributes[:reps] || {}
+      asset_default_rep  = asset_default_reps[@name] || {}
+      return asset_default_rep[name] if asset_default_rep.has_key?(name)
+
+      # Check in site defaults (global)
+      asset_defaults_attrs = @asset.site.asset_defaults.attributes
+      return asset_defaults_attrs[name] if asset_defaults_attrs.has_key?(name)
+
+      # Check in hardcoded defaults
+      return Nanoc::Asset::DEFAULTS[name]
+    end
+
+    # Compiles the asset representation and writes the result to the disk.
+    # This method should not be called directly; please use
+    # Nanoc::Compiler#run instead, and pass this asset representation's asset
+    # as its first argument.
+    #
+    # The asset representation will only be compiled if it wasn't compiled
+    # before yet. To force recompilation of the asset rep, forgetting any
+    # progress, set +from_scratch+ to true.
+    #
+    # +even_when_not_outdated+:: true if the asset rep should be compiled even
+    #                            if it is not outdated, false if not.
+    #
+    # +from_scratch+:: true if the asset rep should be filtered again even if
+    #                  it has already been filtered, false otherwise.
+    def compile(even_when_not_outdated, from_scratch)
+      # Don't compile if already compiled
+      return if @compiled and !from_scratch
+
+      # Skip unless outdated
+      unless outdated? or even_when_not_outdated
+        Nanoc::NotificationCenter.post(:compilation_started, self)
+        Nanoc::NotificationCenter.post(:compilation_ended,   self)
+        return
+      end
+
+      # Reset flags
+      @compiled = false
+      @modified = false
+      @created  = !File.file?(self.disk_path)
+
+      # Forget progress if requested
+      @filtered = false if from_scratch
+
+      # Start
+      @asset.site.compiler.stack.push(self)
+      Nanoc::NotificationCenter.post(:compilation_started, self)
+
+      # Compile
+      unless @filtered
+        if attribute_named(:binary) == true
+          compile_binary
+        else
+          compile_textual
+        end
+      end
+      @compiled = true
+
+      # Stop
+      @asset.site.compiler.stack.pop
+      Nanoc::NotificationCenter.post(:compilation_ended, self)
+    end
+
+  private
+
+    # Computes and returns the MD5 digest for the given file.
+    def digest(filename)
+      # Create hash
+      incr_digest = Digest::MD5.new()
+
+      # Collect data
+      File.open(filename, 'r') do |file|
+        incr_digest << file.read(1000) until file.eof?
+      end
+
+      # Calculate hex hash
+      incr_digest.hexdigest
+    end
+
+    # Compiles the asset rep, treating its contents as binary data.
+    def compile_binary
+      # Calculate digest before
+      digest_before = File.file?(disk_path) ? digest(disk_path) : nil
+
+      # Run filters
+      current_file = @asset.file
+      attribute_named(:filters).each do |filter_name|
+        # Free resources so that this filter won't fail
+        GC.start
+
+        # Create filter
+        klass = Nanoc::BinaryFilter.named(filter_name)
+        raise Nanoc::Errors::UnknownFilterError.new(filter_name) if klass.nil?
+        filter = klass.new(self.to_proxy, @asset.to_proxy, @asset.site)
+
+        # Run filter
+        Nanoc::NotificationCenter.post(:filtering_started, self, klass.identifier)
+        old_file = current_file
+        current_file = filter.run(current_file)
+        old_file.close
+        Nanoc::NotificationCenter.post(:filtering_ended,   self, klass.identifier)
+      end
+
+      # Write asset
+      FileUtils.mkdir_p(File.dirname(self.disk_path))
+      FileUtils.cp(current_file.path, disk_path)
+
+      # Calculate digest after
+      digest_after = digest(disk_path)
+      @modified = (digest_after != digest_before)
+    end
+
+    # Compiles the asset rep, treating its contents as textual data.
+    def compile_textual
+      # Get content
+      current_content = @asset.file.read
+
+      # Check modified
+      @modified = @created ? true : File.read(self.disk_path) != current_content
+
+      # Run filters
+      attribute_named(:filters).each do |filter_name|
+        # Create filter
+        klass = Nanoc::Filter.named(filter_name)
+        raise Nanoc::Errors::UnknownFilterError.new(filter_name) if klass.nil?
+        filter = klass.new(self)
+
+        # Run filter
+        Nanoc::NotificationCenter.post(:filtering_started, self, klass.identifier)
+        current_content = filter.run(current_content)
+        Nanoc::NotificationCenter.post(:filtering_ended,   self, klass.identifier)
+      end
+
+      # Write asset
+      FileUtils.mkdir_p(File.dirname(self.disk_path))
+      File.open(self.disk_path, 'w') { |io| io.write(current_content) }
+    end
+
+  end
+
+end

data/lib/nanoc/base/template.rb.orig

@@ -0,0 +1,68 @@
+module Nanoc
+
+  # A Nanoc::Template represents a template, which can be used for creating
+  # new pages. Pages don't necessary have to be created using templates, but
+  # they can be useful for generating pages where you only have to "fill in
+  # the blanks".
+  class Template
+
+    # The Nanoc::Site this template belongs to.
+    attr_accessor :site
+
+    # The name of this template.
+    attr_reader :name
+
+    # The raw content a page created using this template will have.
+    attr_reader :page_content
+
+    # A hash containing the attributes a page created using this template will
+    # have.
+    attr_reader :page_attributes
+
+    # Creates a new template.
+    #
+    # +name+:: The name of this template.
+    #
+    # +page_content+:: The raw content a page created using this template will
+    #                  have.
+    #
+    # +page_attributes+:: A hash containing the attributes a page created
+    #                     using this template will have.
+    def initialize(page_content, page_attributes, name)
+      @page_content     = page_content
+      @page_attributes  = page_attributes.clean
+      @name             = name
+    end
+
+    def inspect
+      "Nanoc::Template(name=#{@name})"
+    end
+
+    # Saves the template in the database, creating it if it doesn't exist yet
+    # or updating it if it already exists. Tells the site's data source to
+    # save the template.
+    def save
+      @site.data_source.loading do
+        @site.data_source.save_template(self)
+      end
+    end
+
+    # Renames the template. Tells the site's data source to rename the
+    # template.
+    def move_to(new_name)
+      @site.data_source.loading do
+        @site.data_source.move_template(self, new_name)
+      end
+    end
+
+    # Deletes the template. Tells the site's data source to delete the
+    # template.
+    def delete
+      @site.data_source.loading do
+        @site.data_source.delete_template(self)
+      end
+    end
+
+  end
+
+end

data/lib/nanoc/extra/auto_compiler.rb

@@ -173,12 +173,16 @@ END
         # Reload site data
         @site.load_data(true)
 
-        # Get page or file
-        page_reps = @site.pages.map { |p| p.reps }.flatten
-        page_rep  = page_reps.find { |p| p.web_path == path.cleaned_path }
+        # Get paths
+        rep_path  = path.cleaned_path
         file_path = @site.config[:output_dir] + path
 
-        if page_rep.nil?
+        # Find rep
+        objs = @site.pages + @site.assets
+        reps = objs.map { |o| o.reps }.flatten
+        rep = reps.find { |r| r.web_path == rep_path }
+
+        if rep.nil?
           # Serve file
           if File.file?(file_path)
             serve_file(file_path)
@@ -186,8 +190,8 @@ END
             serve_404(path)
           end
         else
-          # Serve page rep
-          serve_page_rep(page_rep)
+          # Serve rep
+          serve_rep(rep)
         end
       end
     end
@@ -244,19 +248,22 @@ END
       ]
     end
 
-    def serve_page_rep(page_rep)
-      # Recompile page rep
+    def serve_rep(rep)
+      # Recompile rep
       begin
-        @site.compiler.run([ page_rep.page ], :even_when_not_outdated => @include_outdated)
+        @site.compiler.run(
+          [ rep.respond_to?(:page) ? rep.page : rep.asset ],
+          :even_when_not_outdated => @include_outdated
+        )
       rescue Exception => exception
-        return serve_500(page_rep.web_path, exception)
+        return serve_500(rep.web_path, exception)
       end
 
       # Build response
       [
         200,
-        { 'Content-Type' => mime_type_of(page_rep.disk_path, 'text/html') },
-        [ page_rep.content(:post) ]
+        { 'Content-Type' => mime_type_of(rep.disk_path, 'text/html') },
+        [ rep.content(:post) ]
       ]
     end
 

data/lib/nanoc/filters/haml.rb

@@ -8,7 +8,7 @@ module Nanoc::Filters
       require 'haml'
 
       # Get options
-      options = @page.attribute_named(:haml_options) || {}
+      options = @page_rep.attribute_named(:haml_options) || {}
 
       # Create context
       context = ::Nanoc::Extra::Context.new(assigns)

data/lib/nanoc/filters/sass.rb

@@ -6,7 +6,11 @@ module Nanoc::Filters
     def run(content)
       require 'sass'
 
-      ::Sass::Engine.new(content).render
+      # Get options
+      options = @page_rep.attribute_named(:sass_options) || {}
+
+      # Get result
+      ::Sass::Engine.new(content, options).render
     end
 
   end

data/lib/nanoc/helpers/link_to.rb.orig

@@ -0,0 +1,73 @@
+module Nanoc::Helpers
+
+  # Nanoc::Helpers::LinkTo contains functions for linking to pages.
+  module LinkTo
+
+    include Nanoc::Helpers::HTMLEscape
+
+    # Creates a HTML link to the given path or page/asset representation, and
+    # with the given text.
+    #
+    # +path_or_rep+:: the URL or path (a String) that should be linked to, or
+    #                 the page or asset representation that should be linked
+    #                 to.
+    #
+    # +text+:: the visible link text.
+    #
+    # +attributes+:: a hash containing HTML attributes that will be added to
+    #                the link.
+    #
+    # Examples:
+    #
+    #   link_to('Blog', '/blog/')
+    #   # => '<a href="/blog/">Blog</a>'
+    #
+    #   page_rep = @pages.find { |p| p.page_id == 'special' }.reps(:default)
+    #   link_to('Special Page', page_rep)
+    #   # => '<a href="/special_page/">Special Page</a>'
+    #
+    #   link_to('Blog', '/blog/', :title => 'My super cool blog')
+    #   # => '<a href="/blog/" title="My super cool blog">Blog</a>
+    def link_to(text, path_or_rep, attributes={})
+      # Find path
+      if path_or_rep.is_a?(String)
+        path = path_or_rep
+      else
+        path = (@config[:base_dir] || '') + path_or_rep.path
+      end
+
+      # Join attributes
+      attributes = attributes.inject('') do |memo, (key, value)|
+        memo + key.to_s + '="' + h(value) + '" '
+      end
+
+      # Create link
+      "<a #{attributes}href=\"#{path}\">#{text}</a>"
+    end
+
+    # Creates a HTML link using link_to, except when the linked page is the
+    # current one. In this case, a span element with class "active" and with
+    # the given text will be returned.
+    #
+    # Examples:
+    #
+    #   link_to('Blog', '/blog/')
+    #   # => '<a href="/blog/">Blog</a>'
+    #
+    #   link_to('This Page', @page_rep)
+    #   # => '<span class="active">This Page</span>'
+    def link_to_unless_current(text, path_or_rep, attributes={})
+      # Find path
+      path = path_or_rep.is_a?(String) ? path_or_rep : path_or_rep.path
+
+      if @page_rep and @page_rep.path == path
+        # Create message
+        "<span class=\"active\" title=\"You're here.\">#{text}</span>"
+      else
+        link_to(text, path_or_rep, attributes)
+      end
+    end
+
+  end
+
+end

data/lib/nanoc.rb

@@ -1,7 +1,7 @@
 module Nanoc
 
   # The current nanoc version.
-  VERSION = '2.1.1'
+  VERSION = '2.1.2'
 
   # Generic error. Superclass for all nanoc-specific errors.
   class Error < RuntimeError ; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nanoc
 version: !ruby/object:Gem::Version 
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors: 
 - Denis Defreyne
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-18 00:00:00 +02:00
+date: 2008-09-08 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -32,6 +32,7 @@ files:
 - lib/nanoc/base/asset.rb
 - lib/nanoc/base/asset_defaults.rb
 - lib/nanoc/base/asset_rep.rb
+- lib/nanoc/base/asset_rep.rb.orig
 - lib/nanoc/base/binary_filter.rb
 - lib/nanoc/base/code.rb
 - lib/nanoc/base/compiler.rb
@@ -58,6 +59,7 @@ files:
 - lib/nanoc/base/router.rb
 - lib/nanoc/base/site.rb
 - lib/nanoc/base/template.rb
+- lib/nanoc/base/template.rb.orig
 - lib/nanoc/binary_filters
 - lib/nanoc/binary_filters/image_science_thumbnail.rb
 - lib/nanoc/cli
@@ -114,6 +116,7 @@ files:
 - lib/nanoc/helpers/capturing.rb
 - lib/nanoc/helpers/html_escape.rb
 - lib/nanoc/helpers/link_to.rb
+- lib/nanoc/helpers/link_to.rb.orig
 - lib/nanoc/helpers/render.rb
 - lib/nanoc/helpers/tagging.rb
 - lib/nanoc/helpers/xml_sitemap.rb