lavender 0.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+lavender.gemspec
+pkg

data/LICENCE

@@ -0,0 +1,13 @@
+Copyright © 2010, Tom Adams <tom@holizz.com>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.rdoc

@@ -0,0 +1,20 @@
+= lavender
+
+Minimalistic YAML-based CMS
+
+== Usage
+
+...
+
+== Inspiration
+
+- http://blog.peepcode.com/tutorials/2010/about-this-blog
+- http://jekyllrb.com/
+
+== Author
+
+Tom Adams <tom@holizz.com>
+
+== Copying
+
+ISC licence (see LICENCE for the full text).

data/Rakefile

@@ -0,0 +1,19 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'lavender'
+    gem.summary = %Q{Minimalistic YAML-based CMS}
+    gem.email = 'tom@holizz.com'
+    gem.homepage = 'http://github.com/holizz/lavender'
+    gem.authors = ['Tom Adams']
+    gem.add_dependency 'haml'
+    gem.add_development_dependency 'rspec'
+    gem.add_development_dependency 'jeweler'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler'
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/bin/lavender

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'lavender'
+Lavender::Command.run(ARGV)

data/lib/lavender.rb

@@ -0,0 +1,8 @@
+require 'erb'
+require 'haml'
+
+require 'lavender/renderer'
+require 'lavender/converter'
+require 'lavender/config'
+require 'lavender/static'
+require 'lavender/command'

data/lib/lavender/command.rb

@@ -0,0 +1,31 @@
+module Lavender
+  class Command
+    def self.run args
+      case args.first
+      when 'help'
+        self.help
+      when nil
+        self.help
+
+      when 'compile'
+        static = Lavender::Static.new true
+        static.run
+      when 'server'
+        raise ArgumentError, "Not yet implemented"
+
+      else
+        raise ArgumentError, "Command not recognised"
+      end
+    end
+
+    def self.help
+      puts <<END
+Usage: lavender command
+
+Commands:
+  help      This message
+  compile   Compiles the project in the current working directory
+END
+    end
+  end
+end

data/lib/lavender/config.rb

@@ -0,0 +1,75 @@
+module Lavender
+  class Config
+
+    class OpenStruct
+      def method_missing(method)
+        method = method.to_s
+        if @hsh[method].is_a? Hash
+          OpenStruct.new(@hsh[method])
+        else
+          @hsh[method]
+        end
+      end
+      def initialize(hsh)
+        @hsh = hsh
+      end
+      def to_hash
+        @hsh
+      end
+    end
+
+    def method_missing(method, *args)
+      @obj.send(method, *args)
+    end
+
+    LOCATIONS = %w[config.yml]
+
+    def initialize config = nil
+      @config = config
+      @config ||= {
+        'defaults' => {'layout' => 'default', 'processor' => 'haml'},
+        'paths' => {
+          'pages' => 'pages',
+          'layouts' => 'layouts',
+          'compiled' => 'compiled',
+          'public' => 'public'
+        },
+        'pwd' => Dir.pwd
+      }
+
+      user_config = {}
+      LOCATIONS.each do |y|
+        if File.exist? y
+          user_config = YAML::load_file y
+          break
+        end
+      end
+
+      @config = recursive_merge user_config, @config
+
+      @obj = OpenStruct.new @config
+    end
+
+    def recursive_merge primary, secondary
+      # merges secondary into primary
+
+      return primary unless primary.is_a? Hash
+
+      output = {}
+
+      primary.each_key do |k|
+        if secondary.has_key? k
+          output[k] = recursive_merge primary[k], secondary[k]
+        else
+          output[k] = user_config[k]
+        end
+      end
+
+      (secondary.keys-primary.keys).each do |k|
+        output[k] = secondary[k]
+      end
+
+      output
+    end
+  end
+end

data/lib/lavender/converter.rb

@@ -0,0 +1,47 @@
+module Lavender
+  class Converter
+    def initialize options
+      @options = options
+      @options[:defaults] ||= {}
+    end
+
+    def render
+      yaml = @options[:page]
+      conf = nil
+      page = nil
+
+      if yaml.match /\A---\s?\n(.+?\n)---\s?\n(.*)\Z/m
+        conf = YAML.load($1)
+        page = $2
+      else
+        conf = {}
+        page = yaml
+      end
+
+      pro = if conf.has_key? 'processor'
+              conf['processor']
+            else
+              @options[:defaults][:processor]
+            end
+      pro = pro.to_sym unless pro.nil?
+      r = Renderer.new(pro, page)
+      output = r.render(conf)
+
+      layout = if conf.has_key? 'layout'
+                 conf['layout']
+               else
+                 @options[:defaults][:layout]
+               end
+      layout = layout.to_sym unless layout.nil?
+      if layout
+        hsh = @options[:layouts][layout]
+        pro = hsh.keys.first
+        content = hsh[pro]
+        r = Renderer.new(pro, content)
+        output = r.render(conf) { output }
+      end
+
+      output
+    end
+  end
+end

data/lib/lavender/renderer.rb

@@ -0,0 +1,24 @@
+module Lavender
+  class Renderer
+    def initialize type, input
+      @type = type
+      @input = input
+    end
+
+    def render vars = {}, &block
+      @vars = vars
+
+      case @type
+      when :raw
+        @input
+      when :erb
+        def method_missing name
+          @vars[name] || @vars[name.to_s]
+        end
+        ERB.new(@input).result(binding)
+      when :haml
+        Haml::Engine.new(@input).to_html(Object.new, @vars, &block)
+      end
+    end
+  end
+end

data/lib/lavender/static.rb

@@ -0,0 +1,59 @@
+require 'fileutils'
+
+module Lavender
+  class Static
+    def initialize verbose = false
+      @config = Lavender::Config.new
+      @verbose = verbose
+    end
+
+    def run
+      # Public
+      Dir["#{path(:public)}/**/*"].each do |file|
+        out = file.sub(/^#{path(:public)}/, path(:compiled))
+        write_file out, File.read(file)
+      end
+
+      # Layouts
+      layouts = {}
+      Dir["#{path(:layouts)}/**/*"].each do |file|
+        name, ext = file.sub(/^#{path(:layouts)}\//,'').match(/^(.+)\.([^\.]+)$/)[1..-1]
+        layouts[name.to_sym] = {ext.to_sym => File.read(file)}
+      end
+
+      # Pages
+      Dir["#{path(:pages)}/**/*.yml"].each do |file|
+        target = file.sub(/^#{path(:pages)}/, path(:compiled))
+        target.sub!(/\.yml$/, '')
+
+        conv = Lavender::Converter.new(:page => File.read(file), :layouts => layouts, :defaults => defaults)
+
+        write_file target, conv.render
+      end
+    end
+
+    def path path
+      File.join(@config.pwd, @config.paths.send(path))
+    end
+
+    def defaults
+      @config.defaults.to_hash.reduce({}) do |a,b|
+        c = b.last
+        c = c.to_sym if c.is_a? String
+        a[b.first.to_sym] = c
+        a
+      end
+    end
+
+    def write_file path, data
+      FileUtils.mkdir_p File.dirname(path)
+      File.open(path, 'w+') do |f|
+        f.write data
+      end
+      if @verbose
+        basepath = path.sub(/^#{@config.pwd}\//,'')
+        puts "  create: #{basepath}"
+      end
+    end
+  end
+end

data/spec/command_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Lavender::Command do
+  it "should call Static correctly" do
+    m=RSpec::Mocks::Mock.new
+    m.stub!(:run)
+    Lavender::Static.should_receive(:new).with(true).and_return(m)
+    Lavender::Command.run(%w[compile])
+  end
+
+  it "should have a placeholder for Server" do
+    lambda { Lavender::Command.run(%w[server]) }.should raise_error
+  end
+
+  it "should bork on unrecognised commands" do
+    lambda { Lavender::Command.run(%w[on the ning nang nong]) }.should raise_error
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Lavender::Config do
+  before do
+    FakeFS.activate!
+    stub_files 'config.yml' => <<END
+---
+defaults:
+  layout: main
+END
+  end
+
+  after do
+    FakeFS.deactivate!
+  end
+
+  it "should take values from the config file" do
+    config = Lavender::Config.new
+    config.defaults.layout.should == 'main'
+  end
+
+  it "should have pre-defined default values" do
+    config = Lavender::Config.new
+    config.defaults.processor.should == 'haml'
+  end
+end

data/spec/converter_spec.rb

@@ -0,0 +1,172 @@
+require 'spec_helper'
+
+describe Lavender::Converter do
+  it "should render anything that isn't YAML with the default layout/processor" do
+    layout = <<END
+<body>
+  <%= yield %>
+</body>
+END
+
+    page = <<END
+%p My paragraph
+END
+
+    c = Lavender::Converter.new(:page => page, :layouts => {:default => {:erb => layout}}, :defaults => {:layout => :default, :processor => :haml})
+    c.render.should == <<END
+<body>
+  <p>My paragraph</p>
+
+</body>
+END
+  end
+
+  it "should render pages with the given template processor" do
+    page = <<END
+---
+processor: erb
+layout: null
+text: content
+---
+<p>Document <%= text %>.</p>
+END
+
+    c = Lavender::Converter.new(:page => page)
+
+    c.render.should == <<END
+<p>Document content.</p>
+END
+  end
+
+  it "should render pages with a layout" do
+    page = <<END
+---
+processor: haml
+layout: default
+title: your face
+---
+%p Document content.
+END
+    layout = <<END
+%html
+  %head
+    %title= title
+  %body
+    = yield
+END
+
+    c = Lavender::Converter.new(:page => page, :layouts => {:default => {:haml => layout}})
+
+    c.render.should == <<END
+<html>
+  <head>
+    <title>your face</title>
+  </head>
+  <body>
+    <p>Document content.</p>
+  </body>
+</html>
+END
+  end
+
+  it "should allow mixing templating languages" do
+    page = <<END
+---
+processor: haml
+layout: page
+title: your face
+---
+%p Document content.
+END
+    layout = <<END
+<html>
+  <head>
+    <title><%= title %></title>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>
+END
+
+    c = Lavender::Converter.new(:page => page, :layouts => {:page => {:erb => layout}})
+
+    c.render.should == <<END
+<html>
+  <head>
+    <title>your face</title>
+  </head>
+  <body>
+    <p>Document content.</p>
+
+  </body>
+</html>
+END
+  end
+
+  it "should use a default processor and layout" do
+    page = <<END
+---
+title: your face
+---
+%p Document content.
+END
+    layout = <<END
+<html>
+  <head>
+    <title><%= title %></title>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>
+END
+
+    c = Lavender::Converter.new(:page => page, :layouts => {:default => {:erb => layout}}, :defaults => {:layout => :default, :processor => :haml})
+
+    c.render.should == <<END
+<html>
+  <head>
+    <title>your face</title>
+  </head>
+  <body>
+    <p>Document content.</p>
+
+  </body>
+</html>
+END
+  end
+
+  it "should not try to parse HAML as YAML" do
+    page = <<END
+---
+layout: null
+---
+%p
+  %img{:src => "hamsterdance.gif"}
+END
+
+    c = Lavender::Converter.new(:page => page, :defaults => {:processor => :haml})
+
+    c.render.should == <<END
+<p>
+  <img src='hamsterdance.gif' />
+</p>
+END
+  end
+
+  it "should not try to parse HAML as YAML (no preamble)" do
+    page = <<END
+%p
+  %img{:src => "hamsterdance.gif"}
+END
+
+    c = Lavender::Converter.new(:page => page, :defaults => {:processor => :haml})
+
+    c.render.should == <<END
+<p>
+  <img src='hamsterdance.gif' />
+</p>
+END
+  end
+end

data/spec/renderer_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Lavender::Renderer do
+  it "should render raw stuff as-is" do
+    page = '<p>My paragraph</p>'
+    r = Lavender::Renderer.new(:raw, page)
+    r.render.should == page
+  end
+
+  it "should render ERB" do
+    page = '<p>Document <%= "content" %>.</p>'
+    r = Lavender::Renderer.new(:erb, page)
+    r.render.should == '<p>Document content.</p>'
+  end
+
+  it "should render HAML" do
+    page = '%p Document content.'
+    r = Lavender::Renderer.new(:haml, page)
+    r.render.should == "<p>Document content.</p>\n"
+  end
+
+  it "should set variables" do
+    # ERB
+    page = '<p>Document <%= text %>.</p>'
+    r = Lavender::Renderer.new(:erb, page)
+    r.render({:text => 'content'}).should == '<p>Document content.</p>'
+
+    # HAML
+    page = '%p= "Document #{text}."'
+    r = Lavender::Renderer.new(:haml, page)
+    r.render({:text => 'content'}).should == "<p>Document content.</p>\n"
+  end
+
+  it "should yield" do
+    # ERB
+    page = '<p>Document <%= yield %>.</p>'
+    r = Lavender::Renderer.new(:erb, page)
+    r.render{ 'content' }.should == '<p>Document content.</p>'
+
+    # HAML
+    page = '%p= "Document #{yield}."'
+    r = Lavender::Renderer.new(:haml, page) { 'content' }
+    r.render{ 'content' }.should == "<p>Document content.</p>\n"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'lavender'
+require 'fakefs/safe'
+
+Dir[File.join(File.dirname(__FILE__),"support/**/*.rb")].each {|f| require f}

data/spec/static_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe Lavender::Static do
+  before do
+    FakeFS.activate!
+  end
+
+  after do
+    FakeFS.deactivate!
+  end
+
+  it "should compile raw files" do
+    stub_files_and_run 'pages/index.html.yml' => <<END
+---
+layout: null
+processor: raw
+---
+<audio src="girlfriendboy.wav"></audio>
+END
+
+    File.should exist 'compiled/index.html'
+    File.read('compiled/index.html').should == <<END
+<audio src="girlfriendboy.wav"></audio>
+END
+  end
+
+  it "should ignore non-.yml files" do
+    stub_files_and_run 'pages/igonreme.txt' => <<END
+Ignore this!!!
+END
+    File.should_not exist 'compiled/ignoreme.txt'
+    File.should_not exist 'compiled/ignoreme'
+  end
+
+  it "should handle layouts and processing languages" do
+    stub_files_and_run(
+      'pages/hamster.html.yml' => <<END,
+%p Text
+END
+      'layouts/main.erb' => <<END)
+<body>
+  <%= yield %>
+</body>
+END
+    File.should exist 'compiled/hamster.html'
+    File.read('compiled/hamster.html').should == <<END
+<body>
+  <p>Text</p>
+
+</body>
+END
+  end
+
+  it "should handle layouts in subdirectories" do
+    stub_files_and_run(
+      'pages/refectory.html.yml' => <<END,
+---
+layout: clarissa/explains
+processor: raw
+---
+Hello there
+END
+      'layouts/clarissa/explains.erb' => <<END)
+<noscript>
+  <%= yield %>
+</noscript>
+END
+    File.should exist 'compiled/refectory.html'
+    File.read('compiled/refectory.html').should == <<END
+<noscript>
+  Hello there
+
+</noscript>
+END
+  end
+
+  it "should create directories" do
+    stub_files_and_run 'pages/s/ash.html.yml' => <<END
+---
+layout: null
+processor: raw
+---
+Hello there
+END
+    File.should exist 'compiled/s/ash.html'
+    File.read('compiled/s/ash.html').should == <<END
+Hello there
+END
+  end
+
+  it "should copy over public" do
+    stub_files_and_run 'public/t.txt' => <<END
+Some plain text
+END
+    File.should exist 'compiled/t.txt'
+    File.read('compiled/t.txt').should == <<END
+Some plain text
+END
+  end
+end

data/spec/support/stub_files.rb

@@ -0,0 +1,15 @@
+def stub_files files
+  files.each_pair do |name,content|
+    dir = File.dirname(name)
+    FileUtils.mkdir_p dir unless File.directory? dir
+    File.open(name,'w+') do |f|
+      f.write content
+    end
+  end
+end
+
+def stub_files_and_run files
+  stub_files files
+  c = Lavender::Static.new
+  c.run
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: lavender
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Tom Adams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-16 00:00:00 -04:00
+default_executable: lavender
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: haml
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: 
+email: tom@holizz.com
+executables: 
+- lavender
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- LICENCE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/lavender
+- lib/lavender.rb
+- lib/lavender/command.rb
+- lib/lavender/config.rb
+- lib/lavender/converter.rb
+- lib/lavender/renderer.rb
+- lib/lavender/static.rb
+- spec/command_spec.rb
+- spec/config_spec.rb
+- spec/converter_spec.rb
+- spec/renderer_spec.rb
+- spec/spec_helper.rb
+- spec/static_spec.rb
+- spec/support/stub_files.rb
+has_rdoc: true
+homepage: http://github.com/holizz/lavender
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Minimalistic YAML-based CMS
+test_files: 
+- spec/converter_spec.rb
+- spec/command_spec.rb
+- spec/static_spec.rb
+- spec/renderer_spec.rb
+- spec/support/stub_files.rb
+- spec/config_spec.rb
+- spec/spec_helper.rb