nanoc3 3.2.4 → 3.3.0

data/lib/nanoc3/filters/sass.rb

@@ -1,66 +0,0 @@
-# encoding: utf-8
-
-require 'sass'
-require 'set'
-
-module Nanoc3::Filters
-  class Sass < Nanoc3::Filter
-
-    class << self
-      # The current filter. This is definitely going to bite me if I ever get
-      # to multithreading nanoc.
-      attr_accessor :current
-    end
-
-    # Essentially the `Sass::Importers::Filesystem` but registering each
-    # import file path.
-    class SassFilesystemImporter < ::Sass::Importers::Filesystem
-
-      private
-
-      def _find(dir, name, options)
-        full_filename, syntax = find_real_file(dir, name)
-        return unless full_filename && File.readable?(full_filename)
-
-        filter = Nanoc3::Filters::Sass.current
-        item = filter.imported_filename_to_item(full_filename)
-        filter.depend_on([ item ]) unless item.nil?
-
-        options[:syntax] = syntax
-        options[:filename] = full_filename
-        options[:importer] = self
-        ::Sass::Engine.new(File.read(full_filename), options)
-      end
-    end
-
-    # Runs the content through [Sass](http://sass-lang.com/).
-    # Parameters passed to this filter will be passed on to Sass.
-    #
-    # @param [String] content The content to filter
-    #
-    # @return [String] The filtered content
-    def run(content, params={})
-      # Build options
-      options = params.dup
-      sass_filename = options[:filename] ||
-        (@item && @item[:content_filename])
-      options[:filename] ||= sass_filename
-      options[:filesystem_importer] ||=
-        Nanoc3::Filters::Sass::SassFilesystemImporter
-
-      # Render
-      engine = ::Sass::Engine.new(content, options)
-      self.class.current = self
-      engine.render
-    end
-
-    def imported_filename_to_item(filename)
-      path = Pathname.new(filename).realpath
-      @items.find do |i|
-        next if i[:content_filename].nil?
-        Pathname.new(i[:content_filename]).realpath == path
-      end
-    end
-
-  end
-end

data/lib/nanoc3/filters/slim.rb

@@ -1,25 +0,0 @@
-# encoding: utf-8
-
-require 'slim'
-
-module Nanoc3::Filters
-
-  # @since 3.2.0
-  class Slim < Nanoc3::Filter
-
-    # Runs the content through [Slim](http://slim-lang.com/)
-    # This method takes no options.
-    #
-    # @param [String] content The content to filter
-    #
-    # @return [String] The filtered content
-    def run(content, params={})
-      # Create context
-      context = ::Nanoc3::Context.new(assigns)
-
-      ::Slim::Template.new { content }.render(context) { assigns[:content] }
-    end
-
-  end
-
-end

data/lib/nanoc3/filters/typogruby.rb

@@ -1,23 +0,0 @@
-# encoding: utf-8
-
-require 'typogruby'
-
-module Nanoc3::Filters
-
-  # @since 3.2.0
-  class Typogruby < Nanoc3::Filter
-
-    # Runs the content through [Typogruby](http://avdgaag.github.com/typogruby/).
-    # This method takes no options.
-    #
-    # @param [String] content The content to filter
-    #
-    # @return [String] The filtered content
-    def run(content, params={})
-      # Get result
-      ::Typogruby.improve(content)
-    end
-
-  end
-
-end

data/lib/nanoc3/filters/uglify_js.rb

@@ -1,42 +0,0 @@
-# encoding: utf-8
-
-require 'uglifier'
-
-module Nanoc3::Filters
-  class UglifyJS < Nanoc3::Filter
-
-    # Runs the content through [UglifyJS](https://github.com/mishoo/UglifyJS/).
-    # This method optionally takes options to pass directly to Uglifier:
-    #
-    #   {
-    #     :mangle => true, # Mangle variables names
-    #     :toplevel => false, # Mangle top-level variable names
-    #     :except => [], # Variable names to be excluded from mangling
-    #     :max_line_length => 32 * 1024, # Maximum line length
-    #     :squeeze => true, # Squeeze code resulting in smaller, but less-readable code
-    #     :seqs => true, # Reduce consecutive statements in blocks into single statement
-    #     :dead_code => true, # Remove dead code (e.g. after return)
-    #     :unsafe => false, # Optimizations known to be unsafe in some situations
-    #     :copyright => true, # Show copyright message
-    #     :beautify => false, # Ouput indented code
-    #     :beautify_options => {
-    #       :indent_level => 4,
-    #       :indent_start => 0,
-    #       :quote_keys => false,
-    #       :space_colon => 0,
-    #       :ascii_only => false
-    #     }
-    #   }
-    #
-    # @param [String] content The content to filter
-    #
-    # @option params [Array] :options ([]) A list of options to pass on to Uglifier
-    #
-    # @return [String] The filtered content
-    def run(content, params={})
-      # Add filename to load path
-      Uglifier.new(params).compile(content)
-    end
-
-  end
-end

data/lib/nanoc3/helpers.rb

@@ -1,16 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3::Helpers
-
-  autoload 'Blogging',    'nanoc3/helpers/blogging'
-  autoload 'Breadcrumbs', 'nanoc3/helpers/breadcrumbs'
-  autoload 'Capturing',   'nanoc3/helpers/capturing'
-  autoload 'Filtering',   'nanoc3/helpers/filtering'
-  autoload 'HTMLEscape',  'nanoc3/helpers/html_escape'
-  autoload 'LinkTo',      'nanoc3/helpers/link_to'
-  autoload 'Rendering',   'nanoc3/helpers/rendering'
-  autoload 'Tagging',     'nanoc3/helpers/tagging'
-  autoload 'Text',        'nanoc3/helpers/text'
-  autoload 'XMLSitemap',  'nanoc3/helpers/xml_sitemap'
-
-end

data/lib/nanoc3/helpers/blogging.rb

@@ -1,319 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3::Helpers
-
-  # Provides functionality for building blogs, such as finding articles and
-  # constructing feeds.
-  #
-  # This helper has a few requirements. First, all blog articles should have
-  # the following attributes:
-  #
-  # * `kind` - Set to `"article"`
-  #
-  # * `created_at` - The article's publication timestamp
-  #
-  # Some functions in this blogging helper, such as the {#atom_feed} function,
-  # require additional attributes to be set; these attributes are described in
-  # the documentation for these functions.
-  #
-  # All "time" item attributes, site configuration attributes or method
-  # parameters can either be a `Time` instance or a string in any format
-  # parseable by `Time.parse`.
-  #
-  # The two main functions are {#sorted_articles} and {#atom_feed}.
-  module Blogging
-
-    # Returns an unsorted list of articles, i.e. items where the `kind`
-    # attribute is set to `"article"`.
-    #
-    # @return [Array] An array containing all articles
-    def articles
-      @items.select { |item| item[:kind] == 'article' }
-    end
-
-    # Returns a sorted list of articles, i.e. items where the `kind`
-    # attribute is set to `"article"`. Articles are sorted by descending
-    # creation date, so newer articles appear before older articles.
-    #
-    # @return [Array] A sorted array containing all articles
-    def sorted_articles
-      articles.sort_by do |a|
-        attribute_to_time(a[:created_at])
-      end.reverse
-    end
-
-    # Returns a string representing the atom feed containing recent articles,
-    # sorted by descending creation date.
-    #
-    # The following attributes must be set on blog articles:
-    #
-    # * `title` - The title of the blog post
-    #
-    # * `kind` and `created_at` (described above)
-    #
-    # The following attributes can optionally be set on blog articles to
-    # change the behaviour of the Atom feed:
-    #
-    # * `excerpt` - An excerpt of the article, which is usually only a few
-    #   lines long.
-    #
-    # * `custom_path_in_feed` - The path that will be used instead of the
-    #   normal path in the feed. This can be useful when including
-    #   non-outputted items in a feed; such items could have their custom feed
-    #   path set to the blog path instead, for example.
-    #
-    # * `custom_url_in_feed` - The url that will be used instead of the
-    #   normal url in the feed (generated from the site's base url + the item
-    #   rep's path). This can be useful when building a link-blog where the
-    #   URL of article is a remote location.
-    #
-    # * `updated_at` - The time when the article was last modified. If this
-    #   attribute is not present, the `created_at` attribute will be used as
-    #   the time when the article was last modified.
-    #
-    # The site configuration will need to have the following attributes:
-    #
-    # * `base_url` - The URL to the site, without trailing slash. For
-    #   example, if the site is at "http://example.com/", the `base_url`
-    #   would be "http://example.com".
-    #
-    # The feed item will need to know about the feed title, the feed author
-    # name, and the URI corresponding to the author. These can be specified
-    # using parameters, as attributes in the feed item, or in the site
-    # configuration.   
-    #
-    # * `title` - The title of the feed, which is usually also the title of
-    #   the blog.
-    #
-    # * `author_name` - The name of the item's author.
-    #
-    # * `author_uri` - The URI for the item's author, such as the author's
-    #   web site URL.
-    #
-    # The feed item can have the following optional attributes:
-    #
-    # * `feed_url` - The custom URL of the feed. This can be useful when the
-    #   private feed URL shouldn't be exposed; for example, when using
-    #   FeedBurner this would be set to the public FeedBurner URL.
-    #
-    # To construct a feed, create a new item and make sure that it is
-    # filtered with `:erb` or `:erubis`; it should not be laid out. Ensure
-    # that it is routed to the proper path, e.g. `/blog.xml`. It may also be
-    # useful to set the `is_hidden` attribute to true, so that helpers such
-    # as the sitemap helper will ignore the item. The content of the feed
-    # item should be `<%= atom_feed %>`.
-    #
-    # @example Defining compilation and routing rules for a feed item
-    #
-    #   compile '/blog/feed/' do
-    #     filter :erb
-    #   end
-    #
-    #   route '/blog/feed/' do
-    #     '/blog.xml'
-    #   end
-    #
-    # @example Limiting the number of items in a feed
-    #
-    #   <%= atom_feed :limit => 5 %>
-    #
-    # @option params [Number] :limit (5) The maximum number of articles to
-    #   show
-    #
-    # @option params [Array] :articles (sorted_articles) A list of articles to
-    #   include in the feed
-    #
-    # @option params [Proc] :content_proc (->{ |article|
-    #   article.compiled_content(:snapshot => :pre) }) A proc that returns the
-    #   content of the given article, which is passed as a parameter. This
-    #   function may not return nil.
-    #
-    # @option params [proc] :excerpt_proc (->{ |article| article[:excerpt] })
-    #   A proc that returns the excerpt of the given article, passed as a
-    #   parameter. This function should return nil if there is no excerpt.
-    #
-    # @option params [String] :title The feed's title, if it is not given in
-    #   the item attributes.
-    #
-    # @option params [String] :author_name The name of the feed's author, if
-    #   it is not given in the item attributes.
-    #
-    # @option params [String] :author_uri The URI of the feed's author, if it
-    #   is not given in the item attributes.
-    #
-    # @return [String] The generated feed content
-    def atom_feed(params={})
-      require 'builder'
-
-      # Extract parameters
-      limit             = params[:limit] || 5
-      relevant_articles = params[:articles] || articles || []
-      content_proc      = params[:content_proc] || lambda { |a| a.compiled_content(:snapshot => :pre) }
-      excerpt_proc      = params[:excerpt_proc] || lambda { |a| a[:excerpt] }
-
-      # Check config attributes
-      if @site.config[:base_url].nil?
-        raise RuntimeError.new('Cannot build Atom feed: site configuration has no base_url')
-      end
-
-      # Check feed item attributes
-      title = params[:title] || @item[:title] || @site.config[:title]
-      if title.nil?
-        raise RuntimeError.new('Cannot build Atom feed: no title in params, item or site config')
-      end
-      author_name = params[:author_name] || @item[:author_name] || @site.config[:author_name]
-      if author_name.nil?
-        raise RuntimeError.new('Cannot build Atom feed: no author_name in params, item or site config')
-      end
-      author_uri = params[:author_uri] || @item[:author_uri] || @site.config[:author_uri]
-      if author_uri.nil?
-        raise RuntimeError.new('Cannot build Atom feed: no author_uri in params, item or site config')
-      end
-
-      # Check article attributes
-      if relevant_articles.empty?
-        raise RuntimeError.new('Cannot build Atom feed: no articles')
-      end
-      if relevant_articles.any? { |a| a[:created_at].nil? }
-        raise RuntimeError.new('Cannot build Atom feed: one or more articles lack created_at')
-      end
-
-      # Get sorted relevant articles
-      sorted_relevant_articles = relevant_articles.sort_by do |a|
-        attribute_to_time(a[:created_at])
-      end.reverse.first(limit)
-
-      # Get most recent article
-      last_article = sorted_relevant_articles.first
-
-      # Create builder
-      buffer = ''
-      xml = Builder::XmlMarkup.new(:target => buffer, :indent => 2)
-
-      # Build feed
-      xml.instruct!
-      xml.feed(:xmlns => 'http://www.w3.org/2005/Atom') do
-        root_url = @site.config[:base_url] + '/'
-
-        # Add primary attributes
-        xml.id      root_url
-        xml.title   title
-
-        # Add date
-        xml.updated(attribute_to_time(last_article[:created_at]).to_iso8601_time)
-
-        # Add links
-        xml.link(:rel => 'alternate', :href => root_url)
-        xml.link(:rel => 'self',      :href => feed_url)
-
-        # Add author information
-        xml.author do
-          xml.name  author_name
-          xml.uri   author_uri
-        end
-
-        # Add articles
-        sorted_relevant_articles.each do |a|
-          # Get URL
-          url = url_for(a)
-          next if url.nil?
-
-          xml.entry do
-            # Add primary attributes
-            xml.id        atom_tag_for(a)
-            xml.title     a[:title], :type => 'html'
-
-            # Add dates
-            xml.published attribute_to_time(a[:created_at]).to_iso8601_time
-            xml.updated   attribute_to_time(a[:updated_at] || a[:created_at]).to_iso8601_time
-        
-            # Add specific author information
-            if a[:author_name] || a[:author_uri]
-              xml.author do
-                xml.name  a[:author_name] || author_name
-                xml.uri   a[:author_uri]  || author_uri
-              end
-            end
-
-            # Add link
-            xml.link(:rel => 'alternate', :href => url)
-
-            # Add content
-            summary = excerpt_proc.call(a)
-            xml.content   content_proc.call(a), :type => 'html'
-            xml.summary   summary, :type => 'html' unless summary.nil?
-          end
-        end
-      end
-
-      buffer
-    end
-
-    # Returns the URL for the given item. It will return the URL containing
-    # the custom path in the feed if possible, otherwise the normal path.
-    #
-    # @param [Nanoc3::Item] item The item for which to fetch the URL.
-    #
-    # @return [String] The URL of the given item
-    def url_for(item)
-      # Check attributes
-      if @site.config[:base_url].nil?
-        raise RuntimeError.new('Cannot build Atom feed: site configuration has no base_url')
-      end
-
-      # Build URL
-      if item[:custom_url_in_feed]
-        item[:custom_url_in_feed]
-      elsif item[:custom_path_in_feed]
-        @site.config[:base_url] + item[:custom_path_in_feed]
-      elsif item.path
-        @site.config[:base_url] + item.path
-      end
-    end
-
-    # Returns the URL of the feed. It will return the custom feed URL if set,
-    # or otherwise the normal feed URL.
-    #
-    # @return [String] The URL of the feed
-    def feed_url
-      # Check attributes
-      if @site.config[:base_url].nil?
-        raise RuntimeError.new('Cannot build Atom feed: site configuration has no base_url')
-      end
-
-      @item[:feed_url] || @site.config[:base_url] + @item.path
-    end
-
-    # Returns an URI containing an unique ID for the given item. This will be
-    # used in the Atom feed to uniquely identify articles. These IDs are
-    # created using a procedure suggested by Mark Pilgrim and described in his
-    # ["How to make a good ID in Atom" blog post]
-    # (http://diveintomark.org/archives/2004/05/28/howto-atom-id).
-    #
-    # @param [Nanoc3::Item] item The item for which to create an atom tag
-    #
-    # @return [String] The atom tag for the given item
-    def atom_tag_for(item)
-      hostname, base_dir = %r{^.+?://([^/]+)(.*)$}.match(@site.config[:base_url])[1..2]
-
-      formatted_date = attribute_to_time(item[:created_at]).to_iso8601_date
-
-      'tag:' + hostname + ',' + formatted_date + ':' + base_dir + (item.path || item.identifier)
-    end
-
-    # Converts the given attribute (which can be a string, a Time or a Date)
-    # into a Time.
-    #
-    # @param [String, Time, Date] time Something that contains time
-    #   information but is not necessarily a Time instance yet
-    #
-    # @return [Time] The Time instance corresponding to the given input
-    def attribute_to_time(time)
-      time = Time.local(time.year, time.month, time.day) if time.is_a?(Date)
-      time = Time.parse(time) if time.is_a?(String)
-      time
-    end
-
-  end
-
-end