RubyGems - laze - Versions diffs - 0.2.0 - Mend

laze 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (65) hide show

data/.document +5 -0
data/.gitignore +22 -0
data/LICENSE +20 -0
data/README.rdoc +150 -0
data/Rakefile +76 -0
data/VERSION.yml +5 -0
data/bin/laze +126 -0
data/examples/website/includes/tagline.html +1 -0
data/examples/website/input/contact/email.md +6 -0
data/examples/website/input/css/screen.css +5 -0
data/examples/website/input/css/test.less +6 -0
data/examples/website/input/img/ruby.gif +0 -0
data/examples/website/input/img/test.jpg +0 -0
data/examples/website/input/img/test.png +0 -0
data/examples/website/input/index.md +13 -0
data/examples/website/input/js/foo.js +1 -0
data/examples/website/input/js/lib.js +5 -0
data/examples/website/layouts/default.html +15 -0
data/examples/website/layouts/subpage.html +5 -0
data/examples/website/laze.yml +1 -0
data/features/create_sites.feature +73 -0
data/features/plugins.feature +49 -0
data/features/site_data.feature +26 -0
data/features/step_definitions/laze_steps.rb +77 -0
data/features/support/env.rb +17 -0
data/lib/laze.rb +64 -0
data/lib/laze/asset.rb +7 -0
data/lib/laze/core_extensions.rb +15 -0
data/lib/laze/item.rb +59 -0
data/lib/laze/javascript.rb +5 -0
data/lib/laze/layout.rb +105 -0
data/lib/laze/page.rb +33 -0
data/lib/laze/plugins.rb +56 -0
data/lib/laze/plugins/cache_buster.rb +49 -0
data/lib/laze/plugins/css_imports.rb +42 -0
data/lib/laze/plugins/cssmin.rb +31 -0
data/lib/laze/plugins/image_check.rb +28 -0
data/lib/laze/plugins/image_optimizer.rb +52 -0
data/lib/laze/plugins/js_requires.rb +63 -0
data/lib/laze/plugins/jsmin.rb +31 -0
data/lib/laze/plugins/less.rb +35 -0
data/lib/laze/plugins/robots.rb +28 -0
data/lib/laze/plugins/sitemap.rb +63 -0
data/lib/laze/renderer.rb +47 -0
data/lib/laze/renderers/javascript_renderer.rb +16 -0
data/lib/laze/renderers/page_renderer.rb +40 -0
data/lib/laze/renderers/stylesheet_renderer.rb +16 -0
data/lib/laze/secretary.rb +74 -0
data/lib/laze/section.rb +39 -0
data/lib/laze/store.rb +51 -0
data/lib/laze/stores/filesystem.rb +127 -0
data/lib/laze/stylesheet.rb +6 -0
data/lib/laze/target.rb +56 -0
data/lib/laze/targets/filesystem.rb +41 -0
data/test/helper.rb +12 -0
data/test/test_assets.rb +28 -0
data/test/test_core_extensions.rb +19 -0
data/test/test_item.rb +59 -0
data/test/test_layout.rb +47 -0
data/test/test_renderer.rb +71 -0
data/test/test_renderers.rb +40 -0
data/test/test_secretary.rb +48 -0
data/test/test_store.rb +18 -0
data/test/test_target.rb +84 -0
metadata +207 -0

data/lib/laze/javascript.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module Laze
+  # A special kind of Item aimed at javascript files.
+  class Javascript < Asset
+  end
+end

data/lib/laze/layout.rb ADDED Viewed

@@ -0,0 +1,105 @@
+module Laze
+  # A layout is a special kind of file that can be used to remove duplication
+  # of HTML boilerplate code. Store a header and footer of a page in a layout
+  # and simply wrap that around a given piece of content to create a page.
+  #
+  # == Inserting content into a layout
+  #
+  # A layout can contain anything you like. The only rule is you should insert
+  # an insertion point for the content of a page. Here's a simple example:
+  #
+  #   <html>
+  #     <head>
+  #       <title>My awesome website</title>
+  #     </head>
+  #     <body>
+  #       {{ yield }}
+  #     </body>
+  #   </html>
+  #
+  # When your page's content is "Welcome" your resulting page output would be:
+  #
+  #   <html>
+  #     <head>
+  #       <title>My awesome website</title>
+  #     </head>
+  #     <body>
+  #       Welcome
+  #     </body>
+  #   </html>
+  #
+  # Laze does its best to preserve whitespace in your content.
+  #
+  # == Nested templates
+  #
+  # You can nest multiple layouts, i.e. a layout can itself have a layout.
+  # This way you can create a master template for your site, with
+  # subtemplates for various page types.
+  #
+  # Simply give your layout file a layout like so:
+  #
+  #   layout: my_layout
+  #   ---
+  #   <html>
+  #     <head>
+  #       <title>My awesome website</title>
+  #     </head>
+  #     <body>
+  #       {{ yield }}
+  #     </body>
+  #   </html>
+  #
+  # == Template data in layout files
+  #
+  # You can use any variables defined in your pages in your layouts, and
+  # the other way around. You could, for example, include the page title in
+  # your <tt><title></tt> element:
+  #
+  #   <html>
+  #     <head>
+  #       <title>{{ page.title }} - My awesome website</title>
+  #     </head>
+  #     <body>
+  #       {{ yield }}
+  #     </body>
+  #   </html>
+  #
+  class Layout < Item
+    # Regex matching where to insert a layout's content
+    YIELD = /\{\{\s*yield\s*\}\}/
+    # Special regex matching an insertion point on a single blank line. In
+    # this case we can preserve whitespace indents.
+    SINGLE_LINE_YIELD = /^(\s+)#{YIELD}\s*$/
+    # Apply this layout to a piece of text, returning this layout's content
+    # with the +YIELD+ replacd with the given string.
+    #
+    # If the +YIELD+ is on a single line that is matched by +SINGLE_LINE_YIELD+
+    # it will prefix every line in +string+ with the whitespace indent of the
+    # +YIELD+.
+    def wrap(string)
+      if content =~ SINGLE_LINE_YIELD
+        whitespace = $1
+        content.sub(SINGLE_LINE_YIELD, string.split(/\n/).map { |l| whitespace + l }.join("\n"))
+      else
+        content.sub(YIELD, string)
+      end
+    end
+    # Return this layout's own layout, to enable nested layouts. Simple
+    # shortcut function.
+    def layout
+      properties[:layout]
+    end
+    # Use the currently active data store to look for a layout by a given
+    # name. Returns +nil+ when given +nil+, and a new layout instance
+    # otherwise.
+    def self.find(layout_name)
+      return unless layout_name
+      Secretary.current.store.find_layout(layout_name)
+    end
+  end
+end

data/lib/laze/page.rb ADDED Viewed

@@ -0,0 +1,33 @@
+module Laze
+  # A special kind of Item aimed at HTML files (could be files ending in
+  # html, htm, md, mkd, mdn, markdown or liquid).
+  class Page < Item
+    # Convert this page's content to HTML using a text filter. You can set
+    # the text filter to use with a property +text_filter+.
+    #
+    # Current filters supported are markdown, textile and none. Default is
+    # markdown.
+    def filtered_content
+      text_filter ? text_filter.new(content).to_html : content
+    end
+    def filename #:nodoc:
+      @filename ||= properties[:filename].sub(/(?:md|mkd|liquid|markdown|htm)$/, 'html')
+    end
+  private
+    # Try to read the text filter to use from the properties. Return nil when
+    # 'none' is defined, RDiscount when undefined or otherwise the
+    # associated filter.
+    def text_filter
+      case properties[:filter]
+      when 'markdown': RDiscount
+      when 'textile': RedCloth
+      when 'none': nil
+      else
+        RDiscount
+      end
+    end
+  end
+end

data/lib/laze/plugins.rb ADDED Viewed

@@ -0,0 +1,56 @@
+module Laze
+  # Plugins provides access to all Laze plugins.
+  #
+  # A plugin is a simple decorator that can wrap an Item object. Every plugin
+  # itself can tell you to what objects it applies, and an Item includes
+  # all available plugins by using the +include_plugins+ macro:
+  #
+  #   class MyItem < Item
+  #     include_plugins :my_item
+  #   end
+  #
+  # == Example
+  #
+  # A plugin is a simple module that usually replaces methods on Item objects.
+  # Here's a simple example:
+  #
+  #   class MyItem < Item
+  #     include_plugins :my_item
+  #     def foo
+  #       'bar'
+  #     end
+  #   end
+  #
+  #   module Plugins
+  #     module MyPlugin
+  #       def applies_to?(kind)
+  #         kind == :my_item
+  #       end
+  #
+  #       def foo
+  #         super + '!'
+  #       end
+  #     end
+  #   end
+  #
+  #   MyItem.new.foo # => 'bar!'
+  #
+  # == Working with plugins
+  #
+  # Usually, each plugin should have its own file, require any third-party
+  # libraries and be responsible for when things go wrong.
+  #
+  # A plugin should be stored in /plugins, where it is automatically loaded.
+  module Plugins
+    # Loop over all available plugins, yielding each.
+    def self.each(for_kind = nil) # :yields: module
+      constants.each do |c|
+        const = Laze::Plugins.const_get(c)
+        yield const if const.is_a?(Module) && (for_kind.nil? || const.applies_to?(for_kind))
+      end
+    end
+  end
+end
+# Load all plugins from /plugins
+Dir[File.join(File.dirname(__FILE__), 'plugins', '*.rb')].each { |f| require f }

data/lib/laze/plugins/cache_buster.rb ADDED Viewed

@@ -0,0 +1,49 @@
+module Laze #:nodoc:
+  module Plugins #:nodoc:
+    # This plugin applies cache busters to CSS files, Javascript files and
+    # image files in your stylesheets. This means it will append the last
+    # modified time of these referenced files to the URL references as
+    # query parameters, so you force the server to bypass caches and give
+    # you a new file when a file has changed.
+    #
+    # Example:
+    #
+    #   # css file
+    #   body {
+    #     background: url(image.png);
+    #   }
+    #
+    #   # HTML file
+    #   <link href="screen.css">
+    #
+    # Becomes:
+    #
+    #   # css file
+    #   body {
+    #     background: url(image.png?201009231441);
+    #   }
+    #
+    #   # HTML file
+    #   <link href="screen.css?201009231441">
+    #
+    module CacheBuster
+      def self.applies_to?(kind) #:nodoc:
+        kind == 'Laze::Renderers::PageRenderer' || kind == 'Laze::Renderers::StylesheetRenderer'
+      end
+      def render(locals = {})
+        Laze.info("Adding cache busters to #{options[:locals][:filename]}")
+        [ /((?:href|src)=(?:'|"))(.+\.(?:css|js))("|')/,
+          /(url\([\s"']*)([^\)"'\s]*\.(?:png|gif|jpg))([\s"']*\))/m
+        ].inject(super) do |output, regex|
+          output.gsub(regex) do |match|
+            filename = File.expand_path(File.join('input', options[:locals][:path], $2))
+            output = "#{$1}#{$2}%s#{$3}"
+            cache_buster = File.exists?(filename) ? '?' + File.mtime(filename).strftime('%Y%m%d%H%M') : ''
+            output % cache_buster
+          end
+        end
+      end
+    end
+  end
+end

data/lib/laze/plugins/css_imports.rb ADDED Viewed

@@ -0,0 +1,42 @@
+module Laze #:nodoc:
+  module Plugins #:nodoc:
+    # This plugin will replace any import statements in your stylesheets with
+    # the actual contents of the referenced files. This reduces the number
+    # of HTTP requests and speeds up your website loading time.
+    #
+    # This plugin is a decorator for Target and fires before Target#save.
+    module CssImports
+      def self.applies_to?(kind) #:nodoc:
+        kind == :target
+      end
+      def save
+        expand_css_imports
+        super
+      end
+    private
+      def expand_css(content, filename)
+        Laze.info("Expanding imports in #{filename}")
+        content.gsub!(/@import\s*url\(\s*('|")?\s*([^'"]+)\s*\1?\s*\);?/) do |match|
+          referenced_file = File.expand_path(File.join(File.dirname(filename), $2))
+          if File.exists?(referenced_file)
+            "/* #{match} */\n" + expand_css(File.read(referenced_file), referenced_file)
+          else
+            Laze.warn "CSS Imported file not found: #{referenced_file}"
+            match
+          end
+        end
+        content
+      end
+      def expand_css_imports
+        Dir[File.join(output_dir, '**', '*.css')].each do |filename|
+          content = File.read(filename)
+          File.open(filename, 'w') { |f| f.write expand_css(content, filename) }
+        end
+      end
+    end
+  end
+end

data/lib/laze/plugins/cssmin.rb ADDED Viewed

@@ -0,0 +1,31 @@
+begin
+  require 'cssmin'
+  module Laze #:nodoc:
+    module Plugins #:nodoc:
+      # This plugin minifies the output of your CSS files, reducing your
+      # website's bandwidth usage.
+      #
+      # This plugin is a decorator for StylesheetRenderer and fires after
+      # StylesheetRenderer#render.
+      #
+      # *Note*: when the cssmin gem is unavailable this plugin will quietly
+      # fail, leaving the .css files untouched and generating a warning in the
+      # logs.
+      module Cssmin
+        def self.applies_to?(kind) #:nodoc:
+          kind == 'Laze::Renderers::StylesheetRenderer'
+        end
+        def render(locals = {})
+          return super unless Secretary.current.options[:minify_css]
+          @minified_content = begin
+            Laze.info "Minifying #{options[:locals][:filename]}"
+            ::CSSMin.minify(super)
+          end
+        end
+      end
+    end
+  end
+rescue LoadError
+  Laze.warn 'The cssmin gem is required to minify .css files.'
+end

data/lib/laze/plugins/image_check.rb ADDED Viewed

@@ -0,0 +1,28 @@
+module Laze #:nodoc:
+  module Plugins #:nodoc:
+    # This plugin checks your stylesheets for missing images and spits out
+    # a log warning message when an image file referenced in your
+    # stylesheets could not be found.
+    #
+    # This plugin is a decorator for StylesheetRenderer and fires after
+    # StylesheetRenderer#render.
+    module ImageCheck
+      def self.applies_to?(kind) #:nodoc:
+        kind == 'Laze::Renderers::StylesheetRenderer'
+      end
+      def render(locals = {})
+        Laze.debug 'Checking for missing stylesheet images'
+        super.scan(/url\(\s*('|")?\s*(.+?)\s*\1?\s*\)/) do |match|
+          filename = match[1].split("?", 2).first
+          if %w(.gif .png .jpg .jpeg).include?(File.extname(filename))
+            path = File.expand_path(File.join(Secretary.current.options[:source], 'input', options[:locals][:path], filename))
+            unless File.exists?(path)
+              Laze.warn "Image #{path} not found (#{options[:locals][:filename]})."
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/laze/plugins/image_optimizer.rb ADDED Viewed

@@ -0,0 +1,52 @@
+module Laze #:nodoc:
+  module Plugins #:nodoc:
+    # This plugin tries to optimize the images in your website.
+    # You will need to have +pngcrush+ and +jpegtran+ installed on your
+    # system for this plugin to work. If not, it will fail silently.
+    #
+    # This plugin is a decorator for Target and fires before Target#save.
+    module ImageOptimizer
+      def self.applies_to?(kind) #:nodoc:
+        kind == :target
+      end
+      def save
+        optimize_images
+        super
+      end
+    private
+      def optimize_images
+        pngcrush = `which pngcrush`
+        jpegtran = `which jpegtran`
+        Laze.warn 'pngcrush not found; skipping PNG optimization' if pngcrush.empty?
+        Laze.warn 'jpegtran not found; skipping JPG optimization' if jpegtran.empty?
+        Dir[File.join(output_dir, '**/*.{png,jpg}')].each do |filename|
+          temp_file = filename + '_optimized'
+          if File.extname(filename).downcase == '.png' && !pngcrush.empty?
+            optimize_png(filename, temp_file)
+          elsif File.extname(filename).downcase == '.jpg' && !jpegtran.empty?
+            optimize_jpg(filename, temp_file)
+          end
+          if File.exists?(temp_file)
+            FileUtils.rm(filename)
+            FileUtils.mv(temp_file, filename)
+          end
+        end
+      end
+      def optimize_png(filename, temp_file)
+        Laze.info "Optimizing #{filename}"
+        system("pngcrush -q -reduce -brute #{filename} #{temp_file}")
+      end
+      def optimize_jpg(filename, temp_file)
+        Laze.info "Optimizing #{filename}"
+        system("jpegtran -copy none -progressive -outfile #{temp_file} #{filename}")
+      end
+    end
+  end
+end

data/lib/laze/plugins/js_requires.rb ADDED Viewed

@@ -0,0 +1,63 @@
+module Laze #:nodoc:
+  module Plugins #:nodoc:
+    # This plugin introduces the +require+ statement to your javascript files.
+    # This is a simple mechanism to concatenate all your javascript files
+    # into a single library and thereby reduce the number of HTTP requests
+    # (improving your website load time).
+    #
+    # You can include another javascript file with a special comment like so:
+    #
+    #   # foo.js
+    #   var foo = 'foo';
+    #
+    #   # bar.js
+    #   // require 'foo.js'
+    #   alert(foo);
+    #
+    # This will compile into the following file:
+    #
+    #   # bar.js
+    #   var foo = 'foo';
+    #   alert(foo);
+    #
+    # Note that this leaves the original files untouched, so your website
+    # will end up with both files. The point is you only have to reference
+    # the one with that is concatenated.
+    #
+    # This plugin is a decorator for Target and fires before Target#save.
+    module JsRequires
+      # This plugin is a decorator for Target and fires before Target#save.
+      def self.applies_to?(kind) #:nodoc:
+        kind == :target
+      end
+      def save
+        expand_js_requires
+        super
+      end
+    private
+      def expand_js(content, filename)
+        Laze.info("Expanding requires in #{filename}")
+        content.gsub!(/^\s*\/\/\s*requires? ('|")?(.+)\1$/) do |match|
+          referenced_file = File.expand_path(File.join(File.dirname(filename), $2))
+          if File.exists?(referenced_file)
+            "#{match}\n" + expand_js(File.read(referenced_file), referenced_file)
+          else
+            Laze.warn "JS required file not found: #{referenced_file}"
+            match
+          end
+        end
+        content
+      end
+      def expand_js_requires
+        Dir[File.join(output_dir, '**', '*.js')].each do |filename|
+          content = File.read(filename)
+          File.open(filename, 'w') { |f| f.write expand_js(content, filename) }
+        end
+      end
+    end
+  end
+end