wormwood 0.0.6 → 0.0.7

data/README.md

@@ -1,53 +1,57 @@
 # Wormwood
 
-Wormwood is an event-driven file rendering utility inspired by [Jekyll](https://github.com/mojombo/jekyll).
+Wormwood is an event-driven template rendering utility inspired by [Jekyll](https://github.com/mojombo/jekyll). It's great for rendering markdown, e.g., a README file, as you edit.
+
+Wormwood will:
+
+1. watch for changes to a template directory ( _./_ by default)
+1. render the changed files (via [Tilt](https://github.com/rtomayko/tilt)) into a layout
+1. write the rendered, laid-out content to an output directory ( _./_ by default).
+
+
+## Installation
+
+    $ gem install wormwood
 
-Wormwood:
-1. watches for changes to a template directory ( _./_ by default)
-2. renders the changed files (via [Tilt](https://github.com/rtomayko/tilt))
-3. writes the rendered output to an output directory ( _./_ by default).
 
 ## Usage
 
-1. Create a file [Tilt](https://github.com/rtomayko/tilt) knows how to render, e.g., _foo.erb_
-2. Create a file named "layout" in the same directory, with a Tilt-supported extension, e.g., _layout.erb_
-3. Reference _content_ in the layout, e.g., `<%= content %>`
-4. Run `wormwood`
-5. Edit _foo.erb_ and observe changes applied to _foo.html_
+1. Create a file [Tilt](https://github.com/rtomayko/tilt) knows how to render, e.g., _foo.md_
+1. Run `wormwood`
+1. Edit _foo.md_ and observe the creation of _foo.html_
+
+**Note:** Wormwood will generate a file called _&lt;layout name>.erb_ in your source directory if a file named "layout" doesn't already exist. Feel free to hack it.
 
 
 ## Configuration
 
-You can specify _source_ and _destination_ directories as options. For example:
+Wormwood defines a few configuration options:
 
-    wormwood -s templates -d public
+`--source` The directory containing the template and layout files. Defaults to "./"
 
-Other options:
+`--destination` The directory to write rendered files to. Defaults to "./"
 
-`--layout` specifies the layout file name (without the extension), e.g., `wormwood --layout default`. Defaults to "layout".
+`--layout` The layout file name (without extension). Defaults to "layout".
 
-`--variable` specifies the variable name used to insert the rendered content into the layout, e.g., `wormwood --variable yield`. Defaults to "content".
+`--variable` The name of the variable used to insert rendered content into the layout. Defaults to "content".
 
 
-## Installation
+## Developing
 
-Add this line to your application's Gemfile:
+1. Develop
+1. Build gem `rake build`
+1. Install gem `rake install`
+1. Run tests `rake test`
 
-    gem 'wormwood'
 
-And then execute:
+## Changelog
 
-    $ bundle
+0.0.7 generates default layout
+0.0.6 adds layout support
 
-Or install it yourself as:
-
-    $ gem install wormwood
 
+## License
 
-## Contributing
+Copyright 2013 Erik Eldridge
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Licensed under the MIT License

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+# ref: http://blog.arvidandersson.se/2012/03/28/minimalicous-testing-in-ruby-1-9
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_spec.rb"
+end

data/bin/wormwood

@@ -11,18 +11,14 @@ default_command :watch
 
 global_option '--source [DIR]', 'Watches specified directory path (defaults to "./")'
 global_option '--destination [DIR]', 'Writes to specified directory path (defaults to "./")'
-global_option '--layout [NAME]', 'The layout file name (defaults to "layout")'
+global_option '--layout [NAME]', 'The layout name (defaults to "layout")'
 global_option '--variable [NAME]', 'The layout variable name (defaults to "content")'
 
 command :watch do |c|
   c.syntax = 'wormwood watch [options]'
   c.description = 'Watches source directory and renders any files that change'
   c.action do |args, options|
-    options.default \
-      :source => './',
-      :destination  => './',
-      :layout => 'layout',
-      :variable => 'content'
+    options.default Wormwood::DEFAULTS
     Wormwood.watch(options)
   end
 end
@@ -31,11 +27,7 @@ command :build do |c|
   c.syntax = 'wormwood build [options]'
   c.description = 'Renders all templates in source directory'
   c.action do |args, options|
-    options.default \
-      :source => './',
-      :destination  => './',
-      :layout => 'layout',
-      :variable => 'content'
+    options.default Wormwood::DEFAULTS
     Wormwood.build(Dir[Wormwood::GLOB], options)
   end
 end

data/lib/wormwood.rb

@@ -5,7 +5,13 @@ require 'fileutils'
 require 'tilt'
 
 module Wormwood
-  GLOB = '**/*.{erb,rhtml,markdown,mkd,md}'
+  GLOB = '**/*.{markdown,mkd,md}'
+  DEFAULTS = {
+    :source => '.',
+    :destination  => '.',
+    :layout => 'layout',
+    :variable => 'content'
+  }
 
   # ref: https://github.com/mojombo/jekyll/blob/master/lib/jekyll/commands/build.rb
   # ref: https://github.com/TwP/directory_watcher/blob/master/lib/directory_watcher.rb
@@ -22,6 +28,10 @@ module Wormwood
 
   def self.build paths, options
     layout_path = Dir.glob(File.join(options.source, "#{options.layout}*")).first
+    if layout_path.nil?
+      layout_path = File.join(options.source, "#{options.layout}.erb")
+      create_layout layout_path, options
+    end
     paths.each do |source_path|
       dest_path = File.join \
         options.destination,
@@ -32,4 +42,15 @@ module Wormwood
     end
   end
 
+  def self.create_layout layout_path, options
+    default_layout = <<-EOS.gsub /^\s+/, ''
+      <!--
+      Default layout generated by wormwood.
+      Check out https://github.com/erikeldridge/wormwood#usage for more info.
+      -->
+      <%= #{options.variable} %>
+    EOS
+    File.write layout_path, default_layout
+  end
+
 end

data/lib/wormwood/version.rb

@@ -1,3 +1,3 @@
 module Wormwood
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/{test/lib/wormwood/build_test.rb → spec/lib/wormwood/build_spec.rb}

@@ -1,11 +1,25 @@
 require_relative '../../test_helper'
 describe Wormwood do
   before do
-    clear_dest
-    create_source
+    clear_dest!
+    create_source_dir!
+    create_template!
+  end
+
+  it "generates default layout" do
+    Wormwood.build \
+      [source_dir("foo.erb")],
+      OpenStruct.new({
+        'source' => source_dir,
+        'destination' => dest_dir,
+        'layout' => 'layout',
+        'variable' => 'content'
+      })
+    assert File.exist?(source_dir('layout.erb'))
   end
 
   it "writes to the correct destination" do
+    create_layout!
     Wormwood.build \
       [source_dir("foo.erb")],
       OpenStruct.new({

data/{test → spec}/test_helper.rb

@@ -4,12 +4,21 @@ require 'fileutils'
 require 'ostruct'
 require_relative '../lib/wormwood.rb'
 
-def create_source
-  unless File.exists? source_dir
-    FileUtils.mkdir_p(source_dir)
-    File.write(source_dir('layout.erb'), "<%= content %>")
-    File.write(source_dir('foo.erb'), "asd")
-  end
+def clear_dest!
+  FileUtils.rm_rf(dest_dir)
+  FileUtils.mkdir_p(dest_dir)
+end
+
+def create_source_dir!
+  FileUtils.mkdir_p(source_dir) unless File.exists? source_dir
+end
+
+def create_layout!
+  File.write(source_dir('layout.erb'), "<%= content %>")
+end
+
+def create_template!
+  File.write(source_dir('foo.erb'), "asd")
 end
 
 # ref: https://github.com/mojombo/jekyll/blob/master/test/helper.rb
@@ -20,8 +29,3 @@ end
 def source_dir(*subdirs)
   File.join(File.dirname(__FILE__), 'tmp/source', *subdirs)
 end
-
-def clear_dest
-  FileUtils.rm_rf(dest_dir)
-  FileUtils.mkdir_p(dest_dir)
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wormwood
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-01 00:00:00.000000000 Z
+date: 2013-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -74,8 +74,8 @@ files:
 - bin/wormwood
 - lib/wormwood.rb
 - lib/wormwood/version.rb
-- test/lib/wormwood/build_test.rb
-- test/test_helper.rb
+- spec/lib/wormwood/build_spec.rb
+- spec/test_helper.rb
 - wormwood.gemspec
 homepage: http://github.com/erikeldridge/wormwood
 licenses: []
@@ -104,5 +104,5 @@ summary: Wormwood watches for changes to a template directory ("./" by default),
   the changed files (via Tilt), and writes the rendered output to an output directory
   ("./" by default).
 test_files:
-- test/lib/wormwood/build_test.rb
-- test/test_helper.rb
+- spec/lib/wormwood/build_spec.rb
+- spec/test_helper.rb