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/examples/website/input/index.md ADDED Viewed

@@ -0,0 +1,13 @@
+title: welcome
+layout: default
+---
+Welcome to our awesome websites!
+{% include 'tagline' %}
+## Lorem ipsum dolor sit amet...
+...Consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+### The title of this page is {{ page.title }}
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et **dolore magna aliqua**. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

data/examples/website/input/js/foo.js ADDED Viewed

	@@ -0,0 +1 @@
1	+ var hello = 'Welcome to this awesome page.';

data/examples/website/input/js/lib.js ADDED Viewed

@@ -0,0 +1,5 @@
+var hello = 'Welcome to this page.';
+// requires 'foo.js'
+window.onload = function init() {
+	alert(hello);
+};

data/examples/website/layouts/default.html ADDED Viewed

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <title>{{ page.title }} &ndash; Laze demo</title>
+        <link rel="stylesheet" href="css/screen.css" media="screen" charset="utf-8">
+        <script src="js/lib.js"></script>
+    </head>
+    <body>
+        <h1>Laze demonstration website</h1>
+        <hr>
+        {{ yield }}
+        <hr>
+        <p>Generated with Laze, the static site generator</p>
+    </body>
+</html>

data/examples/website/layouts/subpage.html ADDED Viewed

@@ -0,0 +1,5 @@
+layout: default
+---
+<p><a href="../index.html">Back to the homepage</a></p>
+{{ yield }}

data/examples/website/laze.yml ADDED Viewed

	@@ -0,0 +1 @@
1	+ domain: http://example.com

data/features/create_sites.feature ADDED Viewed

@@ -0,0 +1,73 @@
+Feature: Create sites
+  As a web developer
+  I want to be able to make a static website
+  In order to earn a living
+  Scenario: Basic site
+    Given I have an 'input/index.html' file that contains 'basic site'
+    When I run laze
+    Then the output directory should exist
+    And I should see 'basic site' in 'output/index.html'
+  Scenario: Site with directories
+    Given I have an 'input/contact/index.html' file that contains 'contact!'
+    When I run laze
+    Then the output directory should exist
+    And I should see 'contact!' in 'output/contact/index.html'
+  Scenario: Basic site with a layout
+    Given I have a layouts directory
+    And I have an 'input/index.html' page with layout 'default' that contains 'page with layout'
+    And I have a 'default' layout that contains 'Layout: {{ yield }}'
+    When I run laze
+    Then the output directory should exist
+    And I should see 'Layout: <p>page with layout</p>' in 'output/index.html'
+  Scenario: Basic site with nested layouts
+    Given I have a layouts directory
+    And I have an 'input/index.html' page with layout 'post' that contains 'page'
+    And I have a 'post' layout with layout 'default' that contains 'Post: {{ yield }}'
+    And I have a 'default' layout that contains 'Layout: {{ yield }}'
+    When I run laze
+    Then the output directory should exist
+    And I should see 'Layout: Post: <p>page</p>' in 'output/index.html'
+  Scenario: Basic site with includes
+    Given I have a includes directory
+    And I have an 'input/index.html' file that contains "Included: {% include 'foo' %}"
+    And I have an 'includes/foo.html' file that contains 'foo'
+    When I run laze
+    Then the output directory should exist
+    And I should see 'Included: foo' in 'output/index.html'
+  Scenario: CSS files
+    Given I have an 'input/base.css' file that contains 'foo'
+    When I run laze
+    Then the output directory should exist
+    And I should see 'foo' in 'output/base.css'
+  Scenario: LESS files
+    Given I have an 'input/base.less' file that contains '#foo { width: 1+1; }'
+    When I run laze
+    Then the output directory should exist
+    And I should see '#foo \{ width: 2; \}' in 'output/base.css'
+  Scenario: Javascript files
+    Given I have an 'input/base.js' file that contains 'foo'
+    When I run laze
+    Then the output directory should exist
+    And I should see 'foo' in 'output/base.js'
+  Scenario: XML Sitemaps
+    Given I have an 'input/test.html' file that contains 'foo'
+    When I run laze
+    Then the output directory should exist
+    And I should see 'foo' in 'output/test.html'
+    And I should see 'test.html' in 'output/sitemap.xml'
+  Scenario: robots.txt
+    Given I have an 'input/test.html' file that contains 'foo'
+    When I run laze
+    Then the output directory should exist
+    And I should see 'foo' in 'output/test.html'
+    And I should see 'Sitemap: sitemap.xml' in 'output/robots.txt'

data/features/plugins.feature ADDED Viewed

@@ -0,0 +1,49 @@
+@plugins
+Feature: Plugins
+  In order to automate tasks
+  As a web developer
+  I want to use plugins to awesomize my website
+  Scenario: CSS compression
+    Given I have an 'input/screen.css' file that contains
+    """
+    a {
+      color: #000;
+    }
+    """
+    When I run laze with minification
+    Then the output directory should exist
+    And I should see 'a\{color:#000;\}' in 'output/screen.css'
+  Scenario: Javascript compression
+    Given I have an 'input/base.js' file that contains
+    """
+    var  hello  =  "world";
+    """
+    When I run laze with minification
+    Then the output directory should exist
+    And I should see 'var hello="world";' in 'output/base.js'
+  Scenario: Javascript requires
+    Given I have an 'input/base.js' file that contains '// require "foo.js"'
+    And I have an 'input/foo.js' file that contains '// test'
+    When I run laze
+    Then the output directory should exist
+    And I should see '// test' in 'output/base.js'
+  Scenario: CSS imports
+    Given I have an 'input/base.css' file that contains '@import url(bar.css)'
+    And I have an 'input/bar.css' file that contains 'baaah'
+    When I run laze
+    Then the output directory should exist
+    And I should see 'baaah' in 'output/base.css'
+  Scenario: CSS cache busters
+    Given I have an 'input/base.css' file that contains 'foo { background: url(test.png); }'
+    And I have an 'input/test.png' file that contains 'foo'
+    When I run laze
+    Then the output directory should exist
+    And I should see 'url\(test.png\?\d+\)' in 'output/base.css'

data/features/site_data.feature ADDED Viewed

@@ -0,0 +1,26 @@
+Feature: Site data
+  As a web designer creating a static website
+  I want to be able to embed data into my site
+  In order to speed up development
+  Scenario: use page variable in a page
+    Given I have an 'input/index.html' page with title 'Foo' that contains '{{ page.title }}'
+    When I run laze
+    Then the output directory should exist
+    And I should see 'Foo' in 'output/index.html'
+  Scenario: use variables in a layout
+    Given I have a layouts directory
+    And I have a 'default' layout that contains '{{ page.title }}: {{ yield }}'
+    And I have an 'input/index.html' page with title 'Foo' and with layout 'default' that contains 'bar'
+    When I run laze
+    Then the output directory should exist
+    And I should see 'Foo: <p>bar</p>' in 'output/index.html'
+  Scenario: use variables in an include
+    Given I have a includes directory
+    And I have an 'includes/foo.html' file that contains '{{ page.title }}'
+    And I have an 'input/index.html' page with title 'Foo' that contains '{% include \'foo\' %}'
+    When I run laze
+    Then the output directory should exist
+    And I should see 'Foo' in 'output/index.html'

data/features/step_definitions/laze_steps.rb ADDED Viewed

@@ -0,0 +1,77 @@
+Before do
+  FileUtils.mkdir(TEST_DIR)
+  Dir.chdir(TEST_DIR)
+end
+After do
+  Dir.chdir(TEST_DIR)
+  FileUtils.rm_rf(TEST_DIR) if File.directory?(TEST_DIR)
+end
+Given /^I have an '(.+?)' file that contains ('|")(.*)\2$/ do |file, quote, text|
+  FileUtils.mkdir_p(File.dirname(file))
+  File.open(file, 'w') do |f|
+    f.write(text)
+  end
+end
+Given /^I have a (.+?) directory$/ do |dir|
+  FileUtils.mkdir(dir)
+end
+Given /^I have a '(.+?)' layout that contains ('|")(.*)\2$/ do |layout, quote, text|
+  File.open(File.join('layouts', layout + '.html'), 'w') do |f|
+    f.write(text)
+  end
+end
+Given /^I have a '(.+?)' layout with layout '(.+?)' that contains '(.*)'$/ do |filename, layout, text|
+  File.open(File.join('layouts', filename + '.html'), 'w') do |f|
+    f.write <<-EOF
+layout: #{layout}
+---
+#{text}
+EOF
+  end
+end
+Given /^I have a '(.+?)' file that contains '(.*)'$/ do |file, text|
+  File.open(file, 'w') do |f|
+    f.write(text)
+  end
+end
+Given /^I have an? '(.+?)' file that contains$/ do |file, text|
+  FileUtils.mkdir_p(File.dirname(file))
+  File.open(file, 'w') do |f|
+    f.write(text)
+  end
+end
+Given /^I have an '(.*?)' page(?: with (.*?) '(.*?)')?(?: and with (.*?) '(.*?)')? that contains '(.*)'$/ do |file, key, value, other_key, other_value, text|
+  FileUtils.mkdir('input') unless File.directory?('input')
+  File.open(file, 'w') do |f|
+    f.write <<EOF
+#{key}: #{value}
+#{other_key + ': ' + other_value unless other_key.nil?}
+---
+#{text}
+EOF
+  end
+end
+When /^I run laze$/ do
+  run_laze
+end
+When /^I run laze with minification$/ do
+  run_laze(:minify => true)
+end
+Then /^the (.+?) directory should exist$/ do |dir|
+  assert File.directory?(dir)
+end
+Then /^I should see '(.*)' in '(.+?)'$/ do |text, file|
+  assert_match Regexp.new(text), File.open(file).readlines.join
+end

data/features/support/env.rb ADDED Viewed

@@ -0,0 +1,17 @@
+require 'fileutils'
+require 'rr'
+require 'test/unit'
+World do
+  include Test::Unit::Assertions
+end
+TEST_DIR    = File.join(ENV['PWD'], 'tmp')
+LAZE_PATH = File.join(ENV['PWD'], 'bin', 'laze')
+def run_laze(options = {})
+  command = LAZE_PATH.dup
+  command << ' -m' if options[:minify]
+  command << ' >> /dev/null 2>&1' if options[:debug].nil?
+  system command
+end

data/lib/laze.rb ADDED Viewed

@@ -0,0 +1,64 @@
+$:.unshift File.dirname(__FILE__) # For use/testing when no gem is installed
+begin
+  # Core
+  require 'yaml'
+  # Standard library
+  require 'fileutils'
+  require 'logger'
+  # Third party
+  require 'liquid'
+  require 'rdiscount'
+  require 'redcloth'
+rescue LoadError
+  # Gems
+  retry if require 'rubygems'
+  raise
+end
+module Laze #:nodoc:
+  def debug(msg)
+    LOGGER.debug(msg) if const_defined?('LOGGER')
+  end
+  def warn(msg)
+    LOGGER.warn(msg) if const_defined?('LOGGER')
+  end
+  def info(msg)
+    LOGGER.info(msg) if const_defined?('LOGGER')
+  end
+  def fatal(msg)
+    LOGGER.fatal(msg) if const_defined?('LOGGER')
+  end
+  def self.version
+    yml = YAML.load(File.read(File.join(File.dirname(__FILE__), *%w[.. VERSION.yml])))
+    "#{yml[:major]}.#{yml[:minor]}.#{yml[:patch]}"
+  end
+  extend self
+end
+# Internal requires
+require 'laze/core_extensions'
+require 'laze/plugins'
+require 'laze/item'
+require 'laze/page'
+require 'laze/asset'
+require 'laze/stylesheet'
+require 'laze/javascript'
+require 'laze/renderer'
+require 'laze/renderers/page_renderer'
+require 'laze/renderers/stylesheet_renderer'
+require 'laze/renderers/javascript_renderer'
+require 'laze/section'
+require 'laze/layout'
+require 'laze/secretary'
+require 'laze/target'
+require 'laze/targets/filesystem'
+require 'laze/store'
+require 'laze/stores/filesystem'

data/lib/laze/asset.rb ADDED Viewed

@@ -0,0 +1,7 @@
+module Laze
+  class Asset < Item # :nodoc:
+    def filename
+      properties[:filename]
+    end
+  end
+end

data/lib/laze/core_extensions.rb ADDED Viewed

@@ -0,0 +1,15 @@
+class Hash #:nodoc:
+  def stringify_keys
+    inject({}) do |output, (key, value)|
+      output[(key.to_s rescue key) || key] = value
+      output
+    end
+  end
+  def symbolize_keys
+    inject({}) do |output, (key, value)|
+      output[(key.to_sym rescue key) || key] = value
+      output
+    end
+  end
+end

data/lib/laze/item.rb ADDED Viewed

@@ -0,0 +1,59 @@
+module Laze
+  # An item is a basic node in a site. It is usually not used directly, but
+  # only through one of its subclasses, like Page or Section. An item is used
+  # as a generic container for static files, such as images.
+  class Item
+    # Hash of proprties, like page title or output filename.
+    attr_accessor :properties
+    # Other item that has this item as one of its subitems.
+    attr_accessor :parent
+    # Contents of the file
+    attr_accessor :content
+    # New items should be created with a hash of options:
+    #
+    #   Item.new :title => 'Foo'
+    #
+    def initialize(properties, content)
+      @properties, @content, @parent = properties, content, nil
+    end
+    # Test if this item has a given property.
+    def has?(key)
+      @properties.has_key?(key)
+    end
+    # Shortcut method to the filename property.
+    def filename
+      @properties[:filename]
+    end
+    def number_of_subitems
+      0
+    end
+    # An array of items, where each item is the next's
+    # parent.
+    def ancestors
+      parent ? [parent, *parent.ancestors].reverse : []
+    end
+    def to_s #:nodoc:
+      filename
+    end
+    def inspect #:nodoc:
+      "#<#{self.class}:0x#{self.object_id.to_s(16)} #{filename}>"
+    end
+  protected
+    def self.include_plugins(kind) #:nodoc:
+      Laze::Plugins.each do |plugin|
+        include plugin if plugin.applies_to?(kind)
+      end
+    end
+  end
+end