spinto 0.2.10 → 0.2.11

data/_plugins/sitemap_generator.rb

@@ -0,0 +1,275 @@
+# https://github.com/kinnetica/jekyll-plugins/blob/master/sitemap_generator.rb
+#
+# Sitemap.xml Generator is a Jekyll plugin that generates a sitemap.xml file by 
+# traversing all of the available posts and pages.
+# pke: modified to use site.config['sitemap']['url'] instead of MY_URL
+#
+# How To Use: 
+#   1.) Copy source file into your _plugins folder within your Jekyll project.
+#   2.) Set url or sitemap: url to reflect your domain name.
+#   3.) Set sitemap: filename if you want your sitemap to be called something
+#       other than sitemap.xml.
+#   4.) Change the PAGES_INCLUDE_POSTS list to include any pages that are looping 
+#       through your posts (e.g. "index.html", "archive.html", etc.). This will 
+#       ensure that right after you make a new post, the last modified date will 
+#       be updated to reflect the new post.
+#   5.) Run Jekyll: jekyll --server to re-generate your site.
+#   6.) A sitemap.xml should be included in your _site folder.
+#
+# Customizations:
+#   1.) If there are any files you don't want included in the sitemap, add them 
+#       to the EXCLUDED_FILES list. The name should match the name of the source 
+#       file.
+#   2.) If you want to include the optional changefreq and priority attributes,
+#       simply include custom variables in the YAML Front Matter of that file.
+#       The names of these custom variables are defined below in the
+#       CHANGE_FREQUENCY_CUSTOM_VARIABLE_NAME and PRIORITY_CUSTOM_VARIABLE_NAME
+#       constants.
+# 
+# Notes:
+#   1.) The last modified date is determined by the latest from the following:
+#       system modified date of the page or post, system modified date of
+#       included layout, system modified date of included layout within that
+#       layout, ... 
+#
+# Author: Michael Levin
+# Site: http://www.kinnetica.com
+# Distributed Under A Creative Commons License
+#   - http://creativecommons.org/licenses/by/3.0/
+
+require 'rexml/document'
+
+module Jekyll
+
+  # Change SITEMAP_FILE_NAME if you would like your sitemap file
+  # to be called something else
+  SITEMAP_FILE_NAME = "sitemap.xml"
+
+  # Any files to exclude from being included in the sitemap.xml
+  EXCLUDED_FILES = []
+
+  # Custom variable names for changefreq and priority elements
+  # These names are used within the YAML Front Matter of pages or posts
+  # for which you want to include these properties
+  CHANGE_FREQUENCY_CUSTOM_VARIABLE_NAME = "change_frequency"
+  PRIORITY_CUSTOM_VARIABLE_NAME = "priority"
+
+  # Recover from strange exception when starting server without --auto
+  class SitemapFile < StaticFile
+    def write(dest)
+      begin
+        super(dest)
+      rescue
+      end
+
+      true
+    end
+  end
+
+  class SitemapGenerator < Generator
+
+    # Valid values allowed by sitemap.xml spec for change frequencies
+    VALID_CHANGE_FREQUENCY_VALUES = ["always", "hourly", "daily", "weekly",
+      "monthly", "yearly", "never"] 
+
+    # Goes through pages and posts and generates sitemap.xml file
+    #
+    # Returns nothing
+    def generate(site)
+      sitemap = REXML::Document.new << REXML::XMLDecl.new("1.0", "UTF-8")
+
+      urlset = REXML::Element.new "urlset"
+      urlset.add_attribute("xmlns", 
+        "http://www.sitemaps.org/schemas/sitemap/0.9")
+
+      @last_modified_post_date = fill_posts(site, urlset)
+      fill_pages(site, urlset)
+
+      sitemap.add_element(urlset)
+
+      # Create destination directory if it doesn't exist yet. Otherwise, we cannot write our file there.
+      Dir::mkdir(site.dest) if !File.directory? site.dest
+
+      # File I/O: create sitemap.xml file and write out pretty-printed XML
+      filename = site.config['sitemap']['filename'] if site.config['sitemap']
+      filename ||= SITEMAP_FILE_NAME
+      file = File.new(File.join(site.dest, filename), "w")
+      formatter = REXML::Formatters::Pretty.new(4)
+      formatter.compact = true
+      formatter.write(sitemap, file)
+      file.close
+
+      # Keep the sitemap.xml file from being cleaned by Jekyll
+      site.static_files << Jekyll::SitemapFile.new(site, site.dest, "/", filename)
+    end
+
+    # Create url elements for all the posts and find the date of the latest one
+    #
+    # Returns last_modified_date of latest post
+    def fill_posts(site, urlset)
+      last_modified_date = nil
+      site.posts.each do |post|
+        if !excluded?(post.name)
+          url = fill_url(site, post)
+          urlset.add_element(url)
+        end
+
+        path = ".#{post.path_to_source}"
+        date = File.mtime(path)
+        last_modified_date = date if last_modified_date == nil or date > last_modified_date
+      end
+
+      last_modified_date
+    end
+
+    # Create url elements for all the normal pages and find the date of the
+    # index to use with the pagination pages
+    #
+    # Returns last_modified_date of index page
+    def fill_pages(site, urlset)
+      site.pages.each do |page|
+        if !excluded?(page.name)
+          path = ".#{page.path_to_source}"
+          if File.exists?(path)
+            url = fill_url(site, page)
+            urlset.add_element(url)
+          end
+        end
+      end
+    end
+
+    # Fill data of each URL element: location, last modified, 
+    # change frequency (optional), and priority.
+    #
+    # Returns url REXML::Element
+    def fill_url(site, page_or_post)
+      url = REXML::Element.new "url"
+
+      loc = fill_location(site, page_or_post)
+      url.add_element(loc)
+
+      lastmod = fill_last_modified(site, page_or_post)
+      url.add_element(lastmod) if lastmod
+
+      if (page_or_post.data[CHANGE_FREQUENCY_CUSTOM_VARIABLE_NAME])
+        change_frequency = 
+          page_or_post.data[CHANGE_FREQUENCY_CUSTOM_VARIABLE_NAME].downcase
+
+        if (valid_change_frequency?(change_frequency))
+          changefreq = REXML::Element.new "changefreq"
+          changefreq.text = change_frequency
+          url.add_element(changefreq)
+        else
+          puts "ERROR: Invalid Change Frequency In #{page_or_post.name}"
+        end
+      end
+
+      if (page_or_post.data[PRIORITY_CUSTOM_VARIABLE_NAME])
+        priority_value = page_or_post.data[PRIORITY_CUSTOM_VARIABLE_NAME]
+        if valid_priority?(priority_value)
+          priority = REXML::Element.new "priority"
+          priority.text = page_or_post.data[PRIORITY_CUSTOM_VARIABLE_NAME]
+          url.add_element(priority)
+        else
+          puts "ERROR: Invalid Priority In #{page_or_post.name}"
+        end
+      end
+
+      url
+    end
+
+    # Get URL location of page or post 
+    #
+    # Returns the location of the page or post
+    def fill_location(site, page_or_post)
+      loc = REXML::Element.new "loc"
+      url = site.config['sitemap']['url'] if site.config['sitemap']
+      url ||= site.config['url']
+      loc.text = "#{url[-1..-1] == '/' ? url[0..-2] : url}#{page_or_post.location_on_server}"
+
+      loc
+    end
+
+    # Fill lastmod XML element with the last modified date for the page or post.
+    #
+    # Returns lastmod REXML::Element or nil
+    def fill_last_modified(site, page_or_post)
+      path = ".#{page_or_post.path_to_source}"
+
+      lastmod = REXML::Element.new "lastmod"
+      date = File.mtime(path)
+      latest_date = find_latest_date(date, site, page_or_post)
+
+      case page_or_post
+      when Jekyll::Page
+        final_date = greater_date(latest_date, @last_modified_post_date)
+        lastmod.text = final_date.iso8601
+      else
+        lastmod.text = latest_date.iso8601
+      end
+      lastmod
+    end
+
+    # Go through the page/post and any implemented layouts and get the latest
+    # modified date
+    #
+    # Returns formatted output of latest date of page/post and any used layouts
+    def find_latest_date(latest_date, site, page_or_post)
+      layouts = site.layouts
+      layout = layouts[page_or_post.data["layout"]]
+      while layout
+        path = ".#{layout.path_to_source}"
+        date = File.mtime(path)
+
+        latest_date = date if (date > latest_date)
+
+        layout = layouts[layout.data["layout"]]
+      end
+
+      latest_date
+    end
+
+    # Which of the two dates is later
+    #
+    # Returns latest of two dates
+    def greater_date(date1, date2)
+      if (date1 >= date2) 
+        date1
+      else 
+        date2 
+      end
+    end
+
+    # Is the page or post listed as something we want to exclude?
+    #
+    # Returns boolean
+    def excluded?(name)
+      name_frags = name.split('.')
+      EXCLUDED_FILES.include?(name) || !(name_frags.last == name || %q{html markdown textile}.include?(name_frags.last))
+    end
+
+    def posts_included?(name)
+      PAGES_INCLUDE_POSTS.include? name
+    end
+
+    # Is the change frequency value provided valid according to the spec
+    #
+    # Returns boolean
+    def valid_change_frequency?(change_frequency)
+      VALID_CHANGE_FREQUENCY_VALUES.include? change_frequency
+    end
+
+    # Is the priority value provided valid according to the spec
+    #
+    # Returns boolean
+    def valid_priority?(priority)
+      begin
+        priority_val = Float(priority)
+        return true if priority_val >= 0.0 and priority_val <= 1.0
+      rescue ArgumentError
+      end
+
+      false
+    end
+  end
+end

data/bin/spinto-site

@@ -44,6 +44,10 @@ opts = OptionParser.new do |opts|
     options['url'] = url
   end
 
+  opts.on("--[no-]pygments", "Use pygments to highlight code (true at Spinto)") do |pygments|
+    options['pygments'] = pygments
+  end
+  
   opts.on("--version", "Display current version") do
     puts "Spinto " + Spinto::VERSION
     exit 0
@@ -69,7 +73,6 @@ end
 
 options['safe'] = false
 options['plugins'] = Spinto::PLUGINS_PATH
-options['pygments'] = true
 
 options = Jekyll.configuration(options)
 

data/lib/spinto.rb

@@ -1,5 +1,5 @@
 module Spinto
-  VERSION = '0.2.10'
+  VERSION = '0.2.11'
   PLUGINS_PATH = File.join(File.dirname(__FILE__), '..', '_plugins')
 
 end

data/spinto.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
 
   s.name              = 'spinto'
-  s.version           = '0.2.10'
-  s.date              = '2012-04-03'
+  s.version           = '0.2.11'
+  s.date              = '2012-04-24'
 
   s.summary     = "The site generator used at spintoapp.com"
   s.description = "Spinto uses Jekyll and plugins to build static sites, this gem provides the spinto-site builder."
@@ -42,6 +42,7 @@ Gem::Specification.new do |s|
     _plugins/less_converter.rb
     _plugins/sass_converter.rb
     _plugins/scss_converter.rb
+    _plugins/sitemap_generator.rb
     bin/spinto-site
     lib/spinto.rb
     spinto.gemspec

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spinto
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.2.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-03 00:00:00.000000000Z
+date: 2012-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spinto-jekyll
-  requirement: &2154469380 !ruby/object:Gem::Requirement
+  requirement: &2180915740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -21,10 +21,10 @@ dependencies:
         version: 0.11.2.3
   type: :runtime
   prerelease: false
-  version_requirements: *2154469380
+  version_requirements: *2180915740
 - !ruby/object:Gem::Dependency
   name: coffee-script
-  requirement: &2154468920 !ruby/object:Gem::Requirement
+  requirement: &2180915280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,10 +32,10 @@ dependencies:
         version: 2.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *2154468920
+  version_requirements: *2180915280
 - !ruby/object:Gem::Dependency
   name: sass
-  requirement: &2154468460 !ruby/object:Gem::Requirement
+  requirement: &2180914820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -43,10 +43,10 @@ dependencies:
         version: 3.1.15
   type: :runtime
   prerelease: false
-  version_requirements: *2154468460
+  version_requirements: *2180914820
 - !ruby/object:Gem::Dependency
   name: less
-  requirement: &2154468000 !ruby/object:Gem::Requirement
+  requirement: &2180914360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -54,10 +54,10 @@ dependencies:
         version: 2.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *2154468000
+  version_requirements: *2180914360
 - !ruby/object:Gem::Dependency
   name: RedCloth
-  requirement: &2154467540 !ruby/object:Gem::Requirement
+  requirement: &2180913900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -65,10 +65,10 @@ dependencies:
         version: 4.2.9
   type: :runtime
   prerelease: false
-  version_requirements: *2154467540
+  version_requirements: *2180913900
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2154467080 !ruby/object:Gem::Requirement
+  requirement: &2180913440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *2154467080
+  version_requirements: *2180913440
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &2154466620 !ruby/object:Gem::Requirement
+  requirement: &2180912980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,7 +87,7 @@ dependencies:
         version: '3.11'
   type: :development
   prerelease: false
-  version_requirements: *2154466620
+  version_requirements: *2180912980
 description: Spinto uses Jekyll and plugins to build static sites, this gem provides
   the spinto-site builder.
 email: matt.beale@madhatted.com
@@ -106,6 +106,7 @@ files:
 - _plugins/less_converter.rb
 - _plugins/sass_converter.rb
 - _plugins/scss_converter.rb
+- _plugins/sitemap_generator.rb
 - bin/spinto-site
 - lib/spinto.rb
 - spinto.gemspec
@@ -124,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4425238121308963726
+      hash: -1798746641388548046
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: