awestructx 0.4.0

data/lib/awestruct/extensions/data_dir.rb

@@ -0,0 +1,31 @@
+module Awestruct
+  module Extensions
+    class DataDir
+
+      def initialize(data_dir="_data")
+        @data_dir = data_dir
+      end
+
+      def watch(watched_dirs)
+          watched_dirs << @data_dir
+      end
+
+      def execute(site)
+        Dir[ "#{site.dir}/#{@data_dir}/*" ].each do |entry|
+          if ( File.directory?( entry ) )
+            data_key = File.basename( entry )
+            data_map = {}
+            Dir[ "#{entry}/*" ].each do |chunk|
+              File.basename( chunk ) =~ /^([^\.]+)/
+              key = $1.to_sym
+              chunk_page = site.engine.load_page( chunk )
+              data_map[ key ] = chunk_page
+            end
+            site.send( "#{data_key}=", data_map )
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/awestruct/extensions/disqus.rb

@@ -0,0 +1,62 @@
+require 'digest/sha1'
+
+module Awestruct
+  module Extensions
+    class Disqus
+
+      def execute(site)
+        site.pages.each{ |p| p.extend Disqus }
+      end
+
+      module Disqus
+        def disqus_comments()
+          identifier = "null"
+          if self.disqus_identifier or site.disqus_generate_id
+            identifier = %Q("#{self.resolve_disqus_identifier()}")
+          end
+          %Q{
+            <div id="disqus_thread"></div>
+            <script type="text/javascript">
+            var disqus_shortname = '#{site.disqus}';
+            var disqus_url = "#{site.base_url}#{self.url}";
+            var disqus_developer = #{site.disqus_developer ? 1 : "null"};
+            var disqus_identifier = #{identifier};
+            (function() {
+              var dsq = document.createElement("script"); dsq.type = "text/javascript"; dsq.async = true;
+              dsq.src = "http://#{site.disqus}.disqus.com/embed.js";
+              (document.getElementsByTagName("head")[0] || document.getElementsByTagName("body")[0]).appendChild(dsq);
+            })();
+            </script>
+            <noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript=#{site.disqus}">comments powered by Disqus.</a></noscript>
+          }
+        end
+
+        def disqus_comments_link()
+          identifier = ''
+          if self.disqus_identifier or site.disqus_generate_id
+            identifier = %Q{ data-disqus-identifier="#{self.resolve_disqus_identifier()}"}
+          end
+          %Q{ <a href="#{self.url}#disqus_thread"#{identifier}>Comments</a> }
+        end
+
+        def disqus_comments_count()
+          %Q{
+            <script type="text/javascript">
+            var disqus_shortname = '#{site.disqus}';
+            (function () {
+              var s = document.createElement('script'); s.async = true;
+              s.src = "http://disqus.com/forums/#{site.disqus}/count.js";
+              (document.getElementsByTagName('HEAD')[0] || document.getElementsByTagName('BODY')[0]).appendChild(s);
+            }());
+            </script>
+          }
+        end
+
+        def resolve_disqus_identifier()
+          self.disqus_identifier ? self.disqus_identifier : Digest::SHA1.hexdigest(self.date.strftime('%Y-%m-%d-') + self.slug)
+        end
+
+      end
+    end
+  end
+end

data/lib/awestruct/extensions/extend_string.rb

@@ -0,0 +1,97 @@
+# RemoveAccents version 1.0.3 (c) 2008-2009 Solutions Informatiques Techniconseils inc.
+# 
+# This module adds 2 methods to the string class. 
+# Up-to-date version and documentation available at:
+#
+# http://www.techniconseils.ca/en/scripts-remove-accents-ruby.php
+#
+# This script is available under the following license :
+# Creative Commons Attribution-Share Alike 2.5.
+#
+# See full license and details at :
+# http://creativecommons.org/licenses/by-sa/2.5/ca/
+#
+# Version history:
+#   * 1.0.3 : July 23 2009
+#               Corrected some incorrect character codes. Source is now wikipedia at:
+#                 http://en.wikipedia.org/wiki/ISO/IEC_8859-1#Related_character_maps
+#               Thanks to Raimon Fernandez for pointing out the incorrect codes.
+#   * 1.0.2 : October 29 2008
+#               Slightly optimized version of urlize - Jonathan Grenier (jgrenier@techniconseils.ca)
+#   * 1.0.1 : October 29 2008
+#               First public revision - Jonathan Grenier (jgrenier@techniconseils.ca)
+#
+
+class String
+  # The extended characters map used by removeaccents. The accented characters 
+  # are coded here using their numerical equivalent to sidestep encoding issues.
+  # These correspond to ISO-8859-1 encoding.
+  ACCENTS_MAPPING = {
+    'E' => [200,201,202,203],
+    'e' => [232,233,234,235],
+    'A' => [192,193,194,195,196,197],
+    'a' => [224,225,226,227,228,229,230],
+    'C' => [199],
+    'c' => [231],
+    'O' => [210,211,212,213,214,216],
+    'o' => [242,243,244,245,246,248],
+    'I' => [204,205,206,207],
+    'i' => [236,237,238,239],
+    'U' => [217,218,219,220],
+    'u' => [249,250,251,252],
+    'N' => [209],
+    'n' => [241],
+    'Y' => [221],
+    'y' => [253,255],
+    'AE' => [306],
+    'ae' => [346],
+    'OE' => [188],
+    'oe' => [189]
+  }
+  
+  
+  # Remove the accents from the string. Uses String::ACCENTS_MAPPING as the source map.
+  def removeaccents    
+    str = String.new(self)
+    String::ACCENTS_MAPPING.each {|letter,accents|
+      packed = accents.pack('U*')
+      rxp = Regexp.new("[#{packed}]", nil, 'U')
+      str.gsub!(rxp, letter)
+    }
+    
+    str
+  end
+  
+  
+  # Convert a string to a format suitable for a URL without ever using escaped characters.
+  # It calls strip, removeaccents, downcase (optional) then removes the spaces (optional)
+  # and finally removes any characters matching the default regexp (/[^-_A-Za-z0-9]/).
+  #
+  # Options
+  #
+  # * :downcase => call downcase on the string (defaults to true)
+  # * :convert_spaces => Convert space to underscore (defaults to false)
+  # * :regexp => The regexp matching characters that will be converting to an empty string (defaults to /[^-_A-Za-z0-9]/)
+  def urlize(options = {})
+    options[:downcase] ||= true
+    options[:convert_spaces] ||= false
+    options[:regexp] ||= /[^-_A-Za-z0-9]/
+    
+    str = self.strip.removeaccents
+    str.downcase! if options[:downcase]
+    str.gsub!(/\ /,'-') if options[:convert_spaces]
+    str.gsub(options[:regexp], '')
+  end
+
+  # This follows the generated ID rules
+  def anchorize(options = {})
+    options[:downcase] ||= true
+    options[:convert_spaces] ||= false
+    options[:regexp] ||= /[^-_A-Za-z0-9]/
+    
+    str = self.strip.removeaccents
+    str.downcase! if options[:downcase]
+    str.gsub!(/\ /,'_') if options[:convert_spaces]
+    str.gsub(options[:regexp], '')
+  end
+end

data/lib/awestruct/extensions/flattr.rb

@@ -0,0 +1,42 @@
+module Awestruct
+  module Extensions
+    class Flattr
+
+      def execute(site)
+        site.pages.each{|p| p.extend Flattrable }
+      end
+
+      module Flattrable
+        def flattr_javascript()
+          html = %Q|<script type='text/javascript'> /* <![CDATA[ */     (function() {\n|
+          html += %Q|var s = document.createElement('script'), t = document.getElementsByTagName('script')[0];|
+          html += %Q|s.type = 'text/javascript';\n|
+          html += %Q|s.async = true;\n|
+          html += %Q|s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto&uid=#{site.flattr_username}&category=text';\n|
+          html += %Q|t.parentNode.insertBefore(s, t);\n|
+          html += %Q|})(); /* ]]> */ </script>|
+          html
+        end
+        def flattr_large_counter(param={})
+          url = param[:url] ? param[:url] : site.base_url + self.url
+          title = param[:title] ? param[:title] : self.title
+          category = param[:category] ? param[:category] : "text"
+          tags = param[:tags] ? "tags:" + param[:tags] + ";" : ""
+          html = %Q|<a class="FlattrButton" style="display:none;" href="#{url}" title="#{title}" |
+          html += %Q|rev="flattr;uid:#{site.flattr_username};category:#{category};#{tags}"></a>|
+          html
+        end
+        def flattr_compact_counter(param={})
+          url = param[:url] ? param[:url] : site.base_url + self.url
+          title = param[:title] ? param[:title] : self.title
+          category = param[:category] ? param[:category] : "text"
+          tags = param[:tags] ? "tags:" + param[:tags] + ";" : ""
+          html = %Q|<a class="FlattrButton" style="display:none;" href="#{url}" title="#{title}" |
+          html += %Q|rev="flattr;button:compact;uid:#{site.flattr_username};category:#{category};#{tags}"></a>|
+          html
+        end
+      end
+
+    end
+  end
+end

data/lib/awestruct/extensions/google_analytics.rb

@@ -0,0 +1,38 @@
+module Awestruct
+  module Extensions
+    module GoogleAnalytics
+
+      def google_analytics()
+        html = ''
+        html += %Q(<script type="text/javascript">\n)
+        html += %Q(var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");\n)
+        html += %Q(document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));\n)
+        html += %Q(</script>\n)
+        html += %Q(<script type="text/javascript">\n)
+        html += %Q(try {\n)
+        html += %Q(var pageTracker = _gat._getTracker("#{site.google_analytics}");\n)
+        html += %Q(pageTracker._trackPageview();\n)
+        html += %Q(} catch(err) {}</script>\n)
+        html
+      end
+
+      def google_analytics_async()
+        html = ''
+        html += %Q(<script type="text/javascript">\n)
+        html += %Q(var _gaq = _gaq || [];\n)
+        html += %Q(_gaq.push(['_setAccount','#{site.google_analytics}']);\n)
+        if site.google_analytics_anonymize
+          html += %Q(_gaq.push(['_gat._anonymizeIp']);\n)
+        end
+        html += %Q(_gaq.push(['_trackPageview']);\n)
+        html += %Q[(function() {\n]
+        html += %Q( var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\n)
+        html += %Q( ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\n)
+        html += %Q( var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\n)
+        html += %Q[})();\n</script>\n]
+        html
+      end
+
+    end
+  end
+end

data/lib/awestruct/extensions/gsub.rb

@@ -0,0 +1,20 @@
+module Awestruct
+  module Extensions
+    class Gsub
+
+      def initialize(pattern, replacement, options = {})
+        @pattern = pattern
+        @replacement = replacement
+        @gsub_required = options[:gsub_required] || lambda { |site, page| page.output_path.end_with?(".html") }
+      end
+
+      def transform(site, page, rendered)
+        if (@gsub_required.call(site, page))
+          rendered = rendered.gsub(@pattern, @replacement)
+        end
+        rendered
+      end
+
+    end
+  end
+end

data/lib/awestruct/extensions/indexifier.rb

@@ -0,0 +1,17 @@
+module Awestruct
+  module Extensions
+    class Indexifier
+
+      def execute(site)
+        site.pages.each do |page|
+          if ( page.inhibit_indexifier || ( page.output_path =~ /^(.*\/)?index.html$/ ) )
+            # skip it!
+          else
+            page.output_path = page.output_path.gsub( /.html$/, '/index.html' )
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/awestruct/extensions/intense_debate.rb

@@ -0,0 +1,38 @@
+require 'digest/sha1'
+
+module Awestruct
+  module Extensions
+    class IntenseDebate
+
+      def execute(site)
+        site.pages.each{|p| p.extend IntenseDebatable }
+      end
+
+      module IntenseDebatable
+        def intense_debate_comments()
+          post_id = self.post_id ? self.post_id : Digest::SHA1.hexdigest( self.url )
+          html = %Q(<script>\n)
+          html += %Q(  var idcomments_acct='#{site.intense_debate_acct}';\n)
+          html += %Q(  var idcomments_post_id='#{post_id}';\n )
+          html += %Q(  var idcomments_post_url='#{site.intense_debate_base_url || site.base_url}#{self.url}';\n)
+          html += %Q(</script>\n)
+          html += %Q(<span id="IDCommentsPostTitle" style="display:none"></span>\n)
+          html += %Q(<script type='text/javascript' src='http://www.intensedebate.com/js/genericCommentWrapperV2.js'></script>\n)
+          html
+        end
+
+        def intense_debate_comments_link()
+          post_id = self.post_id ? self.post_id : Digest::SHA1.hexdigest( self.url )
+          html = %Q(<script>\n)
+          html += %Q(  var idcomments_acct='#{site.intense_debate_acct}';\n)
+          html += %Q(  var idcomments_post_id='#{post_id}';\n )
+          html += %Q(  var idcomments_post_url='#{self.url}';\n)
+          html += %Q(</script>\n)
+          html += %Q(<script type='text/javascript' src='http://www.intensedebate.com/js/genericLinkWrapperV2.js'></script>\n)
+          html
+        end
+
+      end
+    end
+  end
+end

data/lib/awestruct/extensions/minify.rb

@@ -0,0 +1,178 @@
+require 'fileutils'
+
+##
+# Awestruct:Extensions:Minify is a transformer that minimizes JavaScript, CSS and HTML files.
+# The transform runs on the rendered stream before it's written to the output path.
+#
+# Minification is performed by the following three libraries:
+#
+#   htmlcompressor (minifies HTML): http://code.google.com/p/htmlcompressor/
+#   yuicompressor (minifies JavaScript and CSS): http://developer.yahoo.com/yui/compressor/
+#   pngcrush (minifies PNG): http://pmt.sourceforge.net/pngcrush/
+#
+# These commands must be available on your PATH in order to use them.
+#
+# This class is loaded as a transformer in the Awestruct pipeline. The
+# constructor accepts an array of symbols representing the file types to minimize.
+#
+#   extension Awestruct::Extensions::Minify.new
+#
+# This transform recognizes the following symbols:
+#
+#   :css - CSS files with extension .css
+#   :js - JavaScript files with extension .js
+#   :html - HTML files with extension .html
+#   :png - PNG files with extension .png
+#
+# If no types are specified, the default value [:css, :js] is used.
+# 
+# In addition to registering the transformer in the pipeline, it must be enabled
+# by setting the following site property in _ext/config.yml:
+#
+#   minify: true
+#
+# You can limit activation to one or more profiles: 
+#
+#   profiles:
+#     production:
+#       minify: true
+#
+# You can also configure the option arguments passed to the compressor programs. Here's
+# how you specify options arguments for the htmlcompressor command:
+#
+#   minify_html_opts:
+#     remove_intertag_spaces: true
+#     compress_js: true
+#     compress_css: true
+# 
+# Note that any hypen (-) must be represented as an underscore (_) in the configuration.
+
+module Awestruct
+  module Extensions
+    class Minify
+
+      def initialize(types = [ :css, :js ])
+        @types = types
+      end
+
+      def transform(site, page, input)
+        if site.minify
+          ext = File.extname(page.output_path)[1..-1].to_sym
+          if @types.include?(ext)
+            case ext
+            when :html
+              print "minifying html #{page.output_path}"
+              htmlcompressor(page, input, site.minify_html_opts)
+            when :css
+              print "minifying css #{page.output_path}"
+              yuicompressor(page, input, :css)
+            when :js
+              print "minifying js #{page.output_path}"
+              yuicompressor(page, input, :js)
+            when :png
+              print "minifying png #{page.output_path}"
+              pngcrush(page, input)
+            else
+              input
+            end
+          else
+            input
+          end
+        else
+          input
+        end
+      end
+
+      private
+
+      def htmlcompressor(page, input, minify_html_opts)
+        output = ''
+        cmd = "htmlcompressor"
+        if minify_html_opts
+          minify_html_opts.each do |p, v|
+            # boolean options are simple flags (i.e., do not accept values)
+            if v === true
+              cmd += " --#{p.gsub('_', '-')}"
+            elsif not v === false
+              cmd += " --#{p.gsub('_', '-')}=#{v}"
+            end
+          end
+        end
+        Open3.popen3(cmd) do |stdin, stdout, stderr|
+          threads = []
+          threads << Thread.new(stdout) do |o|
+            while ( ! o.eof? )
+              output << o.readline
+            end
+          end
+          threads << Thread.new(stdin) do |i|
+            i.write input
+            i.close
+          end
+          threads.each{ |t|t.join }
+        end
+
+        input_len = input.length
+        output_len = output.length
+
+        if input_len > output_len
+          puts " %d bytes -> %d bytes = %.1f%%" % [ input_len, output_len, 100 * output_len/input_len ]
+          output
+        else
+          puts " no gain"
+          input
+        end
+      end
+
+      def yuicompressor(page, input, type)
+        output = ''
+        Open3.popen3("yuicompressor --type #{type}") do |stdin, stdout, stderr|
+          threads = []
+          threads << Thread.new(stdout) do |o|
+            while ( ! o.eof? )
+              output << o.readline
+            end
+          end
+          threads << Thread.new(stdin) do |i|
+            i.write input
+            i.close
+          end
+          threads.each{ |t|t.join }
+        end
+
+        input_len = input.length
+        output_len = output.length
+
+        if input_len > output_len
+          puts " %d bytes -> %d bytes = %.1f%%" % [ input_len, output_len, 100 * output_len/input_len ]
+          output
+        else
+          puts " no gain"
+          input
+        end
+      end
+
+      def pngcrush(page, input)
+        filename = page.source_path
+        cmd = "pngcrush #{filename} /tmp/pngcrush"
+        `#{cmd}`
+        if $?.exitstatus != 0
+          raise "Failed to execute pngcrush: #{cmd}"
+        end
+        output = File.read('/tmp/pngcrush')
+
+        input_len = File.stat(filename).size
+        output_len = output.length
+
+        if input_len > output_len
+          puts " %d bytes -> %d bytes = %.1f%%" % [ input_len, output_len, 100 * output_len/input_len ]
+          output
+        else
+          puts " no gain"
+          input
+        end
+      end
+    end
+
+  end
+end